W3cubDocs

/Ansible

vmware_cluster - Create VMware vSphere Cluster

New in version 2.0.

Synopsis

Create VMware vSphere Cluster

Requirements (on host that executes module)

  • Tested on ESXi 5.5
  • PyVmomi installed

Options

parameter required default choices comments
cluster_name
 yes
The name of the cluster that will be created
datacenter_name
 yes
The name of the datacenter the cluster will be created in.
enable_drs
 no
If set to True will enable DRS when the cluster is created.
enable_ha
 no
If set to True will enable HA when the cluster is created.
enable_vsan
 no
If set to True will enable vSAN when the cluster is created.
hostname
 yes
The hostname or IP address of the vSphere vCenter.
password
 yes
The password of the vSphere vCenter.
aliases: pass, pwd
username
 yes
The username of the vSphere vCenter.
aliases: user, admin
validate_certs
 no True
  • True
  • False
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

Examples

# Example vmware_cluster command from Ansible Playbooks
- name: Create Cluster
      local_action: >
        vmware_cluster
        hostname="{{ ansible_ssh_host }}" username=root password=vmware
        datacenter_name="datacenter"
        cluster_name="cluster"
        enable_ha=True
        enable_drs=True
        enable_vsan=True

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/vmware_cluster_module.html