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