community.vmware.vmware_cluster_ha module – Manage High Availability (HA) on VMware vSphere clusters
Note
This module is part of the community.vmware collection (version 3.11.1).
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.
To use it in a playbook, specify: community.vmware.vmware_cluster_ha.
Synopsis
Manages HA configuration on VMware vSphere clusters.
All values and VMware object names are case sensitive.
Parameters
Parameter |
Comments |
|---|---|
A dictionary of advanced HA settings. Default: |
|
The response recovery delay time in sec for storage failures categorized as All Paths Down (APD). Only set if Default: |
|
VM response recovery reaction for storage failures categorized as All Paths Down (APD). Only set if Choices:
|
|
VM storage protection setting for storage failures categorized as All Paths Down (APD). Choices:
|
|
The name of the cluster to be managed. |
|
The name of the datacenter. |
|
Whether to enable HA. Choices:
|
|
Configure dedicated failover hosts.
|
|
List of dedicated failover hosts. |
|
Whether HA restarts virtual machines after a host fails. If set to If set to If Choices:
|
|
Priority HA gives to a virtual machine if sufficient capacity is not available to power on all failed virtual machines. Valid only if ha_vm_monitoring is set to either If set to If set to If set to If set to Choices:
|
|
The number of seconds after which virtual machine is declared as failed if no heartbeat has been received. This setting is only valid if Unit is seconds. Default: |
|
The number of seconds for the window during which up to Valid only when ha_vm_monitoring is set to either Unit is seconds. Default specifies no failure window. Default: |
|
Maximum number of failures and automated resets allowed during the time that Valid only when ha_vm_monitoring is set to either Default: |
|
The number of seconds for the virtual machine’s heartbeats to stabilize after the virtual machine has been powered on. Valid only when ha_vm_monitoring is set to either Unit is seconds. Default: |
|
State of virtual machine health monitoring service. If set to If set to If set to If Choices:
|
|
Indicates whether or VMs should be powered off if a host determines that it is isolated from the rest of the compute resource. If set to If set to If set to 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 Environment variable support added in Ansible 2.6. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
VM storage protection setting for storage failures categorized as Permenant Device Loss (PDL). Choices:
|
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. 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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
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 |
|
Configure reservation based admission control policy.
|
|
By default, Choices:
|
|
Percentage of CPU resources in the cluster to reserve for failover. Ignored if Default: |
|
Number of host failures that should be tolerated. |
|
Percentage of memory resources in the cluster to reserve for failover. Ignored if Default: |
|
Configure slot based admission control policy.
|
|
Number of host failures that should be tolerated. |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
- name: Enable HA without admission control
community.vmware.vmware_cluster_ha:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: datacenter
cluster_name: cluster
enable: true
delegate_to: localhost
- name: Enable HA and VM monitoring without admission control
community.vmware.vmware_cluster_ha:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter_name: DC0
cluster_name: "{{ cluster_name }}"
enable: true
ha_vm_monitoring: vmMonitoringOnly
delegate_to: localhost
- name: Enable HA with admission control reserving 50% of resources for HA
community.vmware.vmware_cluster_ha:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: datacenter
cluster_name: cluster
enable: true
reservation_based_admission_control:
auto_compute_percentages: false
failover_level: 1
cpu_failover_resources_percent: 50
memory_failover_resources_percent: 50
delegate_to: localhost