Develop for XenServer

Class: USB_group

June 19, 2024

Contributed by:

X X

A group of compatible USBs across the resource pool

Fields for class: USB_group

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: USB_group

RPC name: add_to_other_config

Overview:

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

Signature:

void add_to_other_config (session ref session_ref, USB_group ref self, string key, string value)
<!--NeedCopy-->

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)
<!--NeedCopy-->

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 USB_group

RPC name: destroy

Overview:

Signature:

void destroy (session ref session_ref, USB_group ref self)
<!--NeedCopy-->

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: get_all

Overview:

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

Signature:

USB_group ref set get_all (session ref session_ref)
<!--NeedCopy-->

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: get_all_records

Overview:

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

Signature:

(USB_group ref -> USB_group record) map get_all_records (session ref session_ref)
<!--NeedCopy-->

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: get_by_name_label

Overview:

Get all the USB_group instances with the given label.

Signature:

USB_group ref set get_by_name_label (session ref session_ref, string label)
<!--NeedCopy-->

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: get_by_uuid

Overview:

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

Signature:

USB_group ref get_by_uuid (session ref session_ref, string uuid)
<!--NeedCopy-->

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: get_name_description

Overview:

Get the name/description field of the given USB_group.

Signature:

string get_name_description (session ref session_ref, USB_group ref self)
<!--NeedCopy-->

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: get_name_label

Overview:

Get the name/label field of the given USB_group.

Signature:

string get_name_label (session ref session_ref, USB_group ref self)
<!--NeedCopy-->

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: get_other_config

Overview:

Get the other_config field of the given USB_group.

Signature:

(string -> string) map get_other_config (session ref session_ref, USB_group ref self)
<!--NeedCopy-->

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: get_PUSBs

Overview:

Get the PUSBs field of the given USB_group.

Signature:

PUSB ref set get_PUSBs (session ref session_ref, USB_group ref self)
<!--NeedCopy-->

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: get_record

Overview:

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

Signature:

USB_group record get_record (session ref session_ref, USB_group ref self)
<!--NeedCopy-->

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: get_uuid

Overview:

Get the uuid field of the given USB_group.

Signature:

string get_uuid (session ref session_ref, USB_group ref self)
<!--NeedCopy-->

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: get_VUSBs

Overview:

Get the VUSBs field of the given USB_group.

Signature:

VUSB ref set get_VUSBs (session ref session_ref, USB_group ref self)
<!--NeedCopy-->

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: remove_from_other_config

Overview:

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.

Signature:

void remove_from_other_config (session ref session_ref, USB_group ref self, string key)
<!--NeedCopy-->

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: set_name_description

Overview:

Set the name/description field of the given USB_group.

Signature:

void set_name_description (session ref session_ref, USB_group ref self, string value)
<!--NeedCopy-->

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: set_name_label

Overview:

Set the name/label field of the given USB_group.

Signature:

void set_name_label (session ref session_ref, USB_group ref self, string value)
<!--NeedCopy-->

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: set_other_config

Overview:

Set the other_config field of the given USB_group.

Signature:

void set_other_config (session ref session_ref, USB_group ref self, (string -> string) map value)
<!--NeedCopy-->

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

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Class: USB_group

June 19, 2024

Contributed by:

X X

June 19, 2024

Contributed by:

X X

Was this helpful

Class: USB_group

Fields for class: USB_group

RPCs associated with class: USB_group

RPC name: add_to_other_config

RPC name: create

RPC name: destroy

RPC name: get_all

RPC name: get_all_records

RPC name: get_by_name_label

RPC name: get_by_uuid

RPC name: get_name_description

RPC name: get_name_label

RPC name: get_other_config

RPC name: get_PUSBs

RPC name: get_record

RPC name: get_uuid

RPC name: get_VUSBs

RPC name: remove_from_other_config

RPC name: set_name_description

RPC name: set_name_label

RPC name: set_other_config

In this article