API to Get the Schema of Troubleshooting Commands
This endpoint returns a static troubleshooting command config schema for selected type of troubleshooting command.
GET /openapi/v1/config_groups/command_schema/<type>
In request payload, <type> is the troubleshooting command config type.
Parameters:
The request URL contains the following parameters
|
Name |
Type |
Description |
|---|---|---|
|
type |
string |
Specify the command type from "SHOW LOG" "SHOW_SERVICE_LOG" "SHOW_RUNNING_CONF" "SHOW_SERVICE_RUNNING_CONF" "SHOW_SYS_COMMANDS" "SHOW_DOCKER_COMMANDS" "SHOW_DOCKER_INSTANCE_COMMANDS" "OPER_DOCKER_INSTANCE_COMMANDS" "SHOW_SUPERVISOR_COMMANDS" "SHOW_SUPERVISOR_SERVICE_COMMANDS" "OPER_SUPERVISOR_SERVICE_COMMANDS" "NETWORK_CONNECTIVITY_COMMANDS" "LIST_FILES" "LIST_SERVICE_FILES" "PACKET_CAPTURE" "SHOW_DATA_EXPORT_LGO" "SHOW_DATAEXPORT_RUNNING_CONF" "SHOW_DATA_EXPORT_SYS_COMMANDS" "UPDATE_LISTENING_PORT" "UPDATE_TAN_LOG_CONF" "SNAPSHOT_APPLIANCE" "SNAPSHOT_CONNECTOR" "SHOW_AWS_DOWNLOADER_LOG" "CONTROLLER_PROFILING" "SERVICE_PROFILING" "RESTART_CONNECTOR_CONTAINER" "RESTART_CONNECTOR_SERVICE" "CONNECTOR_ALERT_INTERVAL_APPLIANCE" "CONNECTOR_ALERT_INTERVAL_CONNECTOR" "EXEC_SCRIPT" "SHOW_SEGMENTATION_POLICIES" |
Response object: Returns the config schema for selected config type.
Sample response
resp = restclient.get('/config_groups/command_schema/SHOW_LOG')
if resp.status_code == 200:
parsed_resp = json.loads(resp.content)
print json.dumps(parsed_resp)
Sample response
{
"name": "Show logs",
"desc": "Show the contents of a log file",
"long_desc": "Show the contents of a log file and optionally grep the file for a specified pattern. The output is tailed for the last 5000 lines.",
"valid_appliances": [
"TETRATION_DATA_INGEST",
"TETRATION_EDGE",
"TETRATION_EXPORT"
],
"valid_connectors": [
"netflow",
"netscaler",
"f5",
"aws",
"anyconnect",
"slack",
"kinesis",
"syslog",
"email",
"pagerduty",
"ise",
"asa",
"meraki",
"servicenow",
"wad"
],
"arg_fillins": [
{
"field": "pattern",
"label": "Grep Pattern",
"input_type": "text",
"optional": true
}
],
"output_type": "FILE",
"output_ext": "LOG"
}