com.xensource.xenapi
Class Pool

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

public class Pool
extends XenAPIObject

Pool-wide information


Nested Class Summary
static class Pool.Record
          Represents all the fields in a Pool
 
Field Summary
protected  java.lang.String ref
          The XenAPI reference to this object.
 
Method Summary
 void addTags(Connection c, java.lang.String value)
          Add the given value to the tags field of the given pool.
 void addToGuiConfig(Connection c, java.lang.String key, java.lang.String value)
          Add the given key-value pair to the gui_config field of the given pool.
 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 pool.
static void certificateInstall(Connection c, java.lang.String name, java.lang.String cert)
          Install an SSL certificate pool-wide.
static Task certificateInstallAsync(Connection c, java.lang.String name, java.lang.String cert)
          Install an SSL certificate pool-wide.
static java.util.Set<java.lang.String> certificateList(Connection c)
          List all installed SSL certificates.
static Task certificateListAsync(Connection c)
          List all installed SSL certificates.
static void certificateSync(Connection c)
          Sync SSL certificates from master to slaves.
static Task certificateSyncAsync(Connection c)
          Sync SSL certificates from master to slaves.
static void certificateUninstall(Connection c, java.lang.String name)
          Remove an SSL certificate.
static Task certificateUninstallAsync(Connection c, java.lang.String name)
          Remove an SSL certificate.
 Blob createNewBlob(Connection c, java.lang.String name, java.lang.String mimeType)
          Create a placeholder for a named binary blob of data that is associated with this pool
 Task createNewBlobAsync(Connection c, java.lang.String name, java.lang.String mimeType)
          Create a placeholder for a named binary blob of data that is associated with this pool
static java.util.Set<PIF> createVLAN(Connection c, java.lang.String device, Network network, java.lang.Long VLAN)
          Create PIFs, mapping a network to the same physical interface/VLAN on each host.
static Task createVLANAsync(Connection c, java.lang.String device, Network network, java.lang.Long VLAN)
          Create PIFs, mapping a network to the same physical interface/VLAN on each host.
static java.util.Set<PIF> createVLANFromPIF(Connection c, PIF pif, Network network, java.lang.Long VLAN)
          Create a pool-wide VLAN by taking the PIF.
static Task createVLANFromPIFAsync(Connection c, PIF pif, Network network, java.lang.Long VLAN)
          Create a pool-wide VLAN by taking the PIF.
static void crlInstall(Connection c, java.lang.String name, java.lang.String cert)
          Install an SSL certificate revocation list, pool-wide.
static Task crlInstallAsync(Connection c, java.lang.String name, java.lang.String cert)
          Install an SSL certificate revocation list, pool-wide.
static java.util.Set<java.lang.String> crlList(Connection c)
          List all installed SSL certificate revocation lists.
static Task crlListAsync(Connection c)
          List all installed SSL certificate revocation lists.
static void crlUninstall(Connection c, java.lang.String name)
          Remove an SSL certificate revocation list.
static Task crlUninstallAsync(Connection c, java.lang.String name)
          Remove an SSL certificate revocation list.
static void deconfigureWlb(Connection c)
          Permanently deconfigures workload balancing monitoring on this pool
static Task deconfigureWlbAsync(Connection c)
          Permanently deconfigures workload balancing monitoring on this pool
static void designateNewMaster(Connection c, Host host)
          Perform an orderly handover of the role of master to the referenced host.
static Task designateNewMasterAsync(Connection c, Host host)
          Perform an orderly handover of the role of master to the referenced host.
 void detectNonhomogeneousExternalAuth(Connection c)
          This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts
 void disableExternalAuth(Connection c, java.util.Map<java.lang.String,java.lang.String> config)
          This call disables external authentication on all the hosts of the pool
static void disableHa(Connection c)
          Turn off High Availability mode
static Task disableHaAsync(Connection c)
          Turn off High Availability mode
 void disableLocalStorageCaching(Connection c)
          This call disables pool-wide local storage caching
 Task disableLocalStorageCachingAsync(Connection c)
          This call disables pool-wide local storage caching
static void disableRedoLog(Connection c)
          Disable the redo log if in use, unless HA is enabled.
static Task disableRedoLogAsync(Connection c)
          Disable the redo log if in use, unless HA is enabled.
static void eject(Connection c, Host host)
          Instruct a pool master to eject a host from the pool
static Task ejectAsync(Connection c, Host host)
          Instruct a pool master to eject a host from the pool
static void emergencyResetMaster(Connection c, java.lang.String masterAddress)
          Instruct a slave already in a pool that the master has changed
static void emergencyTransitionToMaster(Connection c)
          Instruct host that's currently a slave to transition to being master
 void enableExternalAuth(Connection c, java.util.Map<java.lang.String,java.lang.String> config, java.lang.String serviceName, java.lang.String authType)
          This call enables external authentication on all the hosts of the pool
static void enableHa(Connection c, java.util.Set<SR> heartbeatSrs, java.util.Map<java.lang.String,java.lang.String> configuration)
          Turn on High Availability mode
static Task enableHaAsync(Connection c, java.util.Set<SR> heartbeatSrs, java.util.Map<java.lang.String,java.lang.String> configuration)
          Turn on High Availability mode
 void enableLocalStorageCaching(Connection c)
          This call attempts to enable pool-wide local storage caching
 Task enableLocalStorageCachingAsync(Connection c)
          This call attempts to enable pool-wide local storage caching
static void enableRedoLog(Connection c, SR sr)
          Enable the redo log on the given SR and start using it, unless HA is enabled.
static Task enableRedoLogAsync(Connection c, SR sr)
          Enable the redo log on the given SR and start using it, unless HA is enabled.
 boolean equals(java.lang.Object obj)
          If obj is a Pool, compares XenAPI references for equality.
