zfs.resource.create

Create a ZFS resource (filesystem or volume) and mount it.

Properties are given by native ZFS property name - exactly the names zfs.resource.query returns - and are handed to ZFS as-is. The created resource is re-queried after creation and returned, so the entry reflects the values as canonicalized by ZFS, not the input.

To create snapshots, use zfs.resource.snapshot.create instead.

Invalid input is returned to the client as a JSON-RPC error response (code -32602, Invalid params); each failing condition appears in the error’s data.extra array with its own errno. A validation error is raised when:

  • a snapshot path (containing @) is supplied (use zfs.resource.snapshot.create)

  • the resource already exists (EEXIST)

  • the pool, or the parent dataset when create_ancestors is false, does not exist (ENOENT)

  • the target is a pool root filesystem, the path is absolute, ends with /, or is not a valid ZFS name (EINVAL)

  • the path references a protected internal resource (EACCES)

  • a property outside the allowed creation set is supplied, or an allowed property is invalid for the resource type or has an invalid value (EINVAL)

  • an encryption or ZFS native sharing property is supplied through properties, volsize is missing for a VOLUME, or a user property name lacks a colon (EINVAL)

  • encryption provides a hex key beneath a passphrase-encrypted parent, or would create an encryption root beneath an unencrypted dataset that itself sits inside an encrypted one (EINVAL)

  • a thick volume’s reservation would consume more than 80% of the available space - create a sparse volume (refreservation of none) to deliberately oversubscribe (EINVAL)

  • the effective acltype and aclmode combination is unusable - a posix or off acltype requires a discard aclmode and a discard aclmode may not be combined with the nfsv4 acltype (EINVAL)

  • the nearest existing ancestor is readonly - the new filesystem could not be mounted beneath it (EINVAL)

  • special_small_blocks is supplied while ZFS tiering is enabled - placement is managed with zfs.tier.dataset_set_tier (EINVAL)

  • deduplication is requested for a filesystem whose data would be placed on the SPECIAL vdev (the PERFORMANCE tier) while ZFS tiering is enabled (EINVAL)

Examples:

Create a filesystem:

{"path": "tank/documents"}

Create a filesystem with properties, creating missing ancestors:

{
    "path": "tank/a/b/documents",
    "properties": {"compression": "lz4", "atime": "off"},
    "create_ancestors": true
}

Create a sparse 10GiB volume:

{
    "path": "tank/vol1",
    "type": "VOLUME",
    "properties": {"volsize": 10737418240, "refreservation": "none"}
}

Create an encryption root with a generated key:

{"path": "tank/secure", "encryption": {"generate_key": true}}

Create an encryption root protected by a passphrase:

{"path": "tank/private", "encryption": {"passphrase": "correct horse battery staple"}}

Note

Volumes are thick-provisioned by default (refreservation defaults to the volsize, like zfs create -V); set refreservation to none for a sparse volume. Filesystems default xattr to sa.

Note

A resource created under an encrypted parent inherits that encryption unless encryption makes it its own encryption root - an unencrypted child cannot be created beneath an encrypted parent. The parent’s encryption key must be loaded (unlocked) or the creation fails with a JSON-RPC error response (code -32001, Method call error, errno EACCES).

Note

Hex keys (provided or generated) are stored by the system and may be retrieved with pool.dataset.export_key; passphrases are never stored.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Create parameters for creating a ZFS resource.

 No Additional Properties

Path

Type: string

Path of the zfs resource (dataset or volume) to be created. Must be of the form 'pool/name'. It cannot be an absolute path or end with '/'. Snapshot paths (containing '@') are not accepted one must use zfs.resource.snapshot.create instead.

Must be at least 1 characters long

Type

Type: enum (of string) Default: "FILESYSTEM"

The type of ZFS resource to create. A FILESYSTEM is a mountable dataset; a VOLUME (zvol) is a virtual block device.

Must be one of:
  • "FILESYSTEM"
  • "VOLUME"

ZFSResourceCreateProperties

Type: object

ZFS properties to set at creation time. Values are handed to ZFS verbatim and canonicalized by ZFS itself. Read the returned entry for the effective values. A property left as null is simply not sent to ZFS and inherits from the parent as usual. Any property not in this model may not be set at creation time.

Creating a VOLUME requires 'volsize'. Volumes are thick-provisioned by default ('refreservation' defaults to the volsize, like zfs create -V). Set 'refreservation' to 'none' to create a sparse (thin) volume.

A FILESYSTEM defaults 'xattr' to 'sa' (a TrueNAS performance default) unless explicitly specified. An explicit 'acltype' also defaults the coupled acl properties. An nfsv4 acltype defaults 'aclinherit' to 'passthrough' while a posix or off acltype defaults both 'aclmode' and 'aclinherit' to 'discard'.

Encryption is configured through the encryption argument and shares are managed with the sharing.nfs and sharing.smb APIs. Neither may be configured through these properties.

 No Additional Properties

Aclinherit

Default: null

ACL inheritance behavior for new files and directories.

Type: string
Type: null

Aclmode

Default: null

How ACLs are modified during chmod operations.

Type: string
Type: null

Acltype

Default: null

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

Type: string
Type: null

Atime

Default: null

Whether file access times are updated on read.

Type: string
Type: null

Casesensitivity

Default: null

Filename matching sensitivity. Settable at creation time only.

Type: string
Type: null

Checksum

Default: null

Checksum algorithm used to verify data integrity.

Type: string
Type: null

Compression

Default: null

