Xapi Project Docs

Class: VUSB

Describes the vusb device

Published in:

XenServer 7.3 (inverness)

Enums

vusb_operations

Values:	attach	Attempting to attach this VUSB to a VM
	plug	Attempting to plug this VUSB into a VM
	unplug	Attempting to hot unplug this VUSB

Fields

USB_group ref USB_group [RO/runtime]

USB group used by the VUSB

Published in:

XenServer 7.3 (inverness)

VM ref VM [RO/runtime]

VM that owns the VUSB

Published in:

XenServer 7.3 (inverness)

enum vusb_operations set allowed_operations [RO/runtime]

list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.

Default value:	{}
Published in:	XenServer 4.0 (rio)	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.

(string → enum vusb_operations) map current_operations [RO/runtime]

links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.

Default value:	{}
Published in:	XenServer 4.0 (rio)	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.

bool currently_attached [RO/runtime]

is the device currently attached

Default value:	false
Published in:	XenServer 4.0 (rio)	is the device currently attached

(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, VUSB ref, string, string)

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

Parameters:	session ref session_id	Reference to a valid session
	VUSB 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)

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

Create a new VUSB record in the database only

Parameters:	session ref session_id	Reference to a valid session
	VM ref VM	The VM
	USB_group ref USB_group
	(string → string) map other_config
Minimum role:	pool-admin
Result:	The ref of the newly created VUSB record.
Published in:	XenServer 7.3 (inverness)

void destroy (session ref, VUSB ref)

Removes a VUSB record from the database

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

USB_group ref get_USB_group (session ref, VUSB ref)

Get the USB_group field of the given VUSB.

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

VM ref get_VM (session ref, VUSB ref)

Get the VM field of the given VUSB.

Parameters:	session ref session_id	Reference to a valid session
	VUSB 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_all (session ref)

Return a list of all the VUSBs 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)

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

Return a map of VUSB references to VUSB records for all VUSBs 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)

enum vusb_operations set get_allowed_operations (session ref, VUSB ref)

Get the allowed_operations field of the given VUSB.

Parameters:	session ref session_id	Reference to a valid session
	VUSB ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)	list of the operations allowed in this state. This list is advisory only and the server state may have changed by the time this field is read by a client.

VUSB ref get_by_uuid (session ref, string)

Get a reference to the VUSB 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 → enum vusb_operations) map get_current_operations (session ref, VUSB ref)

Get the current_operations field of the given VUSB.

Parameters:	session ref session_id	Reference to a valid session
	VUSB ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)	links each of the running tasks using this object (by reference) to a current_operation enum which describes the nature of the task.

bool get_currently_attached (session ref, VUSB ref)

Get the currently_attached field of the given VUSB.

Parameters:	session ref session_id	Reference to a valid session
	VUSB ref self	reference to the object
Minimum role:	read-only
Result:	value of the field
Published in:	XenServer 4.0 (rio)	is the device currently attached

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

Get the other_config field of the given VUSB.

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

VUSB record get_record (session ref, VUSB ref)

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

Parameters:	session ref session_id	Reference to a valid session
	VUSB 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, VUSB ref)

Get the uuid field of the given VUSB.

Parameters:	session ref session_id	Reference to a valid session
	VUSB 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, VUSB ref, string)

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

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

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

Set the other_config field of the given VUSB.

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

void unplug (session ref, VUSB ref)

Unplug the vusb device from the vm.

Parameters:	session ref session_id	Reference to a valid session
	VUSB ref self	vusb deivce
Minimum role:	pool-admin
Published in:	XenServer 7.3 (inverness)

Class: VUSB

Enums

Fields

Messages Hide implicit

Classes

Messages