Documentation

vmware_cluster_facts - Gather facts about clusters available in given vCenter

New in version 2.6.

Synopsis

  • This module can be used to gather facts about clusters in VMWare infrastructure.
  • All values 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
Name of the cluster.
If set, facts of this cluster will be returned.
This parameter is required, if datacenter is not supplied.
datacenter
Datacenter to search for cluster/s.
This parameter is required, if cluster_name is not supplied.
hostname
str
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 supported added in version 2.6.
password
str
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 supported added in version 2.6.

aliases: pass, pwd
port
int

(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 supported added in version 2.6.
username
str
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 supported added in version 2.6.

aliases: admin, user
validate_certs
bool
    Choices:
  • no
  • yes ←
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 supported added in version 2.6.
If set to yes, please make sure Python >= 2.7.9 is installed on the given machine.

Notes

Note

  • Tested on vSphere 6.5

Examples

- name: Gather cluster facts from given datacenter
  vmware_cluster_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: ha-datacenter
    validate_certs: no
  delegate_to: localhost
  register: cluster_facts

- name: Gather facts from datacenter about specific cluster
  vmware_cluster_facts:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: DC0_C0
  delegate_to: localhost
  register: cluster_facts

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
clusters
dict
always
metadata about the available clusters

Sample:
{'DC0_C0': {'enabled_drs': True, 'ha_restart_priority': None, 'ha_vm_max_failures': None, 'ha_host_monitoring': None, 'ha_vm_tools_monitoring': None, 'vsan_auto_claim_storage': False, 'ha_admission_control_enabled': None, 'ha_failover_level': None, 'drs_vmotion_rate': None, 'enable_ha': None, 'ha_vm_failure_interval': None, 'ha_vm_monitoring': None, 'enabled_vsan': False, 'drs_enable_vm_behavior_overrides': None, 'drs_default_vm_behavior': None, 'ha_vm_max_failure_window': None, 'ha_vm_min_up_time': None}}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Abhijeet Kasurde (@Akasurde)

Hint

If you notice any issues in this documentation you can edit this document to improve it.