vm.device.usb_passthrough_choices

Available choices for USB passthrough devices.

Type: object

Call parameters

Type: array
No Additional Items

Return value

USBPassthroughInfo

Type: object

Object of available USB devices for passthrough with their detailed information.

Additional Properties

Each additional property must conform to the following schema

USBPassthroughDevice

Type: object
No Additional Properties

capability Required

USBCapability

Type: object

USB device capability and identification information.

No Additional Properties

product Required

Product

USB product name. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

product_id Required

Product Id

USB product identifier. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

vendor Required

Vendor

USB vendor name. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

vendor_id Required

Vendor Id

USB vendor identifier. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

bus Required

Bus

USB bus number. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

device Required

Device

USB device number on bus. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

available Required

Available

Type: boolean

Whether the USB device is available for passthrough to virtual machines.

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

Required roles: READONLY_ADMIN | VM_DEVICE_READ