# boot.environment.keep

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: boot_environment_destroy

#### boot_environment_destroy

Type: object

BootEnvironmentKeepArgs parameters.

No Additional Properties

##

#### Id

Type: string

Name of the boot environment to modify.

Must be at least `1` characters long

##

#### Value

Type: boolean

Whether to protect this boot environment from automatic deletion.

##

#### BootEnvironmentEntry

Type: object

The updated boot environment with modified keep setting.

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

This is the currently running boot environment.

##

#### Activated

Type: boolean

Use this boot environment on 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

The given boot environment may be activated.

Required roles: BOOT_ENV_WRITE