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

注意

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

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

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

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

概要 

此模块用于重新配置给定虚拟机的 vGPU 显卡配置文件。
虚拟机必须处于关闭状态 community.vmware.vmware_guest_powerstate 模块可以执行此任务。

参数 

参数	注释
cluster 字符串	虚拟机运行所在的集群名称。
datacenter 字符串	虚拟机所属的数据中心名称。默认值： `"ha-datacenter"`
esxi_hostname 字符串	虚拟机运行所在的 ESXi 主机名。
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
force 布尔值	强制操作。选项 `false` ← (默认) `true`
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。如果任务中未指定此值，则将使用环境变量 `VMWARE_HOST` 的值。
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`的值。
状态字符串	vGPU 配置文件状态。当`present`时，如果虚拟机所在的 ESXi 主机 NVIDIA GPU 提供了所选 vGPU 配置文件，则会添加该配置文件。当`absent`时，所选 vGPU 配置文件将从虚拟机中移除。选项 `"present"` ← (默认) `"absent"`
use_instance_uuid 布尔值	是否使用 VMware 实例 UUID 而不是 BIOS UUID。选项 `false` ← (默认) `true`
用户名别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。如果任务中未指定值，则将使用环境变量`VMWARE_USER`的值。
UUID 字符串	要收集信息的实例的 UUID（如果已知），这是 VMware 的唯一标识符。这是一个必需参数，如果参数`name`或`moid`未提供。
validate_certs 布尔值	允许在 SSL 证书无效时连接。当证书不受信任时，将其设置为`false`。如果任务中未指定值，则将使用环境变量`VMWARE_VALIDATE_CERTS`的值。选项 `false` `true` ← (默认)
vgpu 字符串	根据 GPU 型号支持的 vGPU 配置文件。任何操作都需要。

备注 

注意

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

示例 

- name: Add vGPU profile to VM
  community.vmware.vmware_guest_vgpu:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    validate_certs: false
    name: UbuntuTest
    vgpu: 'grid_m10-8q'
    state: present
  delegate_to: localhost
  register: vgpu_info

- name: Remove vGPU profile to VM
  community.vmware.vmware_guest_vgpu:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    validate_certs: false
    name: UbuntuTest
    vgpu: 'grid_m10-8q'
    state: absent
  delegate_to: localhost
  register: vgpu_info

返回值 

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

键	描述
vgpu_info 字典	关于虚拟机的 vGPU 配置文件的元数据返回值：始终示例：`{"vgpu": {"Controller_Key": 100, "Key": 13000, "Label": "PCI device 0", "Summary": "NVIDIA GRID vGPU grid_m10-8q", "Unit_Number": 18, "Vgpu": "grid_m10-8q"}}`

作者

Mohamed Alibi (@Medalibi)
Unknown (@matancarmeli7)