Docs4dev
Docs
ansible / 2.4 / vmware_cluster_module.html

vmware_cluster - Manage VMware vSphere clusters

New in version 2.0.

Synopsis

  • Add or remove VMware vSphere clusters.

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 no
  • yes
  • no
If set to yes will enable DRS when the cluster is created.
enable_ha
 no no
  • yes
  • no
If set to yes will enable HA when the cluster is created.
enable_vsan
 no no
  • yes
  • no
If set to yes 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
state
 no present
  • absent
  • present
Create (present) or remove (absent) a VMware vSphere cluster.
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

- 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.

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

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