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
Details Example Schema
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",
"device1,device2,device3",
"device1,device2,device3",
"device1,device2,device3",
"device1,device2,device3"
],
"commands": [
"nostrud ut",
"dolor eu ut officia",
"velit Ut qui eu elit"
]
}
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
Details Example Schema
Name
Type
Description
results
object
Live status results.
Copied to Clipboard
[
[
{
"device": "id exercitation adipisicing esse",
"result": "anim",
"status": "deserunt esse ut dolor commodo",
"command": "Lorem eiusmod sunt Ut"
},
{
"device": "incididunt qui dolore ea amet",
"result": "minim dolor amet deserunt",
"status": "nulla est consectetur labore",
"command": "proident Ut consequat aliqua veniam"
},
{
"device": "esse dolor enim tempor minim",
"result": "voluptate",
"status": "labore consequat Excepteur",
"command": "esse incididunt sint exercitation ex"
}
],
[
{
"device": "nostrud nisi deserunt dolore",
"result": "quis id consequat",
"status": "et",
"command": "nostrud laboris aliqua"
},
{
"device": "deserunt in",
"result": "adipisicing laboris in ut",
"status": "qui laborum",
"command": "in nisi ut do"
},
{
"device": "ipsum nulla culpa nisi",
"result": "consectetur",
"status": "in reprehenderit",
"command": "reprehenderit in aliquip labore eiusmod"
},
{
"device": "irure mollit proident veniam consectetur",
"result": "ut ex tempor",
"status": "dolor",
"command": "reprehenderit anim esse non"
},
{
"device": "et mollit magna enim consectetur",
"result": "consectetur laborum quis",
"status": "veniam non laboris aliquip nostrud",
"command": "sint"
}
],
[
{
"device": "ex officia mollit id",
"result": "consequat nisi aute",
"status": "laborum anim ad qui",
"command": "dolor"
}
]
]
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"
}
]
]
}
