Summary
Run a Live Status command against a list of devices
Description
Run a Live Status command against a list of devices (e.g. 'show version', 'show interfaces).
Route
POST /nso_manager/runCommand
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| devices |
array |
yes |
A list of devices names. |
| command |
string |
yes |
The command to run against the devices. |
| options |
object |
yes |
NSO NETCONF transaction options |
Copied to Clipboard
{
"devices": [
"device1,device2,device3",
"device1,device2,device3",
"device1,device2,device3",
"device1,device2,device3"
],
"command": "show version"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"devices": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "inputDevices"
}
},
{
"$ref": "inputDevices"
}
],
"required": [
"devices"
]
},
"command": {
"type": "string",
"examples": [
"show version",
"show ip interface brief",
"show interfaces"
],
"required": [
"command"
]
},
"options": {
"type": "object",
"properties": {}
}
},
"required": [
"devices",
"command",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| results |
object |
Live status results. |
Copied to Clipboard
{
"device": "ios.0",
"result": "\r\nCisco IOS Software, NETSIM\r\nios.0# ",
"status": "success"
}
Copied to Clipboard
{
"type": "array",
"items": {
"type": "object",
"properties": {
"device": {
"type": "string"
},
"result": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"device",
"result",
"status"
]
},
"examples": [
{
"device": "ios.0",
"result": "\r\nCisco IOS Software, NETSIM\r\nios.0# ",
"status": "success"
}
]
}
