|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.xensource.xenapi.XenAPIObject
com.xensource.xenapi.PBD
public class PBD
The physical block devices through which hosts access SRs
Nested Class Summary | |
---|---|
static class |
PBD.Record
Represents all the fields in a PBD |
Field Summary | |
---|---|
protected String |
ref
The XenAPI reference to this object. |
Method Summary | |
---|---|
void |
addToOtherConfig(Connection c,
String key,
String value)
Add the given key-value pair to the other_config field of the given PBD. |
static PBD |
create(Connection c,
PBD.Record record)
Create a new PBD instance, and return its handle. |
static Task |
createAsync(Connection c,
PBD.Record record)
Create a new PBD instance, and return its handle. |
void |
destroy(Connection c)
Destroy the specified PBD instance. |
Task |
destroyAsync(Connection c)
Destroy the specified PBD instance. |
boolean |
equals(Object obj)
If obj is a PBD, compares XenAPI references for equality. |
static Set<PBD> |
getAll(Connection c)
Return a list of all the PBDs known to the system. |
static Map<PBD,PBD.Record> |
getAllRecords(Connection c)
Return a map of PBD references to PBD records for all PBDs known to the system. |
static PBD |
getByUuid(Connection c,
String uuid)
Get a reference to the PBD instance with the specified UUID. |
Boolean |
getCurrentlyAttached(Connection c)
Get the currently_attached field of the given PBD. |
Map<String,String> |
getDeviceConfig(Connection c)
Get the device_config field of the given PBD. |
Host |
getHost(Connection c)
Get the host field of the given PBD. |
Map<String,String> |
getOtherConfig(Connection c)
Get the other_config field of the given PBD. |
PBD.Record |
getRecord(Connection c)
Get a record containing the current state of the given PBD. |
SR |
getSR(Connection c)
Get the SR field of the given PBD. |
String |
getUuid(Connection c)
Get the uuid field of the given PBD. |
int |
hashCode()
|
void |
plug(Connection c)
Activate the specified PBD, causing the referenced SR to be attached and scanned |
Task |
plugAsync(Connection c)
Activate the specified PBD, causing the referenced SR to be attached and scanned |
void |
removeFromOtherConfig(Connection c,
String key)
Remove the given key and its corresponding value from the other_config field of the given PBD. |
void |
setDeviceConfig(Connection c,
Map<String,String> value)
Sets the PBD's device_config field |
Task |
setDeviceConfigAsync(Connection c,
Map<String,String> value)
Sets the PBD's device_config field |
void |
setOtherConfig(Connection c,
Map<String,String> otherConfig)
Set the other_config field of the given PBD. |
String |
toWireString()
|
void |
unplug(Connection c)
Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned |
Task |
unplugAsync(Connection c)
Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected final String ref
Method Detail |
---|
public String toWireString()
toWireString
in class XenAPIObject
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public PBD.Record getRecord(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static PBD getByUuid(Connection c, String uuid) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
uuid
- UUID of object to return
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Task createAsync(Connection c, PBD.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor arguments
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static PBD create(Connection c, PBD.Record record) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
record
- All constructor arguments
Types.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 String getUuid(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Host getHost(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public SR getSR(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Map<String,String> getDeviceConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Boolean getCurrentlyAttached(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Map<String,String> getOtherConfig(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setOtherConfig(Connection c, Map<String,String> otherConfig) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
otherConfig
- New value to set
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void addToOtherConfig(Connection c, String key, String value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to addvalue
- Value to add
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void removeFromOtherConfig(Connection c, String key) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
key
- Key to remove
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task plugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrUnknownDriver
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.SrUnknownDriver
public void plug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException, Types.SrUnknownDriver
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.SrUnknownDriver
public Task unplugAsync(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void unplug(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public Task setDeviceConfigAsync(Connection c, Map<String,String> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- The new value of the PBD's device_config
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public void setDeviceConfig(Connection c, Map<String,String> value) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
value
- The new value of the PBD's device_config
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Set<PBD> getAll(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
public static Map<PBD,PBD.Record> getAllRecords(Connection c) throws Types.BadServerResponse, Types.XenAPIException, org.apache.xmlrpc.XmlRpcException
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |