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