com.vmware.esx.settings.clusters.software.drafts.software

Interface HardwareSupport

All Superinterfaces:

HardwareSupportTypes, Service

All Known Implementing Classes:

HardwareSupportStub

public interface HardwareSupport
extends Service, HardwareSupportTypes

The HardwareSupport interface provides methods to manage a cluster's Hardware Support Package (HSP) configuration in working copy documents.

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	delete(java.lang.String cluster, java.lang.String draft) Deletes a given cluster's working copy document Hardware Support Package (HSP) configuration.
void	delete(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.lang.Void> asyncCallback) Deletes a given cluster's working copy document Hardware Support Package (HSP) configuration.
void	delete(java.lang.String cluster, java.lang.String draft, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes a given cluster's working copy document Hardware Support Package (HSP) configuration.
void	delete(java.lang.String cluster, java.lang.String draft, InvocationConfig invocationConfig) Deletes a given cluster's working copy document Hardware Support Package (HSP) configuration.
HardwareSupportInfo	get(java.lang.String cluster, java.lang.String draft) Returns a given cluster's working copy document Hardware Support Package (HSP) configuration.
void	get(java.lang.String cluster, java.lang.String draft, AsyncCallback<HardwareSupportInfo> asyncCallback) Returns a given cluster's working copy document Hardware Support Package (HSP) configuration.
void	get(java.lang.String cluster, java.lang.String draft, AsyncCallback<HardwareSupportInfo> asyncCallback, InvocationConfig invocationConfig) Returns a given cluster's working copy document Hardware Support Package (HSP) configuration.
HardwareSupportInfo	get(java.lang.String cluster, java.lang.String draft, InvocationConfig invocationConfig) Returns a given cluster's working copy document Hardware Support Package (HSP) configuration.
void	set(java.lang.String cluster, java.lang.String draft, HardwareSupportSpec spec) Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration.
void	set(java.lang.String cluster, java.lang.String draft, HardwareSupportSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration.
void	set(java.lang.String cluster, java.lang.String draft, HardwareSupportSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration.
void	set(java.lang.String cluster, java.lang.String draft, HardwareSupportSpec spec, InvocationConfig invocationConfig) Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration.

Method Detail

delete

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

Deletes a given cluster's working copy document Hardware Support Package (HSP) configuration.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

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

draft - Identifier of image working copy document being updated 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 named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.

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 a given cluster's working copy document Hardware Support Package (HSP) configuration.

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 for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of image working copy document being updated 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 named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.

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 a given cluster's working copy document Hardware Support Package (HSP) configuration.

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 named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.
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 for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of image working copy document being updated 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 a given cluster's working copy document Hardware Support Package (HSP) configuration.

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 named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.
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 for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of image working copy document being updated 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.

get

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

Returns a given cluster's working copy document Hardware Support Package (HSP) configuration.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

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

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

Returns:

Hardware Support Package (HSP) configured for use

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 named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.

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

HardwareSupportInfo get(java.lang.String cluster,
                        java.lang.String draft,
                        InvocationConfig invocationConfig)

Returns a given cluster's working copy document Hardware Support Package (HSP) configuration.

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 for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

invocationConfig - Configuration for the method invocation.

Returns:

Hardware Support Package (HSP) configured for use

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 named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.

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<HardwareSupportInfo> asyncCallback)

Returns a given cluster's working copy document Hardware Support Package (HSP) configuration.

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

Invocation Result:
Hardware Support Package (HSP) configured for use

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 named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.
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 for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of image working copy document being updated 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<HardwareSupportInfo> asyncCallback,
         InvocationConfig invocationConfig)

Returns a given cluster's working copy document Hardware Support Package (HSP) configuration.

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:
Hardware Support Package (HSP) configured for use

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 named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.
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 for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

draft - Identifier of image working copy document being updated 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,
         HardwareSupportSpec spec)

Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

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

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

spec - new Hardware Support Package (HSP) configuration for the cluster

Throws:

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

InvalidArgument

NotFound - If there is no cluster named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.

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,
         HardwareSupportSpec spec,
         InvocationConfig invocationConfig)

Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration.

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 for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

spec - new Hardware Support Package (HSP) configuration for the cluster

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.

InvalidArgument

NotFound - If there is no cluster named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.

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,
         HardwareSupportSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration.

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.
InvalidArgument -
NotFound - If there is no cluster named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.
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 for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

spec - new Hardware Support Package (HSP) configuration for the cluster

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

set

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

Replaces a given cluster's working copy document Hardware Support Package (HSP) configuration.

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.
InvalidArgument -
NotFound - If there is no cluster named cluster, no working copy document draft in the system, or no Hardware Support Package (HSP) configured as part of the working copy document.
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 for the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

spec - new Hardware Support Package (HSP) configuration for the cluster

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

invocationConfig - Configuration for the method invocation.