vyos_config – Manage VyOS configuration on remote device
vyos_config – Manage VyOS configuration on remote device
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
anddelete
commands in the device configuration.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
backup boolean |
|
The | |
backup_options dictionary added in 2.8 |
This is a dict object containing configurable options related to backup file path. The value of this option is read only when | ||
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 - |
The filename to be used to store the backup configuration. If the the filename is not given it will be generated based on the hostname, current time and date in format defined by _config.@ | ||
comment - |
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 - |
The | ||
lines - |
The ordered set of configuration lines to be managed and compared with the existing configuration on the remote device. | ||
match - |
|
The | |
provider dictionary |
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the Network Guide. A dict object containing connection details. | ||
host string / required |
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. | ||
password string |
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
port integer |
Default: 22 |
Specifies the port to use when building the connection to the remote device. | |
ssh_keyfile path |
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
timeout integer |
Default: 10 |
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. | |
username string |
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
save boolean |
|
The | |
src - |
The |
Notes
Note
- Tested against VyOS 1.1.8 (helium).
- This module works with connection
network_cli
. See the VyOS OS Platform Options. - For more information on using Ansible to manage network devices see the Ansible Network Guide
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
- name: render a Jinja2 template onto the VyOS router
vyos_config:
src: vyos_template.j2
- name: for idempotency, use full-form commands
vyos_config:
lines:
# - set int eth eth2 description 'OUTSIDE'
- set interface ethernet eth2 description 'OUTSIDE'
- name: configurable backup path
vyos_config:
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:
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 |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors
- Nathaniel Case (@Qalthos)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vyos_config_module.html