Developer Documentation
Create Task Update Precheck Report
Released in v7.0.0Creates a vCenter Server pre-update compatibility check report for the pending update version. The report can be exported and downloaded in CSV format. The result of this operation can be queried by calling the com.vmware.cis.Tasks#get operation where task is the response of this operation.
Request
URLURL
https://{api_host}/api/vcenter/lcm/update/pending/{version}/precheck-report?vmw-task=true
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Pending update version for which pre-update compatibility check will be executed. The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.update.pending. |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | vmw-task=true is set in order to call this as an async API. The return value then becomes the Task ID instead that is used to query the result from the Task API. |
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
The precheck report, which contains a link to download the CSV report as well
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.not_found : if there is no pending update assosiated with the version in the system. | com.vmware.vapi.std.errors.error : if there is some unknown internal error. The accompanying error message will give more details about the error. |
| 409 | Error | com.vmware.vapi.std.errors.not_allowed_in_current_state : if a precheck is already in progress. |
| default | Error | Not available |
