Package version:

Interface UpdateProperties

Details of a singular Update in HCI Cluster

interface UpdateProperties {
    additionalProperties?: string;
    availabilityType?: string;
    componentVersions?: {};
    description?: string;
    displayName?: string;
    healthCheckDate?: any;
    healthCheckResult?: {};
    healthState?: string;
    installedDate?: any;
    minSbeVersionRequired?: string;
    notifyMessage?: string;
    packagePath?: string;
    packageSizeInMb?: number;
    packageType?: string;
    prerequisites?: {};
    progressPercentage?: number;
    provisioningState?: string;
    publisher?: string;
    rebootRequired?: string;
    releaseLink?: string;
    state?: string;
    version?: string;
}

Properties

additionalProperties? availabilityType? componentVersions? description? displayName? healthCheckDate? healthCheckResult? healthState? installedDate? minSbeVersionRequired? notifyMessage? packagePath? packageSizeInMb? packageType? prerequisites? progressPercentage? provisioningState? publisher? rebootRequired? releaseLink? state? version?

Properties

OptionaladditionalProperties

additionalProperties?: string

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.

OptionalavailabilityType

availabilityType?: string

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.

OptionalcomponentVersions

componentVersions?: {}

An array of component versions for a Solution Bundle update, and an empty array otherwise.

Optionaldescription

description?: string

Description of the update.

OptionaldisplayName

displayName?: string

Display name of the Update

OptionalhealthCheckDate

healthCheckDate?: any

Last time the package-specific checks were run.

OptionalhealthCheckResult

healthCheckResult?: {}

An array of PrecheckResult objects.

OptionalhealthState

healthState?: string

Overall health state for update-specific health checks.

OptionalinstalledDate

installedDate?: any

Date that the update was installed.

OptionalminSbeVersionRequired

minSbeVersionRequired?: string

Minimum Sbe Version of the update.

OptionalnotifyMessage

notifyMessage?: string

Brief message with instructions for updates of AvailabilityType Notify.

OptionalpackagePath

packagePath?: string

Path where the update package is available.

OptionalpackageSizeInMb

packageSizeInMb?: number

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.

OptionalpackageType

packageType?: string

Customer-visible type of the update.

Optionalprerequisites

prerequisites?: {}

If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.

OptionalprogressPercentage

progressPercentage?: number

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.

Optional ReadonlyprovisioningState

provisioningState?: string

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.

Optionalpublisher

publisher?: string

Publisher of the update package.

OptionalrebootRequired

rebootRequired?: string

Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process.

OptionalreleaseLink

releaseLink?: string

Link to release notes for the update.

Optionalstate

state?: string

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.

Optionalversion

version?: string

Version of the update.

Settings

Member Visibility