community.vmware.vmware_datastore_cluster_manager – Manage VMware vSphere datastore cluster’s members
community.vmware.vmware_datastore_cluster_manager – Manage VMware vSphere datastore cluster’s members
Note
This plugin is part of the community.vmware collection (version 1.7.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_datastore_cluster_manager
.
Synopsis
- This module can be used to add datastore in the datastore cluster.
- All parameters and VMware object values are case sensitive.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
datacenter_name string |
The name of the datacenter.
| |
datastore_cluster_name string / required |
The name of the datastore cluster.
| |
datastores list / elements=string / required |
A list of datastores to be manage. | |
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 Environment variable support added in Ansible 2.6. | |
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 Environment variable support added in Ansible 2.6.
| |
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 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 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 | |
state string |
|
If set to present, datastores specified by datastores will be added to the given datastore cluster. If set to absent, datastores specified by datastores will be moved from the given datastore cluster to datstore folder of the parent datacenter. |
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 Environment variable support added in Ansible 2.6.
| |
validate_certs boolean |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to |
Notes
Note
- Tested on vSphere 6.0, 6.5
Examples
- name: Add datastore to the given datastore cluster
community.vmware.vmware_datastore_cluster_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: '{{ datacenter_name }}'
datastore_cluster_name: '{{ datastore_cluster_name }}'
datastores:
- ds_001
- ds_002
- ds_003
state: present
delegate_to: localhost
- name: Move datastore from the given datastore cluster
community.vmware.vmware_datastore_cluster_manager:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: '{{ datacenter_name }}'
datastore_cluster_name: '{{ datastore_cluster_name }}'
datastores:
- ds_001
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 |
---|---|---|
datastore_cluster_info string |
always |
information about datastore cluster
Sample: {'changed_datastores': ['ds_171_1'], 'current_datastores': [], 'msg': None, 'previous_datastores': ['ds_171_1']} |
Authors
- Abhijeet Kasurde (@Akasurde)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/vmware/vmware_datastore_cluster_manager_module.html