com.vmware.vcenter.vcha.cluster

Interface Witness

All Superinterfaces:

Service, WitnessTypes

All Known Implementing Classes:

WitnessStub

public interface Witness
extends Service, WitnessTypes

The Witness interface provides methods to validate a witness's placement configuration and redeploy the witness node in a vCenter High Availability (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.WitnessTypes

WitnessTypes.CheckResult, WitnessTypes.CheckSpec, WitnessTypes.RedeploySpec

Method Summary

Methods

Modifier and Type	Method and Description
WitnessTypes.CheckResult	check(WitnessTypes.CheckSpec spec) Validates the specified witness node's placement configuration.
void	check(WitnessTypes.CheckSpec spec, AsyncCallback<WitnessTypes.CheckResult> asyncCallback) Validates the specified witness node's placement configuration.
void	check(WitnessTypes.CheckSpec spec, AsyncCallback<WitnessTypes.CheckResult> asyncCallback, InvocationConfig invocationConfig) Validates the specified witness node's placement configuration.
WitnessTypes.CheckResult	check(WitnessTypes.CheckSpec spec, InvocationConfig invocationConfig) Validates the specified witness node's placement configuration.
java.lang.String	redeploy_Task(WitnessTypes.RedeploySpec spec) Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.
java.lang.String	redeploy_Task(WitnessTypes.RedeploySpec spec, InvocationConfig invocationConfig) Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node.

Method Detail

check

WitnessTypes.CheckResult check(WitnessTypes.CheckSpec spec)

Validates the specified witness node's placement configuration. 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:

spec - Contains the witness node's placement specification.

Returns:

CheckResult structure containing errors and warnings.

Throws:

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

InvalidArgument - If the specified resource spec is deemed invalid for the clone operation.

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.

NotFound - If the active virtual machine is not managed by the specified vCenter server for the active node.

InvalidElementConfiguration - If the active node is on more than one datastore.

NotAllowedInCurrentState - If the clone operation is not allowed in the current state of the system.

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

Error - If any other error occurs.

check

WitnessTypes.CheckResult check(WitnessTypes.CheckSpec spec,
                             InvocationConfig invocationConfig)

Validates the specified witness node's placement configuration. 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:

spec - Contains the witness node's placement specification.

invocationConfig - Configuration for the method invocation.

Returns:

CheckResult structure containing errors and warnings.

Throws:

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

InvalidArgument - If the specified resource spec is deemed invalid for the clone operation.

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.

NotFound - If the active virtual machine is not managed by the specified vCenter server for the active node.

InvalidElementConfiguration - If the active node is on more than one datastore.

NotAllowedInCurrentState - If the clone operation is not allowed in the current state of the system.

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

Error - If any other error occurs.

check

void check(WitnessTypes.CheckSpec spec,
         AsyncCallback<WitnessTypes.CheckResult> asyncCallback)

Validates the specified witness node's placement configuration. 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:
CheckResult structure containing errors and warnings.

Operation Errors:
InvalidArgument - If the credentials provided for authentincating with the active node's management vCenter server are invalid.
InvalidArgument - If the specified resource spec is deemed invalid for the clone operation.
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.
NotFound - If the active virtual machine is not managed by the specified vCenter server for the active node.
InvalidElementConfiguration - If the active node is on more than one datastore.
NotAllowedInCurrentState - If the clone operation is not allowed in the current state of the system.
Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
Error - If any other error occurs.

Parameters:

spec - Contains the witness node's placement specification.

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

check

void check(WitnessTypes.CheckSpec spec,
         AsyncCallback<WitnessTypes.CheckResult> asyncCallback,
         InvocationConfig invocationConfig)

Validates the specified witness node's placement configuration. 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:
CheckResult structure containing errors and warnings.

Operation Errors:
InvalidArgument - If the credentials provided for authentincating with the active node's management vCenter server are invalid.
InvalidArgument - If the specified resource spec is deemed invalid for the clone operation.
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.
NotFound - If the active virtual machine is not managed by the specified vCenter server for the active node.
InvalidElementConfiguration - If the active node is on more than one datastore.
NotAllowedInCurrentState - If the clone operation is not allowed in the current state of the system.
Unauthorized - If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
Error - If any other error occurs.

Parameters:

spec - Contains the witness node's placement specification.

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

invocationConfig - Configuration for the method invocation.

redeploy_Task

java.lang.String redeploy_Task(WitnessTypes.RedeploySpec spec)

Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node. 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 witness node's redeploy specification.

Throws:

InvalidArgument - If the credentials provided for authentincating 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.

redeploy_Task

java.lang.String redeploy_Task(WitnessTypes.RedeploySpec spec,
                             InvocationConfig invocationConfig)

Creates the witness node in a degraded cluster with node location information and pre-existing VCHA cluster configuration from the active node. 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 witness node's redeploy specification.

invocationContext - Information about a method invocation.

Throws:

InvalidArgument - If the credentials provided for authentincating 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.