UpdateProperties interface
Details of a singular Update in HCI Cluster
Properties
| additional |
Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type. |
| availability |
Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification. |
| component |
An array of component versions for a Solution Bundle update, and an empty array otherwise. |
| description | Description of the update. |
| display |
Display name of the Update |
| health |
Last time the package-specific checks were run. |
| health |
An array of PrecheckResult objects. |
| health |
Overall health state for update-specific health checks. |
| installed |
Date that the update was installed. |
| min |
Minimum Sbe Version of the update. |
| notify |
Brief message with instructions for updates of AvailabilityType Notify. |
| package |
Path where the update package is available. |
| package |
Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content. |
| package |
Customer-visible type of the update. |
| prerequisites | If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. |
| progress |
Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded. |
| provisioning |
Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed. |
| publisher | Publisher of the update package. |
| reboot |
Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process. |
| release |
Link to release notes for the update. |
| state | Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered. |
| version | Version of the update. |
Property Details
additionalProperties
Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.
additionalProperties?: stringProperty Value
string
availabilityType
Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification.
availabilityType?: stringProperty Value
string
componentVersions
An array of component versions for a Solution Bundle update, and an empty array otherwise.
componentVersions?: PackageVersionInfo[]Property Value
description
Description of the update.
description?: stringProperty Value
string
displayName
Display name of the Update
displayName?: stringProperty Value
string
healthCheckDate
Last time the package-specific checks were run.
healthCheckDate?: DateProperty Value
Date
healthCheckResult
An array of PrecheckResult objects.
healthCheckResult?: PrecheckResult[]Property Value
healthState
Overall health state for update-specific health checks.
healthState?: stringProperty Value
string
installedDate
Date that the update was installed.
installedDate?: DateProperty Value
Date
minSbeVersionRequired
Minimum Sbe Version of the update.
minSbeVersionRequired?: stringProperty Value
string
notifyMessage
Brief message with instructions for updates of AvailabilityType Notify.
notifyMessage?: stringProperty Value
string
packagePath
Path where the update package is available.
packagePath?: stringProperty Value
string
packageSizeInMb
Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.
packageSizeInMb?: numberProperty Value
number
packageType
Customer-visible type of the update.
packageType?: stringProperty Value
string
prerequisites
If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
prerequisites?: UpdatePrerequisite[]Property Value
progressPercentage
Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.
progressPercentage?: numberProperty Value
number
provisioningState
Provisioning state of the Updates proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed.
provisioningState?: stringProperty Value
string
publisher
Publisher of the update package.
publisher?: stringProperty Value
string
rebootRequired
Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process.
rebootRequired?: stringProperty Value
string
releaseLink
Link to release notes for the update.
releaseLink?: stringProperty Value
string
state
Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered.
state?: stringProperty Value
string
version
Version of the update.
version?: stringProperty Value
string