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