Create Hosts Compatibility Report 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
URLURL
https://{api_host}/api/esx/hcl/hosts/{host}/compatibility-report?vmw-task=true
Path Parameters
Path Parameters
string
host
Required
Contains the MoID identifying the ESXi host. The parameter must be an identifier for the resource type: HostSystem.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
HclHostsCompatibilityReportSpec of mimetype application/json
Optional
Specifies the input parameters for generating compatibility report. If unset host compatibility will be checked against the current release of the ESXi.
{
"release": "string"
}
string
release
Required
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 CompatibilityReleases.list
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. CompatibilityReport.Result structure that contains the requested report and the identifier of the report.
Errors
400
com.vmware.vapi.std.errors.unsupported : if the provided host is not supported. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if there is no compatibility data on the vCenter executing the operation.
500
com.vmware.vapi.std.errors.resource_inaccessible : if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP). | com.vmware.vapi.std.errors.error : If there is some unknown error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$HclHostsCompatibilityReportSpec = Initialize-HclHostsCompatibilityReportSpec -Release "MyRelease"
Invoke-CreateHostCompatibilityReportAsync -Host "MyHost" -HclHostsCompatibilityReportSpec $HclHostsCompatibilityReportSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"release":"string"}' https://{api_host}/api/esx/hcl/hosts/{host}/compatibility-report?vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create_task
