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",
"device1,device2,device3"
],
"commands": [
"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": "voluptate Excepteur cupidatat minim",
"result": "ullamco voluptate Excepteur do culpa",
"status": "incididunt",
"command": "Lorem"
},
{
"device": "dolore",
"result": "eiusmod",
"status": "laboris",
"command": "eiusmod"
}
],
[
{
"device": "incididunt tempor sint eiusmod nisi",
"result": "sit",
"status": "aute",
"command": "sit sint aliqua reprehenderit do"
},
{
"device": "commodo sunt dolore veniam sed",
"result": "voluptate sunt officia non dolor",
"status": "tempor aute",
"command": "anim voluptate in pariatur"
},
{
"device": "anim sint laboris",
"result": "cupidatat cillum Excepteur in irure",
"status": "officia ea pariatur",
"command": "est tempor Lorem amet in"
}
],
[
{
"device": "ipsum",
"result": "veniam pariatur exercitation dolore eiusmod",
"status": "cillum",
"command": "in reprehenderit incididunt nostrud"
},
{
"device": "sit",
"result": "proident",
"status": "id consectetur",
"command": "proident adipisicing velit laborum"
}
],
[
{
"device": "culpa",
"result": "aliqua",
"status": "exercitation",
"command": "veniam proident dolore nostrud"
}
]
]
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"
]
}
}
}
