pool.snapshot.update
====================

Update the user properties of the snapshot identified by ``snap_id``.

.. 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: id</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>id</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>ID of the snapshot to update.</p>
    </span>
    </div>
    </div>
    <h5>Parameter 2: data</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1">
    <h4>data</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The property updates to apply to the snapshot.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_user_properties_update">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_user_properties_update">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_user_properties_update" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_user_properties_update" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_user_properties_update')" type="button"><span class="property-name">user_properties_update</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_user_properties_update" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_user_properties_update" id="Call_parameters_items_i1_user_properties_update">
    <div class="card-body pl-5">
    <h4>User Properties Update</h4><span class="badge badge-dark value-type">Type: array of object</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>Properties to update.</p>
    </span>
    <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_user_properties_update_items">
    <h4>PoolSnapshotUserPropertyUpdate</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_user_properties_update_items_key">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_user_properties_update_items_key">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_user_properties_update_items_key" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_user_properties_update_items_key" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_user_properties_update_items_key')" type="button"><span class="property-name">key</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_user_properties_update_items_key" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_user_properties_update_items_key" id="Call_parameters_items_i1_user_properties_update_items_key">
    <div class="card-body pl-5">
    <h4>Key</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>The property name in namespace:property format.</p>
    </span><span class="pattern-value" id="Call_parameters_items_i1_user_properties_update_items_key_pattern">Must match regular expression: <code>.*:.*</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_user_properties_update_items_value">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_user_properties_update_items_value">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_user_properties_update_items_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_user_properties_update_items_value" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_user_properties_update_items_value')" type="button"><span class="property-name">value</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_user_properties_update_items_value" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_user_properties_update_items_value" id="Call_parameters_items_i1_user_properties_update_items_value">
    <div class="card-body pl-5">
    <h4>Value</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>The new value to assign to the user property.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_user_properties_remove">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_user_properties_remove">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_user_properties_remove" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_user_properties_remove" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_user_properties_remove')" type="button"><span class="property-name">user_properties_remove</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_user_properties_remove" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_user_properties_remove" id="Call_parameters_items_i1_user_properties_remove">
    <div class="card-body pl-5">
    <h4>User Properties Remove</h4><span class="badge badge-dark value-type">Type: array of string</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>Properties to remove.</p>
    </span>
    <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_user_properties_remove_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>ZFS user property key in namespace:property format (e.g., 'custom:backup<em>policy', 'org:created</em>by').</p>
    </span><span class="pattern-value" id="Call_parameters_items_i1_user_properties_remove_items_pattern">Must match regular expression: <code>.*:.*</code></span>
    </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">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Information about the updated snapshot.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SNAPSHOT_WRITE

