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": [
"qui"
]
}
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": "Lorem deserunt ut et",
"result": "aliquip fugiat laboris dolor",
"status": "Lorem reprehenderit esse",
"command": "dolor fugiat exercitation cillum"
},
{
"device": "adipisicing",
"result": "magna ea eiusmod esse",
"status": "veniam",
"command": "sint magna Ut"
},
{
"device": "nostrud occaecat",
"result": "elit tempor sunt consectetur",
"status": "pariatur ullamco laborum non",
"command": "eu sunt"
},
{
"device": "ut reprehenderit",
"result": "cillum",
"status": "officia Lorem dolor reprehenderit",
"command": "Lorem veniam ipsum"
},
{
"device": "sunt qui mollit",
"result": "cillum voluptate ipsum",
"status": "occaecat",
"command": "Lorem laborum laboris"
}
]
]
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"
]
}
}
}