Class: PUSB

Last published : Oct 01, 2026
A physical USB device
Related information
XenServer 9 Management API

Fields for class: PUSB

Field Type Qualifier Description
description string RO/constructor USB device description
host host ref RO/constructor Physical machine that owns the USB device
other_config (string -> string) map RW additional configuration
passthrough_enabled bool RO/runtime enabled for passthrough
path string RO/constructor port path of USB device
product_desc string RO/constructor product description of the USB device
product_id string RO/constructor product id of the USB device
serial string RO/constructor serial of the USB device
speed float RO/constructor USB device speed
USB_group USB_group ref RO/constructor USB group the PUSB is contained in
uuid string RO/runtime Unique identifier/object reference
vendor_desc string RO/constructor vendor description of the USB device
vendor_id string RO/constructor vendor id of the USB device
version string RO/constructor USB device version

RPCs associated with class: PUSB

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given PUSB.
Signature:
void add_to_other_config (session ref session_ref, PUSB ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
string key Key to add
string value Value to add
Minimum Role: pool-admin
Return Type: void

RPC name: getall

Overview:
Return a list of all the PUSBs known to the system.
Signature:
PUSB ref set get_all (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: PUSB ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of PUSB references to PUSB records for all PUSBs known to the system.
Signature:
(PUSB ref -> PUSB record) map get_all_records (session ref session_ref)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
Minimum Role: read-only
Return Type: (PUSB ref -> PUSB record) map
records of all objects

RPC name: getbyuuid

Overview:
Get a reference to the PUSB instance with the specified UUID.
Signature:
PUSB ref get_by_uuid (session ref session_ref, string uuid)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string uuid UUID of object to return
Minimum Role: read-only
Return Type: PUSB ref
reference to the object

RPC name: getdescription

Overview:
Get the description field of the given PUSB.
Signature:
string get_description (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: gethost

Overview:
Get the host field of the given PUSB.
Signature:
host ref get_host (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: host ref
value of the field

RPC name: getotherconfig

Overview:
Get the otherconfig field of the given PUSB.
Signature:
(string -> string) map get_other_config (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: (string -> string) map
value of the field

RPC name: getpassthroughenabled

Overview:
Get the passthroughenabled field of the given PUSB.
Signature:
bool get_passthrough_enabled (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: bool
value of the field

RPC name: getpath

Overview:
Get the path field of the given PUSB.
Signature:
string get_path (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getproductdesc

Overview:
Get the productdesc field of the given PUSB.
Signature:
string get_product_desc (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getproductid

Overview:
Get the productid field of the given PUSB.
Signature:
string get_product_id (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getrecord

Overview:
Get a record containing the current state of the given PUSB.
Signature:
PUSB record get_record (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: PUSB record
all fields from the object

RPC name: getserial

Overview:
Get the serial field of the given PUSB.
Signature:
string get_serial (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getspeed

Overview:
Get the speed field of the given PUSB.
Signature:
float get_speed (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: float
value of the field

RPC name: getUSBgroup

Overview:
Get the USBgroup field of the given PUSB.
Signature:
USB_group ref get_USB_group (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: USB_group ref
value of the field

RPC name: getuuid

Overview:
Get the uuid field of the given PUSB.
Signature:
string get_uuid (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getvendordesc

Overview:
Get the vendordesc field of the given PUSB.
Signature:
string get_vendor_desc (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getvendorid

Overview:
Get the vendorid field of the given PUSB.
Signature:
string get_vendor_id (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: getversion

Overview:
Get the version field of the given PUSB.
Signature:
string get_version (session ref session_ref, PUSB ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
Minimum Role: read-only
Return Type: string
value of the field

RPC name: removefromotherconfig

Overview:
Remove the given key and its corresponding value from the otherconfig field of the given PUSB. If the key is not in that Map, then do nothing.
Signature:
void remove_from_other_config (session ref session_ref, PUSB ref self, string key)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
string key Key to remove
Minimum Role: pool-admin
Return Type: void

RPC name: scan

Overview:
Signature:
void scan (session ref session_ref, host ref host)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
host ref host The host
Minimum Role: pool-admin
Return Type: void

RPC name: setotherconfig

Overview:
Set the otherconfig field of the given PUSB.
Signature:
void set_other_config (session ref session_ref, PUSB ref self, (string -> string) map value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self reference to the object
(string -> string) map value New value to set
Minimum Role: pool-admin
Return Type: void

RPC name: setpassthroughenabled

Overview:
Signature:
void set_passthrough_enabled (session ref session_ref, PUSB ref self, bool value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
PUSB ref self this PUSB
bool value passthrough is enabled when true and disabled with false
Minimum Role: pool-admin
Return Type: void