com.xensource.xenapi
Class PBD

java.lang.Object
  extended by com.xensource.xenapi.XenAPIObject
      extended by com.xensource.xenapi.PBD

public class PBD
extends XenAPIObject

The physical block devices through which hosts access SRs First published in XenServer 4.0.


Nested Class Summary
static class PBD.Record
          Represents all the fields in a PBD
 
Field Summary
protected  java.lang.String ref
          The XenAPI reference (OpaqueRef) to this object.
 
Method Summary
 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 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(java.lang.Object obj)
          If obj is a PBD, compares XenAPI references for equality.
static java.util.Set<PBD> getAll(Connection c)
          Return a list of all the PBDs known to the system.
static java.util.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, java.lang.String uuid)
          Get a reference to the PBD instance with the specified UUID.
 java.lang.Boolean getCurrentlyAttached(Connection c)
          Get the currently_attached field of the given PBD.
 java.util.Map<java.lang.String,java.lang.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.
 java.util.Map<java.lang.String,java.lang.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.
 java.lang.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 First published in XenServer 4.0.
 Task plugAsync(Connection c)
          Activate the specified PBD, causing the referenced SR to be attached and scanned First published in XenServer 4.0.
 void removeFromOtherConfig(Connection c, java.lang.String key)
          Remove the given key and its corresponding value from the other_config field of the given PBD.
 void setDeviceConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> value)
          Sets the PBD's device_config field First published in XenServer 4.1.
 Task setDeviceConfigAsync(Connection c, java.util.Map<java.lang.String,java.lang.String> value)
          Sets the PBD's device_config field First published in XenServer 4.1.
 void setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig)
          Set the other_config field of the given PBD.
 java.lang.String toWireString()
           
 void unplug(Connection c)
          Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned First published in XenServer 4.0.
 Task unplugAsync(Connection c)
          Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned First published in XenServer 4.0.
 
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 PBD, 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 PBD.Record getRecord(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Get a record containing the current state of the given PBD. First published in XenServer 4.0.

Returns:
all fields from the object
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getByUuid

public static PBD getByUuid(Connection c,
                            java.lang.String uuid)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Get a reference to the PBD instance with the specified UUID. First published in XenServer 4.0.

Parameters:
uuid - UUID of object to return
Returns:
reference to the object
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
                               PBD.Record record)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException
Create a new PBD instance, and return its handle. First published in XenServer 4.0.

Parameters:
record - All constructor arguments
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

create

public static PBD create(Connection c,
                         PBD.Record record)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException
Create a new PBD instance, and return its handle. First published in XenServer 4.0.

Parameters:
record - All constructor arguments
Returns:
reference to the newly created object
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException
Destroy the specified PBD instance. First published in XenServer 4.0.

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
Destroy the specified PBD instance. First published in XenServer 4.0.

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

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

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getSR

public SR getSR(Connection c)
         throws Types.BadServerResponse,
                Types.XenAPIException,
                org.apache.xmlrpc.XmlRpcException
Get the SR field of the given PBD. First published in XenServer 4.0.

Returns:
value of the field
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getDeviceConfig

public java.util.Map<java.lang.String,java.lang.String> getDeviceConfig(Connection c)
                                                                 throws Types.BadServerResponse,
                                                                        Types.XenAPIException,
                                                                        org.apache.xmlrpc.XmlRpcException
Get the device_config field of the given PBD. First published in XenServer 4.0.

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

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

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

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

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 PBD. If the key is not in that Map, then do nothing. First published in XenServer 4.1.

Parameters:
key - Key to remove
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

plugAsync

public Task plugAsync(Connection c)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException,
                      Types.SrUnknownDriver
Activate the specified PBD, causing the referenced SR to be attached and scanned First published in XenServer 4.0.

Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.SrUnknownDriver

plug

public void plug(Connection c)
          throws Types.BadServerResponse,
                 Types.XenAPIException,
                 org.apache.xmlrpc.XmlRpcException,
                 Types.SrUnknownDriver
Activate the specified PBD, causing the referenced SR to be attached and scanned First published in XenServer 4.0.

Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.SrUnknownDriver

unplugAsync

public Task unplugAsync(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException
Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned First published in XenServer 4.0.

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
Deactivate the specified PBD, causing the referenced SR to be detached and nolonger scanned First published in XenServer 4.0.

Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setDeviceConfigAsync

public Task setDeviceConfigAsync(Connection c,
                                 java.util.Map<java.lang.String,java.lang.String> value)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException
Sets the PBD's device_config field First published in XenServer 4.1.

Parameters:
value - The new value of the PBD's device_config
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setDeviceConfig

public void setDeviceConfig(Connection c,
                            java.util.Map<java.lang.String,java.lang.String> value)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Sets the PBD's device_config field First published in XenServer 4.1.

Parameters:
value - The new value of the PBD's device_config
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<PBD> getAll(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
Return a list of all the PBDs known to the system. First published in XenServer 4.0.

Returns:
references to all objects
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<PBD,PBD.Record> getAllRecords(Connection c)
                                                   throws Types.BadServerResponse,
                                                          Types.XenAPIException,
                                                          org.apache.xmlrpc.XmlRpcException
Return a map of PBD references to PBD records for all PBDs known to the system. First published in XenServer 4.0.

Returns:
records of all objects
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException