Class: USBgroup

Last published : Oct 01, 2026
A group of compatible USBs across the resource pool
Related information
XenServer 9 Management API

Fields for class: USBgroup

Field Type Qualifier Description
name_description string RW a notes field containing human-readable description
name_label string RW a human-readable name
other_config (string -> string) map RW Additional configuration
PUSBs PUSB ref set RO/runtime List of PUSBs in the group
uuid string RO/runtime Unique identifier/object reference
VUSBs VUSB ref set RO/runtime List of VUSBs using the group

RPCs associated with class: USBgroup

RPC name: addtootherconfig

Overview:
Add the given keyvalue pair to the otherconfig field of the given USBgroup.
Signature:
void add_to_other_config (session ref session_ref, USB_group ref self, string key, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
USB_group 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: create

Overview:
Signature:
USB_group ref create (session ref session_ref, string name_label, string name_description, (string -> string) map other_config)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string name_label
string name_description
(string -> string) map other_config
Minimum Role: pool-admin
Return Type: USB_group ref
The reference of the created USBgroup

RPC name: destroy

Overview:
Signature:
void destroy (session ref session_ref, USB_group ref self)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
USB_group ref self The USB group to destroy
Minimum Role: pool-admin
Return Type: void

RPC name: getall

Overview:
Return a list of all the USBgroups known to the system.
Signature:
USB_group 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: USB_group ref set
references to all objects

RPC name: getallrecords

Overview:
Return a map of USBgroup references to USBgroup records for all USBgroups known to the system.
Signature:
(USB_group ref -> USB_group 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: (USB_group ref -> USB_group record) map
records of all objects

RPC name: getbynamelabel

Overview:
Get all the USBgroup instances with the given label.
Signature:
USB_group ref set get_by_name_label (session ref session_ref, string label)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
string label label of object to return
Minimum Role: read-only
Return Type: USB_group ref set
references to objects with matching names

RPC name: getbyuuid

Overview:
Get a reference to the USBgroup instance with the specified UUID.
Signature:
USB_group 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: USB_group ref
reference to the object

RPC name: getnamedescription

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

RPC name: getnamelabel

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

RPC name: getotherconfig

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

RPC name: getPUSBs

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

RPC name: getrecord

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

RPC name: getuuid

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

RPC name: getVUSBs

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

RPC name: removefromotherconfig

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

RPC name: setnamedescription

Overview:
Set the name/description field of the given USBgroup.
Signature:
void set_name_description (session ref session_ref, USB_group ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
USB_group ref self reference to the object
string value New value to set
Minimum Role: pool-admin
Return Type: void

RPC name: setnamelabel

Overview:
Set the name/label field of the given USBgroup.
Signature:
void set_name_label (session ref session_ref, USB_group ref self, string value)
Arguments:
Type Name Description
session ref session_ref Reference to a valid session
USB_group ref self reference to the object
string value New value to set
Minimum Role: pool-admin
Return Type: void

RPC name: setotherconfig

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