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