# pool.scan

Progress of pool resilver/scrub.

Type: object

##

#### PoolScanChangedEvent

Type: object
No Additional Properties

##

#### Name

Type: string

Pool name.

##

#### PoolScan

Type: object

Scan information.

No Additional Properties

##

#### Function

Type: enum (of string)

Type of ZFS pool scan.

##### Must be one of:

- "RESILVER"
- "SCRUB"

##

#### State

Type: enum (of string)

Current lifecycle state of the scan.

##### Must be one of:

- "SCANNING"
- "FINISHED"
- "CANCELED"

##

#### Start Time

Type: stringFormat: date-time

Scan start time.

##

#### End Time

Scan end time (`null` while the scan is still running).

## Any of

Type: stringFormat: date-time
Type: null

##

#### Percentage

Type: number

Scan progress (between 0 and 100%).

##

#### Bytes To Process

Type: integer

Total bytes located by scanner.

##

#### Bytes Processed

Type: integer

Total bytes to scan.

##

#### Bytes Issued

Type: integer

Issued bytes per scan pass.

##

#### Pause

Pause time of a scrub pass (`null` if the scan is not paused).

## Any of

Type: stringFormat: date-time
Type: null

##

#### Errors

Type: integer

Number of scan errors.

##

#### Total Secs Left

Number of seconds left (`null` if the scan is not running).

## Any of

Type: integer
Type: null

Required roles: POOL_SCRUB_READ