vm.device.passthrough_device

Retrieve details about device PCI device

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: device

device

Type: string

PCI device identifier to get passthrough information for.

Must be at least 1 characters long

Return value

VMDevicePassthroughDevice

Type: object

Detailed information about the specified PCI passthrough device.

No Additional Properties

capability Required

VMDeviceCapability

Type: object

PCI device capability information.

No Additional Properties

class Required

Class

PCI device class identifier. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

domain Required

Domain

PCI domain number. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

bus Required

Bus

PCI bus number. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

slot Required

Slot

PCI slot number. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

function Required

Function

PCI function number. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

product Required

Product

Product name of the PCI device. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

vendor Required

Vendor

Vendor name of the PCI device. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

controller_type Required

Controller Type

Type of controller this device provides. null if not a controller.

Any of

• Option 1
• Option 2

Type: string

Type: null

iommu_group

Default: null

IOMMU group information for device isolation. null if IOMMU not available.

Any of

• VMDeviceIOMMUGroup
• Option 2

VMDeviceIOMMUGroup

Type: object
No Additional Properties

number Required

Number

Type: integer

IOMMU group number for device isolation.

addresses Required

Addresses

Type: array of object

Array of PCI addresses in this IOMMU group.

No Additional Items

Each item of this array must be:

VMDeviceIOMMUGroupAddress

Type: object
No Additional Properties

domain Required

Domain

Type: string

PCI domain number for this IOMMU group address.

bus Required

Bus

Type: string

PCI bus number for this IOMMU group address.

slot Required

Slot

Type: string

PCI slot number for this IOMMU group address.

function Required

Function

Type: string

PCI function number for this IOMMU group address.

Type: null

available Required

Available

Type: boolean

Whether the device is available for passthrough to virtual machines.

drivers Required

Drivers

Type: array of string

Array of kernel drivers currently bound to this device.

No Additional Items

Each item of this array must be:

Type: string

error Required

Error

Error message if the device cannot be used for passthrough. null if no error.

Any of

• Option 1
• Option 2

Type: string

Type: null

reset_mechanism_defined Required

Reset Mechanism Defined

Type: boolean

Whether the device supports proper reset mechanisms for passthrough.

description Required

Description

Type: string

Human-readable description of the PCI device.

critical Required

Critical

Type: boolean

Whether this device is critical to host system operation.

device_path Required

Device Path

Device filesystem path. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

Required roles: VM_DEVICE_READ