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