| domain_name |
The new domain name to apply to the device.
| domain_search |
A list of domain names to search. Mutually exclusive with name_server
| host_name |
Configure the device hostname parameter. This option takes an ASCII string value.
| name_servers |
A list of name servers to use with the device. Mutually exclusive with domain_search
| provider |
Starting with Ansible 2.5 we recommend using
For more information please see the Network Guide.
A dict object containing connection details.
| host |
string / required
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 |
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
| port |
| Default: |
Specifies the port to use when building the connection to the remote device.
| ssh_keyfile |
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
| timeout |
| Default: |
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 |
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
| state |
| || |
Whether to apply (
- name: configure hostname and domain-name vyos_system: host_name: vyos01 domain_name: test.example.com - name: remove all configuration vyos_system: state: absent - name: configure name servers vyos_system: name_servers - 184.108.40.206 - 220.127.116.11 - name: configure domain search suffixes vyos_system: domain_search: - sub1.example.com - sub2.example.com
Common return values are documented here, the following are the fields unique to this module:
| commands |
The list of configuration mode commands to send to the device
['set system hostname vyos01', 'set system domain-name foo.example.com']
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.