Vcenter Lcm Update Pending get

Vcenter Lcm Update Pending get

Gets detailed update information.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcLifecycle.View.
Request
URI
GET
https://{api_host}/api/vcenter/lcm/update/pending/{version}
COPY
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.


Authentication
This operation uses the following authentication methods.
Responses
200

A detailed information about the particular vCenter patch/update

Returns Vcenter Lcm Update Pending Info of type(s) application/json
{
    "description": "string",
    "pending_update": "string",
    "version": "string",
    "release_date": "string",
    "severity": "string",
    "build": "string",
    "update_type": "string",
    "category": "string",
    "reboot_required": false,
    "execute_url": "string",
    "release_notes": [
        "string"
    ]
}
string
description
Required

Description of the vSphere update

string
pending_update
Required

Identifier of the given vSphere update

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.lcm.update.pending. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.lcm.update.pending.

string
version
Required

Version of the vSphere update or patch

string As date-time As date-time
release_date
Required

Release date of the vSphere update or patch

string
severity
Required

Severity of the issues fixed in the vSphere update or patch

For more information see: Vcenter Lcm Update Pending SeverityType.

string
build
Required

Build number of the vCenter Release

string
update_type
Required

Type of the Release based on the current vCenter version

For more information see: Vcenter Lcm Update Pending UpdateType.

string
category
Required

Category of the release based on features bundled on top of previous release

For more information see: Vcenter Lcm Update Pending Category.

boolean
reboot_required
Required

Flag to suggest a reboot after the release is applied

string As uri As uri
execute_url
Required

VAMI or ISO URL for update or upgrade execute phase redirection

array of string
release_notes
Required

List of URI pointing to patch or update release notes


401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


404

if there is no pending update assosiated with the version in the system.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

500

if there is some unknown internal error. The accompanying error message will give more details about the error.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/lcm/update/pending/{version}