community.vmware.vmware_guest_video 模块 – 修改给定 vCenter 基础架构中指定虚拟机的显卡配置

注意

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

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

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

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

概要 

此模块用于重新配置给定虚拟机的显卡设置。

参数 

参数	注释
datacenter 字符串	虚拟机所属的数据中心名称。默认值： `"ha-datacenter"`
display_number 整数	显示器的数量。有效值为 1 到 10。在 vCenter 6.0、6.5 Web UI 上，最大显示器数量为 4。
enable_3D 布尔值	为 VMware 支持 3D 的客户操作系统启用 3D。选项 `false` `true`
folder 字符串	目标文件夹，查找现有客户机的绝对或相对路径。如果使用相同名称找到多个虚拟机，则这是必需参数。文件夹应包含数据中心。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
gather_video_facts 布尔值	如果设置为 `true`，则返回显卡设置，其他属性将被忽略。如果设置为 `false`，将进行重新配置并返回显卡设置。选项 `false` ← (默认) `true`
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
memory_3D_mb 整数	3D 内存的值必须是 2 的幂，有效值为 32 MB 到 2048 MB。
moid 字符串	要管理的实例的托管对象 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` 的值。
renderer_3D 字符串	如果设置为 `automatic`，则会自动为该虚拟机选择合适的选项（软件或硬件）。如果设置为 `software`，则使用正常的 CPU 处理能力进行 3D 计算。如果设置为 `hardware`，则需要图形硬件 (GPU) 来进行更快的 3D 计算。选项 `"automatic"` `"software"` `"hardware"`
use_auto_detect 布尔值	如果设置为 `true`，则将常用的视频设置应用于客户操作系统，属性 `display_number` 和 `video_memory_mb` 将被忽略。如果设置为 `false`，则将使用 `display_number` 和 `video_memory_mb` 重新配置显示器数量和总视频内存。选项 `false` `true`
用户名别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定此值，则将使用环境变量 `VMWARE_USER` 的值。
UUID 字符串	如果已知，则为实例的 UUID，这是 VMware 的唯一标识符。这是一个必需参数，如果参数 `name` 或 `moid` 未提供。
validate_certs 布尔值	允许在 SSL 证书无效时连接。当证书不受信任时，将其设置为 `false`。如果任务中未指定此值，则将使用环境变量 `VMWARE_VALIDATE_CERTS` 的值。选项 `false` `true` ← (默认)
video_memory_mb 浮点数	虚拟机的有效总视频内存范围：在 ESXi 6.7U1 上为 1.172 MB 到 256 MB，在 ESXi 6.7 和之前的版本上为 1.172 MB 到 128 MB。对于特定的客户操作系统，支持的最小和最大视频内存是不同的，请谨慎设置。

备注 

注意

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

示例 

- name: Change video card settings of virtual machine
  community.vmware.vmware_guest_video:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: test-vm
    gather_video_facts: false
    use_auto_detect: false
    display_number: 2
    video_memory_mb: 8.0
    enable_3D: true
    renderer_3D: automatic
    memory_3D_mb: 512
  delegate_to: localhost
  register: video_facts

- name: Change video card settings of virtual machine using MoID
  community.vmware.vmware_guest_video:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    moid: vm-42
    gather_video_facts: false
    use_auto_detect: false
    display_number: 2
    video_memory_mb: 8.0
    enable_3D: true
    renderer_3D: automatic
    memory_3D_mb: 512
  delegate_to: localhost
  register: video_facts

- name: Gather video card settings of virtual machine
  community.vmware.vmware_guest_video:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: test-vm
    gather_video_facts: false
  delegate_to: localhost
  register: video_facts

返回值 

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

键	描述
video_status 字典	管理虚拟机的显卡后的元数据返回值：始终返回示例： `{"auto_detect": false, "display_number": 2, "enable_3D_support": true, "memory_3D": 524288, "renderer_3D": "automatic", "video_memory": 8192}`

作者

王迪安 (@Tomorrow9)