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。

概要

参数

参数

注释

集群

字符串

虚拟机正在运行的集群名称。

数据中心

字符串

虚拟机所属的数据中心名称。

默认值： "ha-datacenter"

esxi_hostname

字符串

虚拟机正在运行的 ESXi 主机名。

文件夹

字符串

目标文件夹，用于查找现有虚拟机的绝对或相对路径。

如果找到多个同名的虚拟机，则此参数为必填项。

该文件夹应包含数据中心。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

强制

布尔值

强制操作。

选择

  • false ←（默认）

  • true

主机名

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

如果未在任务中指定该值，则将改为使用环境变量 VMWARE_HOST 的值。

moid

字符串

如果已知，则要管理的实例的托管对象 ID，这只是单个 vCenter 实例中的唯一标识符。

如果未提供 name 或 uuid，则此为必填项。

名称

字符串

虚拟机名称。

如果未提供参数 uuid 或 moid，则此为必填项。

密码

别名：pass、pwd

字符串

vSphere vCenter 或 ESXi 服务器的密码。

如果未在任务中指定该值，则将改为使用环境变量 VMWARE_PASSWORD 的值。

端口

整数

vSphere vCenter 或 ESXi 服务器的端口号。

如果未在任务中指定该值，则将改为使用环境变量 VMWARE_PORT 的值。

默认值： 443

代理主机

字符串

将接收所有 HTTPS 请求并转发它们的代理的地址。

格式是主机名或 IP。

如果未在任务中指定该值，则将改为使用环境变量 VMWARE_PROXY_HOST 的值。

代理端口

整数

将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。

如果未在任务中指定该值，则将改为使用环境变量 VMWARE_PROXY_PORT 的值。

状态

字符串

vGPU 配置文件状态。

当 present 时，如果 VM 托管的 ESXi 主机 NVIDIA GPU 提供所选的 vGPU 配置文件，则将添加该配置文件。

当 absent 时，选定的 vGPU 配置文件将从虚拟机中移除。

选择

  • "present" ← (默认)

  • "absent"

use_instance_uuid

布尔值

是否使用 VMware 实例 UUID 而不是 BIOS UUID。

选择

  • false ←（默认）

  • true

username

别名: 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)