vyos_config - Manage VyOS configuration on remote device
New in version 2.2.
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
setanddeletecommands in the device configuration.
Options
| parameter | required | default | choices | comments | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| backup | no |
| The backup argument will backup the current devices active configuration to the Ansible control host prior to making any changes. The backup file will be located in the backup folder in the root of the playbook | ||||||||||||||||||||||||||||||||||||
| comment | no | 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 | no | 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 | no | The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device. | |||||||||||||||||||||||||||||||||||||
| match | no | line |
| 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. | |||||||||||||||||||||||||||||||||||
| provider | no | A dict object containing connection details. |
|||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
| save | no |
| 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 | no | 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. | |||||||||||||||||||||||||||||||||||||
Examples
- name: configure the remote device
vyos_config:
lines:
- set system host-name {{ inventory_hostname }}
- set service lldp
- delete service dhcp-server
- name: backup and load from file
vyos_config:
src: vyos.cfg
backup: yes
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
|---|---|---|---|---|
| backup_path | The full path to the backup file | when backup is yes | string | /playbooks/ansible/backup/vyos_config.2016-07-16@22:28:34 |
| commands | The list of configuration commands sent to the device | always | list | ['...', '...'] |
| filtered | The list of configuration commands removed to avoid a load failure | always | list | ['...', '...'] |
Notes
Note
- Tested against VYOS 1.1.7
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/vyos_config_module.html