community.vmware.vmware_guest_tpm 模块 – 为指定的虚拟机添加或移除 vTPM 设备。

注意

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

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

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

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

概要 

此模块用于为现有虚拟机添加或删除虚拟可信平台模块 (vTPM) 设备。您必须在 vCenter 上创建密钥提供程序，然后才能添加 vTPM。您环境中运行的 ESXi 主机必须是 ESXi 6.7 或更高版本（Windows 客户机操作系统）或 7.0 Update 2（Linux 客户机操作系统）。

参数 

参数	注释
datacenter 字符串 / 必需	vCenter 数据中心名称，用于获取指定的集群或主机。
folder 字符串	虚拟机文件夹，用于查找现有虚拟机的绝对或相对路径。仅当找到多个同名虚拟机时才需要此参数。该文件夹应包含数据中心名称。示例 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 实例中唯一的标识符。如果未提供 `name` 或 `uuid`，则此项为必需项。
name 字符串	虚拟机的名称。如果未提供参数 `uuid` 或 `moid`，则此项为必需项。
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` 的值。
state 字符串	vTPM 设备的状态。如果设置为“absent”，则将从虚拟机中删除 vTPM 设备。如果设置为“present”，则将在不存在时添加 vTPM 设备。在添加或删除 vTPM 设备之前，应关闭虚拟机。在添加 vTPM 设备之前，虚拟机不应包含快照。选项 `"present"` ← (默认) `"absent"`
username 别名：admin, user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果未在任务中指定该值，则将改用环境变量 `VMWARE_USER` 的值。
uuid 字符串	如果要管理实例的 UUID，此 UUID 是 VMware 的唯一标识符。如果未提供参数 `name` 或 `moid`，则此项为必需项。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 `false`。如果未在任务中指定该值，则将改用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)

说明 

注意

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

示例 

- name: Add vTPM to specified VM
  community.vmware.vmware_guest_tpm:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    name: "Test_VM"
    state: present
  delegate_to: localhost

- name: Remove vTPM from specified VM
  community.vmware.vmware_guest_tpm:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter }}"
    name: "Test_VM"
    state: absent
  delegate_to: localhost

返回值 

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

键	描述
instance 字典	关于 VM vTPM 设备的元数据返回: 总是示例: `"None"`

作者

Diane Wang (@Tomorrow9)