systemdataset.update

Update System Dataset Service Configuration.

Set pool to choose which pool hosts the system dataset. Changing the pool moves the system dataset and its contents to the new pool.

This method is a job.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Updated configuration for the system dataset.

No Additional Properties

pool

Pool

The name of a valid pool configured in the system to host the system dataset.

Any of

• Option 1
• Option 2

Type: string

Type: null

pool_exclude

Pool Exclude

The name of a pool to not place the system dataset on if pool is not provided.

Any of

• Option 1
• Option 2

Type: string

Type: null

Return value

SystemDatasetEntry

Type: object

The updated system dataset configuration.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the system dataset configuration.

pool Required

Pool

Type: string

Name of the pool hosting the system dataset.

pool_set Required

Pool Set

Type: boolean

Whether a pool has been explicitly set for the system dataset.

uuid Required

Uuid

Type: string

UUID of the system dataset.

basename Required

Basename

Type: string

Base name of the system dataset.

path Required

Path

Filesystem path to the system dataset. null if not mounted.

Any of

• Option 1
• Option 2

Type: string

Type: null

Required roles: DATASET_WRITE