To use services form the

esx hcl

package, you must verify that you have accepted to participate in the CEIP and there is available compatibility data.

You can use the

CompatibilityReleases

service

to list available releases for generating a compatibility report for a specific

ESXi

host. To list the locally available

ESXi

releases for the host that can be used to generate a compatibility report,

use the

GET https://

<vcenter_ip_address_or_fqdn>

/api/esx/hcl/hosts/

<host_id>

/compatibility-releases

request

. The list includes only major and update releases. Patch releases are not listed.

You can use the

CompatibilityReport

service

to generate a hardware compatibility report for an

ESXi

host against a specific

ESXi

release. To return the last generated hardware compatibility report for a specific host,

use the

GET https://

<vcenter_ip_address_or_fqdn>

/api/esx/hcl/hosts/

<host_id>

/compatibility-report

request

. To generate a hardware compatibility report for a specific host against specific

ESXi

release,

use the

POST https://

<vcenter_ip_address_or_fqdn>

/api/esx/hcl/hosts/

<host_id>

/compatibility-report?vmw-task=true

request

.

You can use the

Reports

service

to download information generated by the hardware compatibility report. To retrieve the URI location for downloading a compatibility report,

use the

GET https://

<vcenter_ip_address_or_fqdn>

/api/esx/hcl/reports/

<report_id>

request

.