# pool.dataset.query

Query Pool Datasets with query-filters and query-options.

We provide two ways to retrieve datasets. The first is a flat structure (default), where all datasets in the system are returned as separate objects which contain all data there is for their children. This retrieval type is slightly slower because of duplicates in each object. The second type is hierarchical, where only top level datasets are returned in the list. They contain all the children in the children key. This retrieval type is slightly faster. These options are controlled by the query-options.extra.flat attribute (default true).

In some cases it might be desirable to only retrieve details of a dataset itself and not it’s children, in this case query-options.extra.retrieve_children should be explicitly specified and set to false which will result in children not being retrieved.

In case only some properties are desired to be retrieved for datasets, consumer should specify query-options.extra.properties which when null ( which is the default ) will retrieve all properties and otherwise a list can be specified like [“type”, “used”, “available”] to retrieve selective properties. If no properties are desired, in that case an empty list should be sent. It should be noted that specifying empty list will still retrieve user properties. If user properties are not desired, in that case query-options.extra.retrieve_user_props should be set to false.

query-options.extra.snapshots can be set to retrieve snapshot(s) of dataset in question.

query-options.extra.snapshots_recursive can be set to retrieve snapshot(s) recursively of dataset in question. If query-options.extra.snapshots_recursive and query-options.extra.snapshots are set, snapshot(s) will be retrieved recursively.

query-options.extra.snapshots_properties can be specified to list out properties which should be retrieved for snapshot(s) related to each dataset. By default only name of the snapshot would be retrieved, however if null is specified all properties of the snapshot would be retrieved in this case.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: filters

#### filters

Type: array Default: []

List of filters for query results. See API documentation for "Query Methods" for more guidance.

No Additional Items

##### Each item of this array must be:

Type: object
Examples:

    [
        [
            "name",
            "=",
            "bob"
        ]
    ]

    [
        [
            "OR",
            [
                [
                    [
                        "name",
                        "=",
                        "bob"
                    ]
                ],
                [
                    [
                        "name",
                        "=",
                        "larry"
                    ]
                ]
            ]
        ]
    ]

##### Parameter 2: options

#### options

