Appliance Update Pending get
Gets update information
This operation was added in vSphere API 6.7.
Update version
The parameter must be an identifier for the resource type: com.vmware.appliance.update.pending.
Name of the upgradeable component
This parameter was added in vSphere API 8.0.0.1.
This parameter is optional because it was added in a newer version than its parent node.
Update
{
"name": "string",
"contents": [
{
"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"
}
],
"services_will_be_stopped": [
{
"service": "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"
}
}
],
"eulas": [
{
"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"
}
],
"staged": false,
"knowledge_base": "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
}Name of the update.
This property was added in vSphere API 6.7.
List of the 1. issues addressed since previous/current version 2. new features/improvements
This property was added in vSphere API 6.7.
List of the services that will be stopped and restarted during the update installation.
This property was added in vSphere API 6.7.
List of EULAs. This list has multiple entries and can be dynamic based on what we are actually installing.
This property was added in vSphere API 6.7.
Is the update staged
This property was added in vSphere API 6.7.
URL for the knowledge base article describing this update.
This property was added in vSphere API 6.7.
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.
Update priority
For more information see: Appliance Update CommonInfo Priority.
This property was added in vSphere API 6.7.
Update severity
For more information see: Appliance Update CommonInfo Severity.
This property was added in vSphere API 6.7.
Update category
For more information see: Appliance Update CommonInfo Category.
This property was added in vSphere API 6.7.
Update release date.
This property was added in vSphere API 6.7.
Flag indicating whether reboot is required after update.
This property was added in vSphere API 6.7.
Download Size of update in Megabytes.
This property was added in vSphere API 6.7.
if the update of this version is already installed
"Vapi Std Errors AlreadyInDesiredState Object"session is not authenticated
"Vapi Std Errors Unauthenticated Object"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.
session is not authorized to perform this operation
"Vapi Std Errors Unauthorized Object"the update is not found
"Vapi Std Errors NotFound Object"Generic error
"Vapi Std Errors Error Object"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.
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.
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.
curl -H 'Authorization: <value>' https://{api_host}/api/appliance/update/pending/{version}