View Source XenAPI.USBGroup (XenAPI v0.3.1)

A group of compatible USBs across the resource pool

Link to this section Summary

Functions

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

Add the given key-value pair to the other_config field of the given USB_group. (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

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

Return a list of all the USB_groups known to the system. (Raise error on XMLRPC failure)

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

Return a map of USB_group references to USB_group records for all USB_groups known to the system. (Raise error on XMLRPC failure)

Get all the USB_group instances with the given label.

Get all the USB_group instances with the given label. (Raise error on XMLRPC failure)

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

Get a reference to the USB_group instance with the specified UUID. (Raise error on XMLRPC failure)

Get the name/description field of the given USB_group.

Get the name/description field of the given USB_group. (Raise error on XMLRPC failure)

Get the name/label field of the given USB_group.

Get the name/label field of the given USB_group. (Raise error on XMLRPC failure)

Get the other_config field of the given USB_group.

Get the other_config field of the given USB_group. (Raise error on XMLRPC failure)

Get the PUSBs field of the given USB_group.

Get the PUSBs field of the given USB_group. (Raise error on XMLRPC failure)

Get a record containing the current state of the given USB_group. Returns XenAPI.USBGroup struct.

Get a record containing the current state of the given USB_group. Returns XenAPI.USBGroup struct. (Raise error on XMLRPC failure)

Get the uuid field of the given USB_group.

Get the uuid field of the given USB_group. (Raise error on XMLRPC failure)

Get the VUSBs field of the given USB_group.

Get the VUSBs field of the given USB_group. (Raise error on XMLRPC failure)

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.

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. (Raise error on XMLRPC failure)

Set the name/description field of the given USB_group.

Set the name/description field of the given USB_group. (Raise error on XMLRPC failure)

Set the name/label field of the given USB_group.

Set the name/label field of the given USB_group. (Raise error on XMLRPC failure)

Set the other_config field of the given USB_group.

Set the other_config field of the given USB_group. (Raise error on XMLRPC failure)

Link to this section Functions

Link to this function

add_to_other_config(xen_session, usb_group_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, usb_group_ref, key, value)

View Source

Add the given key-value pair to the other_config field of the given USB_group. (Raise error on XMLRPC failure)

Link to this function

create(xen_session, name_label, name_description, other_config)

View Source
Link to this function

create!(xen_session, name_label, name_description, other_config)

View Source

(Raise error on XMLRPC failure)

Link to this function

destroy(xen_session, usb_group_ref)

View Source
Link to this function

destroy!(xen_session, usb_group_ref)

View Source

(Raise error on XMLRPC failure)

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

Return a list of all the USB_groups known to the system. (Raise error on XMLRPC failure)

Link to this function

get_all_records(xen_session)

View Source

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

Link to this function

get_all_records!(xen_session)

View Source

Return a map of USB_group references to USB_group records for all USB_groups known to the system. (Raise error on XMLRPC failure)

Link to this function

get_by_name_label(xen_session, label)

View Source

Get all the USB_group instances with the given label.

Link to this function

get_by_name_label!(xen_session, label)

View Source

Get all the USB_group instances with the given label. (Raise error on XMLRPC failure)

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

Get a reference to the USB_group instance with the specified UUID. (Raise error on XMLRPC failure)

Link to this function

get_name_description(xen_session, usb_group_ref)

View Source

Get the name/description field of the given USB_group.

Link to this function

get_name_description!(xen_session, usb_group_ref)

View Source

Get the name/description field of the given USB_group. (Raise error on XMLRPC failure)

Link to this function

get_name_label(xen_session, usb_group_ref)

View Source

Get the name/label field of the given USB_group.

Link to this function

get_name_label!(xen_session, usb_group_ref)

View Source

Get the name/label field of the given USB_group. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, usb_group_ref)

View Source

Get the other_config field of the given USB_group.

Link to this function

get_other_config!(xen_session, usb_group_ref)

View Source

Get the other_config field of the given USB_group. (Raise error on XMLRPC failure)

Link to this function

get_PUSBs(xen_session, usb_group_ref)

View Source

Get the PUSBs field of the given USB_group.

Link to this function

get_PUSBs!(xen_session, usb_group_ref)

View Source

Get the PUSBs field of the given USB_group. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, usb_group_ref)

View Source

Get a record containing the current state of the given USB_group. Returns XenAPI.USBGroup struct.

Link to this function

get_record!(xen_session, usb_group_ref)

View Source

Get a record containing the current state of the given USB_group. Returns XenAPI.USBGroup struct. (Raise error on XMLRPC failure)

Link to this function

get_uuid(xen_session, usb_group_ref)

View Source

Get the uuid field of the given USB_group.

Link to this function

get_uuid!(xen_session, usb_group_ref)

View Source

Get the uuid field of the given USB_group. (Raise error on XMLRPC failure)

Link to this function

get_VUSBs(xen_session, usb_group_ref)

View Source

Get the VUSBs field of the given USB_group.

Link to this function

get_VUSBs!(xen_session, usb_group_ref)

View Source

Get the VUSBs field of the given USB_group. (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, usb_group_ref, key)

View Source

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.

Link to this function

remove_from_other_config!(xen_session, usb_group_ref, key)

View Source

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. (Raise error on XMLRPC failure)

Link to this function

set_name_description(xen_session, usb_group_ref, value)

View Source

Set the name/description field of the given USB_group.

Link to this function

set_name_description!(xen_session, usb_group_ref, value)

View Source

Set the name/description field of the given USB_group. (Raise error on XMLRPC failure)

Link to this function

set_name_label(xen_session, usb_group_ref, value)

View Source

Set the name/label field of the given USB_group.

Link to this function

set_name_label!(xen_session, usb_group_ref, value)

View Source

Set the name/label field of the given USB_group. (Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, usb_group_ref, value)

View Source

Set the other_config field of the given USB_group.

Link to this function

set_other_config!(xen_session, usb_group_ref, value)

View Source

Set the other_config field of the given USB_group. (Raise error on XMLRPC failure)