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