vmware.vmware_rest.vcenter_vm_hardware 模块 – 更新虚拟机的虚拟硬件设置。

注意

此模块是 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_hardware。

vmware.vmware_rest 0.1.0 中的新增功能

概要 

更新虚拟机的虚拟硬件设置。

要求 

以下要求需要在执行此模块的主机上满足。

vSphere 7.0.3 或更高版本
python >= 3.6
aiohttp

参数 

参数	注释
session_timeout float 在 vmware.vmware_rest 2.1.0 中添加	客户端会话的超时设置。整个操作（包括连接建立、请求发送和响应）的最大秒数。默认值为 300 秒。
状态字符串	选择 `"present"` ← (默认) `"upgrade"`
upgrade_policy 字符串	upgrade_policy 枚举类型定义了虚拟机的有效虚拟硬件升级策略。选择 `"AFTER_CLEAN_SHUTDOWN"` `"ALWAYS"` `"NEVER"`
upgrade_version 字符串	version 枚举类型定义了虚拟机的有效虚拟硬件版本。请参阅 https://kb.vmware.com/s/article/1003746（虚拟机硬件版本 (1003746)）。选择 `"VMX_03"` `"VMX_04"` `"VMX_06"` `"VMX_07"` `"VMX_08"` `"VMX_09"` `"VMX_10"` `"VMX_11"` `"VMX_12"` `"VMX_13"` `"VMX_14"` `"VMX_15"` `"VMX_16"` `"VMX_17"` `"VMX_18"` `"VMX_19"` `"VMX_20"` `"VMX_21"`
vcenter_hostname 字符串 / 必需	vSphere vCenter 的主机名或 IP 地址如果未在任务中指定该值，则将使用环境变量 `VMWARE_HOST` 的值。
vcenter_password 字符串 / 必需	vSphere vCenter 密码如果未在任务中指定该值，则将使用环境变量 `VMWARE_PASSWORD` 的值。
vcenter_rest_log_file 字符串	您可以使用此可选参数来设置日志文件的位置。此文件将用于记录 HTTP REST 交互。该文件将存储在运行模块的主机上。如果未在任务中指定该值，则将使用环境变量 `VMWARE_REST_LOG_FILE` 的值。
vcenter_username 字符串 / 必需	vSphere vCenter 用户名如果未在任务中指定该值，则将使用环境变量 `VMWARE_USER` 的值。
vcenter_validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 `false`。如果未在任务中指定该值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选择 `false` `true` ← (默认)
版本字符串	version 枚举类型定义了虚拟机的有效虚拟硬件版本。请参阅 https://kb.vmware.com/s/article/1003746（虚拟机硬件版本 (1003746)）。选择 `"VMX_03"` `"VMX_04"` `"VMX_06"` `"VMX_07"` `"VMX_08"` `"VMX_09"` `"VMX_10"` `"VMX_11"` `"VMX_12"` `"VMX_13"` `"VMX_14"` `"VMX_15"` `"VMX_16"` `"VMX_17"` `"VMX_18"` `"VMX_19"` `"VMX_20"` `"VMX_21"`
vm 字符串 / 必需	虚拟机标识符。该参数必须是由 vmware.vmware_rest.vcenter_vm_info 返回的资源 ID。此参数是强制性的。

注意 

注意

在 vSphere 7.0.3 上测试

示例 

- name: Upgrade the VM hardware version
  vmware.vmware_rest.vcenter_vm_hardware:
    upgrade_policy: AFTER_CLEAN_SHUTDOWN
    upgrade_version: VMX_11
    vm: "{{ lookup('vmware.vmware_rest.vm_moid', '/my_dc/vm/test_vm1') }}"
  register: _result

返回值 

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

键	描述
id 字典	资源的 moid 返回：成功时
value 字典	升级虚拟机硬件版本返回：成功时示例： `{}`

作者

Ansible 云团队 (@ansible-collections)