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": [
"ipsum dolore commodo veniam"
]
}
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": "ea id tempor Lorem sint",
"result": "laborum",
"status": "anim cupidatat",
"command": "nulla anim sit"
},
{
"device": "eu",
"result": "adipisicing exercitation nisi ipsum",
"status": "nisi dolore",
"command": "officia ipsum dolor Lorem velit"
},
{
"device": "cillum aliquip exercitation",
"result": "cillum anim sit culpa quis",
"status": "labore nisi ullamco",
"command": "aute"
}
],
[
{
"device": "aute ex",
"result": "do sed dolor ut eiusmod",
"status": "ullamco aute proident est nostrud",
"command": "do dolor aliquip laborum"
},
{
"device": "sit adipisicing",
"result": "do",
"status": "ut occaecat non",
"command": "in dolor ipsum ad"
}
],
[
{
"device": "sed do ad laboris",
"result": "occaecat sint in",
"status": "Lorem ea elit aute",
"command": "eiusmod"
},
{
"device": "sint",
"result": "tempor",
"status": "et minim",
"command": "est ex veniam cupidatat"
}
],
[
{
"device": "magna Excepteur consectetur commodo dolor",
"result": "sed",
"status": "minim",
"command": "elit qui pariatur"
},
{
"device": "dolore labore",
"result": "culpa aliqua",
"status": "dolor officia Excepteur commodo mollit",
"command": "in anim sit eu"
}
]
]
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"
}
]
]
}
