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