disk.wipe
=========

Performs a wipe of a disk `dev`.

.. 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: dev</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i0"> <h4>dev</h4><span class="badge badge-dark value-type">Type: string</span><br/> <span class="description"><p>The device to perform the disk wipe operation on.<br/> May be passed as /dev/sda or just sda.</p> </span> <p><span class="badge badge-light restriction min-length-restriction" id="Call_parameters_items_i0_minLength">Must be at least <code>1</code> characters long</span></p> </div> </div> <h5>Parameter 2: mode</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i1"> <h4>mode</h4><span class="badge badge-dark value-type">Type: enum (of string)</span><br/> <span class="description"><p>QUICK: write zeros to the first and last 32MB of device<br/> FULL: write whole disk with zero's<br/> FULL_RANDOM: write whole disk with random bytes</p> </span><div class="enum-value" id="Call_parameters_items_i1_enum"> <h5>Must be one of:</h5> <ul class="list-group"><li class="list-group-item enum-item">"QUICK"</li><li class="list-group-item enum-item">"FULL"</li><li class="list-group-item enum-item">"FULL_RANDOM"</li></ul> </div> </div> </div> <h5>Parameter 3: synccache</h5> <div class="card"> <div class="card-body items-definition" id="Call_parameters_items_i2"> <h4>synccache</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 True, will synchronize the device with the database</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: null</span><br/> </div> </div> </div> </div> </div><br><br>

*Required roles:* DISK_WRITE