vmware_host_dns_facts – Gathers facts about an ESXi host’s DNS configuration information¶
New in version 2.5.
DEPRECATED¶
Removed in Ansible: | |
---|---|
version: 2.13 | |
Why: | Deprecated in favour of _info module. |
Alternative: | Use vmware_host_dns_info instead. |
Synopsis¶
- This module can be used to gather facts about an ESXi host’s DNS configuration information when ESXi hostname or Cluster name is given.
- All parameters and VMware object names are case sensitive.
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 the ESXi host belong to.
If
esxi_hostname is not given, this parameter is required. |
|
esxi_hostname
string
|
ESXi hostname to gather facts from.
If
cluster_name is not given, this parameter is required. |
|
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
VMWARE_HOST will be used instead.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
VMWARE_PASSWORD will be used instead.Environment variable support added in Ansible 2.6.
aliases: pass, pwd |
|
port
integer
added in 2.5 |
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
VMWARE_PORT will be used instead.Environment variable support added in Ansible 2.6.
|
proxy_host
string
added in 2.9 |
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
VMWARE_PROXY_HOST will be used instead.This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
|
|
proxy_port
integer
added in 2.9 |
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
VMWARE_PROXY_PORT will be used instead. |
|
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
VMWARE_USER will be used instead.Environment variable support added in Ansible 2.6.
aliases: admin, user |
|
validate_certs
boolean
|
|
Allows connection when SSL certificates are not valid. Set to
false when certificates are not trusted.If the value is not specified in the task, the value of environment variable
VMWARE_VALIDATE_CERTS will be used instead.Environment variable support added in Ansible 2.6.
If set to
yes , please make sure Python >= 2.7.9 is installed on the given machine. |
Examples¶
- name: Gather DNS facts about all ESXi Hosts in given Cluster
vmware_host_dns_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
cluster_name: cluster_name
delegate_to: localhost
- name: Gather DNS facts about ESXi Host
vmware_host_dns_facts:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
esxi_hostname: '{{ esxi_hostname }}'
delegate_to: localhost
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
hosts_dns_facts
dictionary
|
always |
metadata about DNS config from given cluster / host system
Sample:
{'DC0_C0_H0': {'dhcp': True, 'domain_name': 'localdomain', 'host_name': 'localhost', 'ip_address': ['8.8.8.8'], 'search_domain': ['localdomain'], 'virtual_nic_device': 'vmk0'}}
|
Status¶
- This module will be removed in version 2.13. [deprecated]
- For more information see DEPRECATED.
Authors¶
- Abhijeet Kasurde (@Akasurde)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.