com.xensource.xenapi

Class Cluster

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.Cluster

public class Cluster
extends XenAPIObject

Cluster-wide Cluster metadata

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Cluster.Record Represents all the fields in a Cluster

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	ref The XenAPI reference (OpaqueRef) to this object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToOtherConfig(Connection c, java.lang.String key, java.lang.String value) Add the given key-value pair to the other_config field of the given Cluster.
static Cluster	create(Connection c, PIF PIF, java.lang.String clusterStack, java.lang.Boolean poolAutoJoin, java.lang.Double tokenTimeout, java.lang.Double tokenTimeoutCoefficient) Creates a Cluster object and one Cluster_host object as its first member Experimental.
static Task	createAsync(Connection c, PIF PIF, java.lang.String clusterStack, java.lang.Boolean poolAutoJoin, java.lang.Double tokenTimeout, java.lang.Double tokenTimeoutCoefficient) Creates a Cluster object and one Cluster_host object as its first member Experimental.
void	destroy(Connection c) Destroys a Cluster object and the one remaining Cluster_host member Experimental.
Task	destroyAsync(Connection c) Destroys a Cluster object and the one remaining Cluster_host member Experimental.
boolean	equals(java.lang.Object obj) If obj is a Cluster, compares XenAPI references for equality.
static java.util.Set<Cluster>	getAll(Connection c) Return a list of all the Clusters known to the system.
java.util.Set<Types.ClusterOperation>	getAllowedOperations(Connection c) Get the allowed_operations field of the given Cluster.
static java.util.Map<Cluster,Cluster.Record>	getAllRecords(Connection c) Return a map of Cluster references to Cluster records for all Clusters known to the system.
static Cluster	getByUuid(Connection c, java.lang.String uuid) Get a reference to the Cluster instance with the specified UUID.
java.util.Map<java.lang.String,java.lang.String>	getClusterConfig(Connection c) Get the cluster_config field of the given Cluster.
java.util.Set<ClusterHost>	getClusterHosts(Connection c) Get the cluster_hosts field of the given Cluster.
java.lang.String	getClusterStack(Connection c) Get the cluster_stack field of the given Cluster.
java.lang.String	getClusterToken(Connection c) Get the cluster_token field of the given Cluster.
java.util.Map<java.lang.String,Types.ClusterOperation>	getCurrentOperations(Connection c) Get the current_operations field of the given Cluster.
Network	getNetwork(Connection c) Returns the network used by the cluster for inter-host communication, i.e.
Task	getNetworkAsync(Connection c) Returns the network used by the cluster for inter-host communication, i.e.
java.util.Map<java.lang.String,java.lang.String>	getOtherConfig(Connection c) Get the other_config field of the given Cluster.
java.util.Set<java.lang.String>	getPendingForget(Connection c) Get the pending_forget field of the given Cluster.
java.lang.Boolean	getPoolAutoJoin(Connection c) Get the pool_auto_join field of the given Cluster.
Cluster.Record	getRecord(Connection c) Get a record containing the current state of the given Cluster.
java.lang.Double	getTokenTimeout(Connection c) Get the token_timeout field of the given Cluster.
java.lang.Double	getTokenTimeoutCoefficient(Connection c) Get the token_timeout_coefficient field of the given Cluster.
java.lang.String	getUuid(Connection c) Get the uuid field of the given Cluster.
int	hashCode()
static Cluster	poolCreate(Connection c, Network network, java.lang.String clusterStack, java.lang.Double tokenTimeout, java.lang.Double tokenTimeoutCoefficient) Attempt to create a Cluster from the entire pool Experimental.
static Task	poolCreateAsync(Connection c, Network network, java.lang.String clusterStack, java.lang.Double tokenTimeout, java.lang.Double tokenTimeoutCoefficient) Attempt to create a Cluster from the entire pool Experimental.
void	poolDestroy(Connection c) Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster.
Task	poolDestroyAsync(Connection c) Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster.
void	poolForceDestroy(Connection c) Attempt to force destroy the Cluster_host objects, and then destroy the Cluster.
Task	poolForceDestroyAsync(Connection c) Attempt to force destroy the Cluster_host objects, and then destroy the Cluster.
void	poolResync(Connection c) Resynchronise the cluster_host objects across the pool.
Task	poolResyncAsync(Connection c) Resynchronise the cluster_host objects across the 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 Cluster.
void	setOtherConfig(Connection c, java.util.Map<java.lang.String,java.lang.String> otherConfig) Set the other_config field of the given Cluster.
java.lang.String	toWireString()

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 Cluster, 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 Cluster.Record getRecord(Connection c)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given Cluster. Experimental. First published in XenServer 7.5.

