sharing.webshare.query
======================

Sent on sharing.webshare changes.

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionADDED">
    <div class="card">
    <div class="card-header" id="headingADDED">
    <h2 class="mb-0">
    <button aria-controls="ADDED" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED" data-toggle="collapse" onclick="setAnchor('#ADDED')" type="button"><span class="property-name">ADDED</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED" class="collapse property-definition-div" data-parent="#accordionADDED" id="ADDED">
    <div class="card-body pl-5">
    <h4>SharingWebshareAddedEvent</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionADDED_id">
    <div class="card">
    <div class="card-header" id="headingADDED_id">
    <h2 class="mb-0">
    <button aria-controls="ADDED_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_id" data-toggle="collapse" onclick="setAnchor('#ADDED_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_id" class="collapse property-definition-div" data-parent="#accordionADDED_id" id="ADDED_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields">
    <div class="card">
    <div class="card-header" id="headingADDED_fields">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields" data-toggle="collapse" onclick="setAnchor('#ADDED_fields')" type="button"><span class="property-name">fields</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields" class="collapse property-definition-div" data-parent="#accordionADDED_fields" id="ADDED_fields">
    <div class="card-body pl-5">
    <h4>SharingWebshareEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Webshare share entry on the TrueNAS server. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionADDED_fields_id">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_id">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_id" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_id" class="collapse property-definition-div" data-parent="#accordionADDED_fields_id" id="ADDED_fields_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 Webshare share.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_name">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_name">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_name" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_name" class="collapse property-definition-div" data-parent="#accordionADDED_fields_name" id="ADDED_fields_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>Webshare share name.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="ADDED_fields_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_path">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_path">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_path" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_path')" type="button"><span class="property-name">path</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_path" class="collapse property-definition-div" data-parent="#accordionADDED_fields_path" id="ADDED_fields_path">
    <div class="card-body pl-5">
    <h4>Path</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Local server path to share by using the Webshare protocol. The path must start with <code>/mnt/</code> and must be in a     ZFS pool.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="ADDED_fields_path_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_enabled">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_enabled">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_enabled" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_enabled" class="collapse property-definition-div" data-parent="#accordionADDED_fields_enabled" id="ADDED_fields_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 Webshare share is not available.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_is_home_base">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_is_home_base">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_is_home_base" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_is_home_base" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_is_home_base')" type="button"><span class="property-name">is_home_base</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_is_home_base" class="collapse property-definition-div" data-parent="#accordionADDED_fields_is_home_base" id="ADDED_fields_is_home_base">
    <div class="card-body pl-5">
    <h4>Is Home Base</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, this share is used as the base path for user home directories. Only one share can have this enabled.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionADDED_fields_locked">
    <div class="card">
    <div class="card-header" id="headingADDED_fields_locked">
    <h2 class="mb-0">
    <button aria-controls="ADDED_fields_locked" aria-expanded="" class="btn btn-link property-name-button" data-target="#ADDED_fields_locked" data-toggle="collapse" onclick="setAnchor('#ADDED_fields_locked')" type="button"><span class="property-name">locked</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingADDED_fields_locked" class="collapse property-definition-div" data-parent="#accordionADDED_fields_locked" id="ADDED_fields_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="ADDED_fields_locked_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsADDED_fields_locked_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_ADDED_fields_locked_anyOf_i0" id="ADDED_fields_locked_anyOf_i0" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_locked_anyOf_i1" id="ADDED_fields_locked_anyOf_i1" onclick="setAnchor('#ADDED_fields_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_ADDED_fields_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_ADDED_fields_locked_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED">
    <div class="card">
    <div class="card-header" id="headingCHANGED">
    <h2 class="mb-0">
    <button aria-controls="CHANGED" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED" data-toggle="collapse" onclick="setAnchor('#CHANGED')" type="button"><span class="property-name">CHANGED</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED" class="collapse property-definition-div" data-parent="#accordionCHANGED" id="CHANGED">
    <div class="card-body pl-5">
    <h4>SharingWebshareChangedEvent</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCHANGED_id">
    <div class="card">
    <div class="card-header" id="headingCHANGED_id">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_id" data-toggle="collapse" onclick="setAnchor('#CHANGED_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_id" class="collapse property-definition-div" data-parent="#accordionCHANGED_id" id="CHANGED_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields')" type="button"><span class="property-name">fields</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields" id="CHANGED_fields">
    <div class="card-body pl-5">
    <h4>SharingWebshareEntry</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Webshare share entry on the TrueNAS server. </p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCHANGED_fields_id">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_id">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_id" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_id" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_id" id="CHANGED_fields_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 Webshare share.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_name">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_name">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_name" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_name')" type="button"><span class="property-name">name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_name" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_name" id="CHANGED_fields_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>Webshare share name.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="CHANGED_fields_name_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_path">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_path">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_path" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_path" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_path')" type="button"><span class="property-name">path</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_path" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_path" id="CHANGED_fields_path">
    <div class="card-body pl-5">
    <h4>Path</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Local server path to share by using the Webshare protocol. The path must start with <code>/mnt/</code> and must be in a     ZFS pool.</p>
    </span>
    <p><span class="badge badge-light restriction min-length-restriction" id="CHANGED_fields_path_minLength">Must be at least <code>1</code> characters long</span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_enabled">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_enabled">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_enabled" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_enabled" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_enabled" id="CHANGED_fields_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 Webshare share is not available.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_is_home_base">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_is_home_base">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_is_home_base" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_is_home_base" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_is_home_base')" type="button"><span class="property-name">is_home_base</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_is_home_base" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_is_home_base" id="CHANGED_fields_is_home_base">
    <div class="card-body pl-5">
    <h4>Is Home Base</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, this share is used as the base path for user home directories. Only one share can have this enabled.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_fields_locked">
    <div class="card">
    <div class="card-header" id="headingCHANGED_fields_locked">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_fields_locked" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_fields_locked" data-toggle="collapse" onclick="setAnchor('#CHANGED_fields_locked')" type="button"><span class="property-name">locked</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_fields_locked" class="collapse property-definition-div" data-parent="#accordionCHANGED_fields_locked" id="CHANGED_fields_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="CHANGED_fields_locked_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCHANGED_fields_locked_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_CHANGED_fields_locked_anyOf_i0" id="CHANGED_fields_locked_anyOf_i0" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_locked_anyOf_i1" id="CHANGED_fields_locked_anyOf_i1" onclick="setAnchor('#CHANGED_fields_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_CHANGED_fields_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_CHANGED_fields_locked_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: null</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionREMOVED">
    <div class="card">
    <div class="card-header" id="headingREMOVED">
    <h2 class="mb-0">
    <button aria-controls="REMOVED" aria-expanded="" class="btn btn-link property-name-button" data-target="#REMOVED" data-toggle="collapse" onclick="setAnchor('#REMOVED')" type="button"><span class="property-name">REMOVED</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingREMOVED" class="collapse property-definition-div" data-parent="#accordionREMOVED" id="REMOVED">
    <div class="card-body pl-5">
    <h4>SharingWebshareRemovedEvent</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionREMOVED_id">
    <div class="card">
    <div class="card-header" id="headingREMOVED_id">
    <h2 class="mb-0">
    <button aria-controls="REMOVED_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#REMOVED_id" data-toggle="collapse" onclick="setAnchor('#REMOVED_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingREMOVED_id" class="collapse property-definition-div" data-parent="#accordionREMOVED_id" id="REMOVED_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* SHARING_WEBSHARE_READ