vmware_datastore_cluster - Manage VMware vSphere datastore clusters¶

New in version 2.6.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

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
datacenter_name required		The name of the datacenter.
datastore_cluster_name required		The name of the datastore cluster.
hostname		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 supported added in version 2.6.
password		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 supported added in version 2.6. aliases: pass, pwd
port (added in 2.5)	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 supported added in version 2.6.
state	Choices: present ← absent	If the datastore cluster should be present or absent.
username		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 supported added in version 2.6. aliases: user, admin
validate_certs	Choices: no yes Default: True	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 supported added in version 2.6.

Notes ¶

Note

Tested on vSphere 6.0, 6.5

Examples ¶

- name: Create datastore cluster
  vmware_datastore_cluster:
    hostname: vCenter
    username: root
    password: vmware
    datacenter_name: "datacenter"
    datastore_cluster_name: datacluster0
    state: present


- name: Delete datastore cluster
  vmware_datastore_cluster:
    hostname: vCenter
    username: root
    password: vmware
    datacenter_name: "datacenter"
    datastore_cluster_name: datacluster0
    state: absent

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.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Abhijeet Kasurde (@akasurde)

Hint

If you notice any issues in this documentation you can edit this document to improve it.