com.vmware.esx.settings.clusters.software.reports

Interface HardwareCompatibility

All Superinterfaces:

HardwareCompatibilityTypes, Service

All Known Implementing Classes:

HardwareCompatibilityStub

public interface HardwareCompatibility
extends Service, HardwareCompatibilityTypes

The HardwareCompatibility interface provides methods to manage HCL Validation of a software specification of an ESX cluster.

Nested Class Summary

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

HardwareCompatibilityTypes._VAPI_OPERATIONS, HardwareCompatibilityTypes.CheckSummary, HardwareCompatibilityTypes.ComplianceStatus

Field Summary

Fields inherited from interface com.vmware.esx.settings.clusters.software.reports.HardwareCompatibilityTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	check_Task(java.lang.String cluster) Initiates a Cluster HCL Validation check for a given cluster.
void	check_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) Initiates a Cluster HCL Validation check for a given cluster.
void	check_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Initiates a Cluster HCL Validation check for a given cluster.
java.lang.String	check_Task(java.lang.String cluster, InvocationConfig invocationConfig) Initiates a Cluster HCL Validation check for a given cluster.
HardwareCompatibilityTypes.CheckSummary	get(java.lang.String cluster) Returns the hcl validation check summary.
void	get(java.lang.String cluster, AsyncCallback<HardwareCompatibilityTypes.CheckSummary> asyncCallback) Returns the hcl validation check summary.
void	get(java.lang.String cluster, AsyncCallback<HardwareCompatibilityTypes.CheckSummary> asyncCallback, InvocationConfig invocationConfig) Returns the hcl validation check summary.
HardwareCompatibilityTypes.CheckSummary	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns the hcl validation check summary.

Method Detail

get

HardwareCompatibilityTypes.CheckSummary get(java.lang.String cluster)

Returns the hcl validation check summary.

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:

CheckSummary hcl validation summary.

Throws:

Error - If there is some other 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.HardwareCompatibility.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.Read.

get

HardwareCompatibilityTypes.CheckSummary get(java.lang.String cluster,
                                            InvocationConfig invocationConfig)

Returns the hcl validation check summary.

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:

CheckSummary hcl validation summary.

Throws:

Error - If there is some other 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.HardwareCompatibility.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.Read.

get

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

Returns the hcl validation check summary.

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

Invocation Result:
CheckSummary hcl validation summary.

Operation Errors:
Error - If there is some other 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.HardwareCompatibility.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.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<HardwareCompatibilityTypes.CheckSummary> asyncCallback,
         InvocationConfig invocationConfig)

Returns the hcl validation check summary.

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:
CheckSummary hcl validation summary.

Operation Errors:
Error - If there is some other 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.HardwareCompatibility.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.HardwareCompatibility.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.

check_Task

java.lang.String check_Task(java.lang.String cluster)

Initiates a Cluster HCL Validation check for a given cluster. 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 some other 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.

check_Task

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

Initiates a Cluster HCL Validation check for a given cluster. 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 some other 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.

check_Task

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

Initiates a Cluster HCL Validation check for a given cluster. 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 some other 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.

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.

check_Task

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

Initiates a Cluster HCL Validation check for a given cluster. 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 some other 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.

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.