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.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) Add the given key-value pair to the other_config field of the given PUSB.
boolean	equals(java.lang.Object obj) If obj is a PUSB, compares XenAPI references for equality.
static java.util.Set<PUSB>	getAll(Connection c) Return a list of all the PUSBs known to the system.
static java.util.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, java.lang.String uuid) Get a reference to the PUSB instance with the specified UUID.
java.lang.String	getDescription(Connection c) Get the description field of the given PUSB.
Host	getHost(Connection c) Get the host field of the given PUSB.
java.util.Map<java.lang.String,java.lang.String>	getOtherConfig(Connection c) Get the other_config field of the given PUSB.
java.lang.Boolean	getPassthroughEnabled(Connection c) Get the passthrough_enabled field of the given PUSB.
java.lang.String	getPath(Connection c) Get the path field of the given PUSB.
java.lang.String	getProductDesc(Connection c) Get the product_desc field of the given PUSB.
java.lang.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.
java.lang.String	getSerial(Connection c) Get the serial field of the given PUSB.
USBGroup	getUSBGroup(Connection c) Get the USB_group field of the given PUSB.
java.lang.String	getUuid(Connection c) Get the uuid field of the given PUSB.
java.lang.String	getVendorDesc(Connection c) Get the vendor_desc field of the given PUSB.
java.lang.String	getVendorId(Connection c) Get the vendor_id field of the given PUSB.
java.lang.String	getVersion(Connection c) Get the version field of the given PUSB.
int	hashCode()
void	removeFromOtherConfig(Connection c, java.lang.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) First published in XenServer 7.3.
static Task	scanAsync(Connection c, Host host) First published in XenServer 7.3.
void	setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) Set the other_config field of the given PUSB.
void	setPassthroughEnabled(Connection c, java.lang.Boolean value) First published in XenServer 7.3.
Task	setPassthroughEnabledAsync(Connection c, java.lang.Boolean value) First published in XenServer 7.3.
java.lang.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 Detail

ref

protected final java.lang.String ref

The XenAPI reference (OpaqueRef) to this object.

Method Detail

toWireString

public java.lang.String toWireString()

Specified by:

toWireString in class XenAPIObject

Returns:

The XenAPI reference (OpaqueRef) to this object.

equals

public boolean equals(java.lang.Object obj)

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

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

getRecord

public PUSB.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given PUSB. First published in XenServer 7.3.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static PUSB getByUuid(Connection c,
             java.lang.String uuid)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Get a reference to the PUSB instance with the specified UUID. First published in XenServer 7.3.

Parameters:

uuid - UUID of object to return

Returns:

reference to the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUuid

public java.lang.String getUuid(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the uuid field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getUSBGroup

public USBGroup getUSBGroup(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Get the USB_group field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getHost

public Host getHost(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Get the host field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPath

public java.lang.String getPath(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get the path field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVendorId

public java.lang.String getVendorId(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Get the vendor_id field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVendorDesc

public java.lang.String getVendorDesc(Connection c)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException

Get the vendor_desc field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getProductId

public java.lang.String getProductId(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException

Get the product_id field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getProductDesc

public java.lang.String getProductDesc(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException

Get the product_desc field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getSerial

public java.lang.String getSerial(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

Get the serial field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVersion

public java.lang.String getVersion(Connection c)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Get the version field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getDescription

public java.lang.String getDescription(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException

Get the description field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPassthroughEnabled

public java.lang.Boolean getPassthroughEnabled(Connection c)
                                        throws Types.BadServerResponse,
                                               Types.XenAPIException,
                                               org.apache.xmlrpc.XmlRpcException

Get the passthrough_enabled field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getOtherConfig

public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c)
                                                                throws Types.BadServerResponse,
                                                                       Types.XenAPIException,
                                                                       org.apache.xmlrpc.XmlRpcException

Get the other_config field of the given PUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setOtherConfig

public void setOtherConfig(Connection c,
                  java.util.Map<java.lang.String,java.lang.String> otherConfig)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException

Set the other_config field of the given PUSB. First published in XenServer 7.3.

Parameters:

otherConfig - New value to set

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

addToOtherConfig

public void addToOtherConfig(Connection c,
                    java.lang.String key,
                    java.lang.String value)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

Add the given key-value pair to the other_config field of the given PUSB. First published in XenServer 7.3.

Parameters:

key - Key to add

value - Value to add

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

removeFromOtherConfig

public void removeFromOtherConfig(Connection c,
                         java.lang.String key)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

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. First published in XenServer 7.3.

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

scanAsync

public static Task scanAsync(Connection c,
             Host host)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.3.

Parameters:

host - The host

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

scan

public static void scan(Connection c,
        Host host)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.3.

Parameters:

host - The host

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setPassthroughEnabledAsync

public Task setPassthroughEnabledAsync(Connection c,
                              java.lang.Boolean value)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.3.

Parameters:

value - passthrough is enabled when true and disabled with false

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

setPassthroughEnabled

public void setPassthroughEnabled(Connection c,
                         java.lang.Boolean value)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException

First published in XenServer 7.3.

Parameters:

value - passthrough is enabled when true and disabled with false

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<PUSB> getAll(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException

Return a list of all the PUSBs known to the system. First published in XenServer 7.3.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<PUSB,PUSB.Record> getAllRecords(Connection c)
                                                     throws Types.BadServerResponse,
                                                            Types.XenAPIException,
                                                            org.apache.xmlrpc.XmlRpcException

Return a map of PUSB references to PUSB records for all PUSBs known to the system. First published in XenServer 7.3.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException