update.manual

Update the system using a manual update file.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: path

path

Type: string

The absolute path to the update file.

Parameter 2: options

options

Type: object

Default:

{ "dataset_name": null, "resume": false, "cleanup": true }

Options for controlling the manual update process.

No Additional Properties

dataset_name

Dataset Name

Default: null

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

Any of

• Option 1
• Option 2

Type: string

Type: null

resume

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.

cleanup

Cleanup

Type: boolean Default: true

If set to false, the manual update file won't be removed on update success and newly created BE won't be removed on update failure (useful for debugging purposes).

Return value

Result

Type: null

Returns null on successful manual update initiation.

Required roles: SYSTEM_UPDATE_WRITE