com.vmware.esx.settings.clusters.software

Interface AddOn

All Superinterfaces:

AddOnTypes, Service

All Known Implementing Classes:

AddOnStub

public interface AddOn
extends Service, AddOnTypes

The AddOn interface provides methods to manage desired OEM add-on specification for a given cluster.

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
AddOnInfo	get(java.lang.String cluster) Returns the desired OEM add-on specification for a given cluster.
void	get(java.lang.String cluster, AsyncCallback<AddOnInfo> asyncCallback) Returns the desired OEM add-on specification for a given cluster.
void	get(java.lang.String cluster, AsyncCallback<AddOnInfo> asyncCallback, InvocationConfig invocationConfig) Returns the desired OEM add-on specification for a given cluster.
AddOnInfo	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns the desired OEM add-on specification for a given cluster.

Method Detail

get

AddOnInfo get(java.lang.String cluster)

Returns the desired OEM add-on specification for a given cluster.

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:

Desired OEM add-on 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 or if desired OEM add-on specification 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.

get

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

Returns the desired OEM add-on specification for a given cluster.

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:

Desired OEM add-on 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 or if desired OEM add-on specification 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.

get

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

Returns the desired OEM add-on specification for a given cluster.

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

Invocation Result:
Desired OEM add-on 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 or if desired OEM add-on specification 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.

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

get

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

Returns the desired OEM add-on specification for a given cluster.

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:
Desired OEM add-on 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 or if desired OEM add-on specification 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.

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

invocationConfig - Configuration for the method invocation.