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