com.vmware.esx.settings.clusters.enablement.configuration

Class TransitionStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.esx.settings.clusters.enablement.configuration.TransitionStub

All Implemented Interfaces:

Transition, TransitionTypes, Service

public class TransitionStub
extends com.vmware.vapi.internal.bindings.Stub
implements Transition

Remote stub implementation of the Transition API service.

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.clusters.enablement.configuration.TransitionTypes

TransitionTypes._VAPI_OPERATIONS, TransitionTypes.EligibilityResult, TransitionTypes.EnableResult, TransitionTypes.FileSpec, TransitionTypes.Info, TransitionTypes.ReferenceHost, TransitionTypes.Source, TransitionTypes.State, TransitionTypes.ValidateResult

Field Summary

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

apiProvider, converter, ifaceId, retryPolicy, securityContext

Fields inherited from interface com.vmware.esx.settings.clusters.enablement.configuration.TransitionTypes

_VAPI_SERVICE_ID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	cancel(java.lang.String cluster) This API cancels the workflow to transition the cluster to desired configuration platform.
void	cancel(java.lang.String cluster, AsyncCallback<java.lang.Void> asyncCallback) This API cancels the workflow to transition the cluster to desired configuration platform.
void	cancel(java.lang.String cluster, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) This API cancels the workflow to transition the cluster to desired configuration platform.
void	cancel(java.lang.String cluster, InvocationConfig invocationConfig) This API cancels the workflow to transition the cluster to desired configuration platform.
java.lang.String	checkEligibility_Task(java.lang.String cluster) The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform.
void	checkEligibility_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform.
void	checkEligibility_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform.
java.lang.String	checkEligibility_Task(java.lang.String cluster, InvocationConfig invocationConfig) The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform.
java.lang.String	enable_Task(java.lang.String cluster) The API enables ConfigManager on the cluster.
void	enable_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) The API enables ConfigManager on the cluster.
void	enable_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) The API enables ConfigManager on the cluster.
java.lang.String	enable_Task(java.lang.String cluster, InvocationConfig invocationConfig) The API enables ConfigManager on the cluster.
ExportResult	exportConfig(java.lang.String cluster) This API will export configuration associated with the cluster generated as part of the transition workflow.
void	exportConfig(java.lang.String cluster, AsyncCallback<ExportResult> asyncCallback) This API will export configuration associated with the cluster generated as part of the transition workflow.
void	exportConfig(java.lang.String cluster, AsyncCallback<ExportResult> asyncCallback, InvocationConfig invocationConfig) This API will export configuration associated with the cluster generated as part of the transition workflow.
ExportResult	exportConfig(java.lang.String cluster, InvocationConfig invocationConfig) This API will export configuration associated with the cluster generated as part of the transition workflow.
SchemaResult	exportSchema(java.lang.String cluster) This API will export schema associated with the cluster.
void	exportSchema(java.lang.String cluster, AsyncCallback<SchemaResult> asyncCallback) This API will export schema associated with the cluster.
void	exportSchema(java.lang.String cluster, AsyncCallback<SchemaResult> asyncCallback, InvocationConfig invocationConfig) This API will export schema associated with the cluster.
SchemaResult	exportSchema(java.lang.String cluster, InvocationConfig invocationConfig) This API will export schema associated with the cluster.
TransitionTypes.Info	get(java.lang.String cluster) This API returns the current transition state of the cluster.
void	get(java.lang.String cluster, AsyncCallback<TransitionTypes.Info> asyncCallback) This API returns the current transition state of the cluster.
void	get(java.lang.String cluster, AsyncCallback<TransitionTypes.Info> asyncCallback, InvocationConfig invocationConfig) This API returns the current transition state of the cluster.
TransitionTypes.Info	get(java.lang.String cluster, InvocationConfig invocationConfig) This API returns the current transition state of the cluster.
DraftImportResult	importFromFile(java.lang.String cluster, TransitionTypes.FileSpec spec) The API imports the desired configuration from a file.
void	importFromFile(java.lang.String cluster, TransitionTypes.FileSpec spec, AsyncCallback<DraftImportResult> asyncCallback) The API imports the desired configuration from a file.
void	importFromFile(java.lang.String cluster, TransitionTypes.FileSpec spec, AsyncCallback<DraftImportResult> asyncCallback, InvocationConfig invocationConfig) The API imports the desired configuration from a file.
DraftImportResult	importFromFile(java.lang.String cluster, TransitionTypes.FileSpec spec, InvocationConfig invocationConfig) The API imports the desired configuration from a file.
java.lang.String	importFromHost_Task(java.lang.String cluster, java.lang.String host) The API imports the desired configuration from a reference host in the cluster.
void	importFromHost_Task(java.lang.String cluster, java.lang.String host, AsyncCallback<java.lang.String> asyncCallback) The API imports the desired configuration from a reference host in the cluster.
void	importFromHost_Task(java.lang.String cluster, java.lang.String host, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) The API imports the desired configuration from a reference host in the cluster.
java.lang.String	importFromHost_Task(java.lang.String cluster, java.lang.String host, InvocationConfig invocationConfig) The API imports the desired configuration from a reference host in the cluster.
java.lang.String	precheck_Task(java.lang.String cluster) The API computes impact of transitioning the cluster to be managed by desired configuration platform.
void	precheck_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) The API computes impact of transitioning the cluster to be managed by desired configuration platform.
void	precheck_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) The API computes impact of transitioning the cluster to be managed by desired configuration platform.
java.lang.String	precheck_Task(java.lang.String cluster, InvocationConfig invocationConfig) The API computes impact of transitioning the cluster to be managed by desired configuration platform.
java.lang.String	validateConfig_Task(java.lang.String cluster) The API validates the imported desired configuration against the schema and on the hosts with validation plugins.
void	validateConfig_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) The API validates the imported desired configuration against the schema and on the hosts with validation plugins.
void	validateConfig_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) The API validates the imported desired configuration against the schema and on the hosts with validation plugins.
java.lang.String	validateConfig_Task(java.lang.String cluster, InvocationConfig invocationConfig) The API validates the imported desired configuration against the schema and on the hosts with validation plugins.

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

invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TransitionStub

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

TransitionStub

public TransitionStub(ApiProvider apiProvider,
                      StubConfigurationBase config)

Method Detail

get

public TransitionTypes.Info get(java.lang.String cluster)

Description copied from interface: Transition

This API returns the current transition state of the cluster. This method was added in vSphere API 8.0.1.0.

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

Specified by:

get in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

The transition state of the cluster.

get

public TransitionTypes.Info get(java.lang.String cluster,
                                InvocationConfig invocationConfig)

Description copied from interface: Transition

This API returns the current transition state of the cluster. This method was added in vSphere API 8.0.1.0.

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:

get in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

The transition state of the cluster.

get

public void get(java.lang.String cluster,
                AsyncCallback<TransitionTypes.Info> asyncCallback)

Description copied from interface: Transition

This API returns the current transition state of the cluster. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
The transition state of the cluster.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.View.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Specified by:

get in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

get

public void get(java.lang.String cluster,
                AsyncCallback<TransitionTypes.Info> asyncCallback,
                InvocationConfig invocationConfig)

Description copied from interface: Transition

This API returns the current transition state of the cluster. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
The transition state of the cluster.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.View.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.View.

Specified by:

get in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

checkEligibility_Task

public java.lang.String checkEligibility_Task(java.lang.String cluster)

Description copied from interface: Transition

The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Specified by:

checkEligibility_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

identifier for the task created by this API invocation

checkEligibility_Task

public java.lang.String checkEligibility_Task(java.lang.String cluster,
                                              InvocationConfig invocationConfig)

Description copied from interface: Transition

The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

checkEligibility_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

checkEligibility_Task

