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