REST API - create-task
  1. Operations
  2. esx
  3. hcl
  4. hosts
  5. compatibility report

esx hcl hosts compatibility report: create-task

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.

Request:

HTTP request

POST https://{server}/api/esx/hcl/hosts/{host}/compatibility-report

?vmw-task=true
{
    "release" : "string"
}

Path Parameters

Name Type Description
Required
host string Contains the MoID identifying the ESXi host.

Body Parameters:

Name Type Description
bold = required
- spec Optional. Specifies the input parameters for generating compatibility report.
-.release string A target ESXi release which will be used to generate a compatibility report. Releases that can be used to generate report can be found using list

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name Type Description
bold = required
- string result structure that contains the requested report and the identifier of the report.

Errors:

HTTP Status Code Type Description
404 not_found if no host with the given MoID can be found.
401 unauthenticated if the caller is not authenticated.
400 unsupported if the provided host is not supported.
500 resource_inaccessible if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP).
400 not_allowed_in_current_state if there is no compatibility data on the vCenter executing the operation.
500 error If there is some unknown error. The accompanying error message will give more details about the failure.