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

Interface Transition

All Superinterfaces:

Service, TransitionTypes

All Known Implementing Classes:

TransitionStub

public interface Transition
extends Service, TransitionTypes

The Transition interface provides methods to manage transition of an existing cluster to a desired configuration managed cluster. Warning: This interface is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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 interface com.vmware.esx.settings.clusters.enablement.configuration.TransitionTypes

_VAPI_SERVICE_ID

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.

Method Detail

get

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

This API returns the current transition state of the cluster. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Parameters:

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

Returns:

The transition state of the cluster.

Throws:

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.

get

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

This API returns the current transition state of the cluster. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

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.

Throws:

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.

get

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

This API returns the current transition state of the cluster. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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

This API returns the current transition state of the cluster. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

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

Throws:

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.

checkEligibility_Task

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

Throws:

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.

checkEligibility_Task

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

void cancel(java.lang.String cluster)

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

Parameters:

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

Throws:

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.

cancel

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

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

invocationConfig - Configuration for the method invocation.

Throws:

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.

cancel

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

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.

Throws:

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.

importFromFile

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

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.

Throws:

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.

importFromFile

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

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

Throws:

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.

importFromHost_Task

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

Throws:

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.

importFromHost_Task

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

ExportResult exportConfig(java.lang.String cluster)

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

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.

Throws:

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.

exportConfig

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

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.

Throws:

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.

exportConfig

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. The API will throw an error if the transition state is not TransitionTypes.Info.Status.STARTED. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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. The API will throw an error if the transition state is not TransitionTypes.Info.Status.STARTED. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

SchemaResult exportSchema(java.lang.String cluster)

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

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.

Throws:

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.

exportSchema

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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:

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.

Throws:

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.

exportSchema

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

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

Throws:

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.

validateConfig_Task

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

Throws:

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.

validateConfig_Task

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

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

Throws:

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.

precheck_Task

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

Throws:

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.

precheck_Task

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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. 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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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

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

Throws:

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.

enable_Task

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

Throws:

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.

enable_Task

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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

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

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. Warning: This method is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

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.

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.