com.vmware.esx.settings.clusters

Interface Configuration

All Superinterfaces:

ConfigurationTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

ConfigurationStub

public interface Configuration
extends com.vmware.vapi.bindings.Service, ConfigurationTypes

The Configuration interface provides methods to manage desired configuration of an ESX cluster. This interface was added in vSphere API 8.0.1.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.clusters.ConfigurationTypes

ConfigurationTypes._VAPI_OPERATIONS, ConfigurationTypes.ApplyResult, ConfigurationTypes.ApplySpec, ConfigurationTypes.ImportSpec, ConfigurationTypes.Info, ConfigurationTypes.Metadata

Field Summary

Fields inherited from interface com.vmware.esx.settings.clusters.ConfigurationTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	apply_Task(java.lang.String cluster, ConfigurationTypes.ApplySpec spec) Applies the cluster configuration associated with the cluster on the hosts associated with the cluster.
void	apply_Task(java.lang.String cluster, ConfigurationTypes.ApplySpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Applies the cluster configuration associated with the cluster on the hosts associated with the cluster.
void	apply_Task(java.lang.String cluster, ConfigurationTypes.ApplySpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Applies the cluster configuration associated with the cluster on the hosts associated with the cluster.
java.lang.String	apply_Task(java.lang.String cluster, ConfigurationTypes.ApplySpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Applies the cluster configuration associated with the cluster on the hosts associated with the cluster.
java.lang.String	checkCompliance_Task(java.lang.String cluster) Check all the hosts in the cluster for compliance with the desired document.
void	checkCompliance_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Check all the hosts in the cluster for compliance with the desired document.
void	checkCompliance_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Check all the hosts in the cluster for compliance with the desired document.
java.lang.String	checkCompliance_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Check all the hosts in the cluster for compliance with the desired document.
ExportResult	exportConfig(java.lang.String cluster) This API will export the configuration associated with the cluster.
void	exportConfig(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<ExportResult> asyncCallback) This API will export the configuration associated with the cluster.
void	exportConfig(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<ExportResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API will export the configuration associated with the cluster.
ExportResult	exportConfig(java.lang.String cluster, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API will export the configuration associated with the cluster.
ConfigurationTypes.Info	get(java.lang.String cluster, java.lang.String commit, DocumentStructure docStructure) Get the cluster configuration and related metadata.
void	get(java.lang.String cluster, java.lang.String commit, DocumentStructure docStructure, com.vmware.vapi.bindings.client.AsyncCallback<ConfigurationTypes.Info> asyncCallback) Get the cluster configuration and related metadata.
void	get(java.lang.String cluster, java.lang.String commit, DocumentStructure docStructure, com.vmware.vapi.bindings.client.AsyncCallback<ConfigurationTypes.Info> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the cluster configuration and related metadata.
ConfigurationTypes.Info	get(java.lang.String cluster, java.lang.String commit, DocumentStructure docStructure, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get the cluster configuration and related metadata.
java.lang.String	importConfig_Task(java.lang.String cluster, ConfigurationTypes.ImportSpec spec) Deprecated. As of release vSphere API 8.0.2.0. Use com.vmware.esx.settings.clusters.configuration.Drafts#Create instead.
void	importConfig_Task(java.lang.String cluster, ConfigurationTypes.ImportSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Deprecated. As of release vSphere API 8.0.2.0. Use com.vmware.esx.settings.clusters.configuration.Drafts#Create instead. Invocation Result: identifier for the task created by this API invocation Operation Errors: Error - If there is some other unknown internal error. The accompanying error message will give more details about the failure. NotFound - If the cluster is not found in the system. ServiceUnavailable - If the service is not available. Unauthenticated - If the caller is not authenticated.
void	importConfig_Task(java.lang.String cluster, ConfigurationTypes.ImportSpec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated. As of release vSphere API 8.0.2.0. Use com.vmware.esx.settings.clusters.configuration.Drafts#Create instead. Invocation Result: identifier for the task created by this API invocation Operation Errors: Error - If there is some other unknown internal error. The accompanying error message will give more details about the failure. NotFound - If the cluster is not found in the system. ServiceUnavailable - If the service is not available. Unauthenticated - If the caller is not authenticated.
java.lang.String	importConfig_Task(java.lang.String cluster, ConfigurationTypes.ImportSpec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated. As of release vSphere API 8.0.2.0. Use com.vmware.esx.settings.clusters.configuration.Drafts#Create instead.
java.lang.String	precheck_Task(java.lang.String cluster) This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster.
void	precheck_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster.
void	precheck_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster.
java.lang.String	precheck_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster.
java.lang.String	validate_Task(java.lang.String cluster) Deprecated. As of release vSphere API 8.0.2.0. The desired cluster configuration is validated as part of com.vmware.esx.settings.clusters.Configuration#checkCompliance com.vmware.esx.settings.clusters.Configuration#precheck APIs.
void	validate_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Deprecated. As of release vSphere API 8.0.2.0. The desired cluster configuration is validated as part of com.vmware.esx.settings.clusters.Configuration#checkCompliance com.vmware.esx.settings.clusters.Configuration#precheck APIs. Invocation Result: identifier for the task created by this API invocation Operation Errors: Error - If an internal error occurred. The accompanying error message will give more details about the failure. InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform. NotFound - If there is no cluster associated with cluster ServiceUnavailable - If the service is not available. TimedOut - If the API timed out before completion. Unauthenticated - If the caller is not authenticated.
void	validate_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated. As of release vSphere API 8.0.2.0. The desired cluster configuration is validated as part of com.vmware.esx.settings.clusters.Configuration#checkCompliance com.vmware.esx.settings.clusters.Configuration#precheck APIs. Invocation Result: identifier for the task created by this API invocation Operation Errors: Error - If an internal error occurred. The accompanying error message will give more details about the failure. InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform. NotFound - If there is no cluster associated with cluster ServiceUnavailable - If the service is not available. TimedOut - If the API timed out before completion. Unauthenticated - If the caller is not authenticated.
java.lang.String	validate_Task(java.lang.String cluster, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Deprecated. As of release vSphere API 8.0.2.0. The desired cluster configuration is validated as part of com.vmware.esx.settings.clusters.Configuration#checkCompliance com.vmware.esx.settings.clusters.Configuration#precheck APIs.

Method Detail

get

ConfigurationTypes.Info get(java.lang.String cluster,
                            java.lang.String commit,
                            DocumentStructure docStructure)

Get the cluster configuration and related metadata. The configuration returned by this API only contains the user-visible configuration properties available for a 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.

Parameters:

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

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

docStructure -

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 or no commit associated with commit 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

ConfigurationTypes.Info get(java.lang.String cluster,
                            java.lang.String commit,
                            DocumentStructure docStructure,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get the cluster configuration and related metadata. The configuration returned by this API only contains the user-visible configuration properties available for a 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.

Parameters:

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

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

docStructure -

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.

NotFound - If there is no cluster associated with cluster or no commit associated with commit 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,
         java.lang.String commit,
         DocumentStructure docStructure,
         com.vmware.vapi.bindings.client.AsyncCallback<ConfigurationTypes.Info> asyncCallback)

Get the cluster configuration and related metadata. The configuration returned by this API only contains the user-visible configuration properties available for a 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.

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 or no commit associated with commit 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.

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

docStructure -

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

get

void get(java.lang.String cluster,
         java.lang.String commit,
         DocumentStructure docStructure,
         com.vmware.vapi.bindings.client.AsyncCallback<ConfigurationTypes.Info> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Get the cluster configuration and related metadata. The configuration returned by this API only contains the user-visible configuration properties available for a 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.

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 or no commit associated with commit 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.

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

docStructure -

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

invocationConfig - Configuration for the method invocation.

apply_Task

java.lang.String apply_Task(java.lang.String cluster,
                            ConfigurationTypes.ApplySpec spec)

Applies the cluster configuration associated with the cluster on the hosts associated with the cluster. 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.

Parameters:

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

spec - The Apply specification.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyInDesiredState - If the cluster is already at the specified commit as described in the apply specification.

Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.

InvalidArgument - If the ConfigurationTypes.ApplySpec.getCommit() property of spec specifies an invalid commit, or the ConfigurationTypes.ApplySpec.getHosts() property of spec specifies an invalid host or a host that is not part of the cluster, or the cluster is not managed with a configuration specification. Also thrown if the specified cluster is empty.

NotFound - If there is no cluster found in the inventory or no ConfigurationTypes.ApplySpec.getCommit() associated with cluster.

ServiceUnavailable - If the service is not available.

TimedOut - If the API timed out before completion.

Unauthenticated - If the caller is not authenticated.

apply_Task

java.lang.String apply_Task(java.lang.String cluster,
                            ConfigurationTypes.ApplySpec spec,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Applies the cluster configuration associated with the cluster on the hosts associated with the cluster. 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.

Parameters:

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

spec - The Apply specification.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyInDesiredState - If the cluster is already at the specified commit as described in the apply specification.

Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.

InvalidArgument - If the ConfigurationTypes.ApplySpec.getCommit() property of spec specifies an invalid commit, or the ConfigurationTypes.ApplySpec.getHosts() property of spec specifies an invalid host or a host that is not part of the cluster, or the cluster is not managed with a configuration specification. Also thrown if the specified cluster is empty.

NotFound - If there is no cluster found in the inventory or no ConfigurationTypes.ApplySpec.getCommit() associated with cluster.

ServiceUnavailable - If the service is not available.

TimedOut - If the API timed out before completion.

Unauthenticated - If the caller is not authenticated.

apply_Task

void apply_Task(java.lang.String cluster,
                ConfigurationTypes.ApplySpec spec,
                com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Applies the cluster configuration associated with the cluster on the hosts associated with the cluster. 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:
AlreadyInDesiredState - If the cluster is already at the specified commit as described in the apply specification.
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
InvalidArgument - If the ConfigurationTypes.ApplySpec.getCommit() property of spec specifies an invalid commit, or the ConfigurationTypes.ApplySpec.getHosts() property of spec specifies an invalid host or a host that is not part of the cluster, or the cluster is not managed with a configuration specification. Also thrown if the specified cluster is empty.
NotFound - If there is no cluster found in the inventory or no ConfigurationTypes.ApplySpec.getCommit() associated with cluster.
ServiceUnavailable - If the service is not available.
TimedOut - If the API timed out before completion.
Unauthenticated - If the caller is not authenticated.

Parameters:

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

spec - The Apply specification.

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

apply_Task

void apply_Task(java.lang.String cluster,
                ConfigurationTypes.ApplySpec spec,
                com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Applies the cluster configuration associated with the cluster on the hosts associated with the cluster. 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:
AlreadyInDesiredState - If the cluster is already at the specified commit as described in the apply specification.
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
InvalidArgument - If the ConfigurationTypes.ApplySpec.getCommit() property of spec specifies an invalid commit, or the ConfigurationTypes.ApplySpec.getHosts() property of spec specifies an invalid host or a host that is not part of the cluster, or the cluster is not managed with a configuration specification. Also thrown if the specified cluster is empty.
NotFound - If there is no cluster found in the inventory or no ConfigurationTypes.ApplySpec.getCommit() associated with cluster.
ServiceUnavailable - If the service is not available.
TimedOut - If the API timed out before completion.
Unauthenticated - If the caller is not authenticated.

Parameters:

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

spec - The Apply specification.

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

invocationConfig - Configuration for the method invocation.

checkCompliance_Task

java.lang.String checkCompliance_Task(java.lang.String cluster)

Check all the hosts in the cluster for compliance with the desired document. 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.

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 an internal error occurred. The accompanying error message will give more details about the failure.

InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.

NotFound - If there is no cluster associated with cluster

ServiceUnavailable - If the service is not available.

TimedOut - If the API timed out before completion.

Unauthenticated - If the caller is not authenticated.

checkCompliance_Task

java.lang.String checkCompliance_Task(java.lang.String cluster,
                                      com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Check all the hosts in the cluster for compliance with the desired document. 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.

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 an internal error occurred. The accompanying error message will give more details about the failure.

InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.

NotFound - If there is no cluster associated with cluster

ServiceUnavailable - If the service is not available.

TimedOut - If the API timed out before completion.

Unauthenticated - If the caller is not authenticated.

checkCompliance_Task

void checkCompliance_Task(java.lang.String cluster,
                          com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Check all the hosts in the cluster for compliance with the desired document. 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 an internal error occurred. The accompanying error message will give more details about the failure.
InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.
NotFound - If there is no cluster associated with cluster
ServiceUnavailable - If the service is not available.
TimedOut - If the API timed out before completion.
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.

checkCompliance_Task

void checkCompliance_Task(java.lang.String cluster,
                          com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Check all the hosts in the cluster for compliance with the desired document. 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 an internal error occurred. The accompanying error message will give more details about the failure.
InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.
NotFound - If there is no cluster associated with cluster
ServiceUnavailable - If the service is not available.
TimedOut - If the API timed out before completion.
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.

validate_Task

@Deprecated
java.lang.String validate_Task(java.lang.String cluster)

Deprecated. As of release vSphere API 8.0.2.0. The desired cluster configuration is validated as part of com.vmware.esx.settings.clusters.Configuration#checkCompliance com.vmware.esx.settings.clusters.Configuration#precheck APIs.

Check whether the desired cluster configuration is valid. 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.

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 an internal error occurred. The accompanying error message will give more details about the failure.

InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.

NotFound - If there is no cluster associated with cluster

ServiceUnavailable - If the service is not available.

TimedOut - If the API timed out before completion.

Unauthenticated - If the caller is not authenticated.

validate_Task

@Deprecated
java.lang.String validate_Task(java.lang.String cluster,
                                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated. As of release vSphere API 8.0.2.0. The desired cluster configuration is validated as part of com.vmware.esx.settings.clusters.Configuration#checkCompliance com.vmware.esx.settings.clusters.Configuration#precheck APIs.

Check whether the desired cluster configuration is valid. 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.

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 an internal error occurred. The accompanying error message will give more details about the failure.

InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.

NotFound - If there is no cluster associated with cluster

ServiceUnavailable - If the service is not available.

TimedOut - If the API timed out before completion.

Unauthenticated - If the caller is not authenticated.

validate_Task

@Deprecated
void validate_Task(java.lang.String cluster,
                               com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Deprecated. As of release vSphere API 8.0.2.0. The desired cluster configuration is validated as part of com.vmware.esx.settings.clusters.Configuration#checkCompliance com.vmware.esx.settings.clusters.Configuration#precheck APIs.

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

Operation Errors:
Error - If an internal error occurred. The accompanying error message will give more details about the failure.
InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.
NotFound - If there is no cluster associated with cluster
ServiceUnavailable - If the service is not available.
TimedOut - If the API timed out before completion.
Unauthenticated - If the caller is not authenticated.

Check whether the desired cluster configuration is valid. 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.

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.

validate_Task

@Deprecated
void validate_Task(java.lang.String cluster,
                               com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated. As of release vSphere API 8.0.2.0. The desired cluster configuration is validated as part of com.vmware.esx.settings.clusters.Configuration#checkCompliance com.vmware.esx.settings.clusters.Configuration#precheck APIs.

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

Operation Errors:
Error - If an internal error occurred. The accompanying error message will give more details about the failure.
InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.
NotFound - If there is no cluster associated with cluster
ServiceUnavailable - If the service is not available.
TimedOut - If the API timed out before completion.
Unauthenticated - If the caller is not authenticated.

Check whether the desired cluster configuration is valid. 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.

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)

This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster. The API will check against the desired image schema whether the desired configuration has added any requirements for the host to be put in maintenance mode or to be rebooted. The API will also invoke plugins provided by the configuration owner to detect if the host needs to be put in maintenance mode or to be rebooted. If any host needs to be put in maintenance mode or rebooted, prechecks will be performed at the cluster and host level. The result will specify the validation errors if the desired configuration is not valid on the host. If valid, the result will specify host impact of the desired configuration, and list the configurations that will change on applying the desired configuration. If host impact is maintenance mode or reboot, precheck results will also be specified in the result. 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.

Parameters:

cluster - The cluster on which to perform precheck. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

identifier for the task created by this API invocation

Throws:

Error

InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.

NotFound - If the cluster is not found in the system.

ServiceUnavailable - If the service is not available.

TimedOut - If the API timed out before completion.

Unauthenticated - If the caller is not authenticated.

precheck_Task

java.lang.String precheck_Task(java.lang.String cluster,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster. The API will check against the desired image schema whether the desired configuration has added any requirements for the host to be put in maintenance mode or to be rebooted. The API will also invoke plugins provided by the configuration owner to detect if the host needs to be put in maintenance mode or to be rebooted. If any host needs to be put in maintenance mode or rebooted, prechecks will be performed at the cluster and host level. The result will specify the validation errors if the desired configuration is not valid on the host. If valid, the result will specify host impact of the desired configuration, and list the configurations that will change on applying the desired configuration. If host impact is maintenance mode or reboot, precheck results will also be specified in the result. 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.

Parameters:

cluster - The cluster on which to perform precheck. 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

InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.

NotFound - If the cluster is not found in the system.

ServiceUnavailable - If the service is not available.

TimedOut - If the API timed out before completion.

Unauthenticated - If the caller is not authenticated.

precheck_Task

void precheck_Task(java.lang.String cluster,
                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster. The API will check against the desired image schema whether the desired configuration has added any requirements for the host to be put in maintenance mode or to be rebooted. The API will also invoke plugins provided by the configuration owner to detect if the host needs to be put in maintenance mode or to be rebooted. If any host needs to be put in maintenance mode or rebooted, prechecks will be performed at the cluster and host level. The result will specify the validation errors if the desired configuration is not valid on the host. If valid, the result will specify host impact of the desired configuration, and list the configurations that will change on applying the desired configuration. If host impact is maintenance mode or reboot, precheck results will also be specified in the result. 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 -
InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.
NotFound - If the cluster is not found in the system.
ServiceUnavailable - If the service is not available.
TimedOut - If the API timed out before completion.
Unauthenticated - If the caller is not authenticated.

Parameters:

cluster - The cluster on which to perform precheck. 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,
                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster. The API will check against the desired image schema whether the desired configuration has added any requirements for the host to be put in maintenance mode or to be rebooted. The API will also invoke plugins provided by the configuration owner to detect if the host needs to be put in maintenance mode or to be rebooted. If any host needs to be put in maintenance mode or rebooted, prechecks will be performed at the cluster and host level. The result will specify the validation errors if the desired configuration is not valid on the host. If valid, the result will specify host impact of the desired configuration, and list the configurations that will change on applying the desired configuration. If host impact is maintenance mode or reboot, precheck results will also be specified in the result. 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 -
InvalidArgument - If API is called on a cluster that is not managed by desired configuration management platform.
NotFound - If the cluster is not found in the system.
ServiceUnavailable - If the service is not available.
TimedOut - If the API timed out before completion.
Unauthenticated - If the caller is not authenticated.

Parameters:

cluster - The cluster on which to perform precheck. 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.

importConfig_Task

@Deprecated
java.lang.String importConfig_Task(java.lang.String cluster,
                                               ConfigurationTypes.ImportSpec spec)

Deprecated. As of release vSphere API 8.0.2.0. Use com.vmware.esx.settings.clusters.configuration.Drafts#Create instead.

This API replaces the existing desired configuration of the cluster with the configuration provided in the input parameter document. The API will internally validate the input configuration against the configuration schema derived from the cluster software specification associated with the cluster. If the input configuration document passes validation, then it will be the desired configuration of the cluster. The result will specify whether the input document was import successfully. The result will also list the validation errors in case 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.

Parameters:

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

spec - An ImportSpec that contains the new desired configuration for the cluster.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is some other unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If the cluster is not found in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

importConfig_Task

@Deprecated
java.lang.String importConfig_Task(java.lang.String cluster,
                                               ConfigurationTypes.ImportSpec spec,
                                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated. As of release vSphere API 8.0.2.0. Use com.vmware.esx.settings.clusters.configuration.Drafts#Create instead.

This API replaces the existing desired configuration of the cluster with the configuration provided in the input parameter document. The API will internally validate the input configuration against the configuration schema derived from the cluster software specification associated with the cluster. If the input configuration document passes validation, then it will be the desired configuration of the cluster. The result will specify whether the input document was import successfully. The result will also list the validation errors in case 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.

Parameters:

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

spec - An ImportSpec that contains the new desired configuration for the cluster.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - If there is some other unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If the cluster is not found in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

importConfig_Task

@Deprecated
void importConfig_Task(java.lang.String cluster,
                                   ConfigurationTypes.ImportSpec spec,
                                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Deprecated. As of release vSphere API 8.0.2.0. Use com.vmware.esx.settings.clusters.configuration.Drafts#Create instead.

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

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

This API replaces the existing desired configuration of the cluster with the configuration provided in the input parameter document. The API will internally validate the input configuration against the configuration schema derived from the cluster software specification associated with the cluster. If the input configuration document passes validation, then it will be the desired configuration of the cluster. The result will specify whether the input document was import successfully. The result will also list the validation errors in case 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.

Parameters:

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

spec - An ImportSpec that contains the new desired configuration for the cluster.

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

importConfig_Task

@Deprecated
void importConfig_Task(java.lang.String cluster,
                                   ConfigurationTypes.ImportSpec spec,
                                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Deprecated. As of release vSphere API 8.0.2.0. Use com.vmware.esx.settings.clusters.configuration.Drafts#Create instead.

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

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

This API replaces the existing desired configuration of the cluster with the configuration provided in the input parameter document. The API will internally validate the input configuration against the configuration schema derived from the cluster software specification associated with the cluster. If the input configuration document passes validation, then it will be the desired configuration of the cluster. The result will specify whether the input document was import successfully. The result will also list the validation errors in case 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.

Parameters:

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

spec - An ImportSpec that contains the new desired configuration for the cluster.

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 the configuration associated with 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.

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 com.vmware.esx.settings.clusters.Configuration#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.

NotFound - If the cluster is not found in the system.

ServiceUnavailable - If the service is not available.

TimedOut

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,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API will export the configuration associated with 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.

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 com.vmware.esx.settings.clusters.Configuration#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.

NotFound - If the cluster is not found in the system.

ServiceUnavailable - If the service is not available.

TimedOut

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,
                  com.vmware.vapi.bindings.client.AsyncCallback<ExportResult> asyncCallback)

This API will export the configuration associated with 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:
This output structure of type com.vmware.esx.settings.clusters.Configuration#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.
NotFound - If the cluster is not found in the system.
ServiceUnavailable - If the service is not available.
TimedOut -
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,
                  com.vmware.vapi.bindings.client.AsyncCallback<ExportResult> asyncCallback,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

This API will export the configuration associated with 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:
This output structure of type com.vmware.esx.settings.clusters.Configuration#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.
NotFound - If the cluster is not found in the system.
ServiceUnavailable - If the service is not available.
TimedOut -
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.