boot.environment.activate

Activate the boot environment identified by id so that it becomes the default selection on the next boot. The currently running boot environment is unaffected until the system is rebooted.

Activating the already-activated boot environment is allowed and regenerates the boot menu, which is how a caller retries after a failed menu regeneration.

An EINVAL error is typically returned when the boot environment cannot be activated (for example, when it has no associated kernel); a refusal detected at the ZFS layer carries the errno of the underlying failure instead.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: boot_environment_activate

boot_environment_activate

Type: object

BootEnvironmentActivateArgs parameters.

 No Additional Properties

Id

Type: string

Must be at least 1 characters long

BootEnvironmentEntry

Type: object
No Additional Properties

Id

Type: string

The name of the boot environment referenced by the boot environment tool.

Must be at least 1 characters long

Dataset

Type: string

The name of the zfs dataset that represents the boot environment.

Must be at least 1 characters long

Active

Type: boolean

If active is True, this is the currently running boot environment.

Activated

Type: boolean

If True, this will be the boot environment that is used at next boot.

Created

Type: stringFormat: date-time

The date when the boot environment was created.

Used Bytes

Type: integer

The total amount of bytes used by the boot environment.

Used

Type: string

The boot environment's used space in human readable format.

Must be at least 1 characters long

Keep

Type: boolean

When set to false, this makes the boot environment subject to automatic deletion if the TrueNAS updater needs space for an update. Otherwise, the updater will not delete this boot environment if it is set to true.

Can Activate

Type: boolean

If set to true, the given boot environment may be activated.


Required roles: BOOT_ENV_WRITE