community.vmware.vmware_cluster_info – Gather info about clusters available in given vCenter

Note

This plugin is part of the community.vmware collection.

To install it use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_cluster_info.

Synopsis

  • This module can be used to gather information about clusters in VMWare infrastructure.

  • All values and VMware object names are case sensitive.

  • This module was called vmware_cluster_facts before Ansible 2.9. The usage did not change.

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.
If set, information of this cluster will be returned.
This parameter is required, if datacenter is not supplied.
datacenter
string
Datacenter to search for cluster/s.
This parameter is required, if cluster_name is not supplied.
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
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.
properties
list / elements=string
added in 1.0.0 of
Specify the properties to retrieve.
Example:
properties: [
"name",
"configuration.dasConfig.enabled",
"summary.totalCpu"
]
Only valid when schema is vsphere.
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.
schema
string
added in 1.0.0 of
    Choices:
  • summary ←
  • vsphere
Specify the output schema desired.
The 'summary' output schema is the legacy output from the module.
The 'vsphere' output schema is the vSphere API class definition which requires pyvmomi>6.7.1.
show_tag
boolean
    Choices:
  • no ←
  • yes
Tags related to cluster are shown if set to True.
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
    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 support added in Ansible 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, 6.7

Examples

- name: Gather cluster info from given datacenter
  community.vmware.vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: ha-datacenter
    validate_certs: no
  delegate_to: localhost
  register: cluster_info

- name: Gather info from datacenter about specific cluster
  community.vmware.vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: DC0_C0
  delegate_to: localhost
  register: cluster_info

- name: Gather info from datacenter about specific cluster with tags
  community.vmware.vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: DC0_C0
    show_tag: True
  delegate_to: localhost
  register: cluster_info

- name: Gather some info from a cluster using the vSphere API output schema
  vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    validate_certs: no
    cluster_name: DC0_C0
    schema: vsphere
    properties:
      - name
      - configuration.dasConfig.enabled
      - summary.totalCpu
  delegate_to: localhost
  register: cluster_info

Return Values

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

Key Returned Description
clusters
dictionary
always
metadata about the available clusters

Sample:
{'DC0_C0': {'drs_default_vm_behavior': None, 'drs_enable_vm_behavior_overrides': None, 'drs_vmotion_rate': None, 'enable_ha': None, 'enabled_drs': True, 'enabled_vsan': False, 'ha_admission_control_enabled': None, 'ha_failover_level': None, 'ha_host_monitoring': None, 'ha_restart_priority': None, 'ha_vm_failure_interval': None, 'ha_vm_max_failure_window': None, 'ha_vm_max_failures': None, 'ha_vm_min_up_time': None, 'ha_vm_monitoring': None, 'ha_vm_tools_monitoring': None, 'hosts': [{'folder': '/DC0/host/DC0_C0', 'name': 'esxi01.vsphere.local'}, {'folder': '/DC0/host/DC0_C0', 'name': 'esxi02.vsphere.local'}, {'folder': '/DC0/host/DC0_C0', 'name': 'esxi03.vsphere.local'}, {'folder': '/DC0/host/DC0_C0', 'name': 'esxi04.vsphere.local'}], 'resource_summary': {'cpuCapacityMHz': 4224, 'cpuUsedMHz': 87, 'memCapacityMB': 6139, 'memUsedMB': 1254, 'pMemAvailableMB': 0, 'pMemCapacityMB': 0, 'storageCapacityMB': 33280, 'storageUsedMB': 19953}, 'tags': [{'category_id': 'urn:vmomi:InventoryServiceCategory:9fbf83de-7903-442e-8004-70fd3940297c:GLOBAL', 'category_name': 'sample_cluster_cat_0001', 'description': '', 'id': 'urn:vmomi:InventoryServiceTag:93d680db-b3a6-4834-85ad-3e9516e8fee8:GLOBAL', 'name': 'sample_cluster_tag_0001'}], 'vsan_auto_claim_storage': False}}


Authors

  • Abhijeet Kasurde (@Akasurde)

  • Christian Neugum (@digifuchsi)