community.vmware.vmware_guest_powerstate 模块 – 管理 vCenter 中虚拟机的电源状态
注意
此模块是 community.vmware 集合 (版本 5.2.0) 的一部分。
如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install community.vmware。
要在 playbook 中使用它，请指定： community.vmware.vmware_guest_powerstate。
概要
启动/关闭/重启虚拟机。
参数
参数 |
注释 |
|---|---|
要回答的问题列表，如果在等待任务完成时出现一个或多个问题。 一些常见用途是允许更改即使已锁定的 CD-ROM，或回答有关虚拟机是复制还是移动的问题。 如果使用 |
|
消息 ID，例如 |
|
选择键，例如 |
|
您想要操作电源的虚拟机所在的 Datacenter。 默认值： |
|
目标文件夹，查找现有访客的绝对或相对路径。 文件夹应包含 Datacenter。ESX 的 Datacenter 是 ha-datacenter 示例 folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2 |
|
忽略警告并完成操作。 强制虚拟机状态时，此参数很有用。 选项
|
|
vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定该值，则将改用环境变量 |
|
要使用的虚拟机的名称。 vCenter 中的虚拟机名称不一定是唯一的，这可能会有问题，请参见 |
|
如果有多个虚拟机与名称匹配，则使用找到的第一个或最后一个。 选项
|
|
vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定该值，则将改用环境变量 |
|
接收所有 HTTPS 请求并转发它们的 HTTP 代理服务器端口。 如果任务中未指定此值，则将使用环境变量 |
|
计划任务的描述。 仅当指定了 |
|
指示计划任务是启用还是禁用的标志。 选项
|
|
计划任务的名称。 仅当指定了 |
|
需要执行指定任务的日期和时间，以字符串格式表示。 日期和时间的所需格式：'dd/mm/yyyy hh:mm'。 计划任务需要 vCenter 服务器。独立的 ESXi 服务器不支持此选项。 |
|
设置虚拟机的状态。 选项
|
|
如果 如果将此参数设置为正整数，则模块将等待虚拟机达到 powered-off 状态。 该值设置模块等待状态更改的超时时间（以秒为单位）。 默认值： |
|
是否使用 VMware 实例 UUID 而不是 BIOS UUID。 选项
|
|
vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定此值，则将使用环境变量 |
|
允许在 SSL 证书无效时连接。当证书不受信任时，设置为 如果任务中未指定此值，则将使用环境变量 选项
|
注释
注意
所有模块都需要 API 写入访问权限，因此不受免费 ESXi 许可证的支持。
所有变量和 VMware 对象名称都区分大小写。
示例
- name: Set the state of a virtual machine to poweroff
community.vmware.vmware_guest_powerstate:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
folder: "/{{ datacenter_name }}/vm/my_folder"
name: "{{ guest_name }}"
state: powered-off
delegate_to: localhost
register: deploy
- name: Set the state of a virtual machine to poweron using MoID
community.vmware.vmware_guest_powerstate:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
folder: "/{{ datacenter_name }}/vm/my_folder"
moid: vm-42
state: powered-on
delegate_to: localhost
register: deploy
- name: Set the state of a virtual machine to poweroff at given scheduled time
community.vmware.vmware_guest_powerstate:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
folder: "/{{ datacenter_name }}/vm/my_folder"
name: "{{ guest_name }}"
state: powered-off
scheduled_at: "09/01/2018 10:18"
schedule_task_name: "task_00001"
schedule_task_description: "Sample task to poweroff VM"
schedule_task_enabled: true
delegate_to: localhost
register: deploy_at_schedule_datetime
- name: Wait for the virtual machine to shutdown
community.vmware.vmware_guest_powerstate:
hostname: "{{ vcenter_hostname }}"
username: "{{ vcenter_username }}"
password: "{{ vcenter_password }}"
name: "{{ guest_name }}"
state: shutdown-guest
state_change_timeout: 200
delegate_to: localhost
register: deploy
- name: Automatically answer if a question locked a virtual machine
block:
- name: Power on a virtual machine without the answer param
community.vmware.vmware_guest_powerstate:
hostname: "{{ esxi_hostname }}"
username: "{{ esxi_username }}"
password: "{{ esxi_password }}"
validate_certs: false
folder: "{{ f1 }}"
name: "{{ vm_name }}"
state: powered-on
rescue:
- name: Power on a virtual machine with the answer param
community.vmware.vmware_guest_powerstate:
hostname: "{{ esxi_hostname }}"
username: "{{ esxi_username }}"
password: "{{ esxi_password }}"
validate_certs: false
folder: "{{ f1 }}"
name: "{{ vm_name }}"
answer:
- question: "msg.uuid.altered"
response: "button.uuid.copiedTheVM"
state: powered-on