zfs.tier.update

Update the global ZFS tiering configuration.

Controls whether tiering is enabled, how many rewrite jobs may run concurrently, the filesystem usage threshold at which rewrites are aborted, and the percentage of PERFORMANCE tier space reserved for metadata. Applying the new configuration regenerates the truenas_zfstierd daemon configuration and reloads (or restarts, if max_concurrent_jobs changed) the daemon.

ZFS tiering requires a license. A JSON-RPC error response (code -32001, Method call error) is returned when the system is not licensed for this feature.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: zfs_tier_update

zfs_tier_update

Type: object

ZfsTierUpdateArgs parameters.

 No Additional Properties

Enabled

Type: boolean

Whether the ZFS tier service is enabled.

Max Concurrent Jobs

Type: integer

Maximum number of rewrite jobs that execute simultaneously. Jobs submitted beyond this limit are held in a QUEUED state until a slot becomes available (1-10).

Value must be greater or equal to 1 and lesser or equal to 10

Max Used Percentage

Type: integer

Abort rewrites when filesystem usage reaches this percentage threshold (70-95).

Value must be greater or equal to 70 and lesser or equal to 95

Special Class Metadata Reserve Pct

Type: integer

Percentage of PERFORMANCE tier space reserved for metadata. Metadata is always written to the PERFORMANCE tier, but data is only placed there while allocated space stays below 100 - special_class_metadata_reserve_pct percent of total PERFORMANCE tier capacity. Beyond that threshold data falls back to the REGULAR tier. Corresponds to the ZFS kernel parameter zfs_special_class_metadata_reserve_pct (default: 25).

Value must be greater or equal to 10 and lesser or equal to 30

ZfsTierEntry

Type: object

The updated ZFS tier daemon configuration.

 No Additional Properties

Id

Type: integer

Placeholder identifier. Not used; there is only one configuration instance.

Enabled

Type: boolean

Whether the ZFS tier service is enabled.

Max Concurrent Jobs

Type: integer

Maximum number of rewrite jobs that execute simultaneously. Jobs submitted beyond this limit are held in a QUEUED state until a slot becomes available (1-10).

Value must be greater or equal to 1 and lesser or equal to 10

Max Used Percentage

Type: integer

Abort rewrites when filesystem usage reaches this percentage threshold (70-95).

Value must be greater or equal to 70 and lesser or equal to 95

Special Class Metadata Reserve Pct

Type: integer

Percentage of PERFORMANCE tier space reserved for metadata. Metadata is always written to the PERFORMANCE tier, but data is only placed there while allocated space stays below 100 - special_class_metadata_reserve_pct percent of total PERFORMANCE tier capacity. Beyond that threshold data falls back to the REGULAR tier. Corresponds to the ZFS kernel parameter zfs_special_class_metadata_reserve_pct (default: 25).

Value must be greater or equal to 10 and lesser or equal to 30



Required roles: DATASET_WRITE