disk.details
============

Return detailed information for all disks on the system.

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <div class="accordion" id="accordionCall_parameters">
    <div class="card">
    <div class="card-header" id="headingCall_parameters">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters" data-toggle="collapse" onclick="setAnchor('#Call_parameters')" type="button"><span class="property-name">Call parameters</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters" class="collapse property-definition-div" data-parent="#accordionCall_parameters" id="Call_parameters">
    <div class="card-body pl-5">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h4>Tuple Validation</h4>
    <h5>Parameter 1: data</h5>
    <div class="card">
    <div class="card-body items-definition" id="Call_parameters_items_i0">
    <h4>data</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Disk query parameters specifying which disks to return and options.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_join_partitions">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_join_partitions">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_join_partitions" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_join_partitions" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_join_partitions')" type="button"><span class="property-name">join_partitions</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_join_partitions" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_join_partitions" id="Call_parameters_items_i0_join_partitions">
    <div class="card-body pl-5">
    <h4>Join Partitions</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: false</span><br/>
    <span class="description"><p>Return all partitions currently written to disk.</p>
    <p><strong>NOTE: This is an expensive operation.</strong></p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_type">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_type">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_type" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_type" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_type')" type="button"><span class="property-name">type</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_type" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_type" id="Call_parameters_items_i0_type">
    <div class="card-body pl-5">
    <h4>Type</h4><span class="badge badge-dark value-type">Type: enum (of string)</span> <span class="badge badge-success default-value">Default: "BOTH"</span><br/>
    <span class="description"><ul>
    <li><code>USED</code>: Only disks that are IN USE will be returned.</li>
    <li><code>UNUSED</code>: Only disks that are NOT IN USE are returned.</li>
    <li><code>BOTH</code>: Used and unused disks will be returned.</li>
    </ul>
    </span><div class="enum-value" id="Call_parameters_items_i0_type_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"USED"</li><li class="list-group-item enum-item">"UNUSED"</li><li class="list-group-item enum-item">"BOTH"</li></ul>
    </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>Result</h4><br/>
    <span class="description"><p>Array of disk information or object with disk details depending on query options.</p>
    </span><div class="any-of-value" id="Return_value_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsReturn_value_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_Return_value_anyOf_i0" id="Return_value_anyOf_i0" onclick="setAnchor('#Return_value_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_anyOf_i1" id="Return_value_anyOf_i1" onclick="setAnchor('#Return_value_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_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: array</span><br/>
    <span class="badge badge-info no-additional">No Additional Items</span><h5>Each item of this array must be:</h5>
    <div class="card">
    <div class="card-body items-definition" id="Return_value_anyOf_i0_items">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div>
    </div>
    </div><div class="tab-pane fade card-body" id="tab-pane_Return_value_anyOf_i1" role="tabpanel">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div></div></div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* REPORTING_READ

