community.vmware.vmware_datastore_cluster module – Manage VMware vSphere datastore clusters

Note

This module is part of the community.vmware collection (version 2.5.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 community.vmware.

To use it in a playbook, specify: community.vmware.vmware_datastore_cluster.

Synopsis

  • This module can be used to add and delete datastore cluster in given VMware environment.

  • All parameters and VMware object values are case sensitive.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6

  • PyVmomi

Parameters

Parameter

Comments

automation_level

string

Run SDRS automated or manually.

Choices:

  • automated

  • manual ← (default)

datacenter_name

aliases: datacenter

string

The name of the datacenter.

You must specify either a datacenter_name or a folder.

Mutually exclusive with folder parameter.

datastore_cluster_name

string / required

The name of the datastore cluster.

enable_io_loadbalance

boolean

Whether or not storage DRS takes into account storage I/O workload when making load balancing and initial placement recommendations.

Choices:

  • no ← (default)

  • yes

enable_sdrs

boolean

Whether or not storage DRS is enabled.

Choices:

  • no ← (default)

  • yes

folder

string

Destination folder, absolute path to place datastore cluster in.

The folder should include the datacenter.

This parameter is case sensitive.

You must specify either a folder or a datacenter_name.

Examples:

folder: /datacenter1/datastore

folder: datacenter1/datastore

folder: /datacenter1/datastore/folder1

folder: datacenter1/datastore/folder1

folder: /folder1/datacenter1/datastore

folder: folder1/datacenter1/datastore

folder: /folder1/datacenter1/datastore/folder2

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.

keep_vmdks_together

boolean

Specifies whether or not each VM in this datastore cluster should have its virtual disks on the same datastore by default.

Choices:

  • no

  • yes ← (default)

loadbalance_interval

integer

Specify the interval in minutes that storage DRS runs to load balance among datastores.

Default: 480

password

aliases: pass, pwd

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.

port

integer

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.

Default: 443

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.

state

string

If the datastore cluster should be present or absent.

Choices:

  • present ← (default)

  • absent

username

aliases: admin, user

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.

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.

Choices:

  • no

  • yes ← (default)

Notes

Note

  • Tested on vSphere 6.0, 6.5

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

Examples

- name: Create datastore cluster and enable SDRS
  community.vmware.vmware_datastore_cluster:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: '{{ datacenter_name }}'
    datastore_cluster_name: '{{ datastore_cluster_name }}'
    enable_sdrs: True
    state: present
  delegate_to: localhost

- name: Create datastore cluster using folder
  community.vmware.vmware_datastore_cluster:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    folder: '/{{ datacenter_name }}/datastore/ds_folder'
    datastore_cluster_name: '{{ datastore_cluster_name }}'
    state: present
  delegate_to: localhost

- name: Delete datastore cluster
  community.vmware.vmware_datastore_cluster:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: '{{ datacenter_name }}'
    datastore_cluster_name: '{{ datastore_cluster_name }}'
    state: absent
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

result

string

information about datastore cluster operation

Returned: always

Sample: “Datastore cluster \u0027DSC2\u0027 created successfully.”

Authors

  • Abhijeet Kasurde (@Akasurde)