Skip to main content

EvacuationPlan

mountpointstringrequired
moves object[]required
  • Array [
    • sharestringrequired
    relPathstringrequired

    Path relative to the share root.

    sourceBranchstringrequired

    The share-scoped branch directory the file currently lives on, e.g. /mnt/disk1/media.

    targetBranchstringrequired
    sizeBytesinteger<int64>required
  • ]
    • warnings object[]required
  • Array [
    • sharestringrequired
    reasonstringrequired
  • ]
    • nonSharePathsstring[]required

    Every top-level entry on the disk's own mountpoint that is neither a configured share's own branch there nor SnapRAID's own bookkeeping (lost+found, snapraid.content*) — content for which there is no procedure for moving it. Always empty on a plan this operation actually returns: any such content refuses the plan outright (EvacuationPlanRefusal) instead.

    confirmationstringrequired

    Exact typed confirmation evacuateDisk requires for this plan (REMOVE <mountpoint>).

    EvacuationPlan
    {
      "mountpoint": "string",
      "moves": [
        {
          "share": "string",
          "relPath": "string",
          "sourceBranch": "string",
          "targetBranch": "string",
          "sizeBytes": 0
        }
      ],
      "warnings": [
        {
          "share": "string",
          "reason": "string"
        }
      ],
      "nonSharePaths": [
        "string"
      ],
      "confirmation": "string"
    }