community.vmware.vmware_host_auto_start module – Manage the auto power ON or OFF for vm on ESXi host
Note
This module is part of the community.vmware collection (version 1.18.2).
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_auto_start.
Synopsis
In this module, can set up automatic startup and shutdown of virtual machines according to host startup or shutdown.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
PyVmomi
Parameters
Parameter |
Comments |
|---|---|
ESXi hostname where the VM to set auto power on or off exists. |
|
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. |
|
Managed Object ID of the instance to manage if known, this is a unique identifier only within a single vCenter instance. This is required if |
|
VM name to set auto power on or off. This is not necessary if change only system default VM settings for autoStart config. |
|
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. |
|
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. Default: 443 |
|
Startup or shutdown settings of virtual machine. This setting will override the system defaults. Default: {“start_action”: “none”, “start_delay”: -1, “start_order”: -1, “stop_action”: “systemDefault”, “stop_delay”: -1, “wait_for_heartbeat”: “systemDefault”} |
|
Whether to start the virtual machine when the host startup. Choices:
|
|
Auto start delay in seconds of virtual machine. Default: -1 |
|
The autostart priority of virtual machine. Virtual machines with a lower number are powered on first. On host shutdown, the virtual machines are shut down in reverse order, meaning those with a higher number are powered off first. Default: -1 |
|
Stop action executed on the virtual machine when the system stops of virtual machine. Choices:
|
|
Auto stop delay in seconds of virtual machine. Default: -1 |
|
Continue power on processing when VMware Tools started. Choices:
|
|
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
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 |
|
System defaults for auto-start or auto-stop config for virtual machine. |
|
Enable automatically start or stop of virtual machines. Choices:
|
|
Default auto start delay in seconds. Default: 120 |
|
Default stop action executed on the virtual machine when the system stops. Choices:
|
|
Default auto stop delay in seconds. Default: 120 |
|
Continue power on processing when VMware Tools started. If this parameter is enabled to powers on the next virtual machine without waiting for the delay to pass. However, the virtual machine must have VMware Tools installed. Choices:
|
|
Whether to use the VMware instance UUID rather than the BIOS UUID. Choices:
|
|
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. |
|
VM uuid to set auto power on or off, this is VMware’s unique identifier. This is required if This is not necessary if change only system default VM settings for autoStart config. |
|
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 Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
---
- name: Update for system defaults config.
community.vmware.vmware_host_auto_start:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
esxi_hostname: "{{ esxi_hostname }}"
system_defaults:
enabled: true
start_delay: 100
stop_action: guestShutdown
- name: Update for powerInfo config of virtual machine.
community.vmware.vmware_host_auto_start:
hostname: "{{ hostname }}"
username: "{{ username }}"
password: "{{ password }}"
esxi_hostname: "{{ esxi_hostname }}"
name: "{{ vm_name }}"
power_info:
start_action: powerOn
start_delay: 10
start_order: 1
stop_action: powerOff
wait_for_heartbeat: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Parameter return when virtual machine power info config is changed. Returned: changed Sample: “{\n \”start_action\”: \”powerOn\”,\n \”start_delay\”: -1,\n \”start_order\”: -1,\n \”stop_action\”: \”systemDefault\”,\n \”stop_delay\”: -1,\n \”wait_for_heartbeat\”: \”systemDefault\”\n}” |
|
Parameter return when system defaults config is changed. Returned: changed Sample: “{\n \”enabled\”: true,\n \”start_delay\”: 120,\n \”stop_action\”: \”powerOff\”,\n \”stop_delay\”: 120,\n \”wait_for_heartbeat\”: false\n}” |
Authors
sky-joker (@sky-joker)