pool.dataset.set_quota
======================

Allow users to set multiple quotas simultaneously by submitting a list of quotas.

.. 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: dataset</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>dataset</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>The name of the target ZFS dataset.</p> </span> </div> </div> <h5>Parameter 2: quotas</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1"> <h4>quotas</h4><span class="badge badge-dark value-type">Type: array of object</span> <div class="json-default-value">Default:<div class="value">[
      {
        "quota_type": "USER",
        "id": "0",
        "quota_value": 0
      }
    ]</div></div><br/> <span class="description"><p>Specify an array of quota entries to apply to dataset. The array may contain all supported quota types.</p> </span> <p><span class="badge badge-light restriction max-items-restriction" id="Call_parameters_items_i1_maxItems">Must contain a maximum of <code>100</code> items</span></p> <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1_items"> <h4>PoolDatasetSetQuota</h4><span class="badge badge-dark value-type">Type: object</span><br/> <span class="badge badge-info no-additional">No Additional Properties</span> <div class="accordion" id="accordionCall_parameters_items_i1_items_quota_type"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_items_quota_type"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_items_quota_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_items_quota_type" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_items_quota_type')" type="button"><span class="property-name">quota_type</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_items_quota_type" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_items_quota_type" id="Call_parameters_items_i1_items_quota_type"> <div class="card-body pl-5"> <h4>Quota Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <span class="description"><p>The type of quota to apply to the dataset. There are three over-arching types of quotas for ZFS datasets:</p> <p>1) Dataset quotas and refquotas. If a <code>DATASET</code> quota type is specified in this API call, then the API acts as a<br/> wrapper for <code>pool.dataset.update</code>.</p> <p>2) User and group quotas. These limit the amount of disk space consumed by files that are owned by the specified<br/> users or groups. If the respective "object quota" type is specfied, then the quota limits the number of objects<br/> that may be owned by the specified user or group.</p> <p>3) Project quotas. These limit the amount of disk space consumed by files that are owned by the specified project.<br/> Project quotas are not yet implemented.</p> </span><div class="enum-value" id="Call_parameters_items_i1_items_quota_type_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"DATASET"</li><li class="list-group-item enum-item">"USER"</li><li class="list-group-item enum-item">"USEROBJ"</li><li class="list-group-item enum-item">"GROUP"</li><li class="list-group-item enum-item">"GROUPOBJ"</li></ul> </div> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_items_id"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_items_id"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_items_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_items_id" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_items_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_items_id" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_items_id" id="Call_parameters_items_i1_items_id"> <div class="card-body pl-5"> <h4>Id</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>The UID, GID, or name to which the quota applies. If <code>quota_type</code> is 'DATASET', then <code>id</code> must be either <code>QUOTA</code><br/> or <code>REFQUOTA</code>.</p> </span> </div> </div> </div> </div> <div class="accordion" id="accordionCall_parameters_items_i1_items_quota_value"> <div class="card"> <div class="card-header" id="headingCall_parameters_items_i1_items_quota_value"> <h2 class="mb-0"> <button aria-controls="Call_parameters_items_i1_items_quota_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_items_quota_value" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_items_quota_value')" type="button"><span class="property-name">quota_value</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div aria-labelledby="headingCall_parameters_items_i1_items_quota_value" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_items_quota_value" id="Call_parameters_items_i1_items_quota_value"> <div class="card-body pl-5"> <h4>Quota Value</h4><br/> <span class="description"><p>The quota size in bytes. Setting a value of <code>0</code> removes the user or group quota.</p> </span><div class="any-of-value" id="Call_parameters_items_i1_items_quota_value_anyOf"><h2 class="handle"> <label>Any of</label> </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_items_quota_value_anyOf_anyOf" role="tablist"><li class="nav-item"> <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_items_quota_value_anyOf_i0" id="Call_parameters_items_i1_items_quota_value_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_items_quota_value_anyOf_i0')" role="tab">Option 1</a> </li><li class="nav-item"> <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_items_quota_value_anyOf_i1" id="Call_parameters_items_i1_items_quota_value_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_items_quota_value_anyOf_i1')" role="tab">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i1_items_quota_value_anyOf_i0" role="tabpanel"> <span class="badge badge-dark value-type">Type: integer</span><br/> </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_items_quota_value_anyOf_i1" role="tabpanel"> <span class="badge badge-dark value-type">Type: null</span><br/> </div></div></div> </div> </div> </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>Result</h4><span class="badge badge-dark value-type">Type: null</span><br/> </div> </div> </div> </div> </div><br><br>

*Required roles:* DATASET_WRITE