community.vmware.vmware_guest_tools_upgrade 模块 – 用于升级 VMTools 的模块

注意

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

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

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

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

概要

  • 此模块升级 Windows 和 Linux 客户机上的 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

force_upgrade

布尔值

此标志会覆盖客户机操作系统检测，并强制升级 VMware Tools 或 open-vm-tools。

当 VMware Tools 过旧且无法检测 ‘guestFamily’ 值时，此标志很有用。

使用此标志有时可能会产生意外结果，因为模块将覆盖默认的

‘guestFamily’ 检测的行为。

选择

  • false ← (默认)

  • true

hostname

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

如果未在任务中指定该值，则将改用环境变量 VMWARE_HOST 的值。

installer_options

字符串

在 community.vmware 4.1.0 中添加

传递给安装程序的命令行选项，用于修改 Tools 的安装过程。

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

username

别名: admin, user

字符串

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

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

uuid

字符串

要管理的实例的 UUID（如果已知），这是 VMware 的唯一标识符。

如果未提供 name 或 moid，则此为必填项。

validate_certs

布尔值

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

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

选择

  • false

  • true ← (默认)

备注

注意

  • 为了升级 VMTools，请预先启动虚拟机 - 可以“手动”启动，也可以使用模块 community.vmware.vmware_guest_powerstate 启动。

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

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

示例

- name: Get VM 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: Upgrade VMware Tools using uuid
  community.vmware.vmware_guest_tools_upgrade:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    uuid: "{{ vm_facts.instance.hw_product_uuid }}"
  delegate_to: localhost

- name: Upgrade VMware Tools using MoID
  community.vmware.vmware_guest_tools_upgrade:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    moid: vm-42
  delegate_to: localhost

作者

  • Mike Klebolt (@MikeKlebolt)