pool.scrub.scrub

Start/Stop/Pause a scrub on pool name.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: name

name

Type: string

Name of the pool to perform scrub action on.
Parameter 2: action

action

Type: enum (of string) Default: "START"

The scrub action to perform on the pool.

Must be one of:
  • "START"
  • "STOP"
  • "PAUSE"

Result

Type: null

Returns null on successful scrub action.


Required roles: POOL_WRITE