Developer Documentation
Get Update Pending
Released in v7.0.0Gets detailed update information.
Request
URLURL
https://{api_host}/api/vcenter/lcm/update/pending/{version}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | A version identified the update The parameter must be an identifier for the resource type: com.vmware.vcenter.lcm.update.pending. |
Response
Response
Response BodyResponse Body
200 OK returns
PendingInfo
of type application/json
A detailed information about the particular vCenter patch/update
{
"build": "string",
"category": "enum",
"description": "string",
"execute_URL": "string",
"pending_update": "string",
"reboot_required": false,
"release_date": "string",
"release_notes": [
"string"
],
"severity": "enum",
"update_type": "enum",
"version": "string"
}| Property Name | Type | Description |
|---|---|---|
| build | string |
Build number of the vCenter Release |
| category | PendingCategory Enum |
Category of the release based on features bundled on top of previous release |
| description | string |
Description of the vSphere update |
| execute_URL | string |
VAMI or ISO URL for update or upgrade execute phase redirection |
| pending_update | string |
Identifier of the given vSphere update When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.lcm.update.pending. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.lcm.update.pending. |
| reboot_required | boolean |
Flag to suggest a reboot after the release is applied |
| release_date | string |
Release date of the vSphere update or patch |
| release_notes | array of string |
List of URI pointing to patch or update release notes |
| severity | PendingSeverityType Enum |
Severity of the issues fixed in the vSphere update or patch |
| update_type | PendingUpdateType Enum |
Type of the Release based on the current vCenter version |
| version | string |
Version of the vSphere update or patch |
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. |
| default | Error | Not available |
