community.vmware.vmware_host_powermgmt_policy module – Manages the Power Management Policy of an ESXI host system

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

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module can be used to manage the Power Management Policy of ESXi host systems in given vCenter infrastructure.

Parameters

Parameter	Comments
cluster_name string	Name of the cluster from which all host systems will be used. This is required parameter if `esxi_hostname` is not specified.
esxi_hostname string	Name of the host system to work with. This is required parameter if `cluster_name` is not specified.
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.
policy string	Set the Power Management Policy of the host system. Choices: `"high-performance"` `"balanced"` ← (default) `"low-power"` `"custom"`
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.
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)

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: Set the Power Management Policy of a host system to high-performance
  community.vmware.vmware_host_powermgmt_policy:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    esxi_hostname: '{{ esxi_host }}'
    policy: high-performance
  delegate_to: localhost

- name: Set the Power Management Policy of all host systems from cluster to high-performance
  community.vmware.vmware_host_powermgmt_policy:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: '{{ cluster_name }}'
    policy: high-performance
  delegate_to: localhost

Return Values

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

Key	Description
result dictionary	metadata about host system’s Power Management Policy Returned: always Sample: `{"changed": true, "result": {"esxi01": {"changed": true, "current_state": "high-performance", "desired_state": "high-performance", "msg": "Power policy changed", "previous_state": "balanced"}}}`

Authors

Christian Kotte (@ckotte)

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