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