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.11.0).

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

allowed_datastores

list / elements=string

Exclusive list of the allowed datastores.

If there is an existing list configured in vCenter, it will be overridden by this value.

cluster

aliases: cluster_name

string / required

The name of the cluster to be managed.

datacenter

aliases: datacenter_name

string

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.

datastores_to_add

list / elements=string

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.

datastores_to_remove

list / elements=string

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.

hostname

string

The hostname or IP address of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

password

aliases: pass, pwd

string

The password of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

port

integer

The port number of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

proxy_host

string

The 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.

proxy_port

integer

The 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

aliases: admin, user

string

The username of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

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.

Choices:

  • false

  • true ← (default)

Notes

Note

  • All modules require API write access and hence are not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

  • Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

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

added_datastores

list / elements=string

List of datastores that were added by this module. Empty if none had to be added

Returned: always

Sample: ["ds3"]

allowed_datastores

list / elements=string

Complete list of datastores that are in the active configuration (after the module has completed)

Returned: always

Sample: ["ds1 ds2 ds3"]

reconfig_task_result

dictionary

Information about the vSphere task to re-configure vCLS

Returned: on change

Sample: {"completion_time": "2024-07-29T15:27:37.041577+00:00", "entity_name": "test-5fb1_cluster", "error": null, "result": null, "state": "success"}

removed_datastores

list / elements=string

List of datastores that were removed by this module. Empty if none had to be removed

Returned: always

Sample: ["ds4"]

Authors

  • Ansible Cloud Team (@ansible-collections)