pool.dataset.create =================== Creates a dataset/zvol. .. examples(websocket):: Create a dataset within tank pool. :::javascript { "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "pool.dataset.create, "params": [{ "name": "tank/myuser", "comments": "Dataset for myuser" }] } .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data


PoolDatasetCreateFilesystem

Type: object
No Additional Properties

Name

Type: string

Must be at least 1 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"

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

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

Quota Critical

Default: "INHERIT"

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

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

Refquota Warning

Default: "INHERIT"

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

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

Refquota Critical

Default: "INHERIT"

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

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

Reservation

Type: integer

Refreservation

Type: integer

Special Small Block Size


Type: integer
Type: const
Must be one of:
  • "INHERIT"
Specific value: "INHERIT"

Copies

Default: "INHERIT"

Type: integer
Type: const
Must be one of:
  • "INHERIT"
Specific value: "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"

Share Type

Type: enum (of string) Default: "GENERIC"
Must be one of:
  • "GENERIC"
  • "MULTIPROTOCOL"
  • "NFS"
  • "SMB"
  • "APPS"

PoolCreateEncryptionOptions

Type: object

Configuration for encryption of dataset for name pool.

 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

Encryption

Type: boolean Default: false

Create 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: true

User Properties

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

PoolDatasetCreateUserProperty

Type: object
No Additional Properties

Key

Type: string
Must match regular expression: .*:.*

Value

Type: string

Create Ancestors

Type: boolean Default: false

Type

Type: const Default: "FILESYSTEM"
Must be one of:
  • "FILESYSTEM"
Specific value: "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


Type: integer

Value must be greater or equal to 1073741824

Type: enum (of integer or null)
Must be one of:
  • 0
  • null

Refquota


Type: integer

Value must be greater or equal to 1073741824

Type: enum (of integer or null)
Must be one of:
  • 0
  • null

Recordsize

Type: string

PoolDatasetCreateVolume

Type: object
No Additional Properties

Name

Type: string

Must be at least 1 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"

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

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

Quota Critical

Default: "INHERIT"

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

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

Refquota Warning

Default: "INHERIT"

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

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

Refquota Critical

Default: "INHERIT"

Type: integer

Value must be greater or equal to 0 and lesser or equal to 100

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

Reservation

Type: integer

Refreservation

Type: integer

Special Small Block Size


Type: integer
Type: const
Must be one of:
  • "INHERIT"
Specific value: "INHERIT"

Copies

Default: "INHERIT"

Type: integer
Type: const
Must be one of:
  • "INHERIT"
Specific value: "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"

Share Type

Type: enum (of string) Default: "GENERIC"
Must be one of:
  • "GENERIC"
  • "MULTIPROTOCOL"
  • "NFS"
  • "SMB"
  • "APPS"

PoolCreateEncryptionOptions

Type: object

Configuration for encryption of dataset for name pool.

 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

Encryption

Type: boolean Default: false

Create 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: true

User Properties

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

PoolDatasetCreateUserProperty

Type: object
No Additional Properties

Key

Type: string
Must match regular expression: .*:.*

Value

Type: string

Create Ancestors

Type: boolean Default: false

Type

Type: const Default: "VOLUME"
Must be one of:
  • "VOLUME"
Specific value: "VOLUME"

Force Size

Type: boolean

Sparse

Type: boolean

Volsize

Type: integer

The 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: object
No Additional Properties

Id

Type: string

Type

Type: string

Name

Type: string

Pool

Type: string

Encrypted

Type: boolean

Encryption Root


Type: string
Type: null

Key Loaded


Type: boolean
Type: null

Children

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

User Properties

Type: object

Locked

Type: boolean

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue


Type: string
Type: null

Value


Type: string
Type: null

Source


Type: string
Type: null

Source Info

Type: object

Mountpoint


Type: string
Type: null


*Required roles:* DATASET_WRITE