static java.util.Set<Pool> getAll(Connection c)
          Return a list of all the pools known to the system.
static java.util.Map<Pool,Pool.Record> getAllRecords(Connection c)
          Return a map of pool references to pool records for all pools known to the system.
 java.util.Map<java.lang.String,Blob> getBlobs(Connection c)
          Get the blobs field of the given pool.
static Pool getByUuid(Connection c, java.lang.String uuid)
          Get a reference to the pool instance with the specified UUID.
 SR getCrashDumpSR(Connection c)
          Get the crash_dump_SR field of the given pool.
 SR getDefaultSR(Connection c)
          Get the default_SR field of the given pool.
 java.util.Map<java.lang.String,java.lang.String> getGuiConfig(Connection c)
          Get the gui_config field of the given pool.
 java.lang.Boolean getHaAllowOvercommit(Connection c)
          Get the ha_allow_overcommit field of the given pool.
 java.util.Map<java.lang.String,java.lang.String> getHaConfiguration(Connection c)
          Get the ha_configuration field of the given pool.
 java.lang.Boolean getHaEnabled(Connection c)
          Get the ha_enabled field of the given pool.
 java.lang.Long getHaHostFailuresToTolerate(Connection c)
          Get the ha_host_failures_to_tolerate field of the given pool.
 java.lang.Boolean getHaOvercommitted(Connection c)
          Get the ha_overcommitted field of the given pool.
 java.lang.Long getHaPlanExistsFor(Connection c)
          Get the ha_plan_exists_for field of the given pool.
 java.util.Set<java.lang.String> getHaStatefiles(Connection c)
          Get the ha_statefiles field of the given pool.
 Host getMaster(Connection c)
          Get the master field of the given pool.
 java.lang.String getNameDescription(Connection c)
          Get the name_description field of the given pool.
 java.lang.String getNameLabel(Connection c)
          Get the name_label field of the given pool.
 java.util.Map<java.lang.String,java.lang.String> getOtherConfig(Connection c)
          Get the other_config field of the given pool.
 Pool.Record getRecord(Connection c)
          Get a record containing the current state of the given pool.
 java.lang.Boolean getRedoLogEnabled(Connection c)
          Get the redo_log_enabled field of the given pool.
 VDI getRedoLogVdi(Connection c)
          Get the redo_log_vdi field of the given pool.
 java.util.Map<java.lang.String,java.lang.String> getRestrictions(Connection c)
          Get the restrictions field of the given pool.
 SR getSuspendImageSR(Connection c)
          Get the suspend_image_SR field of the given pool.
 java.util.Set<java.lang.String> getTags(Connection c)
          Get the tags field of the given pool.
 java.lang.String getUuid(Connection c)
          Get the uuid field of the given pool.
 java.lang.String getVswitchController(Connection c)
          Get the vswitch_controller field of the given pool.
 java.lang.Boolean getWlbEnabled(Connection c)
          Get the wlb_enabled field of the given pool.
 java.lang.String getWlbUrl(Connection c)
          Get the wlb_url field of the given pool.
 java.lang.String getWlbUsername(Connection c)
          Get the wlb_username field of the given pool.
 java.lang.Boolean getWlbVerifyCert(Connection c)
          Get the wlb_verify_cert field of the given pool.
static java.lang.Long haComputeHypotheticalMaxHostFailuresToTolerate(Connection c, java.util.Map<VM,java.lang.String> configuration)
          Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs
static java.lang.Long haComputeMaxHostFailuresToTolerate(Connection c)
          Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs
static java.util.Map<VM,java.util.Map<java.lang.String,java.lang.String>> haComputeVmFailoverPlan(Connection c, java.util.Set<Host> failedHosts, java.util.Set<VM> failedVms)
          Return a VM failover plan assuming a given subset of hosts fail
static java.lang.Boolean haFailoverPlanExists(Connection c, java.lang.Long n)
          Returns true if a VM failover plan exists for up to 'n' host failures
static void haPreventRestartsFor(Connection c, java.lang.Long seconds)
          When this call returns the VM restart logic will not run for the requested number of seconds.
 int hashCode()
           
static void initializeWlb(Connection c, java.lang.String wlbUrl, java.lang.String wlbUsername, java.lang.String wlbPassword, java.lang.String xenserverUsername, java.lang.String xenserverPassword)
          Initializes workload balancing monitoring on this pool with the specified wlb server
static Task initializeWlbAsync(Connection c, java.lang.String wlbUrl, java.lang.String wlbUsername, java.lang.String wlbPassword, java.lang.String xenserverUsername, java.lang.String xenserverPassword)
          Initializes workload balancing monitoring on this pool with the specified wlb server
static void join(Connection c, java.lang.String masterAddress, java.lang.String masterUsername, java.lang.String masterPassword)
          Instruct host to join a new pool
static Task joinAsync(Connection c, java.lang.String masterAddress, java.lang.String masterUsername, java.lang.String masterPassword)
          Instruct host to join a new pool
static void joinForce(Connection c, java.lang.String masterAddress, java.lang.String masterUsername, java.lang.String masterPassword)
          Instruct host to join a new pool
static Task joinForceAsync(Connection c, java.lang.String masterAddress, java.lang.String masterUsername, java.lang.String masterPassword)
          Instruct host to join a new pool
static java.util.Set<Host> recoverSlaves(Connection c)
          Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.
static Task recoverSlavesAsync(Connection c)
          Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.
 void removeFromGuiConfig(Connection c, java.lang.String key)
          Remove the given key and its corresponding value from the gui_config field of the given pool.
 void removeFromOtherConfig(Connection c, java.lang.String key)
          Remove the given key and its corresponding value from the other_config field of the given pool.
 void removeTags(Connection c, java.lang.String value)
          Remove the given value from the tags field of the given pool.
