community.vmware.vmware_host_passthrough – Manage PCI device passthrough settings on host

Note

This plugin is part of the community.vmware collection (version 1.13.0).

To install it use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_host_passthrough.

New in version 1.11.0: of community.vmware

Synopsis

  • This module can be managed PCI device passthrough settings on host.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • PyVmomi

Parameters

Parameter Choices/Defaults Comments
cluster
string
Name of the cluster from which all host systems will be used.
This parameter is required if esxi_hostname is not specified.

aliases: cluster_name
devices
list / elements=dictionary / required
List of PCI device name.
device_name
string
Name of PCI device to enable passthrough.

aliases: name
esxi_hostname
string
Name of the host system to work with.
This parameter is required if cluster_name is not specified.
User can specify specific host from the cluster.
hostname
string
The hostname or IP address of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
Environment variable support added in Ansible 2.6.
password
string
The password of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
Environment variable support added in Ansible 2.6.

aliases: pass, pwd
port
integer
Default:
443
The port number of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
Environment variable support added in Ansible 2.6.
proxy_host
string
Address of a proxy that will receive all HTTPS requests and relay them.
The format is a hostname or a IP.
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.
This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
proxy_port
integer
Port of the HTTP proxy that will receive all HTTPS requests and relay them.
If the value is not specified in the task, the value of environment variable VMWARE_PROXY_PORT will be used instead.
state
string
    Choices:
  • present ←
  • absent
If state=present, passthrough of PCI device will be enabled.
If state=absent, passthrough of PCI device will be disabled.
username
string
The username of the vSphere vCenter or ESXi server.
If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
Environment variable support added in Ansible 2.6.

aliases: admin, user
validate_certs
boolean
    Choices:
  • no
  • yes ←
Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.
If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.
Environment variable support added in Ansible 2.6.
If set to true, please make sure Python >= 2.7.9 is installed on the given machine.

Notes

Note

  • Supports check_mode.

Examples

- 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: 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
passthrough_configs
list / elements=dictionary
changed
list of that PCI devices have been enabled passthrough for each host system.

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


Authors

  • sky-joker (@sky-joker)