zfs.tier.rewrite_job_create
===========================

Create a new rewrite job for the specified ZFS dataset.

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionCall_parameters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters">
    <div class="card-body pl-5">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4>
    <h5>Parameter 1: zfs_tier_rewrite_job_create</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>zfs_tier_rewrite_job_create</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>ZfsTierRewriteJobCreateArgs parameters.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_dataset_name">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_dataset_name">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_dataset_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_dataset_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_dataset_name')" type="button"><span class="property-name">dataset_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_dataset_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_dataset_name" id="Call_parameters_items_i0_dataset_name">
    <div class="card-body pl-5">
    <h4>Dataset Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>ZFS dataset to rewrite (e.g. <code>tank/data</code>). Only one job may exist per dataset at     a time; creating a second returns an error.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_dataset_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>ZfsTierRewriteJobEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The newly created rewrite job, initially in <code>QUEUED</code> state.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_tier_job_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_tier_job_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_tier_job_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_tier_job_id" data-toggle="collapse" onclick="setAnchor('#Return_value_tier_job_id')" type="button"><span class="property-name">tier_job_id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_tier_job_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_tier_job_id" id="Return_value_tier_job_id">
    <div class="card-body pl-5">
    <h4>Tier Job Id</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Rewrite job identifier in <code>dataset_name@job_uuid</code> format.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_tier_job_id_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_dataset_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_dataset_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_dataset_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_dataset_name" data-toggle="collapse" onclick="setAnchor('#Return_value_dataset_name')" type="button"><span class="property-name">dataset_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_dataset_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_dataset_name" id="Return_value_dataset_name">
    <div class="card-body pl-5">
    <h4>Dataset Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>ZFS dataset this job is operating on.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_dataset_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_job_uuid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_job_uuid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_job_uuid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_job_uuid" data-toggle="collapse" onclick="setAnchor('#Return_value_job_uuid')" type="button"><span class="property-name">job_uuid</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_job_uuid" class="collapse property-definition-div" data-parent="#accordionReturn_value_job_uuid" id="Return_value_job_uuid">
    <div class="card-body pl-5">
    <h4>Job Uuid</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Unique identifier for this rewrite job.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_job_uuid_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_status">
    <div class="card">
    <div class="card-header" id="headingReturn_value_status">
    <h2 class="mb-0">
    <button aria-controls="Return_value_status" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_status" data-toggle="collapse" onclick="setAnchor('#Return_value_status')" type="button"><span class="property-name">status</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_status" class="collapse property-definition-div" data-parent="#accordionReturn_value_status" id="Return_value_status">
    <div class="card-body pl-5">
    <h4>Status</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Current lifecycle state of the job.</p>
    <ul>
    <li><code>COMPLETE</code> - All files in the dataset have been processed.</li>
    <li><code>RUNNING</code> - Job is actively processing files.</li>
    <li><code>QUEUED</code> - Job is waiting for a free execution slot (see <code>max_concurrent_jobs</code>).</li>
    <li><code>CANCELLED</code> - Job was stopped via <code>zfs_tier_job.cancel</code>. Not resumable.</li>
    <li><code>STOPPED</code> - 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.</li>
    <li><code>ERROR</code> - Job halted due to an unrecoverable error. Use <code>zfs_tier_job.recover</code> to     retry failed files.</li>
    </ul>
    </span><div class="enum-value" id="Return_value_status_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"COMPLETE"</li><li class="list-group-item enum-item">"RUNNING"</li><li class="list-group-item enum-item">"QUEUED"</li><li class="list-group-item enum-item">"CANCELLED"</li><li class="list-group-item enum-item">"STOPPED"</li><li class="list-group-item enum-item">"ERROR"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* DATASET_WRITE