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