API to Create a Troubleshooting Command
This endpoint creates a troubleshooting command available for given Appliance.
POST /openapi/v1/ext_appliances/<id>/commands
where <id> is the appliance_id that can be obtained from the API to Get List of Appliances. In request payload, <command> is a troubleshooting command type that can be obtained from API to Get the Schema of Troubleshooting Commands response "valid_appliances" field. <arguments> is a filled JSON object of the command schema, which can be obtained from API to Get the Schema of Troubleshooting Commands.
Parameters: The request URL contains the following parameters
|
Name |
Type |
Description |
|---|---|---|
|
id |
string |
Specify the Appliance ID |
|
command |
string |
Specify the command type |
|
arguments |
set |
Provide the filled command schema in JSON format |
Response object: Returns the troubleshooting command created for given Appliance.
Sample response
req_payload = {
"command": "SHOW_LOG",
"arguments": {}
}
resp = restclient.post('/ext_appliances/63be3b1ade36423c12bff6e1/commands', json_body=json.dumps(req_payload))
if resp.status_code == 200:
parsed_resp = json.loads(resp.content)
print json.dumps(parsed_resp)
Sample response
{
"appliance_id": "63be3b1ade36423c12bff6e1",
"state": "pending",
"level": "APPLIANCE",
"command": "SHOW_LOG",
"args": {},
"tailed": false,
"rc": 0,
"push_to_dio_at": 0,
"attempts": 0,
"deleted": false,
"deleted_at": 0,
"created_at": 1673595392,
"total_chunk": 0,
"id": "63c10a0039042a6aee1b008c"
}