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": [
"dolor officia sint"
]
}
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": "reprehenderit",
"result": "occaecat irure",
"status": "enim sint qui eiusmod",
"command": "ullamco consectetur nisi cillum et"
},
{
"device": "nulla id",
"result": "laboris incididunt veniam fugiat",
"status": "sit enim eiusmod occaecat in",
"command": "qui reprehenderit"
},
{
"device": "quis id aliqua",
"result": "et Ut dolore",
"status": "tempor labore id ex consequat",
"command": "incididunt nulla"
},
{
"device": "ipsum est officia Duis culpa",
"result": "consectetur fugiat nostrud sed",
"status": "nostrud dolor ut Duis",
"command": "ex esse ut incididunt enim"
},
{
"device": "veniam tempor",
"result": "consequat",
"status": "aliqua tempor nulla sed",
"command": "dolor dolor fugiat esse sed"
}
],
[
{
"device": "culpa",
"result": "exercitation occaecat ut",
"status": "amet occaecat est",
"command": "esse ullamco irure tempor cupidatat"
},
{
"device": "minim aliqua amet nulla",
"result": "enim",
"status": "Ut",
"command": "ad mollit incididunt irure laboris"
},
{
"device": "dolor esse dolore magna",
"result": "Excepteur velit",
"status": "et qui",
"command": "dolore"
}
]
]
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"
}
]
]
}
