com.xensource.xenapi

Class ClusterHost

java.lang.Object

com.xensource.xenapi.XenAPIObject

com.xensource.xenapi.ClusterHost

public class ClusterHost
extends XenAPIObject

Cluster member metadata

Nested Class Summary

Nested Classes

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

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
static ClusterHost	create(Connection c, Cluster cluster, Host host, PIF pif) Add a new host to an existing cluster.
static Task	createAsync(Connection c, Cluster cluster, Host host, PIF pif) Add a new host to an existing cluster.
void	destroy(Connection c) Remove a host from an existing cluster.
Task	destroyAsync(Connection c) Remove a host from an existing cluster.
void	disable(Connection c) Disable cluster membership for an enabled cluster host.
Task	disableAsync(Connection c) Disable cluster membership for an enabled cluster host.
void	enable(Connection c) Enable cluster membership for a disabled cluster host.
Task	enableAsync(Connection c) Enable cluster membership for a disabled cluster host.
boolean	equals(java.lang.Object obj) If obj is a ClusterHost, compares XenAPI references for equality.
void	forceDestroy(Connection c) Remove a host from an existing cluster forcefully.
Task	forceDestroyAsync(Connection c) Remove a host from an existing cluster forcefully.
static java.util.Set<ClusterHost>	getAll(Connection c) Return a list of all the Cluster_hosts known to the system.
java.util.Set<Types.ClusterHostOperation>	getAllowedOperations(Connection c) Get the allowed_operations field of the given Cluster_host.
static java.util.Map<ClusterHost,ClusterHost.Record>	getAllRecords(Connection c) Return a map of Cluster_host references to Cluster_host records for all Cluster_hosts known to the system.
static ClusterHost	getByUuid(Connection c, java.lang.String uuid) Get a reference to the Cluster_host instance with the specified UUID.
Cluster	getCluster(Connection c) Get the cluster field of the given Cluster_host.
java.util.Map<java.lang.String,Types.ClusterHostOperation>	getCurrentOperations(Connection c) Get the current_operations field of the given Cluster_host.
java.lang.Boolean	getEnabled(Connection c) Get the enabled field of the given Cluster_host.
Host	getHost(Connection c) Get the host field of the given Cluster_host.
java.lang.Boolean	getJoined(Connection c) Get the joined field of the given Cluster_host.
java.util.Map<java.lang.String,java.lang.String>	getOtherConfig(Connection c) Get the other_config field of the given Cluster_host.
PIF	getPIF(Connection c) Get the PIF field of the given Cluster_host.
ClusterHost.Record	getRecord(Connection c) Get a record containing the current state of the given Cluster_host.
java.lang.String	getUuid(Connection c) Get the uuid field of the given Cluster_host.
int	hashCode()
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 ClusterHost, 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 ClusterHost.Record getRecord(Connection c)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Get a record containing the current state of the given Cluster_host. 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 ClusterHost getByUuid(Connection c,
                    java.lang.String uuid)
                             throws Types.BadServerResponse,
                                    Types.XenAPIException,
                                    org.apache.xmlrpc.XmlRpcException

Get a reference to the Cluster_host 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_host. Experimental. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCluster

public Cluster getCluster(Connection c)
                   throws Types.BadServerResponse,
                          Types.XenAPIException,
                          org.apache.xmlrpc.XmlRpcException

Get the cluster field of the given Cluster_host. Experimental. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getHost

public Host getHost(Connection c)
             throws Types.BadServerResponse,
                    Types.XenAPIException,
                    org.apache.xmlrpc.XmlRpcException

Get the host field of the given Cluster_host. Experimental. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getEnabled

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

Get the enabled field of the given Cluster_host. Experimental. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getPIF

public PIF getPIF(Connection c)
           throws Types.BadServerResponse,
                  Types.XenAPIException,
                  org.apache.xmlrpc.XmlRpcException

Get the PIF field of the given Cluster_host. Experimental. First published in XenServer 7.5.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getJoined

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

Get the joined field of the given Cluster_host. 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.ClusterHostOperation> getAllowedOperations(Connection c)
                                                               throws Types.BadServerResponse,
                                                                      Types.XenAPIException,
                                                                      org.apache.xmlrpc.XmlRpcException

Get the allowed_operations field of the given Cluster_host.

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

getCurrentOperations

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

Get the current_operations field of the given Cluster_host.

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

Returns:

value of the field

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

createAsync

public static Task createAsync(Connection c,
               Cluster cluster,
               Host host,
               PIF pif)
                        throws Types.BadServerResponse,
                               Types.XenAPIException,
                               org.apache.xmlrpc.XmlRpcException,
                               Types.PifNotAttachedToHost,
                               Types.NoClusterHostsReachable

Add a new host to an existing cluster. Experimental. First published in XenServer 7.5.

Parameters:

cluster - Cluster to join

host - new cluster member

pif - Network interface to use for communication

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.PifNotAttachedToHost

Types.NoClusterHostsReachable

create

public static ClusterHost create(Connection c,
                 Cluster cluster,
                 Host host,
                 PIF pif)
                          throws Types.BadServerResponse,
                                 Types.XenAPIException,
                                 org.apache.xmlrpc.XmlRpcException,
                                 Types.PifNotAttachedToHost,
                                 Types.NoClusterHostsReachable

Add a new host to an existing cluster. Experimental. First published in XenServer 7.5.

Parameters:

cluster - Cluster to join

host - new cluster member

pif - Network interface to use for communication

Returns:

the newly created cluster_host object

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.PifNotAttachedToHost

Types.NoClusterHostsReachable

destroyAsync

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

Remove a host from an existing 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

destroy

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

Remove a host from an existing cluster. Experimental. First published in XenServer 7.5.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterStackInUse

Types.ClusteringDisabled

Types.ClusterHostIsLast

enableAsync

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

Enable cluster membership for a disabled cluster host. Experimental. First published in XenServer 7.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.PifAllowsUnplug

Types.RequiredPifIsUnplugged

enable

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

Enable cluster membership for a disabled cluster host. Experimental. First published in XenServer 7.5.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.PifAllowsUnplug

Types.RequiredPifIsUnplugged

forceDestroyAsync

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

Remove a host from an existing cluster forcefully. Experimental. First published in XenServer 7.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterStackInUse

forceDestroy

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

Remove a host from an existing cluster forcefully. Experimental. First published in XenServer 7.5.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterStackInUse

disableAsync

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

Disable cluster membership for an enabled cluster host. Experimental. First published in XenServer 7.5.

Returns:

Task

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterStackInUse

disable

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

Disable cluster membership for an enabled cluster host. Experimental. First published in XenServer 7.5.

Throws:

Types.BadServerResponse

Types.XenAPIException

org.apache.xmlrpc.XmlRpcException

Types.ClusterStackInUse

getAll

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

Return a list of all the Cluster_hosts 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<ClusterHost,ClusterHost.Record> getAllRecords(Connection c)
                                                                   throws Types.BadServerResponse,
                                                                          Types.XenAPIException,
                                                                          org.apache.xmlrpc.XmlRpcException

Return a map of Cluster_host references to Cluster_host records for all Cluster_hosts 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