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