com.vmware.esx.settings.clusters.software

Interface Solutions

All Superinterfaces:

Service, SolutionsTypes

All Known Implementing Classes:

SolutionsStub

public interface Solutions
extends Service, SolutionsTypes

The Solutions interface provides methods to manage desired software solution specifications for an ESX cluster.

Nested Class Summary

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

SolutionsTypes._VAPI_OPERATIONS

Field Summary

Fields inherited from interface com.vmware.esx.settings.clusters.software.SolutionsTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String solution) Deletes the given solution from the desired software specification.
void	delete_Task(java.lang.String cluster, java.lang.String solution, AsyncCallback<java.lang.String> asyncCallback) Deletes the given solution from the desired software specification.
void	delete_Task(java.lang.String cluster, java.lang.String solution, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Deletes the given solution from the desired software specification.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String solution, InvocationConfig invocationConfig) Deletes the given solution from the desired software specification.
SolutionInfo	get(java.lang.String cluster, java.lang.String solution) Returns components registered for the given solution in the desired software specification.
void	get(java.lang.String cluster, java.lang.String solution, AsyncCallback<SolutionInfo> asyncCallback) Returns components registered for the given solution in the desired software specification.
void	get(java.lang.String cluster, java.lang.String solution, AsyncCallback<SolutionInfo> asyncCallback, InvocationConfig invocationConfig) Returns components registered for the given solution in the desired software specification.
SolutionInfo	get(java.lang.String cluster, java.lang.String solution, InvocationConfig invocationConfig) Returns components registered for the given solution in the desired software specification.
java.util.Map<java.lang.String,SolutionInfo>	list(java.lang.String cluster) Returns all solutions in the desired software specification.
void	list(java.lang.String cluster, AsyncCallback<java.util.Map<java.lang.String,SolutionInfo>> asyncCallback) Returns all solutions in the desired software specification.
void	list(java.lang.String cluster, AsyncCallback<java.util.Map<java.lang.String,SolutionInfo>> asyncCallback, InvocationConfig invocationConfig) Returns all solutions in the desired software specification.
java.util.Map<java.lang.String,SolutionInfo>	list(java.lang.String cluster, InvocationConfig invocationConfig) Returns all solutions in the desired software specification.
java.lang.String	set_Task(java.lang.String cluster, java.lang.String solution, SolutionSpec spec) Sets the components registered for the given solution in the desired software specification.
void	set_Task(java.lang.String cluster, java.lang.String solution, SolutionSpec spec, AsyncCallback<java.lang.String> asyncCallback) Sets the components registered for the given solution in the desired software specification.
void	set_Task(java.lang.String cluster, java.lang.String solution, SolutionSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Sets the components registered for the given solution in the desired software specification.
java.lang.String	set_Task(java.lang.String cluster, java.lang.String solution, SolutionSpec spec, InvocationConfig invocationConfig) Sets the components registered for the given solution in the desired software specification.

Method Detail

get

SolutionInfo get(java.lang.String cluster,
                 java.lang.String solution)

Returns components registered for the given solution in 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

Returns:

Specification of components registered by the solution.

Throws:

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

InvalidArgument - If invalid component name is provided.

NotFound - If there is no cluster associated with cluster in the system or or no solution associated with solution 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

SolutionInfo get(java.lang.String cluster,
                 java.lang.String solution,
                 InvocationConfig invocationConfig)

Returns components registered for the given solution in 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

invocationConfig - Configuration for the method invocation.

Returns:

Specification of components registered by the solution.

Throws:

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

InvalidArgument - If invalid component name is provided.

NotFound - If there is no cluster associated with cluster in the system or or no solution associated with solution 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,
         java.lang.String solution,
         AsyncCallback<SolutionInfo> asyncCallback)

Returns components registered for the given solution in the desired software specification.

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

Invocation Result:
Specification of components registered by the solution.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
InvalidArgument - If invalid component name is provided.
NotFound - If there is no cluster associated with cluster in the system or or no solution associated with solution 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

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

get

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

Returns components registered for the given solution in 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:
Specification of components registered by the solution.

Operation Errors:
Error - If there is unknown internal error. The accompanying error message will give more details about the failure.
InvalidArgument - If invalid component name is provided.
NotFound - If there is no cluster associated with cluster in the system or or no solution associated with solution 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

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

