community.network.edgeos_config module – Manage EdgeOS configuration on remote device
Note
This module is part of the community.network collection (version 5.0.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
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` and `delete` 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.
Note
This module has a corresponding action plugin.
Aliases: network.edgeos.edgeos_config
Parameters
Parameter |
Comments |
---|---|
The Choices:
|
|
This is a dict object containing configurable options related to backup file path. The value of this option is read only when |
|
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 |
|
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 <hostname>_config.<current-date>@<current-time> |
|
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. Default: |
|
The |
|
The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device. |
|
The Choices:
|
|
The Choices:
|
|
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: true
- name: Configurable backup path
community.network.edgeos_config:
src: edgeos.cfg
backup: true
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 |
Description |
---|---|
The full path to the backup file Returned: when backup is yes Sample: |
|
The list of configuration commands sent to the device Returned: always Sample: |