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