Summary
Run a command on a device
Description
This method will run the provided command on a device
Route
No Northbound API Available
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| devices |
array |
yes |
the name of device(s) to run the command on |
| command |
string |
yes |
the command to run on the device |
| options |
object |
yes |
the options to include in the command |
Copied to Clipboard
{
"devices": [
"xr9kv-atl"
],
"command": "show version"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "deviceData#/definitions/deviceName"
}
},
"command": {
"type": "string",
"examples": [
"show version"
]
},
"options": {
"type": "object",
"properties": {},
"examples": [
{}
]
}
},
"required": [
"devices",
"command",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
An object containing the status of running the command on all devices |
Copied to Clipboard
{
"result": [
{
"device": "some-device-name",
"status": "failure",
"result": "Output of the command"
},
{
"device": "some-device-name",
"status": "failure",
"result": "Output of the command"
},
{
"device": "some-device-name",
"status": "success",
"result": "Output of the command"
},
{
"device": "some-device-name",
"status": "success",
"result": "Output of the command"
},
{
"device": "some-device-name",
"status": "failure",
"result": "Output of the command"
}
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"type": "object",
"properties": {
"device": {
"type": "string",
"description": "The Device name",
"examples": [
"some-device-name"
]
},
"status": {
"type": "string",
"description": "The status of the command",
"examples": [
"failure",
"success"
]
},
"result": {
"type": "string",
"description": "The result of the run command or the error response",
"examples": [
"Output of the command"
]
}
}
}
}
}
}