Type: object
Default:
{ "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

Query options including pagination, ordering, and additional parameters.

No Additional Properties

##

#### Extra

Type: object Default: {}

Extra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.

##

#### Order By

Type: array of string Default: []

An array of field names describing the manner in which query results should be ordered. The field names may also have one of more of the following special prefixes: `-` (reverse sort direction), `nulls_first:` (place any null values at the head of the results list), `nulls_last:` (place any null values at the tail of the results list).

No Additional Items

##### Each item of this array must be:

Type: string
Example:

    [
        "size",
        "-devname",
        "nulls_first:-expiretime"
    ]

##

#### Select

Type: array Default: []

An array of field names specifying the exact fields to include in the query return. The dot character `.` may be used to explicitly select only subkeys of the query result.

No Additional Items

##### Each item of this array must be:

## Any of

Type: string
Type: array
No Additional Items

##### Each item of this array must be:

Type: object
Example:

    [
        "username",
        "Authentication.status"
    ]

##

#### Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified `query-filters`.

##

#### Get

Type: boolean Default: false

Return the JSON object of the first result matching the specified `query-filters`. The query fails if there specified `query-filters` return no results.

##

#### Offset

Type: integer Default: 0

This specifies the beginning offset of the results array. When combined with the `limit` query-option it may be used to implement pagination of large results arrays. WARNING: some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

##

#### Limit

Type: integer Default: 0

This specifies the maximum number of results matching the specified `query-filters` to return. When combined wtih the `offset` query-option it may be used to implement pagination of large results arrays.

WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether pagination is appropriate for a particular query API method.

##

#### Force Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

##

#### Result

## Any of

Type: array of object
No Additional Items

##### Each item of this array must be:

#### PoolDatasetQueryResultItem

Type: object

##

#### Id

Type: string

The full dataset path including pool name.

Example:

    "tank/dataset/child"

##

#### Type

Type: string

The dataset type.

Examples:

    "FILESYSTEM"

    "VOLUME"

##

#### Name

Type: string

The dataset name without the pool prefix.

##

#### Pool

Type: string

The name of the ZFS pool containing this dataset.

##

#### Encrypted

Type: boolean

Whether the dataset is encrypted.

##

#### Encryption Root

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

## Any of

Type: string
Type: null

##

#### Key Loaded

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

## Any of

Type: boolean
Type: null

##

#### 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

Type: object

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

##

#### Locked

Type: boolean

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

##

#### PoolDatasetEntryProperty

Type: object

ZFS comments property for storing descriptive text about the dataset.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

ZFS quota warning threshold property as a percentage.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

ZFS quota critical threshold property as a percentage.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

ZFS reference quota warning threshold property as a percentage.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

ZFS reference quota critical threshold property as a percentage.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Identifies which service or system manages this dataset.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Extended attributes storage method (on/off).

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Whether file access times are updated when files are accessed.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

File name case sensitivity setting (sensitive/insensitive).

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Data integrity checksum algorithm used for this dataset.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Whether files in this dataset can be executed.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Synchronous write behavior (standard/always/disabled).

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Compression algorithm and level applied to data in this dataset.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Whether the dataset is read-only.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

The suggested block size for files in this filesystem dataset.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

For volumes, the logical size of the volume.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

For volumes, the block size used by the volume.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Amount of disk space consumed by child datasets.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Amount of disk space consumed by snapshots of this dataset.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

Timestamp when this dataset was created.

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### PoolDatasetEntryProperty

Type: object

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

No Additional Properties

##

#### Parsed

Type: object

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

##

#### Rawvalue

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

## Any of

Type: string
Type: null

##

#### Value

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

## Any of

Type: string
Type: null

##

#### Source

Indicates where the property value originates from.

## Any of

Type: string
Type: null
Examples:

    "LOCAL"

    "INHERITED"

    "DEFAULT"

##

#### Source Info

Type: object

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

##

#### Mountpoint

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

## Any of

Type: string
Type: null

##

Additional Properties of any type are allowed.

Type: object

#### PoolDatasetQueryResultItem

Type: object

##

#### Id

Type: string

The full dataset path including pool name.

Example:

    "tank/dataset/child"

##

#### Type

Type: string

The dataset type.

Examples:

    "FILESYSTEM"

    "VOLUME"

##

#### Name

Type: string

The dataset name without the pool prefix.

##

#### Pool

Type: string

The name of the ZFS pool containing this dataset.

##

#### Encrypted

Type: boolean

Whether the dataset is encrypted.

##

#### Encryption Root

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

## Any of

Type: string
Type: null

##

#### Key Loaded

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

## Any of

Type: boolean
Type: null

##

#### 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

Type: object

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

##

#### Locked

Type: boolean

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

##

Type: object

ZFS comments property for storing descriptive text about the dataset.

##

Type: object

ZFS quota warning threshold property as a percentage.

##

Type: object

ZFS quota critical threshold property as a percentage.

##

Type: object

ZFS reference quota warning threshold property as a percentage.

##

Type: object

ZFS reference quota critical threshold property as a percentage.

##

Type: object

Identifies which service or system manages this dataset.

##

Type: object

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

##

Type: object

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

##

Type: object

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

##

Type: object

Extended attributes storage method (on/off).

##

Type: object

Whether file access times are updated when files are accessed.

##

Type: object

File name case sensitivity setting (sensitive/insensitive).

##

Type: object

Data integrity checksum algorithm used for this dataset.

##

Type: object

Whether files in this dataset can be executed.

##

Type: object

Synchronous write behavior (standard/always/disabled).

##

Type: object

Compression algorithm and level applied to data in this dataset.

##

Type: object

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

##

Type: object

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

##

Type: object

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

##

Type: object

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

##

Type: object

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

##

Type: object

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

##

Type: object

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

##

Type: object

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

##

Type: object

Whether the dataset is read-only.

##

Type: object

The suggested block size for files in this filesystem dataset.

##

Type: object

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

##

Type: object

For volumes, the logical size of the volume.

##

Type: object

For volumes, the block size used by the volume.

##

Type: object

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

##

Type: object

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

##

Type: object

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

##

Type: object

Amount of disk space consumed by child datasets.

##

Type: object

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

##

Type: object

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

##

Type: object

Amount of disk space consumed by snapshots of this dataset.

##

Type: object

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

##

Type: object

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

##

Type: object

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

##

Type: object

Timestamp when this dataset was created.

##

Type: object

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

##

#### Mountpoint

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

## Any of

Type: string
Type: null

##

Additional Properties of any type are allowed.

Type: object
Type: integer

Required roles: DATASET_READ