Summary
Run a Live Status command against a list of devices
Description
Run a Live Status command against a list of devices (e.g. 'show version').
Route
POST /nso_manager/runCommand
Roles
admin
Parameters
Details Example Schema
Name
Type
Required
Description
devices
array
yes
A list of names.
command
string
yes
The command to run against the devices.
options
object
yes
NSO NETCONF transaction options
Copied to Clipboard
{
"devices": "device1,device2,device3",
"command": "show ip interface brief"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"devices": {
"oneOf": [
{
"type": "array",
"items": {
"$ref": "inputDevices"
}
},
{
"$ref": "inputDevices"
}
],
"required": [
"devices"
]
},
"command": {
"type": "string",
"examples": [
"show version",
"show ip interface brief"
],
"required": [
"command"
]
},
"options": {
"type": "object",
"properties": {}
}
},
"required": [
"devices",
"command",
"options"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
results
object
Live status results.
Copied to Clipboard
[
{
"device": "in est",
"result": "incididunt dolor",
"status": "ut ex laborum sunt"
},
{
"device": "dolor occaecat ut culpa qui",
"result": "est et ut esse",
"status": "in non incididunt nulla laborum"
}
]
Copied to Clipboard
{
"type": "array",
"items": {
"type": "object",
"properties": {
"device": {
"type": "string"
},
"result": {
"type": "string"
},
"status": {
"type": "string"
}
},
"required": [
"device",
"result",
"status"
]
}
}
