com.vmware.esx.settings.clusters

Interface Software

All Superinterfaces:

Service, SoftwareTypes

All Known Implementing Classes:

SoftwareStub

public interface Software
extends Service, SoftwareTypes

The Software interface provides methods to manage desired software specification of an ESX cluster.

Nested Class Summary

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

SoftwareTypes._VAPI_OPERATIONS, SoftwareTypes.ApplyResult, SoftwareTypes.ApplySpec, SoftwareTypes.ApplyStatus, SoftwareTypes.CheckInfo, SoftwareTypes.CheckResult, SoftwareTypes.CheckSpec, SoftwareTypes.CheckStatus, SoftwareTypes.EntityCheckResult, SoftwareTypes.ExportSpec, SoftwareTypes.ExportType, SoftwareTypes.Status

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	apply_Task(java.lang.String cluster, SoftwareTypes.ApplySpec spec) Applies the desired software document associated with the given cluster to hosts within the cluster.
void	apply_Task(java.lang.String cluster, SoftwareTypes.ApplySpec spec, AsyncCallback<java.lang.String> asyncCallback) Applies the desired software document associated with the given cluster to hosts within the cluster.
void	apply_Task(java.lang.String cluster, SoftwareTypes.ApplySpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Applies the desired software document associated with the given cluster to hosts within the cluster.
java.lang.String	apply_Task(java.lang.String cluster, SoftwareTypes.ApplySpec spec, InvocationConfig invocationConfig) Applies the desired software document associated with the given cluster to hosts within the cluster.
java.lang.String	check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec) Runs checks on the cluster before applying the desired software document across all hosts in the cluster.
void	check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec, AsyncCallback<java.lang.String> asyncCallback) Runs checks on the cluster before applying the desired software document across all hosts in the cluster.
void	check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Runs checks on the cluster before applying the desired software document across all hosts in the cluster.
java.lang.String	check_Task(java.lang.String cluster, SoftwareTypes.CheckSpec spec, InvocationConfig invocationConfig) Runs checks on the cluster before applying the desired software document across all hosts in the cluster.
java.util.Map<SoftwareTypes.ExportType,java.net.URI>	export(java.lang.String cluster, SoftwareTypes.ExportSpec spec) Exports the desired software specification document and/or image.
void	export(java.lang.String cluster, SoftwareTypes.ExportSpec spec, AsyncCallback<java.util.Map<SoftwareTypes.ExportType,java.net.URI>> asyncCallback) Exports the desired software specification document and/or image.
void	export(java.lang.String cluster, SoftwareTypes.ExportSpec spec, AsyncCallback<java.util.Map<SoftwareTypes.ExportType,java.net.URI>> asyncCallback, InvocationConfig invocationConfig) Exports the desired software specification document and/or image.
java.util.Map<SoftwareTypes.ExportType,java.net.URI>	export(java.lang.String cluster, SoftwareTypes.ExportSpec spec, InvocationConfig invocationConfig) Exports the desired software specification document and/or image.
SoftwareInfo	get(java.lang.String cluster) Returns the complete desired software specification.
void	get(java.lang.String cluster, AsyncCallback<SoftwareInfo> asyncCallback) Returns the complete desired software specification.
void	get(java.lang.String cluster, AsyncCallback<SoftwareInfo> asyncCallback, InvocationConfig invocationConfig) Returns the complete desired software specification.
SoftwareInfo	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns the complete desired software specification.
java.lang.String	scan_Task(java.lang.String cluster) Scans all the hosts in the cluster against the cluster's desired state.
void	scan_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) Scans all the hosts in the cluster against the cluster's desired state.
void	scan_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Scans all the hosts in the cluster against the cluster's desired state.
java.lang.String	scan_Task(java.lang.String cluster, InvocationConfig invocationConfig) Scans all the hosts in the cluster against the cluster's desired state.

Method Detail

get

SoftwareInfo get(java.lang.String cluster)

Returns the complete desired software specification.

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:

Cluster software specification.

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.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

get

SoftwareInfo get(java.lang.String cluster,
                 InvocationConfig invocationConfig)

Returns the complete desired software specification.

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:

Cluster software specification.

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.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

get

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

Returns the complete desired software specification.

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

Invocation Result:
Cluster software specification.

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.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

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<SoftwareInfo> asyncCallback,
         InvocationConfig invocationConfig)

Returns the complete desired software specification.

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:
Cluster software specification.

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.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

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.

scan_Task

java.lang.String scan_Task(java.lang.String cluster)

Scans all the hosts in the cluster against the cluster's desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 or if desired software document is not found.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

scan_Task

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

