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