Summary
wrapper of send_config_set of netmiko
Description
wrapper of send_config_set of netmiko
Route
POST /automationgateway/netmiko/send_config
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| netmikoSendConfigParameters |
object |
yes |
connection and config information
https://ktbyers.github.io/netmiko/docs/netmiko/base_connection.html: {"config_commands": "array", "connection_options": {"device_type": "string", "password": "string", "port": 123, "username": "string"}, "host": "string"} |
Copied to Clipboard
{
"netmikoSendConfigParameters": {
"host": "172.17.0.2",
"config_commands": [
"logging buffered 20010",
"no logging console"
],
"connection_options": {
"device_type": "cisco_ios",
"password": "password",
"port": 22,
"username": "root"
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"netmikoSendConfigParameters": {
"properties": {
"config_commands": {
"items": {
"type": "string",
"examples": [
"logging buffered 20000",
"logging buffered 20010",
"no logging console"
]
},
"type": "array"
},
"connection_options": {
"properties": {
"device_type": {
"examples": [
"cisco_ios"
],
"type": "string"
},
"password": {
"examples": [
"password"
],
"type": "string"
},
"port": {
"default": 22,
"example": 22,
"type": "integer"
},
"username": {
"examples": [
"root"
],
"type": "string"
}
},
"required": [
"device_type"
],
"type": "object"
},
"host": {
"examples": [
"172.17.0.2"
],
"type": "string"
}
},
"required": [
"host",
"config_commands",
"connection_options"
],
"type": "object"
}
},
"required": [
"netmikoSendConfigParameters"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
A JSON Object containing status, code and the result |
Copied to Clipboard
{
"key": "result",
"status": "200"
}
