Runs one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully.
A list of domain names to search. Mutually exclusive with name_server
hostname
no
Configure the device hostname parameter. This option takes an ASCII string value.
name_server
no
A list of name servers to use with the device. Mutually exclusive with domain_search
provider
no
A dict object containing connection details.
Dictionary object provider
parameter
required
default
choices
comments
username
no
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.
host
yes
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.
ssh_keyfile
no
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
no
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.
password
no
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
no
22
Specifies the port to use when building the connection to the remote device.
state
no
present
present
absent
Whether to apply (present) or remove (absent) the settings.
-name:configure hostname and domain-namevyos_system:hostname:vyos01domain_name:test.example.com-name:remove all configurationvyos_system:state:absent-name:configure name serversvyos_system:name_server:-8.8.8.8-8.8.4.4-name:configure domain search suffixesvyos_system:domain_search:-sub1.example.com-sub2.example.com
For more information about Red Hat’s this support of this module, please
refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>