invocationConfig - Configuration for the method invocation.

list

java.util.Map<java.lang.String,SolutionInfo> list(java.lang.String cluster)

Returns all solutions in 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.

Returns:

Map of solutions where key is solution identifier and value is a list of components registered by that solution. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.solution.

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.

list

java.util.Map<java.lang.String,SolutionInfo> list(java.lang.String cluster,
                                                  InvocationConfig invocationConfig)

Returns all solutions in 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.

invocationConfig - Configuration for the method invocation.

Returns:

Map of solutions where key is solution identifier and value is a list of components registered by that solution. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.solution.

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.

list

void list(java.lang.String cluster,
          AsyncCallback<java.util.Map<java.lang.String,SolutionInfo>> asyncCallback)

Returns all solutions in the desired software specification.

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

Invocation Result:
Map of solutions where key is solution identifier and value is a list of components registered by that solution. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.solution.

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.

list

void list(java.lang.String cluster,
          AsyncCallback<java.util.Map<java.lang.String,SolutionInfo>> asyncCallback,
          InvocationConfig invocationConfig)

Returns all solutions in 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:
Map of solutions where key is solution identifier and value is a list of components registered by that solution. The key in the return value Map will be an identifier for the resource type: com.vmware.esx.settings.solution.

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.

set_Task

java.lang.String set_Task(java.lang.String cluster,
                          java.lang.String solution,
                          SolutionSpec spec)

Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

spec - Registered solution 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 validation of the software document fails. The value of the data property of Error will be a class that contains all the properties defined in ValidateResult.

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

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

set_Task

java.lang.String set_Task(java.lang.String cluster,
                          java.lang.String solution,
                          SolutionSpec spec,
                          InvocationConfig invocationConfig)

Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

spec - Registered solution 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 validation of the software document fails. The value of the data property of Error will be a class that contains all the properties defined in ValidateResult.

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

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

set_Task

void set_Task(java.lang.String cluster,
              java.lang.String solution,
              SolutionSpec spec,
              AsyncCallback<java.lang.String> asyncCallback)

Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. 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 validation of the software document fails. The value of the data property of Error will be a class that contains all the properties defined in ValidateResult.
NotFound - If there is no cluster associated with cluster or no solution associated with solution 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

spec - Registered solution specification.

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

set_Task

void set_Task(java.lang.String cluster,
              java.lang.String solution,
              SolutionSpec spec,
              AsyncCallback<java.lang.String> asyncCallback,
              InvocationConfig invocationConfig)

Sets the components registered for the given solution in the desired software specification. The task will set only one solution specification at a time. Solution constraints would be validated with the current desired software specification before it is committed as new desired spec. 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 validation of the software document fails. The value of the data property of Error will be a class that contains all the properties defined in ValidateResult.
NotFound - If there is no cluster associated with cluster or no solution associated with solution 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

spec - Registered solution specification.

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

invocationConfig - Configuration for the method invocation.

delete_Task

java.lang.String delete_Task(java.lang.String cluster,
                             java.lang.String solution)

Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

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 validation of the software document fails. The value of the data property of Error will be a class that contains all the properties defined in ValidateResult.

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

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

delete_Task

java.lang.String delete_Task(java.lang.String cluster,
                             java.lang.String solution,
                             InvocationConfig invocationConfig)

Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

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 validation of the software document fails. The value of the data property of Error will be a class that contains all the properties defined in ValidateResult.

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

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

delete_Task

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

Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. 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 validation of the software document fails. The value of the data property of Error will be a class that contains all the properties defined in ValidateResult.
NotFound - If there is no cluster associated with cluster or no solution associated with solution 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

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

delete_Task

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

Deletes the given solution from the desired software specification. The deletion will be validated along with the entire software specification before it is committed as new desired spec. 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 validation of the software document fails. The value of the data property of Error will be a class that contains all the properties defined in ValidateResult.
NotFound - If there is no cluster associated with cluster or no solution associated with solution 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.

solution - Identifier of the solution. The parameter must be an identifier for the resource type: com.vmware.esx.settings.solution.

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

invocationConfig - Configuration for the method invocation.