Interface ZPool

interface ZPool {
    comment?: string;
    datasets?: Dataset[];
    diskIdentifier?: DiskIdentifier;
    diskType?: "Hybrid" | "SSD" | "HDD";
    errorCount: number;
    errors?: string[];
    failMode?: "wait" | "continue" | "panic";
    fileSystem?: ZFSFileSystemInfo;
    guid: string;
    name: string;
    properties: {
        allocated: string;
        altroot?: string;
        autoExpand: boolean;
        autoReplace: boolean;
        autoTrim: boolean;
        available: number;
        capacity: number;
        compression: boolean;
        deduplication: boolean;
        delegation?: boolean;
        forceCreate?: boolean;
        free: string;
        health?: string;
        listSnapshots?: boolean;
        rawsize: number;
        readOnly: boolean;
        record: string;
        refreservationPercent?: number;
        refreservationRawSize?: number;
        sector: string;
        size: string;
        upgradable?: boolean;
    };
    scan?: PoolScanObject;
    status: string;
    statusCode: null | string;
    statusDetail: null | string;
    vdevs: VDevBase[];
}

Hierarchy-Diagram

UML class diagram of ZPool
Legend
icon for an interface in the UML class diagram interface
icon for a public property in the UML class diagram public property

Hierarchy (view full)

Properties

comment? datasets? diskIdentifier? diskType? errorCount errors? failMode? fileSystem? guid name properties scan? status statusCode statusDetail vdevs

Properties

Optional comment

comment?: string

Optional datasets

datasets?: Dataset[]

Optional diskIdentifier

diskIdentifier?: DiskIdentifier

Optional diskType

diskType?: "Hybrid" | "SSD" | "HDD"

errorCount

errorCount: number

Optional errors

errors?: string[]

Optional failMode

failMode?: "wait" | "continue" | "panic"

Optional fileSystem

fileSystem?: ZFSFileSystemInfo

guid

guid: string

name

name: string

properties

properties: {
    allocated: string;
    altroot?: string;
    autoExpand: boolean;
    autoReplace: boolean;
    autoTrim: boolean;
    available: number;
    capacity: number;
    compression: boolean;
    deduplication: boolean;
    delegation?: boolean;
    forceCreate?: boolean;
    free: string;
    health?: string;
    listSnapshots?: boolean;
    rawsize: number;
    readOnly: boolean;
    record: string;
    refreservationPercent?: number;
    refreservationRawSize?: number;
    sector: string;
    size: string;
    upgradable?: boolean;
}

Type declaration

  • allocated: string
  • Optional altroot?: string
  • autoExpand: boolean
  • autoReplace: boolean
  • autoTrim: boolean
  • available: number
  • capacity: number
  • compression: boolean
  • deduplication: boolean
  • Optional delegation?: boolean
  • Optional forceCreate?: boolean
  • free: string
  • Optional health?: string
  • Optional listSnapshots?: boolean
  • rawsize: number
  • readOnly: boolean
  • record: string
  • Optional refreservationPercent?: number
  • Optional refreservationRawSize?: number
  • sector: string
  • size: string
  • Optional upgradable?: boolean

Optional scan

scan?: PoolScanObject

status

status: string

statusCode

statusCode: null | string

statusDetail

statusDetail: null | string

vdevs

vdevs: VDevBase[]

Settings

Member Visibility

Theme

On This Page

commentdatasetsdiskIdentifierdiskTypeerrorCounterrorsfailModefileSystemguidnamepropertiesscanstatusstatusCodestatusDetailvdevs