pool.scrub.scrub

Start, stop, or pause a scrub on pool name.

START begins a regular scrub and blocks until it finishes, is paused, or is canceled. STOP cancels an in-progress scrub. PAUSE pauses it.

Deprecated since version 26.0.0: Use zpool.scrub.run instead.

This method is a job.

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