zfs.resource.snapshot.clone
===========================

Clone a ZFS snapshot to create a new dataset.

A validation error is raised when:

- the source snapshot does not exist
- the destination dataset already exists
- the source is not a snapshot

A filesystem clone that cannot be mounted is kept, and the error names it.

Examples:

Clone a snapshot to a new dataset:

.. code:: json

    {"snapshot": "tank/data@backup", "dataset": "tank/data_clone"}

Clone with properties:

.. code:: json

    {
        "snapshot": "tank/data@backup",
        "dataset": "tank/data_clone",
        "properties": {"compression": "lz4", "quota": "10G"}
    }

.. 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>Clone parameters for cloning ZFS snapshots.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_snapshot">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_snapshot">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_snapshot" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_snapshot" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_snapshot')" type="button"><span class="property-name">snapshot</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_snapshot" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_snapshot" id="Call_parameters_items_i0_snapshot">
    <div class="card-body pl-5">
    <h4>Snapshot</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Source snapshot path to clone (e.g., 'pool/dataset@snapshot').</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_snapshot_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_dataset">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_dataset">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_dataset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_dataset" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_dataset')" type="button"><span class="property-name">dataset</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_dataset" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_dataset" id="Call_parameters_items_i0_dataset">
    <div class="card-body pl-5">
    <h4>Dataset</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Destination dataset path for the clone (e.g., 'pool/clone').</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_dataset_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_properties">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_properties">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_properties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_properties" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_properties')" type="button"><span class="property-name">properties</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_properties" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_properties" id="Call_parameters_items_i0_properties">
    <div class="card-body pl-5">
    <h4>Properties</h4><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {}</span><br/>
    <span class="description"><p>ZFS properties to set on the cloned dataset.</p>
    </span>
    <div class="accordion" id="accordionCall_parameters_items_i0_properties_additionalProperties">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_properties_additionalProperties">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_properties_additionalProperties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_properties_additionalProperties" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_properties_additionalProperties')" type="button"><em><span class="property-name">Additional Properties</span></em></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_properties_additionalProperties" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_properties_additionalProperties" id="Call_parameters_items_i0_properties_additionalProperties">
    <div class="card-body pl-5"><p class="additional-properties">Each additional property must conform to the following schema</p>
    <br/>
    <div class="any-of-value" id="Call_parameters_items_i0_properties_additionalProperties_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_properties_additionalProperties_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_properties_additionalProperties_anyOf_i0" id="Call_parameters_items_i0_properties_additionalProperties_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_properties_additionalProperties_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_i0_properties_additionalProperties_anyOf_i1" id="Call_parameters_items_i0_properties_additionalProperties_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_properties_additionalProperties_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_i0_properties_additionalProperties_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_properties_additionalProperties_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_no_mount">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_no_mount">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_no_mount" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_no_mount" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_no_mount')" type="button"><span class="property-name">no_mount</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_no_mount" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_no_mount" id="Call_parameters_items_i0_no_mount">
    <div class="card-body pl-5">
    <h4>No Mount</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>Do not mount the clone after creating it. Volume clones are never mounted.</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