community.vmware.vmware_host_passthrough module – Manage PCI device passthrough settings on host
Note
This module is part of the community.vmware collection (version 5.0.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.vmware
.
To use it in a playbook, specify: community.vmware.vmware_host_passthrough
.
Synopsis
This module can be managed PCI device passthrough settings on host.
Parameters
Parameter |
Comments |
---|---|
Name of the cluster from which all host systems will be used. This parameter is required if |
|
List of PCI device name or id. |
|
Name of PCI device to enable passthrough. |
|
Name of the host system to work with. This parameter is required if User can specify specific host from the cluster. |
|
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 |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
If If Choices:
|
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
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: 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
list of that PCI devices have been enabled passthrough for each host system. Returned: changed Sample: |