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