View Source XenAPI.PUSB (XenAPI v0.3.0)

A physical USB device

Link to this section Summary

Functions

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

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

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

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

Return a map of PUSB references to PUSB records for all PUSBs known to the system.

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

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

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

Get the description field of the given PUSB.

Get the description field of the given PUSB. (Raise error on XMLRPC failure)

Get the host field of the given PUSB.

Get the host field of the given PUSB. (Raise error on XMLRPC failure)

Get the other_config field of the given PUSB.

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

Get the passthrough_enabled field of the given PUSB.

Get the passthrough_enabled field of the given PUSB. (Raise error on XMLRPC failure)

Get the path field of the given PUSB.

Get the path field of the given PUSB. (Raise error on XMLRPC failure)

Get the product_desc field of the given PUSB.

Get the product_desc field of the given PUSB. (Raise error on XMLRPC failure)

Get the product_id field of the given PUSB.

Get the product_id field of the given PUSB. (Raise error on XMLRPC failure)

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

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

Get the serial field of the given PUSB.

Get the serial field of the given PUSB. (Raise error on XMLRPC failure)

Get the USB_group field of the given PUSB.

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

Get the uuid field of the given PUSB.

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

Get the vendor_desc field of the given PUSB.

Get the vendor_desc field of the given PUSB. (Raise error on XMLRPC failure)

Get the vendor_id field of the given PUSB.

Get the vendor_id field of the given PUSB. (Raise error on XMLRPC failure)

Get the version field of the given PUSB.

Get the version field of the given PUSB. (Raise error on XMLRPC failure)

Remove the given key and its corresponding value from the other_config field of the given PUSB. 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 PUSB. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

(Raise error on XMLRPC failure)

Set the other_config field of the given PUSB.

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

Link to this section Functions

Link to this function

add_to_other_config(xen_session, pusb_ref, key, value)

View Source

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

Link to this function

add_to_other_config!(xen_session, pusb_ref, key, value)

View Source

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

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

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

Link to this function

get_all_records(xen_session)

View Source

Return a map of PUSB references to PUSB records for all PUSBs known to the system.

Link to this function

get_all_records!(xen_session)

View Source

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

Link to this function

get_by_uuid(xen_session, uuid)

View Source

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

Link to this function

get_by_uuid!(xen_session, uuid)

View Source

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

Link to this function

get_description(xen_session, pusb_ref)

View Source

Get the description field of the given PUSB.

Link to this function

get_description!(xen_session, pusb_ref)

View Source

Get the description field of the given PUSB. (Raise error on XMLRPC failure)

Link to this function

get_host(xen_session, pusb_ref)

View Source

Get the host field of the given PUSB.

Link to this function

get_host!(xen_session, pusb_ref)

View Source

Get the host field of the given PUSB. (Raise error on XMLRPC failure)

Link to this function

get_other_config(xen_session, pusb_ref)

View Source

Get the other_config field of the given PUSB.

Link to this function

get_other_config!(xen_session, pusb_ref)

View Source

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

Link to this function

get_passthrough_enabled(xen_session, pusb_ref)

View Source

Get the passthrough_enabled field of the given PUSB.

Link to this function

get_passthrough_enabled!(xen_session, pusb_ref)

View Source

Get the passthrough_enabled field of the given PUSB. (Raise error on XMLRPC failure)

Link to this function

get_path(xen_session, pusb_ref)

View Source

Get the path field of the given PUSB.

Link to this function

get_path!(xen_session, pusb_ref)

View Source

Get the path field of the given PUSB. (Raise error on XMLRPC failure)

Link to this function

get_product_desc(xen_session, pusb_ref)

View Source

Get the product_desc field of the given PUSB.

Link to this function

get_product_desc!(xen_session, pusb_ref)

View Source

Get the product_desc field of the given PUSB. (Raise error on XMLRPC failure)

Link to this function

get_product_id(xen_session, pusb_ref)

View Source

Get the product_id field of the given PUSB.

Link to this function

get_product_id!(xen_session, pusb_ref)

View Source

Get the product_id field of the given PUSB. (Raise error on XMLRPC failure)

Link to this function

get_record(xen_session, pusb_ref)

View Source

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

Link to this function

get_record!(xen_session, pusb_ref)

View Source

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

Link to this function

get_serial(xen_session, pusb_ref)

View Source

Get the serial field of the given PUSB.

Link to this function

get_serial!(xen_session, pusb_ref)

View Source

Get the serial field of the given PUSB. (Raise error on XMLRPC failure)

Link to this function

get_USB_group(xen_session, pusb_ref)

View Source

Get the USB_group field of the given PUSB.

Link to this function

get_USB_group!(xen_session, pusb_ref)

View Source

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

Link to this function

get_uuid(xen_session, pusb_ref)

View Source

Get the uuid field of the given PUSB.

Link to this function

get_uuid!(xen_session, pusb_ref)

View Source

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

Link to this function

get_vendor_desc(xen_session, pusb_ref)

View Source

Get the vendor_desc field of the given PUSB.

Link to this function

get_vendor_desc!(xen_session, pusb_ref)

View Source

Get the vendor_desc field of the given PUSB. (Raise error on XMLRPC failure)

Link to this function

get_vendor_id(xen_session, pusb_ref)

View Source

Get the vendor_id field of the given PUSB.

Link to this function

get_vendor_id!(xen_session, pusb_ref)

View Source

Get the vendor_id field of the given PUSB. (Raise error on XMLRPC failure)

Link to this function

get_version(xen_session, pusb_ref)

View Source

Get the version field of the given PUSB.

Link to this function

get_version!(xen_session, pusb_ref)

View Source

Get the version field of the given PUSB. (Raise error on XMLRPC failure)

Link to this function

remove_from_other_config(xen_session, pusb_ref, key)

View Source

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

Link to this function

remove_from_other_config!(xen_session, pusb_ref, key)

View Source

Remove the given key and its corresponding value from the other_config field of the given PUSB. If the key is not in that Map, then do nothing. (Raise error on XMLRPC failure)

Link to this function

scan!(xen_session, host)

View Source

(Raise error on XMLRPC failure)

Link to this function

set_other_config(xen_session, pusb_ref, value)

View Source

Set the other_config field of the given PUSB.

Link to this function

set_other_config!(xen_session, pusb_ref, value)

View Source

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

Link to this function

set_passthrough_enabled(xen_session, pusb_ref, value)

View Source
Link to this function

set_passthrough_enabled!(xen_session, pusb_ref, value)

View Source

(Raise error on XMLRPC failure)