boot.environment.activate

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: boot_environment_activate

boot_environment_activate

Type: object
No Additional Properties

id Required

Id

Type: string

Must be at least 1 characters long

Return value

BootEnvironmentEntry

Type: object
No Additional Properties

id Required

Id

Type: string

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

Must be at least 1 characters long

dataset Required

Dataset

Type: string

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

Must be at least 1 characters long

active Required

Active

Type: boolean

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

activated Required

Activated

Type: boolean

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

created Required

Created

Type: stringFormat: date-time

The date when the boot environment was created.

used_bytes Required

Used Bytes

Type: integer

The total amount of bytes used by the boot environment.

used Required

Used

Type: string

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

Must be at least 1 characters long

keep Required

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 Required

Can Activate

Type: boolean

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

Required roles: BOOT_ENV_WRITE