pool.snapshot.get_instance
==========================

Returns instance matching `id`. If `id` is not found, Validation error is raised.

Please see `query` method documentation for `options`.

.. 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/>
    </div>
    </div>
    <h5>Parameter 2: options</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i1">
    <h4>options</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>Query options customize the results returned by a query method. More complete documentation with examples     are covered in the "Query methods" section of the TrueNAS API documentation. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_extra">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_extra">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_extra" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_extra" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_extra')" type="button"><span class="property-name">extra</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_extra" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_extra" id="Call_parameters_items_i1_extra">
    <div class="card-body pl-5">
    <h4>Extra</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>Extra options are defined on a per-endpoint basis and are described in the documentation for the associated     query method. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_order_by">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_order_by">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_order_by" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_order_by" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_order_by')" type="button"><span class="property-name">order_by</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_order_by" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_order_by" id="Call_parameters_items_i1_order_by">
    <div class="card-body pl-5">
    <h4>Order By</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>An array of field names describing the manner in which query results should be ordered. The field names may     also have one of more of the following special prefixes: <code>-</code> (reverse sort direction), <code>nulls_first:</code> (place     any null values at the head of the results list), <code>nulls_last:</code> (place any null values at the tail of the     results list). </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_order_by_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_order_by_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"size"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"-devname"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"nulls_first:-expiretime"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_select">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_select">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_select" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_select" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_select')" type="button"><span class="property-name">select</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_select" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_select" id="Call_parameters_items_i1_select">
    <div class="card-body pl-5">
    <h4>Select</h4><span class="badge badge-dark value-type">Type: array</span> <span class="badge badge-success default-value">Default: []</span><br/>
    <span class="description"><p>An array of field names specifying the exact fields to include in the query return. The dot character <code>.</code>     may be used to explicitly select only subkeys of the query result. </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_select_items">
    <br/>
    <div class="any-of-value" id="Call_parameters_items_i1_select_items_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_select_items_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_select_items_anyOf_i0" id="Call_parameters_items_i1_select_items_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_select_items_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_select_items_anyOf_i1" id="Call_parameters_items_i1_select_items_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_select_items_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_select_items_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_i1_select_items_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <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_select_items_anyOf_i1_items">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div>
    </div>
    </div></div></div>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_select_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"username"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"Authentication.status"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_count">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_count">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_count" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_count" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_count')" type="button"><span class="property-name">count</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_count" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_count" id="Call_parameters_items_i1_count">
    <div class="card-body pl-5">
    <h4>Count</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>Return a numeric value representing the number of items that match the specified <code>query-filters</code>. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_get">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_get">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_get" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_get" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_get')" type="button"><span class="property-name">get</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_get" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_get" id="Call_parameters_items_i1_get">
    <div class="card-body pl-5">
    <h4>Get</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>Return the JSON object of the first result matching the specified <code>query-filters</code>. The query fails     if there specified <code>query-filters</code> return no results. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_offset">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_offset">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_offset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_offset" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_offset')" type="button"><span class="property-name">offset</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_offset" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_offset" id="Call_parameters_items_i1_offset">
    <div class="card-body pl-5">
    <h4>Offset</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/>
    <span class="description"><p>This specifies the beginning offset of the results array. When combined with the <code>limit</code> query-option     it may be used to implement pagination of large results arrays. WARNING: some query methods provide     volatile results and the onus is on the developer to understand whether pagination is appropriate     for a particular query API method. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_limit">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_limit">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_limit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_limit" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_limit')" type="button"><span class="property-name">limit</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_limit" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_limit" id="Call_parameters_items_i1_limit">
    <div class="card-body pl-5">
    <h4>Limit</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 0</span><br/>
    <span class="description"><p>This specifies the maximum number of results matching the specified <code>query-filters</code> to return. When     combined wtih the <code>offset</code> query-option it may be used to implement pagination of large results arrays.</p>
    <p>WARNING: Some query methods provide volatile results and the onus is on the developer to understand whether     pagination is appropriate for a particular query API method. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_force_sql_filters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_force_sql_filters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_force_sql_filters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_force_sql_filters" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_force_sql_filters')" type="button"><span class="property-name">force_sql_filters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_force_sql_filters" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_force_sql_filters" id="Call_parameters_items_i1_force_sql_filters">
    <div class="card-body pl-5">
    <h4>Force Sql Filters</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>Force use of SQL for result filtering to reduce response time. May not work for all methods.</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>PoolSnapshotEntry</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="accordionReturn_value_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_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>Full snapshot identifier including dataset and snapshot name.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_properties">
    <div class="card">
    <div class="card-header" id="headingReturn_value_properties">
    <h2 class="mb-0">
    <button aria-controls="Return_value_properties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_properties" data-toggle="collapse" onclick="setAnchor('#Return_value_properties')" type="button"><span class="property-name">properties</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_properties" class="collapse property-definition-div" data-parent="#accordionReturn_value_properties" id="Return_value_properties">
    <div class="card-body pl-5">
    <h4>Properties</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Object mapping ZFS property names to their values and metadata.</p>
    </span>
    <div class="accordion" id="accordionReturn_value_properties_additionalProperties">
    <div class="card">
    <div class="card-header" id="headingReturn_value_properties_additionalProperties">
    <h2 class="mb-0">
    <button aria-controls="Return_value_properties_additionalProperties" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_properties_additionalProperties" data-toggle="collapse" onclick="setAnchor('#Return_value_properties_additionalProperties')" type="button"><em><span class="property-name">Additional Properties</span></em></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_properties_additionalProperties" class="collapse property-definition-div" data-parent="#accordionReturn_value_properties_additionalProperties" id="Return_value_properties_additionalProperties">
    <div class="card-body pl-5"><p class="additional-properties">Each additional property must conform to the following schema</p>
    <h4>PoolSnapshotEntryPropertyFields</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="accordionReturn_value_properties_additionalProperties_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value_properties_additionalProperties_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value_properties_additionalProperties_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_properties_additionalProperties_value" data-toggle="collapse" onclick="setAnchor('#Return_value_properties_additionalProperties_value')" type="button"><span class="property-name">value</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_properties_additionalProperties_value" class="collapse property-definition-div" data-parent="#accordionReturn_value_properties_additionalProperties_value" id="Return_value_properties_additionalProperties_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>Current effective value of the ZFS property as a string.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_properties_additionalProperties_rawvalue">
    <div class="card">
    <div class="card-header" id="headingReturn_value_properties_additionalProperties_rawvalue">
    <h2 class="mb-0">
    <button aria-controls="Return_value_properties_additionalProperties_rawvalue" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_properties_additionalProperties_rawvalue" data-toggle="collapse" onclick="setAnchor('#Return_value_properties_additionalProperties_rawvalue')" type="button"><span class="property-name">rawvalue</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_properties_additionalProperties_rawvalue" class="collapse property-definition-div" data-parent="#accordionReturn_value_properties_additionalProperties_rawvalue" id="Return_value_properties_additionalProperties_rawvalue">
    <div class="card-body pl-5">
    <h4>Rawvalue</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Raw string value of the ZFS property as stored.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_properties_additionalProperties_source">
    <div class="card">
    <div class="card-header" id="headingReturn_value_properties_additionalProperties_source">
    <h2 class="mb-0">
    <button aria-controls="Return_value_properties_additionalProperties_source" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_properties_additionalProperties_source" data-toggle="collapse" onclick="setAnchor('#Return_value_properties_additionalProperties_source')" type="button"><span class="property-name">source</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_properties_additionalProperties_source" class="collapse property-definition-div" data-parent="#accordionReturn_value_properties_additionalProperties_source" id="Return_value_properties_additionalProperties_source">
    <div class="card-body pl-5">
    <h4>Source</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Source of the property value.</p>
    <ul>
    <li><code>NONE</code>: Property is not set</li>
    <li><code>DEFAULT</code>: Using ZFS default value</li>
    <li><code>LOCAL</code>: Set locally on this snapshot</li>
    <li><code>TEMPORARY</code>: Temporary override value</li>
    <li><code>INHERITED</code>: Inherited from parent dataset</li>
    <li><code>RECEIVED</code>: Set by ZFS receive operation</li>
    </ul>
    </span><div class="enum-value" id="Return_value_properties_additionalProperties_source_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"NONE"</li><li class="list-group-item enum-item">"DEFAULT"</li><li class="list-group-item enum-item">"LOCAL"</li><li class="list-group-item enum-item">"TEMPORARY"</li><li class="list-group-item enum-item">"INHERITED"</li><li class="list-group-item enum-item">"RECEIVED"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_properties_additionalProperties_parsed">
    <div class="card">
    <div class="card-header" id="headingReturn_value_properties_additionalProperties_parsed">
    <h2 class="mb-0">
    <button aria-controls="Return_value_properties_additionalProperties_parsed" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_properties_additionalProperties_parsed" data-toggle="collapse" onclick="setAnchor('#Return_value_properties_additionalProperties_parsed')" type="button"><span class="property-name">parsed</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_properties_additionalProperties_parsed" class="collapse property-definition-div" data-parent="#accordionReturn_value_properties_additionalProperties_parsed" id="Return_value_properties_additionalProperties_parsed">
    <div class="card-body pl-5">
    <h4>Parsed</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Property value parsed into the appropriate type (string, boolean, integer, etc.).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_pool">
    <div class="card">
    <div class="card-header" id="headingReturn_value_pool">
    <h2 class="mb-0">
    <button aria-controls="Return_value_pool" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_pool" data-toggle="collapse" onclick="setAnchor('#Return_value_pool')" type="button"><span class="property-name">pool</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_pool" class="collapse property-definition-div" data-parent="#accordionReturn_value_pool" id="Return_value_pool">
    <div class="card-body pl-5">
    <h4>Pool</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Name of the ZFS pool containing this snapshot.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_name" data-toggle="collapse" onclick="setAnchor('#Return_value_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_name" id="Return_value_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>Full name of the snapshot including dataset path.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_type" data-toggle="collapse" onclick="setAnchor('#Return_value_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_type" id="Return_value_type">
    <div class="card-body pl-5">
    <h4>Type</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="description"><p>Type identifier indicating this is a ZFS snapshot.</p>
    </span><span class="const-value" id="Return_value_type_const">Specific value: <code>"SNAPSHOT"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_snapshot_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_snapshot_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_snapshot_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_snapshot_name" data-toggle="collapse" onclick="setAnchor('#Return_value_snapshot_name')" type="button"><span class="property-name">snapshot_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_snapshot_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_snapshot_name" id="Return_value_snapshot_name">
    <div class="card-body pl-5">
    <h4>Snapshot Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Just the snapshot name portion without the dataset path.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_dataset">
    <div class="card">
    <div class="card-header" id="headingReturn_value_dataset">
    <h2 class="mb-0">
    <button aria-controls="Return_value_dataset" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_dataset" data-toggle="collapse" onclick="setAnchor('#Return_value_dataset')" type="button"><span class="property-name">dataset</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_dataset" class="collapse property-definition-div" data-parent="#accordionReturn_value_dataset" id="Return_value_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 this snapshot was taken from.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_createtxg">
    <div class="card">
    <div class="card-header" id="headingReturn_value_createtxg">
    <h2 class="mb-0">
    <button aria-controls="Return_value_createtxg" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_createtxg" data-toggle="collapse" onclick="setAnchor('#Return_value_createtxg')" type="button"><span class="property-name">createtxg</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_createtxg" class="collapse property-definition-div" data-parent="#accordionReturn_value_createtxg" id="Return_value_createtxg">
    <div class="card-body pl-5">
    <h4>Createtxg</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Transaction group ID when the snapshot was created.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_holds">
    <div class="card">
    <div class="card-header" id="headingReturn_value_holds">
    <h2 class="mb-0">
    <button aria-controls="Return_value_holds" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_holds" data-toggle="collapse" onclick="setAnchor('#Return_value_holds')" type="button"><span class="property-name">holds</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_holds" class="collapse property-definition-div" data-parent="#accordionReturn_value_holds" id="Return_value_holds">
    <div class="card-body pl-5">
    <h4>Holds</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Returned when options.extra.holds is set.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_holds_truenas">
    <div class="card">
    <div class="card-header" id="headingReturn_value_holds_truenas">
    <h2 class="mb-0">
    <button aria-controls="Return_value_holds_truenas" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_holds_truenas" data-toggle="collapse" onclick="setAnchor('#Return_value_holds_truenas')" type="button"><span class="property-name">truenas</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_holds_truenas" class="collapse property-definition-div" data-parent="#accordionReturn_value_holds_truenas" id="Return_value_holds_truenas">
    <div class="card-body pl-5">
    <h4>Truenas</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Present if a hold has been placed on the snapshot.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_retention">
    <div class="card">
    <div class="card-header" id="headingReturn_value_retention">
    <h2 class="mb-0">
    <button aria-controls="Return_value_retention" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_retention" data-toggle="collapse" onclick="setAnchor('#Return_value_retention')" type="button"><span class="property-name">retention</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_retention" class="collapse property-definition-div" data-parent="#accordionReturn_value_retention" id="Return_value_retention">
    <div class="card-body pl-5">
    <h4>Retention</h4><br/>
    <span class="description"><p>Returned when options.extra.retention is set.</p>
    </span><div class="any-of-value" id="Return_value_retention_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_retention_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_retention_anyOf_i0" id="Return_value_retention_anyOf_i0" onclick="setAnchor('#Return_value_retention_anyOf_i0')" role="tab">Option 1</a>
    </li><li class="nav-item">
    <a class="nav-link anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_retention_anyOf_i1" id="Return_value_retention_anyOf_i1" onclick="setAnchor('#Return_value_retention_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_Return_value_retention_anyOf_i0" role="tabpanel">
    <br/>
    <div class="one-of-value" id="Return_value_retention_anyOf_i0_oneOf"><h2 class="handle">
    <label>One of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_retention_anyOf_i0_oneOf_oneOf" role="tablist"><li class="nav-item">
    <a class="nav-link active oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_retention_anyOf_i0_oneOf_i0" id="Return_value_retention_anyOf_i0_oneOf_i0" onclick="setAnchor('#Return_value_retention_anyOf_i0_oneOf_i0')" role="tab">PoolSnapshotRetentionPST</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_retention_anyOf_i0_oneOf_i1" id="Return_value_retention_anyOf_i0_oneOf_i1" onclick="setAnchor('#Return_value_retention_anyOf_i0_oneOf_i1')" role="tab">PoolSnapshotRetentionProperty</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_retention_anyOf_i0_oneOf_i0" role="tabpanel">
    <h4>PoolSnapshotRetentionPST</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="accordionReturn_value_retention_anyOf_i0_oneOf_i0_datetime">
    <div class="card">
    <div class="card-header" id="headingReturn_value_retention_anyOf_i0_oneOf_i0_datetime">
    <h2 class="mb-0">
    <button aria-controls="Return_value_retention_anyOf_i0_oneOf_i0_datetime" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_retention_anyOf_i0_oneOf_i0_datetime" data-toggle="collapse" onclick="setAnchor('#Return_value_retention_anyOf_i0_oneOf_i0_datetime')" type="button"><span class="property-name">datetime</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_retention_anyOf_i0_oneOf_i0_datetime" class="collapse property-definition-div" data-parent="#accordionReturn_value_retention_anyOf_i0_oneOf_i0_datetime" id="Return_value_retention_anyOf_i0_oneOf_i0_datetime">
    <div class="card-body pl-5">
    <h4>Datetime</h4><span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: date-time</span><br/>
    <span class="description"><p>Timestamp when the snapshot will be eligible for removal.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_retention_anyOf_i0_oneOf_i0_source">
    <div class="card">
    <div class="card-header" id="headingReturn_value_retention_anyOf_i0_oneOf_i0_source">
    <h2 class="mb-0">
    <button aria-controls="Return_value_retention_anyOf_i0_oneOf_i0_source" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_retention_anyOf_i0_oneOf_i0_source" data-toggle="collapse" onclick="setAnchor('#Return_value_retention_anyOf_i0_oneOf_i0_source')" type="button"><span class="property-name">source</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_retention_anyOf_i0_oneOf_i0_source" class="collapse property-definition-div" data-parent="#accordionReturn_value_retention_anyOf_i0_oneOf_i0_source" id="Return_value_retention_anyOf_i0_oneOf_i0_source">
    <div class="card-body pl-5">
    <h4>Source</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="description"><p>Indicates retention is managed by a periodic snapshot task.</p>
    </span><span class="const-value" id="Return_value_retention_anyOf_i0_oneOf_i0_source_const">Specific value: <code>"periodic_snapshot_task"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_retention_anyOf_i0_oneOf_i0_periodic_snapshot_task_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_retention_anyOf_i0_oneOf_i0_periodic_snapshot_task_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_retention_anyOf_i0_oneOf_i0_periodic_snapshot_task_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_retention_anyOf_i0_oneOf_i0_periodic_snapshot_task_id" data-toggle="collapse" onclick="setAnchor('#Return_value_retention_anyOf_i0_oneOf_i0_periodic_snapshot_task_id')" type="button"><span class="property-name">periodic_snapshot_task_id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_retention_anyOf_i0_oneOf_i0_periodic_snapshot_task_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_retention_anyOf_i0_oneOf_i0_periodic_snapshot_task_id" id="Return_value_retention_anyOf_i0_oneOf_i0_periodic_snapshot_task_id">
    <div class="card-body pl-5">
    <h4>Periodic Snapshot Task Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>ID of the periodic snapshot task managing this retention.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_retention_anyOf_i0_oneOf_i1" role="tabpanel">
    <h4>PoolSnapshotRetentionProperty</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="accordionReturn_value_retention_anyOf_i0_oneOf_i1_datetime">
    <div class="card">
    <div class="card-header" id="headingReturn_value_retention_anyOf_i0_oneOf_i1_datetime">
    <h2 class="mb-0">
    <button aria-controls="Return_value_retention_anyOf_i0_oneOf_i1_datetime" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_retention_anyOf_i0_oneOf_i1_datetime" data-toggle="collapse" onclick="setAnchor('#Return_value_retention_anyOf_i0_oneOf_i1_datetime')" type="button"><span class="property-name">datetime</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_retention_anyOf_i0_oneOf_i1_datetime" class="collapse property-definition-div" data-parent="#accordionReturn_value_retention_anyOf_i0_oneOf_i1_datetime" id="Return_value_retention_anyOf_i0_oneOf_i1_datetime">
    <div class="card-body pl-5">
    <h4>Datetime</h4><span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: date-time</span><br/>
    <span class="description"><p>Timestamp when the snapshot will be eligible for removal.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_retention_anyOf_i0_oneOf_i1_source">
    <div class="card">
    <div class="card-header" id="headingReturn_value_retention_anyOf_i0_oneOf_i1_source">
    <h2 class="mb-0">
    <button aria-controls="Return_value_retention_anyOf_i0_oneOf_i1_source" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_retention_anyOf_i0_oneOf_i1_source" data-toggle="collapse" onclick="setAnchor('#Return_value_retention_anyOf_i0_oneOf_i1_source')" type="button"><span class="property-name">source</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_retention_anyOf_i0_oneOf_i1_source" class="collapse property-definition-div" data-parent="#accordionReturn_value_retention_anyOf_i0_oneOf_i1_source" id="Return_value_retention_anyOf_i0_oneOf_i1_source">
    <div class="card-body pl-5">
    <h4>Source</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="description"><p>Indicates retention is managed by ZFS properties.</p>
    </span><span class="const-value" id="Return_value_retention_anyOf_i0_oneOf_i1_source_const">Specific value: <code>"property"</code></span>
    </div>
    </div>
    </div>
    </div>
    </div></div></div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_retention_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><br><br>

*Required roles:* SNAPSHOT_READ

