community.vmware.vmware_host_passthrough 模块 – 管理主机上的 PCI 设备直通设置

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.vmware

要在剧本中使用它,请指定:community.vmware.vmware_host_passthrough

概要

  • 此模块可以管理主机上的 PCI 设备直通设置。

参数

参数

注释

集群

别名: cluster_name

字符串

从中将使用所有主机系统的集群的名称。

如果未指定 esxi_hostname,则此参数是必需的。

devices

列表 / 元素=字典 / 必需

PCI 设备名称或 ID 的列表。

device

别名: name, device_name

字符串

要启用直通的 PCI 设备名称。

esxi_hostname

字符串

要使用的主机系统的名称。

如果未指定 cluster_name,则此参数是必需的。

用户可以从集群中指定特定的主机。

hostname

字符串

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

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

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 的值。

state

字符串

如果 state=present,则将启用 PCI 设备的直通。

如果 state=absent,则将禁用 PCI 设备的直通。

选择

  • "present" ← (默认)

  • "absent"

username

别名: admin, user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

如果未在任务中指定该值,则将改用环境变量 VMWARE_USER 的值。

validate_certs

布尔值

当 SSL 证书无效时允许连接。当证书不受信任时,设置为 false

如果未在任务中指定该值,则将改用环境变量 VMWARE_VALIDATE_CERTS 的值。

选择

  • false

  • true ← (默认)

注释

注意

  • 所有模块都需要 API 写入权限,因此在免费的 ESXi 许可证上不支持。

  • 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Enable PCI device passthrough against the whole ESXi in a cluster
  community.vmware.vmware_host_passthrough:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    cluster: "{{ ccr1 }}"
    devices:
      - device_name: "Dual Band Wireless AC 3165"
    state: present

- name: Enable PCI device passthrough against one ESXi
  community.vmware.vmware_host_passthrough:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    esxi_hostname: "{{ esxi1 }}"
    devices:
      - device_name: "Dual Band Wireless AC 3165"
    state: present

- name: Enable PCI device passthrough with PCI ids
  community.vmware.vmware_host_passthrough:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    esxi_hostname: "{{ esxi1 }}"
    devices:
      - device: '0000:03:00.0'
      - device: '0000:00:02.0'
    state: present

- name: Disable PCI device passthrough against the whole ESXi in a cluster
  community.vmware.vmware_host_passthrough:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    validate_certs: false
    cluster: "{{ ccr1 }}"
    devices:
      - device_name: "Dual Band Wireless AC 3165"
    state: absent

返回值

通用返回值已在此处 记录,以下是此模块特有的字段

描述

passthrough_configs

列表 / 元素=字典

已为每个主机系统启用直通的 PCI 设备列表。

返回: changed

示例: "[\n    {\n        \"esxi-01.example.com\": [\n            {\n                \"device_id\": \"0000:03:00.0\",\n                \"device_name\": \"Dual Band Wireless AC 3165\",\n                \"passthruEnabled\": true\n            }\n        ]\n    },\n    {\n        \"esxi-02.example.com\": [\n            {\n                \"device_id\": \"0000:03:00.0\",\n                \"device_name\": \"Dual Band Wireless AC 3165\",\n                \"passthruEnabled\": true\n            }\n        ]\n    }\n]"

作者

  • sky-joker (@sky-joker)