pool.create =========== Create a new ZFS Pool. .. examples(websocket):: Create a pool named "tank", raidz1 with 3 disks, 1 cache disk, 1 ZIL/log disk and 1 hot spare disk. :::javascript { "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "pool.create", "params": [{ "name": "tank", "topology": { "data": [ {"type": "RAIDZ1", "disks": ["da1", "da2", "da3"]} ], "cache": [ {"type": "STRIPE", "disks": ["da4"]} ], "log": [ {"type": "RAIDZ1", "disks": ["da5"]} ], "spares": ["da6"] } }] } .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object
No Additional Properties

Name

Type: string

Must be at least 1 characters long

Must be at most 50 characters long

Encryption

Type: boolean Default: false

If set, create a ZFS encrypted root dataset for this pool.

Dedup Table Quota

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

Dedup Table Quota Value

Default: null

Type: integer

Value must be strictly greater than 0

Type: null

Deduplication

Type: enum (of null or string) Default: null

Make sure no block of data is duplicated in the pool. If set to VERIFY and two blocks have similar signatures,
byte-to-byte comparison is performed to ensure that the blcoks are identical. This should be used in special
circumstances as it carries a significant overhead.

Must be one of:
  • "ON"
  • "VERIFY"
  • "OFF"
  • null

Checksum

Type: enum (of null or string) Default: null
Must be one of:
  • "ON"
  • "OFF"
  • "FLETCHER2"
  • "FLETCHER4"
  • "SHA256"
  • "SHA512"
  • "SKEIN"
  • "EDONR"
  • "BLAKE3"
  • null

PoolCreateEncryptionOptions

Type: object

Specify configuration for encryption of root dataset.

 No Additional Properties

Generate Key

Type: boolean Default: false

Automatically generate the key to be used for dataset encryption.

Pbkdf2Iters

Type: integer Default: 350000

Value must be greater or equal to 100000

Algorithm

Type: enum (of string) Default: "AES-256-GCM"
Must be one of:
  • "AES-128-CCM"
  • "AES-192-CCM"
  • "AES-256-CCM"
  • "AES-128-GCM"
  • "AES-192-GCM"
  • "AES-256-GCM"

Passphrase

Default: null

Must be specified if encryption for root dataset is desired with a passphrase as a key.

Type: string

Must be at least 8 characters long

Type: null

Key

Default: null

A hex-encoded key specified as an alternative to using passphrase.

Type: string

Must be at least 64 characters long

Must be at most 64 characters long

Type: null

PoolCreateTopology

Type: object
No Additional Properties
Example:

{
        "cache": [
            {
                "disks": [
                    "da4"
                ],
                "type": "STRIPE"
            }
        ],
        "data": [
            {
                "disks": [
                    "da1",
                    "da2",
                    "da3"
                ],
                "type": "RAIDZ1"
            }
        ],
        "log": [
            {
                "disks": [
                    "da5"
                ],
                "type": "STRIPE"
            }
        ],
        "spares": [
            "da6"
        ]
    }

Data

Type: array

All vdevs must be of the same type.

Must contain a minimum of 1 items

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 Default: []
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 Default: []
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 Default: []
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 Default: []
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 Default: []
No Additional Items
Each item of this array must be:
Type: string

Allow Duplicate Serials

Type: boolean Default: false

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