You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.vmware.vmware_host_config_facts – Gathers facts about an ESXi host’s advance configuration information

Note

This plugin is part of the community.vmware collection (version 1.17.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_config_facts.

DEPRECATED
Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

DEPRECATED 

Removed in: major release after 2021-12-01
Why: Deprecated in favour of community.vmware.vmware_host_config_info module.
Alternative: Use community.vmware.vmware_host_config_info instead.

Synopsis 

This module can be used to gather facts about an ESXi host’s advance configuration information when ESXi hostname or Cluster name is given.

Requirements 

The below requirements are needed on the host that executes this module.

python >= 2.6
PyVmomi

Parameters 

Parameter	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 aliases: pass, pwd 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.
port integer	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. Default: 443
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 `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	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 aliases: admin, user 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.
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 `true`, please make sure Python >= 2.7.9 is installed on the given machine. Choices: no yes ← (default)

Notes 

Note

Tested on vSphere 6.5
All modules requires API write access and hence is not supported on a free ESXi license.

Examples 

- name: Gather facts about all ESXi Host in given Cluster
  community.vmware.vmware_host_config_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: cluster_name
  delegate_to: localhost

- name: Gather facts about ESXi Host
  community.vmware.vmware_host_config_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	Description
hosts_facts dictionary	dict with hostname as key and dict with host config facts Returned: always Sample: {“10.76.33.226”: {“Annotations.WelcomeMessage”: “”, “BufferCache.FlushInterval”: 30000, “BufferCache.HardMaxDirty”: 95, “BufferCache.PerFileHardMaxDirty”: 50, “BufferCache.SoftMaxDirty”: 15}}

Status 

This module will be removed in a major release after 2021-12-01. [deprecated]
For more information see DEPRECATED.

Authors

Abhijeet Kasurde (@Akasurde)