vmware.vmware.esxi_maintenance_mode module – Manage an ESXi hosts maintenance mode setting in vCenter

Note

This module is part of the vmware.vmware collection (version 1.11.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 vmware.vmware.

To use it in a playbook, specify: vmware.vmware.esxi_maintenance_mode.

Synopsis

  • Manage an ESXi hosts maintenance mode setting in vCenter

Parameters

Parameter

Comments

enable_maintenance_mode

boolean

If true, the ESXi host will be put into maintenance mode.

Choices:

  • false

  • true ← (default)

esxi_host_name

aliases: name

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.

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_compliance_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. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

Examples

- name: Enable ESXi Maintenance Mode On A Host
  vmware.vmware.esxi_maintenance_mode:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    name: my_esxi_host
    enable_maintenance_mode: true
    evacuate: true
    timeout: 600

- name: Disable ESXi Maintenance Mode On A Host
  vmware.vmware.esxi_maintenance_mode:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    name: my_esxi_host
    enable_maintenance_mode: false

- name: Enable With A Specific VSAN Mode
  vmware.vmware.esxi_maintenance_mode:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    name: my_esxi_host
    enable_maintenance_mode: true
    vsan_compliance_mode: ensureObjectAccessibility

Return Values

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

Key

Description

result

dictionary

Information about the maintenance mode update task, if something changed

If nothing changed, an empty dictionary is returned

Returned: On success

Sample: {"result": {"completion_time": "2024-07-29T15:27:37.041577+00:00", "entity_name": "test-5fb1_my_esxi_host", "error": null, "state": "success"}}

Authors

  • Ansible Cloud Team (@ansible-collections)