com.vmware.esx.hcl

Interface CompatibilityData

All Superinterfaces:

CompatibilityDataTypes, Service

All Known Implementing Classes:

CompatibilityDataStub

public interface CompatibilityData
extends Service, CompatibilityDataTypes

This interface provides methods to update the local compatibility data residing on the vCenter Appliance or to get information about the said data. The information in the data is generic VMware compatibility information for servers and devices.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.hcl.CompatibilityDataTypes

CompatibilityDataTypes._VAPI_OPERATIONS, CompatibilityDataTypes.Status

Field Summary

Fields inherited from interface com.vmware.esx.hcl.CompatibilityDataTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
CompatibilityDataTypes.Status	get() Provides information about the compatibility data located on the vCenter Appliance.
void	get(AsyncCallback<CompatibilityDataTypes.Status> asyncCallback) Provides information about the compatibility data located on the vCenter Appliance.
void	get(AsyncCallback<CompatibilityDataTypes.Status> asyncCallback, InvocationConfig invocationConfig) Provides information about the compatibility data located on the vCenter Appliance.
CompatibilityDataTypes.Status	get(InvocationConfig invocationConfig) Provides information about the compatibility data located on the vCenter Appliance.
java.lang.String	update_Task() Replaces the local compatibility data with the latest version found from VMware official source.
void	update_Task(AsyncCallback<java.lang.String> asyncCallback) Replaces the local compatibility data with the latest version found from VMware official source.
void	update_Task(AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Replaces the local compatibility data with the latest version found from VMware official source.
java.lang.String	update_Task(InvocationConfig invocationConfig) Replaces the local compatibility data with the latest version found from VMware official source.

Method Detail

get

CompatibilityDataTypes.Status get()

Provides information about the compatibility data located on the vCenter Appliance.

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

Returns:

Information about the compatibility data.

Throws:

NotAllowedInCurrentState - if there is no compatibility data on the vCenter executing the operation.

Unauthenticated - if the caller is not authenticated.

ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).

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

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.HardwareCompatibility.Read.

get

CompatibilityDataTypes.Status get(InvocationConfig invocationConfig)

Provides information about the compatibility data located on the vCenter Appliance.

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:

invocationConfig - Configuration for the method invocation.

Returns:

Information about the compatibility data.

Throws:

NotAllowedInCurrentState - if there is no compatibility data on the vCenter executing the operation.

Unauthenticated - if the caller is not authenticated.

ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).

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

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.HardwareCompatibility.Read.

get

void get(AsyncCallback<CompatibilityDataTypes.Status> asyncCallback)

Provides information about the compatibility data located on the vCenter Appliance.

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

Invocation Result:
Information about the compatibility data.

Operation Errors:
NotAllowedInCurrentState - if there is no compatibility data on the vCenter executing the operation.
Unauthenticated - if the caller is not authenticated.
ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
Error - If there is some unknown error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.HardwareCompatibility.Read.

Parameters:

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

get

void get(AsyncCallback<CompatibilityDataTypes.Status> asyncCallback,
         InvocationConfig invocationConfig)

Provides information about the compatibility data located on the vCenter Appliance.

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:
Information about the compatibility data.

Operation Errors:
NotAllowedInCurrentState - if there is no compatibility data on the vCenter executing the operation.
Unauthenticated - if the caller is not authenticated.
ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
Error - If there is some unknown error. The accompanying error message will give more details about the failure.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.HardwareCompatibility.Read.

Parameters:

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

invocationConfig - Configuration for the method invocation.

update_Task

java.lang.String update_Task()

Replaces the local compatibility data with the latest version found from VMware official source.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Returns:

identifier for the task created by this API invocation

Throws:

NotAllowedInCurrentState - if there is compatibility data update in progress.

Unauthenticated - if the caller is not authenticated.

ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).

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

update_Task

java.lang.String update_Task(InvocationConfig invocationConfig)

Replaces the local compatibility data with the latest version found from VMware official source.

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:

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

NotAllowedInCurrentState - if there is compatibility data update in progress.

Unauthenticated - if the caller is not authenticated.

ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).

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

update_Task

void update_Task(AsyncCallback<java.lang.String> asyncCallback)

Replaces the local compatibility data with the latest version found from VMware official source.

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:
NotAllowedInCurrentState - if there is compatibility data update in progress.
Unauthenticated - if the caller is not authenticated.
ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
Error - If there is some unknown error. The accompanying error message will give more details about the failure.

Parameters:

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

update_Task

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

Replaces the local compatibility data with the latest version found from VMware official source.

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:
NotAllowedInCurrentState - if there is compatibility data update in progress.
Unauthenticated - if the caller is not authenticated.
ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
Error - If there is some unknown error. The accompanying error message will give more details about the failure.

Parameters:

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

invocationConfig - Configuration for the method invocation.