vyos.vyos.vyos_system_module.rst

vyos.vyos.vyos_system

Run `set system` commands on VyOS devices

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

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

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
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 ansible.netcommon.network_cli. See the VyOS OS Platform Options.
• For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <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	always	The list of configuration mode commands to send to the device Sample: ['set system hostname vyos01', 'set system domain-name foo.example.com']

Status

Authors

• Nathaniel Case (@Qalthos)