community.vmware.vmware_maintenancemode module – Place a host into maintenance mode

Note

This module is part of the community.vmware collection (version 6.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_maintenancemode.

DEPRECATED
Synopsis
Parameters
Notes
Examples
Return Values
Status

DEPRECATED

Removed in:: version 7.0.0
Why:: This module has been moved to the new vmware.vmware collection
Alternative:: Use vmware.vmware.esxi_maintenance_mode instead.

Synopsis

This module can be used for placing a ESXi host into maintenance mode.
Support for VSAN compliant maintenance mode when selected.

Parameters

Parameter	Comments
esxi_hostname string / required	Name of the host as defined in vCenter.
evacuate boolean	If set to `true`, evacuate all powered off VMs. Choices: `false` ← (default) `true`
hostname string	The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable `VMWARE_HOST` will be used instead.
password aliases: pass, pwd string	The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable `VMWARE_PASSWORD` will be used instead.
port integer	The port number of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable `VMWARE_PORT` will be used instead. Default: `443`
proxy_host string	The 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 `VMWARE_PROXY_HOST` will be used instead.
proxy_port integer	The 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 `VMWARE_PROXY_PORT` will be used instead.
state string	Enter or exit maintenance mode. Choices: `"present"` ← (default) `"absent"`
timeout integer	Specify a timeout for the operation. Default: `0`
username aliases: admin, user string	The username of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable `VMWARE_USER` will be used instead.
validate_certs boolean	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. Choices: `false` `true` ← (default)
vsan aliases: vsan_mode string	Specify which VSAN compliant mode to enter. Choices: `"ensureObjectAccessibility"` `"evacuateAllData"` `"noAction"`

Notes

Note

All modules require API write access and hence are not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Note having this variable set may cause a ‘false’ value for the ‘validate_certs’ option to be ignored in some cases. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Examples

- name: Enter VSAN-Compliant Maintenance Mode
  community.vmware.vmware_maintenancemode:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    esxi_hostname: "{{ esxi_hostname }}"
    vsan: ensureObjectAccessibility
    evacuate: true
    timeout: 3600
    state: present
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
hostname string	Name of host in vCenter Returned: always Sample: `"esxi.local.domain"`
hostsystem string	Name of vim reference Returned: always Sample: `"'vim.HostSystem:host-236'"`
status string	Action taken Returned: always Sample: `"ENTER"`

Status

This module will be removed in version 7.0.0. [deprecated]
For more information see DEPRECATED.

Authors

Jay Jahns (@jjahns)
Abhijeet Kasurde (@Akasurde)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/vmware/vmware_maintenancemode_module.html