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