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