pool.scan
=========

Progress of pool resilver/scrub.

.. raw:: html

    <div id="json-schema">
    <span class="badge badge-dark value-type">Type: object</span><br/>
    <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>PoolScanChangedEvent</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_name">
    <div class="card">
    <div class="card-header" id="headingCHANGED_name">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_name" data-toggle="collapse" onclick="setAnchor('#CHANGED_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_name" class="collapse property-definition-div" data-parent="#accordionCHANGED_name" id="CHANGED_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>Pool name.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_scan">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan')" type="button"><span class="property-name">scan</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan" id="CHANGED_scan">
    <div class="card-body pl-5">
    <h4>PoolScan</h4><span class="badge badge-dark value-type">Type: object</span><br/>
    <span class="description"><p>Scan information.</p>
    </span> <span class="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCHANGED_scan_function">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_function">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_function" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_function" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_function')" type="button"><span class="property-name">function</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_function" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_function" id="CHANGED_scan_function">
    <div class="card-body pl-5">
    <h4>Function</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Type of ZFS pool scan.</p>
    </span><div class="enum-value" id="CHANGED_scan_function_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"RESILVER"</li><li class="list-group-item enum-item">"SCRUB"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_scan_state">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_state">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_state" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_state" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_state')" type="button"><span class="property-name">state</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_state" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_state" id="CHANGED_scan_state">
    <div class="card-body pl-5">
    <h4>State</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/>
    <span class="description"><p>Current lifecycle state of the scan.</p>
    </span><div class="enum-value" id="CHANGED_scan_state_enum">
    <h5>Must be one of:</h5>
    <ul class="list-group"><li class="list-group-item enum-item">"SCANNING"</li><li class="list-group-item enum-item">"FINISHED"</li><li class="list-group-item enum-item">"CANCELED"</li></ul>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_scan_start_time">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_start_time">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_start_time" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_start_time" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_start_time')" type="button"><span class="property-name">start_time</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_start_time" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_start_time" id="CHANGED_scan_start_time">
    <div class="card-body pl-5">
    <h4>Start Time</h4><span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: date-time</span><br/>
    <span class="description"><p>Scan start time.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_scan_end_time">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_end_time">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_end_time" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_end_time" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_end_time')" type="button"><span class="property-name">end_time</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_end_time" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_end_time" id="CHANGED_scan_end_time">
    <div class="card-body pl-5">
    <h4>End Time</h4><br/>
    <span class="description"><p>Scan end time (<code>null</code> while the scan is still running).</p>
    </span><div class="any-of-value" id="CHANGED_scan_end_time_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCHANGED_scan_end_time_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_CHANGED_scan_end_time_anyOf_i0" id="CHANGED_scan_end_time_anyOf_i0" onclick="setAnchor('#CHANGED_scan_end_time_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_scan_end_time_anyOf_i1" id="CHANGED_scan_end_time_anyOf_i1" onclick="setAnchor('#CHANGED_scan_end_time_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_scan_end_time_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: date-time</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_CHANGED_scan_end_time_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="accordionCHANGED_scan_percentage">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_percentage">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_percentage" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_percentage" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_percentage')" type="button"><span class="property-name">percentage</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_percentage" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_percentage" id="CHANGED_scan_percentage">
    <div class="card-body pl-5">
    <h4>Percentage</h4><span class="badge badge-dark value-type">Type: number</span><br/>
    <span class="description"><p>Scan progress (between 0 and 100%).</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_scan_bytes_to_process">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_bytes_to_process">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_bytes_to_process" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_bytes_to_process" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_bytes_to_process')" type="button"><span class="property-name">bytes_to_process</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_bytes_to_process" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_bytes_to_process" id="CHANGED_scan_bytes_to_process">
    <div class="card-body pl-5">
    <h4>Bytes To Process</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Total bytes located by scanner.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_scan_bytes_processed">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_bytes_processed">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_bytes_processed" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_bytes_processed" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_bytes_processed')" type="button"><span class="property-name">bytes_processed</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_bytes_processed" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_bytes_processed" id="CHANGED_scan_bytes_processed">
    <div class="card-body pl-5">
    <h4>Bytes Processed</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Total bytes to scan.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_scan_bytes_issued">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_bytes_issued">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_bytes_issued" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_bytes_issued" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_bytes_issued')" type="button"><span class="property-name">bytes_issued</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_bytes_issued" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_bytes_issued" id="CHANGED_scan_bytes_issued">
    <div class="card-body pl-5">
    <h4>Bytes Issued</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Issued bytes per scan pass.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_scan_pause">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_pause">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_pause" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_pause" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_pause')" type="button"><span class="property-name">pause</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_pause" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_pause" id="CHANGED_scan_pause">
    <div class="card-body pl-5">
    <h4>Pause</h4><br/>
    <span class="description"><p>Pause time of a scrub pass (<code>null</code> if the scan is not paused).</p>
    </span><div class="any-of-value" id="CHANGED_scan_pause_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCHANGED_scan_pause_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_CHANGED_scan_pause_anyOf_i0" id="CHANGED_scan_pause_anyOf_i0" onclick="setAnchor('#CHANGED_scan_pause_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_scan_pause_anyOf_i1" id="CHANGED_scan_pause_anyOf_i1" onclick="setAnchor('#CHANGED_scan_pause_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_scan_pause_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: date-time</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_CHANGED_scan_pause_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="accordionCHANGED_scan_errors">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_errors">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_errors" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_errors" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_errors')" type="button"><span class="property-name">errors</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_errors" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_errors" id="CHANGED_scan_errors">
    <div class="card-body pl-5">
    <h4>Errors</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <span class="description"><p>Number of scan errors.</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCHANGED_scan_total_secs_left">
    <div class="card">
    <div class="card-header" id="headingCHANGED_scan_total_secs_left">
    <h2 class="mb-0">
    <button aria-controls="CHANGED_scan_total_secs_left" aria-expanded="" class="btn btn-link property-name-button" data-target="#CHANGED_scan_total_secs_left" data-toggle="collapse" onclick="setAnchor('#CHANGED_scan_total_secs_left')" type="button"><span class="property-name">total_secs_left</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCHANGED_scan_total_secs_left" class="collapse property-definition-div" data-parent="#accordionCHANGED_scan_total_secs_left" id="CHANGED_scan_total_secs_left">
    <div class="card-body pl-5">
    <h4>Total Secs Left</h4><br/>
    <span class="description"><p>Number of seconds left (<code>null</code> if the scan is not running).</p>
    </span><div class="any-of-value" id="CHANGED_scan_total_secs_left_anyOf"><h2 class="handle">
    <label>Any of</label>
    </h2><ul class="nav nav-tabs" id="tabsCHANGED_scan_total_secs_left_anyOf_anyOf" role="tablist"><li class="nav-item">
    <a class="nav-link active anyOf-option" data-toggle="tab" href="#tab-pane_CHANGED_scan_total_secs_left_anyOf_i0" id="CHANGED_scan_total_secs_left_anyOf_i0" onclick="setAnchor('#CHANGED_scan_total_secs_left_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_scan_total_secs_left_anyOf_i1" id="CHANGED_scan_total_secs_left_anyOf_i1" onclick="setAnchor('#CHANGED_scan_total_secs_left_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_scan_total_secs_left_anyOf_i0" role="tabpanel">
    <span class="badge badge-dark value-type">Type: integer</span><br/>
    </div><div class="tab-pane fade card-body" id="tab-pane_CHANGED_scan_total_secs_left_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><br><br>

*Required roles:* POOL_SCRUB_READ

