com.vmware.esx.settings.clusters.software.drafts.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 the OEM add-on specification in a software draft.

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String cluster, java.lang.String draft) Deletes the desired OEM add-on specification in the software draft.
void	delete(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.lang.Void> asyncCallback) Deletes the desired OEM add-on specification in the software draft.
void	delete(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes the desired OEM add-on specification in the software draft.
void	delete(java.lang.String cluster, java.lang.String draft, InvocationConfig invocationConfig) Deletes the desired OEM add-on specification in the software draft.
AddOnInfo	get(java.lang.String cluster, java.lang.String draft) Returns the OEM add-on specification in a software draft.
void	get(java.lang.String cluster, java.lang.String draft, AsyncCallback<AddOnInfo> asyncCallback) Returns the OEM add-on specification in a software draft.
void	get(java.lang.String cluster, java.lang.String draft, AsyncCallback<AddOnInfo> asyncCallback, InvocationConfig invocationConfig) Returns the OEM add-on specification in a software draft.
AddOnInfo	get(java.lang.String cluster, java.lang.String draft, InvocationConfig invocationConfig) Returns the OEM add-on specification in a software draft.
void	set(java.lang.String cluster, java.lang.String draft, AddOnSpec spec) Sets a new desired OEM add-on specification in the software draft.
void	set(java.lang.String cluster, java.lang.String draft, AddOnSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Sets a new desired OEM add-on specification in the software draft.
void	set(java.lang.String cluster, java.lang.String draft, AddOnSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Sets a new desired OEM add-on specification in the software draft.
void	set(java.lang.String cluster, java.lang.String draft, AddOnSpec spec, InvocationConfig invocationConfig) Sets a new desired OEM add-on specification in the software draft.

Method Detail

get

AddOnInfo get(java.lang.String cluster,
              java.lang.String draft)

Returns the OEM add-on specification in a software draft.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Returns:

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 or no draft associated with draft in the system or no add-on specification is set.

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,
              java.lang.String draft,
              InvocationConfig invocationConfig)

Returns the OEM add-on specification in a software draft.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

invocationConfig - Configuration for the method invocation.

Returns:

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 or no draft associated with draft in the system or no add-on specification is set.

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 draft,
         AsyncCallback<AddOnInfo> asyncCallback)

Returns the OEM add-on specification in a software draft.

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

Invocation Result:
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 or no draft associated with draft in the system or no add-on specification is set.
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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

get

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

Returns the OEM add-on specification in a software draft.

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:
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 or no draft associated with draft in the system or no add-on specification is set.
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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

invocationConfig - Configuration for the method invocation.

set

void set(java.lang.String cluster,
         java.lang.String draft,
         AddOnSpec spec)

Sets a new desired OEM add-on specification in the software draft. It will overwrite the existing desired OEM add-on specification if one already exists.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - AddOn specification.

Throws:

Error - If there is some 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 draft associated with draft 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.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

set

void set(java.lang.String cluster,
         java.lang.String draft,
         AddOnSpec spec,
         InvocationConfig invocationConfig)

Sets a new desired OEM add-on specification in the software draft. It will overwrite the existing desired OEM add-on specification if one already exists.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - AddOn specification.

invocationConfig - Configuration for the method invocation.

Throws:

Error - If there is some 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 draft associated with draft 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.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

set

void set(java.lang.String cluster,
         java.lang.String draft,
         AddOnSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Sets a new desired OEM add-on specification in the software draft. It will overwrite the existing desired OEM add-on specification if one already exists.

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

Operation Errors:
Error - If there is some 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 draft associated with draft 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.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Parameters:

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

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - AddOn specification.

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

set

void set(java.lang.String cluster,
         java.lang.String draft,
         AddOnSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Sets a new desired OEM add-on specification in the software draft. It will overwrite the existing desired OEM add-on specification if one already exists.

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 some 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 draft associated with draft 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.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Parameters:

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

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

spec - AddOn specification.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String cluster,
            java.lang.String draft)

Deletes the desired OEM add-on specification in the software draft.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

Throws:

Error - If there is some 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 draft associated with draft 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.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

delete

void delete(java.lang.String cluster,
            java.lang.String draft,
            InvocationConfig invocationConfig)

Deletes the desired OEM add-on specification in the software draft.

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.

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

invocationConfig - Configuration for the method invocation.

Throws:

Error - If there is some 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 draft associated with draft 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.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

delete

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

Deletes the desired OEM add-on specification in the software draft.

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

Operation Errors:
Error - If there is some 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 draft associated with draft 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.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Parameters:

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

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

delete

void delete(java.lang.String cluster,
            java.lang.String draft,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Deletes the desired OEM add-on specification in the software draft.

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 some 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 draft associated with draft 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.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSoftwareSpecification.Write.

Parameters:

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

draft - Identifier of the working copy document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft.

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

invocationConfig - Configuration for the method invocation.