static java.util.Map<java.lang.String,java.lang.String> retrieveWlbConfiguration(Connection c)
          Retrieves the pool optimization criteria from the workload balancing server
static Task retrieveWlbConfigurationAsync(Connection c)
          Retrieves the pool optimization criteria from the workload balancing server
static java.util.Map<VM,java.util.Set<java.lang.String>> retrieveWlbRecommendations(Connection c)
          Retrieves vm migrate recommendations for the pool from the workload balancing server
static Task retrieveWlbRecommendationsAsync(Connection c)
          Retrieves vm migrate recommendations for the pool from the workload balancing server
static java.lang.String sendTestPost(Connection c, java.lang.String host, java.lang.Long port, java.lang.String body)
          Send the given body to the given host and port, using HTTPS, and print the response.
static Task sendTestPostAsync(Connection c, java.lang.String host, java.lang.Long port, java.lang.String body)
          Send the given body to the given host and port, using HTTPS, and print the response.
static void sendWlbConfiguration(Connection c, java.util.Map<java.lang.String,java.lang.String> config)
          Sets the pool optimization criteria for the workload balancing server
static Task sendWlbConfigurationAsync(Connection c, java.util.Map<java.lang.String,java.lang.String> config)
          Sets the pool optimization criteria for the workload balancing server
 void setCrashDumpSR(Connection c, SR crashDumpSR)
          Set the crash_dump_SR field of the given pool.
 void setDefaultSR(Connection c, SR defaultSR)
          Set the default_SR field of the given pool.
 void setGuiConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> guiConfig)
          Set the gui_config field of the given pool.
 void setHaAllowOvercommit(Connection c, java.lang.Boolean haAllowOvercommit)
          Set the ha_allow_overcommit field of the given pool.
 void setHaHostFailuresToTolerate(Connection c, java.lang.Long value)
          Set the maximum number of host failures to consider in the HA VM restart planner
 Task setHaHostFailuresToTolerateAsync(Connection c, java.lang.Long value)
          Set the maximum number of host failures to consider in the HA VM restart planner
 void setNameDescription(Connection c, java.lang.String nameDescription)
          Set the name_description field of the given pool.
 void setNameLabel(Connection c, java.lang.String nameLabel)
          Set the name_label field of the given pool.
 void setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig)
          Set the other_config field of the given pool.
 void setSuspendImageSR(Connection c, SR suspendImageSR)
          Set the suspend_image_SR field of the given pool.
 void setTags(Connection c, java.util.Set<java.lang.String> tags)
          Set the tags field of the given pool.
static void setVswitchController(Connection c, java.lang.String address)
          Set the IP address of the vswitch controller.
static Task setVswitchControllerAsync(Connection c, java.lang.String address)
          Set the IP address of the vswitch controller.
 void setWlbEnabled(Connection c, java.lang.Boolean wlbEnabled)
          Set the wlb_enabled field of the given pool.
 void setWlbVerifyCert(Connection c, java.lang.Boolean wlbVerifyCert)
          Set the wlb_verify_cert field of the given pool.
static void syncDatabase(Connection c)
          Forcibly synchronise the database now
static Task syncDatabaseAsync(Connection c)
          Forcibly synchronise the database now
 java.lang.String testArchiveTarget(Connection c, java.util.Map<java.lang.String,java.lang.String> config)
          This call tests if a location is valid
 java.lang.String toWireString()
           
 
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 to this object.

Method Detail

toWireString

public java.lang.String toWireString()
Specified by:
toWireString in class XenAPIObject

equals

