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