vmware.vmware.cluster_vcls module – Manage the vCLS (vSphere Cluster Services) VM disk placement for this cluster.
Note
This module is part of the vmware.vmware collection (version 1.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 vmware.vmware
.
To use it in a playbook, specify: vmware.vmware.cluster_vcls
.
Synopsis
Overrides the default vCLS VM disk placement for this cluster.
Datastores may not be configured for vCLS if they are blocked by solutions where vCLS cannot be configured such as SRM or vSAN maintenance mode.
Parameters
Parameter |
Comments |
---|---|
Exclusive list of the allowed datastores. If there is an existing list configured in vCenter, it will be overridden by this value. |
|
The name of the cluster to be managed. |
|
The name of the datacenter where the cluster and datastores can be found. If the cluster_name is unique for your environment, the datacenter is optional. |
|
List of datastores to add to the vCLS config The module will make sure these datastores are present in the config, and not change other datastores that are present. |
|
List of datastores to remove from the vCLS config The module will make sure these datastores are absent from the config, and not change other datastores that are present. |
|
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:
|
Notes
Note
All modules require API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Set Allowed vCLS Datastores
vmware.vmware.cluster_vcls:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: datacenter
cluster_name: cluster
allowed_datastores:
- ds1
- ds2
- name: Make sure DS1 is Allowed and DS2 is Not
vmware.vmware.cluster_vcls:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: datacenter
cluster_name: cluster
datastores_to_add:
- ds1
datastores_to_remove:
- ds2
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of datastores that were added by this module. Empty if none had to be added Returned: always Sample: |
|
Complete list of datastores that are in the active configuration (after the module has completed) Returned: always Sample: |
|
Information about the vSphere task to re-configure vCLS Returned: on change Sample: |
|
List of datastores that were removed by this module. Empty if none had to be removed Returned: always Sample: |