com.vmware.vcenter.vcha.cluster

Class PassiveStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vcha.cluster.PassiveStub

All Implemented Interfaces:

Service, Passive, PassiveTypes

public class PassiveStub
extends com.vmware.vapi.internal.bindings.Stub
implements Passive

Remote stub implementation of the Passive API service.

WARNING: Internal class, subject to change in future versions.

Nested Class Summary

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

PassiveTypes.CheckResult, PassiveTypes.CheckSpec, PassiveTypes.RedeploySpec

Field Summary

Fields inherited from class com.vmware.vapi.internal.bindings.Stub

apiProvider, converter, ifaceId, securityContext

Constructor Summary

Constructors

Constructor and Description
PassiveStub(ApiProvider apiProvider, StubConfigurationBase config)
PassiveStub(ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, StubConfigurationBase config)

Method Summary

Methods

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

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

invokeMethod, invokeMethodAsync, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PassiveStub

public PassiveStub(ApiProvider apiProvider,
           com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
           StubConfigurationBase config)

PassiveStub

public PassiveStub(ApiProvider apiProvider,
           StubConfigurationBase config)

Method Detail

check

public PassiveTypes.CheckResult check(PassiveTypes.CheckSpec spec)

Description copied from interface: Passive

Validates the specified passive 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.

Specified by:

check in interface Passive

Parameters:

spec - Contains the passive node's placement specification.

Returns:

CheckResult structure containing errors and warnings.

check

public PassiveTypes.CheckResult check(PassiveTypes.CheckSpec spec,
                             InvocationConfig invocationConfig)

Description copied from interface: Passive

Validates the specified passive 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.

Specified by:

check in interface Passive

Parameters:

spec - Contains the passive node's placement specification.

invocationConfig - Configuration for the method invocation.

Returns:

CheckResult structure containing errors and warnings.

check

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

Description copied from interface: Passive

Validates the specified passive 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.

Specified by:

check in interface Passive

Parameters:

spec - Contains the passive node's placement specification.

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

check

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

Description copied from interface: Passive

Validates the specified passive 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.

Specified by:

check in interface Passive

Parameters:

spec - Contains the passive node's placement specification.

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

invocationConfig - Configuration for the method invocation.

redeploy_Task

public java.lang.String redeploy_Task(PassiveTypes.RedeploySpec spec)

Description copied from interface: Passive

Creates the passive 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.

Specified by:

redeploy_Task in interface Passive

Parameters:

spec - Contains the passive node's redeploy specification.

redeploy_Task

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

Description copied from interface: Passive

Creates the passive 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.

Specified by:

redeploy_Task in interface Passive

Parameters:

spec - Contains the passive node's redeploy specification.