update.status

Updated on update status changes.

Type: object

CHANGED

UpdateStatusChangedEvent

Type: object
No Additional Properties

status Required

UpdateStatus

Type: object

Updated system update status information.

No Additional Properties

code Required

Code

Type: enum (of string)

Status code:
* NORMAL - normal status, see status dictionary for details.
* ERROR - an error occurred, see error for details.

Must be one of:

• "NORMAL"
• "ERROR"

status Required

Detailed update status information. null if code is ERROR.

Any of

• UpdateStatusStatus
• Option 2

UpdateStatusStatus

Type: object
No Additional Properties

current_version Required

UpdateStatusCurrentVersion

Type: object

Currently running system version information.

No Additional Properties

train Required

Train

Type: string

Train name.

profile Required

Profile

Type: string

Update profile assigned for the version.

matches_profile Required

Matches Profile

Type: boolean

Whether the system version running matches the configured update profile.

new_version Required

New system version information (or null if no new system version is available).

Any of

• UpdateStatusNewVersion
• Option 2

UpdateStatusNewVersion

Type: object
No Additional Properties

version Required

Version

Type: string

Newly available version number.

manifest Required

Manifest

Type: object

Object containing detailed version information and metadata.

release_notes Required

Release Notes

Release notes.

Any of

• Option 1
• Option 2

Type: string

Type: null

release_notes_url Required

Release Notes Url

Type: string

Release notes URL.

Type: null

Type: null

error Required

Error message if code is ERROR. null otherwise.

Any of

• UpdateStatusError
• Option 2

UpdateStatusError

Type: object
No Additional Properties

errname Required

Errname

Type: string

Error code (i.e. ENONET).

reason Required

Reason

Type: string

Error text.

Type: null

update_download_progress Required

Current update download progress.

Any of

• UpdateDownloadProgress
• Option 2

UpdateDownloadProgress

Type: object
No Additional Properties

percent Required

Percent

Type: number

Download completion percentage (0.0 to 100.0).

description Required

Description

Type: string

Human-readable description of the current download activity.

version Required

Version

Type: string

Version number being downloaded.

Type: null

Required roles: SYSTEM_UPDATE_READ