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