community.vmware.vmware_host_auto_start 模块 – 管理 ESXi 主机上虚拟机的自动启动或关闭

注意

此模块是 community.vmware 集合（版本 5.2.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定： community.vmware.vmware_host_auto_start。

概要 

在此模块中，可以根据主机启动或关闭设置虚拟机的自动启动和关闭。

参数 

参数	注释
esxi_hostname 字符串 / 必需	ESXi 主机名，其中存在要设置自动启动或关闭的虚拟机。
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定该值，则将使用环境变量 `VMWARE_HOST` 的值。
moid 字符串	要管理的实例的托管对象 ID（如果已知），这只是在单个 vCenter 实例中的唯一标识符。如果未提供 `name` 或 `uuid`，则这是必需的。
name 字符串	要设置自动启动或关闭的虚拟机名称。如果仅更改自动启动配置的系统默认虚拟机设置，则不需要此项。
password 别名：pass，pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果任务中未指定该值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。如果任务中未指定该值，则将使用环境变量 `VMWARE_PORT` 的值。默认： `443`
power_info 字典	虚拟机的启动或关闭设置。此设置将覆盖系统默认值。默认： `{"start_action": "none", "start_delay": -1, "start_order": -1, "stop_action": "systemDefault", "stop_delay": -1, "wait_for_heartbeat": "systemDefault"}`
start_action 字符串	主机启动时是否启动虚拟机。选项 `"none"` ← (默认) `"powerOn"`
start_delay 整数	虚拟机自动启动延迟（秒）。默认： `-1`
start_order 整数	虚拟机的自动启动优先级。数字较低的虚拟机先启动。在主机关闭时，虚拟机以相反的顺序关闭，这意味着数字较高的虚拟机先关闭。默认： `-1`
stop_action 字符串	虚拟机停止时对虚拟机执行的停止操作。选项 `"none"` `"systemDefault"` ← (默认) `"powerOff"` `"suspend"`
stop_delay 整数	虚拟机自动停止延迟（秒）。默认： `-1`
wait_for_heartbeat 字符串	当 VMware Tools 启动时，继续启动电源处理。选项 `"no"` `"yes"` `"systemDefault"` ← (默认)
proxy_host 字符串	接收所有 HTTPS 请求并中继它们的代理地址。格式是主机名或 IP。如果任务中未指定该值，则将使用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	接收所有 HTTPS 请求并中继它们的 HTTP 代理端口。如果任务中未指定该值，则将使用环境变量 `VMWARE_PROXY_PORT` 的值。
system_defaults 字典	虚拟机自动启动或自动停止配置的系统默认值。
enabled 布尔值	启用虚拟机的自动启动或停止。选项 `false` ← (默认) `true`
start_delay 整数	默认自动启动延迟（秒）。默认： `120`
stop_action 字符串	系统停止时在虚拟机上执行的默认停止操作。选项 `"none"` `"guestShutdown"` `"powerOff"` ← (默认) `"suspend"`
stop_delay 整数	默认自动停止延迟（秒）。默认： `120`
wait_for_heartbeat 布尔值	当 VMware Tools 启动时，继续启动电源处理。如果启用此参数，则会在不等待延迟时间过去的情况下启动下一个虚拟机。但是，虚拟机必须安装 VMware Tools。选项 `false` ← (默认) `true`
use_instance_uuid 布尔值	是否使用 VMware 实例 UUID 而不是 BIOS UUID。选项 `false` ← (默认) `true`
username 别名：admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定该值，则将改用环境变量 `VMWARE_USER` 的值。
uuid 字符串	用于设置自动开机或关机的虚拟机 UUID，这是 VMware 的唯一标识符。如果未提供 `name`，则此参数为必需。如果仅更改自动启动配置的系统默认虚拟机设置，则不需要此项。
validate_certs 布尔值	允许在 SSL 证书无效时进行连接。当证书不受信任时，设置为 `false`。如果任务中未指定该值，则将改用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

注释 

注意

所有模块都需要 API 写入权限，因此在免费 ESXi 许可证上不受支持。
所有变量和 VMware 对象名称都区分大小写。

示例 

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

返回值 

通用返回值在此处记录这里，以下是此模块特有的字段

键	描述
power_info_config 字典	当虚拟机电源信息配置更改时返回的参数。已返回: 已更改示例: `{"start_action": "powerOn", "start_delay": -1, "start_order": -1, "stop_action": "systemDefault", "stop_delay": -1, "wait_for_heartbeat": "systemDefault"}`
system_defaults_config 字典	当系统默认配置更改时返回的参数。已返回: 已更改示例: `{"enabled": true, "start_delay": 120, "stop_action": "powerOff", "stop_delay": 120, "wait_for_heartbeat": false}`

作者

sky-joker (@sky-joker)