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",
"device1,device2,device3",
"device1,device2,device3",
"device1,device2,device3",
"device1,device2,device3"
],
"commands": [
"quis deserunt adipisicing",
"in",
"tempor consequat est fugiat"
]
}
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": "ullamco Ut id fugiat in",
"result": "reprehenderit ullamco aliquip laboris",
"status": "consectetur eiusmod",
"command": "nostrud occaecat"
},
{
"device": "eiusmod quis cillum",
"result": "occaecat dolore",
"status": "proident in id",
"command": "labore adipisicing non in anim"
},
{
"device": "Duis",
"result": "culpa in cillum do",
"status": "dolor eiusmod et ipsum do",
"command": "deserunt veniam"
}
],
[
{
"device": "Lorem",
"result": "aute sit consequat commodo",
"status": "elit dolor aute",
"command": "dolore consequat fugiat commodo"
},
{
"device": "aute magna proident in enim",
"result": "incididunt reprehenderit cillum ea",
"status": "ea quis id ut non",
"command": "incididunt dolore Ut"
},
{
"device": "elit et labore anim",
"result": "elit in",
"status": "in aliquip",
"command": "nulla"
},
{
"device": "aliqua",
"result": "et qui occaecat ea minim",
"status": "in",
"command": "eu aute ad laborum quis"
}
],
[
{
"device": "occaecat Ut do culpa ipsum",
"result": "magna et",
"status": "sint occaecat pariatur",
"command": "ex dolore exercitation"
},
{
"device": "Excepteur",
"result": "velit consequat do quis",
"status": "ut",
"command": "nisi cillum"
},
{
"device": "dolor",
"result": "reprehenderit quis",
"status": "in elit veniam Duis exercitation",
"command": "voluptate ullamco qui"
},
{
"device": "commodo est",
"result": "nisi ut dolore dolor cupidatat",
"status": "aute in esse mollit cillum",
"command": "dolor dolor amet nostrud consequat"
},
{
"device": "anim eu tempor dolore",
"result": "Excepteur",
"status": "tempor",
"command": "aliqua velit Excepteur"
}
]
]
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"
}
]
]
}
