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