edgeos_config - Manage EdgeOS configuration on remote device¶

New in version 2.5.

Synopsis
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

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.

Parameters ¶

Parameter	Choices/Defaults	Comments
backup bool	Choices: no ← yes	The `backup` argument will backup the current device's active configuration to the Ansible control host prior to making any changes. The backup file will be located in the backup folder in the playbook root directory or role root directory if the playbook is part of an ansible role. If the directory does not exist, it is created.
comment	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		The `config` argument specifies the base configuration to use to compare against the desired configuration. If this value is not specified, the module will automatically retrieve the current active configuration from the remote device.
lines		The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device.
match	Choices: line ← none	The `match` argument controls the method used to match against the current active configuration. By default, the desired config is matched against the active config and the deltas are loaded. If the `match` argument is set to `none` the active configuration is ignored and the configuration is always loaded.
save bool	Choices: no ← yes	The `save` argument controls whether or not changes made to the active configuration are saved to disk. This is independent of committing the config. When set to `True`, the active configuration is saved.
src		The `src` argument specifies the path to the source config file to load. The source config file can either be in bracket format or set format. The source file can include Jinja2 template variables.

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
  edgeos_config:
    lines:
      - set system host-name {{ inventory_hostname }}
      - set service lldp
      - delete service dhcp-server

- name: backup and load from file
  edgeos_config:
    src: edgeos.cfg
    backup: yes

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/[email protected]:28:34
commands list	always	The list of configuration commands sent to the device Sample: ['...', '...']
filtered list	always	The list of configuration commands removed to avoid a load failure Sample: ['...', '...']

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Nathaniel Case (@qalthos)
Sam Doran (@samdoran)

Hint

If you notice any issues in this documentation you can edit this document to improve it.