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
bool
    Choices:
  • no ←
  • yes
If set to yes will enable DRS when the cluster is created.
enable_ha
bool
    Choices:
  • no ←
  • yes
If set to yes will enable HA when the cluster is created.
enable_vsan
bool
    Choices:
  • no ←
  • yes
If set to yes will enable vSAN when the cluster is created.
hostname
str
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
str
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
int

(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
    Choices:
  • absent
  • present ←
Create (present) or remove (absent) a VMware vSphere cluster.
username
str
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
bool
    Choices:
  • no
  • yes ←
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
  local_action:
    module: vmware_cluster
    hostname: '{{ ansible_ssh_host }}'
    username: root
    password: vmware
    datacenter_name: datacenter
    cluster_name: cluster
    enable_ha: yes
    enable_drs: yes
    enable_vsan: yes

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • 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.6/modules/vmware_cluster_module.html