community.vmware.vmware_cluster module – Manage VMware vSphere clusters
Note
This module is part of the community.vmware collection (version 4.7.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
.
To use it in a playbook, specify: community.vmware.vmware_cluster
.
DEPRECATED
- Removed in:
version 6.0.0
- Why:
This module has been moved to the new vmware.vmware collection
- Alternative:
Use vmware.vmware.cluster instead.
Synopsis
Adds or removes VMware vSphere clusters.
To manage DRS, HA and VSAN related configurations, use the modules vmware_cluster_drs, vmware_cluster_ha and vmware_cluster_vsan.
Parameters
Parameter |
Comments |
---|---|
The name of the cluster to be managed. |
|
The name of the datacenter. |
|
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 |
|
Create Choices:
|
|
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.
See Also
See also
- community.vmware.vmware_cluster_drs
Manage Distributed Resource Scheduler (DRS) on VMware vSphere clusters.
- community.vmware.vmware_cluster_ha
Manage High Availability (HA) on VMware vSphere clusters.
- community.vmware.vmware_cluster_vsan
Manages virtual storage area network (vSAN) configuration on VMware vSphere clusters.
Examples
- name: Create Cluster
community.vmware.vmware_cluster:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: datacenter
cluster_name: cluster
delegate_to: localhost
- name: Delete Cluster
community.vmware.vmware_cluster:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter_name: datacenter
cluster_name: cluster
state: absent
delegate_to: localhost
Status
This module will be removed in version 6.0.0. [deprecated]
For more information see DEPRECATED.