# pool.dataset.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: id

#### id

Type: string

##### Parameter 2: options

#### options

Type: object Default: {}

Query options customize the results returned by a query method. More complete documentation with examples are covered in the "Query methods" section of the TrueNAS API documentation.

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.

##

#### PoolDatasetEntry

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

Required roles: DATASET_READ