sharing.smb.update
==================

.. 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: integer</span><br/>
    <span class="description"><p>ID of the SMB share 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>Updated SMB share configuration data.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_purpose">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_purpose">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_purpose" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_purpose" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_purpose')" type="button"><span class="property-name">purpose</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_purpose" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_purpose" id="Call_parameters_items_i1_purpose">
    <div class="card-body pl-5">
    <h4>Purpose</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>This parameter sets the purpose of the SMB share. It controls how the SMB share behaves and what features are     available through options. The DEFAULT_SHARE setting is best for most applications, and should be used, unless     there is a specific reason to change it.</p>
    <ul>
    <li><p><code>DEFAULT_SHARE</code>: Set the SMB share for best compatibility with common SMB clients.</p></li>
    <li><p><code>LEGACY_SHARE</code>: Set the SMB share for compatibility with older TrueNAS versions. Automated backend migrations       use this to help the administrator move to better-supported share settings. It should not be used for new SMB       shares.</p></li>
    <li><p><code>TIMEMACHINE_SHARE</code>: The SMB share is presented to MacOS clients as a time machine target.<br/>
    NOTE: <code>aapl_extensions</code> must be set in the global <code>smb.config</code>.</p></li>
    <li><p><code>MULTIPROTOCOL_SHARE</code>: The SMB share is configured for multi-protocol access. Set this if the <code>path</code> is shared       through NFS, FTP, or used by containers or apps.<br/>
    NOTE: This setting can reduce SMB share performance because it turns off some SMB features for safer       interoperability with external processes.</p></li>
    <li><p><code>TIME_LOCKED_SHARE</code>: The SMB share makes files read-only through the SMB protocol after the set grace_period       ends.<br/>
    WARNING: This setting does not work if the <code>path</code> is accessed locally or if another SMB share without the       <code>TIME_LOCKED_SHARE</code> purpose uses the same path.<br/>
    WARNING: This setting might not meet regulatory requirements for write-once storage.</p></li>
    <li><p><code>PRIVATE_DATASETS_SHARE</code>: The server uses the specified <code>dataset_naming_schema</code> in <code>options</code> to make a new ZFS       dataset when the client connects. The server uses this dataset as the share path during the SMB session.</p></li>
    <li><p><code>EXTERNAL_SHARE</code>: The SMB share is a DFS proxy to a share hosted on an external SMB server.</p></li>
    <li><p><code>VEEAM_REPOSITORY_SHARE</code>: The SMB share is a repository for Veeam Backup &amp; Replication and supports Fast Clone.<br/>
    NOTE: This feature is available only for TrueNAS Enterprise customers.</p></li>
    </ul>
    </span><div class="enum-value" id="Call_parameters_items_i1_purpose_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"DEFAULT_SHARE"</li><li class="list-group-item enum-item">"LEGACY_SHARE"</li><li class="list-group-item enum-item">"TIMEMACHINE_SHARE"</li><li class="list-group-item enum-item">"MULTIPROTOCOL_SHARE"</li><li class="list-group-item enum-item">"TIME_LOCKED_SHARE"</li><li class="list-group-item enum-item">"PRIVATE_DATASETS_SHARE"</li><li class="list-group-item enum-item">"EXTERNAL_SHARE"</li><li class="list-group-item enum-item">"VEEAM_REPOSITORY_SHARE"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_name">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_name">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_name" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_name')" type="button"><span class="property-name">name</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_name" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_name" id="Call_parameters_items_i1_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>SMB share name. SMB share names are case-insensitive and must be unique, and are subject     to the following restrictions:</p>
    <ul>
    <li><p>A share name must be no more than 80 characters in length.</p></li>
    <li><p>The following characters are illegal in a share name: <code>\ / [ ] : | &lt; &gt; + = ; , * ? "</code></p></li>
    <li><p>Unicode control characters are illegal in a share name.</p></li>
    <li><p>The following share names are not allowed: global, printers, homes.</p></li>
    </ul>
    </span>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_name_ex1"><div class="highlight"><pre><span></span><span class="s2">"SHARE"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_name_ex2"><div class="highlight"><pre><span></span><span class="s2">"Macrodata_refinement"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_path">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_path">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_path" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_path')" type="button"><span class="property-name">path</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_path" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_path" id="Call_parameters_items_i1_path">
    <div class="card-body pl-5">
    <h4>Path</h4><br/>
    <span class="description"><p>Local server path to share by using the SMB protocol. The path must start with <code>/mnt/</code> and must be in a     ZFS pool.</p>
    <p>Use the string <code>EXTERNAL</code> if the share works as a DFS proxy.</p>
    <p>WARNING: The TrueNAS server does not check if external paths are reachable. </p>
    </span><div class="any-of-value" id="Call_parameters_items_i1_path_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_path_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_path_anyOf_i0" id="Call_parameters_items_i1_path_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_path_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_path_anyOf_i1" id="Call_parameters_items_i1_path_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_path_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_path_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i1_path_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_path_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i1_path_anyOf_i1_const">Specific value: <code>"EXTERNAL"</code></span>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_path_ex1"><div class="highlight"><pre><span></span><span class="s2">"/mnt/dozer/SHARE"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_path_ex2"><div class="highlight"><pre><span></span><span class="s2">"EXTERNAL"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_enabled">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_enabled">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_enabled" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_enabled" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_enabled" id="Call_parameters_items_i1_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>If unset, the SMB share is not available over the SMB protocol. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_comment">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_comment">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_comment" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_comment" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_comment')" type="button"><span class="property-name">comment</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_comment" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_comment" id="Call_parameters_items_i1_comment">
    <div class="card-body pl-5">
    <h4>Comment</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Text field that is seen next to a share when an SMB client requests a list of SMB shares on the TrueNAS     server. </p>
    </span>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_comment_ex1"><div class="highlight"><pre><span></span><span class="s2">"Mammalian nurturable"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_readonly">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_readonly">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_readonly" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_readonly" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_readonly')" type="button"><span class="property-name">readonly</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_readonly" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_readonly" id="Call_parameters_items_i1_readonly">
    <div class="card-body pl-5">
    <h4>Readonly</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>If set, SMB clients cannot create or change files and directories in the SMB share.</p>
    <p>NOTE: If set, the share path is still writeable by local processes or other file sharing protocols. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_browsable">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_browsable">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_browsable" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_browsable" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_browsable')" type="button"><span class="property-name">browsable</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_browsable" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_browsable" id="Call_parameters_items_i1_browsable">
    <div class="card-body pl-5">
    <h4>Browsable</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>If set, the share is included when an SMB client requests a list of SMB shares on the TrueNAS server. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_access_based_share_enumeration">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_access_based_share_enumeration">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_access_based_share_enumeration" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_access_based_share_enumeration" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_access_based_share_enumeration')" type="button"><span class="property-name">access_based_share_enumeration</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_access_based_share_enumeration" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_access_based_share_enumeration" id="Call_parameters_items_i1_access_based_share_enumeration">
    <div class="card-body pl-5">
    <h4>Access Based Share Enumeration</h4><span class="badge badge-dark value-type">Type: boolean</span><br/>
    <span class="description"><p>If set, the share is only included when an SMB client requests a list of shares on the SMB server if     the share (not filesystem) access control list (see <code>sharing.smb.getacl</code>) grants access to the user. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_audit">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_audit">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_audit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_audit" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_audit')" type="button"><span class="property-name">audit</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_audit" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_audit" id="Call_parameters_items_i1_audit">
    <div class="card-body pl-5">
    <h4>SmbAuditConfig</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Audit configuration for monitoring SMB share access and operations.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_audit_ex1"><div class="highlight"><pre><span></span><span class="p">{</span>
    <span class="w">    </span><span class="s2">"enable"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"ignore_list"</span><span class="o">:</span><span class="w"> </span><span class="p">[],</span>
    <span class="w">    </span><span class="s2">"watch_list"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span>
    <span class="w">        </span><span class="s2">"interns"</span>
    <span class="w">    </span><span class="p">]</span>
    <span class="p">}</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_audit_ex2"><div class="highlight"><pre><span></span><span class="p">{</span>
    <span class="w">    </span><span class="s2">"enable"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"ignore_list"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span>
    <span class="w">        </span><span class="s2">"automation"</span>
    <span class="w">    </span><span class="p">],</span>
    <span class="w">    </span><span class="s2">"watch_list"</span><span class="o">:</span><span class="w"> </span><span class="p">[]</span>
    <span class="p">}</span>
    </pre></div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_audit_enable">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_audit_enable">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_audit_enable" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_audit_enable" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_audit_enable')" type="button"><span class="property-name">enable</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_audit_enable" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_audit_enable" id="Call_parameters_items_i1_audit_enable">
    <div class="card-body pl-5">
    <h4>Enable</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>Turn on auditing for the SMB share. SMB share auditing may not be enabled if <code>enable_smb1</code> is <code>true</code>     in the SMB service configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_audit_watch_list">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_audit_watch_list">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_audit_watch_list" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_audit_watch_list" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_audit_watch_list')" type="button"><span class="property-name">watch_list</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_audit_watch_list" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_audit_watch_list" id="Call_parameters_items_i1_audit_watch_list">
    <div class="card-body pl-5">
    <h4>Watch List</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>Only audit the listed group accounts. If the list is empty, all groups will be audited. </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_audit_watch_list_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i1_audit_watch_list_items_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_audit_watch_list_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"interns"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"contractors"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_audit_ignore_list">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_audit_ignore_list">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_audit_ignore_list" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_audit_ignore_list" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_audit_ignore_list')" type="button"><span class="property-name">ignore_list</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_audit_ignore_list" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_audit_ignore_list" id="Call_parameters_items_i1_audit_ignore_list">
    <div class="card-body pl-5">
    <h4>Ignore List</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>List of groups that will not be audited. </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_audit_ignore_list_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i1_audit_ignore_list_items_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_audit_ignore_list_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"automation"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"apps"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options')" type="button"><span class="property-name">options</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options" id="Call_parameters_items_i1_options">
    <div class="card-body pl-5">
    <h4>Options</h4><br/>
    <span class="description"><p>Additional configuration related to the configured SMB share purpose. If null, then the default     options related to the share purpose will be applied. </p>
    </span><div class="any-of-value" id="Call_parameters_items_i1_options_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_options_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_options_anyOf_i0" id="Call_parameters_items_i1_options_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_options_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_options_anyOf_i1" id="Call_parameters_items_i1_options_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_options_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_options_anyOf_i0" role="tabpanel">
    <br/>
    <div class="one-of-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf"><h2 class="handle">
    <label>One of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_options_anyOf_i0_oneOf_oneOf" role="tablist"><li class="nav-item">
    <a class="nav-link active oneOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i0" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0')" role="tab">LegacyOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i1" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i1" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i1')" role="tab">DefaultOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i2" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2')" role="tab">TimeMachineOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i3" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i3" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i3')" role="tab">MultiprotocolOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i4" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i4" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i4')" role="tab">TimeLockedOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i5" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5')" role="tab">PrivateDatasetOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i6" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i6" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i6')" role="tab">ExternalOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i7" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i7" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i7')" role="tab">VeeamRepositoryOpt</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i0" role="tabpanel">
    <h4>LegacyOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>LEGACY_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_purpose">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_purpose">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_purpose" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_purpose" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_purpose')" type="button"><span class="property-name">purpose</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_purpose" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_purpose" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_purpose">
    <div class="card-body pl-5">
    <h4>Purpose</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_purpose_const">Specific value: <code>"LEGACY_SHARE"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_recyclebin">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_recyclebin">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_recyclebin" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_recyclebin" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_recyclebin')" type="button"><span class="property-name">recyclebin</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_recyclebin" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_recyclebin" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_recyclebin">
    <div class="card-body pl-5">
    <h4>Recyclebin</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>If set, deleted files are moved to per-user subdirectories in the <code>.recycle</code> directory. The     SMB server creates the <code>.recycle</code> directory at the root of the SMB share if the file is in the same     ZFS dataset as the share <code>path</code>. If the file is in a child ZFS dataset, the server uses the     <code>mountpoint</code> of that dataset to create the <code>.recycle</code> directory.</p>
    <p>NOTE: This feature does not work with recycle bin features in client operating systems.</p>
    <p>WARNING: Do not use this feature instead of backups or ZFS snapshots. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix')" type="button"><span class="property-name">path_suffix</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix">
    <div class="card-body pl-5">
    <h4>Path Suffix</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Path suffix template for dynamic path generation. Uses SMB variable substitution patterns like <code>%D</code> (domain)     and <code>%U</code> (username).</p>
    </span><div class="any-of-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix_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_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i0" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix_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_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i1" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix_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_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_path_suffix_ex1"><div class="highlight"><pre><span></span><span class="s2">"%D/%U"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow')" type="button"><span class="property-name">hostsallow</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow">
    <div class="card-body pl-5">
    <h4>Hostsallow</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>A list of IP addresses or subnets that are allowed to access the SMB share. The EXCEPT keyword     may be used to limit a wildcard list.</p>
    <p>NOTE: Hostname lookups are disabled on the SMB server for performance reasons. </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_options_anyOf_i0_oneOf_i0_hostsallow_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"192.168.0.200"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"150.203."</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow_ex2"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"150.203.15.0/255.255.255.0"</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsallow_ex3"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"150.203. EXCEPT 150.203.6.66"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny')" type="button"><span class="property-name">hostsdeny</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny">
    <div class="card-body pl-5">
    <h4>Hostsdeny</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>A list of IP addresses or subnets that are not allowed to access the SMB share. The keyword     <code>ALL</code> or the netmask <code>0.0.0.0/0</code> may be used to deny all by default. </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_options_anyOf_i0_oneOf_i0_hostsdeny_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"150.203.4."</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny_ex2"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"ALL"</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_hostsdeny_ex3"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"0.0.0.0/0"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_guestok">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_guestok">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_guestok" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_guestok" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_guestok')" type="button"><span class="property-name">guestok</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_guestok" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_guestok" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_guestok">
    <div class="card-body pl-5">
    <h4>Guestok</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>If set, guest access to the share is allowed. This should not be used in production environments.</p>
    <p>NOTE: If a user account does not exist, the SMB server maps access to the guest account.</p>
    <p>WARNING: Additional client-side configuration downgrading security settings may be required in order     to use this feature. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_streams">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_streams">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_streams" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_streams" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_streams')" type="button"><span class="property-name">streams</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_streams" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_streams" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_streams">
    <div class="card-body pl-5">
    <h4>Streams</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If set, support for SMB alternate data streams is enabled.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_durablehandle">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_durablehandle">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_durablehandle" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_durablehandle" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_durablehandle')" type="button"><span class="property-name">durablehandle</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_durablehandle" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_durablehandle" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_durablehandle">
    <div class="card-body pl-5">
    <h4>Durablehandle</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If set, support for SMB durable handles is enabled.</p>
    <p>WARNING: This feature is incompatible with multiprotocol and local filesystem access. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_shadowcopy">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_shadowcopy">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_shadowcopy" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_shadowcopy" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_shadowcopy')" type="button"><span class="property-name">shadowcopy</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_shadowcopy" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_shadowcopy" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_shadowcopy">
    <div class="card-body pl-5">
    <h4>Shadowcopy</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If set, previous versions of files contained in ZFS snapshots are accessible through standard SMB protocol     operations on previous versions of files. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_fsrvp">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_fsrvp">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_fsrvp" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_fsrvp" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_fsrvp')" type="button"><span class="property-name">fsrvp</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_fsrvp" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_fsrvp" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_fsrvp">
    <div class="card-body pl-5">
    <h4>Fsrvp</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>If set, enable support for the File Server Remote VSS Protocol. This allows clients to manage     snapshots for the specified SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_home">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_home">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_home" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_home" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_home')" type="button"><span class="property-name">home</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_home" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_home" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_home">
    <div class="card-body pl-5">
    <h4>Home</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>Use the <code>path</code> to store user home directories. Each user has a personal home directory and share.     Users cannot access other user directories when connecting to shares.</p>
    <p>NOTE: This parameter changes the share <code>name</code> to <code>homes</code>. It also creates a dynamic share that mirrors     the username of the user. Both shares use the same <code>path</code>. You can hide the homes share by turning off     <code>browsable</code>. The dynamic user home share cannot be hidden.</p>
    <p>WARNING: This parameter changes the global server configuration. The SMB server will not authenticate     users without a valid home directory or shell.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_acl">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_acl">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_acl" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_acl" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_acl')" type="button"><span class="property-name">acl</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_acl" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_acl" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_acl">
    <div class="card-body pl-5">
    <h4>Acl</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If set, enable mapping of local filesystem ACLs to NT ACLs for SMB clients. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_afp">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_afp">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_afp" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_afp" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_afp')" type="button"><span class="property-name">afp</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_afp" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_afp" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_afp">
    <div class="card-body pl-5">
    <h4>Afp</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>If set, SMB server will read and store file metadata in an on-disk format compatible with the     legacy AFP file server.</p>
    <p>WARNING: This should not be set unless the SMB server is sharing data that was originally written     via the AFP protocol. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine')" type="button"><span class="property-name">timemachine</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine">
    <div class="card-body pl-5">
    <h4>Timemachine</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>If set, MacOS clients can use the share as a time machine target. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine_quota">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine_quota">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine_quota" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine_quota" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine_quota')" type="button"><span class="property-name">timemachine_quota</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine_quota" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine_quota" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine_quota">
    <div class="card-body pl-5">
    <h4>Timemachine Quota</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>If set, it defines the maximum size of a single time machine sparsebundle volume by limiting the     reported disk size to the SMB client. A value of zero means no quota is applied to the share.</p>
    <p>NOTE: Modern MacOS versions you set Time Machine quotas client-side. This gives more predictable     server and client behavior.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_timemachine_quota_number">Value must be greater or equal to <code>0</code> and lesser or equal to <code>109951162777600</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_aapl_name_mangling">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_aapl_name_mangling">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_aapl_name_mangling" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_aapl_name_mangling" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_aapl_name_mangling')" type="button"><span class="property-name">aapl_name_mangling</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_aapl_name_mangling" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_aapl_name_mangling" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_aapl_name_mangling">
    <div class="card-body pl-5">
    <h4>Aapl Name Mangling</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>If set, illegal NTFS characters commonly used by MacOS clients are stored with their native values on the SMB     server's local filesystem.</p>
    <p>NOTE: Files with illegal NTFS characters in their names may not be accessible to non-MacOS SMB clients.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid')" type="button"><span class="property-name">vuid</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid">
    <div class="card-body pl-5">
    <h4>Vuid</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>This value is the Time Machine volume UUID for the SMB share. The TrueNAS server uses this value in the mDNS     advertisement for the Time Machine share. MacOS clients may use it to identify the volume. When you create or     update a share, setting this value to null makes the TrueNAS server generate a new UUID for the share. </p>
    </span><div class="any-of-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid_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_options_anyOf_i0_oneOf_i0_vuid_anyOf_i0" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid_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_options_anyOf_i0_oneOf_i0_vuid_anyOf_i1" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid_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_options_anyOf_i0_oneOf_i0_vuid_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_vuid_ex1"><div class="highlight"><pre><span></span><span class="s2">"d12aafdc-a7ac-4e3c-8bbd-6001f7f19819"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_auxsmbconf">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_auxsmbconf">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_auxsmbconf" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_auxsmbconf" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_auxsmbconf')" type="button"><span class="property-name">auxsmbconf</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_auxsmbconf" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i0_auxsmbconf" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i0_auxsmbconf">
    <div class="card-body pl-5">
    <h4>Auxsmbconf</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: ""</span><br/>
    <span class="description"><p>Additional parameters to set on the SMB share. Parameters must be separated by the new-line character.</p>
    <p>WARNING: These parameters are not validated and may cause undefined server behavior including     data corruption or data loss.</p>
    <p>WARNING: Auxiliary parameters are an unsupported configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i1" role="tabpanel">
    <h4>DefaultOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>DEFAULT_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i1_purpose">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i1_purpose">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i1_purpose" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i1_purpose" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i1_purpose')" type="button"><span class="property-name">purpose</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i1_purpose" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i1_purpose" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i1_purpose">
    <div class="card-body pl-5">
    <h4>Purpose</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i1_purpose_const">Specific value: <code>"DEFAULT_SHARE"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i1_aapl_name_mangling">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i1_aapl_name_mangling">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i1_aapl_name_mangling" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i1_aapl_name_mangling" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i1_aapl_name_mangling')" type="button"><span class="property-name">aapl_name_mangling</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i1_aapl_name_mangling" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i1_aapl_name_mangling" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i1_aapl_name_mangling">
    <div class="card-body pl-5">
    <h4>Aapl Name Mangling</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>If set, illegal NTFS characters commonly used by MacOS clients are stored with their native values on the SMB     server's local filesystem.</p>
    <p>NOTE: Files with illegal NTFS characters in their names may not be accessible to non-MacOS SMB clients.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i2" role="tabpanel">
    <h4>TimeMachineOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>TIMEMACHINE_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_purpose">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_purpose">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_purpose" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_purpose" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_purpose')" type="button"><span class="property-name">purpose</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_purpose" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_purpose" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_purpose">
    <div class="card-body pl-5">
    <h4>Purpose</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_purpose_const">Specific value: <code>"TIMEMACHINE_SHARE"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_timemachine_quota">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_timemachine_quota">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_timemachine_quota" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_timemachine_quota" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_timemachine_quota')" type="button"><span class="property-name">timemachine_quota</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_timemachine_quota" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_timemachine_quota" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_timemachine_quota">
    <div class="card-body pl-5">
    <h4>Timemachine Quota</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>If set, it defines the maximum size in bytes of a single time machine sparsebundle volume by limiting the     reported disk size to the SMB client. A value of zero means no quota is set.</p>
    <p>NOTE: Modern MacOS versions you set Time Machine quotas client-side. This gives more predictable     server and client behavior.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_timemachine_quota_number">Value must be greater or equal to <code>0</code> and lesser or equal to <code>109951162777600</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_snapshot">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_snapshot">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_snapshot" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_snapshot" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_snapshot')" type="button"><span class="property-name">auto_snapshot</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_snapshot" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_snapshot" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_snapshot">
    <div class="card-body pl-5">
    <h4>Auto Snapshot</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>If set, the server makes a ZFS snapshot of the share dataset when the client makes a new     Time Machine backup. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_dataset_creation">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_dataset_creation">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_dataset_creation" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_dataset_creation" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_dataset_creation')" type="button"><span class="property-name">auto_dataset_creation</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_dataset_creation" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_dataset_creation" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_auto_dataset_creation">
    <div class="card-body pl-5">
    <h4>Auto Dataset Creation</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>If set, the server uses the <code>dataset_naming_schema</code> to make a new ZFS dataset when the client connects.     The server uses this dataset as the share path during the SMB session.</p>
    <p>NOTE: this setting requires the share path to be a dataset mountpoint.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema')" type="button"><span class="property-name">dataset_naming_schema</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema">
    <div class="card-body pl-5">
    <h4>Dataset Naming Schema</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>The naming schema to use when <code>auto_dataset_creation</code> is specified. If you do not set a schema,     the server uses <code>%U</code> (username) if it is not joined to Active Directory. If the server is joined to     Active Directory it uses <code>%D/%U</code> (domain/username). See the <code>VARIABLE SUBSTITUTIONS</code> section in the smb.conf     manpage for valid strings.</p>
    <p>WARNING: ZFS dataset naming rules are more restrictive than normal path rules. For example, if <code>%u</code> is specified     then the character <code>\</code> may be inserted in the username (which is not supported in ZFS).</p>
    </span><div class="any-of-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema_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_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_i0" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema_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_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_i1" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema_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_options_anyOf_i0_oneOf_i2_dataset_naming_schema_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_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_dataset_naming_schema_ex1"><div class="highlight"><pre><span></span><span class="s2">"%D/%U"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid')" type="button"><span class="property-name">vuid</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid">
    <div class="card-body pl-5">
    <h4>Vuid</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>This value is the Time Machine volume UUID for the SMB share. The TrueNAS server uses this value in the mDNS     advertisement for the Time Machine share. MacOS clients may use it to identify the volume. When you create or     update a share, setting this value to null makes the TrueNAS server generate a new UUID for the share. </p>
    </span><div class="any-of-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid_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_options_anyOf_i0_oneOf_i2_vuid_anyOf_i0" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid_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_options_anyOf_i0_oneOf_i2_vuid_anyOf_i1" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid_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_options_anyOf_i0_oneOf_i2_vuid_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i2_vuid_ex1"><div class="highlight"><pre><span></span><span class="s2">"d12aafdc-a7ac-4e3c-8bbd-6001f7f19819"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i3" role="tabpanel">
    <h4>MultiprotocolOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>MULTIPROTOCOL_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i3_purpose">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i3_purpose">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i3_purpose" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i3_purpose" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i3_purpose')" type="button"><span class="property-name">purpose</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i3_purpose" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i3_purpose" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i3_purpose">
    <div class="card-body pl-5">
    <h4>Purpose</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i3_purpose_const">Specific value: <code>"MULTIPROTOCOL_SHARE"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i3_aapl_name_mangling">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i3_aapl_name_mangling">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i3_aapl_name_mangling" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i3_aapl_name_mangling" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i3_aapl_name_mangling')" type="button"><span class="property-name">aapl_name_mangling</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i3_aapl_name_mangling" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i3_aapl_name_mangling" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i3_aapl_name_mangling">
    <div class="card-body pl-5">
    <h4>Aapl Name Mangling</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>If set, illegal NTFS characters commonly used by MacOS clients are stored with their native values on the SMB     server's local filesystem.</p>
    <p>NOTE: Files with illegal NTFS characters in their names may not be accessible to non-MacOS SMB clients.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i4" role="tabpanel">
    <h4>TimeLockedOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>TIME_LOCKED_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_purpose">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_purpose">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_purpose" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_purpose" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_purpose')" type="button"><span class="property-name">purpose</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_purpose" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_purpose" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_purpose">
    <div class="card-body pl-5">
    <h4>Purpose</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_purpose_const">Specific value: <code>"TIME_LOCKED_SHARE"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_grace_period">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_grace_period">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_grace_period" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_grace_period" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_grace_period')" type="button"><span class="property-name">grace_period</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_grace_period" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_grace_period" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_grace_period">
    <div class="card-body pl-5">
    <h4>Grace Period</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 900</span><br/>
    <span class="description"><p>Time in seconds when write access to the file or directory is allowed. </p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_grace_period_number">Value must be greater or equal to <code>60</code> and lesser or equal to <code>15552000</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_aapl_name_mangling">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_aapl_name_mangling">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_aapl_name_mangling" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_aapl_name_mangling" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_aapl_name_mangling')" type="button"><span class="property-name">aapl_name_mangling</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_aapl_name_mangling" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i4_aapl_name_mangling" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i4_aapl_name_mangling">
    <div class="card-body pl-5">
    <h4>Aapl Name Mangling</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>If set, illegal NTFS characters commonly used by MacOS clients are stored with their native values on the SMB     server's local filesystem.</p>
    <p>NOTE: Files with illegal NTFS characters in their names may not be accessible to non-MacOS SMB clients.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i5" role="tabpanel">
    <h4>PrivateDatasetOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>PRIVATE_DATASETS_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_purpose">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_purpose">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_purpose" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_purpose" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_purpose')" type="button"><span class="property-name">purpose</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_purpose" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_purpose" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_purpose">
    <div class="card-body pl-5">
    <h4>Purpose</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_purpose_const">Specific value: <code>"PRIVATE_DATASETS_SHARE"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema')" type="button"><span class="property-name">dataset_naming_schema</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema">
    <div class="card-body pl-5">
    <h4>Dataset Naming Schema</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>The naming schema to use. If you do not set a schema, the server uses <code>%U</code> (username) if it is not joined to     Active Directory. If the server is joined to Active Directory it uses <code>%D/%U</code> (domain/username).</p>
    <p>WARNING: ZFS dataset naming rules are more restrictive than normal path rules.</p>
    </span><div class="any-of-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema_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_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_i0" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_i0" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema_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_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_i1" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_i1" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema_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_options_anyOf_i0_oneOf_i5_dataset_naming_schema_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_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_dataset_naming_schema_ex1"><div class="highlight"><pre><span></span><span class="s2">"%D/%U"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_auto_quota">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_auto_quota">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_auto_quota" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_auto_quota" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_auto_quota')" type="button"><span class="property-name">auto_quota</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_auto_quota" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_auto_quota" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_auto_quota">
    <div class="card-body pl-5">
    <h4>Auto Quota</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>Set the specified ZFS quota (in gibibytes) on new datasets. If the value is zero, TrueNAS disables     automatic quotas for the share.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_auto_quota_number">Value must be greater or equal to <code>0</code></span></p>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_auto_quota_ex1"><div class="highlight"><pre><span></span><span class="mf">10</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_aapl_name_mangling">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_aapl_name_mangling">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_aapl_name_mangling" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_aapl_name_mangling" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_aapl_name_mangling')" type="button"><span class="property-name">aapl_name_mangling</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_aapl_name_mangling" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i5_aapl_name_mangling" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i5_aapl_name_mangling">
    <div class="card-body pl-5">
    <h4>Aapl Name Mangling</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>If set, illegal NTFS characters commonly used by MacOS clients are stored with their native values on the SMB     server's local filesystem.</p>
    <p>NOTE: Files with illegal NTFS characters in their names may not be accessible to non-MacOS SMB clients.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i6" role="tabpanel">
    <h4>ExternalOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>EXTERNAL_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i6_purpose">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i6_purpose">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_purpose" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_purpose" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_purpose')" type="button"><span class="property-name">purpose</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i6_purpose" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i6_purpose" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_purpose">
    <div class="card-body pl-5">
    <h4>Purpose</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_purpose_const">Specific value: <code>"EXTERNAL_SHARE"</code></span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path')" type="button"><span class="property-name">remote_path</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path">
    <div class="card-body pl-5">
    <h4>Remote Path</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>This is the path to the external server and share. Each server entry must include a full domain name or IP     address and share name. Separate the server and share with the <code>\</code> character.</p>
    <p>WARNING: The SMB server and TrueNAS middleware do not check if external paths are reachable. </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_options_anyOf_i0_oneOf_i6_remote_path_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path_items_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"192.168.0.200\\SHARE"</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path_ex2"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"SERVER1.MYDOM.INTERNAL\\SHARE"</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i6_remote_path_ex3"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"SERVER1.MYDOM.INTERNAL\\SHARE, SERVER2.MYDOM.INTERNAL\\SHARE"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i0_oneOf_i7" role="tabpanel">
    <h4>VeeamRepositoryOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>VEEAM_REPOSITORY_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i7_purpose">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i7_purpose">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i1_options_anyOf_i0_oneOf_i7_purpose" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i1_options_anyOf_i0_oneOf_i7_purpose" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i1_options_anyOf_i0_oneOf_i7_purpose')" type="button"><span class="property-name">purpose</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i1_options_anyOf_i0_oneOf_i7_purpose" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i1_options_anyOf_i0_oneOf_i7_purpose" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i7_purpose">
    <div class="card-body pl-5">
    <h4>Purpose</h4><span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Call_parameters_items_i1_options_anyOf_i0_oneOf_i7_purpose_const">Specific value: <code>"VEEAM_REPOSITORY_SHARE"</code></span>
    </div>
    </div>
    </div>
    </div>
    </div></div></div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Call_parameters_items_i1_options_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Call_parameters_items_i1_options_ex1"><div class="highlight"><pre><span></span><span class="p">{</span>
    <span class="w">    </span><span class="s2">"auto_snapshot"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
    <span class="p">}</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Call_parameters_items_i1_options_ex2"><div class="highlight"><pre><span></span><span class="p">{</span>
    <span class="w">    </span><span class="s2">"auto_quota"</span><span class="o">:</span><span class="w"> </span><span class="mf">100</span>
    <span class="p">}</span>
    </pre></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">
    <h4>SharingSMBEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>The updated SMB share configuration.</p>
    </span> <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: integer</span><br/>
    <span class="description"><p>Unique identifier for this SMB share.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_purpose">
    <div class="card">
    <div class="card-header" id="headingReturn_value_purpose">
    <h2 class="mb-0">
    <button aria-controls="Return_value_purpose" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_purpose" data-toggle="collapse" onclick="setAnchor('#Return_value_purpose')" type="button"><span class="property-name">purpose</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_purpose" class="collapse property-definition-div" data-parent="#accordionReturn_value_purpose" id="Return_value_purpose">
    <div class="card-body pl-5">
    <h4>Purpose</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "DEFAULT_SHARE"</span><br/>
    <span class="description"><p>This parameter sets the purpose of the SMB share. It controls how the SMB share behaves and what features are     available through options. The DEFAULT_SHARE setting is best for most applications, and should be used, unless     there is a specific reason to change it.</p>
    <ul>
    <li><p><code>DEFAULT_SHARE</code>: Set the SMB share for best compatibility with common SMB clients.</p></li>
    <li><p><code>LEGACY_SHARE</code>: Set the SMB share for compatibility with older TrueNAS versions. Automated backend migrations       use this to help the administrator move to better-supported share settings. It should not be used for new SMB       shares.</p></li>
    <li><p><code>TIMEMACHINE_SHARE</code>: The SMB share is presented to MacOS clients as a time machine target.<br/>
    NOTE: <code>aapl_extensions</code> must be set in the global <code>smb.config</code>.</p></li>
    <li><p><code>MULTIPROTOCOL_SHARE</code>: The SMB share is configured for multi-protocol access. Set this if the <code>path</code> is shared       through NFS, FTP, or used by containers or apps.<br/>
    NOTE: This setting can reduce SMB share performance because it turns off some SMB features for safer       interoperability with external processes.</p></li>
    <li><p><code>TIME_LOCKED_SHARE</code>: The SMB share makes files read-only through the SMB protocol after the set grace_period       ends.<br/>
    WARNING: This setting does not work if the <code>path</code> is accessed locally or if another SMB share without the       <code>TIME_LOCKED_SHARE</code> purpose uses the same path.<br/>
    WARNING: This setting might not meet regulatory requirements for write-once storage.</p></li>
    <li><p><code>PRIVATE_DATASETS_SHARE</code>: The server uses the specified <code>dataset_naming_schema</code> in <code>options</code> to make a new ZFS       dataset when the client connects. The server uses this dataset as the share path during the SMB session.</p></li>
    <li><p><code>EXTERNAL_SHARE</code>: The SMB share is a DFS proxy to a share hosted on an external SMB server.</p></li>
    <li><p><code>VEEAM_REPOSITORY_SHARE</code>: The SMB share is a repository for Veeam Backup &amp; Replication and supports Fast Clone.<br/>
    NOTE: This feature is available only for TrueNAS Enterprise customers.</p></li>
    </ul>
    </span><div class="enum-value" id="Return_value_purpose_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"DEFAULT_SHARE"</li><li class="list-group-item enum-item">"LEGACY_SHARE"</li><li class="list-group-item enum-item">"TIMEMACHINE_SHARE"</li><li class="list-group-item enum-item">"MULTIPROTOCOL_SHARE"</li><li class="list-group-item enum-item">"TIME_LOCKED_SHARE"</li><li class="list-group-item enum-item">"PRIVATE_DATASETS_SHARE"</li><li class="list-group-item enum-item">"EXTERNAL_SHARE"</li><li class="list-group-item enum-item">"VEEAM_REPOSITORY_SHARE"</li></ul>
    </div>
    </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>SMB share name. SMB share names are case-insensitive and must be unique, and are subject     to the following restrictions:</p>
    <ul>
    <li><p>A share name must be no more than 80 characters in length.</p></li>
    <li><p>The following characters are illegal in a share name: <code>\ / [ ] : | &lt; &gt; + = ; , * ? "</code></p></li>
    <li><p>Unicode control characters are illegal in a share name.</p></li>
    <li><p>The following share names are not allowed: global, printers, homes.</p></li>
    </ul>
    </span>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Return_value_name_ex1"><div class="highlight"><pre><span></span><span class="s2">"SHARE"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_name_ex2"><div class="highlight"><pre><span></span><span class="s2">"Macrodata_refinement"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_path">
    <div class="card">
    <div class="card-header" id="headingReturn_value_path">
    <h2 class="mb-0">
    <button aria-controls="Return_value_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_path" data-toggle="collapse" onclick="setAnchor('#Return_value_path')" type="button"><span class="property-name">path</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_path" class="collapse property-definition-div" data-parent="#accordionReturn_value_path" id="Return_value_path">
    <div class="card-body pl-5">
    <h4>Path</h4><br/>
    <span class="description"><p>Local server path to share by using the SMB protocol. The path must start with <code>/mnt/</code> and must be in a     ZFS pool.</p>
    <p>Use the string <code>EXTERNAL</code> if the share works as a DFS proxy.</p>
    <p>WARNING: The TrueNAS server does not check if external paths are reachable. </p>
    </span><div class="any-of-value" id="Return_value_path_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_path_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_path_anyOf_i0" id="Return_value_path_anyOf_i0" onclick="setAnchor('#Return_value_path_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_path_anyOf_i1" id="Return_value_path_anyOf_i1" onclick="setAnchor('#Return_value_path_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_path_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_path_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_path_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: const</span><br/>
    <span class="const-value" id="Return_value_path_anyOf_i1_const">Specific value: <code>"EXTERNAL"</code></span>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Return_value_path_ex1"><div class="highlight"><pre><span></span><span class="s2">"/mnt/dozer/SHARE"</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_path_ex2"><div class="highlight"><pre><span></span><span class="s2">"EXTERNAL"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_enabled">
    <div class="card">
    <div class="card-header" id="headingReturn_value_enabled">
    <h2 class="mb-0">
    <button aria-controls="Return_value_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_enabled" data-toggle="collapse" onclick="setAnchor('#Return_value_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_enabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_enabled" id="Return_value_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If unset, the SMB share is not available over the SMB protocol. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_comment">
    <div class="card">
    <div class="card-header" id="headingReturn_value_comment">
    <h2 class="mb-0">
    <button aria-controls="Return_value_comment" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_comment" data-toggle="collapse" onclick="setAnchor('#Return_value_comment')" type="button"><span class="property-name">comment</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_comment" class="collapse property-definition-div" data-parent="#accordionReturn_value_comment" id="Return_value_comment">
    <div class="card-body pl-5">
    <h4>Comment</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: ""</span><br/>
    <span class="description"><p>Text field that is seen next to a share when an SMB client requests a list of SMB shares on the TrueNAS     server. </p>
    </span>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Return_value_comment_ex1"><div class="highlight"><pre><span></span><span class="s2">"Mammalian nurturable"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_readonly">
    <div class="card">
    <div class="card-header" id="headingReturn_value_readonly">
    <h2 class="mb-0">
    <button aria-controls="Return_value_readonly" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_readonly" data-toggle="collapse" onclick="setAnchor('#Return_value_readonly')" type="button"><span class="property-name">readonly</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_readonly" class="collapse property-definition-div" data-parent="#accordionReturn_value_readonly" id="Return_value_readonly">
    <div class="card-body pl-5">
    <h4>Readonly</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>If set, SMB clients cannot create or change files and directories in the SMB share.</p>
    <p>NOTE: If set, the share path is still writeable by local processes or other file sharing protocols. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_browsable">
    <div class="card">
    <div class="card-header" id="headingReturn_value_browsable">
    <h2 class="mb-0">
    <button aria-controls="Return_value_browsable" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_browsable" data-toggle="collapse" onclick="setAnchor('#Return_value_browsable')" type="button"><span class="property-name">browsable</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_browsable" class="collapse property-definition-div" data-parent="#accordionReturn_value_browsable" id="Return_value_browsable">
    <div class="card-body pl-5">
    <h4>Browsable</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If set, the share is included when an SMB client requests a list of SMB shares on the TrueNAS server. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_access_based_share_enumeration">
    <div class="card">
    <div class="card-header" id="headingReturn_value_access_based_share_enumeration">
    <h2 class="mb-0">
    <button aria-controls="Return_value_access_based_share_enumeration" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_access_based_share_enumeration" data-toggle="collapse" onclick="setAnchor('#Return_value_access_based_share_enumeration')" type="button"><span class="property-name">access_based_share_enumeration</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_access_based_share_enumeration" class="collapse property-definition-div" data-parent="#accordionReturn_value_access_based_share_enumeration" id="Return_value_access_based_share_enumeration">
    <div class="card-body pl-5">
    <h4>Access Based Share Enumeration</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>If set, the share is only included when an SMB client requests a list of shares on the SMB server if     the share (not filesystem) access control list (see <code>sharing.smb.getacl</code>) grants access to the user. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_locked">
    <div class="card">
    <div class="card-header" id="headingReturn_value_locked">
    <h2 class="mb-0">
    <button aria-controls="Return_value_locked" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_locked" data-toggle="collapse" onclick="setAnchor('#Return_value_locked')" type="button"><span class="property-name">locked</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_locked" class="collapse property-definition-div" data-parent="#accordionReturn_value_locked" id="Return_value_locked">
    <div class="card-body pl-5">
    <h4>Locked</h4><br/>
    <span class="description"><p>Read-only value indicating whether the share is located on a locked dataset.</p>
    <p>Returns:<br/>
        - True: The share is in a locked dataset.<br/>
        - False: The share is not in a locked dataset.<br/>
        - None: Lock status is not available because path locking information was not requested.</p>
    </span><div class="any-of-value" id="Return_value_locked_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_locked_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_locked_anyOf_i0" id="Return_value_locked_anyOf_i0" onclick="setAnchor('#Return_value_locked_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_locked_anyOf_i1" id="Return_value_locked_anyOf_i1" onclick="setAnchor('#Return_value_locked_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_locked_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: boolean</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_locked_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_audit">
    <div class="card">
    <div class="card-header" id="headingReturn_value_audit">
    <h2 class="mb-0">
    <button aria-controls="Return_value_audit" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_audit" data-toggle="collapse" onclick="setAnchor('#Return_value_audit')" type="button"><span class="property-name">audit</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_audit" class="collapse property-definition-div" data-parent="#accordionReturn_value_audit" id="Return_value_audit">
    <div class="card-body pl-5">
    <h4>SmbAuditConfig</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Audit configuration for monitoring SMB share access and operations.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Return_value_audit_ex1"><div class="highlight"><pre><span></span><span class="p">{</span>
    <span class="w">    </span><span class="s2">"enable"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"ignore_list"</span><span class="o">:</span><span class="w"> </span><span class="p">[],</span>
    <span class="w">    </span><span class="s2">"watch_list"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span>
    <span class="w">        </span><span class="s2">"interns"</span>
    <span class="w">    </span><span class="p">]</span>
    <span class="p">}</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_audit_ex2"><div class="highlight"><pre><span></span><span class="p">{</span>
    <span class="w">    </span><span class="s2">"enable"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"ignore_list"</span><span class="o">:</span><span class="w"> </span><span class="p">[</span>
    <span class="w">        </span><span class="s2">"automation"</span>
    <span class="w">    </span><span class="p">],</span>
    <span class="w">    </span><span class="s2">"watch_list"</span><span class="o">:</span><span class="w"> </span><span class="p">[]</span>
    <span class="p">}</span>
    </pre></div>
    </div>
    <div class="accordion" id="accordionReturn_value_audit_enable">
    <div class="card">
    <div class="card-header" id="headingReturn_value_audit_enable">
    <h2 class="mb-0">
    <button aria-controls="Return_value_audit_enable" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_audit_enable" data-toggle="collapse" onclick="setAnchor('#Return_value_audit_enable')" type="button"><span class="property-name">enable</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_audit_enable" class="collapse property-definition-div" data-parent="#accordionReturn_value_audit_enable" id="Return_value_audit_enable">
    <div class="card-body pl-5">
    <h4>Enable</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>Turn on auditing for the SMB share. SMB share auditing may not be enabled if <code>enable_smb1</code> is <code>true</code>     in the SMB service configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_audit_watch_list">
    <div class="card">
    <div class="card-header" id="headingReturn_value_audit_watch_list">
    <h2 class="mb-0">
    <button aria-controls="Return_value_audit_watch_list" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_audit_watch_list" data-toggle="collapse" onclick="setAnchor('#Return_value_audit_watch_list')" type="button"><span class="property-name">watch_list</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_audit_watch_list" class="collapse property-definition-div" data-parent="#accordionReturn_value_audit_watch_list" id="Return_value_audit_watch_list">
    <div class="card-body pl-5">
    <h4>Watch List</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>Only audit the listed group accounts. If the list is empty, all groups will be audited. </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="Return_value_audit_watch_list_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_audit_watch_list_items_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Return_value_audit_watch_list_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"interns"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"contractors"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_audit_ignore_list">
    <div class="card">
    <div class="card-header" id="headingReturn_value_audit_ignore_list">
    <h2 class="mb-0">
    <button aria-controls="Return_value_audit_ignore_list" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_audit_ignore_list" data-toggle="collapse" onclick="setAnchor('#Return_value_audit_ignore_list')" type="button"><span class="property-name">ignore_list</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_audit_ignore_list" class="collapse property-definition-div" data-parent="#accordionReturn_value_audit_ignore_list" id="Return_value_audit_ignore_list">
    <div class="card-body pl-5">
    <h4>Ignore List</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>List of groups that will not be audited. </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="Return_value_audit_ignore_list_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_audit_ignore_list_items_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Return_value_audit_ignore_list_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"automation"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"apps"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options" data-toggle="collapse" onclick="setAnchor('#Return_value_options')" type="button"><span class="property-name">options</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options" class="collapse property-definition-div" data-parent="#accordionReturn_value_options" id="Return_value_options">
    <div class="card-body pl-5">
    <h4>Options</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Additional configuration related to the configured SMB share purpose. If null, then the default     options related to the share purpose will be applied. </p>
    </span><div class="any-of-value" id="Return_value_options_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_options_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0" id="Return_value_options_anyOf_i0" onclick="setAnchor('#Return_value_options_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_options_anyOf_i1" id="Return_value_options_anyOf_i1" onclick="setAnchor('#Return_value_options_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_options_anyOf_i0" role="tabpanel">
    <br/>
    <div class="one-of-value" id="Return_value_options_anyOf_i0_oneOf"><h2 class="handle">
    <label>One of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_options_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_options_anyOf_i0_oneOf_i0" id="Return_value_options_anyOf_i0_oneOf_i0" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0')" role="tab">LegacyOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i1" id="Return_value_options_anyOf_i0_oneOf_i1" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i1')" role="tab">DefaultOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i2" id="Return_value_options_anyOf_i0_oneOf_i2" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i2')" role="tab">TimeMachineOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i3" id="Return_value_options_anyOf_i0_oneOf_i3" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i3')" role="tab">MultiprotocolOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i4" id="Return_value_options_anyOf_i0_oneOf_i4" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i4')" role="tab">TimeLockedOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i5" id="Return_value_options_anyOf_i0_oneOf_i5" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i5')" role="tab">PrivateDatasetOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i6" id="Return_value_options_anyOf_i0_oneOf_i6" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i6')" role="tab">ExternalOpt</a>
    </li><li class="nav-item">
    <a class="nav-link oneOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i7" id="Return_value_options_anyOf_i0_oneOf_i7" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i7')" role="tab">VeeamRepositoryOpt</a>
    </li></ul>
    <div class="tab-content card"><div class="tab-pane fade card-body active show" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i0" role="tabpanel">
    <h4>LegacyOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>LEGACY_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_recyclebin">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_recyclebin">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_recyclebin" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_recyclebin" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_recyclebin')" type="button"><span class="property-name">recyclebin</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_recyclebin" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_recyclebin" id="Return_value_options_anyOf_i0_oneOf_i0_recyclebin">
    <div class="card-body pl-5">
    <h4>Recyclebin</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>If set, deleted files are moved to per-user subdirectories in the <code>.recycle</code> directory. The     SMB server creates the <code>.recycle</code> directory at the root of the SMB share if the file is in the same     ZFS dataset as the share <code>path</code>. If the file is in a child ZFS dataset, the server uses the     <code>mountpoint</code> of that dataset to create the <code>.recycle</code> directory.</p>
    <p>NOTE: This feature does not work with recycle bin features in client operating systems.</p>
    <p>WARNING: Do not use this feature instead of backups or ZFS snapshots. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_path_suffix">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_path_suffix">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_path_suffix" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_path_suffix" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_path_suffix')" type="button"><span class="property-name">path_suffix</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_path_suffix" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_path_suffix" id="Return_value_options_anyOf_i0_oneOf_i0_path_suffix">
    <div class="card-body pl-5">
    <h4>Path Suffix</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>Path suffix template for dynamic path generation. Uses SMB variable substitution patterns like <code>%D</code> (domain)     and <code>%U</code> (username).</p>
    </span><div class="any-of-value" id="Return_value_options_anyOf_i0_oneOf_i0_path_suffix_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i0" id="Return_value_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i0" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_path_suffix_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_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i1" id="Return_value_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i1" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_path_suffix_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_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i0_path_suffix_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i0_path_suffix_ex1"><div class="highlight"><pre><span></span><span class="s2">"%D/%U"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_hostsallow">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_hostsallow">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_hostsallow" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_hostsallow" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_hostsallow')" type="button"><span class="property-name">hostsallow</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_hostsallow" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_hostsallow" id="Return_value_options_anyOf_i0_oneOf_i0_hostsallow">
    <div class="card-body pl-5">
    <h4>Hostsallow</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>A list of IP addresses or subnets that are allowed to access the SMB share. The EXCEPT keyword     may be used to limit a wildcard list.</p>
    <p>NOTE: Hostname lookups are disabled on the SMB server for performance reasons. </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="Return_value_options_anyOf_i0_oneOf_i0_hostsallow_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i0_hostsallow_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"192.168.0.200"</span><span class="p">,</span>
    <span class="w">    </span><span class="s2">"150.203."</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i0_hostsallow_ex2"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"150.203.15.0/255.255.255.0"</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i0_hostsallow_ex3"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"150.203. EXCEPT 150.203.6.66"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_hostsdeny">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_hostsdeny">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_hostsdeny" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_hostsdeny" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_hostsdeny')" type="button"><span class="property-name">hostsdeny</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_hostsdeny" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_hostsdeny" id="Return_value_options_anyOf_i0_oneOf_i0_hostsdeny">
    <div class="card-body pl-5">
    <h4>Hostsdeny</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>A list of IP addresses or subnets that are not allowed to access the SMB share. The keyword     <code>ALL</code> or the netmask <code>0.0.0.0/0</code> may be used to deny all by default. </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="Return_value_options_anyOf_i0_oneOf_i0_hostsdeny_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i0_hostsdeny_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"150.203.4."</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i0_hostsdeny_ex2"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"ALL"</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i0_hostsdeny_ex3"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"0.0.0.0/0"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_guestok">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_guestok">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_guestok" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_guestok" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_guestok')" type="button"><span class="property-name">guestok</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_guestok" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_guestok" id="Return_value_options_anyOf_i0_oneOf_i0_guestok">
    <div class="card-body pl-5">
    <h4>Guestok</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>If set, guest access to the share is allowed. This should not be used in production environments.</p>
    <p>NOTE: If a user account does not exist, the SMB server maps access to the guest account.</p>
    <p>WARNING: Additional client-side configuration downgrading security settings may be required in order     to use this feature. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_streams">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_streams">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_streams" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_streams" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_streams')" type="button"><span class="property-name">streams</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_streams" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_streams" id="Return_value_options_anyOf_i0_oneOf_i0_streams">
    <div class="card-body pl-5">
    <h4>Streams</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If set, support for SMB alternate data streams is enabled.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_durablehandle">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_durablehandle">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_durablehandle" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_durablehandle" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_durablehandle')" type="button"><span class="property-name">durablehandle</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_durablehandle" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_durablehandle" id="Return_value_options_anyOf_i0_oneOf_i0_durablehandle">
    <div class="card-body pl-5">
    <h4>Durablehandle</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If set, support for SMB durable handles is enabled.</p>
    <p>WARNING: This feature is incompatible with multiprotocol and local filesystem access. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_shadowcopy">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_shadowcopy">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_shadowcopy" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_shadowcopy" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_shadowcopy')" type="button"><span class="property-name">shadowcopy</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_shadowcopy" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_shadowcopy" id="Return_value_options_anyOf_i0_oneOf_i0_shadowcopy">
    <div class="card-body pl-5">
    <h4>Shadowcopy</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If set, previous versions of files contained in ZFS snapshots are accessible through standard SMB protocol     operations on previous versions of files. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_fsrvp">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_fsrvp">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_fsrvp" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_fsrvp" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_fsrvp')" type="button"><span class="property-name">fsrvp</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_fsrvp" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_fsrvp" id="Return_value_options_anyOf_i0_oneOf_i0_fsrvp">
    <div class="card-body pl-5">
    <h4>Fsrvp</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>If set, enable support for the File Server Remote VSS Protocol. This allows clients to manage     snapshots for the specified SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_home">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_home">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_home" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_home" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_home')" type="button"><span class="property-name">home</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_home" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_home" id="Return_value_options_anyOf_i0_oneOf_i0_home">
    <div class="card-body pl-5">
    <h4>Home</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>Use the <code>path</code> to store user home directories. Each user has a personal home directory and share.     Users cannot access other user directories when connecting to shares.</p>
    <p>NOTE: This parameter changes the share <code>name</code> to <code>homes</code>. It also creates a dynamic share that mirrors     the username of the user. Both shares use the same <code>path</code>. You can hide the homes share by turning off     <code>browsable</code>. The dynamic user home share cannot be hidden.</p>
    <p>WARNING: This parameter changes the global server configuration. The SMB server will not authenticate     users without a valid home directory or shell.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_acl">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_acl">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_acl" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_acl" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_acl')" type="button"><span class="property-name">acl</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_acl" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_acl" id="Return_value_options_anyOf_i0_oneOf_i0_acl">
    <div class="card-body pl-5">
    <h4>Acl</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    <span class="description"><p>If set, enable mapping of local filesystem ACLs to NT ACLs for SMB clients. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_afp">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_afp">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_afp" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_afp" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_afp')" type="button"><span class="property-name">afp</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_afp" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_afp" id="Return_value_options_anyOf_i0_oneOf_i0_afp">
    <div class="card-body pl-5">
    <h4>Afp</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>If set, SMB server will read and store file metadata in an on-disk format compatible with the     legacy AFP file server.</p>
    <p>WARNING: This should not be set unless the SMB server is sharing data that was originally written     via the AFP protocol. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_timemachine">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_timemachine">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_timemachine" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_timemachine" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_timemachine')" type="button"><span class="property-name">timemachine</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_timemachine" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_timemachine" id="Return_value_options_anyOf_i0_oneOf_i0_timemachine">
    <div class="card-body pl-5">
    <h4>Timemachine</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>If set, MacOS clients can use the share as a time machine target. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_timemachine_quota">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_timemachine_quota">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_timemachine_quota" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_timemachine_quota" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_timemachine_quota')" type="button"><span class="property-name">timemachine_quota</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_timemachine_quota" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_timemachine_quota" id="Return_value_options_anyOf_i0_oneOf_i0_timemachine_quota">
    <div class="card-body pl-5">
    <h4>Timemachine Quota</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>If set, it defines the maximum size of a single time machine sparsebundle volume by limiting the     reported disk size to the SMB client. A value of zero means no quota is applied to the share.</p>
    <p>NOTE: Modern MacOS versions you set Time Machine quotas client-side. This gives more predictable     server and client behavior.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_options_anyOf_i0_oneOf_i0_timemachine_quota_number">Value must be greater or equal to <code>0</code> and lesser or equal to <code>109951162777600</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_aapl_name_mangling">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_aapl_name_mangling">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_aapl_name_mangling" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_aapl_name_mangling" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_aapl_name_mangling')" type="button"><span class="property-name">aapl_name_mangling</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_aapl_name_mangling" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_aapl_name_mangling" id="Return_value_options_anyOf_i0_oneOf_i0_aapl_name_mangling">
    <div class="card-body pl-5">
    <h4>Aapl Name Mangling</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>If set, illegal NTFS characters commonly used by MacOS clients are stored with their native values on the SMB     server's local filesystem.</p>
    <p>NOTE: Files with illegal NTFS characters in their names may not be accessible to non-MacOS SMB clients.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_vuid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_vuid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_vuid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_vuid" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_vuid')" type="button"><span class="property-name">vuid</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_vuid" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_vuid" id="Return_value_options_anyOf_i0_oneOf_i0_vuid">
    <div class="card-body pl-5">
    <h4>Vuid</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>This value is the Time Machine volume UUID for the SMB share. The TrueNAS server uses this value in the mDNS     advertisement for the Time Machine share. MacOS clients may use it to identify the volume. When you create or     update a share, setting this value to null makes the TrueNAS server generate a new UUID for the share. </p>
    </span><div class="any-of-value" id="Return_value_options_anyOf_i0_oneOf_i0_vuid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_options_anyOf_i0_oneOf_i0_vuid_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i0_vuid_anyOf_i0" id="Return_value_options_anyOf_i0_oneOf_i0_vuid_anyOf_i0" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_vuid_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_options_anyOf_i0_oneOf_i0_vuid_anyOf_i1" id="Return_value_options_anyOf_i0_oneOf_i0_vuid_anyOf_i1" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_vuid_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_options_anyOf_i0_oneOf_i0_vuid_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_options_anyOf_i0_oneOf_i0_vuid_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i0_vuid_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i0_vuid_ex1"><div class="highlight"><pre><span></span><span class="s2">"d12aafdc-a7ac-4e3c-8bbd-6001f7f19819"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i0_auxsmbconf">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i0_auxsmbconf">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i0_auxsmbconf" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i0_auxsmbconf" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i0_auxsmbconf')" type="button"><span class="property-name">auxsmbconf</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i0_auxsmbconf" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i0_auxsmbconf" id="Return_value_options_anyOf_i0_oneOf_i0_auxsmbconf">
    <div class="card-body pl-5">
    <h4>Auxsmbconf</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: ""</span><br/>
    <span class="description"><p>Additional parameters to set on the SMB share. Parameters must be separated by the new-line character.</p>
    <p>WARNING: These parameters are not validated and may cause undefined server behavior including     data corruption or data loss.</p>
    <p>WARNING: Auxiliary parameters are an unsupported configuration.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i1" role="tabpanel">
    <h4>DefaultOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>DEFAULT_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i1_aapl_name_mangling">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i1_aapl_name_mangling">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i1_aapl_name_mangling" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i1_aapl_name_mangling" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i1_aapl_name_mangling')" type="button"><span class="property-name">aapl_name_mangling</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i1_aapl_name_mangling" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i1_aapl_name_mangling" id="Return_value_options_anyOf_i0_oneOf_i1_aapl_name_mangling">
    <div class="card-body pl-5">
    <h4>Aapl Name Mangling</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>If set, illegal NTFS characters commonly used by MacOS clients are stored with their native values on the SMB     server's local filesystem.</p>
    <p>NOTE: Files with illegal NTFS characters in their names may not be accessible to non-MacOS SMB clients.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i2" role="tabpanel">
    <h4>TimeMachineOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>TIMEMACHINE_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i2_timemachine_quota">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i2_timemachine_quota">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i2_timemachine_quota" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i2_timemachine_quota" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i2_timemachine_quota')" type="button"><span class="property-name">timemachine_quota</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i2_timemachine_quota" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i2_timemachine_quota" id="Return_value_options_anyOf_i0_oneOf_i2_timemachine_quota">
    <div class="card-body pl-5">
    <h4>Timemachine Quota</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>If set, it defines the maximum size in bytes of a single time machine sparsebundle volume by limiting the     reported disk size to the SMB client. A value of zero means no quota is set.</p>
    <p>NOTE: Modern MacOS versions you set Time Machine quotas client-side. This gives more predictable     server and client behavior.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_options_anyOf_i0_oneOf_i2_timemachine_quota_number">Value must be greater or equal to <code>0</code> and lesser or equal to <code>109951162777600</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i2_auto_snapshot">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i2_auto_snapshot">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i2_auto_snapshot" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i2_auto_snapshot" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i2_auto_snapshot')" type="button"><span class="property-name">auto_snapshot</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i2_auto_snapshot" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i2_auto_snapshot" id="Return_value_options_anyOf_i0_oneOf_i2_auto_snapshot">
    <div class="card-body pl-5">
    <h4>Auto Snapshot</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>If set, the server makes a ZFS snapshot of the share dataset when the client makes a new     Time Machine backup. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i2_auto_dataset_creation">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i2_auto_dataset_creation">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i2_auto_dataset_creation" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i2_auto_dataset_creation" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i2_auto_dataset_creation')" type="button"><span class="property-name">auto_dataset_creation</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i2_auto_dataset_creation" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i2_auto_dataset_creation" id="Return_value_options_anyOf_i0_oneOf_i2_auto_dataset_creation">
    <div class="card-body pl-5">
    <h4>Auto Dataset Creation</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>If set, the server uses the <code>dataset_naming_schema</code> to make a new ZFS dataset when the client connects.     The server uses this dataset as the share path during the SMB session.</p>
    <p>NOTE: this setting requires the share path to be a dataset mountpoint.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema')" type="button"><span class="property-name">dataset_naming_schema</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema" id="Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema">
    <div class="card-body pl-5">
    <h4>Dataset Naming Schema</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>The naming schema to use when <code>auto_dataset_creation</code> is specified. If you do not set a schema,     the server uses <code>%U</code> (username) if it is not joined to Active Directory. If the server is joined to     Active Directory it uses <code>%D/%U</code> (domain/username). See the <code>VARIABLE SUBSTITUTIONS</code> section in the smb.conf     manpage for valid strings.</p>
    <p>WARNING: ZFS dataset naming rules are more restrictive than normal path rules. For example, if <code>%u</code> is specified     then the character <code>\</code> may be inserted in the username (which is not supported in ZFS).</p>
    </span><div class="any-of-value" id="Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_i0" id="Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_i0" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema_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_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_i1" id="Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_i1" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema_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_options_anyOf_i0_oneOf_i2_dataset_naming_schema_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_Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i2_dataset_naming_schema_ex1"><div class="highlight"><pre><span></span><span class="s2">"%D/%U"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i2_vuid">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i2_vuid">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i2_vuid" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i2_vuid" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i2_vuid')" type="button"><span class="property-name">vuid</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i2_vuid" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i2_vuid" id="Return_value_options_anyOf_i0_oneOf_i2_vuid">
    <div class="card-body pl-5">
    <h4>Vuid</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>This value is the Time Machine volume UUID for the SMB share. The TrueNAS server uses this value in the mDNS     advertisement for the Time Machine share. MacOS clients may use it to identify the volume. When you create or     update a share, setting this value to null makes the TrueNAS server generate a new UUID for the share. </p>
    </span><div class="any-of-value" id="Return_value_options_anyOf_i0_oneOf_i2_vuid_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_options_anyOf_i0_oneOf_i2_vuid_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i2_vuid_anyOf_i0" id="Return_value_options_anyOf_i0_oneOf_i2_vuid_anyOf_i0" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i2_vuid_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_options_anyOf_i0_oneOf_i2_vuid_anyOf_i1" id="Return_value_options_anyOf_i0_oneOf_i2_vuid_anyOf_i1" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i2_vuid_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_options_anyOf_i0_oneOf_i2_vuid_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_options_anyOf_i0_oneOf_i2_vuid_anyOf_i0_minLength">Must be at least <code>1</code> characters long</span></p>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i2_vuid_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i2_vuid_ex1"><div class="highlight"><pre><span></span><span class="s2">"d12aafdc-a7ac-4e3c-8bbd-6001f7f19819"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i3" role="tabpanel">
    <h4>MultiprotocolOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>MULTIPROTOCOL_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i3_aapl_name_mangling">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i3_aapl_name_mangling">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i3_aapl_name_mangling" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i3_aapl_name_mangling" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i3_aapl_name_mangling')" type="button"><span class="property-name">aapl_name_mangling</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i3_aapl_name_mangling" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i3_aapl_name_mangling" id="Return_value_options_anyOf_i0_oneOf_i3_aapl_name_mangling">
    <div class="card-body pl-5">
    <h4>Aapl Name Mangling</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>If set, illegal NTFS characters commonly used by MacOS clients are stored with their native values on the SMB     server's local filesystem.</p>
    <p>NOTE: Files with illegal NTFS characters in their names may not be accessible to non-MacOS SMB clients.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i4" role="tabpanel">
    <h4>TimeLockedOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>TIME_LOCKED_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i4_grace_period">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i4_grace_period">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i4_grace_period" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i4_grace_period" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i4_grace_period')" type="button"><span class="property-name">grace_period</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i4_grace_period" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i4_grace_period" id="Return_value_options_anyOf_i0_oneOf_i4_grace_period">
    <div class="card-body pl-5">
    <h4>Grace Period</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 900</span><br/>
    <span class="description"><p>Time in seconds when write access to the file or directory is allowed. </p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_options_anyOf_i0_oneOf_i4_grace_period_number">Value must be greater or equal to <code>60</code> and lesser or equal to <code>15552000</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i4_aapl_name_mangling">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i4_aapl_name_mangling">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i4_aapl_name_mangling" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i4_aapl_name_mangling" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i4_aapl_name_mangling')" type="button"><span class="property-name">aapl_name_mangling</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i4_aapl_name_mangling" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i4_aapl_name_mangling" id="Return_value_options_anyOf_i0_oneOf_i4_aapl_name_mangling">
    <div class="card-body pl-5">
    <h4>Aapl Name Mangling</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>If set, illegal NTFS characters commonly used by MacOS clients are stored with their native values on the SMB     server's local filesystem.</p>
    <p>NOTE: Files with illegal NTFS characters in their names may not be accessible to non-MacOS SMB clients.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i5" role="tabpanel">
    <h4>PrivateDatasetOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>PRIVATE_DATASETS_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema')" type="button"><span class="property-name">dataset_naming_schema</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema" id="Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema">
    <div class="card-body pl-5">
    <h4>Dataset Naming Schema</h4> <span class="badge badge-success default-value">Default: null</span><br/>
    <span class="description"><p>The naming schema to use. If you do not set a schema, the server uses <code>%U</code> (username) if it is not joined to     Active Directory. If the server is joined to Active Directory it uses <code>%D/%U</code> (domain/username).</p>
    <p>WARNING: ZFS dataset naming rules are more restrictive than normal path rules.</p>
    </span><div class="any-of-value" id="Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_i0" id="Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_i0" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema_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_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_i1" id="Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_i1" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema_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_options_anyOf_i0_oneOf_i5_dataset_naming_schema_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_Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i5_dataset_naming_schema_ex1"><div class="highlight"><pre><span></span><span class="s2">"%D/%U"</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i5_auto_quota">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i5_auto_quota">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i5_auto_quota" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i5_auto_quota" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i5_auto_quota')" type="button"><span class="property-name">auto_quota</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i5_auto_quota" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i5_auto_quota" id="Return_value_options_anyOf_i0_oneOf_i5_auto_quota">
    <div class="card-body pl-5">
    <h4>Auto Quota</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>Set the specified ZFS quota (in gibibytes) on new datasets. If the value is zero, TrueNAS disables     automatic quotas for the share.</p>
    </span>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_options_anyOf_i0_oneOf_i5_auto_quota_number">Value must be greater or equal to <code>0</code></span></p>
    <br/>
    <div class="badge badge-secondary">Example:</div>
    <br/><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i5_auto_quota_ex1"><div class="highlight"><pre><span></span><span class="mf">10</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i5_aapl_name_mangling">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i5_aapl_name_mangling">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i5_aapl_name_mangling" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i5_aapl_name_mangling" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i5_aapl_name_mangling')" type="button"><span class="property-name">aapl_name_mangling</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i5_aapl_name_mangling" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i5_aapl_name_mangling" id="Return_value_options_anyOf_i0_oneOf_i5_aapl_name_mangling">
    <div class="card-body pl-5">
    <h4>Aapl Name Mangling</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>If set, illegal NTFS characters commonly used by MacOS clients are stored with their native values on the SMB     server's local filesystem.</p>
    <p>NOTE: Files with illegal NTFS characters in their names may not be accessible to non-MacOS SMB clients.</p>
    <p>WARNING: This value should not be changed once data is written to the SMB share. </p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i6" role="tabpanel">
    <h4>ExternalOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>EXTERNAL_SHARE</code> purpose. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_options_anyOf_i0_oneOf_i6_remote_path">
    <div class="card">
    <div class="card-header" id="headingReturn_value_options_anyOf_i0_oneOf_i6_remote_path">
    <h2 class="mb-0">
    <button aria-controls="Return_value_options_anyOf_i0_oneOf_i6_remote_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_options_anyOf_i0_oneOf_i6_remote_path" data-toggle="collapse" onclick="setAnchor('#Return_value_options_anyOf_i0_oneOf_i6_remote_path')" type="button"><span class="property-name">remote_path</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_options_anyOf_i0_oneOf_i6_remote_path" class="collapse property-definition-div" data-parent="#accordionReturn_value_options_anyOf_i0_oneOf_i6_remote_path" id="Return_value_options_anyOf_i0_oneOf_i6_remote_path">
    <div class="card-body pl-5">
    <h4>Remote Path</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>This is the path to the external server and share. Each server entry must include a full domain name or IP     address and share name. Separate the server and share with the <code>\</code> character.</p>
    <p>WARNING: The SMB server and TrueNAS middleware do not check if external paths are reachable. </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="Return_value_options_anyOf_i0_oneOf_i6_remote_path_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    <p><span class="badge badge-light restriction min-length-restriction" id="Return_value_options_anyOf_i0_oneOf_i6_remote_path_items_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div><br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i6_remote_path_ex1"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"192.168.0.200\\SHARE"</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i6_remote_path_ex2"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"SERVER1.MYDOM.INTERNAL\\SHARE"</span>
    <span class="p">]</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_options_anyOf_i0_oneOf_i6_remote_path_ex3"><div class="highlight"><pre><span></span><span class="p">[</span>
    <span class="w">    </span><span class="s2">"SERVER1.MYDOM.INTERNAL\\SHARE, SERVER2.MYDOM.INTERNAL\\SHARE"</span>
    <span class="p">]</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i0_oneOf_i7" role="tabpanel">
    <h4>VeeamRepositoryOpt</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>These configuration options apply to shares with the <code>VEEAM_REPOSITORY_SHARE</code> purpose. </p>
    </span>
    </div></div></div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_options_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    <br/>
    <div class="badge badge-secondary">Examples:</div>
    <br/><div class="jumbotron examples" id="Return_value_options_ex1"><div class="highlight"><pre><span></span><span class="p">{</span>
    <span class="w">    </span><span class="s2">"auto_snapshot"</span><span class="o">:</span><span class="w"> </span><span class="kc">true</span>
    <span class="p">}</span>
    </pre></div>
    </div><div class="jumbotron examples" id="Return_value_options_ex2"><div class="highlight"><pre><span></span><span class="p">{</span>
    <span class="w">    </span><span class="s2">"auto_quota"</span><span class="o">:</span><span class="w"> </span><span class="mf">100</span>
    <span class="p">}</span>
    </pre></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SHARING_SMB_WRITE

