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