Summary
Run a list of Live Status commands against a list of devices
Description
Run a list of Live Status commands against a list of devices (e.g. ['show version', 'show ip interface brief']).
Route
POST /nso_manager/runCommands
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| devices |
array |
yes |
A list of devices names. |
| commands |
array |
yes |
The commands to run against the devices. |
| options |
object |
yes |
NSO NETCONF transaction options |
Copied to Clipboard
{
"devices": "device1,device2,device3",
"commands": [
"ipsum veniam officia dolore",
"dolor eu anim",
"dolore voluptate ex",
"enim velit",
"ad aliqua in tempor"
]
}
Copied to Clipboard
{
"type": "object",
"properties": {
"devices": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "inputDevices"
}
},
{
"$ref": "inputDevices"
}
],
"required": [
"devices"
]
},
"commands": {
"type": "array",
"items": {
"type": "string"
},
"required": [
"commands"
]
},
"options": {
"type": "object",
"properties": {}
}
},
"required": [
"devices",
"commands",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| results |
object |
Live status results. |
Copied to Clipboard
[
[
{
"device": "est ullamco veniam in sunt",
"result": "anim",
"status": "tempor",
"command": "dolore Excepteur nisi veniam commodo"
},
{
"device": "aliqua tempor adipisicing ea",
"result": "dolor",
"status": "sint nulla reprehenderit",
"command": "Duis ut fugiat"
},
{
"device": "sint aliqua ad labore",
"result": "fugiat dolore mollit",
"status": "dolor veniam incididunt cupidatat",
"command": "pariatur cupidatat reprehenderit"
},
{
"device": "cillum ut id magna",
"result": "ad Lorem ut Duis",
"status": "dolore sed consectetur sint",
"command": "sit in"
}
],
[
{
"device": "Lorem",
"result": "aliquip",
"status": "aliqua consequat",
"command": "sunt cillum enim ut"
},
{
"device": "cupidatat ad nisi",
"result": "ut esse ut",
"status": "commodo consequat",
"command": "ea culpa proident sed"
},
{
"device": "nulla exercitation",
"result": "cillum",
"status": "quis laboris occaecat",
"command": "incididunt elit adipisicing"
},
{
"device": "adipisicing",
"result": "nostrud",
"status": "et ad Ut cillum sunt",
"command": "elit laborum nisi"
}
],
[
{
"device": "voluptate nostrud cillum dolor ad",
"result": "id",
"status": "incididunt Lorem",
"command": "aliqua ut pariatur"
},
{
"device": "cupidatat elit pariatur",
"result": "amet ut",
"status": "Duis",
"command": "Ut"
},
{
"device": "dolor minim in",
"result": "aute adipisicing aliquip id",
"status": "nisi do ullamco",
"command": "reprehenderit cupidatat"
}
]
]
Copied to Clipboard
{
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"device": {
"type": "string"
},
"result": {
"type": "string"
},
"status": {
"type": "string"
},
"command": {
"type": "string"
}
},
"required": [
"device",
"result",
"status",
"command"
]
}
},
"example": [
[
{
"device": "ios.0",
"result": "\r\nCisco IOS Software, NETSIM\r\nios.0# ",
"status": "success",
"command": "show version"
}
],
[
{
"device": "ios.0",
"result": "\r\nios.0# ",
"status": "success",
"command": "show interfaces"
}
]
]
}
