Create Task Update Precheck Report
Released in v7.0.0 DescriptionCreates 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. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
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. The precheck report, which contains a link to download the CSV report as well
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/lcm/update/pending/{version}/precheck-report?vmw-task=true
Errors
| Code | Returns | Description |
|---|---|---|
| 409 | Error | com.vmware.vapi.std.errors.not_allowed_in_current_state : if a precheck is already in progress. |
| default | Error | Not available |
| 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. |
