webui.enclosure.dashboard
=========================

This endpoint is used by the webUI for the enclosure dashboard page for TrueNAS sold hardware.

An example of what this returns looks like the following (some redundant information cut out for brevity)::

    [{
        "name": "iX 4024Sp c205",
        "model": "M40",
        "controller": true,
        "dmi": "TRUENAS-M40-HA",
        "status": ["OK"],
        "id": "5b0bd6d1a30714bf",
        "vendor": "iX",
        "product": "4024Sp",
        "revision": "c205",
        "bsg": "/dev/bsg/0:0:23:0",
        "sg": "/dev/sg25",
        "pci": "0:0:23:0",
        "rackmount": true,
        "top_loaded": false,
        "front_slots": 24,
        "rear_slots": 0,
        "internal_slots": 0,
        "elements": {
            "Array Device Slot": {
                "1": {
                    "descriptor": "slot00",
                    "status": "OK",
                    "dev": "sda",
                    "supports_identify_light": true,
                    "name": "sda",
                    "size": 12000138625024,
                    "model": "HUH721212AL4200",
                    "serial": "XXXXX",
                    "advpowermgmt": "DISABLED",
                    "transfermode": "Auto",
                    "hddstandby": "ALWAYS ON",
                    "description": "",
                    "rotationrate": 7200,
                    "pool_info": {
                        "pool_name": "test",
                        "disk_status": "ONLINE",
                        "disk_read_errors": 0,
                        "disk_write_errors": 0,
                        "disk_checksum_errors": 0,
                        "vdev_name": "mirror-0",
                        "vdev_type": "data",
                        "vdev_disks": [
                            {
                                "enclosure_id": "5b0bd6d1a30714bf",
                                "slot": 1,
                                "dev": "sda"
                            },
                            {
                                "enclosure_id": "5b0bd6d1a30714bf",
                                "slot": 2,
                                "dev": "sdb"
                            },
                            {
                                "enclosure_id": "5b0bd6d1a30714bf",
                                "slot": 3,
                                "dev": "sdc"
                            }
                        ]
                    }
                }
            }
        }
    }]

.. 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>
    </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 enclosure information objects for the web UI dashboard display.</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">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* ENCLOSURE_READ

