pool.dataset.update

Updates a dataset/zvol id.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

The dataset ID (full path) to update.
Parameter 2: data

data

Type: object

The dataset properties to update.

 No Additional Properties

Comments

Type: string

Comments or description for the dataset.

Sync

Type: enum (of string)

Synchronous write behavior for the dataset.

Must be one of:
  • "STANDARD"
  • "ALWAYS"
  • "DISABLED"
  • "INHERIT"

Snapdev

Type: enum (of string)

Controls visibility of volume snapshots under /dev/zvol/.

Must be one of:
  • "HIDDEN"
  • "VISIBLE"
  • "INHERIT"

Compression

Type: enum (of string)

Compression algorithm to use for the dataset. Higher numbered variants provide better compression but use more CPU. 'INHERIT' uses the parent dataset's setting.

Must be one of:
  • "ON"
  • "OFF"
  • "LZ4"
  • "GZIP"
  • "GZIP-1"
  • "GZIP-9"
  • "ZSTD"
  • "ZSTD-FAST"
  • "ZLE"
  • "LZJB"
  • "ZSTD-1"
  • "ZSTD-2"
  • "ZSTD-3"
  • "ZSTD-4"
  • "ZSTD-5"
  • "ZSTD-6"
  • "ZSTD-7"
  • "ZSTD-8"
  • "ZSTD-9"
  • "ZSTD-10"
  • "ZSTD-11"
  • "ZSTD-12"
  • "ZSTD-13"
  • "ZSTD-14"
  • "ZSTD-15"
  • "ZSTD-16"
  • "ZSTD-17"
  • "ZSTD-18"
  • "ZSTD-19"
  • "ZSTD-FAST-1"
  • "ZSTD-FAST-2"
  • "ZSTD-FAST-3"
  • "ZSTD-FAST-4"
  • "ZSTD-FAST-5"
  • "ZSTD-FAST-6"
  • "ZSTD-FAST-7"
  • "ZSTD-FAST-8"
  • "ZSTD-FAST-9"
  • "ZSTD-FAST-10"
  • "ZSTD-FAST-20"
  • "ZSTD-FAST-30"
  • "ZSTD-FAST-40"
  • "ZSTD-FAST-50"
  • "ZSTD-FAST-60"
  • "ZSTD-FAST-70"
  • "ZSTD-FAST-80"
  • "ZSTD-FAST-90"
  • "ZSTD-FAST-100"
  • "ZSTD-FAST-500"
  • "ZSTD-FAST-1000"
  • "INHERIT"

Exec

Type: enum (of string)

Whether files in this dataset can be executed.

Must be one of:
  • "ON"
  • "OFF"
  • "INHERIT"

Managedby

Type: string

Identifies which service or system manages this dataset.

Must be at least 1 characters long

Quota Warning


Percentage of dataset quota at which to issue a warning. 0-100 or 'INHERIT'.

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

Type: const
Specific value: "INHERIT"

Quota Critical


Percentage of dataset quota at which to issue a critical alert. 0-100 or 'INHERIT'.

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

Type: const
Specific value: "INHERIT"

Refquota Warning


Percentage of reference quota at which to issue a warning. 0-100 or 'INHERIT'.

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

Type: const
Specific value: "INHERIT"

Refquota Critical


Percentage of reference quota at which to issue a critical alert. 0-100 or 'INHERIT'.

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

Type: const
Specific value: "INHERIT"

Reservation

Type: integer

Minimum disk space guaranteed to this dataset and its children in bytes.

Refreservation

Type: integer

Minimum disk space guaranteed to this dataset itself in bytes.

Special Small Block Size


Size threshold below which blocks are stored on special vdevs in bytes.

Type: integer
Type: const
Specific value: "INHERIT"

Copies


Number of copies of data blocks to maintain for redundancy.

Type: integer
Type: const
Specific value: "INHERIT"

Snapdir

Type: enum (of string)

Controls visibility of the .zfs/snapshot directory. 'DISABLED' hides snapshots, 'VISIBLE' shows them, 'HIDDEN' makes them accessible but not listed.

Must be one of:
  • "DISABLED"
  • "VISIBLE"
  • "HIDDEN"
  • "INHERIT"

Deduplication

Type: enum (of string)

Deduplication setting. 'ON' enables dedup, 'VERIFY' enables with checksum verification, 'OFF' disables.

Must be one of:
  • "ON"
  • "VERIFY"
  • "OFF"
  • "INHERIT"

Checksum

Type: enum (of string)

Checksum algorithm to verify data integrity. Higher security algorithms like SHA256 provide better protection but use more CPU.

Must be one of:
  • "ON"
  • "OFF"
  • "FLETCHER2"
  • "FLETCHER4"
  • "SHA256"
  • "SHA512"
  • "SKEIN"
  • "EDONR"
  • "BLAKE3"
  • "INHERIT"

Readonly

Type: enum (of string)

Whether the dataset is read-only.

Must be one of:
  • "ON"
  • "OFF"
  • "INHERIT"

User Properties

Type: array of object

Custom user-defined properties to set on the dataset.

 No Additional Items
Each item of this array must be:

PoolDatasetCreateUserProperty

Type: object
No Additional Properties

Key

Type: string

User property key in namespace:property format.

Must match regular expression: .*:.*
Examples:

"custom:backup_policy"

"org:created_by"

Value

Type: string

The value to assign to the user property.

Create Ancestors

Type: boolean

Whether to create any missing parent datasets.

Force Size

Type: boolean

Force creation even if the size is not optimal.

Volsize

Type: integer

The volume size in bytes; supposed to be a multiple of the block size.

Aclmode

Type: enum (of string)

How Access Control Lists are handled when chmod is used.

Must be one of:
  • "PASSTHROUGH"
  • "RESTRICTED"
  • "DISCARD"
  • "INHERIT"

Acltype

Type: enum (of string)

The type of Access Control List system to use.

Must be one of:
  • "OFF"
  • "NFSV4"
  • "POSIX"
  • "INHERIT"

Atime

Type: enum (of string)

Whether file access times are updated when files are accessed.

Must be one of:
  • "ON"
  • "OFF"
  • "INHERIT"

Quota


Maximum disk space this dataset and its children can consume in bytes.

Type: integer

Value must be greater or equal to 1073741824

Type: enum (of integer or null)
Must be one of:
  • 0
  • null

Refquota


Maximum disk space this dataset itself can consume in bytes.

Type: integer

Value must be greater or equal to 1073741824

Type: enum (of integer or null)
Must be one of:
  • 0
  • null

Recordsize

Type: string

The suggested block size for files in this filesystem dataset.

User Properties Update

Type: array of object

Array of user property updates to apply to the dataset.

 No Additional Items
Each item of this array must be:

PoolDatasetUpdateUserProperty

Type: object
No Additional Properties

Key

Type: string

User property key in namespace:property format.

Must match regular expression: .*:.*
Examples:

"custom:backup_policy"

"org:created_by"

Value

Type: string

New value for the user property. Not required if removing the property.

Remove

Type: boolean

Whether to remove this user property from the dataset.

Type: object

The updated dataset information.


Required roles: DATASET_WRITE