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 devices 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",
"incididunt",
"voluptate irure in labore officia",
"enim officia nostrud in",
"anim 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": "elit",
"result": "minim nulla dolore",
"status": "qui",
"command": "mollit irure eiusmod"
},
{
"device": "dolor incididunt pariatur consequat",
"result": "labore aute incididunt adipisicing",
"status": "aliquip minim veniam quis dolore",
"command": "nisi"
},
{
"device": "consectetur aute",
"result": "in amet dolore id fugiat",
"status": "reprehenderit adipisicing in",
"command": "cupidatat adipisicing labore"
},
{
"device": "Lorem amet laborum tempor mollit",
"result": "dolore laborum officia culpa",
"status": "anim fugiat veniam tempor",
"command": "dolor commodo dolore"
}
],
[
{
"device": "in nulla in reprehenderit fugiat",
"result": "ullamco",
"status": "id aliquip laborum",
"command": "elit aliquip"
},
{
"device": "dolore nostrud",
"result": "elit aliquip dolore qui",
"status": "adipisicing id",
"command": "est proident Excepteur fugiat"
}
],
[
{
"device": "irure Ut adipisicing anim pariatur",
"result": "ex consequat",
"status": "magna adipisicing",
"command": "sit dolor laboris"
},
{
"device": "aute ut enim aliquip elit",
"result": "reprehenderit consequat ullamco",
"status": "ipsum",
"command": "dolor"
}
]
]
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"
]
}
},
"example": [
[
{
"device": "ios.0",
"result": "\r\nCisco IOS Software, NETSIM\r\nios.0# ",
"status": "success",
"command": "show version"
}
],
[
{
"device": "ios.0",
"result": "\r\nios.0# ",
"status": "success",
"command": "show interfaces"
}
]
]
}
