update.check_available

Checks if there is an update available from update server.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: attrs

attrs

Type: object
No Additional Properties

train

Train

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

Return value

Result

One of

• UpdateStatusAvailable
• UpdateStatusUnavailable

UpdateStatusAvailable

Type: object
No Additional Properties

status Required

Status

Type: const

An update is available.

Must be one of:

• "AVAILABLE"

Specific value: "AVAILABLE"

changes Required

Changes

Type: array of object
No Additional Items

Each item of this array must be:

UpdateStatusAvailableChanges

Type: object
No Additional Properties

operation Required

Operation

Type: const

Must be one of:

• "upgrade"

Specific value: "upgrade"

old Required

UpdateStatusAvailableChangesVersion

Type: object
No Additional Properties

name Required

Name

Type: const

Must be one of:

• "TrueNAS"

Specific value: "TrueNAS"

version Required

Version

Type: string

new Required

UpdateStatusAvailableChangesVersion

Type: object
No Additional Properties

name Required

Name

Type: const

Must be one of:

• "TrueNAS"

Specific value: "TrueNAS"

version Required

Version

Type: string

notice Required

Notice

Type: null

notes Required

Notes

Type: null

release_notes_url Required

Release Notes Url

Any of

• Option 1
• Option 2

Type: string

Type: null

changelog Required

Changelog

Type: string

version Required

Version

Type: string

Version string of the available update version.

filename Required

Filename

Type: string

Name of the update file available for download.

filesize Required

Filesize

Type: integer

Size of the update file in bytes.

checksum Required

Checksum

Type: string

UpdateStatusUnavailable

Type: object
No Additional Properties

status Required

Status

Type: enum (of string)

REBOOT_REQUIRED: An update has already been applied.
UNAVAILABLE: No update available.
HA_UNAVAILABLE: HA is non-functional.

Must be one of:

• "REBOOT_REQUIRED"
• "HA_UNAVAILABLE"
• "UNAVAILABLE"

Required roles: SYSTEM_UPDATE_READ