pool.dataset.query

Sent on pool.dataset changes.

Type: object

ADDED

PoolDatasetAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: string

fields Required

PoolDatasetEntry

Type: object

id

Id

Type: string

The full dataset path including pool name.

Example:

"tank/dataset/child"

type

Type

Type: string

The dataset type.

Examples:

"FILESYSTEM"

"VOLUME"

name

Name

Type: string

The dataset name without the pool prefix.

pool

Pool

Type: string

The name of the ZFS pool containing this dataset.

encrypted

Encrypted

Type: boolean

Whether the dataset is encrypted.

encryption_root

Encryption Root

The root dataset where encryption is enabled. null if the dataset is not encrypted.

Any of

• Option 1
• Option 2

Type: string

Type: null

key_loaded

Key Loaded

Whether the encryption key is currently loaded for encrypted datasets. null for unencrypted datasets.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

children

Children

Type: array

Array of child dataset objects nested under this dataset.

No Additional Items

Each item of this array must be:

Type: object

user_properties

User Properties

Type: object

Custom user-defined ZFS properties set on this dataset as key-value pairs.

locked

Locked

Type: boolean

Whether an encrypted dataset is currently locked (key not loaded).

comments

PoolDatasetEntryProperty

Type: object

ZFS comments property for storing descriptive text about the dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

quota_warning

PoolDatasetEntryProperty

Type: object

ZFS quota warning threshold property as a percentage.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

quota_critical

PoolDatasetEntryProperty

Type: object

ZFS quota critical threshold property as a percentage.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

refquota_warning

PoolDatasetEntryProperty

Type: object

ZFS reference quota warning threshold property as a percentage.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

refquota_critical

PoolDatasetEntryProperty

Type: object

ZFS reference quota critical threshold property as a percentage.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

managedby

PoolDatasetEntryProperty

Type: object

Identifies which service or system manages this dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

deduplication

PoolDatasetEntryProperty

Type: object

ZFS deduplication setting - whether identical data blocks are stored only once.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

aclmode

PoolDatasetEntryProperty

Type: object

How Access Control Lists (ACLs) are handled when chmod is used.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

acltype

PoolDatasetEntryProperty

Type: object

The type of Access Control List system used (NFSV4, POSIX, or OFF).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

xattr

PoolDatasetEntryProperty

Type: object

Extended attributes storage method (on/off).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

atime

PoolDatasetEntryProperty

Type: object

Whether file access times are updated when files are accessed.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

casesensitivity

PoolDatasetEntryProperty

Type: object

File name case sensitivity setting (sensitive/insensitive).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

checksum

PoolDatasetEntryProperty

Type: object

Data integrity checksum algorithm used for this dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

exec

PoolDatasetEntryProperty

Type: object

Whether files in this dataset can be executed.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

sync

PoolDatasetEntryProperty

Type: object

Synchronous write behavior (standard/always/disabled).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

compression

PoolDatasetEntryProperty

Type: object

Compression algorithm and level applied to data in this dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

compressratio

PoolDatasetEntryProperty

Type: object

The achieved compression ratio as a decimal (e.g., '2.50x').

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

origin

PoolDatasetEntryProperty

Type: object

The snapshot from which this clone was created. Empty for non-clone datasets.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

quota

PoolDatasetEntryProperty

Type: object

Maximum amount of disk space this dataset and its children can consume.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

refquota

PoolDatasetEntryProperty

Type: object

Maximum amount of disk space this dataset itself can consume (excluding children).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

reservation

PoolDatasetEntryProperty

Type: object

Minimum amount of disk space guaranteed to be available to this dataset and its children.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

refreservation

PoolDatasetEntryProperty

Type: object

Minimum amount of disk space guaranteed to be available to this dataset itself.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

copies

PoolDatasetEntryProperty

Type: object

Number of copies of data blocks to maintain for redundancy (1-3).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

snapdir

PoolDatasetEntryProperty

Type: object

Visibility of the .zfs/snapshot directory (visible/hidden).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

readonly

PoolDatasetEntryProperty

Type: object

Whether the dataset is read-only.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

recordsize

PoolDatasetEntryProperty

Type: object

The suggested block size for files in this filesystem dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

sparse

PoolDatasetEntryProperty

Type: object

For volumes, whether to use sparse (thin) provisioning.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

volsize

PoolDatasetEntryProperty

Type: object

For volumes, the logical size of the volume.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

volblocksize

PoolDatasetEntryProperty

Type: object

For volumes, the block size used by the volume.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

key_format

PoolDatasetEntryProperty

Type: object

Format of the encryption key (hex/raw/passphrase). Only relevant for encrypted datasets.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

encryption_algorithm

PoolDatasetEntryProperty

Type: object

Encryption algorithm used (e.g., AES-256-GCM). Only relevant for encrypted datasets.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

used

PoolDatasetEntryProperty

Type: object

Total amount of disk space consumed by this dataset and all its children.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

usedbychildren

PoolDatasetEntryProperty

Type: object

Amount of disk space consumed by child datasets.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

usedbydataset

PoolDatasetEntryProperty

Type: object

Amount of disk space consumed by this dataset itself, excluding children and snapshots.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

usedbyrefreservation

PoolDatasetEntryProperty

Type: object

Amount of disk space consumed by the refreservation of this dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

usedbysnapshots

PoolDatasetEntryProperty

Type: object

Amount of disk space consumed by snapshots of this dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

available

PoolDatasetEntryProperty

Type: object

Amount of disk space available to this dataset and its children.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

special_small_block_size

PoolDatasetEntryProperty

Type: object

Size threshold below which blocks are stored on special vdevs if configured.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

pbkdf2iters

PoolDatasetEntryProperty

Type: object

Number of PBKDF2 iterations used for passphrase-based encryption keys.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

creation

PoolDatasetEntryProperty

Type: object

Timestamp when this dataset was created.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

snapdev

PoolDatasetEntryProperty

Type: object

Controls visibility of volume snapshots under /dev/zvol/<pool>/.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

mountpoint

Mountpoint

Filesystem path where this dataset is mounted. Null for unmounted datasets or volumes.

Any of

• Option 1
• Option 2

Type: string

Type: null

Additional Properties

Additional Properties of any type are allowed.

Type: object

CHANGED

PoolDatasetChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: string

fields Required

PoolDatasetEntry

Type: object

id

Id

Type: string

The full dataset path including pool name.

Example:

"tank/dataset/child"

type

Type

Type: string

The dataset type.

Examples:

"FILESYSTEM"

"VOLUME"

name

Name

Type: string

The dataset name without the pool prefix.

pool

Pool

Type: string

The name of the ZFS pool containing this dataset.

encrypted

Encrypted

Type: boolean

Whether the dataset is encrypted.

encryption_root

Encryption Root

The root dataset where encryption is enabled. null if the dataset is not encrypted.

Any of

• Option 1
• Option 2

Type: string

Type: null

key_loaded

Key Loaded

Whether the encryption key is currently loaded for encrypted datasets. null for unencrypted datasets.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

children

Children

Type: array

Array of child dataset objects nested under this dataset.

No Additional Items

Each item of this array must be:

Type: object

user_properties

User Properties

Type: object

Custom user-defined ZFS properties set on this dataset as key-value pairs.

locked

Locked

Type: boolean

Whether an encrypted dataset is currently locked (key not loaded).

comments

PoolDatasetEntryProperty

Type: object

ZFS comments property for storing descriptive text about the dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

quota_warning

PoolDatasetEntryProperty

Type: object

ZFS quota warning threshold property as a percentage.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

quota_critical

PoolDatasetEntryProperty

Type: object

ZFS quota critical threshold property as a percentage.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

refquota_warning

PoolDatasetEntryProperty

Type: object

ZFS reference quota warning threshold property as a percentage.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

refquota_critical

PoolDatasetEntryProperty

Type: object

ZFS reference quota critical threshold property as a percentage.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

managedby

PoolDatasetEntryProperty

Type: object

Identifies which service or system manages this dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

deduplication

PoolDatasetEntryProperty

Type: object

ZFS deduplication setting - whether identical data blocks are stored only once.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

aclmode

PoolDatasetEntryProperty

Type: object

How Access Control Lists (ACLs) are handled when chmod is used.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

acltype

PoolDatasetEntryProperty

Type: object

The type of Access Control List system used (NFSV4, POSIX, or OFF).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

xattr

PoolDatasetEntryProperty

Type: object

Extended attributes storage method (on/off).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

atime

PoolDatasetEntryProperty

Type: object

Whether file access times are updated when files are accessed.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

casesensitivity

PoolDatasetEntryProperty

Type: object

File name case sensitivity setting (sensitive/insensitive).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

