# zfs.resource.query

Query ZFS resources (datasets and volumes) with flexible filtering options.

This method provides a high-performance interface for retrieving information about ZFS resources, including their properties, hierarchical relationships, and metadata. The query can be customized to retrieve specific resources, properties, and control the output format.

Raises: ValidationError: If: - Snapshot paths are provided (must use get_snapshots = True) - Overlapping paths are provided with get_children=True

Examples: # Query all resources with default properties query()

> # Query specific resources with all properties query({“paths”: [“tank/documents”, “tank/media”]})

> # Query with specific properties and children query({ “paths”: [“tank”], “properties”: [“mounted”, “compression”, “used”], “get_children”: True })

> # Get hierarchical view of resources query({“paths”: [“tank”], “nest_results”: True, “get_children”: True})

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: data

#### data

Type: object
Default:
{ "paths": [], "properties": [], "get_user_properties": false, "get_source": false, "nest_results": false, "get_children": false, "get_snapshots": false, "max_depth": 0 }

Query parameters for retrieving ZFS resource information.

No Additional Properties

##

#### Paths

Type: array of string Default: []

A list of zfs filesystem or volume paths to be queried. In almost all scenarios, you should provide a path of what you want to query. By providing path(s) here, it allows the API to apply optimizations so that the requested information is retrieved as efficiently and quickly as possible.

Example 1:
{"paths": ["tank/foo"]} will query the relevant information for this resource only.
Example 2:
{"paths": ["tank/foo", "dozer/test"]} will query the relevant information for these resources only.

