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