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
Configuration for the new scrub schedule.
No Additional PropertiesID of the pool to scrub.
Value must be strictly greater than 0
Days before a scrub is due when a scrub should automatically start.
Value must be greater or equal to 0
Description or notes for this scrub schedule.
Cron schedule for when scrubs should run.
No Additional PropertiesMinute when the scrub should run (cron format).
Hour when the scrub should run (cron format).
"1" - "31"
"1" (January) - "12" (December)
Day of week when the scrub should run (cron format, 7=Sunday).
Whether this scrub schedule is enabled.
The newly created scrub schedule configuration.
No Additional PropertiesID of the pool to scrub.
Value must be strictly greater than 0
Days before a scrub is due when a scrub should automatically start.
Value must be greater or equal to 0
Description or notes for this scrub schedule.
Cron schedule for when scrubs should run.
No Additional PropertiesMinute when the scrub should run (cron format).
Hour when the scrub should run (cron format).
"1" - "31"
"1" (January) - "12" (December)
Day of week when the scrub should run (cron format, 7=Sunday).
Whether this scrub schedule is enabled.
Unique identifier for the scrub schedule.
Name of the pool being scrubbed.