checksum

PoolDatasetEntryProperty

Type: object

Data integrity checksum algorithm used for this dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

exec

PoolDatasetEntryProperty

Type: object

Whether files in this dataset can be executed.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

sync

PoolDatasetEntryProperty

Type: object

Synchronous write behavior (standard/always/disabled).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

compression

PoolDatasetEntryProperty

Type: object

Compression algorithm and level applied to data in this dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

compressratio

PoolDatasetEntryProperty

Type: object

The achieved compression ratio as a decimal (e.g., '2.50x').

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

origin

PoolDatasetEntryProperty

Type: object

The snapshot from which this clone was created. Empty for non-clone datasets.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

quota

PoolDatasetEntryProperty

Type: object

Maximum amount of disk space this dataset and its children can consume.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

refquota

PoolDatasetEntryProperty

Type: object

Maximum amount of disk space this dataset itself can consume (excluding children).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

reservation

PoolDatasetEntryProperty

Type: object

Minimum amount of disk space guaranteed to be available to this dataset and its children.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

refreservation

PoolDatasetEntryProperty

Type: object

Minimum amount of disk space guaranteed to be available to this dataset itself.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

copies

PoolDatasetEntryProperty

Type: object

Number of copies of data blocks to maintain for redundancy (1-3).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

snapdir

PoolDatasetEntryProperty

Type: object

Visibility of the .zfs/snapshot directory (visible/hidden).

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

readonly

PoolDatasetEntryProperty

Type: object

Whether the dataset is read-only.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

recordsize

PoolDatasetEntryProperty

Type: object

The suggested block size for files in this filesystem dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

sparse

PoolDatasetEntryProperty

Type: object

For volumes, whether to use sparse (thin) provisioning.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

volsize

PoolDatasetEntryProperty

Type: object

For volumes, the logical size of the volume.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

volblocksize

PoolDatasetEntryProperty

Type: object

For volumes, the block size used by the volume.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

key_format

PoolDatasetEntryProperty

Type: object

Format of the encryption key (hex/raw/passphrase). Only relevant for encrypted datasets.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

encryption_algorithm

PoolDatasetEntryProperty

Type: object

Encryption algorithm used (e.g., AES-256-GCM). Only relevant for encrypted datasets.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

used

PoolDatasetEntryProperty

Type: object

Total amount of disk space consumed by this dataset and all its children.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

usedbychildren

PoolDatasetEntryProperty

Type: object

Amount of disk space consumed by child datasets.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

usedbydataset

PoolDatasetEntryProperty

Type: object

Amount of disk space consumed by this dataset itself, excluding children and snapshots.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

usedbyrefreservation

PoolDatasetEntryProperty

Type: object

Amount of disk space consumed by the refreservation of this dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

usedbysnapshots

PoolDatasetEntryProperty

Type: object

Amount of disk space consumed by snapshots of this dataset.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

available

PoolDatasetEntryProperty

Type: object

Amount of disk space available to this dataset and its children.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

special_small_block_size

PoolDatasetEntryProperty

Type: object

Size threshold below which blocks are stored on special vdevs if configured.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

pbkdf2iters

PoolDatasetEntryProperty

Type: object

Number of PBKDF2 iterations used for passphrase-based encryption keys.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

creation

PoolDatasetEntryProperty

Type: object

Timestamp when this dataset was created.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

snapdev

PoolDatasetEntryProperty

Type: object

Controls visibility of volume snapshots under /dev/zvol/<pool>/.

No Additional Properties

parsed

Parsed

Type: object

The ZFS property value parsed into the appropriate type (string, boolean, integer, etc.).

rawvalue

Rawvalue

The raw string value of the ZFS property as stored in the pool. Can be null if not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

The current effective value of the ZFS property as a string. Can be null if inherited or not set.

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Indicates where the property value originates from.

Any of

• Option 1
• Option 2

Type: string

Type: null

Examples:

"LOCAL"

"INHERITED"

"DEFAULT"

source_info

Source Info

Type: object

Additional metadata about the property source, such as the parent dataset for inherited values.

mountpoint

Mountpoint

Filesystem path where this dataset is mounted. Null for unmounted datasets or volumes.

Any of

• Option 1
• Option 2

Type: string

Type: null

Additional Properties

Additional Properties of any type are allowed.

Type: object

REMOVED

PoolDatasetRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: string

Required roles: DATASET_READ