pool.dataset.update

Updates a dataset/zvol id.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

Parameter 2: data

data

Type: object
No Additional Properties

comments

Comments

Type: string

sync

Sync

Type: enum (of string)

Must be one of:

• "STANDARD"
• "ALWAYS"
• "DISABLED"
• "INHERIT"

snapdev

Snapdev

Type: enum (of string)

Must be one of:

• "HIDDEN"
• "VISIBLE"
• "INHERIT"

compression

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

Exec

Type: enum (of string)

Must be one of:

• "ON"
• "OFF"
• "INHERIT"

managedby

Managedby

Type: string

Must be at least 1 characters long

quota_warning

Quota 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"

quota_critical

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

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

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

Reservation

Type: integer

refreservation

Refreservation

Type: integer

special_small_block_size

Special Small Block Size

Any of

• Option 1
• Option 2

Type: integer

Type: const

Must be one of:

• "INHERIT"

Specific value: "INHERIT"

copies

Copies

Any of

• Option 1
• Option 2

Type: integer

Type: const

Must be one of:

• "INHERIT"

Specific value: "INHERIT"

snapdir

Snapdir

Type: enum (of string)

Must be one of:

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

deduplication

Deduplication

Type: enum (of string)

Must be one of:

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

checksum

Checksum

Type: enum (of string)

Must be one of:

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

readonly

Readonly

Type: enum (of string)

Must be one of:

• "ON"
• "OFF"
• "INHERIT"

user_properties

User Properties

Type: array of object
No Additional Items

Each item of this array must be:

PoolDatasetCreateUserProperty

Type: object
No Additional Properties

key Required

Key

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

value Required

Value

Type: string

create_ancestors

Create Ancestors

Type: boolean

force_size

Force Size

Type: boolean

volsize

Volsize

Type: integer

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

aclmode

Aclmode

Type: enum (of string)

Must be one of:

• "PASSTHROUGH"
• "RESTRICTED"
• "DISCARD"
• "INHERIT"

acltype

Acltype

Type: enum (of string)

Must be one of:

• "OFF"
• "NFSV4"
• "POSIX"
• "INHERIT"

atime

Atime

Type: enum (of string)

Must be one of:

• "ON"
• "OFF"
• "INHERIT"

quota

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

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

Recordsize

Type: string

user_properties_update

User Properties Update

Type: array of object
No Additional Items

Each item of this array must be:

PoolDatasetUpdateUserProperty

Type: object
No Additional Properties

key Required

Key

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

value

Value

Type: string

remove

Remove

Type: boolean

Return value

PoolDatasetEntry

Type: object
No Additional Properties

id

Id

Type: string

type

Type

Type: string

name

Name

Type: string

pool

Pool

Type: string

encrypted

Encrypted

Type: boolean

encryption_root

Encryption Root

Any of

• Option 1
• Option 2

Type: string

Type: null

key_loaded

Key Loaded

Any of

• Option 1
• Option 2

Type: boolean

Type: null

children

Children

Type: array
No Additional Items

Each item of this array must be:

Type: object

user_properties

User Properties

Type: object

locked

Locked

Type: boolean

comments

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

quota_warning

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

quota_critical

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

refquota_warning

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

refquota_critical

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

managedby

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

deduplication

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

aclmode

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

acltype

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

xattr

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

atime

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

casesensitivity

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

checksum

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

exec

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

sync

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

compression

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

compressratio

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

origin

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

quota

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

refquota

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

reservation

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

refreservation

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

copies

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

snapdir

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

readonly

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

recordsize

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

sparse

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

volsize

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

volblocksize

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

key_format

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

encryption_algorithm

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

used

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

usedbychildren

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

usedbydataset

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

usedbyrefreservation

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

usedbysnapshots

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

available

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

special_small_block_size

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

pbkdf2iters

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

creation

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

snapdev

PoolDatasetEntryProperty

Type: object
No Additional Properties

parsed

Parsed

Type: object

rawvalue

Rawvalue

Any of

• Option 1
• Option 2

Type: string

Type: null

value

Value

Any of

• Option 1
• Option 2

Type: string

Type: null

source

Source

Any of

• Option 1
• Option 2

Type: string

Type: null

source_info

Source Info

Type: object

mountpoint

Mountpoint

Any of

• Option 1
• Option 2

Type: string

Type: null

Required roles: DATASET_WRITE