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