# update.status

Update status.

Type: object

##

Type: array
No Additional Items

##

#### UpdateStatus

Type: object

Current system update status and availability information.

No Additional Properties

##

#### 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"

##

Detailed update status information. `null` if code is ERROR.

## Any of

#### UpdateStatusStatus

Type: object
No Additional Properties

##

#### UpdateStatusCurrentVersion

Type: object

Currently running system version information.

No Additional Properties

##

#### Train

Type: string

Train name.

##

#### Profile

Type: string

Update profile assigned for the version.

##

#### Matches Profile

Type: boolean

Whether the system version running matches the configured update profile.

##

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

## Any of

#### UpdateStatusNewVersion

Type: object
No Additional Properties

##

#### Version

Type: string

Newly available version number.

##

#### Manifest

Type: object

Object containing detailed version information and metadata.

##

#### Release Notes

Release notes.

## Any of

Type: string
Type: null

##

#### Release Notes Url

Type: string

Release notes URL.

Type: null
Type: null

##

Error message if code is ERROR. `null` otherwise.

## Any of

#### UpdateStatusError

Type: object
No Additional Properties

##

#### Errname

Type: string

Error code (i.e. ENONET).

##

#### Reason

Type: string

Error text.

Type: null

##

Current update download progress.

## Any of

#### UpdateDownloadProgress

Type: object
No Additional Properties

##

#### Percent

Type: number

Download completion percentage (0.0 to 100.0).

##

#### Description

Type: string

Human-readable description of the current download activity.

##

#### Version

Type: string

Version number being downloaded.

Type: null

Required roles: SYSTEM_UPDATE_READ