Documentation

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

                  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, Helping Testing PRs and Developing Modules.