Package com.xensource.xenapi
Class VUSB
java.lang.Object
com.xensource.xenapi.XenAPIObject
com.xensource.xenapi.VUSB
Describes the vusb device
First published in XenServer 7.3.
- Author:
- Cloud Software Group, Inc.
-
Nested Class Summary
Nested Classes -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoid
addToOtherConfig
(Connection c, String key, String value) Add the given key-value pair to the other_config field of the given VUSB.static VUSB
Create a new VUSB record in the database only Minimum allowed role: pool-admin First published in XenServer 7.3.static Task
createAsync
(Connection c, VM VM, USBGroup USBGroup, Map<String, String> otherConfig) Create a new VUSB record in the database only Minimum allowed role: pool-admin First published in XenServer 7.3.void
Removes a VUSB record from the database Minimum allowed role: pool-admin First published in XenServer 7.3.Removes a VUSB record from the database Minimum allowed role: pool-admin First published in XenServer 7.3.boolean
If obj is a VUSB, compares XenAPI references for equality.getAll
(Connection c) Return a list of all the VUSBs known to the system.Get the allowed_operations field of the given VUSB.static Map<VUSB,
VUSB.Record> Return a map of VUSB references to VUSB records for all VUSBs known to the system.static VUSB
getByUuid
(Connection c, String uuid) Get a reference to the VUSB instance with the specified UUID.Get the currently_attached field of the given VUSB.Get the current_operations field of the given VUSB.Get the other_config field of the given VUSB.Get a record containing the current state of the given VUSB.Get the USB_group field of the given VUSB.Get the uuid field of the given VUSB.getVM
(Connection c) Get the VM field of the given VUSB.int
hashCode()
void
removeFromOtherConfig
(Connection c, String key) Remove the given key and its corresponding value from the other_config field of the given VUSB.void
setOtherConfig
(Connection c, Map<String, String> otherConfig) Set the other_config field of the given VUSB.void
unplug
(Connection c) Unplug the vusb device from the vm.Unplug the vusb device from the vm.Methods inherited from class com.xensource.xenapi.XenAPIObject
isNull
-
Field Details
-
ref
The XenAPI reference (OpaqueRef) to this object.
-
-
Method Details
-
toWireString
- Specified by:
toWireString
in classXenAPIObject
- Returns:
- The XenAPI reference (OpaqueRef) to this object.
-
equals
If obj is a VUSB, compares XenAPI references for equality. -
hashCode
public int hashCode() -
getRecord
public VUSB.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a record containing the current state of the given VUSB. 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 VUSB getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, IOException Get a reference to the VUSB instance with the specified UUID. Minimum allowed role: read-only First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onuuid
- 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 VUSB. 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.
-
getAllowedOperations
public Set<Types.VusbOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the allowed_operations field of the given VUSB. 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.
-
getCurrentOperations
public Map<String,Types.VusbOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the current_operations field of the given VUSB. 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.
-
getVM
Get the VM field of the given VUSB. 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 VUSB. 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 VUSB. 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.
-
getCurrentlyAttached
public Boolean getCurrentlyAttached(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Get the currently_attached field of the given VUSB. 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.
-
setOtherConfig
public void setOtherConfig(Connection c, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionSet the other_config field of the given VUSB. Minimum allowed role: pool-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onotherConfig
- 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 VUSB. Minimum allowed role: pool-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onkey
- Key to addvalue
- 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 VUSB. 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 onkey
- 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.
-
create
public static VUSB create(Connection c, VM VM, USBGroup USBGroup, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionCreate a new VUSB record in the database only Minimum allowed role: pool-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onVM
- The VMUSBGroup
- No descriptionotherConfig
- No description- Returns:
- The ref of the newly created VUSB record.
- 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.
-
createAsync
public static Task createAsync(Connection c, VM VM, USBGroup USBGroup, Map<String, String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, IOExceptionCreate a new VUSB record in the database only Minimum allowed role: pool-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made onVM
- The VMUSBGroup
- No descriptionotherConfig
- No description- 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.
-
unplug
Unplug the vusb device from the vm. Minimum allowed role: pool-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- 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.
-
unplugAsync
public Task unplugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Unplug the vusb device from the vm. Minimum allowed role: pool-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- 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.
-
destroy
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Removes a VUSB record from the database Minimum allowed role: pool-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- 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.
-
destroyAsync
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Removes a VUSB record from the database Minimum allowed role: pool-admin First published in XenServer 7.3.- Parameters:
c
- The connection the call is made on- 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<VUSB> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a list of all the VUSBs 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<VUSB,VUSB.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, IOException Return a map of VUSB references to VUSB records for all VUSBs 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.
-