Skip to main content

DiskUpgradePlan

mountpointstringrequired
roleArrayDiskRolerequired

A role the array-setup wizard assigns. Ignore is omitted — those disks never appear in the plan.

Possible values: [parity, data, cache]

previousDevicestringrequired

The device on record for this slot before the upgrade.

replacementDevicestringrequired
modelstring

The replacement disk's own model, for the operator to recognise it by.

wwnstring
serialstring
sizeBytesinteger<int64>
currentFilesystemstring

The replacement's filesystem before this operation, if any, cached from udev.

filesystemArrayDiskFilesystemrequired

Filesystem to format with, or to verify when adopt is true. Parity is always xfs.

Possible values: [xfs, ext4, btrfs]

newMountpointstring

Parity upgrades only: the fresh /mnt/parityN slot the new disk will be formatted, mounted and verified at independently of the old one, submitted back unchanged to upgradeDisk.

stepsstring[]required

The copy/verify/remount steps (data) or copy/verify/switch/check steps (parity) this plan's own apply call runs, in order.

confirmationstringrequired

Exact typed confirmation upgradeDisk requires for this plan: ERASE <replacementDevice>.

DiskUpgradePlan
{
  "mountpoint": "string",
  "role": "parity",
  "previousDevice": "string",
  "replacementDevice": "string",
  "model": "string",
  "wwn": "string",
  "serial": "string",
  "sizeBytes": 0,
  "currentFilesystem": "string",
  "filesystem": "xfs",
  "newMountpoint": "string",
  "steps": [
    "string"
  ],
  "confirmation": "string"
}