Note
This plugin is part of the community.vmware collection (version 1.7.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_cluster_vsan
.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
advanced_options dictionary added in 1.1.0 of community.vmware | Advanced VSAN Options. | ||
automatic_rebalance boolean |
| If enabled, vSAN automatically rebalances (moves the data among disks) when a capacity disk fullness hits proactive rebalance threshold. | |
disable_site_read_locality boolean |
| For vSAN stretched clusters, reads to vSAN objects occur on the site the VM resides on. Setting to True will force reads across all mirrors. | |
large_cluster_support boolean |
| 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. | |
object_repair_timer integer | Delay time in minutes for VSAN to wait for the absent component to come back before starting to repair it. | ||
thin_swap boolean |
| When enabled , swap objects would not reserve 100% space of their size on vSAN datastore. | |
cluster_name string / required | The name of the cluster to be managed. | ||
datacenter string / required | The name of the datacenter. aliases: datacenter_name | ||
enable_vsan boolean |
| Whether to enable vSAN. | |
hostname string | 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 VMWARE_HOST will be used instead.Environment variable support added in Ansible 2.6. | ||
password string | The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.Environment variable support added in Ansible 2.6. aliases: pass, pwd | ||
port integer | Default: 443 | The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.Environment variable support added in Ansible 2.6. | |
proxy_host string | 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 VMWARE_PROXY_HOST will be used instead.This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 | ||
proxy_port integer | 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 VMWARE_PROXY_PORT will be used instead. | ||
username string | The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.Environment variable support added in Ansible 2.6. aliases: admin, user | ||
validate_certs boolean |
| Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.Environment variable support added in Ansible 2.6. If set to true , please make sure Python >= 2.7.9 is installed on the given machine. | |
vsan_auto_claim_storage boolean |
| Whether the VSAN service is configured to automatically claim local storage on VSAN-enabled hosts in the cluster. |
- name: Enable vSAN community.vmware.vmware_cluster_vsan: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' datacenter_name: datacenter cluster_name: cluster enable_vsan: 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_vsan: 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_vsan: True vsan_auto_claim_storage: True delegate_to: localhost
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_cluster_vsan_module.html