New in version 2.6.
The below requirements are needed on the host that executes this module.
| 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 |
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 |
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
(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 |
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: user, admin |
|
| validate_certs |
True
|
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.
|
- name: Gather cluster facts from given datacenter
vmware_cluster_facts:
hostname: 192.168.1.209
username: administrator@vsphere.local
password: vmware
datacenter: ha-datacenter
validate_certs: False
delegate_to: localhost
register: cluster_facts
- name: Gather facts from datacenter about specific cluster
vmware_cluster_facts:
hostname: 192.168.1.209
username: administrator@vsphere.local
password: vmware
cluster_name: DC0_C0
validate_certs: False
delegate_to: localhost
register: cluster_facts
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}}
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.