appliance update pending: get
Gets update information
Request:
HTTP request
GET https://{server}/rest/appliance/update/pending/{version}
Path Parameters
Name | Type | Description |
---|---|---|
Required | ||
version | string | Update version. |
Response:
HTTP Status Code: 200
Representation:
{
"value": {
"contents": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
],
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"eulas": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
],
"priority": "HIGH",
"reboot_required": true,
"release_date": "2015-01-01T22:13:05.651Z",
"services_will_be_stopped": [
{
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"service": "obj-103"
},
{
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"service": "obj-103"
}
],
"severity": "CRITICAL",
"size": 1,
"staged": true,
"update_type": "SECURITY"
}
}
"value": {
"contents": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
],
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"eulas": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
],
"priority": "HIGH",
"reboot_required": true,
"release_date": "2015-01-01T22:13:05.651Z",
"services_will_be_stopped": [
{
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"service": "obj-103"
},
{
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"service": "obj-103"
}
],
"severity": "CRITICAL",
"size": 1,
"staged": true,
"update_type": "SECURITY"
}
}
Response Type:
Name | Type | Description |
---|---|---|
bold = required | ||
value | info | Update. |
value.contents | localizable_message[] | List of the 1. issues addressed since previous/current version 2. new features/improvements |
value.contents[].id | 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.contents[].default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id 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.contents[].args | string[] | Arguments to be substituted into a message template. |
value.services_will_be_stopped | service_info[] | List of the services that will be stopped and restarted during the update installation. |
value.services_will_be_stopped[].service | string | Service ID When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.service . When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.service . |
value.services_will_be_stopped[].description | localizable_message | Service description |
value.services_will_be_stopped[].description.id | 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.services_will_be_stopped[].description.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id 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.services_will_be_stopped[].description.args | string[] | Arguments to be substituted into a message template. |
value.eulas | localizable_message[] | List of EULAs. This list has multiple entries and can be dynamic based on what we are actually installing. |
value.eulas[].id | 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.eulas[].default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id 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.eulas[].args | string[] | Arguments to be substituted into a message template. |
value.staged | boolean | Is the update staged |
value.description | localizable_message | Description of the update. The short information what this update is. E.g. "Update2 for vCenter Server Appliance 6.5" |
value.description.id | 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 vapi.std.localizable_message.id 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. |
Errors:
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 |
404 | not_found | the update is not found |
400 | already_in_desired_state | if the update of this version is already installed |