community.vmware.vmware_host_dns – Manage DNS configuration of an ESXi host system
community.vmware.vmware_host_dns – Manage DNS configuration of an ESXi host system
Note
This plugin is part of the community.vmware collection (version 1.6.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_host_dns
.
Synopsis
- This module can be used to configure DNS for the default TCP/IP stack on an ESXi host system.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
cluster_name string |
Name of the cluster from which all host systems will be used. This parameter is required if Cannot be used when you connect directly to an ESXi host. | |
device string |
The VMkernel network adapter to obtain DNS settings from. Needs to get its IP through DHCP, a static network configuration combined with a dynamic DNS configuration doesn't work. The parameter is only required in case of | |
dns_servers list / elements=string |
A list of DNS servers to be used. The order of the DNS servers is important as they are used consecutively in order. | |
domain string |
The domain name to be used for the ESXi host. | |
esxi_hostname string |
Name of the host system to work with. This parameter is required if Cannot be used when you connect directly to an ESXi host. | |
host_name string |
The hostname to be used for the ESXi host. Cannot be used when configuring a complete cluster. | |
hostname string |
The hostname or IP address of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. | |
password string |
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6.
| |
port integer |
Default: 443 |
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
proxy_host string |
Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 | |
proxy_port integer |
Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable | |
search_domains list / elements=string |
A list of domains to be searched through by the resolver. | |
type string / required |
|
Type of DNS assignment. Either A VMkernel adapter needs to be set to DHCP if |
username string |
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6.
| |
validate_certs boolean |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to |
verbose boolean |
|
Verbose output of the DNS server configuration change. Explains if an DNS server was added, removed, or if the DNS server sequence was changed. |
Notes
Note
- This module is a replacement for the module
vmware_dns_config
- Tested on vSphere 6.7
Examples
- name: Configure DNS for an ESXi host
community.vmware.vmware_host_dns:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
type: static
host_name: esx01
domain: example.local
dns_servers:
- 192.168.1.10
- 192.168.1.11
search_domains:
- subdomain.example.local
- example.local
delegate_to: localhost
- name: Configure DNS for all ESXi hosts of a cluster
community.vmware.vmware_host_dns:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: '{{ cluster_name }}'
type: static
domain: example.local
dns_servers:
- 192.168.1.10
- 192.168.1.11
search_domains:
- subdomain.example.local
- example.local
delegate_to: localhost
- name: Configure DNS via DHCP for an ESXi host
community.vmware.vmware_host_dns:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
type: dhcp
device: vmk0
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
dns_config_result dictionary |
always |
metadata about host system's DNS configuration
Sample: {'esx01.example.local': {'changed': True, 'dns_servers': ['192.168.1.10', '192.168.1.11'], 'dns_servers_changed': ['192.168.1.12', '192.168.1.13'], 'dns_servers_previous': ['192.168.1.10', '192.168.1.11', '192.168.1.12', '192.168.1.13'], 'domain': 'example.local', 'host_name': 'esx01', 'msg': 'DNS servers and Search domains changed', 'search_domains': ['subdomain.example.local', 'example.local'], 'search_domains_changed': ['subdomain.example.local'], 'search_domains_previous': ['example.local']}} |
Authors
- Christian Kotte (@ckotte)
- Mario Lenz (@mariolenz)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_host_dns_module.html