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