pool.replace

Replace a disk on a pool.

label is the ZFS guid or a device name disk is the identifier of a disk If preserve_settings is true, then settings (power management, S.M.A.R.T., etc.) of a disk being replaced will be applied to a new disk.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the pool to replace a disk in.
Parameter 2: options

options

Type: object

Configuration for the disk replacement operation.

 No Additional Properties

Label

Type: string

GUID or device name of the disk to replace.

Disk

Type: string

Name of the new disk to use as replacement.

Force

Type: boolean Default: false

Force the replacement even if the new disk appears to be in use.

Preserve Settings

Type: boolean Default: true

Whether to preserve disk settings from the replaced disk.

Preserve Description

Type: boolean Default: true

Whether to preserve the description from the replaced disk.

Result

Type: const

Indicates successful disk replacement initiation.

Must be one of:
  • true
Specific value: true


Required roles: POOL_WRITE