Package com.xensource.xenapi

Class PUSB

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.PUSB

public class PUSB
extends XenAPIObject

A physical USB device First published in XenServer 7.3.

Author:

Cloud Software Group, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PUSB.Record	Represents all the fields in a PUSB

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	ref	The XenAPI reference (OpaqueRef) to this object.

Method Summary

Modifier and Type	Method	Description
void	addToOtherConfig(Connection c, String key, String value)	Add the given key-value pair to the other_config field of the given PUSB.
boolean	equals(Object obj)	If obj is a PUSB, compares XenAPI references for equality.
static Set<PUSB>	getAll(Connection c)	Return a list of all the PUSBs known to the system.
static Map<PUSB,PUSB.Record>	getAllRecords(Connection c)	Return a map of PUSB references to PUSB records for all PUSBs known to the system.
static PUSB	getByUuid(Connection c, String uuid)	Get a reference to the PUSB instance with the specified UUID.
String	getDescription(Connection c)	Get the description field of the given PUSB.
Host	getHost(Connection c)	Get the host field of the given PUSB.
Map<String,String>	getOtherConfig(Connection c)	Get the other_config field of the given PUSB.
Boolean	getPassthroughEnabled(Connection c)	Get the passthrough_enabled field of the given PUSB.
String	getPath(Connection c)	Get the path field of the given PUSB.
String	getProductDesc(Connection c)	Get the product_desc field of the given PUSB.
String	getProductId(Connection c)	Get the product_id field of the given PUSB.
PUSB.Record	getRecord(Connection c)	Get a record containing the current state of the given PUSB.
String	getSerial(Connection c)	Get the serial field of the given PUSB.
Double	getSpeed(Connection c)	Get the speed field of the given PUSB.
USBGroup	getUSBGroup(Connection c)	Get the USB_group field of the given PUSB.
String	getUuid(Connection c)	Get the uuid field of the given PUSB.
String	getVendorDesc(Connection c)	Get the vendor_desc field of the given PUSB.
String	getVendorId(Connection c)	Get the vendor_id field of the given PUSB.
String	getVersion(Connection c)	Get the version field of the given PUSB.
int	hashCode()
void	removeFromOtherConfig(Connection c, String key)	Remove the given key and its corresponding value from the other_config field of the given PUSB.
static void	scan(Connection c, Host host)	Minimum allowed role: pool-admin First published in XenServer 7.3.
static Task	scanAsync(Connection c, Host host)	Minimum allowed role: pool-admin First published in XenServer 7.3.
void	setOtherConfig(Connection c, Map<String,String> otherConfig)	Set the other_config field of the given PUSB.
void	setPassthroughEnabled(Connection c, Boolean value)	Minimum allowed role: pool-admin First published in XenServer 7.3.
Task	setPassthroughEnabledAsync(Connection c, Boolean value)	Minimum allowed role: pool-admin First published in XenServer 7.3.
String	toWireString()

Methods inherited from class com.xensource.xenapi.XenAPIObject

isNull

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ref

protected final String ref

The XenAPI reference (OpaqueRef) to this object.

Method Details

toWireString

public String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(Object obj)

If obj is a PUSB, compares XenAPI references for equality.

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getRecord

public PUSB.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a record containing the current state of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

all fields from the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getByUuid

public static PUSB getByUuid(Connection c,
 String uuid)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get a reference to the PUSB instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUuid

public String getUuid(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the uuid field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getUSBGroup

public USBGroup getUSBGroup(Connection c)
                     throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the USB_group field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getHost

public Host getHost(Connection c)
             throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the host field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getPath

public String getPath(Connection c)
               throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the path field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getVendorId

public String getVendorId(Connection c)
                   throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the vendor_id field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getVendorDesc

public String getVendorDesc(Connection c)
                     throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the vendor_desc field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getProductId

public String getProductId(Connection c)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the product_id field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getProductDesc

public String getProductDesc(Connection c)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the product_desc field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getSerial

public String getSerial(Connection c)
                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the serial field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getVersion

public String getVersion(Connection c)
                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the version field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getDescription

public String getDescription(Connection c)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the description field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getPassthroughEnabled

public Boolean getPassthroughEnabled(Connection c)
                              throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the passthrough_enabled field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getOtherConfig

public Map<String,String> getOtherConfig(Connection c)
                                  throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the other_config field of the given PUSB. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getSpeed

public Double getSpeed(Connection c)
                throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Get the speed field of the given PUSB. Minimum allowed role: read-only First published in Citrix Hypervisor 8.2.

Parameters:

c - The connection the call is made on

Returns:

value of the field

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setOtherConfig

public void setOtherConfig(Connection c,
 Map<String,String> otherConfig)
                    throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Set the other_config field of the given PUSB. Minimum allowed role: pool-admin First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

otherConfig - New value to set

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

addToOtherConfig

public void addToOtherConfig(Connection c,
 String key,
 String value)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Add the given key-value pair to the other_config field of the given PUSB. Minimum allowed role: pool-admin First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
 String key)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

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. Minimum allowed role: pool-admin First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

key - Key to remove

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

scan

public static void scan(Connection c,
 Host host)
                 throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: pool-admin First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

host - The host

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

scanAsync

public static Task scanAsync(Connection c,
 Host host)
                      throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: pool-admin First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

host - The host

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setPassthroughEnabled

public void setPassthroughEnabled(Connection c,
 Boolean value)
                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: pool-admin First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

value - passthrough is enabled when true and disabled with false

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

setPassthroughEnabledAsync

public Task setPassthroughEnabledAsync(Connection c,
 Boolean value)
                                throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Minimum allowed role: pool-admin First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

value - passthrough is enabled when true and disabled with false

Returns:

Task

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAll

public static Set<PUSB> getAll(Connection c)
                        throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a list of all the PUSBs known to the system. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

references to all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.

getAllRecords

public static Map<PUSB,PUSB.Record> getAllRecords(Connection c)
                                           throws Types.BadServerResponse,
Types.XenAPIException,
IOException

Return a map of PUSB references to PUSB records for all PUSBs known to the system. Minimum allowed role: read-only First published in XenServer 7.3.

Parameters:

c - The connection the call is made on

Returns:

records of all objects

Throws:

Types.BadServerResponse - Thrown if the response from the server contains an invalid status.

Types.XenAPIException - if the call failed.

IOException - if an error occurs during a send or receive. This includes cases where a payload is invalid JSON.