Create Update Precheck Report Task
Creates 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
string
version
Required
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
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
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. The precheck report, which contains a link to download the CSV report as well
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if a precheck is already in progress.
404
com.vmware.vapi.std.errors.not_found : if there is no pending update assosiated with the version in the system.
500
com.vmware.vapi.std.errors.error : if there is some unknown internal error. The accompanying error message will give more details about the error.
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
Invoke-CreateVersionPrecheckReportAsync -Version "MyVersion"
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
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create_task
