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 主机名。 |
|
vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定此值，则将使用环境变量 |
|
要设置自动电源开启或关闭的虚拟机名称。 如果仅更改 autoStart 配置的系统默认虚拟机设置，则不需要此参数。 |
|
vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定此值，则将使用环境变量 |
|
虚拟机的启动或关闭设置。 此设置将覆盖系统默认值。 默认值： |
|
主机启动时是否启动虚拟机。 选项
|
|
虚拟机的自动启动延迟（秒）。 默认值： |
|
虚拟机的自动启动优先级。 数字越小的虚拟机越先启动。 主机关闭时，虚拟机将按相反的顺序关闭，这意味着数字越大的虚拟机越先关闭。 默认值： |
|
系统停止虚拟机时对虚拟机执行的停止操作。 选项
|
|
虚拟机的自动停止延迟（秒）。 默认值： |
|
VMware Tools 启动后继续电源开启处理。 选项
|
|
将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定此值，则将使用环境变量 |
|
虚拟机的自动启动或自动停止配置的系统默认值。 |
|
启用虚拟机的自动启动或停止。 选项
|
|
默认自动启动延迟（秒）。 默认值： |
|
系统停止时对虚拟机执行的默认停止操作。 选项
|
|
默认自动停止延迟（秒）。 默认值： |
|
VMware Tools 启动后继续电源开启处理。 如果启用此参数，则会在不等待延迟过去的情况下启动下一个虚拟机。 但是，虚拟机必须安装 VMware Tools。 选项
|
|
是否使用 VMware 实例 UUID 而不是 BIOS UUID。 选项
|
|
vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定此值，则将使用环境变量 |
|
备注
注意
所有模块都需要 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
返回值
常见返回值已在此处记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
更改虚拟机电源信息配置时返回的参数。 已返回：changed 示例： |
|
更改系统默认配置时返回的参数。 已返回：changed 示例： |