community / community.vmware / 4.2.0 / module / vmware_host_powermgmt_policy Manages the Power Management Policy of an ESXI host system Authors: Christian Kotte (@ckotte) <christian.kotte@gmx.de>community.vmware.vmware_host_powermgmt_policy (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to manage the Power Management Policy of ESXi host systems in given vCenter infrastructure.
- 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
port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int policy: choices: - high-performance - balanced - low-power - custom default: balanced description: - Set the Power Management Policy of the host system. type: str hostname: description: - 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 E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str proxy_host: description: - 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 E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - 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 E(VMWARE_PROXY_PORT) will be used instead. required: false type: int cluster_name: description: - Name of the cluster from which all host systems will be used. - This is required parameter if O(esxi_hostname) is not specified. type: str esxi_hostname: description: - Name of the host system to work with. - This is required parameter if O(cluster_name) is not specified. type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool
result: description: 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 type: dict