vmware_host_powerstate – Manages power states of host systems in vCenter
vmware_host_powerstate – Manages power states of host systems in vCenter
New in version 2.6.
Synopsis
- This module can be used to manage power states of host systems in given vCenter infrastructure.
- User can set power state to ‘power-down-to-standby’, ‘power-up-from-standby’, ‘shutdown-host’ and ‘reboot-host’.
- State ‘reboot-host’, ‘shutdown-host’ and ‘power-down-to-standby’ are not supported by all the host systems.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- PyVmomi
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
cluster_name - |
Name of the cluster from which all host systems will be used. This is required parameter if | |
esxi_hostname - |
Name of the host system to work with. This is required parameter if | |
force boolean |
|
This parameter specify if the host should be proceeding with user defined powerstate regardless of whether it is in maintenance mode. If If If Not applicable if |
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 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 Environment variable support added in Ansible 2.6.
| |
port integer 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 Environment variable support added in Ansible 2.6. |
state - |
|
Set the state of the host system. |
timeout - |
Default: 600 |
This parameter defines timeout for Ignored if This parameter is defined in seconds. |
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 Environment variable support added in Ansible 2.6.
| |
validate_certs boolean |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to |
Examples
- name: Set the state of a host system to reboot
vmware_host_powerstate:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
validate_certs: no
esxi_hostname: '{{ esxi_hostname }}'
state: reboot-host
delegate_to: localhost
register: reboot_host
- name: Set the state of a host system to power down to standby
vmware_host_powerstate:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
validate_certs: no
esxi_hostname: '{{ esxi_hostname }}'
state: power-down-to-standby
delegate_to: localhost
register: power_down
- name: Set the state of all host systems from cluster to reboot
vmware_host_powerstate:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
validate_certs: no
cluster_name: '{{ cluster_name }}'
state: reboot-host
delegate_to: localhost
register: reboot_host
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
result dictionary |
always |
metadata about host system's state
Sample: {'esxi01': {'msg': "power down 'esxi01' to standby", 'error': }} |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Abhijeet Kasurde (@Akasurde) <[email protected]>
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/vmware_host_powerstate_module.html