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