public class VBD extends XenAPIObject
Modifier and Type | Class and Description |
---|---|
static class |
VBD.Record
Represents all the fields in a VBD
|
Modifier and Type | Field and Description |
---|---|
protected java.lang.String |
ref
The XenAPI reference to this object.
|
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 VBD.
|
void |
addToQosAlgorithmParams(Connection c,
java.lang.String key,
java.lang.String value)
Add the given key-value pair to the qos/algorithm_params field of the given VBD.
|
void |
assertAttachable(Connection c)
Throws an error if this VBD could not be attached to this VM if the VM were running.
|
Task |
assertAttachableAsync(Connection c)
Throws an error if this VBD could not be attached to this VM if the VM were running.
|
static VBD |
create(Connection c,
VBD.Record record)
Create a new VBD instance, and return its handle.
|
static Task |
createAsync(Connection c,
VBD.Record record)
Create a new VBD instance, and return its handle.
|
void |
destroy(Connection c)
Destroy the specified VBD instance.
|
Task |
destroyAsync(Connection c)
Destroy the specified VBD instance.
|
void |
eject(Connection c)
Remove the media from the device and leave it empty
|
Task |
ejectAsync(Connection c)
Remove the media from the device and leave it empty
|
boolean |
equals(java.lang.Object obj)
If obj is a VBD, compares XenAPI references for equality.
|
static java.util.Set<VBD> |
getAll(Connection c)
Return a list of all the VBDs known to the system.
|
java.util.Set<Types.VbdOperations> |
getAllowedOperations(Connection c)
Get the allowed_operations field of the given VBD.
|
static java.util.Map<VBD,VBD.Record> |
getAllRecords(Connection c)
Return a map of VBD references to VBD records for all VBDs known to the system.
|
java.lang.Boolean |
getBootable(Connection c)
Get the bootable field of the given VBD.
|
static VBD |
getByUuid(Connection c,
java.lang.String uuid)
Get a reference to the VBD instance with the specified UUID.
|
java.lang.Boolean |
getCurrentlyAttached(Connection c)
Get the currently_attached field of the given VBD.
|
java.util.Map<java.lang.String,Types.VbdOperations> |
getCurrentOperations(Connection c)
Get the current_operations field of the given VBD.
|
java.lang.String |
getDevice(Connection c)
Get the device field of the given VBD.
|
java.lang.Boolean |
getEmpty(Connection c)
Get the empty field of the given VBD.
|
VBDMetrics |
getMetrics(Connection c)
Get the metrics field of the given VBD.
|
Types.VbdMode |
getMode(Connection c)
Get the mode field of the given VBD.
|
java.util.Map<java.lang.String,java.lang.String> |
getOtherConfig(Connection c)
Get the other_config field of the given VBD.
|
java.util.Map<java.lang.String,java.lang.String> |
getQosAlgorithmParams(Connection c)
Get the qos/algorithm_params field of the given VBD.
|
java.lang.String |
getQosAlgorithmType(Connection c)
Get the qos/algorithm_type field of the given VBD.
|
java.util.Set<java.lang.String> |
getQosSupportedAlgorithms(Connection c)
Get the qos/supported_algorithms field of the given VBD.
|
VBD.Record |
getRecord(Connection c)
Get a record containing the current state of the given VBD.
|
java.util.Map<java.lang.String,java.lang.String> |
getRuntimeProperties(Connection c)
Get the runtime_properties field of the given VBD.
|
java.lang.Long |
getStatusCode(Connection c)
Get the status_code field of the given VBD.
|
java.lang.String |
getStatusDetail(Connection c)
Get the status_detail field of the given VBD.
|
java.lang.Boolean |
getStorageLock(Connection c)
Get the storage_lock field of the given VBD.
|
Types.VbdType |
getType(Connection c)
Get the type field of the given VBD.
|
java.lang.Boolean |
getUnpluggable(Connection c)
Get the unpluggable field of the given VBD.
|
java.lang.String |
getUserdevice(Connection c)
Get the userdevice field of the given VBD.
|
java.lang.String |
getUuid(Connection c)
Get the uuid field of the given VBD.
|
VDI |
getVDI(Connection c)
Get the VDI field of the given VBD.
|
VM |
getVM(Connection c)
Get the VM field of the given VBD.
|
int |
hashCode() |
void |
insert(Connection c,
VDI vdi)
Insert new media into the device
|
Task |
insertAsync(Connection c,
VDI vdi)
Insert new media into the device
|
void |
plug(Connection c)
Hotplug the specified VBD, dynamically attaching it to the running VM
|
Task |
plugAsync(Connection c)
Hotplug the specified VBD, dynamically attaching it to the running VM
|
void |
removeFromOtherConfig(Connection c,
java.lang.String key)
Remove the given key and its corresponding value from the other_config field of the given VBD.
|
void |
removeFromQosAlgorithmParams(Connection c,
java.lang.String key)
Remove the given key and its corresponding value from the qos/algorithm_params field of the given VBD.
|
void |
setBootable(Connection c,
java.lang.Boolean bootable)
Set the bootable field of the given VBD.
|
void |
setMode(Connection c,
Types.VbdMode mode)
Set the mode field of the given VBD.
|
void |
setOtherConfig(Connection c,
java.util.Map<java.lang.String,java.lang.String> otherConfig)
Set the other_config field of the given VBD.
|
void |
setQosAlgorithmParams(Connection c,
java.util.Map<java.lang.String,java.lang.String> algorithmParams)
Set the qos/algorithm_params field of the given VBD.
|
void |
setQosAlgorithmType(Connection c,
java.lang.String algorithmType)
Set the qos/algorithm_type field of the given VBD.
|
void |
setType(Connection c,
Types.VbdType type)
Set the type field of the given VBD.
|
void |
setUnpluggable(Connection c,
java.lang.Boolean unpluggable)
Set the unpluggable field of the given VBD.
|
void |
setUserdevice(Connection c,
java.lang.String userdevice)
Set the userdevice field of the given VBD.
|
java.lang.String |
toWireString() |
void |
unplug(Connection c)
Hot-unplug the specified VBD, dynamically unattaching it from the running VM
|
Task |
unplugAsync(Connection c)
Hot-unplug the specified VBD, dynamically unattaching it from the running VM
|
void |
unplugForce(Connection c)
Forcibly unplug the specified VBD
|
Task |
unplugForceAsync(Connection c)
Forcibly unplug the specified VBD
|
public java.lang.String toWireString()
toWireString
in class XenAPIObject
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public VBD.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static VBD getByUuid(Connection c, java.lang.String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
uuid
- UUID of object to returnTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Task createAsync(Connection c, VBD.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor argumentsTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static VBD create(Connection c, VBD.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor argumentsTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task destroyAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void destroy(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Set<Types.VbdOperations> getAllowedOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,Types.VbdOperations> getCurrentOperations(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public VM getVM(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public VDI getVDI(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getDevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getUserdevice(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Boolean getBootable(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Types.VbdMode getMode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Types.VbdType getType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Boolean getUnpluggable(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Boolean getStorageLock(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Boolean getEmpty(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Boolean getCurrentlyAttached(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.Long getStatusCode(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getStatusDetail(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,java.lang.String> getRuntimeProperties(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.lang.String getQosAlgorithmType(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Map<java.lang.String,java.lang.String> getQosAlgorithmParams(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public java.util.Set<java.lang.String> getQosSupportedAlgorithms(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public VBDMetrics getMetrics(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setUserdevice(Connection c, java.lang.String userdevice) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
userdevice
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setBootable(Connection c, java.lang.Boolean bootable) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
bootable
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setMode(Connection c, Types.VbdMode mode) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
mode
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setType(Connection c, Types.VbdType type) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
type
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setUnpluggable(Connection c, java.lang.Boolean unpluggable) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
unpluggable
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
otherConfig
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to addvalue
- Value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromOtherConfig(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setQosAlgorithmType(Connection c, java.lang.String algorithmType) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
algorithmType
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setQosAlgorithmParams(Connection c, java.util.Map<java.lang.String,java.lang.String> algorithmParams) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
algorithmParams
- New value to setTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToQosAlgorithmParams(Connection c, java.lang.String key, java.lang.String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to addvalue
- Value to addTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromQosAlgorithmParams(Connection c, java.lang.String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to removeTypes.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task ejectAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VbdNotRemovableMedia, Types.VbdIsEmpty
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VbdNotRemovableMedia
Types.VbdIsEmpty
public void eject(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VbdNotRemovableMedia, Types.VbdIsEmpty
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VbdNotRemovableMedia
Types.VbdIsEmpty
public Task insertAsync(Connection c, VDI vdi) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VbdNotRemovableMedia, Types.VbdNotEmpty
vdi
- The new VDI to 'insert'Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VbdNotRemovableMedia
Types.VbdNotEmpty
public void insert(Connection c, VDI vdi) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.VbdNotRemovableMedia, Types.VbdNotEmpty
vdi
- The new VDI to 'insert'Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VbdNotRemovableMedia
Types.VbdNotEmpty
public Task plugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void plug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task unplugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.DeviceDetachRejected, Types.DeviceAlreadyDetached
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.DeviceDetachRejected
Types.DeviceAlreadyDetached
public void unplug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.DeviceDetachRejected, Types.DeviceAlreadyDetached
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.DeviceDetachRejected
Types.DeviceAlreadyDetached
public Task unplugForceAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void unplugForce(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task assertAttachableAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void assertAttachable(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Set<VBD> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static java.util.Map<VBD,VBD.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException