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": [
"culpa aute Lorem",
"cupidatat",
"id ex qui"
]
}
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": "pariatur non reprehenderit aute ipsum",
"result": "nisi ea minim tempor",
"status": "deserunt",
"command": "irure"
}
],
[
{
"device": "Ut",
"result": "officia",
"status": "laborum voluptate tempor",
"command": "nisi nostrud magna"
},
{
"device": "fugiat qui",
"result": "Ut",
"status": "velit labore Lorem",
"command": "culpa non"
},
{
"device": "anim",
"result": "eiusmod qui non",
"status": "nostrud nulla",
"command": "veniam"
},
{
"device": "cupidatat velit ut magna",
"result": "proident irure Lorem voluptate ut",
"status": "voluptate",
"command": "consequat laborum et"
},
{
"device": "voluptate ea incididunt culpa",
"result": "in",
"status": "non in mollit in aliqua",
"command": "Duis incididunt ex officia sint"
}
],
[
{
"device": "mollit aute cupidatat",
"result": "nostrud",
"status": "ea occaecat",
"command": "qui in reprehenderit"
},
{
"device": "irure fugiat eiusmod reprehenderit",
"result": "Ut magna elit adipisicing",
"status": "commodo",
"command": "exercitation eiusmod ea ex"
},
{
"device": "veniam ea dolor",
"result": "magna",
"status": "anim",
"command": "irure incididunt culpa"
}
]
]
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"
}
]
]
}