vyos.vyos.vyos_config module – Manage VyOS configuration on remote device
Note
This module is part of the vyos.vyos collection (version 5.0.0).
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 vyos.vyos.
To use it in a playbook, specify: vyos.vyos.vyos_config.
New in vyos.vyos 1.0.0
Synopsis
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.
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 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. |
|
The Choices:
|
|
The Choices:
|
|
The |
Notes
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>`
Examples
- 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/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: |
|
The date extracted from the backup file name Returned: when backup is yes Sample: |
|
The name of the backup file Returned: when backup is yes and filename is not specified in backup options Sample: |
|
The list of configuration commands removed to avoid a load failure Returned: always Sample: |
|
The full path to the backup file excluding the timestamp Returned: when backup is yes and filename is not specified in backup options Sample: |
|
The time extracted from the backup file name Returned: when backup is yes Sample: |