Skip to main content

ShareRelocationPrecheck

dockerAvailablebooleanrequired

False when Docker is not reachable; containers is then empty because there is nothing to list, not because none uses the share.

containers object[]required
  • Array [
  • idstringrequired
    namestringrequired
    stateAppStaterequired

    The Docker Engine's own container state vocabulary.

    Possible values: [created, running, paused, restarting, removing, exited, dead]

    activebooleanrequired

    True for a running, paused or restarting container. Stopping it (stopApp) is what clears it for a relocation.

    mountsstring[]required

    The host paths of this container's mounts that use the share.

  • ]
  • openPathsstring[]required

    Every file, relative to the share root, that some process holds open on the cache or on an array branch. A file a client or container reaches through the pool shows as held open by mergerfs itself, so a name is never attributed to it.

    ShareRelocationPrecheck
    {
    "dockerAvailable": true,
    "containers": [
    {
    "id": "string",
    "name": "string",
    "state": "created",
    "active": true,
    "mounts": [
    "string"
    ]
    }
    ],
    "openPaths": [
    "string"
    ]
    }