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