VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::esx::hcl::hosts::CompatibilityReport Interface Reference

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

Inherited by vmware::esx::hcl::hosts::CompatibilityReportStub.

List of all members.

Public Member Functions

string Create_Task (string host, vmware.esx.hcl.hosts.CompatibilityReportTypes.Spec spec)
 Generates hardware compatibility report for a specified ESXi host against specific ESXi release.
string Create_Task (string host, vmware.esx.hcl.hosts.CompatibilityReportTypes.Spec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Generates hardware compatibility report for a specified ESXi host against specific ESXi release.
vmware.esx.hcl.hosts.CompatibilityReportTypes.Result Get (string host)
 Returns the last generated hardware compatibility report for the given host.
vmware.esx.hcl.hosts.CompatibilityReportTypes.Result Get (string host, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the last generated hardware compatibility report for the given host.
global::System.Threading.Tasks.Task
< vmware.esx.hcl.hosts.CompatibilityReportTypes.Result
GetAsync (string host)
 Returns the last generated hardware compatibility report for the given host.
global::System.Threading.Tasks.Task
< vmware.esx.hcl.hosts.CompatibilityReportTypes.Result
GetAsync (string host, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the last generated hardware compatibility report for the given host.

Detailed Description

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


Member Function Documentation

string vmware::esx::hcl::hosts::CompatibilityReport::Create_Task ( string  host,
vmware.esx.hcl.hosts.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.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:
vmware.vapi.std.errors.NotFoundif no host with the given MoID can be found.
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unsupportedif the provided host is not supported.
vmware.vapi.std.errors.ResourceInaccessibleif the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
vmware.vapi.std.errors.NotAllowedInCurrentStateif there is no compatibility data on the vCenter executing the operation.
vmware.vapi.std.errors.ErrorIf there is some unknown error. The accompanying error message will give more details about the failure.
Parameters:
hostContains the MoID identifying the ESXi host. The parameter must be an identifier for the resource type: HostSystem .
specSpecifies 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

Implemented in vmware::esx::hcl::hosts::CompatibilityReportStub.

string vmware::esx::hcl::hosts::CompatibilityReport::Create_Task ( string  host,
vmware.esx.hcl.hosts.CompatibilityReportTypes.Spec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
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.

Task method overload. Result of the invocation is a task identifier which is going to be returned by this method.

Exceptions:
vmware.vapi.std.errors.NotFoundif no host with the given MoID can be found.
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.Unsupportedif the provided host is not supported.
vmware.vapi.std.errors.ResourceInaccessibleif the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
vmware.vapi.std.errors.NotAllowedInCurrentStateif there is no compatibility data on the vCenter executing the operation.
vmware.vapi.std.errors.ErrorIf there is some unknown error. The accompanying error message will give more details about the failure.
Parameters:
hostContains the MoID identifying the ESXi host. The parameter must be an identifier for the resource type: HostSystem .
specSpecifies the input parameters for generating compatibility report. If null host compatibility will be checked against the current release of the ESXi.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Identifier for the task created by this API invocation

Implemented in vmware::esx::hcl::hosts::CompatibilityReportStub.

vmware.esx.hcl.hosts.CompatibilityReportTypes.Result vmware::esx::hcl::hosts::CompatibilityReport::Get ( string  host,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

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

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no report generated for the given host. This operation does not check if the host id is valid or it exists.
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.ResourceInaccessibleif the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
vmware.vapi.std.errors.ErrorIf there is some unknown error. The accompanying error message will give more details about the failure.
Parameters:
hostThe parameter must be an identifier for the resource type: HostSystem .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:

Implemented in vmware::esx::hcl::hosts::CompatibilityReportStub.

vmware.esx.hcl.hosts.CompatibilityReportTypes.Result vmware::esx::hcl::hosts::CompatibilityReport::Get ( string  host)

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

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no report generated for the given host. This operation does not check if the host id is valid or it exists.
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.ResourceInaccessibleif the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
vmware.vapi.std.errors.ErrorIf there is some unknown error. The accompanying error message will give more details about the failure.
Parameters:
hostThe parameter must be an identifier for the resource type: HostSystem .
Returns:

Implemented in vmware::esx::hcl::hosts::CompatibilityReportStub.

global::System.Threading.Tasks.Task<vmware.esx.hcl.hosts.CompatibilityReportTypes.Result> vmware::esx::hcl::hosts::CompatibilityReport::GetAsync ( string  host,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

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

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no report generated for the given host. This operation does not check if the host id is valid or it exists.
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.ResourceInaccessibleif the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
vmware.vapi.std.errors.ErrorIf there is some unknown error. The accompanying error message will give more details about the failure.
Parameters:
hostThe parameter must be an identifier for the resource type: HostSystem .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:

Implemented in vmware::esx::hcl::hosts::CompatibilityReportStub.

global::System.Threading.Tasks.Task<vmware.esx.hcl.hosts.CompatibilityReportTypes.Result> vmware::esx::hcl::hosts::CompatibilityReport::GetAsync ( string  host)

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

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no report generated for the given host. This operation does not check if the host id is valid or it exists.
vmware.vapi.std.errors.Unauthenticatedif the caller is not authenticated.
vmware.vapi.std.errors.ResourceInaccessibleif the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
vmware.vapi.std.errors.ErrorIf there is some unknown error. The accompanying error message will give more details about the failure.
Parameters:
hostThe parameter must be an identifier for the resource type: HostSystem .
Returns:

Implemented in vmware::esx::hcl::hosts::CompatibilityReportStub.


The documentation for this interface was generated from the following file: