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