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