vmware.vmware_rest.vcenter_vm_tools 模块 – 更新 VMware Tools 的属性。
注意
此模块是 vmware.vmware_rest 集合 (版本 4.3.0) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install vmware.vmware_rest。您需要其他要求才能使用此模块，请参阅 要求 以了解详情。
要在 playbook 中使用它，请指定： vmware.vmware_rest.vcenter_vm_tools。
vmware.vmware_rest 0.1.0 中的新增功能
概要
更新 VMware Tools 的属性。
要求
执行此模块的主机需要以下要求。
vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp
参数
参数 |
注释 |
|---|---|
传递给安装程序的命令行选项，用于修改 Tools 的安装过程。 如果需要任何其他选项，请设置。 |
|
客户端会话的超时设置。 整个操作（包括建立连接、发送请求和响应）的最大秒数。 默认值为 300 秒。 |
|
选项
|
|
upgrade_policy 枚举类型定义了何时自动升级虚拟机的 Tools。 选项
|
|
vSphere vCenter 的主机名或 IP 地址 如果任务中未指定此值，则将使用环境变量 |
|
vSphere vCenter 密码 如果任务中未指定此值，则将使用环境变量 |
|
您可以使用此可选参数设置日志文件的位置。 此文件将用于记录 HTTP REST 交互。 该文件将存储在运行模块的主机上。 如果任务中未指定此值，则将使用 环境变量 |
|
vSphere vCenter 用户名 如果任务中未指定此值，则将使用环境变量 |
|
允许在 SSL 证书无效时连接。当证书不受信任时，设置为 如果任务中未指定此值，则将使用环境变量 选项
|
|
虚拟机的标识符。 该参数必须是 vmware.vmware_rest.vcenter_vm_info 返回的资源的 ID。此参数是必需的。 |
备注
注意
在 vSphere 7.0.3 上测试
示例
- name: Look up the VM called test_vm1 in the inventory
register: search_result
vmware.vmware_rest.vcenter_vm_info:
filter_names:
- test_vm1
- name: Collect information about a specific VM
vmware.vmware_rest.vcenter_vm_info:
vm: '{{ search_result.value[0].vm }}'
register: test_vm1_info
- name: Retrive vm-tools information
vmware.vmware_rest.vcenter_vm_tools:
vm: '{{ test_vm1_info.id }}'
register: _result
- name: Change vm-tools upgrade policy to UPGRADE_AT_POWER_CYCLE
vmware.vmware_rest.vcenter_vm_tools:
vm: '{{ test_vm1_info.id }}'
upgrade_policy: UPGRADE_AT_POWER_CYCLE
register: _result
- name: Change vm-tools upgrade policy to MANUAL
vmware.vmware_rest.vcenter_vm_tools:
vm: '{{ test_vm1_info.id }}'
upgrade_policy: MANUAL
register: _result
返回值
常见的返回值已记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
资源的 moid 返回：成功时 |
|
检索 vm-tools 信息 返回：成功时 示例： |