community.vmware.vmware_cluster_vsan module – Manages virtual storage area network (vSAN) configuration on VMware vSphere clusters
Note
This module is part of the community.vmware collection (version 4.7.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.vmware
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.vmware.vmware_cluster_vsan
.
Synopsis
Manages vSAN on VMware vSphere clusters.
Requirements
The below requirements are needed on the host that executes this module.
vSAN Management SDK, which needs to be downloaded from VMware and installed manually.
Parameters
Parameter |
Comments |
---|---|
Advanced VSAN Options. |
|
If enabled, vSAN automatically rebalances (moves the data among disks) when a capacity disk fullness hits proactive rebalance threshold. Choices:
|
|
For vSAN stretched clusters, reads to vSAN objects occur on the site the VM resides on. Setting to Choices:
|
|
Allow > 32 VSAN hosts per cluster; if this is changed on an existing vSAN cluster, all hosts are required to reboot to apply this change. Choices:
|
|
Delay time in minutes for VSAN to wait for the absent component to come back before starting to repair it. |
|
When Choices:
|
|
The name of the cluster to be managed. |
|
The name of the datacenter. |
|
Whether to enable vSAN. Choices:
|
|
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 |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
Address of a proxy that will receive all HTTPS requests and relay them. The format is a hostname or a IP. If the value is not specified in the task, the value of environment variable |
|
Port of the HTTP proxy that will receive all HTTPS requests and relay them. If the value is not specified in the task, the value of environment variable |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
|
Whether the VSAN service is configured to automatically claim local storage on VSAN-enabled hosts in the cluster. Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Enable vSAN
community.vmware.vmware_cluster_vsan:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: datacenter
cluster_name: cluster
enable: true
delegate_to: localhost
- name: Enable vSAN and automatic rebalancing
community.vmware.vmware_cluster_vsan:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: datacenter
cluster_name: cluster
enable: true
advanced_options:
automatic_rebalance: true
delegate_to: localhost
- name: Enable vSAN and claim storage automatically
community.vmware.vmware_cluster_vsan:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
datacenter_name: DC0
cluster_name: "{{ cluster_name }}"
enable: true
vsan_auto_claim_storage: true
delegate_to: localhost