vyos.vyos.vyos_system – Run set system commands on VyOS devices
Note
This plugin is part of the vyos.vyos collection (version 2.6.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 version 1.0.0: of vyos.vyos
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 |
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 |
|
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the Network Guide. A dict object containing connection details. |
|
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. |
|
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 |
|
Specifies the port to use when building the connection to the remote device. |
|
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 |
|
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. |
|
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 |
|
Whether to apply ( Choices:
|
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 |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: [“set system hostname vyos01”, “set system domain-name foo.example.com”] |
Authors
Nathaniel Case (@Qalthos)