community.vmware.vmware_guest_tools_info 模块 – 收集虚拟机中安装的 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_info

概要

  • 收集有关虚拟机中安装的 VMware Tools 的信息。

参数

参数

注释

datacenter

字符串

虚拟机所属的数据中心名称。

folder

字符串

目标文件夹,用于查找现有虚拟机的绝对或相对路径。

如果提供了 name,则这是必需的。

该文件夹应包括数据中心。ESXi 服务器的数据中心是 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(如果已知),则该 ID 是单个 vCenter 实例中唯一的标识符。

如果未提供 nameuuid,则这是必需的。

name

字符串

要获取 VMware Tools 信息的虚拟机的名称。

如果未提供 uuidmoid,则这是必需的。

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 的值。

use_instance_uuid

布尔值

是否使用 VMware 实例 UUID 而不是 BIOS UUID。

选项

  • false ←(默认)

  • true

username

别名:admin, user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

如果未在任务中指定该值,则将使用环境变量 VMWARE_USER 的值。

uuid

字符串

如果要管理的实例的 UUID(如果已知),这是 VMware 的唯一标识符。

如果未提供 namemoid,则这是必需的。

validate_certs

布尔值

当 SSL 证书无效时允许连接。当证书不受信任时,设置为 false

如果任务中未指定该值,则将使用环境变量 VMWARE_VALIDATE_CERTS 的值。

选项

  • false

  • true ← (默认)

说明

注意

  • 所有模块都需要 API 写入权限,因此在免费的 ESXi 许可证上不受支持。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Gather VMware tools info installed in VM specified by uuid
  community.vmware.vmware_guest_tools_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
  delegate_to: localhost
  register: vmtools_info

- name: Gather VMware tools info installed in VM specified by name
  community.vmware.vmware_guest_tools_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: "{{ vm_name }}"
  delegate_to: localhost
  register: vmtools_info

返回值

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

描述

vmtools_info

字典

虚拟机中安装的 VMware Tools 的元数据

返回: 总是

示例: {"vm_guest_fullname": "Microsoft Windows 10 (64-bit)", "vm_guest_hostname": "test", "vm_guest_id": "windows9_64Guest", "vm_hw_version": "vmx-14", "vm_ipaddress": "10.10.10.10", "vm_moid": null, "vm_name": "test_vm", "vm_tools_install_type": "guestToolsTypeMSI", "vm_tools_last_install_count": 0, "vm_tools_running_status": "guestToolsRunning", "vm_tools_upgrade_policy": "manual", "vm_tools_version": 10341, "vm_tools_version_status": "guestToolsCurrent", "vm_use_instance_uuid": false, "vm_uuid": null}

作者

  • Diane Wang (@Tomorrow9)