pool.create¶
Create a new ZFS Pool.
No Additional Items
Tuple Validation
Parameter 1: data
data
Type: objectNo Additional Properties
Name
Type: stringMust be at least 1 characters long
Must be at most 50 characters long
Encryption
Type: boolean Default: falseIf 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: nullValue must be strictly greater than 0
Deduplication
Type: enum (of null or string) Default: nullMake 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: nullMust be one of:
- "ON"
- "OFF"
- "FLETCHER2"
- "FLETCHER4"
- "SHA256"
- "SHA512"
- "SKEIN"
- "EDONR"
- "BLAKE3"
- null
PoolCreateEncryptionOptions
Type: objectSpecify configuration for encryption of root dataset.
No Additional PropertiesGenerate Key
Type: boolean Default: falseAutomatically generate the key to be used for dataset encryption.
Pbkdf2Iters
Type: integer Default: 350000Value 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: nullMust be specified if encryption for root dataset is desired with a passphrase as a key.
Must be at least 8 characters long
Key
Default: nullA hex-encoded key specified as an alternative to using passphrase.
Must be at least 64 characters long
Must be at most 64 characters long
PoolCreateTopology
Type: objectNo Additional Properties
{
    "cache": [
        {
            "disks": [
                "da4"
            ],
            "type": "STRIPE"
        }
    ],
    "data": [
        {
            "disks": [
                "da1",
                "da2",
                "da3"
            ],
            "type": "RAIDZ1"
        }
    ],
    "log": [
        {
            "disks": [
                "da5"
            ],
            "type": "STRIPE"
        }
    ],
    "spares": [
        "da6"
    ]
}
Data
Type: arrayAll vdevs must be of the same type.
Must contain a minimum of 1 items
Each item of this array must be:
PoolCreateTopologyDataVdevDRAID
Type: objectNo Additional Properties
Type
Type: enum (of string)Must be one of:
- "DRAID1"
- "DRAID2"
- "DRAID3"
Disks
Type: array of stringNo Additional Items
Each item of this array must be:
Draid Data Disks
Default: nullDefaults to zfs.VDEV_DRAID_MAX_CHILDREN.
Draid Spare Disks
Type: integer Default: 0PoolCreateTopologyDataVdevNonDRAID
Type: objectNo Additional Properties
Type
Type: enum (of string)Must be one of:
- "RAIDZ1"
- "RAIDZ2"
- "RAIDZ3"
- "MIRROR"
- "STRIPE"
Disks
Type: array of stringNo Additional Items
Each item of this array must be:
Special
Type: array of object Default: []No Additional Items
Each item of this array must be:
PoolCreateTopologySpecialVdev
Type: objectNo Additional Properties
Type
Type: enum (of string)Must be one of:
- "MIRROR"
- "STRIPE"
Disks
Type: array of stringNo Additional Items
Each item of this array must be:
Dedup
Type: array of object Default: []No Additional Items
Each item of this array must be:
PoolCreateTopologyDedupVdev
Type: objectNo Additional Properties
Type
Type: enum (of string)Must be one of:
- "MIRROR"
- "STRIPE"
Disks
Type: array of stringNo Additional Items
Each item of this array must be:
Cache
Type: array of object Default: []No Additional Items
Each item of this array must be:
PoolCreateTopologyCacheVdev
Type: objectNo Additional Properties
Type
Type: constMust be one of:
- "STRIPE"
"STRIPE" Disks
Type: array of stringNo Additional Items
Each item of this array must be:
Log
Type: array of object Default: []No Additional Items
Each item of this array must be:
PoolCreateTopologyLogVdev
Type: objectNo Additional Properties
Type
Type: enum (of string)Must be one of:
- "MIRROR"
- "STRIPE"
Disks
Type: array of stringNo Additional Items
Each item of this array must be:
Spares
Type: array of string Default: []No Additional Items
Each item of this array must be:
Allow Duplicate Serials
Type: boolean Default: falsePoolEntry
Type: objectNo Additional Properties
Id
Type: integerName
Type: stringGuid
Type: stringStatus
Type: stringPath
Type: stringScan
{
    "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
}
Expand
{
    "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
}
Is Upgraded
Type: boolean Default: falseHealthy
Type: booleanWarning
Type: booleanStatus Code
Status Detail
Size
Allocated
Free
Freeing
Dedup Table Size
Dedup Table Quota
Fragmentation
Size Str
Allocated Str
Free Str
Freeing Str
Autotrim
Type: object{
    "parsed": "off",
    "rawvalue": "off",
    "source": "DEFAULT",
    "value": "off"
}
PoolTopology
Type: objectNo Additional Properties
Data
Type: arrayNo Additional Items
Each item of this array must be:
Log
Type: arrayNo Additional Items
Each item of this array must be:
Cache
Type: arrayNo Additional Items
Each item of this array must be:
Spare
Type: arrayNo Additional Items
Each item of this array must be:
Special
Type: arrayNo Additional Items
Each item of this array must be:
Dedup
Type: arrayNo Additional Items
Each item of this array must be:
Required roles: POOL_WRITE