zfs.tier.rewrite_job_create

Create a new rewrite job for the specified ZFS dataset.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: zfs_tier_rewrite_job_create

zfs_tier_rewrite_job_create

Type: object

ZfsTierRewriteJobCreateArgs parameters.

 No Additional Properties

Dataset Name

Type: string

ZFS dataset to rewrite (e.g. tank/data). Only one job may exist per dataset at a time; creating a second returns an error.

Must be at least 1 characters long

ZfsTierRewriteJobEntry

Type: object

The newly created rewrite job, initially in QUEUED state.

 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"


Required roles: DATASET_WRITE