Summary
IAG Native Netmiko send_config_set
Description
Netmiko send_config_set wrapper which accepts all function parameters
Route
POST /automationgateway/netmikoSendConfigSet
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| host |
string |
yes |
Either hostname or ip accepted |
| configCommands |
array |
yes |
Multiple configuration commands to be sent to the device |
| exitConfigMode |
boolean |
no |
Determines whether or not to exit config mode after complete |
| delayFactor |
number |
no |
Factor to adjust delays |
| maxLoops |
number |
no |
Controls wait time in conjunction with delay_factor (default to 150) |
| stripPrompt |
boolean |
no |
Determines whether or not to strip the prompt |
| stripCommand |
boolean |
no |
Determines whether or not to strip the command |
| configModeCommand |
string |
no |
The command to enter into config mode |
| cmdVerify |
boolean |
no |
Whether or not to verify command echo for each command in config_set |
| enterConfigMode |
boolean |
no |
Do you enter config mode before sending config commands |
| errorPattern |
string |
no |
Regular expression pattern to detect config errors in the output. |
Copied to Clipboard
{
"host": "xr9kv-atl",
"configCommands": "cisco_device",
"exitConfigMode": true,
"delayFactor": 0,
"maxLoops": 0,
"stripPrompt": false,
"stripCommand": true,
"configModeCommand": "configure terminal",
"cmdVerify": false,
"enterConfigMode": true,
"errorPattern": "^asb?{2}"
}
Copied to Clipboard
{
"type": "object",
"properties": {
"host": {
"title": "host",
"type": "string",
"$ref": "deviceData#/definitions/deviceName"
},
"configCommands": {
"title": "configCommands",
"type": "array",
"items": {
"type": "string"
},
"examples": [
"cisco_device"
]
},
"exitConfigMode": {
"title": "exitConfigMode",
"type": "boolean",
"examples": [
true,
false
]
},
"delayFactor": {
"title": "delayFactor",
"type": "number",
"examples": [
0
]
},
"maxLoops": {
"title": "maxLoops",
"type": "number",
"examples": [
0
]
},
"stripPrompt": {
"title": "stripPrompt",
"type": "boolean",
"examples": [
true,
false
]
},
"stripCommand": {
"title": "stripCommand",
"type": "boolean",
"examples": [
true,
false
]
},
"configModeCommand": {
"title": "configModeCommand",
"type": "string",
"examples": [
"configure terminal"
]
},
"cmdVerify": {
"title": "cmdVerify",
"type": "boolean",
"examples": [
true,
false
]
},
"enterConfigMode": {
"title": "enterConfigMode",
"type": "boolean",
"examples": [
true,
false
]
},
"errorPattern": {
"title": "errorPattern",
"type": "string",
"examples": [
"^asb?{2}"
]
}
},
"required": [
"host",
"configCommands"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
A JSON Object containing status, code and the result |
Copied to Clipboard
{
"config_commands": [
"show version"
],
"error_msg": "TCP connection to device faile",
"host": "netmiko",
"status": "FAILURE"
}
Copied to Clipboard
{
"properties": {
"config_commands": {
"items": {
"type": "string",
"examples": [
"show version"
]
},
"type": "array"
},
"error_msg": {
"type": "string",
"examples": [
"TCP connection to device faile"
]
},
"host": {
"type": "string",
"examples": [
"netmiko"
]
},
"status": {
"enum": [
"SUCCESS",
"FAILURE"
],
"type": "string"
}
},
"type": "object"
}
