pool.snapshot.create
====================

Take a snapshot from a given dataset.

.. 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><br/>
    <span class="description"><p>Configuration for creating a snapshot with either an explicit name or naming schema.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i0_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i0_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_anyOf_i0" id="Call_parameters_items_i0_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0')" role="tab">PoolSnapshotCreateWithName</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i0_anyOf_i1" id="Call_parameters_items_i0_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1')" role="tab">PoolSnapshotCreateWithSchema</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i0_anyOf_i0" role="tabpanel">
    <h4>PoolSnapshotCreateWithName</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_i0_anyOf_i0_dataset">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_dataset">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i0_dataset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_dataset" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_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_anyOf_i0_dataset" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_dataset" id="Call_parameters_items_i0_anyOf_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>Name of the dataset to create a snapshot of.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_anyOf_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_anyOf_i0_recursive">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_recursive">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i0_recursive" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_recursive" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_recursive')" type="button"><span class="property-name">recursive</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i0_recursive" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_recursive" id="Call_parameters_items_i0_anyOf_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>Whether to recursively snapshot child datasets.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i0_exclude">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_exclude">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i0_exclude" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_exclude" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_exclude')" type="button"><span class="property-name">exclude</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i0_exclude" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_exclude" id="Call_parameters_items_i0_anyOf_i0_exclude">
    <div class="card-body pl-5">
    <h4>Exclude</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>Array of dataset patterns to exclude from recursive snapshots.</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_i0_anyOf_i0_exclude_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i0_vmware_sync">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_vmware_sync">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i0_vmware_sync" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_vmware_sync" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_vmware_sync')" type="button"><span class="property-name">vmware_sync</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i0_vmware_sync" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_vmware_sync" id="Call_parameters_items_i0_anyOf_i0_vmware_sync">
    <div class="card-body pl-5">
    <h4>Vmware Sync</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>Whether to sync VMware VMs before taking the snapshot.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i0_properties">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_properties">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i0_properties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_properties" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_properties')" type="button"><span class="property-name">properties</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i0_properties" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_properties" id="Call_parameters_items_i0_anyOf_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>Object mapping ZFS property names to values to set on the snapshot.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i0_name">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i0_name">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i0_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i0_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i0_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i0_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i0_name" id="Call_parameters_items_i0_anyOf_i0_name">
    <div class="card-body pl-5">
    <h4>Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Explicit name for the snapshot.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_anyOf_i0_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i0_anyOf_i1" role="tabpanel">
    <h4>PoolSnapshotCreateWithSchema</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_i0_anyOf_i1_dataset">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_dataset">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i1_dataset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_dataset" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_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_anyOf_i1_dataset" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_dataset" id="Call_parameters_items_i0_anyOf_i1_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>Name of the dataset to create a snapshot of.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_anyOf_i1_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_anyOf_i1_recursive">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_recursive">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i1_recursive" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_recursive" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_recursive')" type="button"><span class="property-name">recursive</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_recursive" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_recursive" id="Call_parameters_items_i0_anyOf_i1_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>Whether to recursively snapshot child datasets.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_exclude">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_exclude">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i1_exclude" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_exclude" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_exclude')" type="button"><span class="property-name">exclude</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_exclude" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_exclude" id="Call_parameters_items_i0_anyOf_i1_exclude">
    <div class="card-body pl-5">
    <h4>Exclude</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>Array of dataset patterns to exclude from recursive snapshots.</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_i0_anyOf_i1_exclude_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_vmware_sync">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_vmware_sync">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i1_vmware_sync" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_vmware_sync" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_vmware_sync')" type="button"><span class="property-name">vmware_sync</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_vmware_sync" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_vmware_sync" id="Call_parameters_items_i0_anyOf_i1_vmware_sync">
    <div class="card-body pl-5">
    <h4>Vmware Sync</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>Whether to sync VMware VMs before taking the snapshot.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_properties">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_properties">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i1_properties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_properties" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_properties')" type="button"><span class="property-name">properties</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_properties" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_properties" id="Call_parameters_items_i0_anyOf_i1_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>Object mapping ZFS property names to values to set on the snapshot.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_anyOf_i1_naming_schema">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_anyOf_i1_naming_schema">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_anyOf_i1_naming_schema" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_anyOf_i1_naming_schema" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_anyOf_i1_naming_schema')" type="button"><span class="property-name">naming_schema</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_anyOf_i1_naming_schema" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_anyOf_i1_naming_schema" id="Call_parameters_items_i0_anyOf_i1_naming_schema">
    <div class="card-body pl-5">
    <h4>Naming Schema</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Naming schema pattern to generate the snapshot name automatically.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_anyOf_i1_naming_schema_minLength">Must be at least <code>1</code> characters long</span></p>
    </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">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Information about the newly created snapshot.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SNAPSHOT_WRITE

