community.network.edgeos_config – Manage EdgeOS configuration on remote device
community.network.edgeos_config – Manage EdgeOS configuration on remote device
Note
This plugin is part of the community.network collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.edgeos_config
.
Synopsis
- This module provides configuration file management of EdgeOS devices. It provides arguments for managing both the configuration file and state of the active configuration. All configuration statements are based on
set
anddelete
commands in the device configuration. - This is a network module and requires the
connection: network_cli
in order to work properly. - For more information please see the Network Guide.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
backup boolean |
|
The | |
backup_options dictionary |
This is a dict object containing configurable options related to backup file path. The value of this option is read only when | ||
dir_path path |
This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of | ||
filename string |
The filename to be used to store the backup configuration. If the filename is not given it will be generated based on the hostname, current time and date in format defined by _config.@ | ||
comment string |
Default: "configured by edgeos_config" |
Allows a commit description to be specified to be included when the configuration is committed. If the configuration is not changed or committed, this argument is ignored. | |
config string |
The | ||
lines string |
The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device. | ||
match string |
|
The | |
save boolean |
|
The | |
src string |
The |
Notes
Note
- Tested against EdgeOS 1.9.7
- Setting
ANSIBLE_PERSISTENT_COMMAND_TIMEOUT
to 30 is recommended since the save command can take longer than the default of 10 seconds on some EdgeOS hardware.
Examples
- name: Configure the remote device
community.network.edgeos_config:
lines:
- set system host-name {{ inventory_hostname }}
- set service lldp
- delete service dhcp-server
- name: Backup and load from file
community.network.edgeos_config:
src: edgeos.cfg
backup: yes
- name: Configurable backup path
community.network.edgeos_config:
src: edgeos.cfg
backup: yes
backup_options:
filename: backup.cfg
dir_path: /home/user
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
backup_path string |
when backup is yes |
The full path to the backup file
Sample: /playbooks/ansible/backup/edgeos_config.2016-07-16@22:28:34 |
commands list / elements=string |
always |
The list of configuration commands sent to the device
Sample: ['...', '...'] |
Authors
- Nathaniel Case (@Qalthos)
- Sam Doran (@samdoran)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/edgeos_config_module.html