com.xensource.xenapi

Class VUSB

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.VUSB

public class VUSB
extends XenAPIObject

Describes the vusb device First published in XenServer 7.3.

Nested Class Summary

Nested Classes

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

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 VUSB.
static VUSB	create(Connection c, VM VM, USBGroup USBGroup, java.util.Map<java.lang.String,java.lang.String> otherConfig) Create a new VUSB record in the database only First published in XenServer 7.3.
static Task	createAsync(Connection c, VM VM, USBGroup USBGroup, java.util.Map<java.lang.String,java.lang.String> otherConfig) Create a new VUSB record in the database only First published in XenServer 7.3.
void	destroy(Connection c) Removes a VUSB record from the database First published in XenServer 7.3.
Task	destroyAsync(Connection c) Removes a VUSB record from the database First published in XenServer 7.3.
boolean	equals(java.lang.Object obj) If obj is a VUSB, compares XenAPI references for equality.
static java.util.Set<VUSB>	getAll(Connection c) Return a list of all the VUSBs known to the system.
java.util.Set<Types.VusbOperations>	getAllowedOperations(Connection c) Get the allowed_operations field of the given VUSB.
static java.util.Map<VUSB,VUSB.Record>	getAllRecords(Connection c) Return a map of VUSB references to VUSB records for all VUSBs known to the system.
static VUSB	getByUuid(Connection c, java.lang.String uuid) Get a reference to the VUSB instance with the specified UUID.
java.lang.Boolean	getCurrentlyAttached(Connection c) Get the currently_attached field of the given VUSB.
java.util.Map<java.lang.String,Types.VusbOperations>	getCurrentOperations(Connection c) Get the current_operations field of the given VUSB.
java.util.Map<java.lang.String,java.lang.String>	getOtherConfig(Connection c) Get the other_config field of the given VUSB.
VUSB.Record	getRecord(Connection c) Get a record containing the current state of the given VUSB.
USBGroup	getUSBGroup(Connection c) Get the USB_group field of the given VUSB.
java.lang.String	getUuid(Connection c) Get the uuid field of the given VUSB.
VM	getVM(Connection c) Get the VM field of the given VUSB.
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 VUSB.
void	setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) Set the other_config field of the given VUSB.
java.lang.String	toWireString()
void	unplug(Connection c) Unplug the vusb device from the vm.
Task	unplugAsync(Connection c) Unplug the vusb device from the vm.

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 VUSB, 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 VUSB.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException

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

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

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

Get a reference to the VUSB 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 VUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllowedOperations

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

Get the allowed_operations field of the given VUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCurrentOperations

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

Get the current_operations field of the given VUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getVM

public VM getVM(Connection c)
         throws Types.BadServerResponse,
                Types.XenAPIException,
                org.apache.xmlrpc.XmlRpcException

Get the VM field of the given VUSB. 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 VUSB. 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 VUSB. First published in XenServer 7.3.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCurrentlyAttached

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

Get the currently_attached field of the given VUSB. 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 VUSB. 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 VUSB. 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 VUSB. 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

createAsync

public static Task createAsync(Connection c,
               VM VM,
               USBGroup USBGroup,
               java.util.Map<java.lang.String,java.lang.String> otherConfig)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException

Create a new VUSB record in the database only First published in XenServer 7.3.

Parameters:

VM - The VM

USBGroup -

otherConfig -

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

create

public static VUSB create(Connection c,
          VM VM,
          USBGroup USBGroup,
          java.util.Map<java.lang.String,java.lang.String> otherConfig)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Create a new VUSB record in the database only First published in XenServer 7.3.

Parameters:

VM - The VM

USBGroup -

otherConfig -

Returns:

The ref of the newly created VUSB record.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

unplugAsync

public Task unplugAsync(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException

Unplug the vusb device from the vm. First published in XenServer 7.3.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

unplug

public void unplug(Connection c)
            throws Types.BadServerResponse,
                   Types.XenAPIException,
                   org.apache.xmlrpc.XmlRpcException

Unplug the vusb device from the vm. First published in XenServer 7.3.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException

Removes a VUSB record from the database First published in XenServer 7.3.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Removes a VUSB record from the database First published in XenServer 7.3.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

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

Return a list of all the VUSBs 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<VUSB,VUSB.Record> getAllRecords(Connection c)
                                                     throws Types.BadServerResponse,
                                                            Types.XenAPIException,
                                                            org.apache.xmlrpc.XmlRpcException

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

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException