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": [
"anim exercitation nisi est",
"minim mollit",
"dolor do dolore Lorem",
"quis ipsum aliquip magna aute"
]
}
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": "culpa",
"result": "eu aliquip",
"status": "commodo tempor elit officia sit",
"command": "anim"
},
{
"device": "nostrud tempor pariatur ex",
"result": "veniam sunt",
"status": "consequat",
"command": "laborum in Duis dolor"
},
{
"device": "et",
"result": "Ut ullamco officia",
"status": "sit incididunt Duis",
"command": "Duis pariatur amet"
}
],
[
{
"device": "dolore id",
"result": "reprehenderit",
"status": "ipsum sunt Ut",
"command": "esse cillum officia amet adipisicing"
}
],
[
{
"device": "minim",
"result": "sunt ex proident",
"status": "dolor velit ea",
"command": "ut exercitation irure consequat"
}
],
[
{
"device": "amet reprehenderit cupidatat",
"result": "reprehenderit",
"status": "dolor",
"command": "consequat ad"
},
{
"device": "Duis",
"result": "id deserunt",
"status": "consequat in magna est et",
"command": "ipsum irure 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"
}
]
]
}
