appliance update staged: get

Gets the current status of the staged update


HTTP request

GET https://{server}/rest/appliance/update/staged
No request parameters


HTTP Status Code: 200



Response Type:

Name Type Description
bold = required
value info Info structure with information about staged update.
value.staging_complete boolean Is staging complete

value.version string Version in form of X.Y.Z.P. e.g.

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

value.description localizable_message Description of the update. The short information what this update is. E.g. "Update2 for vCenter Server Appliance 6.5" string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

value.description.default_message string The value of this localizable string or message template in the en_US (English) locale. If refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.

value.description.args string[] Arguments to be substituted into a message template.

value.priority string Update priority

Defines the update installation priority recommendations. Value is one of:
HIGH: Install ASAP
MEDIUM: Install at the earliest convenience
LOW: Install at your discretion

value.severity string Update severity

Defines the severity of the issues fixed in the update. Value is one of:
CRITICAL: Vulnerabilities that can be exploited by an unauthenticated attacker from the Internet or those that break the guest/host Operating System isolation. The exploitation results in the complete compromise of confidentiality, integrity, and availability of user data and/or processing resources without user interaction. Exploitation could be leveraged to propagate an Internet worm or execute arbitrary code between Virtual Machines and/or the Host Operating System.
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. This rating also applies to those vulnerabilities which could lead to the complete compromise of availability when exploitation is by a remote unauthenticated attacker from the Internet or through a breach of virtual machine isolation.
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 have a security impact. Vulnerabilities where exploitation is believed to be extremely difficult, or where successful exploitation would have minimal impact

value.update_type string Update category

Defines update type Value is one of:
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

value.release_date date_time Update release date.

value.reboot_required boolean Flag indicating whether reboot is required after update.

value.size long Download Size of update in Megabytes.


HTTP Status Code Type Description
500 error Generic error
401 unauthenticated session is not authenticated
403 unauthorized session is not authorized to perform this operation
400 not_allowed_in_current_state if nothing is staged