vmware_cluster – Manage VMware vSphere clusters
New in version 2.0.
Synopsis
- Add or remove VMware vSphere clusters.
Requirements
The below requirements are needed on the host that executes this module.
- Tested on ESXi 5.5
- PyVmomi installed
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| cluster_name
- / required
|
The name of the cluster that will be created.
|
|
| datacenter_name
- / required
|
The name of the datacenter the cluster will be created in.
|
|
| enable_drs
boolean
|
|
If set to yes will enable DRS when the cluster is created.
|
| enable_ha
boolean
|
|
If set to yes will enable HA when the cluster is created.
|
| enable_vsan
boolean
|
|
If set to yes will enable vSAN when the cluster is created.
|
| 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.
Environment variable support added in version 2.6.
|
|
| 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
VMWARE_PASSWORD will be used instead.
Environment variable support added in version 2.6.
aliases: pass, pwd |
|
| 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
VMWARE_PORT will be used instead.
Environment variable support added in version 2.6.
|
| state
-
|
|
Create ( present) or remove (absent) a VMware vSphere cluster.
|
| 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
VMWARE_USER will be used instead.
Environment variable support added in version 2.6.
aliases: admin, user |
|
| 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.
Environment variable support added in version 2.6.
If set to yes, please make sure Python >= 2.7.9 is installed on the given machine.
|
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
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)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/vmware_cluster_module.html