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