pool.update =========== Update pool of `id`, adding the new topology. .. examples(websocket):: Add a new set of raidz1 to pool of id 1. :::javascript { "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "pool.update", "params": [1, { "topology": { "data": [ {"type": "RAIDZ1", "disks": ["da7", "da8", "da9"]} ] } }] } .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer
Parameter 2: data

data

Type: object
No Additional Properties

Dedup Table Quota

Type: enum (of null or string)
Must be one of:
  • "AUTO"
  • "CUSTOM"
  • null

Dedup Table Quota Value


Type: integer

Value must be strictly greater than 0

Type: null

PoolUpdateTopology

Type: object

Cannot change type of existing vdevs.

 No Additional Properties

Data

Type: array
No Additional Items
Each item of this array must be:

PoolCreateTopologyDataVdevDRAID

Type: object
No Additional Properties

Type

Type: enum (of string)
Must be one of:
  • "DRAID1"
  • "DRAID2"
  • "DRAID3"

Disks

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Draid Data Disks

Default: null

Defaults to zfs.VDEV_DRAID_MAX_CHILDREN.

Type: integer
Type: null

Draid Spare Disks

Type: integer Default: 0

PoolCreateTopologyDataVdevNonDRAID

Type: object
No Additional Properties

Type

Type: enum (of string)
Must be one of:
  • "RAIDZ1"
  • "RAIDZ2"
  • "RAIDZ3"
  • "MIRROR"
  • "STRIPE"

Disks

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Special

Type: array of object
No Additional Items
Each item of this array must be:

PoolCreateTopologySpecialVdev

Type: object
No Additional Properties

Type

Type: enum (of string)
Must be one of:
  • "MIRROR"
  • "STRIPE"

Disks

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Dedup

Type: array of object
No Additional Items
Each item of this array must be:

PoolCreateTopologyDedupVdev

Type: object
No Additional Properties

Type

Type: enum (of string)
Must be one of:
  • "MIRROR"
  • "STRIPE"

Disks

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Cache

Type: array of object
No Additional Items
Each item of this array must be:

PoolCreateTopologyCacheVdev

Type: object
No Additional Properties

Type

Type: const
Must be one of:
  • "STRIPE"
Specific value: "STRIPE"

Disks

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Log

Type: array of object
No Additional Items
Each item of this array must be:

PoolCreateTopologyLogVdev

Type: object
No Additional Properties

Type

Type: enum (of string)
Must be one of:
  • "MIRROR"
  • "STRIPE"

Disks

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Spares

Type: array of string
No Additional Items
Each item of this array must be:
Type: string

Allow Duplicate Serials

Type: boolean

Autotrim

Type: enum (of string)
Must be one of:
  • "ON"
  • "OFF"

PoolEntry

Type: object
No Additional Properties

Id

Type: integer

Name

Type: string

Guid

Type: string

Status

Type: string

Path

Type: string

Scan


Type: object

Example:

{
        "bytes_issued": null,
        "bytes_processed": null,
        "bytes_to_process": null,
        "end_time": null,
        "errors": null,
        "function": null,
        "pause": null,
        "percentage": null,
        "start_time": null,
        "state": null,
        "total_secs_left": null
    }
Type: null

Expand


Type: object

Example:

{
        "bytes_reflowed": 978944,
        "bytes_to_reflow": 835584,
        "end_time": null,
        "expanding_vdev": 0,
        "percentage": 85.35564853556485,
        "start_time": null,
        "state": "FINISHED",
        "total_secs_left": null,
        "waiting_for_resilver": 0
    }
Type: null

Is Upgraded

Type: boolean Default: false

Healthy

Type: boolean

Warning

Type: boolean

Status Code


Type: string
Type: null

Status Detail


Type: string
Type: null

Size


Type: integer
Type: null

Allocated


Type: integer
Type: null

Free


Type: integer
Type: null

Freeing


Type: integer
Type: null

Dedup Table Size


Type: integer
Type: null

Dedup Table Quota


Type: string
Type: null

Fragmentation


Type: string
Type: null

Size Str


Type: string
Type: null

Allocated Str


Type: string
Type: null

Free Str


Type: string
Type: null

Freeing Str


Type: string
Type: null

Autotrim

Type: object

Example:

{
        "parsed": "off",
        "rawvalue": "off",
        "source": "DEFAULT",
        "value": "off"
    }


PoolTopology

Type: object
No Additional Properties

Data

Type: array
No Additional Items
Each item of this array must be:
Type: object

Log

Type: array
No Additional Items
Each item of this array must be:
Type: object

Cache

Type: array
No Additional Items
Each item of this array must be:
Type: object

Spare

Type: array
No Additional Items
Each item of this array must be:
Type: object

Special

Type: array
No Additional Items
Each item of this array must be:
Type: object

Dedup

Type: array
No Additional Items
Each item of this array must be:
Type: object
Type: null


*Required roles:* POOL_WRITE