Manage VyOS configuration on remote device
Version added: 1.0.0
- This module provides configuration file management of VyOS 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.
| Parameter |
Choices/Defaults |
Comments |
|
backup
boolean
|
|
The backup argument will backup the current devices active configuration to the Ansible control host prior to making any changes. If the backup_options value is not given, the backup file will be located in the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.
|
|
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 backup is set to yes, if backup is set to no this option will be silently ignored.
|
|
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 or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.
|
|
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 <hostname>_config.<current-date>@<current-time>
|
|
comment
string
|
Default:
"configured by vyos_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 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. The configuration lines in the option value should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
|
|
lines
list
/ elements=string
|
|
The ordered set of commands that should be configured in the section. The commands must be the exact same commands as found in the device running-config as found in the device running-config to ensure idempotency and correct diff. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.
|
|
match
string
|
|
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
boolean
|
|
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
path
|
|
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. The configuration lines in the source file should be similar to how it will appear if present in the running-configuration of the device including indentation to ensure idempotency and correct diff.
|
Note
- Tested against VyOS 1.1.8 (helium).
- This module works with connection
ansible.netcommon.network_cli. See the VyOS OS Platform Options.
- To ensure idempotency and correct diff the configuration lines in the relevant module options should be similar to how they appear if present in the running configuration on device including the indentation.
- For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
- name: configure the remote device
vyos.vyos.vyos_config:
lines:
- set system host-name {{ inventory_hostname }}
- set service lldp
- delete service dhcp-server
- name: backup and load from file
vyos.vyos.vyos_config:
src: vyos.cfg
backup: true
- name: render a Jinja2 template onto the VyOS router
vyos.vyos.vyos_config:
src: vyos_template.j2
- name: for idempotency, use full-form commands
vyos.vyos.vyos_config:
lines:
# - set int eth eth2 description 'OUTSIDE'
- set interface ethernet eth2 description 'OUTSIDE'
- name: configurable backup path
vyos.vyos.vyos_config:
backup: true
backup_options:
filename: backup.cfg
dir_path: /home/userCommon 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/vyos_config.2016-07-16@22:28:34
|
|
commands
list
|
always |
The list of configuration commands sent to the device
Sample:
['...', '...']
|
|
date
string
|
when backup is yes |
The date extracted from the backup file name
Sample:
2016-07-16
|
|
filename
string
|
when backup is yes and filename is not specified in backup options |
The name of the backup file
Sample:
vyos_config.2016-07-16@22:28:34
|
|
filtered
list
|
always |
The list of configuration commands removed to avoid a load failure
Sample:
['...', '...']
|
|
shortname
string
|
when backup is yes and filename is not specified in backup options |
The full path to the backup file excluding the timestamp
Sample:
/playbooks/ansible/backup/vyos_config
|
|
time
string
|
when backup is yes |
The time extracted from the backup file name
Sample:
22:28:34
|
- Nathaniel Case (@Qalthos)