pool.query

Sent on pool changes.

Type: object

ADDED

PoolAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

PoolEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for this storage pool.

name Required

Name

Type: string

Name of the storage pool.

guid Required

Guid

Type: string

Globally unique identifier (GUID) for this pool.

status Required

Status

Type: string

Current status of the pool.

Examples:

"ONLINE"

"DEGRADED"

"FAULTED"

path Required

Path

Type: string

Filesystem path where the pool is mounted.

scan Required

Information about the most recent scrub or resilver operation. null if no scan data is available.

Any of

• PoolScan
• Option 2

PoolScan

Type: object
No Additional Properties

function Required

Function

Type: enum (of string)

Type of ZFS pool scan.

Must be one of:

• "RESILVER"
• "SCRUB"

state Required

State

Type: enum (of string)

Current lifecycle state of the scan.

Must be one of:

• "SCANNING"
• "FINISHED"
• "CANCELED"

start_time Required

Start Time

Type: stringFormat: date-time

Scan start time.

end_time Required

End Time

Scan end time (null while the scan is still running).

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

percentage Required

Percentage

Type: number

Scan progress (between 0 and 100%).

bytes_to_process Required

Bytes To Process

Type: integer

Total bytes located by scanner.

bytes_processed Required

Bytes Processed

Type: integer

Total bytes to scan.

bytes_issued Required

Bytes Issued

Type: integer

Issued bytes per scan pass.

pause Required

Pause

Pause time of a scrub pass (null if the scan is not paused).

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

errors Required

Errors

Type: integer

Number of scan errors.

total_secs_left Required

Total Secs Left

Number of seconds left (null if the scan is not running).

Any of

• Option 1
• Option 2

Type: integer

Type: null

Type: null

expand Required

Expand

Information about any active pool expansion operation. null if no expansion is running.

Any of

• Option 1
• Option 2

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

Is Upgraded

Type: boolean Default: false

Whether this pool has been upgraded to the latest feature flags.

healthy Required

Healthy

Type: boolean

Whether the pool is in a healthy state with no errors or warnings.

warning Required

Warning

Type: boolean

Whether the pool has warning conditions that require attention.

status_code Required

Status Code

Detailed status code for the pool condition. null if not applicable.

Any of

• Option 1
• Option 2

Type: string

Type: null

status_detail Required

Status Detail

Human-readable description of the pool status. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

size Required

Size

Total size of the pool in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

allocated Required

Allocated

Amount of space currently allocated in the pool in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

free Required

Free

Amount of free space available in the pool in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

freeing Required

Freeing

Amount of space being freed (in bytes) by ongoing operations. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

dedup_table_size Required

Dedup Table Size

Size of the deduplication table in bytes. null if deduplication is not enabled.

Any of

• Option 1
• Option 2

Type: integer

Type: null

dedup_table_quota Required

Dedup Table Quota

Quota limit for the deduplication table. null if no quota is set.

Any of

• Option 1
• Option 2

Type: string

Type: null

fragmentation Required

Fragmentation

Percentage of pool fragmentation as a string. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

size_str Required

Size Str

Human-readable string representation of the pool size. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

allocated_str Required

Allocated Str

Human-readable string representation of allocated space. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

free_str Required

Free Str

Human-readable string representation of free space. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

freeing_str Required

Freeing Str

Human-readable string representation of space being freed. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

autotrim Required

Autotrim

Type: object

Auto-trim configuration for the pool indicating whether automatic TRIM operations are enabled.

Example:

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

topology Required

Physical topology and structure of the pool including vdevs. null if not available.

Any of

• PoolTopology
• Option 2

PoolTopology

Type: object
No Additional Properties

data Required

Data

Type: array

Array of data vdev configurations in the pool.

No Additional Items

Each item of this array must be:

Type: object

log Required

Log

Type: array

Array of ZFS Intent Log (ZIL) vdev configurations.

No Additional Items

Each item of this array must be:

Type: object

cache Required

Cache

Type: array

Array of L2ARC cache vdev configurations.

No Additional Items

Each item of this array must be:

Type: object

spare Required

Spare

Type: array

Array of spare disk configurations.

No Additional Items

Each item of this array must be:

Type: object

special Required

Special

Type: array

Array of special vdev configurations for metadata.

No Additional Items

Each item of this array must be:

Type: object

dedup Required

Dedup

Type: array

Array of deduplication table vdev configurations.

No Additional Items

Each item of this array must be:

Type: object

Type: null

CHANGED

PoolChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

fields Required

PoolEntry

