Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

Parameter 2: data

data

Type: object
No Additional Properties

Comments

Type: string

Sync

Type: enum (of string)

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)

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)

Must be one of:

"ON"
"OFF"
"INHERIT"

Managedby

Type: string

Must be at least 1 characters long

Quota Warning

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

Any of

Option 1
Option 2

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

Any of

Option 1
Option 2

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

Any of

Option 1
Option 2

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

Any of

Option 1
Option 2

Type: integer

Type: const

Must be one of:

"INHERIT"

Specific value: "INHERIT"

Copies

Any of

Option 1
Option 2

Type: integer

Type: const

Must be one of:

"INHERIT"

Specific value: "INHERIT"

Snapdir

Type: enum (of string)

Must be one of:

"DISABLED"
"VISIBLE"
"HIDDEN"
"INHERIT"

Deduplication

Type: enum (of string)

Must be one of:

"ON"
"VERIFY"
"OFF"
"INHERIT"

Checksum

Type: enum (of string)

Must be one of:

"ON"
"OFF"
"FLETCHER2"
"FLETCHER4"
"SHA256"
"SHA512"
"SKEIN"
"EDONR"
"BLAKE3"
"INHERIT"

Readonly

Type: enum (of string)

Must be one of:

"ON"
"OFF"
"INHERIT"

User Properties

Type: array of object
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

Force Size

Type: boolean

Volsize

Type: integer

The volume size in bytes; supposed to be a multiple of the block size.

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"

Quota

Any of

Option 1
Option 2

Type: integer

Value must be greater or equal to 1073741824

Type: enum (of integer or null)

Must be one of:

0
null

Refquota

Any of

Option 1
Option 2

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

User Properties Update

Type: array of object
No Additional Items

Each item of this array must be:

PoolDatasetUpdateUserProperty

Type: object
No Additional Properties

Key

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

Value

Type: string

Remove

Type: boolean

PoolDatasetEntry

Type: object
No Additional Properties

Id

Type: string

Type

Type: string

Name

Type: string

Pool

Type: string

Encrypted

Type: boolean

Encryption Root

Any of

Option 1
Option 2

Type: string

Type: null

Key Loaded

Any of

Option 1
Option 2

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

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

PoolDatasetEntryProperty

Type: object
No Additional Properties

Parsed

Type: object

Rawvalue

Any of

Option 1
Option 2

Type: string

Type: null

Value

Any of

Option 1
Option 2

Type: string

Type: null

Source

Any of

Option 1
Option 2

Type: string

Type: null

Source Info

Type: object

Mountpoint

Any of

Option 1
Option 2

Type: string

Type: null

Call parameters

Tuple Validation

Parameter 1: id

id

Parameter 2: data

data

comments

Comments

sync

Sync

Must be one of:

snapdev

Snapdev

Must be one of:

compression

Compression

Must be one of:

exec

Exec

Must be one of:

managedby

Managedby

quota_warning

Quota Warning

Any of

Must be one of:

quota_critical

Quota Critical

Any of

Must be one of:

refquota_warning

Refquota Warning

Any of

Must be one of:

refquota_critical

Refquota Critical

Any of

Must be one of:

reservation

Reservation

refreservation

Refreservation

special_small_block_size

Special Small Block Size

Any of

Must be one of:

copies

Copies

Any of

Must be one of:

snapdir

Snapdir

Must be one of:

deduplication

Deduplication

Must be one of:

checksum

Checksum

Must be one of:

readonly

Readonly

Must be one of:

user_properties

User Properties

Each item of this array must be:

PoolDatasetCreateUserProperty

key Required

Key

value Required

Value

create_ancestors

Create Ancestors

force_size

Force Size

volsize

Volsize

aclmode

Aclmode

Must be one of:

acltype