community.vmware.vmware_host_dns module – Manage DNS configuration of an ESXi host system
Note
This module is part of the community.vmware collection (version 4.7.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 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.
Parameters
Parameter |
Comments |
---|---|
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. |
|
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 |
|
A list of DNS servers to be used. The order of the DNS servers is important as they are used consecutively in order. |
|
The domain name to be used for the ESXi host. |
|
Name of the host system to work with. This parameter is required if Cannot be used when you connect directly to an ESXi host. |
|
The hostname to be used for the ESXi host. Cannot be used when configuring a complete cluster. |
|
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 |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
A list of domains to be searched through by the resolver. |
|
Type of DNS assignment. Either A VMkernel adapter needs to be set to DHCP if set to Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
|
Verbose output of the DNS server configuration change. Explains if an DNS server was added, removed, or if the DNS server sequence was changed. Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
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 |
Description |
---|---|
metadata about host system’s DNS configuration Returned: always Sample: |