Appliance Update Staged get

Appliance Update Staged get

Gets the current status of the staged update

This operation was added in vSphere API 6.7.

Request
URI
GET
https://{api_host}/api/appliance/update/staged
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Info structure with information about staged update

Returns Appliance Update Staged Info of type(s) application/json 
{
    "staging_complete": false,
    "component": "string",
    "version": "string",
    "name": "string",
    "description": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    },
    "priority": "string",
    "severity": "string",
    "update_type": "string",
    "release_date": "string",
    "reboot_required": false,
    "size": 0
}
boolean
staging_complete
Required

Is staging complete

This property was added in vSphere API 6.7.

string
component
Optional

Staged Component name.

This property was added in vSphere API 8.0.0.1.

if missing or null the staged update is for full patch if set staged update is an upgradeable component which can be updated individually without vc update

string
version
Required

Version in form of X.Y.Z.P. e.g. 6.5.1.5400

This property was added in vSphere API 6.7.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.appliance.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.appliance.update.pending.

string
name
Required

Name of the update.

This property was added in vSphere API 6.7.

description
Required

Description of the update. The short information what this update is. E.g. "Update2 for vCenter Server Appliance 6.5"

This property was added in vSphere API 6.7.

string
priority
Required

Update priority

For more information see: Appliance Update CommonInfo Priority.

This property was added in vSphere API 6.7.

string
severity
Required

Update severity

For more information see: Appliance Update CommonInfo Severity.

This property was added in vSphere API 6.7.

string
update_type
Required

Update category

For more information see: Appliance Update CommonInfo Category.

This property was added in vSphere API 6.7.

string As date-time As date-time
release_date
Required

Update release date.

This property was added in vSphere API 6.7.

boolean
reboot_required
Required

Flag indicating whether reboot is required after update.

This property was added in vSphere API 6.7.

integer As int64 As int64
size
Required

Download Size of update in Megabytes.

This property was added in vSphere API 6.7.


400

if nothing is staged

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

401

session is not 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.


403

session is not authorized to perform this operation

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

500

Generic 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/appliance/update/staged
On This Page
Appliance Operations
GET
Appliance Update Staged get
DELETE
Appliance Update Staged delete