boot.environment.query

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []
No Additional Items
Each item of this array must be:
Type: object
Parameter 2: options

options

Type: object
Default:
{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

No Additional Properties

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string
Type: null

Extend Context

Default: null

Type: string
Type: null

Prefix

Default: null

Type: string
Type: null

Extra

Type: object Default: {}

Order By

Type: array of string Default: []
No Additional Items
Each item of this array must be:
Type: string

Select

Type: array Default: []
No Additional Items
Each item of this array must be:

Type: string
Type: array
No Additional Items
Each item of this array must be:
Type: object

Count

Type: boolean Default: false

Get

Type: boolean Default: false

Offset

Type: integer Default: 0

Limit

Type: integer Default: 0

Force Sql Filters

Type: boolean Default: false

Result


Type: array of object
No Additional Items
Each item of this array must be:

BootEnvironmentQueryResultItem

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.

BootEnvironmentQueryResultItem

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.
Type: integer


Required roles: BOOT_ENV_READ