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