pool.scrub.create
=================

Create a scrub task for a pool.

`threshold` refers to the minimum amount of time in days has to be passed before a scrub can run again.

.. examples(websocket)::

  Create a scrub task for pool of id 1, to run every sunday but with a threshold of 35 days. The check will run at 3AM every sunday.

    :::javascript {
        "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "pool.scrub.create" "params": [{ "pool": 1, "threshold": 35, "description": "Monthly scrub for tank", "schedule": "0 3 * * 7", "enabled": true }] }

.. 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="badge badge-info no-additional">No Additional Properties</span>
    <div class="accordion" id="accordionCall_parameters_items_i0_pool">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_pool">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_pool" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_pool" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_pool')" type="button"><span class="property-name">pool</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_pool" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_pool" id="Call_parameters_items_i0_pool">
    <div class="card-body pl-5">
    <h4>Pool</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_pool_number">Value must be strictly greater than <code>0</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_threshold">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_threshold">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_threshold" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_threshold" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_threshold')" type="button"><span class="property-name">threshold</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_threshold" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_threshold" id="Call_parameters_items_i0_threshold">
    <div class="card-body pl-5">
    <h4>Threshold</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 35</span><br/>
    <p><span class="badge badge-light restriction numeric-restriction" id="Call_parameters_items_i0_threshold_number">Value must be greater or equal to <code>0</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_description">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_description">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_description" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_description" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_description')" type="button"><span class="property-name">description</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_description" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_description" id="Call_parameters_items_i0_description">
    <div class="card-body pl-5">
    <h4>Description</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: ""</span><br/>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_schedule">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_schedule">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_schedule" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule')" type="button"><span class="property-name">schedule</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_schedule" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule" id="Call_parameters_items_i0_schedule">
    <div class="card-body pl-5">
    <h4>PoolScrubCron</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="accordionCall_parameters_items_i0_schedule_minute">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_schedule_minute">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_schedule_minute" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule_minute" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule_minute')" type="button"><span class="property-name">minute</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_schedule_minute" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule_minute" id="Call_parameters_items_i0_schedule_minute">
    <div class="card-body pl-5">
    <h4>Minute</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "00"</span><br/>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_schedule_hour">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_schedule_hour">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_schedule_hour" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule_hour" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule_hour')" type="button"><span class="property-name">hour</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_schedule_hour" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule_hour" id="Call_parameters_items_i0_schedule_hour">
    <div class="card-body pl-5">
    <h4>Hour</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "00"</span><br/>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_schedule_dom">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_schedule_dom">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_schedule_dom" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule_dom" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule_dom')" type="button"><span class="property-name">dom</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_schedule_dom" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule_dom" id="Call_parameters_items_i0_schedule_dom">
    <div class="card-body pl-5">
    <h4>Dom</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"1" - "31"</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_schedule_month">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_schedule_month">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_schedule_month" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule_month" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule_month')" type="button"><span class="property-name">month</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_schedule_month" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule_month" id="Call_parameters_items_i0_schedule_month">
    <div class="card-body pl-5">
    <h4>Month</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"1" (January) - "12" (December)</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_schedule_dow">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_schedule_dow">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_schedule_dow" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_schedule_dow" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_schedule_dow')" type="button"><span class="property-name">dow</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_schedule_dow" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_schedule_dow" id="Call_parameters_items_i0_schedule_dow">
    <div class="card-body pl-5">
    <h4>Dow</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "7"</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionCall_parameters_items_i0_enabled">
    <div class="card">
    <div class="card-header" id="headingCall_parameters_items_i0_enabled">
    <h2 class="mb-0">
    <button aria-controls="Call_parameters_items_i0_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Call_parameters_items_i0_enabled" data-toggle="collapse" onclick="setAnchor('#Call_parameters_items_i0_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingCall_parameters_items_i0_enabled" class="collapse property-definition-div" data-parent="#accordionCall_parameters_items_i0_enabled" id="Call_parameters_items_i0_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    </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>PoolScrubEntry</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_pool">
    <div class="card">
    <div class="card-header" id="headingReturn_value_pool">
    <h2 class="mb-0">
    <button aria-controls="Return_value_pool" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_pool" data-toggle="collapse" onclick="setAnchor('#Return_value_pool')" type="button"><span class="property-name">pool</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_pool" class="collapse property-definition-div" data-parent="#accordionReturn_value_pool" id="Return_value_pool">
    <div class="card-body pl-5">
    <h4>Pool</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_pool_number">Value must be strictly greater than <code>0</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_threshold">
    <div class="card">
    <div class="card-header" id="headingReturn_value_threshold">
    <h2 class="mb-0">
    <button aria-controls="Return_value_threshold" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_threshold" data-toggle="collapse" onclick="setAnchor('#Return_value_threshold')" type="button"><span class="property-name">threshold</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_threshold" class="collapse property-definition-div" data-parent="#accordionReturn_value_threshold" id="Return_value_threshold">
    <div class="card-body pl-5">
    <h4>Threshold</h4><span class="badge badge-dark value-type">Type: integer</span> <span class="badge badge-success default-value">Default: 35</span><br/>
    <p><span class="badge badge-light restriction numeric-restriction" id="Return_value_threshold_number">Value must be greater or equal to <code>0</code></span></p>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_description">
    <div class="card">
    <div class="card-header" id="headingReturn_value_description">
    <h2 class="mb-0">
    <button aria-controls="Return_value_description" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_description" data-toggle="collapse" onclick="setAnchor('#Return_value_description')" type="button"><span class="property-name">description</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_description" class="collapse property-definition-div" data-parent="#accordionReturn_value_description" id="Return_value_description">
    <div class="card-body pl-5">
    <h4>Description</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: ""</span><br/>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_schedule">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule')" type="button"><span class="property-name">schedule</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule" id="Return_value_schedule">
    <div class="card-body pl-5">
    <h4>PoolScrubCron</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_schedule_minute">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule_minute">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule_minute" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule_minute" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule_minute')" type="button"><span class="property-name">minute</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule_minute" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule_minute" id="Return_value_schedule_minute">
    <div class="card-body pl-5">
    <h4>Minute</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "00"</span><br/>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_schedule_hour">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule_hour">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule_hour" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule_hour" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule_hour')" type="button"><span class="property-name">hour</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule_hour" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule_hour" id="Return_value_schedule_hour">
    <div class="card-body pl-5">
    <h4>Hour</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "00"</span><br/>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_schedule_dom">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule_dom">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule_dom" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule_dom" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule_dom')" type="button"><span class="property-name">dom</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule_dom" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule_dom" id="Return_value_schedule_dom">
    <div class="card-body pl-5">
    <h4>Dom</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"1" - "31"</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_schedule_month">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule_month">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule_month" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule_month" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule_month')" type="button"><span class="property-name">month</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule_month" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule_month" id="Return_value_schedule_month">
    <div class="card-body pl-5">
    <h4>Month</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "*"</span><br/>
    <span class="description"><p>"1" (January) - "12" (December)</p>
    </span>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_schedule_dow">
    <div class="card">
    <div class="card-header" id="headingReturn_value_schedule_dow">
    <h2 class="mb-0">
    <button aria-controls="Return_value_schedule_dow" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_schedule_dow" data-toggle="collapse" onclick="setAnchor('#Return_value_schedule_dow')" type="button"><span class="property-name">dow</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_schedule_dow" class="collapse property-definition-div" data-parent="#accordionReturn_value_schedule_dow" id="Return_value_schedule_dow">
    <div class="card-body pl-5">
    <h4>Dow</h4><span class="badge badge-dark value-type">Type: string</span> <span class="badge badge-success default-value">Default: "7"</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_enabled">
    <div class="card">
    <div class="card-header" id="headingReturn_value_enabled">
    <h2 class="mb-0">
    <button aria-controls="Return_value_enabled" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_enabled" data-toggle="collapse" onclick="setAnchor('#Return_value_enabled')" type="button"><span class="property-name">enabled</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_enabled" class="collapse property-definition-div" data-parent="#accordionReturn_value_enabled" id="Return_value_enabled">
    <div class="card-body pl-5">
    <h4>Enabled</h4><span class="badge badge-dark value-type">Type: boolean</span> <span class="badge badge-success default-value">Default: true</span><br/>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_id">
    <div class="card">
    <div class="card-header" id="headingReturn_value_id">
    <h2 class="mb-0">
    <button aria-controls="Return_value_id" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_id" data-toggle="collapse" onclick="setAnchor('#Return_value_id')" type="button"><span class="property-name">id</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_id" class="collapse property-definition-div" data-parent="#accordionReturn_value_id" id="Return_value_id">
    <div class="card-body pl-5">
    <h4>Id</h4><span class="badge badge-dark value-type">Type: integer</span><br/>
    </div>
    </div>
    </div>
    </div>
    <div class="accordion" id="accordionReturn_value_pool_name">
    <div class="card">
    <div class="card-header" id="headingReturn_value_pool_name">
    <h2 class="mb-0">
    <button aria-controls="Return_value_pool_name" aria-expanded="" class="btn btn-link property-name-button" data-target="#Return_value_pool_name" data-toggle="collapse" onclick="setAnchor('#Return_value_pool_name')" type="button"><span class="property-name">pool_name</span> <span class="badge badge-warning required-property">Required</span></button>
    </h2>
    </div>
    <div aria-labelledby="headingReturn_value_pool_name" class="collapse property-definition-div" data-parent="#accordionReturn_value_pool_name" id="Return_value_pool_name">
    <div class="card-body pl-5">
    <h4>Pool Name</h4><span class="badge badge-dark value-type">Type: string</span><br/>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div>
    </div><br><br>

*Required roles:* POOL_SCRUB_WRITE

