Summary
wrapper of send_command of netmiko
Description
wrapper of send_command of netmiko
Route
POST /automationgateway/netmiko/send_command
Roles
admin
Parameters
Details Example Schema
Name
Type
Required
Description
netmikoSendCommandParameters
object
yes
-
Copied to Clipboard
{
"netmikoSendCommandParameters": {
"host": "et id ut eiusmod pariatur",
"commands": [
"voluptate cillum",
"eu ut",
"sint in pariatur ut voluptate"
],
"connection_options": {
"device_type": "laborum cupidatat enim in",
"password": "in enim dolor consequat",
"port": 22,
"username": "nostrud sed consectetur do commodo"
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"netmikoSendCommandParameters": {
"properties": {
"commands": {
"example": [
"pwd",
"show ip int brief"
],
"items": {
"type": "string"
},
"type": "array"
},
"connection_options": {
"properties": {
"device_type": {
"example": "cisco_ios",
"type": "string"
},
"password": {
"example": "password",
"type": "string"
},
"port": {
"default": 22,
"example": 22,
"type": "integer"
},
"username": {
"example": "root",
"type": "string"
}
},
"required": [
"device_type"
],
"type": "object"
},
"host": {
"example": "172.17.0.2",
"type": "string"
}
},
"required": [
"host",
"commands",
"connection_options"
],
"type": "object"
}
},
"required": [
"netmikoSendCommandParameters"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
result
object
A JSON Object containing status, code and the result
Copied to Clipboard
{
"title": "result",
"type": "object"
}
