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