zfs.resource.attachments
========================

Retrieve the shares, tasks and services that depend on the ZFS resource named by ``path``.

A filesystem reports the consumers of it and its descendants; one whose mountpoint is ``legacy`` reports nothing. A validation error is raised when the resource does not exist or is a protected internal resource (``ENOENT``).

.. code:: json

    {
        "jsonrpc": "2.0",
        "id": 1,
        "method": "zfs.resource.attachments",
        "params": ["tank/work"]
    }

.. 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: path</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>path</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Path of the zfs resource (filesystem or volume) whose dependents to list.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value">
    <div class="card">
    <div class="card-header" id="headingReturn_value">
    <h2 class="mb-0">
    <button aria-controls="Return_value" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value" data-toggle="collapse" onclick="setAnchor('#Return_value')" type="button"><span class="property-name">Return value</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value" class="collapse property-definition-div" data-parent="#accordionReturn_value" id="Return_value">
    <div class="card-body pl-5">
    <h4>Result</h4><span class="badge badge-dark value-type">Type: array of object</span><br/>
    <span class="description"><p>Array of the shares, tasks and services using the resource, grouped by kind.</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_items">
    <h4>PoolAttachment</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionReturn_value_items_type">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_type">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_type" data-toggle="collapse" onclick="setAnchor('#Return_value_items_type')" type="button"><span class="property-name">type</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_type" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_type" id="Return_value_items_type">
    <div class="card-body pl-5">
    <h4>Type</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    <span class="description"><p>Type of attachment.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_items_service">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_service">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_service" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_service" data-toggle="collapse" onclick="setAnchor('#Return_value_items_service')" type="button"><span class="property-name">service</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_service" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_service" id="Return_value_items_service">
    <div class="card-body pl-5">
    <h4>Service</h4><br/>
    <span class="description"><p>Name of the service using this pool. <code>null</code> if not a service attachment.</p>
    </span><div class="any-of-value" id="Return_value_items_service_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_items_service_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_items_service_anyOf_i0" id="Return_value_items_service_anyOf_i0" onclick="setAnchor('#Return_value_items_service_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_items_service_anyOf_i1" id="Return_value_items_service_anyOf_i1" onclick="setAnchor('#Return_value_items_service_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_items_service_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_items_service_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_items_attachments">
    <div class="card">
    <div class="card-header" id="headingReturn_value_items_attachments">
    <h2 class="mb-0">
    <button aria-controls="Return_value_items_attachments" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_items_attachments" data-toggle="collapse" onclick="setAnchor('#Return_value_items_attachments')" type="button"><span class="property-name">attachments</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_items_attachments" class="collapse property-definition-div" data-parent="#accordionReturn_value_items_attachments" id="Return_value_items_attachments">
    <div class="card-body pl-5">
    <h4>Attachments</h4><span class="badge badge-dark value-type">Type: array of string</span><br/>
    <span class="description"><p>Array of specific attachment identifiers or paths.</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_items_attachments_items">
    <span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* ZFS_RESOURCE_READ