vyos.vyos.vyos_system – Run set system commands on VyOS devices

Note

This plugin is part of the vyos.vyos collection (version 1.1.0).

To install it use: ansible-galaxy collection install vyos.vyos.

To use it in a playbook, specify: vyos.vyos.vyos_system.

New in version 1.0.0: of vyos.vyos

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Runs one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully.

Note

This module has a corresponding action plugin.

Parameters

Parameter		Choices/Defaults	Comments
domain_name string			The new domain name to apply to the device.
domain_search list / elements=string			A list of domain names to search. Mutually exclusive with name_server
host_name string			Configure the device hostname parameter. This option takes an ASCII string value.
name_server list / elements=string			A list of name servers to use with the device. Mutually exclusive with domain_search aliases: name_servers
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		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_PASSWORD` will be used instead.
	port integer		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_KEYFILE` will be used instead.
	timeout integer		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_USERNAME` will be used instead.
state string		Choices: present ← absent	Whether to apply (`present`) or remove (`absent`) the settings.

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 hostname and domain-name
  vyos.vyos.vyos_system:
    host_name: vyos01
    domain_name: test.example.com

- name: remove all configuration
  vyos.vyos.vyos_system:
    state: absent

- name: configure name servers
  vyos.vyos.vyos_system: name_servers - 8.8.8.8 - 8.8.4.4
- name: configure domain search suffixes
  vyos.vyos.vyos_system:
    domain_search:
    - sub1.example.com
    - sub2.example.com

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
commands list / elements=string	always	The list of configuration mode commands to send to the device Sample: ['set system hostname vyos01', 'set system domain-name foo.example.com']

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.10/collections/vyos/vyos/vyos_system_module.html