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