NOTE:
paths must be non-overlapping if `get_children` is True.
(i.e. this won't work and will raise a validation error)
{
"paths": ["tank/foo1", "tank/foo1/foo2"],
"get_children": True
}

All items must be unique

No Additional Items

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

Type: string

##

#### Properties

Default: []

A list of zfs properties to be retrieved. Defaults to an empty list which will return a default set of zfs properties.
Setting this to None will retrieve no zfs properties.

## Any of

Type: array of string
No Additional Items

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

Type: string
Type: null

##

#### Get User Properties

Type: boolean Default: false

Retrieve user properties for zfs resource(s).

##

#### Get Source

Type: boolean Default: false

Retrieve source information for a zfs property.

##

#### Nest Results

Type: boolean Default: false

Return a nested object that associates all children to their respective parents in the filesystem. By default, each zfs resource is returned as a separate item in the array and is not associated to its parent.

##

#### Get Children

Type: boolean Default: false

Retrieve children information for the zfs resource.

##

#### Get Snapshots

Type: boolean Default: false

Retrieve snapshot information for the zfs resource.

##

#### Max Depth

Type: integer Default: 0

Maximum depth to recurse when retrieving children.
A value of 0 means unlimited recursion (default behavior).
A value greater than 0 limits the recursion to that many levels deep.

When maxdepth > 0, getchildren is automatically enabled if not already set.

Examples:
maxdepth=0: Retrieve all descendants (unlimited depth)
maxdepth=1: Retrieve only immediate children
maxdepth=2: Retrieve children and grandchildren
maxdepth=3: Retrieve up to great-grandchildren

Note: When maxdepth > 0 is specified, it takes priority over getchildren.
The depth is measured from the specified path(s), not from the pool root.

##

#### Result

Type: array of object
No Additional Items

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

#### ZFSResourceEntry

Type: object
No Additional Properties

##

#### Createtxg

Type: integer

Transaction group when resource was created.

##

#### Guid

Type: integer

Globally unique identifier for the resource.

##

#### Name

Type: string

The name of the zfs resource.

##

#### Pool

Type: string

The name of the zpool that the zfs resouce is associated to.

##

The zfs properties for the resource.

## Any of

#### ZFSPropertiesEntry

Type: object
No Additional Properties

##

#### Aclinherit

Type: object

Controls how ACEs are inherited for new files/directories.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

#### SourceValue

Type: object
No Additional Properties

##

#### Type

Type: enum (of string)

The source type.

##### Must be one of:

- "NONE"
- "DEFAULT"
- "TEMPORARY"
- "LOCAL"
- "INHERITED"
- "RECEIVED"

##

#### Value

The source value.

## Any of

Type: string
Type: null
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Aclmode

Type: object

Determines how ACLs are modified during chmod operations.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Acltype

Type: object

Specifies type of ACL to use (off, nfsv4, posix).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Atime

Type: object

Controls whether access time is updated on file reads.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Canmount

Type: object

Controls whether filesystem can be mounted.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Casesensitivity

Type: object

Determines filename matching algorithm sensitivity.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Defaultgroupobjquota

Type: object

Default object quota for new groups.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Defaultgroupquota

Type: object

Default space quota for new groups.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Defaultprojectobjquota

Type: object

Default object quota for new projects.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Defaultprojectquota

Type: object

Default space quota for new projects.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Defaultuserobjquota

Type: object

Default object quota for new users.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Defaultuserquota

Type: object

Default space quota for new users.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Devices

Type: object

Controls whether device files can be opened.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Direct

Type: object

Controls direct I/O behavior (standard or always).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Dnodesize

Type: object

Controls dnode size for new objects.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Exec

Type: object

Controls whether programs can be executed from filesystem.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Filesystem Count

Type: object

(READ-ONLY): Count of child filesystems.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Filesystem Limit

Type: object

Maximum number of child filesystems allowed.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Longname

Type: object

Controls support for long filenames.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Mounted

Type: object

(READ-ONLY): Property indicating if filesystem is mounted.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Mountpoint

Type: object

Controls mount point used for this filesystem.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Nbmand

Type: object

Controls non-blocking mandatory locking behavior.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Normalization

Type: object

Unicode normalization property for filenames.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Overlay

Type: object

Controls overlay mount behavior.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Quota

Type: object

Limits space consumed by dataset and descendants.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Recordsize

Type: object

Maximum block size for files in this filesystem.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Refquota

Type: object

Limits space consumed by dataset itself (no descendants).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Refreservation

Type: object

Minimum space reserved for volume itself.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Relatime

Type: object

Controls relative access time updates.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Setuid

Type: object

Controls setuid/setgid bit respect on executable files.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Sharenfs

Type: object

Controls NFS sharing options for the filesystem.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Sharesmb

Type: object

Controls SMB/CIFS sharing options for the filesystem.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Snapdir

Type: object

Controls snapshot directory visibility (hidden or visible).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Special Small Blocks

Type: object

Size threshold for storing blocks on special vdevs.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Utf8Only

Type: object

Controls whether only UTF-8 filenames are allowed.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Version

Type: object

(READ-ONLY): Filesystem version number.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Volmode

Type: object

Controls volume mode (default, geom, dev, none).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Vscan

Type: object

Controls virus scanning behavior.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Xattr

Type: object

Controls extended attribute behavior (on, off, sa, dir).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Zoned

Type: object

Controls whether filesystem is managed from a zone.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Available

Type: object

Amount of space available to dataset and its children.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Checksum

Type: object

Controls checksum algorithm used to verify data integrity.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Compression

Type: object

Controls compression algorithm used for this dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Compressratio

Type: object

(READ-ONLY): Property showing achieved compression ratio.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Context

Type: object

SELinux security context for the dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Copies

Type: object

Controls number of copies of data stored (1, 2, or 3).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Createtxg

Type: object

(READ-ONLY): Transaction group when dataset was created.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Creation

Type: object

(READ-ONLY): Timestamp when dataset was created.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Dedup

Type: object

Controls data deduplication for the dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Defcontext

Type: object

SELinux default security context for new files.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Encryption

Type: object

Controls encryption cipher suite for the dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Encryptionroot

Type: object

(READ-ONLY): Property showing encryption root dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Fscontext

Type: object

SELinux filesystem security context.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Guid

Type: object

(READ-ONLY): Globally unique identifier for the dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Keyformat

Type: object

Encryption key format (raw, hex, or passphrase).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Keylocation

Type: object

Location where encryption key is stored.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Keystatus

Type: object

(READ-ONLY): Encryption key status (available/unavailable).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Logbias

Type: object

Controls ZIL write behavior (latency or throughput).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Logicalreferenced

Type: object

(READ-ONLY): Logical space referenced by dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Logicalused

Type: object

(READ-ONLY): Logical space used by dataset and descendants.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Mlslabel

Type: object

Multi-level security label for the dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Objsetid

Type: object

(READ-ONLY): Object set identifier for the dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Origin

Type: object

(READ-ONLY): Snapshot this dataset was cloned from.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Pbkdf2Iters

Type: object

Number of PBKDF2 iterations for key derivation.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Prefetch

Type: object

Controls prefetch behavior (all, metadata, or none).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Primarycache

Type: object

Controls primary cache usage (all, metadata, or none).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Readonly

Type: object

Controls whether dataset can be modified.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Receive Resume Token

Type: object

(READ-ONLY): Token for resuming interrupted zfs receive.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Redact Snaps

Type: object

(READ-ONLY): List of redaction snapshots.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Redundant Metadata

Type: object

Controls redundant metadata storage (all or most).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Refcompressratio

Type: object

(READ-ONLY): Compression ratio for referenced data.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Referenced

Type: object

(READ-ONLY): Space referenced by this dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Reservation

Type: object

Minimum space reserved for dataset and descendants.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Rootcontext

Type: object

SELinux root directory security context.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Secondarycache

Type: object

Controls secondary cache usage (all, metadata, or none).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Snapdev

Type: object

Controls snapshot device visibility (hidden or visible).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Snapshot Count

Type: object

(READ-ONLY): Count of snapshots in this dataset.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Snapshot Limit

Type: object

Maximum number of snapshots allowed.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Snapshots Changed

Type: object

(READ-ONLY): Property indicating snapshot changes.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Sync

Type: object

Controls synchronous write behavior (standard, always, disabled).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Type

(READ-ONLY): Type of ZFS dataset (filesystem, volume, etc).

## Any of

#### PropertyValue

Type: object
No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null
Type: null

##

#### Used

Type: object

(READ-ONLY): Space used by dataset and descendants.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Usedbychildren

Type: object

(READ-ONLY): Space used by child datasets.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Usedbydataset

Type: object

(READ-ONLY): Space used by this dataset itself.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Usedbyrefreservation

Type: object

(READ-ONLY): Space used by refreservation.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Usedbysnapshots

Type: object

(READ-ONLY): Space used by snapshots.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Written

Type: object

(READ-ONLY): Space referenced since previous snapshot.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Volblocksize

Type: object

Block size for volume (typically 8K or 16K).

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Volsize

Type: object

Logical size of the volume.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null

##

#### Volthreading

Type: object

Controls volume threading behavior.

No Additional Properties

##

#### Raw

Type: string

The raw value of the property.

##

The source from where this property received its value.

## Any of

Type: object
Type: null

##

#### Value

The parsed raw value of the property.

## Any of

Type: integer
Type: number
Type: string
Type: boolean
Type: null
Type: null

##

#### Type

Type: enum (of string)

The type of ZFS resource.

##### Must be one of:

- "FILESYSTEM"
- "VOLUME"

##

#### User Properties

Custom metadata properties with colon-separated names (max 256 chars).

## Any of

Type: object

##

Each additional property must conform to the following schema

Type: string
Type: null

##

#### Children

The children of this zfs resource.

## Any of

Type: array
No Additional Items

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

Type: object
Type: null

##

#### Snapshots

Snapshots for this zfs resource.

## Any of

Type: object

##

Each additional property must conform to the following schema

Type: object
Type: null

Required roles: ZFS_RESOURCE_READ