com.vmware.vcenter.vcha.cluster

Interface Mode

All Superinterfaces:

ModeTypes, Service

All Known Implementing Classes:

ModeStub

public interface Mode
extends Service, ModeTypes

The Mode interface provides methods to manage the operating mode of a vCenter High Availability Cluster (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.cluster.ModeTypes

ModeTypes.ClusterMode, ModeTypes.Info

Method Summary

Methods

Modifier and Type	Method and Description
ModeTypes.Info	get() Retrieves the current mode of a VCHA cluster.
void	get(AsyncCallback<ModeTypes.Info> asyncCallback) Retrieves the current mode of a VCHA cluster.
void	get(AsyncCallback<ModeTypes.Info> asyncCallback, InvocationConfig invocationConfig) Retrieves the current mode of a VCHA cluster.
ModeTypes.Info	get(InvocationConfig invocationConfig) Retrieves the current mode of a VCHA cluster.
java.lang.String	set_Task(ModeTypes.ClusterMode mode) Manipulates the mode of a VCHA Cluster.
java.lang.String	set_Task(ModeTypes.ClusterMode mode, InvocationConfig invocationConfig) Manipulates the mode of a VCHA Cluster.

Method Detail

get

ModeTypes.Info get()

Retrieves the current mode 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.

Returns:

Info structure containing the mode of the the VCHA cluster.

Throws:

NotAllowedInCurrentState - If the VCHA cluster is not configured.

Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.

Error - If any other error occurs.

get

ModeTypes.Info get(InvocationConfig invocationConfig)

Retrieves the current mode 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:

invocationConfig - Configuration for the method invocation.

Returns:

Info structure containing the mode of the the VCHA cluster.

Throws:

NotAllowedInCurrentState - If the VCHA cluster is not configured.

Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.

Error - If any other error occurs.

get

void get(AsyncCallback<ModeTypes.Info> asyncCallback)

Retrieves the current mode 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 mode of the the VCHA cluster.

Operation Errors:
NotAllowedInCurrentState - If the VCHA cluster is not configured.
Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
Error - If any other error occurs.

Parameters:

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

get

void get(AsyncCallback<ModeTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Retrieves the current mode 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 mode of the the VCHA cluster.

Operation Errors:
NotAllowedInCurrentState - If the VCHA cluster is not configured.
Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the System.Read privilege.
Error - If any other error occurs.

Parameters:

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

invocationConfig - Configuration for the method invocation.

set_Task

java.lang.String set_Task(ModeTypes.ClusterMode mode)

Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed:
enabled -> disabled - Allowed only in healthy and degraded states.
enabled -> maintenance - Allowed only in healthy state.
disabled -> enabled - Allowed only in healthy state.
maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version.
maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version.
All other transitions are not allowed.

VCHA Cluster configuration remains intact in any of the cluster modes.

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

mode - Clustermode to change the VCHA cluster mode to.

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.

set_Task

java.lang.String set_Task(ModeTypes.ClusterMode mode,
                        InvocationConfig invocationConfig)

Manipulates the mode of a VCHA Cluster. Following mode transitions are allowed:
enabled -> disabled - Allowed only in healthy and degraded states.
enabled -> maintenance - Allowed only in healthy state.
disabled -> enabled - Allowed only in healthy state.
maintenance -> enabled - Allowed only in healthy state with all nodes are running the same version.
maintenance -> disabled - Allowed only in healthy state with all nodes are running the same version.
All other transitions are not allowed.

VCHA Cluster configuration remains intact in any of the cluster modes.

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

mode - Clustermode to change the VCHA cluster mode to.

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.