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