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