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