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