appliance update pending: list
Checks if new updates are available. This operation was added in vSphere API 6.7.
Request:
HTTP request
GET https://{server}/rest/appliance/update/pending
?source_type=LAST_CHECK
&url=string
?source_type=LAST_CHECK
&url=string
Request Query Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| source_type | string | Defines the supported types of sources of updates. This enumeration was added in vSphere API 6.7. Value is one of: LAST_CHECK: Do not perform a new check, return the previous result. This constant was added in vSphere API 6.7. LOCAL: Check the local sources, ISO devices, staged area. This constant was added in vSphere API 6.7. LOCAL_AND_ONLINE: Check the local sources, ISO devices, staged area, then online repository as stated in update policy. This constant was added in vSphere API 6.7.type of the source. |
| url | string | Optional. specific URL to check at. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : [
{
"severity" : "CRITICAL",
"update_type" : "SECURITY",
"size" : 1,
"release_date" : "2015-01-01T22:13:05.651Z",
"reboot_required" : true,
"name" : "string",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"priority" : "HIGH",
"version" : "obj-103"
},
{
"severity" : "CRITICAL",
"update_type" : "SECURITY",
"size" : 1,
"release_date" : "2015-01-01T22:13:05.651Z",
"reboot_required" : true,
"name" : "string",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"priority" : "HIGH",
"version" : "obj-103"
}
]
}
"value" : [
{
"severity" : "CRITICAL",
"update_type" : "SECURITY",
"size" : 1,
"release_date" : "2015-01-01T22:13:05.651Z",
"reboot_required" : true,
"name" : "string",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"priority" : "HIGH",
"version" : "obj-103"
},
{
"severity" : "CRITICAL",
"update_type" : "SECURITY",
"size" : 1,
"release_date" : "2015-01-01T22:13:05.651Z",
"reboot_required" : true,
"name" : "string",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"priority" : "HIGH",
"version" : "obj-103"
}
]
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | summary[] | List of the update summaries. |
| value[].version | string | Version in form of X.Y.Z.P. e.g. 6.5.1.5400. This attribute was added in vSphere API 6.7. 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[].name | string | Name of the update. This attribute was added in vSphere API 6.7. |
| value[].description | localizable_message | Description of the update. The short information what this update is. E.g. "Update2 for vCenter Server Appliance 6.5". This attribute was added in vSphere API 6.7. |
| 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[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | Generic error |
| 404 | not_found | source is not found |
| 401 | unauthenticated | session is not authenticated |
| 403 | unauthorized | session is not authorized to perform this operation |