community.vmware.vmware_guest_tools_wait 模块 – 等待 VMware Tools 可用

注意

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

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

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

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

概要 

此模块可用于等待给定虚拟机上的 VMware Tools 可用并返回事实。

参数 

参数	注释
datacenter 字符串	数据中心的名称。搜索虚拟机的目标数据中心。
folder 字符串	目标文件夹，查找现有客户机的绝对或相对路径。只有在找到具有相同 `name` 的多个虚拟机时才需要此参数。此文件夹应包含数据中心。ESX 的数据中心是 `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
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
moid 字符串	要管理的实例的管理对象 ID（如果已知），这在单个 vCenter 实例中是唯一的标识符。如果未提供 `name` 或 `uuid`，则需要此参数。
name 字符串	要等待其工具可用到的虚拟机的名称。如果未提供 `uuid` 或 `moid`，则需要此参数。
name_match 字符串	如果多个虚拟机与名称匹配，则使用找到的第一个或最后一个。选项 `"first"` ← (默认) `"last"`
password 别名：pass，pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。如果任务中未指定此值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。如果任务中未指定此值，则将使用环境变量 `VMWARE_PORT` 的值。默认值： `443`
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。格式为主机名或 IP。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_HOST` 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。如果任务中未指定此值，则将使用环境变量 `VMWARE_PROXY_PORT` 的值。
timeout 整数	等待时间的最大持续时间（秒）。默认值： `500`
use_instance_uuid 布尔值	是否使用 VMware 实例 UUID 而不是 BIOS UUID。选项 `false` ← (默认) `true`
用户名别名: admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定此值，则将使用环境变量 `VMWARE_USER` 的值。
UUID 字符串	要等待其工具可用（如果已知）的虚拟机的 UUID。这是 VMware 的唯一标识符。如果未提供 `name` 或 `moid`，则需要此参数。
validate_certs 布尔值	允许在 SSL 证书无效时连接。当证书不受信任时，将其设置为 `false`。如果任务中未指定此值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

注释 

注意

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

示例 

- name: Wait for VMware tools to become available by UUID
  vmware_guest_facts:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    folder: "/{{datacenter}}/vm"
    name: "{{ vm_name }}"
  delegate_to: localhost
  register: vm_facts

- name: Get UUID from previous task and pass it to this task
  community.vmware.vmware_guest_tools_wait:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    uuid: "{{ vm_facts.instance.hw_product_uuid }}"
  delegate_to: localhost
  register: facts


- name: Wait for VMware tools to become available by MoID
  community.vmware.vmware_guest_tools_wait:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    moid: vm-42
  delegate_to: localhost
  register: facts

- name: Wait for VMware tools to become available by name
  community.vmware.vmware_guest_tools_wait:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    name: test-vm
    folder: "/{{datacenter}}/vm"
    datacenter: "{{ datacenter }}"
  delegate_to: localhost
  register: facts

返回值 

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

键	描述
instance 字典	关于虚拟机的元数据返回：始终示例： `"None"`

作者

Philippe Dellaert (@pdellaert)