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