pool.replace

Replace a disk on a pool.

Replace missing ZFS device with disk {serial}FOO:

{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "pool.replace",
    "params": [1, {
        "label": "80802394992848654",
        "disk": "{serial}FOO"
    }]
}

This method is a job.

Type: object

Call parameters

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 Required

Label

Type: string

GUID or device name of the disk to replace.

disk Required

Disk

Type: string

Name of the new disk to use as replacement.

force

Force

Type: boolean Default: false

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

preserve_settings

Preserve Settings

Type: boolean Default: true

Whether to preserve disk settings from the replaced disk.

preserve_description

Preserve Description

Type: boolean Default: true

Whether to preserve the description from the replaced disk.

Return value

Result

Type: const

Indicates successful disk replacement initiation.

Specific value: true

Required roles: POOL_WRITE