Documentation

vmware_vsan_cluster - Configure VSAN clustering on an ESXi host

New in version 2.0.

Synopsis

This module can be used to configure VSAN clustering on an ESXi host

Requirements (on host that executes module)

  • python >= 2.6
  • PyVmomi

Options

parameter required default choices comments
cluster_uuid
no
    Desired cluster UUID
    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 command from Ansible Playbook
          
          - name: Configure VMware VSAN Cluster
            hosts: deploy_node
            gather_facts: False
            tags:
              - vsan
            tasks:
              - name: Configure VSAN on first host
                vmware_vsan_cluster:
                   hostname: "{{ groups['esxi'][0] }}"
                   username: "{{ esxi_username }}"
                   password: "{{ site_password }}"
                register: vsan_cluster
          
              - name: Configure VSAN on remaining hosts
                vmware_vsan_cluster:
                   hostname: "{{ item }}"
                   username: "{{ esxi_username }}"
                   password: "{{ site_password }}"
                   cluster_uuid: "{{ vsan_cluster.cluster_uuid }}"
                with_items: groups['esxi'][1:]
          

          Notes

          Note

          Tested on vSphere 5.5

          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.