API to List Troubleshooting Commands Available for an Appliance
This endpoint returns the list of troubleshooting commands available for given Appliance.
GET /openapi/v1/ext_appliances/<id>/commands/available
where <id> is the appliance_id that can be obtained from the API to Get List of Appliances.
Parameters: The request URL contains the following parameters
|
Name |
Type |
Description |
|---|---|---|
|
id |
string |
Specify the Appliance ID |
Response object: Returns the list of troubleshooting commands available for given Appliance.
Sample response
resp = restclient.get('/ext_appliances/63c6ef42bca44e2b5e729191/commands/available')
if resp.status_code == 200:
parsed_resp = json.loads(resp.content)
print json.dumps(parsed_resp)
Sample response
[
{
"type": "UPDATE_LISTENING_PORT",
"name": "Update the listening port on a connector"
},
{
"type": "SNAPSHOT_APPLIANCE",
"name": "Collect Snapshot from Appliance"
},
{
"type": "LIST_FILES",
"name": "List a directory"
},
{
"type": "CONTROLLER_PROFILING",
"name": "Collect controller profile"
},
{
"type": "SHOW_LOG",
"name": "Show logs"
},
{
"type": "SHOW_SUPERVISOR_COMMANDS",
"name": "Execute supervisorctl command"
},
{
"type": "PACKET_CAPTURE",
"name": "Packet capture"
},
{
"type": "NETWORK_CONNECTIVITY_COMMANDS",
"name": "Test network connectivity"
},
{
"type": "SHOW_DOCKER_COMMANDS",
"name": "Execute docker command"
},
{
"type": "CONNECTOR_ALERT_INTERVAL_APPLIANCE",
"name": "Override connector alert interval for Appliance"
},
{
"type": "SHOW_RUNNING_CONF",
"name": "Show running configuration"
},
{
"type": "SHOW_SYS_COMMANDS",
"name": "Execute system command"
}
]