community.vmware.vmware_maintenancemode – Place a host into maintenance mode
Note
This plugin is part of the community.vmware collection (version 1.9.0).
To install it use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_maintenancemode
.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
esxi_hostname
string
/ required
|
|
Name of the host as defined in vCenter.
|
evacuate
boolean
|
|
If set to True , evacuate all powered off VMs.
|
hostname
string
|
|
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 Ansible 2.6.
|
password
string
|
|
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 Ansible 2.6.
aliases: pass, pwd
|
port
integer
|
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 Ansible 2.6.
|
proxy_host
string
|
|
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.
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
|
proxy_port
integer
|
|
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
|
Choices:
present ←
- absent
|
Enter or exit maintenance mode.
|
timeout
integer
|
Default:
0
|
Specify a timeout for the operation.
|
username
string
|
|
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 Ansible 2.6.
aliases: admin, user
|
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.
Environment variable support added in Ansible 2.6.
If set to true , please make sure Python >= 2.7.9 is installed on the given machine.
|
vsan
string
|
Choices:
- ensureObjectAccessibility
- evacuateAllData
- noAction
|
Specify which VSAN compliant mode to enter.
aliases: vsan_mode
|
- 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
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
|