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