Returns:

all fields from the object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getByUuid

public static Cluster getByUuid(Connection c,
                java.lang.String uuid)
                         throws Types.BadServerResponse,
                                Types.XenAPIException,
                                org.apache.xmlrpc.XmlRpcException

Get a reference to the Cluster instance with the specified UUID. Experimental. First published in XenServer 7.5.

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 Cluster. Experimental. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getClusterHosts

public java.util.Set<ClusterHost> getClusterHosts(Connection c)
                                           throws Types.BadServerResponse,
                                                  Types.XenAPIException,
                                                  org.apache.xmlrpc.XmlRpcException

Get the cluster_hosts field of the given Cluster. Experimental. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPendingForget

public java.util.Set<java.lang.String> getPendingForget(Connection c)
                                                 throws Types.BadServerResponse,
                                                        Types.XenAPIException,
                                                        org.apache.xmlrpc.XmlRpcException

Get the pending_forget field of the given Cluster. Experimental. First published in XenServer 7.6.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getClusterToken

public java.lang.String getClusterToken(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get the cluster_token field of the given Cluster. Experimental. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getClusterStack

public java.lang.String getClusterStack(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get the cluster_stack field of the given Cluster. Experimental. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllowedOperations

public java.util.Set<Types.ClusterOperation> getAllowedOperations(Connection c)
                                                           throws Types.BadServerResponse,
                                                                  Types.XenAPIException,
                                                                  org.apache.xmlrpc.XmlRpcException

Get the allowed_operations field of the given Cluster.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCurrentOperations

public java.util.Map<java.lang.String,Types.ClusterOperation> getCurrentOperations(Connection c)
                                                                            throws Types.BadServerResponse,
                                                                                   Types.XenAPIException,
                                                                                   org.apache.xmlrpc.XmlRpcException

Get the current_operations field of the given Cluster.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPoolAutoJoin

public java.lang.Boolean getPoolAutoJoin(Connection c)
                                  throws Types.BadServerResponse,
                                         Types.XenAPIException,
                                         org.apache.xmlrpc.XmlRpcException

Get the pool_auto_join field of the given Cluster. Experimental. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getTokenTimeout

public java.lang.Double getTokenTimeout(Connection c)
                                 throws Types.BadServerResponse,
                                        Types.XenAPIException,
                                        org.apache.xmlrpc.XmlRpcException

Get the token_timeout field of the given Cluster.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getTokenTimeoutCoefficient

public java.lang.Double getTokenTimeoutCoefficient(Connection c)
                                            throws Types.BadServerResponse,
                                                   Types.XenAPIException,
                                                   org.apache.xmlrpc.XmlRpcException

Get the token_timeout_coefficient field of the given Cluster.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getClusterConfig

public java.util.Map<java.lang.String,java.lang.String> getClusterConfig(Connection c)
                                                                  throws Types.BadServerResponse,
                                                                         Types.XenAPIException,
                                                                         org.apache.xmlrpc.XmlRpcException

Get the cluster_config field of the given Cluster. Experimental. First published in XenServer 7.5.

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 Cluster. Experimental. First published in XenServer 7.5.

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 Cluster. Experimental. First published in XenServer 7.5.

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 Cluster. Experimental. First published in XenServer 7.5.

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

Parameters:

key - Key to remove

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               PIF PIF,
               java.lang.String clusterStack,
               java.lang.Boolean poolAutoJoin,
               java.lang.Double tokenTimeout,
               java.lang.Double tokenTimeoutCoefficient)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException,
                               Types.InvalidClusterStack,
                               Types.InvalidValue,
                               Types.PifAllowsUnplug,
                               Types.RequiredPifIsUnplugged

Creates a Cluster object and one Cluster_host object as its first member Experimental. First published in XenServer 7.5.

Parameters:

PIF - The PIF to connect the cluster's first cluster_host to

clusterStack - simply the string 'corosync'. No other cluster stacks are currently supported

poolAutoJoin - true if xapi is automatically joining new pool members to the cluster

tokenTimeout - Corosync token timeout in seconds

tokenTimeoutCoefficient - Corosync token timeout coefficient in seconds

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.InvalidClusterStack

Types.InvalidValue

Types.PifAllowsUnplug

Types.RequiredPifIsUnplugged

create

public static Cluster create(Connection c,
             PIF PIF,
             java.lang.String clusterStack,
             java.lang.Boolean poolAutoJoin,
             java.lang.Double tokenTimeout,
             java.lang.Double tokenTimeoutCoefficient)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException,
                             Types.InvalidClusterStack,
                             Types.InvalidValue,
                             Types.PifAllowsUnplug,
                             Types.RequiredPifIsUnplugged

Creates a Cluster object and one Cluster_host object as its first member Experimental. First published in XenServer 7.5.

Parameters:

PIF - The PIF to connect the cluster's first cluster_host to

clusterStack - simply the string 'corosync'. No other cluster stacks are currently supported

poolAutoJoin - true if xapi is automatically joining new pool members to the cluster

tokenTimeout - Corosync token timeout in seconds

tokenTimeoutCoefficient - Corosync token timeout coefficient in seconds

Returns:

the new Cluster

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.InvalidClusterStack

Types.InvalidValue

Types.PifAllowsUnplug

Types.RequiredPifIsUnplugged

destroyAsync

public Task destroyAsync(Connection c)
                  throws Types.BadServerResponse,
                         Types.XenAPIException,
                         org.apache.xmlrpc.XmlRpcException,
                         Types.ClusterDoesNotHaveOneNode,
                         Types.ClusterStackInUse

Destroys a Cluster object and the one remaining Cluster_host member Experimental. First published in XenServer 7.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterDoesNotHaveOneNode

Types.ClusterStackInUse

destroy

public void destroy(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException,
                    Types.ClusterDoesNotHaveOneNode,
                    Types.ClusterStackInUse

Destroys a Cluster object and the one remaining Cluster_host member Experimental. First published in XenServer 7.5.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterDoesNotHaveOneNode

Types.ClusterStackInUse

getNetworkAsync

public Task getNetworkAsync(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Returns the network used by the cluster for inter-host communication, i.e. the network shared by all cluster host PIFs Experimental. First published in XenServer 7.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getNetwork

public Network getNetwork(Connection c)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Returns the network used by the cluster for inter-host communication, i.e. the network shared by all cluster host PIFs Experimental. First published in XenServer 7.5.

Returns:

network of cluster

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

poolCreateAsync

public static Task poolCreateAsync(Connection c,
                   Network network,
                   java.lang.String clusterStack,
                   java.lang.Double tokenTimeout,
                   java.lang.Double tokenTimeoutCoefficient)
                            throws Types.BadServerResponse,
                                   Types.XenAPIException,
                                   org.apache.xmlrpc.XmlRpcException

Attempt to create a Cluster from the entire pool Experimental. First published in XenServer 7.5.

Parameters:

network - the single network on which corosync carries out its inter-host communications

clusterStack - simply the string 'corosync'. No other cluster stacks are currently supported

tokenTimeout - Corosync token timeout in seconds

tokenTimeoutCoefficient - Corosync token timeout coefficient in seconds

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

poolCreate

public static Cluster poolCreate(Connection c,
                 Network network,
                 java.lang.String clusterStack,
                 java.lang.Double tokenTimeout,
                 java.lang.Double tokenTimeoutCoefficient)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException

Attempt to create a Cluster from the entire pool Experimental. First published in XenServer 7.5.

Parameters:

network - the single network on which corosync carries out its inter-host communications

clusterStack - simply the string 'corosync'. No other cluster stacks are currently supported

tokenTimeout - Corosync token timeout in seconds

tokenTimeoutCoefficient - Corosync token timeout coefficient in seconds

Returns:

the new Cluster

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

poolForceDestroyAsync

public Task poolForceDestroyAsync(Connection c)
                           throws Types.BadServerResponse,
                                  Types.XenAPIException,
                                  org.apache.xmlrpc.XmlRpcException,
                                  Types.ClusterForceDestroyFailed

Attempt to force destroy the Cluster_host objects, and then destroy the Cluster. Experimental. First published in XenServer 7.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterForceDestroyFailed

poolForceDestroy

public void poolForceDestroy(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException,
                             Types.ClusterForceDestroyFailed

Attempt to force destroy the Cluster_host objects, and then destroy the Cluster. Experimental. First published in XenServer 7.5.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterForceDestroyFailed

poolDestroyAsync

public Task poolDestroyAsync(Connection c)
                      throws Types.BadServerResponse,
                             Types.XenAPIException,
                             org.apache.xmlrpc.XmlRpcException,
                             Types.ClusterStackInUse,
                             Types.ClusteringDisabled,
                             Types.ClusterHostIsLast

Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster. Experimental. First published in XenServer 7.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterStackInUse

Types.ClusteringDisabled

Types.ClusterHostIsLast

poolDestroy

public void poolDestroy(Connection c)
                 throws Types.BadServerResponse,
                        Types.XenAPIException,
                        org.apache.xmlrpc.XmlRpcException,
                        Types.ClusterStackInUse,
                        Types.ClusteringDisabled,
                        Types.ClusterHostIsLast

Attempt to destroy the Cluster_host objects for all hosts in the pool and then destroy the Cluster. Experimental. First published in XenServer 7.5.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterStackInUse

Types.ClusteringDisabled

Types.ClusterHostIsLast

poolResyncAsync

public Task poolResyncAsync(Connection c)
                     throws Types.BadServerResponse,
                            Types.XenAPIException,
                            org.apache.xmlrpc.XmlRpcException

Resynchronise the cluster_host objects across the pool. Creates them where they need creating and then plugs them Experimental. First published in XenServer 7.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

poolResync

public void poolResync(Connection c)
                throws Types.BadServerResponse,
                       Types.XenAPIException,
                       org.apache.xmlrpc.XmlRpcException

Resynchronise the cluster_host objects across the pool. Creates them where they need creating and then plugs them Experimental. First published in XenServer 7.5.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAll

public static java.util.Set<Cluster> getAll(Connection c)
                                     throws Types.BadServerResponse,
                                            Types.XenAPIException,
                                            org.apache.xmlrpc.XmlRpcException

Return a list of all the Clusters known to the system. Experimental. First published in XenServer 7.5.

Returns:

references to all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getAllRecords

public static java.util.Map<Cluster,Cluster.Record> getAllRecords(Connection c)
                                                           throws Types.BadServerResponse,
                                                                  Types.XenAPIException,
                                                                  org.apache.xmlrpc.XmlRpcException

Return a map of Cluster references to Cluster records for all Clusters known to the system. Experimental. First published in XenServer 7.5.

Returns:

records of all objects

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException