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