Documentation
  • Docs »
  • vmware_datastore_cluster - Manage VMware vSphere datastore clusters

vmware_datastore_cluster - Manage VMware vSphere datastore clusters

New in version 2.6.

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
str
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 version 2.6.
password
str
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 version 2.6.

aliases: pass, pwd
port
int

(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 support added in version 2.6.
state
    Choices:
  • present ←
  • absent
If the datastore cluster should be present or absent.
username
str
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 version 2.6.

aliases: admin, user
validate_certs
bool
    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 version 2.6.
If set to yes, 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
  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.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Abhijeet Kasurde (@Akasurde)

Hint

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