Documentation

vmware_maintenancemode - Place a host into maintenance mode

New in version 2.1.

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.6
  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
esxi_hostname
required
Name of the host as defined in vCenter.
evacuate
    Choices:
  • no ←
  • yes
If set to True, evacuate all powered off VMs.
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
Enter or exit maintenance mode.
timeout Default:
0
Specify a timeout for the operation.
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.
vsan
    Choices:
  • ensureObjectAccessibility
  • evacuateAllData
  • noAction
Specify which VSAN compliant mode to enter.

aliases: vsan_mode

Notes

Note

  • Tested on vSphere 5.5, 6.0 and 6.5

Examples

- name: Enter VSAN-Compliant Maintenance Mode
  vmware_maintenancemode:
    hostname: vc_host
    username: vc_user
    password: vc_pass
    esxi_hostname: esxi.host.example
    vsan: ensureObjectAccessibility
    evacuate: yes
    timeout: 3600
    state: present

Return Values

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

Key Returned Description
hostname
string
 always
Name of host in vCenter

Sample:
esxi.local.domain
hostsystem
string
 always
Name of vim reference

Sample:
'vim.HostSystem:host-236'
status
string
 always
Action taken

Sample:
ENTER


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author

Hint

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