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