public void checkEligibility_Task(java.lang.String cluster,
                                  AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Transition

The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform. This method was added in vSphere API 8.0.1.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

checkEligibility_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

checkEligibility_Task

public void checkEligibility_Task(java.lang.String cluster,
                                  AsyncCallback<java.lang.String> asyncCallback,
                                  InvocationConfig invocationConfig)

Description copied from interface: Transition

The API performs eligibility checks on the cluster to see if it can be transitioned to desired configuration management platform. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

checkEligibility_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

cancel

public void cancel(java.lang.String cluster)

Description copied from interface: Transition

This API cancels the workflow to transition the cluster to desired configuration platform. If the status of transition is TransitionTypes.Info.Status.STARTED, the associated state information will be deleted. Otherwise, cancel will not be allowed and the API will throw an error. This method was added in vSphere API 8.0.1.0.

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

Specified by:

cancel in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

cancel

public void cancel(java.lang.String cluster,
                   InvocationConfig invocationConfig)

Description copied from interface: Transition

This API cancels the workflow to transition the cluster to desired configuration platform. If the status of transition is TransitionTypes.Info.Status.STARTED, the associated state information will be deleted. Otherwise, cancel will not be allowed and the API will throw an error. This method was added in vSphere API 8.0.1.0.

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:

cancel in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

cancel

public void cancel(java.lang.String cluster,
                   AsyncCallback<java.lang.Void> asyncCallback)

Description copied from interface: Transition

This API cancels the workflow to transition the cluster to desired configuration platform. If the status of transition is TransitionTypes.Info.Status.STARTED, the associated state information will be deleted. Otherwise, cancel will not be allowed and the API will throw an error. This method was added in vSphere API 8.0.1.0.

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

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotAllowedInCurrentState - If the status of transition process is not TransitionTypes.Info.Status.STARTED.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.Modify.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.

Specified by:

cancel in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

cancel

public void cancel(java.lang.String cluster,
                   AsyncCallback<java.lang.Void> asyncCallback,
                   InvocationConfig invocationConfig)

Description copied from interface: Transition

This API cancels the workflow to transition the cluster to desired configuration platform. If the status of transition is TransitionTypes.Info.Status.STARTED, the associated state information will be deleted. Otherwise, cancel will not be allowed and the API will throw an error. This method was added in vSphere API 8.0.1.0.

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

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotAllowedInCurrentState - If the status of transition process is not TransitionTypes.Info.Status.STARTED.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.Modify.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.

Specified by:

cancel in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

importFromFile

public DraftImportResult importFromFile(java.lang.String cluster,
                                        TransitionTypes.FileSpec spec)

Description copied from interface: Transition

The API imports the desired configuration from a file. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. This method was added in vSphere API 8.0.1.0.

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

Specified by:

importFromFile in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Input structure containing file information.

Returns:

Output structure containing the status of the operation and error if any.

importFromFile

public DraftImportResult importFromFile(java.lang.String cluster,
                                        TransitionTypes.FileSpec spec,
                                        InvocationConfig invocationConfig)

Description copied from interface: Transition

The API imports the desired configuration from a file. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. This method was added in vSphere API 8.0.1.0.

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:

importFromFile in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Input structure containing file information.

invocationConfig - Configuration for the method invocation.

Returns:

Output structure containing the status of the operation and error if any.

importFromFile

public void importFromFile(java.lang.String cluster,
                           TransitionTypes.FileSpec spec,
                           AsyncCallback<DraftImportResult> asyncCallback)

Description copied from interface: Transition

The API imports the desired configuration from a file. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
Output structure containing the status of the operation and error if any.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.Modify.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.

Specified by:

importFromFile in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Input structure containing file information.

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

importFromFile

public void importFromFile(java.lang.String cluster,
                           TransitionTypes.FileSpec spec,
                           AsyncCallback<DraftImportResult> asyncCallback,
                           InvocationConfig invocationConfig)

Description copied from interface: Transition

The API imports the desired configuration from a file. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
Output structure containing the status of the operation and error if any.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.Modify.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Modify.

Specified by:

importFromFile in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Input structure containing file information.

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

invocationConfig - Configuration for the method invocation.

importFromHost_Task

public java.lang.String importFromHost_Task(java.lang.String cluster,
                                            java.lang.String host)

Description copied from interface: Transition

The API imports the desired configuration from a reference host in the cluster. The API also adds host-specific and host-overrides from the other hosts in the cluster. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Specified by:

importFromHost_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

host - Identifier of the reference host The parameter must be an identifier for the resource type: HostSystem.

Returns:

identifier for the task created by this API invocation

importFromHost_Task

public java.lang.String importFromHost_Task(java.lang.String cluster,
                                            java.lang.String host,
                                            InvocationConfig invocationConfig)

Description copied from interface: Transition

The API imports the desired configuration from a reference host in the cluster. The API also adds host-specific and host-overrides from the other hosts in the cluster. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

importFromHost_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

host - Identifier of the reference host The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

importFromHost_Task

public void importFromHost_Task(java.lang.String cluster,
                                java.lang.String host,
                                AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Transition

The API imports the desired configuration from a reference host in the cluster. The API also adds host-specific and host-overrides from the other hosts in the cluster. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. This method was added in vSphere API 8.0.1.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

importFromHost_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

host - Identifier of the reference host The parameter must be an identifier for the resource type: HostSystem.

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

importFromHost_Task

public void importFromHost_Task(java.lang.String cluster,
                                java.lang.String host,
                                AsyncCallback<java.lang.String> asyncCallback,
                                InvocationConfig invocationConfig)

Description copied from interface: Transition

The API imports the desired configuration from a reference host in the cluster. The API also adds host-specific and host-overrides from the other hosts in the cluster. Import API does not validate the configuration against the schema. The result will specify if the configuration was imported successfully. The result will provide localized error message if the import operation failed. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

importFromHost_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

host - Identifier of the reference host The parameter must be an identifier for the resource type: HostSystem.

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

invocationConfig - Configuration for the method invocation.

exportConfig

public ExportResult exportConfig(java.lang.String cluster)

Description copied from interface: Transition

This API will export configuration associated with the cluster generated as part of the transition workflow. The API will throw an error if the transition state is not TransitionTypes.Info.Status.STARTED. This method was added in vSphere API 8.0.1.0.

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

Specified by:

exportConfig in interface Transition

Parameters:

cluster - Identifier of the cluster on which operation should be performed. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

This output structure of type ExportResult contains the configuration document encoded as JSON.

exportConfig

public ExportResult exportConfig(java.lang.String cluster,
                                 InvocationConfig invocationConfig)

Description copied from interface: Transition

This API will export configuration associated with the cluster generated as part of the transition workflow. The API will throw an error if the transition state is not TransitionTypes.Info.Status.STARTED. This method was added in vSphere API 8.0.1.0.

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:

exportConfig in interface Transition

Parameters:

cluster - Identifier of the cluster on which operation should be performed. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

This output structure of type ExportResult contains the configuration document encoded as JSON.

exportConfig

public void exportConfig(java.lang.String cluster,
                         AsyncCallback<ExportResult> asyncCallback)

Description copied from interface: Transition

This API will export configuration associated with the cluster generated as part of the transition workflow. The API will throw an error if the transition state is not TransitionTypes.Info.Status.STARTED. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
This output structure of type ExportResult contains the configuration document encoded as JSON.

Operation Errors:
Error - If there is some other unknown internal error. The accompanying error message will give more details about the failure.
NotAllowedInCurrentState - If the status of transition process is not TransitionTypes.Info.Status.STARTED.
NotFound - If the cluster is not found in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.Export.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.

Specified by:

exportConfig in interface Transition

Parameters:

cluster - Identifier of the cluster on which operation should be performed. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

exportConfig

public void exportConfig(java.lang.String cluster,
                         AsyncCallback<ExportResult> asyncCallback,
                         InvocationConfig invocationConfig)

Description copied from interface: Transition

This API will export configuration associated with the cluster generated as part of the transition workflow. The API will throw an error if the transition state is not TransitionTypes.Info.Status.STARTED. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
This output structure of type ExportResult contains the configuration document encoded as JSON.

Operation Errors:
Error - If there is some other unknown internal error. The accompanying error message will give more details about the failure.
NotAllowedInCurrentState - If the status of transition process is not TransitionTypes.Info.Status.STARTED.
NotFound - If the cluster is not found in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.Export.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.

Specified by:

exportConfig in interface Transition

Parameters:

cluster - Identifier of the cluster on which operation should be performed. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

exportSchema

public SchemaResult exportSchema(java.lang.String cluster)

Description copied from interface: Transition

This API will export schema associated with the cluster. The API will throw an error if the transition state is not TransitionTypes.Info.Status.STARTED. This method was added in vSphere API 8.0.1.0.

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

Specified by:

exportSchema in interface Transition

Parameters:

cluster - Identifier of the cluster on which operation should be performed. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

This output structure of type SchemaResult containing the schema document encoded as JSON.

exportSchema

public SchemaResult exportSchema(java.lang.String cluster,
                                 InvocationConfig invocationConfig)

Description copied from interface: Transition

This API will export schema associated with the cluster. The API will throw an error if the transition state is not TransitionTypes.Info.Status.STARTED. This method was added in vSphere API 8.0.1.0.

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:

exportSchema in interface Transition

Parameters:

cluster - Identifier of the cluster on which operation should be performed. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

This output structure of type SchemaResult containing the schema document encoded as JSON.

exportSchema

public void exportSchema(java.lang.String cluster,
                         AsyncCallback<SchemaResult> asyncCallback)

Description copied from interface: Transition

This API will export schema associated with the cluster. The API will throw an error if the transition state is not TransitionTypes.Info.Status.STARTED. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
This output structure of type SchemaResult containing the schema document encoded as JSON.

Operation Errors:
Error - If there is some other unknown internal error. The accompanying error message will give more details about the failure.
NotAllowedInCurrentState - If the status of transition process is not TransitionTypes.Info.Status.STARTED.
NotFound - If the cluster is not found in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.Export.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.

Specified by:

exportSchema in interface Transition

Parameters:

cluster - Identifier of the cluster on which operation should be performed. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

exportSchema

public void exportSchema(java.lang.String cluster,
                         AsyncCallback<SchemaResult> asyncCallback,
                         InvocationConfig invocationConfig)

Description copied from interface: Transition

This API will export schema associated with the cluster. The API will throw an error if the transition state is not TransitionTypes.Info.Status.STARTED. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
This output structure of type SchemaResult containing the schema document encoded as JSON.

Operation Errors:
Error - If there is some other unknown internal error. The accompanying error message will give more details about the failure.
NotAllowedInCurrentState - If the status of transition process is not TransitionTypes.Info.Status.STARTED.
NotFound - If the cluster is not found in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.ClusterConfiguration.Export.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.ClusterConfiguration.Export.

Specified by:

exportSchema in interface Transition

Parameters:

cluster - Identifier of the cluster on which operation should be performed. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

validateConfig_Task

public java.lang.String validateConfig_Task(java.lang.String cluster)

Description copied from interface: Transition

The API validates the imported desired configuration against the schema and on the hosts with validation plugins. If the document is valid, the API will check all the hosts for compliance with the desired configuration. The API returns validation errors if the configuration is not valid on any of the host. If the configuration is valid, the API returns compliance information. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Specified by:

validateConfig_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

identifier for the task created by this API invocation

validateConfig_Task

public java.lang.String validateConfig_Task(java.lang.String cluster,
                                            InvocationConfig invocationConfig)

Description copied from interface: Transition

The API validates the imported desired configuration against the schema and on the hosts with validation plugins. If the document is valid, the API will check all the hosts for compliance with the desired configuration. The API returns validation errors if the configuration is not valid on any of the host. If the configuration is valid, the API returns compliance information. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

validateConfig_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

validateConfig_Task

public void validateConfig_Task(java.lang.String cluster,
                                AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Transition

The API validates the imported desired configuration against the schema and on the hosts with validation plugins. If the document is valid, the API will check all the hosts for compliance with the desired configuration. The API returns validation errors if the configuration is not valid on any of the host. If the configuration is valid, the API returns compliance information. This method was added in vSphere API 8.0.1.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

validateConfig_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

validateConfig_Task

public void validateConfig_Task(java.lang.String cluster,
                                AsyncCallback<java.lang.String> asyncCallback,
                                InvocationConfig invocationConfig)

Description copied from interface: Transition

The API validates the imported desired configuration against the schema and on the hosts with validation plugins. If the document is valid, the API will check all the hosts for compliance with the desired configuration. The API returns validation errors if the configuration is not valid on any of the host. If the configuration is valid, the API returns compliance information. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

validateConfig_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

precheck_Task

public java.lang.String precheck_Task(java.lang.String cluster)

Description copied from interface: Transition

The API computes impact of transitioning the cluster to be managed by desired configuration platform. It also runs health checks to verify the cluster's health before transitioning. The API returns the impact on the hosts in the cluster and the result of health checks from the cluster and hosts. Health checks are run only if the host needs be rebooted or put in maintenanceMode. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Specified by:

precheck_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

identifier for the task created by this API invocation

precheck_Task

public java.lang.String precheck_Task(java.lang.String cluster,
                                      InvocationConfig invocationConfig)

Description copied from interface: Transition

The API computes impact of transitioning the cluster to be managed by desired configuration platform. It also runs health checks to verify the cluster's health before transitioning. The API returns the impact on the hosts in the cluster and the result of health checks from the cluster and hosts. Health checks are run only if the host needs be rebooted or put in maintenanceMode. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

precheck_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

precheck_Task

public void precheck_Task(java.lang.String cluster,
                          AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Transition

The API computes impact of transitioning the cluster to be managed by desired configuration platform. It also runs health checks to verify the cluster's health before transitioning. The API returns the impact on the hosts in the cluster and the result of health checks from the cluster and hosts. Health checks are run only if the host needs be rebooted or put in maintenanceMode. This method was added in vSphere API 8.0.1.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

precheck_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

precheck_Task

public void precheck_Task(java.lang.String cluster,
                          AsyncCallback<java.lang.String> asyncCallback,
                          InvocationConfig invocationConfig)

Description copied from interface: Transition

The API computes impact of transitioning the cluster to be managed by desired configuration platform. It also runs health checks to verify the cluster's health before transitioning. The API returns the impact on the hosts in the cluster and the result of health checks from the cluster and hosts. Health checks are run only if the host needs be rebooted or put in maintenanceMode. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

precheck_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

enable_Task

public java.lang.String enable_Task(java.lang.String cluster)

Description copied from interface: Transition

The API enables ConfigManager on the cluster. Before setting the desired configuration state, the API verifies the eligibility of the cluster to transition to desired configuration platform. The API then validates and sets the configuration draft as the desired configuration of the cluster, thus enabling ConfigManager. The API finally initiates remediation by invoking Apply. Apply is not invoked if the cluster is empty. The API does not wait for remediation to complete before returning. If any of the above step fails, the API will fail and result will contain descriptive error messages. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Specified by:

enable_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

identifier for the task created by this API invocation

enable_Task

public java.lang.String enable_Task(java.lang.String cluster,
                                    InvocationConfig invocationConfig)

Description copied from interface: Transition

The API enables ConfigManager on the cluster. Before setting the desired configuration state, the API verifies the eligibility of the cluster to transition to desired configuration platform. The API then validates and sets the configuration draft as the desired configuration of the cluster, thus enabling ConfigManager. The API finally initiates remediation by invoking Apply. Apply is not invoked if the cluster is empty. The API does not wait for remediation to complete before returning. If any of the above step fails, the API will fail and result will contain descriptive error messages. This method was added in vSphere API 8.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Specified by:

enable_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

enable_Task

public void enable_Task(java.lang.String cluster,
                        AsyncCallback<java.lang.String> asyncCallback)

Description copied from interface: Transition

The API enables ConfigManager on the cluster. Before setting the desired configuration state, the API verifies the eligibility of the cluster to transition to desired configuration platform. The API then validates and sets the configuration draft as the desired configuration of the cluster, thus enabling ConfigManager. The API finally initiates remediation by invoking Apply. Apply is not invoked if the cluster is empty. The API does not wait for remediation to complete before returning. If any of the above step fails, the API will fail and result will contain descriptive error messages. This method was added in vSphere API 8.0.1.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

enable_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

enable_Task

public void enable_Task(java.lang.String cluster,
                        AsyncCallback<java.lang.String> asyncCallback,
                        InvocationConfig invocationConfig)

Description copied from interface: Transition

The API enables ConfigManager on the cluster. Before setting the desired configuration state, the API verifies the eligibility of the cluster to transition to desired configuration platform. The API then validates and sets the configuration draft as the desired configuration of the cluster, thus enabling ConfigManager. The API finally initiates remediation by invoking Apply. Apply is not invoked if the cluster is empty. The API does not wait for remediation to complete before returning. If any of the above step fails, the API will fail and result will contain descriptive error messages. This method was added in vSphere API 8.0.1.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.

Specified by:

enable_Task in interface Transition

Parameters:

cluster - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.