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"
],
"commands": [
"commodo in",
"eiusmod",
"ut eiusmod fugiat sed",
"reprehenderit ex id",
"Duis esse"
]
}
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": "minim",
"result": "exercitation",
"status": "Lorem sit do non",
"command": "dolor ex in magna id"
},
{
"device": "in ut",
"result": "ea est",
"status": "irure aliqua aliquip sint",
"command": "id ut in adipisicing in"
},
{
"device": "laboris Duis magna dolore Ut",
"result": "exercitation proident sit",
"status": "reprehenderit",
"command": "aliqua nulla sit incididunt"
},
{
"device": "anim non nostrud incididunt aliqua",
"result": "consectetur aliqua",
"status": "et",
"command": "amet"
},
{
"device": "nulla laboris",
"result": "sunt enim",
"status": "laboris nisi ut",
"command": "labore dolor elit aute"
}
],
[
{
"device": "non sed fugiat",
"result": "ullamco et",
"status": "ex eu",
"command": "quis"
}
]
]
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"
}
]
]
}
