vmware_datastore_maintenancemode - Place a datastore into maintenance mode
New in version 2.6.
Synopsis
- This module can be used to manage maintenance mode of a datastore.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
cluster_name | Name of the cluster where datastore is connected to. If multiple datastores are connected to the given cluster, then all datastores will be managed by state .If datastore or datastore_cluster are not set, this parameter is required. | |
datastore | Name of datastore to manage. If datastore_cluster or cluster_name are not set, this parameter is required. | |
datastore_cluster | Name of the datastore cluster from all child datastores to be managed. If datastore or cluster_name are not set, this parameter is required. | |
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 |
| If set to present , then enter datastore into maintenance mode.If set to present and datastore is already in maintenance mode, then no action will be taken.If set to absent and datastore is in maintenance mode, then exit maintenance mode.If set to absent and datastore is not in maintenance mode, then no action will be taken. |
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 |
| 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 5.5, 6.0 and 6.5
Examples
- name: Enter datastore into Maintenance Mode vmware_datastore_maintenancemode: hostname: vc_host username: vc_user password: vc_pass datastore: datastore1 state: present - name: Enter all datastores under cluster into Maintenance Mode vmware_datastore_maintenancemode: hostname: vc_host username: vc_user password: vc_pass cluster_name: DC0_C0 state: present - name: Enter all datastores under datastore cluster into Maintenance Mode vmware_datastore_maintenancemode: hostname: vc_host username: vc_user password: vc_pass datastore_cluster: DSC_POD0 state: present - name: Exit datastore into Maintenance Mode vmware_datastore_maintenancemode: hostname: vc_host username: vc_user password: vc_pass datastore: datastore1 state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
results dict | always | Action taken for datastore |
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.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/vmware_datastore_maintenancemode_module.html