pool.dataset.create¶
Creates a dataset/zvol.
No Additional Items
Tuple Validation
Parameter 1: data
data
PoolDatasetCreateFilesystem
Type: objectNo Additional Properties
Name
Type: stringMust be at most 200
characters long
Comments
Type: string Default: "INHERIT"Sync
Type: enum (of string) Default: "INHERIT"Must be one of:
- "STANDARD"
- "ALWAYS"
- "DISABLED"
- "INHERIT"
Snapdev
Type: enum (of string)Must be one of:
- "HIDDEN"
- "VISIBLE"
- "INHERIT"
Compression
Type: enum (of string) Default: "INHERIT"Must be one of:
- "ON"
- "OFF"
- "LZ4"
- "GZIP"
- "GZIP-1"
- "GZIP-9"
- "ZSTD"
- "ZSTD-FAST"
- "ZLE"
- "LZJB"
- "ZSTD-1"
- "ZSTD-2"
- "ZSTD-3"
- "ZSTD-4"
- "ZSTD-5"
- "ZSTD-6"
- "ZSTD-7"
- "ZSTD-8"
- "ZSTD-9"
- "ZSTD-10"
- "ZSTD-11"
- "ZSTD-12"
- "ZSTD-13"
- "ZSTD-14"
- "ZSTD-15"
- "ZSTD-16"
- "ZSTD-17"
- "ZSTD-18"
- "ZSTD-19"
- "ZSTD-FAST-1"
- "ZSTD-FAST-2"
- "ZSTD-FAST-3"
- "ZSTD-FAST-4"
- "ZSTD-FAST-5"
- "ZSTD-FAST-6"
- "ZSTD-FAST-7"
- "ZSTD-FAST-8"
- "ZSTD-FAST-9"
- "ZSTD-FAST-10"
- "ZSTD-FAST-20"
- "ZSTD-FAST-30"
- "ZSTD-FAST-40"
- "ZSTD-FAST-50"
- "ZSTD-FAST-60"
- "ZSTD-FAST-70"
- "ZSTD-FAST-80"
- "ZSTD-FAST-90"
- "ZSTD-FAST-100"
- "ZSTD-FAST-500"
- "ZSTD-FAST-1000"
- "INHERIT"
Exec
Type: enum (of string) Default: "INHERIT"Must be one of:
- "ON"
- "OFF"
- "INHERIT"
Managedby
Type: string Default: "INHERIT"Must be at least 1
characters long
Quota Warning
Default: "INHERIT"Value must be greater or equal to 0
and lesser or equal to 100
Must be one of:
- "INHERIT"
"INHERIT"
Quota Critical
Default: "INHERIT"Value must be greater or equal to 0
and lesser or equal to 100
Must be one of:
- "INHERIT"
"INHERIT"
Refquota Warning
Default: "INHERIT"Value must be greater or equal to 0
and lesser or equal to 100
Must be one of:
- "INHERIT"
"INHERIT"
Refquota Critical
Default: "INHERIT"Value must be greater or equal to 0
and lesser or equal to 100
Must be one of:
- "INHERIT"
"INHERIT"
Reservation
Type: integerRefreservation
Type: integerSpecial Small Block Size
Must be one of:
- "INHERIT"
"INHERIT"
Copies
Default: "INHERIT"Must be one of:
- "INHERIT"
"INHERIT"
Snapdir
Type: enum (of string) Default: "INHERIT"Must be one of:
- "DISABLED"
- "VISIBLE"
- "HIDDEN"
- "INHERIT"
Deduplication
Type: enum (of string) Default: "INHERIT"Must be one of:
- "ON"
- "VERIFY"
- "OFF"
- "INHERIT"
Checksum
Type: enum (of string) Default: "INHERIT"Must be one of:
- "ON"
- "OFF"
- "FLETCHER2"
- "FLETCHER4"
- "SHA256"
- "SHA512"
- "SKEIN"
- "EDONR"
- "BLAKE3"
- "INHERIT"
Readonly
Type: enum (of string) Default: "INHERIT"Must be one of:
- "ON"
- "OFF"
- "INHERIT"
PoolCreateEncryptionOptions
Type: objectConfiguration for encryption of dataset for name
pool.
Generate 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
Encryption
Type: boolean Default: falseCreate a ZFS encrypted root dataset for name
pool.
There is 1 case where ZFS encryption is not allowed for a dataset:
1) If the parent dataset is encrypted with a passphrase and name
is being created with a key for encrypting the
dataset.
Inherit Encryption
Type: boolean Default: trueUser Properties
Type: array of object Default: []No Additional Items
Each item of this array must be:
PoolDatasetCreateUserProperty
Type: objectNo Additional Properties
Key
Type: stringMust match regular expression:
.*:.*
Value
Type: stringCreate Ancestors
Type: boolean Default: falseType
Type: const Default: "FILESYSTEM"Must be one of:
- "FILESYSTEM"
"FILESYSTEM"
Aclmode
Type: enum (of string)Must be one of:
- "PASSTHROUGH"
- "RESTRICTED"
- "DISCARD"
- "INHERIT"
Acltype
Type: enum (of string)Must be one of:
- "OFF"
- "NFSV4"
- "POSIX"
- "INHERIT"
Atime
Type: enum (of string)Must be one of:
- "ON"
- "OFF"
- "INHERIT"
Casesensitivity
Type: enum (of string)Must be one of:
- "SENSITIVE"
- "INSENSITIVE"
- "INHERIT"
Quota
Value must be greater or equal to 1073741824
Must be one of:
- 0
- null
Refquota
Value must be greater or equal to 1073741824
Must be one of:
- 0
- null
Recordsize
Type: stringPoolDatasetCreateVolume
Type: objectNo Additional Properties
Name
Type: stringMust be at most 200
characters long
Comments
Type: string Default: "INHERIT"Sync
Type: enum (of string) Default: "INHERIT"Must be one of:
- "STANDARD"
- "ALWAYS"
- "DISABLED"
- "INHERIT"
Snapdev
Type: enum (of string)Must be one of:
- "HIDDEN"
- "VISIBLE"
- "INHERIT"
Compression
Type: enum (of string) Default: "INHERIT"Must be one of:
- "ON"
- "OFF"
- "LZ4"
- "GZIP"
- "GZIP-1"
- "GZIP-9"
- "ZSTD"
- "ZSTD-FAST"
- "ZLE"
- "LZJB"
- "ZSTD-1"
- "ZSTD-2"
- "ZSTD-3"
- "ZSTD-4"
- "ZSTD-5"
- "ZSTD-6"
- "ZSTD-7"
- "ZSTD-8"
- "ZSTD-9"
- "ZSTD-10"
- "ZSTD-11"
- "ZSTD-12"
- "ZSTD-13"
- "ZSTD-14"
- "ZSTD-15"
- "ZSTD-16"
- "ZSTD-17"
- "ZSTD-18"
- "ZSTD-19"
- "ZSTD-FAST-1"
- "ZSTD-FAST-2"
- "ZSTD-FAST-3"
- "ZSTD-FAST-4"
- "ZSTD-FAST-5"
- "ZSTD-FAST-6"
- "ZSTD-FAST-7"
- "ZSTD-FAST-8"
- "ZSTD-FAST-9"
- "ZSTD-FAST-10"
- "ZSTD-FAST-20"
- "ZSTD-FAST-30"
- "ZSTD-FAST-40"
- "ZSTD-FAST-50"
- "ZSTD-FAST-60"
- "ZSTD-FAST-70"
- "ZSTD-FAST-80"
- "ZSTD-FAST-90"
- "ZSTD-FAST-100"
- "ZSTD-FAST-500"
- "ZSTD-FAST-1000"
- "INHERIT"
Exec
Type: enum (of string) Default: "INHERIT"Must be one of:
- "ON"
- "OFF"
- "INHERIT"
Managedby
Type: string Default: "INHERIT"Must be at least 1
characters long
Quota Warning
Default: "INHERIT"Value must be greater or equal to 0
and lesser or equal to 100
Must be one of:
- "INHERIT"
"INHERIT"
Quota Critical
Default: "INHERIT"Value must be greater or equal to 0
and lesser or equal to 100
Must be one of:
- "INHERIT"
"INHERIT"
Refquota Warning
Default: "INHERIT"Value must be greater or equal to 0
and lesser or equal to 100
Must be one of:
- "INHERIT"
"INHERIT"
Refquota Critical
Default: "INHERIT"Value must be greater or equal to 0
and lesser or equal to 100
Must be one of:
- "INHERIT"
"INHERIT"
Reservation
Type: integerRefreservation
Type: integerSpecial Small Block Size
Must be one of:
- "INHERIT"
"INHERIT"
Copies
Default: "INHERIT"Must be one of:
- "INHERIT"
"INHERIT"
Snapdir
Type: enum (of string) Default: "INHERIT"Must be one of:
- "DISABLED"
- "VISIBLE"
- "HIDDEN"
- "INHERIT"
Deduplication
Type: enum (of string) Default: "INHERIT"Must be one of:
- "ON"
- "VERIFY"
- "OFF"
- "INHERIT"
Checksum
Type: enum (of string) Default: "INHERIT"Must be one of:
- "ON"
- "OFF"
- "FLETCHER2"
- "FLETCHER4"
- "SHA256"
- "SHA512"
- "SKEIN"
- "EDONR"
- "BLAKE3"
- "INHERIT"
Readonly
Type: enum (of string) Default: "INHERIT"Must be one of:
- "ON"
- "OFF"
- "INHERIT"
PoolCreateEncryptionOptions
Type: objectConfiguration for encryption of dataset for name
pool.
Generate 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
Encryption
Type: boolean Default: falseCreate a ZFS encrypted root dataset for name
pool.
There is 1 case where ZFS encryption is not allowed for a dataset:
1) If the parent dataset is encrypted with a passphrase and name
is being created with a key for encrypting the
dataset.
Inherit Encryption
Type: boolean Default: trueUser Properties
Type: array of object Default: []No Additional Items
Each item of this array must be:
PoolDatasetCreateUserProperty
Type: objectNo Additional Properties
Key
Type: stringMust match regular expression:
.*:.*
Value
Type: stringCreate Ancestors
Type: boolean Default: falseType
Type: const Default: "VOLUME"Must be one of:
- "VOLUME"
"VOLUME"
Force Size
Type: booleanSparse
Type: booleanVolsize
Type: integerThe volume size in bytes; supposed to be a multiple of the block size.
Volblocksize
Type: enum (of string)Defaults to 128K
if the parent pool is a DRAID pool or 16K
otherwise.
Must be one of:
- "512"
- "512B"
- "1K"
- "2K"
- "4K"
- "8K"
- "16K"
- "32K"
- "64K"
- "128K"
PoolDatasetEntry
Type: objectNo Additional Properties
Id
Type: stringType
Type: stringName
Type: stringPool
Type: stringEncrypted
Type: booleanEncryption Root
Key Loaded
Children
Type: arrayNo Additional Items
Each item of this array must be:
User Properties
Type: objectLocked
Type: booleanPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectPoolDatasetEntryProperty
Type: objectNo Additional Properties
Parsed
Type: objectRawvalue
Value
Source
Source Info
Type: objectMountpoint
Required roles: DATASET_WRITE