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
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object
No Additional Properties

Pool

Type: integer

Value must be strictly greater than 0

Threshold

Type: integer Default: 35

Value must be greater or equal to 0

Description

Type: string Default: ""

PoolScrubCron

Type: object
No Additional Properties

Minute

Type: string Default: "00"

Hour

Type: string Default: "00"

Dom

Type: string Default: "*"

"1" - "31"

Month

Type: string Default: "*"

"1" (January) - "12" (December)

Dow

Type: string Default: "7"

Enabled

Type: boolean Default: true

PoolScrubEntry

Type: object
No Additional Properties

Pool

Type: integer

Value must be strictly greater than 0

Threshold

Type: integer Default: 35

Value must be greater or equal to 0

Description

Type: string Default: ""

PoolScrubCron

Type: object
No Additional Properties

Minute

Type: string Default: "00"

Hour

Type: string Default: "00"

Dom

Type: string Default: "*"

"1" - "31"

Month

Type: string Default: "*"

"1" (January) - "12" (December)

Dow

Type: string Default: "7"

Enabled

Type: boolean Default: true

Id

Type: integer

Pool Name

Type: string


*Required roles:* POOL_SCRUB_WRITE