community.network.edgeos_config – Manage EdgeOS configuration on remote device¶
Note
This plugin is part of the community.network collection (version 2.1.1).
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.
Parameters¶
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:
Authors¶
Nathaniel Case (@Qalthos)
Sam Doran (@samdoran)