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": [
"est incididunt ex eu esse",
"do",
"sint do officia amet dolore",
"proident ex sit",
"esse in fugiat pariatur ea"
]
}
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": "sed exercitation sunt et",
"result": "fugiat",
"status": "reprehenderit veniam minim ad",
"command": "reprehenderit sed proident"
},
{
"device": "aliqua officia veniam ut",
"result": "aliquip dolore",
"status": "aliquip voluptate fugiat",
"command": "reprehenderit velit pariatur minim"
},
{
"device": "id veniam",
"result": "dolore",
"status": "dolor in mollit ex",
"command": "elit cupidatat cillum"
},
{
"device": "anim do est esse",
"result": "incididunt do sint minim",
"status": "mollit",
"command": "ut"
}
],
[
{
"device": "fugiat elit in sit sed",
"result": "Lorem",
"status": "eu",
"command": "elit mollit"
},
{
"device": "exercitation veniam",
"result": "nisi voluptate",
"status": "ad sit consequat officia",
"command": "magna"
}
],
[
{
"device": "in amet sint labore laboris",
"result": "do aliquip",
"status": "nulla",
"command": "eu sunt laborum nostrud"
},
{
"device": "non",
"result": "nisi dolor aute sint pariatur",
"status": "voluptate",
"command": "quis proident"
},
{
"device": "cupidatat magna in cillum",
"result": "ullamco",
"status": "aliquip sed ut",
"command": "incididunt consequat do exercitation minim"
},
{
"device": "reprehenderit",
"result": "laboris nisi in",
"status": "in culpa",
"command": "voluptate nisi"
},
{
"device": "in nisi proident",
"result": "anim",
"status": "sint minim",
"command": "laboris"
}
]
]
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"
}
]
]
}
