zfs.resource.snapshot.rename
============================

Rename a ZFS snapshot.

A validation error is raised when:

- the snapshot does not exist
- the new name already exists
- a supplied path is invalid

Examples:

Rename a single snapshot:

.. code:: json

    {"current_name": "tank/data@old", "new_name": "tank/data@new"}

Rename matching snapshots in child datasets:

.. code:: json

    {"current_name": "tank@old", "new_name": "tank@new", "recursive": true}

.. 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: data</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>data</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Rename parameters for renaming ZFS snapshots.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_current_name">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_current_name">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_current_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_current_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_current_name')" type="button"><span class="property-name">current_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_current_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_current_name" id="Call_parameters_items_i0_current_name">
    <div class="card-body pl-5">
    <h4>Current Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Current snapshot path (e.g., 'pool/dataset@old_name').</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_current_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_new_name">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_new_name">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_new_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_new_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_new_name')" type="button"><span class="property-name">new_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_new_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_new_name" id="Call_parameters_items_i0_new_name">
    <div class="card-body pl-5">
    <h4>New Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>New snapshot path (e.g., 'pool/dataset@new_name').</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_new_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_recursive">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_recursive">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_recursive" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_recursive" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_recursive')" type="button"><span class="property-name">recursive</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_recursive" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_recursive" id="Call_parameters_items_i0_recursive">
    <div class="card-body pl-5">
    <h4>Recursive</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Recursively rename matching snapshots in child datasets.</p>
    </span>
    </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:* SNAPSHOT_WRITE