vmware_datastore_maintenancemode - Place a datastore into maintenance mode¶

New in version 2.6.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

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		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 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		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 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.

Author ¶

Abhijeet Kasurde (@akasurde)

Hint

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