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