Xapi Project Docs

Class: USB_group

A group of compatible USBs across the resource pool

Published in:

XenServer 7.3 (inverness)

Fields

PUSB ref set PUSBs [RO/runtime]

List of PUSBs in the group

Published in:

XenServer 7.3 (inverness)

VUSB ref set VUSBs [RO/runtime]

List of VUSBs using the group

Published in:

XenServer 7.3 (inverness)

string name_description [RW]

a notes field containing human-readable description

Default value:	""
Published in:	XenServer 7.3 (inverness)

string name_label [RW]

a human-readable name

Default value:	""
Published in:	XenServer 7.3 (inverness)

(string → string) map other_config [RW]

Additional configuration

Default value:	{}
Published in:	XenServer 7.3 (inverness)

string uuid [RO/runtime]

Unique identifier/object reference

Published in:

XenServer 7.3 (inverness)

Messages

void add_to_other_config (session ref, USB_group ref, string, string)

Add the given key-value pair to the other_config field of the given USB_group.

Parameters:	session ref session_id	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
Published in:	XenServer 7.3 (inverness)

USB_group ref create (session ref, string, string, (string → string) map)

Parameters:	session ref session_id	Reference to a valid session
	string name_label
	string name_description
	(string → string) map other_config
Minimum role:	pool-admin
Result:	The reference of the created USB_group
Published in:	XenServer 7.3 (inverness)

void destroy (session ref, USB_group ref)

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	The USB group to destroy
Minimum role:	pool-admin
Published in:	XenServer 7.3 (inverness)

PUSB ref set get_PUSBs (session ref, USB_group ref)

Get the PUSBs field of the given USB_group.

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.3 (inverness)

VUSB ref set get_VUSBs (session ref, USB_group ref)

Get the VUSBs field of the given USB_group.

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.3 (inverness)

USB_group ref set get_all (session ref)

Return a list of all the USB_groups known to the system.

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	references to all objects
Published in:	XenServer 7.3 (inverness)

(USB_group ref → USB_group record) map get_all_records (session ref)

Return a map of USB_group references to USB_group records for all USB_groups known to the system.

Parameters:	session ref session_id	Reference to a valid session
Minimum role:	read-only
Result:	records of all objects
Published in:	XenServer 7.3 (inverness)

USB_group ref set get_by_name_label (session ref, string)

Get all the USB_group instances with the given label.

Parameters:	session ref session_id	Reference to a valid session
	string label	label of object to return
Minimum role:	read-only
Result:	references to objects with matching names
Published in:	XenServer 7.3 (inverness)

USB_group ref get_by_uuid (session ref, string)

Get a reference to the USB_group instance with the specified UUID.

Parameters:	session ref session_id	Reference to a valid session
	string uuid	UUID of object to return
Minimum role:	read-only
Result:	reference to the object
Published in:	XenServer 7.3 (inverness)

string get_name_description (session ref, USB_group ref)

Get the name/description field of the given USB_group.

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.3 (inverness)

string get_name_label (session ref, USB_group ref)

Get the name/label field of the given USB_group.

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.3 (inverness)

(string → string) map get_other_config (session ref, USB_group ref)

Get the other_config field of the given USB_group.

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.3 (inverness)

USB_group record get_record (session ref, USB_group ref)

Get a record containing the current state of the given USB_group.

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	reference to the object
Minimum role:	read-only
Result:	all fields from the object
Published in:	XenServer 7.3 (inverness)

string get_uuid (session ref, USB_group ref)

Get the uuid field of the given USB_group.

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 7.3 (inverness)

void remove_from_other_config (session ref, USB_group ref, string)

Remove the given key and its corresponding value from the other_config field of the given USB_group. If the key is not in that Map, then do nothing.

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	reference to the object
	string key	Key to remove
Minimum role:	pool-admin
Published in:	XenServer 7.3 (inverness)

void set_name_description (session ref, USB_group ref, string)

Set the name/description field of the given USB_group.

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	reference to the object
	string value	New value to set
Minimum role:	pool-admin
Published in:	XenServer 7.3 (inverness)

void set_name_label (session ref, USB_group ref, string)

Set the name/label field of the given USB_group.

Parameters:	session ref session_id	Reference to a valid session
	USB_group ref self	reference to the object
	string value	New value to set
Minimum role:	pool-admin
Published in:	XenServer 7.3 (inverness)

void set_other_config (session ref, USB_group ref, (string → string) map)

Set the other_config field of the given USB_group.

Parameters:	session ref session_id	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
Published in:	XenServer 7.3 (inverness)

Class: USB_group

Fields

Messages Hide implicit

Classes

Messages