public boolean equals(java.lang.Object obj)
If obj is a Pool, 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 Pool.Record getRecord(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Get a record containing the current state of the given pool.

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

getByUuid

public static Pool getByUuid(Connection c,
                             java.lang.String uuid)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Get a reference to the pool instance with the specified UUID.

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 pool.

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

getNameLabel

public java.lang.String getNameLabel(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException
Get the name_label field of the given pool.

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

getNameDescription

public java.lang.String getNameDescription(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException
Get the name_description field of the given pool.

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

getMaster

public Host getMaster(Connection c)
               throws Types.BadServerResponse,
                      Types.XenAPIException,
                      org.apache.xmlrpc.XmlRpcException
Get the master field of the given pool.

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

getDefaultSR

public SR getDefaultSR(Connection c)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException
Get the default_SR field of the given pool.

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

getSuspendImageSR

public SR getSuspendImageSR(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Get the suspend_image_SR field of the given pool.

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

getCrashDumpSR

public SR getCrashDumpSR(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException
Get the crash_dump_SR field of the given pool.

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 pool.

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

getHaEnabled

public java.lang.Boolean getHaEnabled(Connection c)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException
Get the ha_enabled field of the given pool.

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

getHaConfiguration

public java.util.Map<java.lang.String,java.lang.String> getHaConfiguration(Connection c)
                                                                    throws Types.BadServerResponse,
                                                                           Types.XenAPIException,
                                                                           org.apache.xmlrpc.XmlRpcException
Get the ha_configuration field of the given pool.

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

getHaStatefiles

public java.util.Set<java.lang.String> getHaStatefiles(Connection c)
                                                throws Types.BadServerResponse,
                                                       Types.XenAPIException,
                                                       org.apache.xmlrpc.XmlRpcException
Get the ha_statefiles field of the given pool.

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

getHaHostFailuresToTolerate

public java.lang.Long getHaHostFailuresToTolerate(Connection c)
                                           throws Types.BadServerResponse,
                                                  Types.XenAPIException,
                                                  org.apache.xmlrpc.XmlRpcException
Get the ha_host_failures_to_tolerate field of the given pool.

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

getHaPlanExistsFor

public java.lang.Long getHaPlanExistsFor(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException
Get the ha_plan_exists_for field of the given pool.

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

getHaAllowOvercommit

public java.lang.Boolean getHaAllowOvercommit(Connection c)
                                       throws Types.BadServerResponse,
                                              Types.XenAPIException,
                                              org.apache.xmlrpc.XmlRpcException
Get the ha_allow_overcommit field of the given pool.

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

getHaOvercommitted

public java.lang.Boolean getHaOvercommitted(Connection c)
                                     throws Types.BadServerResponse,
                                            Types.XenAPIException,
                                            org.apache.xmlrpc.XmlRpcException
Get the ha_overcommitted field of the given pool.

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

getBlobs

public java.util.Map<java.lang.String,Blob> getBlobs(Connection c)
                                              throws Types.BadServerResponse,
                                                     Types.XenAPIException,
                                                     org.apache.xmlrpc.XmlRpcException
Get the blobs field of the given pool.

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

getTags

public java.util.Set<java.lang.String> getTags(Connection c)
                                        throws Types.BadServerResponse,
                                               Types.XenAPIException,
                                               org.apache.xmlrpc.XmlRpcException
Get the tags field of the given pool.

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

getGuiConfig

public java.util.Map<java.lang.String,java.lang.String> getGuiConfig(Connection c)
                                                              throws Types.BadServerResponse,
                                                                     Types.XenAPIException,
                                                                     org.apache.xmlrpc.XmlRpcException
Get the gui_config field of the given pool.

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

getWlbUrl

public java.lang.String getWlbUrl(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
Get the wlb_url field of the given pool.

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

getWlbUsername

public java.lang.String getWlbUsername(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException
Get the wlb_username field of the given pool.

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

getWlbEnabled

public java.lang.Boolean getWlbEnabled(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException
Get the wlb_enabled field of the given pool.

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

getWlbVerifyCert

public java.lang.Boolean getWlbVerifyCert(Connection c)
                                   throws Types.BadServerResponse,
                                          Types.XenAPIException,
                                          org.apache.xmlrpc.XmlRpcException
Get the wlb_verify_cert field of the given pool.

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

getRedoLogEnabled

public java.lang.Boolean getRedoLogEnabled(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException
Get the redo_log_enabled field of the given pool.

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

getRedoLogVdi

public VDI getRedoLogVdi(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException
Get the redo_log_vdi field of the given pool.

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

getVswitchController

public java.lang.String getVswitchController(Connection c)
                                      throws Types.BadServerResponse,
                                             Types.XenAPIException,
                                             org.apache.xmlrpc.XmlRpcException
Get the vswitch_controller field of the given pool.

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

getRestrictions

public java.util.Map<java.lang.String,java.lang.String> getRestrictions(Connection c)
                                                                 throws Types.BadServerResponse,
                                                                        Types.XenAPIException,
                                                                        org.apache.xmlrpc.XmlRpcException
Get the restrictions field of the given pool.

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

setNameLabel

public void setNameLabel(Connection c,
                         java.lang.String nameLabel)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException
Set the name_label field of the given pool.

Parameters:
nameLabel - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setNameDescription

public void setNameDescription(Connection c,
                               java.lang.String nameDescription)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException
Set the name_description field of the given pool.

Parameters:
nameDescription - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setDefaultSR

public void setDefaultSR(Connection c,
                         SR defaultSR)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException
Set the default_SR field of the given pool.

Parameters:
defaultSR - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setSuspendImageSR

public void setSuspendImageSR(Connection c,
                              SR suspendImageSR)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Set the suspend_image_SR field of the given pool.

Parameters:
suspendImageSR - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setCrashDumpSR

public void setCrashDumpSR(Connection c,
                           SR crashDumpSR)
                    throws Types.BadServerResponse,
                           Types.XenAPIException,
                           org.apache.xmlrpc.XmlRpcException
Set the crash_dump_SR field of the given pool.

Parameters:
crashDumpSR - New value to set
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 pool.

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 pool.

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 pool. If the key is not in that Map, then do nothing.

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

setHaAllowOvercommit

public void setHaAllowOvercommit(Connection c,
                                 java.lang.Boolean haAllowOvercommit)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException
Set the ha_allow_overcommit field of the given pool.

Parameters:
haAllowOvercommit - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setTags

public void setTags(Connection c,
                    java.util.Set<java.lang.String> tags)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException
Set the tags field of the given pool.

Parameters:
tags - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

addTags

public void addTags(Connection c,
                    java.lang.String value)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException
Add the given value to the tags field of the given pool. If the value is already in that Set, then do nothing.

Parameters:
value - New value to add
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

removeTags

public void removeTags(Connection c,
                       java.lang.String value)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException
Remove the given value from the tags field of the given pool. If the value is not in that Set, then do nothing.

Parameters:
value - Value to remove
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setGuiConfig

public void setGuiConfig(Connection c,
                         java.util.Map<java.lang.String,java.lang.String> guiConfig)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException
Set the gui_config field of the given pool.

Parameters:
guiConfig - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

addToGuiConfig

public void addToGuiConfig(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 gui_config field of the given pool.

Parameters:
key - Key to add
value - Value to add
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

removeFromGuiConfig

public void removeFromGuiConfig(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 gui_config field of the given pool. If the key is not in that Map, then do nothing.

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

setWlbEnabled

public void setWlbEnabled(Connection c,
                          java.lang.Boolean wlbEnabled)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException
Set the wlb_enabled field of the given pool.

Parameters:
wlbEnabled - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setWlbVerifyCert

public void setWlbVerifyCert(Connection c,
                             java.lang.Boolean wlbVerifyCert)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Set the wlb_verify_cert field of the given pool.

Parameters:
wlbVerifyCert - New value to set
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

joinAsync

public static Task joinAsync(Connection c,
                             java.lang.String masterAddress,
                             java.lang.String masterUsername,
                             java.lang.String masterPassword)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException,
                             Types.JoiningHostCannotContainSharedSrs
Instruct host to join a new pool

Parameters:
masterAddress - The hostname of the master of the pool to join
masterUsername - The username of the master (for initial authentication)
masterPassword - The password for the master (for initial authentication)
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.JoiningHostCannotContainSharedSrs

join

public static void join(Connection c,
                        java.lang.String masterAddress,
                        java.lang.String masterUsername,
                        java.lang.String masterPassword)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException,
                        Types.JoiningHostCannotContainSharedSrs
Instruct host to join a new pool

Parameters:
masterAddress - The hostname of the master of the pool to join
masterUsername - The username of the master (for initial authentication)
masterPassword - The password for the master (for initial authentication)
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.JoiningHostCannotContainSharedSrs

joinForceAsync

public static Task joinForceAsync(Connection c,
                                  java.lang.String masterAddress,
                                  java.lang.String masterUsername,
                                  java.lang.String masterPassword)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
Instruct host to join a new pool

Parameters:
masterAddress - The hostname of the master of the pool to join
masterUsername - The username of the master (for initial authentication)
masterPassword - The password for the master (for initial authentication)
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

joinForce

public static void joinForce(Connection c,
                             java.lang.String masterAddress,
                             java.lang.String masterUsername,
                             java.lang.String masterPassword)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Instruct host to join a new pool

Parameters:
masterAddress - The hostname of the master of the pool to join
masterUsername - The username of the master (for initial authentication)
masterPassword - The password for the master (for initial authentication)
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

ejectAsync

public static Task ejectAsync(Connection c,
                              Host host)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Instruct a pool master to eject a host from the pool

Parameters:
host - The host to eject
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

eject

public static void eject(Connection c,
                         Host host)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException
Instruct a pool master to eject a host from the pool

Parameters:
host - The host to eject
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

emergencyTransitionToMaster

public static void emergencyTransitionToMaster(Connection c)
                                        throws Types.BadServerResponse,
                                               Types.XenAPIException,
                                               org.apache.xmlrpc.XmlRpcException
Instruct host that's currently a slave to transition to being master

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

emergencyResetMaster

public static void emergencyResetMaster(Connection c,
                                        java.lang.String masterAddress)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
Instruct a slave already in a pool that the master has changed

Parameters:
masterAddress - The hostname of the master
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

recoverSlavesAsync

public static Task recoverSlavesAsync(Connection c)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException
Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.

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

recoverSlaves

public static java.util.Set<Host> recoverSlaves(Connection c)
                                         throws Types.BadServerResponse,
                                                Types.XenAPIException,
                                                org.apache.xmlrpc.XmlRpcException
Instruct a pool master, M, to try and contact its slaves and, if slaves are in emergency mode, reset their master address to M.

Returns:
list of hosts whose master address were succesfully reset
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

createVLANAsync

public static Task createVLANAsync(Connection c,
                                   java.lang.String device,
                                   Network network,
                                   java.lang.Long VLAN)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException,
                                   Types.VlanTagInvalid
Create PIFs, mapping a network to the same physical interface/VLAN on each host. This call is deprecated: use Pool.create_VLAN_from_PIF instead.

Parameters:
device - physical interface on which to create the VLAN interface
network - network to which this interface should be connected
VLAN - VLAN tag for the new interface
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VlanTagInvalid

createVLAN

public static java.util.Set<PIF> createVLAN(Connection c,
                                            java.lang.String device,
                                            Network network,
                                            java.lang.Long VLAN)
                                     throws Types.BadServerResponse,
                                            Types.XenAPIException,
                                            org.apache.xmlrpc.XmlRpcException,
                                            Types.VlanTagInvalid
Create PIFs, mapping a network to the same physical interface/VLAN on each host. This call is deprecated: use Pool.create_VLAN_from_PIF instead.

Parameters:
device - physical interface on which to create the VLAN interface
network - network to which this interface should be connected
VLAN - VLAN tag for the new interface
Returns:
The references of the created PIF objects
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VlanTagInvalid

createVLANFromPIFAsync

public static Task createVLANFromPIFAsync(Connection c,
                                          PIF pif,
                                          Network network,
                                          java.lang.Long VLAN)
                                   throws Types.BadServerResponse,
                                          Types.XenAPIException,
                                          org.apache.xmlrpc.XmlRpcException,
                                          Types.VlanTagInvalid
Create a pool-wide VLAN by taking the PIF.

Parameters:
pif - physical interface on any particular host, that identifies the PIF on which to create the (pool-wide) VLAN interface
network - network to which this interface should be connected
VLAN - VLAN tag for the new interface
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VlanTagInvalid

createVLANFromPIF

public static java.util.Set<PIF> createVLANFromPIF(Connection c,
                                                   PIF pif,
                                                   Network network,
                                                   java.lang.Long VLAN)
                                            throws Types.BadServerResponse,
                                                   Types.XenAPIException,
                                                   org.apache.xmlrpc.XmlRpcException,
                                                   Types.VlanTagInvalid
Create a pool-wide VLAN by taking the PIF.

Parameters:
pif - physical interface on any particular host, that identifies the PIF on which to create the (pool-wide) VLAN interface
network - network to which this interface should be connected
VLAN - VLAN tag for the new interface
Returns:
The references of the created PIF objects
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException
Types.VlanTagInvalid

enableHaAsync

public static Task enableHaAsync(Connection c,
                                 java.util.Set<SR> heartbeatSrs,
                                 java.util.Map<java.lang.String,java.lang.String> configuration)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException
Turn on High Availability mode

Parameters:
heartbeatSrs - Set of SRs to use for storage heartbeating.
configuration - Detailed HA configuration to apply
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

enableHa

public static void enableHa(Connection c,
                            java.util.Set<SR> heartbeatSrs,
                            java.util.Map<java.lang.String,java.lang.String> configuration)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException
Turn on High Availability mode

Parameters:
heartbeatSrs - Set of SRs to use for storage heartbeating.
configuration - Detailed HA configuration to apply
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

disableHaAsync

public static Task disableHaAsync(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
Turn off High Availability mode

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

disableHa

public static void disableHa(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException
Turn off High Availability mode

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

syncDatabaseAsync

public static Task syncDatabaseAsync(Connection c)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException
Forcibly synchronise the database now

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

syncDatabase

public static void syncDatabase(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException
Forcibly synchronise the database now

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

designateNewMasterAsync

public static Task designateNewMasterAsync(Connection c,
                                           Host host)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException
Perform an orderly handover of the role of master to the referenced host.

Parameters:
host - The host who should become the new master
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

designateNewMaster

public static void designateNewMaster(Connection c,
                                      Host host)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException
Perform an orderly handover of the role of master to the referenced host.

Parameters:
host - The host who should become the new master
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

haPreventRestartsFor

public static void haPreventRestartsFor(Connection c,
                                        java.lang.Long seconds)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
When this call returns the VM restart logic will not run for the requested number of seconds. If the argument is zero then the restart thread is immediately unblocked

Parameters:
seconds - The number of seconds to block the restart thread for
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

haFailoverPlanExists

public static java.lang.Boolean haFailoverPlanExists(Connection c,
                                                     java.lang.Long n)
                                              throws Types.BadServerResponse,
                                                     Types.XenAPIException,
                                                     org.apache.xmlrpc.XmlRpcException
Returns true if a VM failover plan exists for up to 'n' host failures

Parameters:
n - The number of host failures to plan for
Returns:
true if a failover plan exists for the supplied number of host failures
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

haComputeMaxHostFailuresToTolerate

public static java.lang.Long haComputeMaxHostFailuresToTolerate(Connection c)
                                                         throws Types.BadServerResponse,
                                                                Types.XenAPIException,
                                                                org.apache.xmlrpc.XmlRpcException
Returns the maximum number of host failures we could tolerate before we would be unable to restart configured VMs

Returns:
maximum value for ha_host_failures_to_tolerate given current configuration
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

haComputeHypotheticalMaxHostFailuresToTolerate

public static java.lang.Long haComputeHypotheticalMaxHostFailuresToTolerate(Connection c,
                                                                            java.util.Map<VM,java.lang.String> configuration)
                                                                     throws Types.BadServerResponse,
                                                                            Types.XenAPIException,
                                                                            org.apache.xmlrpc.XmlRpcException
Returns the maximum number of host failures we could tolerate before we would be unable to restart the provided VMs

Parameters:
configuration - Map of protected VM reference to restart priority
Returns:
maximum value for ha_host_failures_to_tolerate given provided configuration
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

haComputeVmFailoverPlan

public static java.util.Map<VM,java.util.Map<java.lang.String,java.lang.String>> haComputeVmFailoverPlan(Connection c,
                                                                                                         java.util.Set<Host> failedHosts,
                                                                                                         java.util.Set<VM> failedVms)
                                                                                                  throws Types.BadServerResponse,
                                                                                                         Types.XenAPIException,
                                                                                                         org.apache.xmlrpc.XmlRpcException
Return a VM failover plan assuming a given subset of hosts fail

Parameters:
failedHosts - The set of hosts to assume have failed
failedVms - The set of VMs to restart
Returns:
VM failover plan: a map of VM to host to restart the host on
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setHaHostFailuresToTolerateAsync

public Task setHaHostFailuresToTolerateAsync(Connection c,
                                             java.lang.Long value)
                                      throws Types.BadServerResponse,
                                             Types.XenAPIException,
                                             org.apache.xmlrpc.XmlRpcException
Set the maximum number of host failures to consider in the HA VM restart planner

Parameters:
value - New number of host failures to consider
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setHaHostFailuresToTolerate

public void setHaHostFailuresToTolerate(Connection c,
                                        java.lang.Long value)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
Set the maximum number of host failures to consider in the HA VM restart planner

Parameters:
value - New number of host failures to consider
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

createNewBlobAsync

public Task createNewBlobAsync(Connection c,
                               java.lang.String name,
                               java.lang.String mimeType)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException
Create a placeholder for a named binary blob of data that is associated with this pool

Parameters:
name - The name associated with the blob
mimeType - The mime type for the data. Empty string translates to application/octet-stream
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

createNewBlob

public Blob createNewBlob(Connection c,
                          java.lang.String name,
                          java.lang.String mimeType)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException
Create a placeholder for a named binary blob of data that is associated with this pool

Parameters:
name - The name associated with the blob
mimeType - The mime type for the data. Empty string translates to application/octet-stream
Returns:
The reference of the blob, needed for populating its data
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

enableExternalAuth

public void enableExternalAuth(Connection c,
                               java.util.Map<java.lang.String,java.lang.String> config,
                               java.lang.String serviceName,
                               java.lang.String authType)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException
This call enables external authentication on all the hosts of the pool

Parameters:
config - A list of key-values containing the configuration data
serviceName - The name of the service
authType - The type of authentication (e.g. AD for Active Directory)
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

disableExternalAuth

public void disableExternalAuth(Connection c,
                                java.util.Map<java.lang.String,java.lang.String> config)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException
This call disables external authentication on all the hosts of the pool

Parameters:
config - Optional parameters as a list of key-values containing the configuration data
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

detectNonhomogeneousExternalAuth

public void detectNonhomogeneousExternalAuth(Connection c)
                                      throws Types.BadServerResponse,
                                             Types.XenAPIException,
                                             org.apache.xmlrpc.XmlRpcException
This call asynchronously detects if the external authentication configuration in any slave is different from that in the master and raises appropriate alerts

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

initializeWlbAsync

public static Task initializeWlbAsync(Connection c,
                                      java.lang.String wlbUrl,
                                      java.lang.String wlbUsername,
                                      java.lang.String wlbPassword,
                                      java.lang.String xenserverUsername,
                                      java.lang.String xenserverPassword)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException
Initializes workload balancing monitoring on this pool with the specified wlb server

Parameters:
wlbUrl - The ip address and port to use when accessing the wlb server
wlbUsername - The username used to authenticate with the wlb server
wlbPassword - The password used to authenticate with the wlb server
xenserverUsername - The usernamed used by the wlb server to authenticate with the xenserver
xenserverPassword - The password used by the wlb server to authenticate with the xenserver
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

initializeWlb

public static void initializeWlb(Connection c,
                                 java.lang.String wlbUrl,
                                 java.lang.String wlbUsername,
                                 java.lang.String wlbPassword,
                                 java.lang.String xenserverUsername,
                                 java.lang.String xenserverPassword)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException
Initializes workload balancing monitoring on this pool with the specified wlb server

Parameters:
wlbUrl - The ip address and port to use when accessing the wlb server
wlbUsername - The username used to authenticate with the wlb server
wlbPassword - The password used to authenticate with the wlb server
xenserverUsername - The usernamed used by the wlb server to authenticate with the xenserver
xenserverPassword - The password used by the wlb server to authenticate with the xenserver
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

deconfigureWlbAsync

public static Task deconfigureWlbAsync(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException
Permanently deconfigures workload balancing monitoring on this pool

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

deconfigureWlb

public static void deconfigureWlb(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
Permanently deconfigures workload balancing monitoring on this pool

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

sendWlbConfigurationAsync

public static Task sendWlbConfigurationAsync(Connection c,
                                             java.util.Map<java.lang.String,java.lang.String> config)
                                      throws Types.BadServerResponse,
                                             Types.XenAPIException,
                                             org.apache.xmlrpc.XmlRpcException
Sets the pool optimization criteria for the workload balancing server

Parameters:
config - The configuration to use in optimizing this pool
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

sendWlbConfiguration

public static void sendWlbConfiguration(Connection c,
                                        java.util.Map<java.lang.String,java.lang.String> config)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
Sets the pool optimization criteria for the workload balancing server

Parameters:
config - The configuration to use in optimizing this pool
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

retrieveWlbConfigurationAsync

public static Task retrieveWlbConfigurationAsync(Connection c)
                                          throws Types.BadServerResponse,
                                                 Types.XenAPIException,
                                                 org.apache.xmlrpc.XmlRpcException
Retrieves the pool optimization criteria from the workload balancing server

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

retrieveWlbConfiguration

public static java.util.Map<java.lang.String,java.lang.String> retrieveWlbConfiguration(Connection c)
                                                                                 throws Types.BadServerResponse,
                                                                                        Types.XenAPIException,
                                                                                        org.apache.xmlrpc.XmlRpcException
Retrieves the pool optimization criteria from the workload balancing server

Returns:
The configuration used in optimizing this pool
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

retrieveWlbRecommendationsAsync

public static Task retrieveWlbRecommendationsAsync(Connection c)
                                            throws Types.BadServerResponse,
                                                   Types.XenAPIException,
                                                   org.apache.xmlrpc.XmlRpcException
Retrieves vm migrate recommendations for the pool from the workload balancing server

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

retrieveWlbRecommendations

public static java.util.Map<VM,java.util.Set<java.lang.String>> retrieveWlbRecommendations(Connection c)
                                                                                    throws Types.BadServerResponse,
                                                                                           Types.XenAPIException,
                                                                                           org.apache.xmlrpc.XmlRpcException
Retrieves vm migrate recommendations for the pool from the workload balancing server

Returns:
The list of vm migration recommendations
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

sendTestPostAsync

public static Task sendTestPostAsync(Connection c,
                                     java.lang.String host,
                                     java.lang.Long port,
                                     java.lang.String body)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException
Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer.

Parameters:
host -
port -
body -
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

sendTestPost

public static java.lang.String sendTestPost(Connection c,
                                            java.lang.String host,
                                            java.lang.Long port,
                                            java.lang.String body)
                                     throws Types.BadServerResponse,
                                            Types.XenAPIException,
                                            org.apache.xmlrpc.XmlRpcException
Send the given body to the given host and port, using HTTPS, and print the response. This is used for debugging the SSL layer.

Parameters:
host -
port -
body -
Returns:
The response
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

certificateInstallAsync

public static Task certificateInstallAsync(Connection c,
                                           java.lang.String name,
                                           java.lang.String cert)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException
Install an SSL certificate pool-wide.

Parameters:
name - A name to give the certificate
cert - The certificate
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

certificateInstall

public static void certificateInstall(Connection c,
                                      java.lang.String name,
                                      java.lang.String cert)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException
Install an SSL certificate pool-wide.

Parameters:
name - A name to give the certificate
cert - The certificate
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

certificateUninstallAsync

public static Task certificateUninstallAsync(Connection c,
                                             java.lang.String name)
                                      throws Types.BadServerResponse,
                                             Types.XenAPIException,
                                             org.apache.xmlrpc.XmlRpcException
Remove an SSL certificate.

Parameters:
name - The certificate name
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

certificateUninstall

public static void certificateUninstall(Connection c,
                                        java.lang.String name)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
Remove an SSL certificate.

Parameters:
name - The certificate name
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

certificateListAsync

public static Task certificateListAsync(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
List all installed SSL certificates.

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

certificateList

public static java.util.Set<java.lang.String> certificateList(Connection c)
                                                       throws Types.BadServerResponse,
                                                              Types.XenAPIException,
                                                              org.apache.xmlrpc.XmlRpcException
List all installed SSL certificates.

Returns:
All installed certificates
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

crlInstallAsync

public static Task crlInstallAsync(Connection c,
                                   java.lang.String name,
                                   java.lang.String cert)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException
Install an SSL certificate revocation list, pool-wide.

Parameters:
name - A name to give the CRL
cert - The CRL
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

crlInstall

public static void crlInstall(Connection c,
                              java.lang.String name,
                              java.lang.String cert)
                       throws Types.BadServerResponse,
                              Types.XenAPIException,
                              org.apache.xmlrpc.XmlRpcException
Install an SSL certificate revocation list, pool-wide.

Parameters:
name - A name to give the CRL
cert - The CRL
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

crlUninstallAsync

public static Task crlUninstallAsync(Connection c,
                                     java.lang.String name)
                              throws Types.BadServerResponse,
                                     Types.XenAPIException,
                                     org.apache.xmlrpc.XmlRpcException
Remove an SSL certificate revocation list.

Parameters:
name - The CRL name
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

crlUninstall

public static void crlUninstall(Connection c,
                                java.lang.String name)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException
Remove an SSL certificate revocation list.

Parameters:
name - The CRL name
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

crlListAsync

public static Task crlListAsync(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException
List all installed SSL certificate revocation lists.

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

crlList

public static java.util.Set<java.lang.String> crlList(Connection c)
                                               throws Types.BadServerResponse,
                                                      Types.XenAPIException,
                                                      org.apache.xmlrpc.XmlRpcException
List all installed SSL certificate revocation lists.

Returns:
All installed CRLs
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

certificateSyncAsync

public static Task certificateSyncAsync(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
Sync SSL certificates from master to slaves.

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

certificateSync

public static void certificateSync(Connection c)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException
Sync SSL certificates from master to slaves.

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

enableRedoLogAsync

public static Task enableRedoLogAsync(Connection c,
                                      SR sr)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException
Enable the redo log on the given SR and start using it, unless HA is enabled.

Parameters:
sr - SR to hold the redo log.
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

enableRedoLog

public static void enableRedoLog(Connection c,
                                 SR sr)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException
Enable the redo log on the given SR and start using it, unless HA is enabled.

Parameters:
sr - SR to hold the redo log.
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

disableRedoLogAsync

public static Task disableRedoLogAsync(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException
Disable the redo log if in use, unless HA is enabled.

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

disableRedoLog

public static void disableRedoLog(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException
Disable the redo log if in use, unless HA is enabled.

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

setVswitchControllerAsync

public static Task setVswitchControllerAsync(Connection c,
                                             java.lang.String address)
                                      throws Types.BadServerResponse,
                                             Types.XenAPIException,
                                             org.apache.xmlrpc.XmlRpcException
Set the IP address of the vswitch controller.

Parameters:
address - IP address of the vswitch controller.
Returns:
Task
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

setVswitchController

public static void setVswitchController(Connection c,
                                        java.lang.String address)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException
Set the IP address of the vswitch controller.

Parameters:
address - IP address of the vswitch controller.
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

testArchiveTarget

public java.lang.String testArchiveTarget(Connection c,
                                          java.util.Map<java.lang.String,java.lang.String> config)
                                   throws Types.BadServerResponse,
                                          Types.XenAPIException,
                                          org.apache.xmlrpc.XmlRpcException
This call tests if a location is valid

Parameters:
config - Location config settings to test
Returns:
An XMLRPC result
Throws:
Types.BadServerResponse
Types.XenAPIException
org.apache.xmlrpc.XmlRpcException

enableLocalStorageCachingAsync

public Task enableLocalStorageCachingAsync(Connection c)
                                    throws Types.BadServerResponse,
                                           Types.XenAPIException,
                                           org.apache.xmlrpc.XmlRpcException
This call attempts to enable pool-wide local storage caching

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

enableLocalStorageCaching

public void enableLocalStorageCaching(Connection c)
                               throws Types.BadServerResponse,
                                      Types.XenAPIException,
                                      org.apache.xmlrpc.XmlRpcException
This call attempts to enable pool-wide local storage caching

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

disableLocalStorageCachingAsync

public Task disableLocalStorageCachingAsync(Connection c)
                                     throws Types.BadServerResponse,
                                            Types.XenAPIException,
                                            org.apache.xmlrpc.XmlRpcException
This call disables pool-wide local storage caching

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

disableLocalStorageCaching

public void disableLocalStorageCaching(Connection c)
                                throws Types.BadServerResponse,
                                       Types.XenAPIException,
                                       org.apache.xmlrpc.XmlRpcException
This call disables pool-wide local storage caching

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

getAll

public static java.util.Set<Pool> getAll(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException
Return a list of all the pools known to the system.

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

getAllRecords

public static java.util.Map<Pool,Pool.Record> getAllRecords(Connection c)
                                                     throws Types.BadServerResponse,
                                                            Types.XenAPIException,
                                                            org.apache.xmlrpc.XmlRpcException
Return a map of pool references to pool records for all pools known to the system.

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