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