Scans all the hosts in the cluster against the cluster's desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 or if desired software document is not found.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

scan_Task

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

Scans all the hosts in the cluster against the cluster's desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 or if desired software document is not found.
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.

scan_Task

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

Scans all the hosts in the cluster against the cluster's desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 or if desired software document is not found.
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.

export

java.util.Map<SoftwareTypes.ExportType,java.net.URI> export(java.lang.String cluster,
                                                            SoftwareTypes.ExportSpec spec)

Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification.

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 -

Returns:

A map from export type to URL of the exported data for that type.

Throws:

Error - If there is am 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 or if desired software document is not found.

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.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

export

java.util.Map<SoftwareTypes.ExportType,java.net.URI> export(java.lang.String cluster,
                                                            SoftwareTypes.ExportSpec spec,
                                                            InvocationConfig invocationConfig)

Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification.

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 -

invocationConfig - Configuration for the method invocation.

Returns:

A map from export type to URL of the exported data for that type.

Throws:

Error - If there is am 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 or if desired software document is not found.

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.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

export

void export(java.lang.String cluster,
            SoftwareTypes.ExportSpec spec,
            AsyncCallback<java.util.Map<SoftwareTypes.ExportType,java.net.URI>> asyncCallback)

Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification.

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

Invocation Result:
A map from export type to URL of the exported data for that type.

Operation Errors:
Error - If there is am 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 or if desired software document is not found.
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.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

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

spec -

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

export

void export(java.lang.String cluster,
            SoftwareTypes.ExportSpec spec,
            AsyncCallback<java.util.Map<SoftwareTypes.ExportType,java.net.URI>> asyncCallback,
            InvocationConfig invocationConfig)

Exports the desired software specification document and/or image. This API will not export the solution section of the desired software specification.

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:
A map from export type to URL of the exported data for that type.

Operation Errors:
Error - If there is am 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 or if desired software document is not found.
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.lifecycleSoftwareSpecification.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Read.

Parameters:

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

spec -

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,
                            SoftwareTypes.ApplySpec spec)

Applies the desired software document associated with the given cluster to hosts within the cluster. If getCommit() property is Set, it implies the minimum commit that the com.vmware.esx.settings.clusters.Software#apply method should use, however if subsequent commits have been made to the desired state document the apply method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 - Apply specification.

Returns:

identifier for the task created by this API invocation

Throws:

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

Error - If there is an unknown internal error or if the EULA has not been accepted. The accompanying error message will give more details about the failure.

InvalidArgument - If the getCommit() property of spec specifies an invalid commit, or the getHosts() property of spec specifies an invalid host or a host not part of the cluster.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If there is no cluster associated with cluster in the system or if desired software document is not found.

ServiceUnavailable - If the service is not available.

TimedOut - If the operation times out.

Unauthenticated - If the caller is not authenticated.

apply_Task

java.lang.String apply_Task(java.lang.String cluster,
                            SoftwareTypes.ApplySpec spec,
                            InvocationConfig invocationConfig)

Applies the desired software document associated with the given cluster to hosts within the cluster. If getCommit() property is Set, it implies the minimum commit that the com.vmware.esx.settings.clusters.Software#apply method should use, however if subsequent commits have been made to the desired state document the apply method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 - 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 specified commit as described in the apply specification.

Error - If there is an unknown internal error or if the EULA has not been accepted. The accompanying error message will give more details about the failure.

InvalidArgument - If the getCommit() property of spec specifies an invalid commit, or the getHosts() property of spec specifies an invalid host or a host not part of the cluster.

NotAllowedInCurrentState - If there is another operation in progress.

NotFound - If there is no cluster associated with cluster in the system or if desired software document is not found.

ServiceUnavailable - If the service is not available.

TimedOut - If the operation times out.

Unauthenticated - If the caller is not authenticated.

apply_Task

void apply_Task(java.lang.String cluster,
                SoftwareTypes.ApplySpec spec,
                AsyncCallback<java.lang.String> asyncCallback)

Applies the desired software document associated with the given cluster to hosts within the cluster. If getCommit() property is Set, it implies the minimum commit that the com.vmware.esx.settings.clusters.Software#apply method should use, however if subsequent commits have been made to the desired state document the apply method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 specified commit as described in the apply specification.
Error - If there is an unknown internal error or if the EULA has not been accepted. The accompanying error message will give more details about the failure.
InvalidArgument - If the getCommit() property of spec specifies an invalid commit, or the getHosts() property of spec specifies an invalid host or a host not part of the cluster.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If there is no cluster associated with cluster in the system or if desired software document is not found.
ServiceUnavailable - If the service is not available.
TimedOut - If the operation times out.
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 - Apply specification.

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

