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 and delete commands in the device configuration.
Parameters¶
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| backup 
                    boolean
                                                                 | 
 | The  backupargument will backup the current devices active configuration to the Ansible control host prior to making any changes. If thebackup_optionsvalue 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
                                                                 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  backupis set to yes, ifbackupis 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  filenameor default filename as described infilenameoptions 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 infilenamewithin backup directory. | ||
| 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 <hostname>_config.<current-date>@<current-time> | ||
| 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  configargument 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 
                    -
                                                                 | 
 | The  matchargument 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 thematchargument is set tononethe active configuration is ignored and the configuration is always loaded. | |
| provider 
                    dictionary
                                                                 | Deprecated Starting with Ansible 2.5 we recommend using  connection: network_cli.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  ANSIBLE_NET_PASSWORDwill be used instead. | ||
| 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  ANSIBLE_NET_SSH_KEYFILEwill be used instead. | ||
| 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  ANSIBLE_NET_USERNAMEwill be used instead. | ||
| save 
                    boolean
                                                                 | 
 | The  saveargument 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  srcargument 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 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:
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)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
