pool.dataset.change_key

Change encryption properties for id encrypted dataset.

Changing dataset encryption to use passphrase instead of a key is not allowed if:

1. It has encrypted roots as children which are encrypted with a key 2) If it is a root dataset where the system dataset is located

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

Parameter 2: options

options

Type: object
No Additional Properties

generate_key

Generate Key

Type: boolean Default: false

key_file

Key File

Type: boolean Default: false

pbkdf2iters

Pbkdf2Iters

Type: integer Default: 350000

Value must be greater or equal to 100000

passphrase

Passphrase

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 1 characters long

Type: null

key

Key

Default: null

Any of

• Option 1
• Option 2

Type: string

Must be at least 64 characters long

Must be at most 64 characters long

Type: null

Return value

Result

Type: null

Required roles: DATASET_WRITE