com.vmware.esx.hcl.hosts

Interface CompatibilityReport

All Superinterfaces:

CompatibilityReportTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

CompatibilityReportStub

public interface CompatibilityReport
extends com.vmware.vapi.bindings.Service, CompatibilityReportTypes

This interface provides methods to generate hardware compatibility report for a given ESXi host against a specific ESXi release.

Nested Class Summary

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

CompatibilityReportTypes._VAPI_OPERATIONS, CompatibilityReportTypes.BiosConstraint, CompatibilityReportTypes.DeviceConstraint, CompatibilityReportTypes.DeviceHclInfo, CompatibilityReportTypes.HclReport, CompatibilityReportTypes.Result, CompatibilityReportTypes.ServerCompatibility, CompatibilityReportTypes.ServerHclInfo, CompatibilityReportTypes.Spec

Field Summary

Fields inherited from interface com.vmware.esx.hcl.hosts.CompatibilityReportTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create_Task(java.lang.String host, CompatibilityReportTypes.Spec spec) Generates hardware compatibility report for a specified ESXi host against specific ESXi release.
void	create_Task(java.lang.String host, CompatibilityReportTypes.Spec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback) Generates hardware compatibility report for a specified ESXi host against specific ESXi release.
void	create_Task(java.lang.String host, CompatibilityReportTypes.Spec spec, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Generates hardware compatibility report for a specified ESXi host against specific ESXi release.
java.lang.String	create_Task(java.lang.String host, CompatibilityReportTypes.Spec spec, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Generates hardware compatibility report for a specified ESXi host against specific ESXi release.
CompatibilityReportTypes.Result	get(java.lang.String host) Returns the last generated hardware compatibility report for the given host.
void	get(java.lang.String host, com.vmware.vapi.bindings.client.AsyncCallback<CompatibilityReportTypes.Result> asyncCallback) Returns the last generated hardware compatibility report for the given host.
void	get(java.lang.String host, com.vmware.vapi.bindings.client.AsyncCallback<CompatibilityReportTypes.Result> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the last generated hardware compatibility report for the given host.
CompatibilityReportTypes.Result	get(java.lang.String host, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Returns the last generated hardware compatibility report for the given host.

Method Detail

create_Task

java.lang.String create_Task(java.lang.String host,
                             CompatibilityReportTypes.Spec spec)

Generates hardware compatibility report for a specified ESXi host against specific ESXi release.

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:

host - Contains the MoID identifying the ESXi host. The parameter must be an identifier for the resource type: HostSystem.

spec - Specifies the input parameters for generating compatibility report. If null host compatibility will be checked against the current release of the ESXi.

Returns:

identifier for the task created by this API invocation

Throws:

NotFound - if no host with the given MoID can be found.

Unauthenticated - if the caller is not authenticated.

Unsupported - if the provided host is not supported.

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

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

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

create_Task

java.lang.String create_Task(java.lang.String host,
                             CompatibilityReportTypes.Spec spec,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Generates hardware compatibility report for a specified ESXi host against specific ESXi release.

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:

host - Contains the MoID identifying the ESXi host. The parameter must be an identifier for the resource type: HostSystem.

spec - Specifies the input parameters for generating compatibility report. If null host compatibility will be checked against the current release of the ESXi.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

NotFound - if no host with the given MoID can be found.

Unauthenticated - if the caller is not authenticated.

Unsupported - if the provided host is not supported.

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

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

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

create_Task

void create_Task(java.lang.String host,
                 CompatibilityReportTypes.Spec spec,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback)

Generates hardware compatibility report for a specified ESXi host against specific ESXi release.

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:
NotFound - if no host with the given MoID can be found.
Unauthenticated - if the caller is not authenticated.
Unsupported - if the provided host is not supported.
ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
NotAllowedInCurrentState - if there is no compatibility data on the vCenter executing the operation.
Error - If there is some unknown error. The accompanying error message will give more details about the failure.

Parameters:

host - Contains the MoID identifying the ESXi host. The parameter must be an identifier for the resource type: HostSystem.

spec - Specifies the input parameters for generating compatibility report. If null host compatibility will be checked against the current release of the ESXi.

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

create_Task

void create_Task(java.lang.String host,
                 CompatibilityReportTypes.Spec spec,
                 com.vmware.vapi.bindings.client.AsyncCallback<java.lang.String> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Generates hardware compatibility report for a specified ESXi host against specific ESXi release.

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:
NotFound - if no host with the given MoID can be found.
Unauthenticated - if the caller is not authenticated.
Unsupported - if the provided host is not supported.
ResourceInaccessible - if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
NotAllowedInCurrentState - if there is no compatibility data on the vCenter executing the operation.
Error - If there is some unknown error. The accompanying error message will give more details about the failure.

Parameters:

host - Contains the MoID identifying the ESXi host. The parameter must be an identifier for the resource type: HostSystem.

spec - Specifies the input parameters for generating compatibility report. If null host compatibility will be checked against the current release of the ESXi.

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

invocationConfig - Configuration for the method invocation.

get

CompatibilityReportTypes.Result get(java.lang.String host)

Returns the last generated hardware compatibility report for the given host.

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

Parameters:

host - The parameter must be an identifier for the resource type: HostSystem.

Throws:

NotFound - if there is no report generated for the given host. This operation does not check if the host id is valid or it exists.

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

CompatibilityReportTypes.Result get(java.lang.String host,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the last generated hardware compatibility report for the given host.

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:

host - The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if there is no report generated for the given host. This operation does not check if the host id is valid or it exists.

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(java.lang.String host,
         com.vmware.vapi.bindings.client.AsyncCallback<CompatibilityReportTypes.Result> asyncCallback)

Returns the last generated hardware compatibility report for the given host.

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

Operation Errors:
NotFound - if there is no report generated for the given host. This operation does not check if the host id is valid or it exists.
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:

host - The parameter must be an identifier for the resource type: HostSystem.

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

get

void get(java.lang.String host,
         com.vmware.vapi.bindings.client.AsyncCallback<CompatibilityReportTypes.Result> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Returns the last generated hardware compatibility report for the given host.

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:
NotFound - if there is no report generated for the given host. This operation does not check if the host id is valid or it exists.
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:

host - The parameter must be an identifier for the resource type: HostSystem.

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

invocationConfig - Configuration for the method invocation.