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 carrying the ZFSTIER feature. The call fails when the system is not entitled to this feature.

.. 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_update</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>zfs_tier_update</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>ZfsTierUpdateArgs parameters.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_enabled">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_enabled">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_enabled" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_enabled" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_enabled" id="Call_parameters_items_i0_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether the ZFS tier service is enabled.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_max_concurrent_jobs">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_max_concurrent_jobs">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_max_concurrent_jobs" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_max_concurrent_jobs" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_max_concurrent_jobs')" type="button"><span class="property-name">max_concurrent_jobs</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_max_concurrent_jobs" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_max_concurrent_jobs" id="Call_parameters_items_i0_max_concurrent_jobs">
    <div class="card-body pl-5">
    <h4>Max Concurrent Jobs</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>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).</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_max_concurrent_jobs_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>10</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_max_used_percentage">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_max_used_percentage">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_max_used_percentage" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_max_used_percentage" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_max_used_percentage')" type="button"><span class="property-name">max_used_percentage</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_max_used_percentage" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_max_used_percentage" id="Call_parameters_items_i0_max_used_percentage">
    <div class="card-body pl-5">
    <h4>Max Used Percentage</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Abort rewrites when filesystem usage reaches this percentage threshold (70-95).</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_max_used_percentage_number">Value must be greater or equal to <code>70</code> and lesser or equal to <code>95</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_special_class_metadata_reserve_pct">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_special_class_metadata_reserve_pct">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_special_class_metadata_reserve_pct" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_special_class_metadata_reserve_pct" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_special_class_metadata_reserve_pct')" type="button"><span class="property-name">special_class_metadata_reserve_pct</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_special_class_metadata_reserve_pct" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_special_class_metadata_reserve_pct" id="Call_parameters_items_i0_special_class_metadata_reserve_pct">
    <div class="card-body pl-5">
    <h4>Special Class Metadata Reserve Pct</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>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 <code>100 - special_class_metadata_reserve_pct</code> percent of total PERFORMANCE tier capacity. Beyond that threshold data falls back to the REGULAR tier. Corresponds to the ZFS kernel parameter <code>zfs_special_class_metadata_reserve_pct</code> (default: 25).</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_special_class_metadata_reserve_pct_number">Value must be greater or equal to <code>10</code> and lesser or equal to <code>30</code></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>ZfsTierEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The updated ZFS tier daemon configuration.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Placeholder identifier. Not used; there is only one configuration instance.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_enabled">
    <div class="card">
    <div class="card-header" id="headingReturn_value_enabled">
    <h2 class="mb-0">
    <button aria-controls="Return_value_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_enabled" data-toggle="collapse" onclick="setAnchor('#Return_value_enabled')" type="button"><span class="property-name">enabled</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_enabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_enabled" id="Return_value_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>Whether the ZFS tier service is enabled.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_max_concurrent_jobs">
    <div class="card">
    <div class="card-header" id="headingReturn_value_max_concurrent_jobs">
    <h2 class="mb-0">
    <button aria-controls="Return_value_max_concurrent_jobs" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_max_concurrent_jobs" data-toggle="collapse" onclick="setAnchor('#Return_value_max_concurrent_jobs')" type="button"><span class="property-name">max_concurrent_jobs</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_max_concurrent_jobs" class="collapse property-definition-div" data-parent="#accordionReturn_value_max_concurrent_jobs" id="Return_value_max_concurrent_jobs">
    <div class="card-body pl-5">
    <h4>Max Concurrent Jobs</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>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).</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_max_concurrent_jobs_number">Value must be greater or equal to <code>1</code> and lesser or equal to <code>10</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_max_used_percentage">
    <div class="card">
    <div class="card-header" id="headingReturn_value_max_used_percentage">
    <h2 class="mb-0">
    <button aria-controls="Return_value_max_used_percentage" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_max_used_percentage" data-toggle="collapse" onclick="setAnchor('#Return_value_max_used_percentage')" type="button"><span class="property-name">max_used_percentage</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_max_used_percentage" class="collapse property-definition-div" data-parent="#accordionReturn_value_max_used_percentage" id="Return_value_max_used_percentage">
    <div class="card-body pl-5">
    <h4>Max Used Percentage</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Abort rewrites when filesystem usage reaches this percentage threshold (70-95).</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_max_used_percentage_number">Value must be greater or equal to <code>70</code> and lesser or equal to <code>95</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_special_class_metadata_reserve_pct">
    <div class="card">
    <div class="card-header" id="headingReturn_value_special_class_metadata_reserve_pct">
    <h2 class="mb-0">
    <button aria-controls="Return_value_special_class_metadata_reserve_pct" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_special_class_metadata_reserve_pct" data-toggle="collapse" onclick="setAnchor('#Return_value_special_class_metadata_reserve_pct')" type="button"><span class="property-name">special_class_metadata_reserve_pct</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_special_class_metadata_reserve_pct" class="collapse property-definition-div" data-parent="#accordionReturn_value_special_class_metadata_reserve_pct" id="Return_value_special_class_metadata_reserve_pct">
    <div class="card-body pl-5">
    <h4>Special Class Metadata Reserve Pct</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>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 <code>100 - special_class_metadata_reserve_pct</code> percent of total PERFORMANCE tier capacity. Beyond that threshold data falls back to the REGULAR tier. Corresponds to the ZFS kernel parameter <code>zfs_special_class_metadata_reserve_pct</code> (default: 25).</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_special_class_metadata_reserve_pct_number">Value must be greater or equal to <code>10</code> and lesser or equal to <code>30</code></span></p>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* ZFS_RESOURCE_WRITE