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