Compression algorithm for the resource.

Type: string
Type: null

Copies

Default: null

Number of copies of data blocks to store.

Type: string
Type: integer
Type: null

Dedup

Default: null

Deduplication setting for the resource.

Type: string
Type: null

Exec

Default: null

Whether programs can be executed from the filesystem.

Type: string
Type: null

Quota

Default: null

Maximum space the dataset and its descendants may consume.

Type: string
Type: integer
Type: null

Readonly

Default: null

Whether the resource can be modified.

Type: string
Type: null

Recordsize

Default: null

Suggested block size for files in the filesystem.

Type: string
Type: integer
Type: null

Refquota

Default: null

Maximum space the dataset itself may consume.

Type: string
Type: integer
Type: null

Refreservation

Default: null

Minimum space reserved for the resource itself. Set to 'none' to create a sparse volume.

Type: string
Type: integer
Type: null

Reservation

Default: null

Minimum space reserved for the dataset and its descendants.

Type: string
Type: integer
Type: null

Snapdev

Default: null

Snapshot device visibility under /dev/zvol.

Type: string
Type: null

Snapdir

Default: null

Visibility of the .zfs/snapshot directory.

Type: string
Type: null

Special Small Blocks

Default: null

Size threshold below which blocks are stored on the SPECIAL vdev.

Type: string
Type: integer
Type: null

Sync

Default: null

Synchronous write behavior.

Type: string
Type: null

Volblocksize

Default: null

Block size of the volume. Settable at creation time only.

Type: string
Type: integer
Type: null

Volsize

Default: null

Logical size of the volume in bytes. Required when creating a VOLUME.

Type: string
Type: integer
Type: null

Xattr

Default: null

Extended attribute storage mode. Defaults to 'sa' for performance.

Type: string
Type: null

User Properties

Type: object Default: {}

User properties to set at creation time. Property names must contain a colon (e.g. 'org.truenas:custom').

Each additional property must conform to the following schema

Type: string

Create Ancestors

Type: boolean Default: false

Create any missing ancestor filesystems.

Default: null

Make the new resource its own ZFS encryption root, encrypted (aes-256-gcm) with the given key or passphrase. When omitted (the default), the resource simply inherits its parent's encryption state. A child of an encrypted parent is encrypted as part of the parent's encryption root, a child of an unencrypted parent is unencrypted.

A key-encrypted root may NOT be created beneath a passphrase-encrypted parent. Such a child could not be unlocked while its parent is locked.

ZFSResourceCreateEncryption

Type: object

Exactly one of key, passphrase, or generate_key must be provided.

 No Additional Properties

Generate Key

Type: boolean Default: false

Automatically generate a 64-character hex key for the new encryption root.

Key

Default: ""

A 64-character hex-encoded key for the new encryption root.

Type: string
Must match regular expression: ^[0-9a-fA-F]+$

Must be at least 64 characters long

Must be at most 64 characters long

Type: null

Passphrase

Default: ""

A passphrase (at least 8 characters) for the new encryption root. Passphrases are never stored by the system. The resource can only be unlocked by someone who knows it.

Type: string

Must be at least 8 characters long

Type: null

Pbkdf2Iters

Type: integer Default: 1300000

Number of PBKDF2 iterations for key derivation from the passphrase. Only meaningful together with passphrase. Higher values improve resistance to brute force attacks but increase unlock time.

Value must be greater or equal to 1300000 and lesser or equal to 10000000

Type: null

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.

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.

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.

Type: string
Type: null
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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

Type


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

PropertyValue

Type: object
No Additional Properties

Raw

Type: string

The raw value of the property.


The source from where this property received its value.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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.

Type: object
Type: null

Value


The parsed raw value of the property.

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).

Type: object

Each additional property must conform to the following schema

Type: string
Type: null

Children


The children of this zfs resource.

Type: array
No Additional Items
Each item of this array must be:
Type: object
Type: null

Default: null

Tier classification for FILESYSTEM resources. None if not requested, not applicable, or deduplication is enabled on the dataset.

TierInfo

Type: object
No Additional Properties

Tier Type

Type: enum (of string)

Storage performance tier for this share.

Must be one of:
  • "REGULAR"
  • "PERFORMANCE"

Default: null

Most recent rewrite job for this share's dataset, or null if no job history exists.

ZfsTierRewriteJobEntry

Type: object
No Additional Properties

Tier Job Id

Type: string

Rewrite job identifier in dataset_name@job_uuid format.

Must be at least 1 characters long

Dataset Name

Type: string

ZFS dataset this job is operating on.

Must be at least 1 characters long

Job Uuid

Type: string

Unique identifier for this rewrite job.

Must be at least 1 characters long

Status

Type: enum (of string)

Current lifecycle state of the job.

  • COMPLETE - All files in the dataset have been processed.
  • RUNNING - Job is actively processing files.
  • QUEUED - Job is waiting for a free execution slot (see max_concurrent_jobs).
  • CANCELLED - Job was stopped via zfs_tier_job.cancel. Not resumable.
  • STOPPED - Job was RUNNING but its process is no longer active (e.g. daemon restart). This state is computed on read and is never written to persistent storage.
  • ERROR - Job halted due to an unrecoverable error. Use zfs_tier_job.recover to retry failed files.
Must be one of:
  • "COMPLETE"
  • "RUNNING"
  • "QUEUED"
  • "CANCELLED"
  • "STOPPED"
  • "ERROR"
Type: null
Type: null


Required roles: ZFS_RESOURCE_WRITE