pool.query ========== Sent on pool changes. .. raw:: html
Type: object

PoolAddedEvent

Type: object
No Additional Properties

Id

Type: integer

PoolEntry

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string

Guid

Type: string

Status

Type: string

Path

Type: string

Scan


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


Type: string
Type: null

Status Detail


Type: string
Type: null

Size


Type: integer
Type: null

Allocated


Type: integer
Type: null

Free


Type: integer
Type: null

Freeing


Type: integer
Type: null

Dedup Table Size


Type: integer
Type: null

Dedup Table Quota


Type: string
Type: null

Fragmentation


Type: string
Type: null

Size Str


Type: string
Type: null

Allocated Str


Type: string
Type: null

Free Str


Type: string
Type: null

Freeing Str


Type: string
Type: null

Autotrim

Type: object

Example:

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


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

PoolChangedEvent

Type: object
No Additional Properties

Id

Type: integer

PoolEntry

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string

Guid

Type: string

Status

Type: string

Path

Type: string

Scan


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


Type: string
Type: null

Status Detail


Type: string
Type: null

Size


Type: integer
Type: null

Allocated


Type: integer
Type: null

Free


Type: integer
Type: null

Freeing


Type: integer
Type: null

Dedup Table Size


Type: integer
Type: null

Dedup Table Quota


Type: string
Type: null

Fragmentation


Type: string
Type: null

Size Str


Type: string
Type: null

Allocated Str


Type: string
Type: null

Free Str


Type: string
Type: null

Freeing Str


Type: string
Type: null

Autotrim

Type: object

Example:

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


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

PoolRemovedEvent

Type: object
No Additional Properties

Id

Type: integer


*Required roles:* POOL_READ