Skip to main content

CreateArrayRequest

disks object[]required

Possible values: >= 1

  • Array [
  • devicestringrequired
    roleArrayDiskRolerequired

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

    Possible values: [parity, data, cache]

    filesystemArrayDiskFilesystem

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

    Possible values: [xfs, ext4, btrfs]

    adoptboolean

    Keep the existing filesystem instead of formatting (data and cache only; not allowed on parity).

    Default value: false
  • ]
  • createPolicyArrayCreatePolicy

    Default mergerfs create policy for new shares.

    Possible values: [mspmfs, mfs, lfs, ff]

    minFreeSpacestring

    mergerfs minfreespace in its size-suffix syntax, e.g. 50G. Omitted uses the engine default.

    confirmationstringrequired

    Exact typed confirmation for this plan: ERASE /dev/sda, /dev/sdb listing every device that will be formatted, sorted, or ADOPT ONLY — NOTHING ERASED when every assigned disk is adopted. A wrong or missing string is refused and formats nothing.

    CreateArrayRequest
    {
    "disks": [
    {
    "device": "string",
    "role": "parity",
    "filesystem": "xfs",
    "adopt": false
    }
    ],
    "createPolicy": "mspmfs",
    "minFreeSpace": "string",
    "confirmation": "string"
    }