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