com.vmware.vcenter.vcha

Interface Cluster

All Superinterfaces:

ClusterTypes, Service

All Known Implementing Classes:

ClusterStub

public interface Cluster
extends Service, ClusterTypes

The Cluster interface provides methods to deploy and undeploy a vCenter High Availability (VCHA) cluster, failover from the active VCHA node to the passive VCHA node, and retrieve the status of the VCHA cluster. This interface was added in vSphere API 6.7 U1.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vcha.ClusterTypes

ClusterTypes.ActiveSpec, ClusterTypes.ClusterMode, ClusterTypes.ClusterState, ClusterTypes.ConfigState, ClusterTypes.DeploySpec, ClusterTypes.ErrorCondition, ClusterTypes.Info, ClusterTypes.IpFamily, ClusterTypes.IpInfo, ClusterTypes.Ipv4Info, ClusterTypes.Ipv6Info, ClusterTypes.NodeInfo, ClusterTypes.NodeRole, ClusterTypes.NodeRuntimeInfo, ClusterTypes.NodeState, ClusterTypes.NodeVmInfo, ClusterTypes.PassiveSpec, ClusterTypes.Type, ClusterTypes.UndeploySpec, ClusterTypes.VmInfo, ClusterTypes.WitnessInfo, ClusterTypes.WitnessSpec

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	deploy_Task(ClusterTypes.DeploySpec spec) Prepares, clones, and configures a VCHA cluster.
java.lang.String	deploy_Task(ClusterTypes.DeploySpec spec, InvocationConfig invocationConfig) Prepares, clones, and configures a VCHA cluster.
java.lang.String	failover_Task(boolean planned) Initiates failover from the active vCenter node to the passive node.
java.lang.String	failover_Task(boolean planned, InvocationConfig invocationConfig) Initiates failover from the active vCenter node to the passive node.
ClusterTypes.Info	get(CredentialsSpec vcSpec, java.lang.Boolean partial) Retrieves the status of a VCHA cluster.
void	get(CredentialsSpec vcSpec, java.lang.Boolean partial, AsyncCallback<ClusterTypes.Info> asyncCallback) Retrieves the status of a VCHA cluster.
void	get(CredentialsSpec vcSpec, java.lang.Boolean partial, AsyncCallback<ClusterTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves the status of a VCHA cluster.
ClusterTypes.Info	get(CredentialsSpec vcSpec, java.lang.Boolean partial, InvocationConfig invocationConfig) Retrieves the status of a VCHA cluster.
java.lang.String	undeploy_Task(ClusterTypes.UndeploySpec spec) Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance.
java.lang.String	undeploy_Task(ClusterTypes.UndeploySpec spec, InvocationConfig invocationConfig) Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance.

Method Detail

deploy_Task

java.lang.String deploy_Task(ClusterTypes.DeploySpec spec)

Prepares, clones, and configures a VCHA cluster. This method was added in vSphere API 6.7 U1.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Parameters:

spec - Contains the deploy specification for all three nodes of a VCHA cluster.

Throws:

InvalidArgument - If the credentials provided for authenticating with the active node's management vCenter server are invalid.

Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.

UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.

Error - If any other error occurs.

deploy_Task

java.lang.String deploy_Task(ClusterTypes.DeploySpec spec,
                           InvocationConfig invocationConfig)

Prepares, clones, and configures a VCHA cluster. This method was added in vSphere API 6.7 U1.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Parameters:

spec - Contains the deploy specification for all three nodes of a VCHA cluster.

invocationContext - Information about a method invocation.

Throws:

InvalidArgument - If the credentials provided for authenticating with the active node's management vCenter server are invalid.

Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.

UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.

Error - If any other error occurs.

failover_Task

java.lang.String failover_Task(boolean planned)

Initiates failover from the active vCenter node to the passive node.

For forced failover, Active node immediately initiates a failover. This may result into a data loss after failover.

For planned failover, Active node flushes all the state to the Passive node, waits for the flush to complete before causing a failover. After the failover, Passive node starts without any data loss.

A failover is allowed only in the following cases:

1. Cluster's mode is enabled and all cluster members are present.
2. Cluster's mode is maintenance and all cluster members are present.

. This method was added in vSphere API 6.7 U1.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Parameters:

planned - If false, a failover is initiated immediately and may result in data loss.
If true, a failover is initated after the Active node flushes its state to Passive and there is no data loss.

Throws:

Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.

Error - If any other error occurs.

failover_Task

java.lang.String failover_Task(boolean planned,
                             InvocationConfig invocationConfig)

Initiates failover from the active vCenter node to the passive node.

For forced failover, Active node immediately initiates a failover. This may result into a data loss after failover.

For planned failover, Active node flushes all the state to the Passive node, waits for the flush to complete before causing a failover. After the failover, Passive node starts without any data loss.

A failover is allowed only in the following cases:

1. Cluster's mode is enabled and all cluster members are present.
2. Cluster's mode is maintenance and all cluster members are present.

. This method was added in vSphere API 6.7 U1.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Parameters:

planned - If false, a failover is initiated immediately and may result in data loss.
If true, a failover is initated after the Active node flushes its state to Passive and there is no data loss.

invocationContext - Information about a method invocation.

Throws:

Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.

Error - If any other error occurs.

get

ClusterTypes.Info get(CredentialsSpec vcSpec,
                    java.lang.Boolean partial)

Retrieves the status of a VCHA cluster. This method was added in vSphere API 6.7 U1.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

vcSpec - Contains active node's management vCenter server credentials. If null, then the active vCenter server is assumed to be managed by itself.

partial - If true, then return only the information that does not require connecting to the Active vCenter Server.
If false or unset, then return all the information. If null, then return all the information.

Returns:

Info structure containing the VCHA configuration and health information.

Throws:

InvalidArgument - If the credentials provided for authenticating with the active node's management vCenter server are invalid.

Unauthorized - If the user has insufficient privilege to perform the operation.

• If partial is false or unset, then the operation execution requires the Global.VCServer privilege.
• If partial is true, then the operation execution requires the System.Read privilege.

UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.

Error - If any other error occurs.

get

ClusterTypes.Info get(CredentialsSpec vcSpec,
                    java.lang.Boolean partial,
                    InvocationConfig invocationConfig)

Retrieves the status of a VCHA cluster. This method was added in vSphere API 6.7 U1.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

vcSpec - Contains active node's management vCenter server credentials. If null, then the active vCenter server is assumed to be managed by itself.

partial - If true, then return only the information that does not require connecting to the Active vCenter Server.
If false or unset, then return all the information. If null, then return all the information.

invocationConfig - Configuration for the method invocation.

Returns:

Info structure containing the VCHA configuration and health information.

Throws:

InvalidArgument - If the credentials provided for authenticating with the active node's management vCenter server are invalid.

Unauthorized - If the user has insufficient privilege to perform the operation.

• If partial is false or unset, then the operation execution requires the Global.VCServer privilege.
• If partial is true, then the operation execution requires the System.Read privilege.

UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.

Error - If any other error occurs.

get

void get(CredentialsSpec vcSpec,
       java.lang.Boolean partial,
       AsyncCallback<ClusterTypes.Info> asyncCallback)

Retrieves the status of a VCHA cluster. This method was added in vSphere API 6.7 U1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Result:
Info structure containing the VCHA configuration and health information.

Operation Errors:
InvalidArgument - If the credentials provided for authenticating with the active node's management vCenter server are invalid.
Unauthorized - If the user has insufficient privilege to perform the operation.

• If partial is false or unset, then the operation execution requires the Global.VCServer privilege.
• If partial is true, then the operation execution requires the System.Read privilege.

UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.
Error - If any other error occurs.

Parameters:

vcSpec - Contains active node's management vCenter server credentials. If null, then the active vCenter server is assumed to be managed by itself.

partial - If true, then return only the information that does not require connecting to the Active vCenter Server.
If false or unset, then return all the information. If null, then return all the information.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(CredentialsSpec vcSpec,
       java.lang.Boolean partial,
       AsyncCallback<ClusterTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Retrieves the status of a VCHA cluster. This method was added in vSphere API 6.7 U1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Result:
Info structure containing the VCHA configuration and health information.

Operation Errors:
InvalidArgument - If the credentials provided for authenticating with the active node's management vCenter server are invalid.
Unauthorized - If the user has insufficient privilege to perform the operation.

• If partial is false or unset, then the operation execution requires the Global.VCServer privilege.
• If partial is true, then the operation execution requires the System.Read privilege.

UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.
Error - If any other error occurs.

Parameters:

vcSpec - Contains active node's management vCenter server credentials. If null, then the active vCenter server is assumed to be managed by itself.

partial - If true, then return only the information that does not require connecting to the Active vCenter Server.
If false or unset, then return all the information. If null, then return all the information.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

undeploy_Task

java.lang.String undeploy_Task(ClusterTypes.UndeploySpec spec)

Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance. Optionally, the passive and witness node virtual machines will be deleted only if VCHA was deployed using automatic deployment. The active node in the cluster continues to run as a standalone VCVA appliance after the destroy operation has been performed.

If the VCHA cluster is in a transition state and not configured, then the VCHA cluster specific information is removed.

. This method was added in vSphere API 6.7 U1.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Parameters:

spec - Contains the undeploy specification for a VCHA cluster.

Throws:

InvalidArgument - If the credentials provided for authenticating with the active node's management vCenter server are invalid.

NotFound - If the passive virtual machine is not managed by the specified vCenter server.

NotFound - If the witness virtual machine is not managed by the specified vCenter server.

Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.

UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.

Error - If any other error occurs.

undeploy_Task

java.lang.String undeploy_Task(ClusterTypes.UndeploySpec spec,
                             InvocationConfig invocationConfig)

Destroys the VCHA cluster and removes all VCHA specific information from the VCVA appliance. Optionally, the passive and witness node virtual machines will be deleted only if VCHA was deployed using automatic deployment. The active node in the cluster continues to run as a standalone VCVA appliance after the destroy operation has been performed.

If the VCHA cluster is in a transition state and not configured, then the VCHA cluster specific information is removed.

. This method was added in vSphere API 6.7 U1.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Parameters:

spec - Contains the undeploy specification for a VCHA cluster.

invocationContext - Information about a method invocation.

Throws:

InvalidArgument - If the credentials provided for authenticating with the active node's management vCenter server are invalid.

NotFound - If the passive virtual machine is not managed by the specified vCenter server.

NotFound - If the witness virtual machine is not managed by the specified vCenter server.

Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.

UnverifiedPeer - If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Error will be a class that contains all the properties defined in CertificateInfo.

Error - If any other error occurs.