Type: object
No Additional Properties

id Required

Id

Type: integer

Unique identifier for this storage pool.

name Required

Name

Type: string

Name of the storage pool.

guid Required

Guid

Type: string

Globally unique identifier (GUID) for this pool.

status Required

Status

Type: string

Current status of the pool.

Examples:

"ONLINE"

"DEGRADED"

"FAULTED"

path Required

Path

Type: string

Filesystem path where the pool is mounted.

scan Required

Information about the most recent scrub or resilver operation. null if no scan data is available.

Any of

• PoolScan
• Option 2

PoolScan

Type: object
No Additional Properties

function Required

Function

Type: enum (of string)

Type of ZFS pool scan.

Must be one of:

• "RESILVER"
• "SCRUB"

state Required

State

Type: enum (of string)

Current lifecycle state of the scan.

Must be one of:

• "SCANNING"
• "FINISHED"
• "CANCELED"

start_time Required

Start Time

Type: stringFormat: date-time

Scan start time.

end_time Required

End Time

Scan end time (null while the scan is still running).

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

percentage Required

Percentage

Type: number

Scan progress (between 0 and 100%).

bytes_to_process Required

Bytes To Process

Type: integer

Total bytes located by scanner.

bytes_processed Required

Bytes Processed

Type: integer

Total bytes to scan.

bytes_issued Required

Bytes Issued

Type: integer

Issued bytes per scan pass.

pause Required

Pause

Pause time of a scrub pass (null if the scan is not paused).

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

errors Required

Errors

Type: integer

Number of scan errors.

total_secs_left Required

Total Secs Left

Number of seconds left (null if the scan is not running).

Any of

• Option 1
• Option 2

Type: integer

Type: null

Type: null

expand Required

Expand

Information about any active pool expansion operation. null if no expansion is running.

Any of

• Option 1
• Option 2

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

Is Upgraded

Type: boolean Default: false

Whether this pool has been upgraded to the latest feature flags.

healthy Required

Healthy

Type: boolean

Whether the pool is in a healthy state with no errors or warnings.

warning Required

Warning

Type: boolean

Whether the pool has warning conditions that require attention.

status_code Required

Status Code

Detailed status code for the pool condition. null if not applicable.

Any of

• Option 1
• Option 2

Type: string

Type: null

status_detail Required

Status Detail

Human-readable description of the pool status. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

size Required

Size

Total size of the pool in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

allocated Required

Allocated

Amount of space currently allocated in the pool in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

free Required

Free

Amount of free space available in the pool in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

freeing Required

Freeing

Amount of space being freed (in bytes) by ongoing operations. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

dedup_table_size Required

Dedup Table Size

Size of the deduplication table in bytes. null if deduplication is not enabled.

Any of

• Option 1
• Option 2

Type: integer

Type: null

dedup_table_quota Required

Dedup Table Quota

Quota limit for the deduplication table. null if no quota is set.

Any of

• Option 1
• Option 2

Type: string

Type: null

fragmentation Required

Fragmentation

Percentage of pool fragmentation as a string. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

size_str Required

Size Str

Human-readable string representation of the pool size. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

allocated_str Required

Allocated Str

Human-readable string representation of allocated space. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

free_str Required

Free Str

Human-readable string representation of free space. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

freeing_str Required

Freeing Str

Human-readable string representation of space being freed. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

autotrim Required

Autotrim

Type: object

Auto-trim configuration for the pool indicating whether automatic TRIM operations are enabled.

Example:

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

topology Required

Physical topology and structure of the pool including vdevs. null if not available.

Any of

• PoolTopology
• Option 2

PoolTopology

Type: object
No Additional Properties

data Required

Data

Type: array

Array of data vdev configurations in the pool.

No Additional Items

Each item of this array must be:

Type: object

log Required

Log

Type: array

Array of ZFS Intent Log (ZIL) vdev configurations.

No Additional Items

Each item of this array must be:

Type: object

cache Required

Cache

Type: array

Array of L2ARC cache vdev configurations.

No Additional Items

Each item of this array must be:

Type: object

spare Required

Spare

Type: array

Array of spare disk configurations.

No Additional Items

Each item of this array must be:

Type: object

special Required

Special

Type: array

Array of special vdev configurations for metadata.

No Additional Items

Each item of this array must be:

Type: object

dedup Required

Dedup

Type: array

Array of deduplication table vdev configurations.

No Additional Items

Each item of this array must be:

Type: object

Type: null

REMOVED

PoolRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: integer

Required roles: POOL_READ