zfs.tier.dataset_set_tier

Set the performance tier for a ZFS dataset, optionally migrating existing data.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: zfs_tier_dataset_set_tier

zfs_tier_dataset_set_tier

Type: object

ZfsTierDatasetSetTierArgs parameters.

No Additional Properties

dataset_name Required

Dataset Name

Type: string

ZFS dataset to configure (e.g. tank/data).

Must be at least 1 characters long

tier_type Required

Tier Type

Type: enum (of string)

Storage performance tier for this dataset.

Must be one of:

• "REGULAR"
• "PERFORMANCE"

move_existing_data

Move Existing Data

Type: boolean Default: false

When true, immediately create a rewrite job to physically migrate existing data to match the new tier.

Return value

TierInfo

Type: object

Updated tier info for the dataset. If move_existing_data was true, tier_job will contain the newly created rewrite job.

No Additional Properties

tier_type Required

Tier Type

Type: enum (of string)

Storage performance tier for this share.

Must be one of:

• "REGULAR"
• "PERFORMANCE"

tier_job

Default: null

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

Any of

• ZfsTierRewriteJobEntry
• Option 2

ZfsTierRewriteJobEntry

Type: object
No Additional Properties

tier_job_id Required

Tier Job Id

Type: string

Rewrite job identifier in dataset_name@job_uuid format.

Must be at least 1 characters long

dataset_name Required

Dataset Name

Type: string

ZFS dataset this job is operating on.

Must be at least 1 characters long

job_uuid Required

Job Uuid

Type: string

Unique identifier for this rewrite job.

Must be at least 1 characters long

status Required

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

Required roles: DATASET_WRITE