W3cubDocs

/Ansible

community.vmware.vmware_vsan_health_info module – Gather information about a VMware vSAN cluster’s health

Note

This module is part of the community.vmware collection (version 5.7.2).

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Gather information about a VMware vSAN cluster’s health.

Requirements

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

  • VMware vSAN Python’s SDK

Parameters

Parameter

Comments

cluster_name

string / required

Name of the vSAN cluster.

datacenter

aliases: datacenter_name

string

Name of the Datacenter.

fetch_from_cache

boolean

true to return the result from cache directly instead of running the full health check.

Choices:

  • false ← (default)
  • true

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.

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.

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.

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.

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.

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.

Choices:

  • false
  • true ← (default)

Notes

Note

  • All modules requires API write access and hence is not supported on a free ESXi license.
  • All variables and VMware object names are case sensitive.

Examples

- name: Gather health info from a vSAN's cluster
  community.vmware.vmware_vsan_health_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    cluster_name: 'vSAN01'
    fetch_from_cache: false

- name: Gather health info from a vSAN's cluster with datacenter
  community.vmware.vmware_vsan_health_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    cluster_name: 'vSAN01'
    datacenter: 'Datacenter_01'
    fetch_from_cache: true

Return Values

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

Key

Description

vsan_health_info

dictionary

vSAN cluster health info

Returned: on success

Sample: {"_vimtype": "vim.cluster.VsanClusterHealthSummary", "burnInTest": null, "clusterStatus": {"_vimtype": "vim.cluster.VsanClusterHealthSystemStatusResult", "goalState": "installed", "status": "green", "trackedHostsStatus": [{"_vimtype": "vim.host.VsanHostHealthSystemStatusResult", "hostname": "esxi01.example.com", "issues": [], "status": "green"}, {"_vimtype": "vim.host.VsanHostHealthSystemStatusResult", "hostname": "esxi04.example.com", "issues": [], "status": "green"}, {"_vimtype": "vim.host.VsanHostHealthSystemStatusResult", "hostname": "esxi02.example.com", "issues": [], "status": "green"}, {"_vimtype": "vim.host.VsanHostHealthSystemStatusResult", "hostname": "esxi03.example.com", "issues": [], "status": "green"}], "untrackedHosts": []}}

Authors

  • Erwan Quelin (@equelin)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/vmware/vmware_vsan_health_info_module.html