community.vmware.vmware_datastore_cluster – Manage VMware vSphere datastore clusters

Note

This plugin is part of the community.vmware collection (version 1.9.0).

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 Choices/Defaults Comments
automation_level
string
    Choices:
  • automated
  • manual ←
Run SDRS automated or manually.
datacenter_name
string
The name of the datacenter.
You must specify either a datacenter_name or a folder.
Mutually exclusive with folder parameter.

aliases: datacenter
datastore_cluster_name
string / required
The name of the datastore cluster.
enable_io_loadbalance
boolean
    Choices:
  • no ←
  • yes
Whether or not storage DRS takes into account storage I/O workload when making load balancing and initial placement recommendations.
enable_sdrs
boolean
    Choices:
  • no ←
  • yes
Whether or not storage DRS is enabled.
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
    Choices:
  • no
  • yes ←
Specifies whether or not each VM in this datastore cluster should have its virtual disks on the same datastore by default.
loadbalance_interval
integer
Default:
480
Specify the interval in minutes that storage DRS runs to load balance among datastores.
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.
state
string
    Choices:
  • present ←
  • absent
If the datastore cluster should be present or absent.
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
    Choices:
  • no
  • yes ←
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.

Notes

Note

  • Tested on vSphere 6.0, 6.5

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 Returned Description
result
string
always
information about datastore cluster operation

Sample:
Datastore cluster 'DSC2' created successfully.


Authors

  • Abhijeet Kasurde (@Akasurde)