Skip to main content

MigrationContainers

parityInitializedbooleanrequired

Whether the migration is past its point of no return. No stack is created or started before.

templates object[]required
  • Array [
  • namestringrequired

    The template's <Name>.

    filestringrequired

    The template's file name, which createMigrationStacks and getMigrationTemplate take.

    classMigrationTemplateClassrequired

    What a dockerMan template stands for in the Phase A capture: autostart (on Unraid's autostart list), running, stopped, template_only (a template with no container), or unknown for every template when the capture has no usable container list.

    Possible values: [autostart, running, stopped, template_only, unknown]

    statusMigrationTemplateStatusrequired

    How a conversion reads. clean means no warning of class untranslated_flag, untranslated_field, flagged_path, missing_network or conflict. warnings has at least one. failed is a template the converter could not read. previewed is a Compose Manager project's compose.yaml, which is never converted. missing is a project whose compose.yaml is not in the source.

    Possible values: [clean, warnings, failed, previewed, missing]

    warningCountintegerrequired

    The warnings that make a conversion not clean.

    errorstring

    Why the converter could not read the template. Present only when status is failed.

    stackstring

    The name its stack would have. Absent when the template's name cannot make a stack name.

    autostartPositioninteger

    The 1-based place on Unraid's autostart list. Absent off the list.

    autostartWaitSecondsinteger

    The seconds Unraid's autostart list waits after starting it, as a suggestion. Absent when it gives none.

    creatablebooleanrequired

    False for a template the converter could not read.

    preselectedbooleanrequired

    True for a creatable template on Unraid's autostart list whose stack does not exist yet, and for nothing else.

    createdbooleanrequired

    Whether its stack was created from this migration.

  • ]
  • composeProjects object[]required
  • Array [
  • namestringrequired

    The project's name, which createMigrationStacks and getMigrationTemplate take.

    containersstring[]required

    The containers the capture shows the project running.

    statusMigrationTemplateStatusrequired

    How a conversion reads. clean means no warning of class untranslated_flag, untranslated_field, flagged_path, missing_network or conflict. warnings has at least one. failed is a template the converter could not read. previewed is a Compose Manager project's compose.yaml, which is never converted. missing is a project whose compose.yaml is not in the source.

    Possible values: [clean, warnings, failed, previewed, missing]

    errorstring

    Why the project's compose.yaml could not be read. Present only when status is failed.

    stackstring

    The name its stack would have. Absent when the project's name cannot make a stack name.

    creatablebooleanrequired

    False for a project whose compose.yaml is missing from the source or could not be read.

    createdbooleanrequired
  • ]
  • byHand object[]required

    Containers created by hand. No template describes them, so nothing is generated for them: they are recreated by hand.

  • Array [
  • namestringrequired
    imagestring

    The image the container was created from. Absent when the capture does not say.

  • ]
  • stacks object[]required

    The stacks created from the scan, in the order they are offered for starting.

  • Array [
  • namestringrequired

    The stack's name, which the start, check and confirm operations take.

    sourcestringrequired

    The template file or Compose Manager project it was created from.

    kindstringrequired

    Possible values: [template, compose_project]

    statestringrequired

    created is a stack that was not started by the migration, started one whose start was queued and that is not confirmed, confirmed one the user confirmed sees its data.

    Possible values: [created, started, confirmed]

    autostartPositioninteger

    The 1-based place on Unraid's autostart list. Absent off the list.

    waitSecondsinteger

    The seconds Unraid's autostart list waited after starting it, as a suggestion for the wait before the next. Absent when it gives none.

    awaitingbooleanrequired

    True for a started stack that is neither confirmed nor known to be stopped; also true when that cannot be read. Another stack is not started while one is.

    checkedbooleanrequired

    Whether a data check has run since the latest start.

    checkFailedbooleanrequired

    Whether that check found a path that is missing, empty or unreadable.

  • ]
  • awaitingstring

    The stack to confirm or stop before another is started. Absent when none.

    nextstring

    The stack to start now. Absent when one awaits confirmation or all are confirmed.

    MigrationContainers
    {
    "parityInitialized": true,
    "templates": [
    {
    "name": "string",
    "file": "string",
    "class": "autostart",
    "status": "clean",
    "warningCount": 0,
    "error": "string",
    "stack": "string",
    "autostartPosition": 0,
    "autostartWaitSeconds": 0,
    "creatable": true,
    "preselected": true,
    "created": true
    }
    ],
    "composeProjects": [
    {
    "name": "string",
    "containers": [
    "string"
    ],
    "status": "clean",
    "error": "string",
    "stack": "string",
    "creatable": true,
    "created": true
    }
    ],
    "byHand": [
    {
    "name": "string",
    "image": "string"
    }
    ],
    "stacks": [
    {
    "name": "string",
    "source": "string",
    "kind": "template",
    "state": "created",
    "autostartPosition": 0,
    "waitSeconds": 0,
    "awaiting": true,
    "checked": true,
    "checkFailed": true
    }
    ],
    "awaiting": "string",
    "next": "string"
    }