boot.get_state¶

Returns the current state of the boot pool, including all vdevs, properties and datasets.

Type: object

Type: array
No Additional Items

BootGetState

Type: object
No Additional Properties

Name

Type: string

Status

Type: string

Path

Type: string

Scan

Any of

Option 1
Option 2

Type: object

Example:

{
    "bytes_issued": null,
    "bytes_processed": null,
    "bytes_to_process": null,
    "end_time": null,
    "errors": null,
    "function": null,
    "pause": null,
    "percentage": null,
    "start_time": null,
    "state": null,
    "total_secs_left": null
}

Type: null

Expand

Type: object

Example:

{
    "bytes_reflowed": 978944,
    "bytes_to_reflow": 835584,
    "end_time": null,
    "expanding_vdev": 0,
    "percentage": 85.35564853556485,
    "start_time": null,
    "state": "FINISHED",
    "total_secs_left": null,
    "waiting_for_resilver": 0
}

Type: null

Is Upgraded

Type: boolean Default: false

Healthy

Type: boolean

Warning

Type: boolean

Status Code

Any of

Option 1
Option 2

Type: string

Type: null

Status Detail

Any of

Option 1
Option 2

Type: string

Type: null

Size

Any of

Option 1
Option 2

Type: integer

Type: null

Allocated

Any of

Option 1
Option 2

Type: integer

Type: null

Free

Any of

Option 1
Option 2

Type: integer

Type: null

Freeing

Any of

Option 1
Option 2

Type: integer

Type: null

Dedup Table Size

Any of

Option 1
Option 2

Type: integer

Type: null

Dedup Table Quota

Any of

Option 1
Option 2

Type: string

Type: null

Fragmentation

Any of

Option 1
Option 2

Type: string

Type: null

Size Str

Any of

Option 1
Option 2

Type: string

Type: null

Allocated Str

Any of

Option 1
Option 2

Type: string

Type: null

Free Str

Any of

Option 1
Option 2

Type: string

Type: null

Freeing Str

Any of

Option 1
Option 2

Type: string

Type: null

Autotrim

Type: object

Example:

{
    "parsed": "off",
    "rawvalue": "off",
    "source": "DEFAULT",
    "value": "off"
}

Any of

PoolTopology
Option 2

PoolTopology

Type: object
No Additional Properties

Data

Type: array
No Additional Items

Each item of this array must be:

Type: object

Log

Type: array
No Additional Items

Each item of this array must be:

Type: object

Cache

Type: array
No Additional Items

Each item of this array must be:

Type: object

Spare

Type: array
No Additional Items

Each item of this array must be:

Type: object

Special

Type: array
No Additional Items

Each item of this array must be:

Type: object

Dedup

Type: array
No Additional Items

Each item of this array must be:

Type: object

Type: null

Required roles: READONLY_ADMIN

Table Of Contents

Previous topic

Next topic

boot.get_state¶

Call parameters

Return value

BootGetState

name Required

Name

status Required

Status

path Required

Path

scan Required

Scan

Any of

expand Required

Expand

Any of

is_upgraded

Is Upgraded

healthy Required

Healthy

warning Required

Warning

status_code Required

Status Code

Any of

status_detail Required

Status Detail

Any of

size Required

Size

Any of

allocated Required

Allocated

Any of

free Required

Free

Any of

freeing Required

Freeing

Any of

dedup_table_size Required

Dedup Table Size

Any of

dedup_table_quota Required

Dedup Table Quota

Any of

fragmentation Required

Fragmentation

Any of

size_str Required

Size Str

Any of

allocated_str Required

Allocated Str

Any of

free_str Required

Free Str

Any of

freeing_str Required

Freeing Str

Any of

autotrim Required

Autotrim

topology Required

Any of

PoolTopology

data Required

Data

Each item of this array must be:

log Required

Log

Each item of this array must be:

cache Required

Cache

Each item of this array must be:

spare Required

Spare