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

This interface provides methods to download information generated from the hardware compatibility feature residing on the vCenter Appliance. More...

Inherited by vmware::esx::hcl::ReportsStub.

List of all members.

Public Member Functions

vmware.esx.hcl.ReportsTypes.Location Get (string report)
 Returns the location Reports.Location information for downloading a compatibility report.
vmware.esx.hcl.ReportsTypes.Location Get (string report, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the location Reports.Location information for downloading a compatibility report.
global::System.Threading.Tasks.Task
< vmware.esx.hcl.ReportsTypes.Location
GetAsync (string report)
 Returns the location Reports.Location information for downloading a compatibility report.
global::System.Threading.Tasks.Task
< vmware.esx.hcl.ReportsTypes.Location
GetAsync (string report, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Returns the location Reports.Location information for downloading a compatibility report.

Detailed Description

This interface provides methods to download information generated from the hardware compatibility feature residing on the vCenter Appliance.


Member Function Documentation

vmware.esx.hcl.ReportsTypes.Location vmware::esx::hcl::Reports::Get ( string  report)

Returns the location Reports.Location information for downloading a compatibility report.

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no report for the given id.
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.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires VcIntegrity.HardwareCompatibility.Read .
Parameters:
reportidentifier of hardware compatiblity report to be downloaded. The parameter must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport .
Returns:
Reports.Location class which includes the URI to file, short lived token and expiry of the token in the Reports.Location object.

Implemented in vmware::esx::hcl::ReportsStub.

vmware.esx.hcl.ReportsTypes.Location vmware::esx::hcl::Reports::Get ( string  report,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns the location Reports.Location information for downloading a compatibility report.

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no report for the given id.
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.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires VcIntegrity.HardwareCompatibility.Read .
Parameters:
reportidentifier of hardware compatiblity report to be downloaded. The parameter must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Reports.Location class which includes the URI to file, short lived token and expiry of the token in the Reports.Location object.

Implemented in vmware::esx::hcl::ReportsStub.

global::System.Threading.Tasks.Task<vmware.esx.hcl.ReportsTypes.Location> vmware::esx::hcl::Reports::GetAsync ( string  report)

Returns the location Reports.Location information for downloading a compatibility report.

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no report for the given id.
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.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires VcIntegrity.HardwareCompatibility.Read .
Parameters:
reportidentifier of hardware compatiblity report to be downloaded. The parameter must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport .
Returns:
Reports.Location class which includes the URI to file, short lived token and expiry of the token in the Reports.Location object.

Implemented in vmware::esx::hcl::ReportsStub.

global::System.Threading.Tasks.Task<vmware.esx.hcl.ReportsTypes.Location> vmware::esx::hcl::Reports::GetAsync ( string  report,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Returns the location Reports.Location information for downloading a compatibility report.

Exceptions:
vmware.vapi.std.errors.NotFoundif there is no report for the given id.
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.
vmware.vapi.std.errors.Unauthorizedif you do not have all of the privileges described as follows:
  • Method execution requires VcIntegrity.HardwareCompatibility.Read .
Parameters:
reportidentifier of hardware compatiblity report to be downloaded. The parameter must be an identifier for the resource type: com.vmware.esx.hcl.resources.CompatibilityReport .
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
Reports.Location class which includes the URI to file, short lived token and expiry of the token in the Reports.Location object.

Implemented in vmware::esx::hcl::ReportsStub.


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