Get Update Pending
Gets detailed update information.
Request
URLURL
https://{api_host}/api/vcenter/lcm/update/pending/{version}
Path Parameters
Path Parameters
string
version
Required
A version identified the update 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
200 OK returns
LcmUpdatePendingInfo
of type application/json
A detailed information about the particular vCenter patch/update
{
"build": "string",
"category": "SECURITY",
"description": "string",
"execute_URL": "string",
"pending_update": "string",
"reboot_required": false,
"release_date": "string",
"release_notes": [
"string"
],
"severity": "CRITICAL",
"update_type": "PATCH",
"version": "string"
}
string
build
Required
Build number of the vCenter Release
category
Required
The Pending.Category enumerated type defines the type of payload this release has on top of previous release
SECURITY : Fixes vulnerabilities, doesn’t change functionality
FIX : Fixes bugs/vulnerabilities, doesn’t change functionality
UPDATE : Changes product functionality
UPGRADE : Introduces new features, significantly changes product functionality
Possible values are: SECURITY , FIX , UPDATE , UPGRADE
string
description
Required
Description of the vSphere update
string
execute_URL
Required
VAMI or ISO URL for update or upgrade execute phase redirection
string
pending_update
Required
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.
boolean
reboot_required
Required
Flag to suggest a reboot after the release is applied
string
release_date
Required
Release date of the vSphere update or patch
array of
string
release_notes
Required
List of URI pointing to patch or update release notes
severity
Required
Level of severity for applying a given patch or update.
CRITICAL : Vulnerabilities that can be exploited by an unauthenticated attacker from the Internet or those that break the guest/host Operating System isolation.
IMPORTANT : Vulnerabilities that are not rated critical but whose exploitation results in the complete compromise of confidentiality and/or integrity of user data and/or processing resources through user assistance or by authenticated attackers.
MODERATE : Vulnerabilities where the ability to exploit is mitigated to a significant degree by configuration or difficulty of exploitation, but in certain deployment scenarios could still lead to the compromise of confidentiality, integrity, or availability of user data and/or processing resources.
LOW : All other issues that may or maynot have a security impact. Vulnerabilities where exploitation is believed to be extremely difficult, or where successful exploitation would have minimal impact.
Possible values are: CRITICAL , IMPORTANT , MODERATE , LOW
update_type
Required
The Pending.UpdateType enumerated type defines update type
PATCH : Fixes bugs/vulnerabilities, doesn’t change functionality
UPDATE : Changes product functionality
UPGRADE : Introduces new features, significantly changes product functionality
Possible values are: PATCH , UPDATE , UPGRADE
string
version
Required
Version of the vSphere update or patch
Errors
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-GetVersionUpdatePending -Version "MyVersion"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/lcm/update/pending/{version}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
