vyos.vyos.vyos_system module – Run `set system` commands on VyOS devices
Note
This module is part of the vyos.vyos collection (version 5.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install vyos.vyos
.
To use it in a playbook, specify: vyos.vyos.vyos_system
.
New in vyos.vyos 1.0.0
Synopsis
Runs one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully.
Aliases: system
Parameters
Parameter |
Comments |
---|---|
The new domain name to apply to the device. |
|
A list of domain names to search. Mutually exclusive with name_server |
|
Configure the device hostname parameter. This option takes an ASCII string value. |
|
A list of name servers to use with the device. Mutually exclusive with domain_search |
|
Whether to apply ( Choices:
|
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 |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: |