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 4.8.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
.
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 |
---|---|
Name of the vSAN cluster. |
|
Name of the Datacenter. |
|
Choices:
|
|
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 |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
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 cluster health info Returned: on success Sample: |