# update.run

Downloads (if not already in cache) and apply an update.

This method is a job.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: attrs

#### attrs

Type: object
Default:
{ "dataset_name": null, "resume": false, "train": null, "version": null, "reboot": false }

Attributes controlling the system update execution process.

No Additional Properties

##

#### Dataset Name

Default: null

Name of the ZFS dataset to use for the new boot environment. `null` for automatic naming.

## Any of

Type: string
Type: null

##

#### Resume

Type: boolean Default: false

Should be set to `true` if a previous call to this method returned a `CallError` with `errno=EAGAIN` meaning that an upgrade can be performed with a warning and that warning is accepted. In that case, update process will be continued using an already downloaded file without performing any extra checks.

##

#### Train

Default: null

Specifies the train from which to download the update. If both `train` and `version` are `null``, the most recent version that matches the currently selected update profile is used.

## Any of

Type: string
Type: null

##

#### Version

Default: null

Specific version to update to. `null` to use the latest version from the specified train.

## Any of

Type: string
Type: null

##

#### Reboot

Type: boolean Default: false

Whether to automatically reboot the system after applying the update.

##

#### Result

Type: const

Always returns true on successful update process initiation.

Specific value: `true`

Required roles: SYSTEM_UPDATE_WRITE