apply_Task

void apply_Task(java.lang.String cluster,
                SoftwareTypes.ApplySpec spec,
                AsyncCallback<java.lang.String> asyncCallback,
                InvocationConfig invocationConfig)

Applies the desired software document associated with the given cluster to hosts within the cluster. If getCommit() property is Set, it implies the minimum commit that the com.vmware.esx.settings.clusters.Software#apply method should use, however if subsequent commits have been made to the desired state document the apply method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 specified commit as described in the apply specification.
Error - If there is an unknown internal error or if the EULA has not been accepted. The accompanying error message will give more details about the failure.
InvalidArgument - If the getCommit() property of spec specifies an invalid commit, or the getHosts() property of spec specifies an invalid host or a host not part of the cluster.
NotAllowedInCurrentState - If there is another operation in progress.
NotFound - If there is no cluster associated with cluster in the system or if desired software document is not found.
ServiceUnavailable - If the service is not available.
TimedOut - If the operation times out.
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 - Apply specification.

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

invocationConfig - Configuration for the method invocation.

check_Task

java.lang.String check_Task(java.lang.String cluster,
                            SoftwareTypes.CheckSpec spec)

Runs checks on the cluster before applying the desired software document across all hosts in the cluster. Checks if all hosts in the cluster are in a good state to be updated with the desired software document. If getCommit() property is Set it implies the minimum commit that the check method should use, however if subsequent commits have been made to the desired state document the check method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 - Check specification.

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.

InvalidArgument - If the getCommit() property of spec specifies an invalid commit, or the getHosts() property of spec specifies an invalid host or a host not part of the cluster.

NotAllowedInCurrentState - If there is another operation in progress or if the getCommit() property of spec specifies a commit that has already been applied.

NotFound - If there is no cluster associated with cluster in the system.

ServiceUnavailable - If the service is not available.

TimedOut - If the operation times out.

Unauthenticated - If the caller is not authenticated.

check_Task

java.lang.String check_Task(java.lang.String cluster,
                            SoftwareTypes.CheckSpec spec,
                            InvocationConfig invocationConfig)

Runs checks on the cluster before applying the desired software document across all hosts in the cluster. Checks if all hosts in the cluster are in a good state to be updated with the desired software document. If getCommit() property is Set it implies the minimum commit that the check method should use, however if subsequent commits have been made to the desired state document the check method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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 - Check specification.

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.

InvalidArgument - If the getCommit() property of spec specifies an invalid commit, or the getHosts() property of spec specifies an invalid host or a host not part of the cluster.

NotAllowedInCurrentState - If there is another operation in progress or if the getCommit() property of spec specifies a commit that has already been applied.

NotFound - If there is no cluster associated with cluster in the system.

ServiceUnavailable - If the service is not available.

TimedOut - If the operation times out.

Unauthenticated - If the caller is not authenticated.

check_Task

void check_Task(java.lang.String cluster,
                SoftwareTypes.CheckSpec spec,
                AsyncCallback<java.lang.String> asyncCallback)

Runs checks on the cluster before applying the desired software document across all hosts in the cluster. Checks if all hosts in the cluster are in a good state to be updated with the desired software document. If getCommit() property is Set it implies the minimum commit that the check method should use, however if subsequent commits have been made to the desired state document the check method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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.
InvalidArgument - If the getCommit() property of spec specifies an invalid commit, or the getHosts() property of spec specifies an invalid host or a host not part of the cluster.
NotAllowedInCurrentState - If there is another operation in progress or if the getCommit() property of spec specifies a commit that has already been applied.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
TimedOut - If the operation times out.
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 - Check specification.

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

check_Task

void check_Task(java.lang.String cluster,
                SoftwareTypes.CheckSpec spec,
                AsyncCallback<java.lang.String> asyncCallback,
                InvocationConfig invocationConfig)

Runs checks on the cluster before applying the desired software document across all hosts in the cluster. Checks if all hosts in the cluster are in a good state to be updated with the desired software document. If getCommit() property is Set it implies the minimum commit that the check method should use, however if subsequent commits have been made to the desired state document the check method will use the most recent desired state document. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

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.
InvalidArgument - If the getCommit() property of spec specifies an invalid commit, or the getHosts() property of spec specifies an invalid host or a host not part of the cluster.
NotAllowedInCurrentState - If there is another operation in progress or if the getCommit() property of spec specifies a commit that has already been applied.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
TimedOut - If the operation times out.
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 - Check specification.

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

invocationConfig - Configuration for the method invocation.