vmware_cluster – Manage VMware vSphere clusters
vmware_cluster – Manage VMware vSphere clusters
Synopsis
- Adds or removes VMware vSphere clusters.
- Although this module can manage DRS, HA and VSAN related configurations, this functionality is deprecated and will be removed in 2.12.
- To manage DRS, HA and VSAN related configurations, use the new modules vmware_cluster_drs, vmware_cluster_ha and vmware_cluster_vsan.
- All values and VMware object names are case sensitive.
Requirements
The below requirements are needed on the host that executes this module.
- Tested on ESXi 5.5 and 6.5.
- PyVmomi installed.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
cluster_name string / required |
The name of the cluster to be managed. | |
datacenter string / required |
The name of the datacenter.
| |
drs_default_vm_behavior - added in 2.8 |
|
Specifies the cluster-wide default DRS behavior for virtual machines. If set to If set to If set to Use Deprecated option, will be removed in version 2.12. |
drs_enable_vm_behavior_overrides boolean added in 2.8 |
|
Determines whether DRS Behavior overrides for individual virtual machines are enabled. If set to Use Deprecated option, will be removed in version 2.12. |
drs_vmotion_rate - added in 2.8 |
|
Threshold for generated ClusterRecommendations. Use Deprecated option, will be removed in version 2.12. |
enable_drs boolean |
|
If set to Use Deprecated option, will be removed in version 2.12. |
enable_ha boolean |
|
If set to Use Deprecated option, will be removed in version 2.12. |
enable_vsan boolean |
|
If set to Use Deprecated option, will be removed in version 2.12. |
ha_admission_control_enabled boolean added in 2.8 |
|
Determines if strict admission control is enabled. It is recommended to set this parameter to Use Deprecated option, will be removed in version 2.12. |
ha_failover_level - added in 2.8 |
Default: 2 |
Number of host failures that should be tolerated, still guaranteeing sufficient resources to restart virtual machines on available hosts. Accepts integer values only. Use Deprecated option, will be removed in version 2.12. |
ha_host_monitoring - added in 2.8 |
|
Indicates whether HA restarts virtual machines after a host fails. If set to If set to If Use Deprecated option, will be removed in version 2.12. |
ha_restart_priority - added in 2.8 |
|
Determines the preference that HA gives to a virtual machine if sufficient capacity is not available to power on all failed virtual machines. This setting is only valid if If set to If set to If set to If set to Use Deprecated option, will be removed in version 2.12. |
ha_vm_failure_interval - added in 2.8 |
Default: 30 |
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. Use Deprecated option, will be removed in version 2.12. |
ha_vm_max_failure_window - added in 2.8 |
Default: -1 |
The number of seconds for the window during which up to This setting is only valid if Unit is seconds. Default specifies no failure window. Use Deprecated option, will be removed in version 2.12. |
ha_vm_max_failures - added in 2.8 |
Default: 3 |
Maximum number of failures and automated resets allowed during the time that This setting is only valid if Use Deprecated option, will be removed in version 2.12. |
ha_vm_min_up_time - added in 2.8 |
Default: 120 |
The number of seconds for the virtual machine's heartbeats to stabilize after the virtual machine has been powered on. This setting is only valid if Unit is seconds. Use Deprecated option, will be removed in version 2.12. |
ha_vm_monitoring - added in 2.8 |
|
Indicates the state of virtual machine health monitoring service. If set to If set to If set to If Use Deprecated option, will be removed in version 2.12. |
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 Environment variable support added in Ansible 2.6. | |
ignore_drs boolean added in 2.9 |
|
If set to |
ignore_ha boolean added in 2.9 |
|
If set to |
ignore_vsan boolean added in 2.9 |
|
If set to |
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 Environment variable support added in Ansible 2.6.
| |
port integer 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 Environment variable support added in Ansible 2.6. |
proxy_host string added in 2.9 |
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 | |
proxy_port integer added in 2.9 |
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 | |
state - |
|
Create |
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 Environment variable support added in Ansible 2.6.
| |
validate_certs boolean |
|
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 |
vsan_auto_claim_storage boolean added in 2.8 |
|
Determines whether the VSAN service is configured to automatically claim local storage on VSAN-enabled hosts in the cluster. Use Deprecated option, will be removed in version 2.12. |
See Also
See also
- vmware_cluster_drs – Manage Distributed Resource Scheduler (DRS) on VMware vSphere clusters
- The official documentation on the vmware_cluster_drs module.
- vmware_cluster_ha – Manage High Availability (HA) on VMware vSphere clusters
- The official documentation on the vmware_cluster_ha module.
- vmware_cluster_vsan – Manages virtual storage area network (vSAN) configuration on VMware vSphere clusters
- The official documentation on the vmware_cluster_vsan module.
Examples
- name: Create Cluster
vmware_cluster:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: datacenter
cluster_name: cluster
enable_ha: yes
enable_drs: yes
enable_vsan: yes
delegate_to: localhost
- name: Create Cluster with additional changes
vmware_cluster:
hostname: "{{ vcenter_server }}"
username: "{{ vcenter_user }}"
password: "{{ vcenter_pass }}"
validate_certs: no
datacenter_name: DC0
cluster_name: "{{ cluster_name }}"
enable_ha: True
ha_vm_monitoring: vmMonitoringOnly
enable_drs: True
drs_default_vm_behavior: partiallyAutomated
enable_vsan: True
register: cl_result
delegate_to: localhost
- name: Delete Cluster
vmware_cluster:
hostname: "{{ vcenter_server }}"
username: "{{ vcenter_user }}"
password: "{{ vcenter_pass }}"
datacenter_name: datacenter
cluster_name: cluster
enable_ha: yes
enable_drs: yes
enable_vsan: yes
state: absent
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Joseph Callen (@jcpowermac)
- Abhijeet Kasurde (@Akasurde)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vmware_cluster_module.html