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