Skip to main content

MigrationTemplates

counts objectrequired
cleanintegerrequired

Counted templates that convert cleanly.

withWarningsintegerrequired

Counted templates that convert with at least one warning that needs manual action.

failedintegerrequired

Counted templates the converter could not read. Never part of clean.

templateOnlyintegerrequired

Templates with no container on the source server. They are converted and previewable and are in none of the counts above.

allTemplatesbooleanrequired

True when the capture has no container list, so nothing says which templates are installed and clean, withWarnings and failed cover every template.

composeProjectsintegerrequired

Compose Manager projects whose compose.yaml is previewed. Not converted and not in the counts above.

templates object[]required

Every template that parsed, by file name.

  • Array [
  • namestringrequired

    The template's <Name>, the name its container is matched on.

    filestringrequired

    The template's file name, which getMigrationTemplate takes.

    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]

    countedbooleanrequired

    Whether the template is in the report's clean and warning counts.

    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. The writable-layer warning every conversion carries and the notes are not counted; the preview lists every warning.

    errorstring

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

    autostartPositioninteger

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

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

    The project's name, which getMigrationTemplate takes.

    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.

  • ]
  • MigrationTemplates
    {
    "counts": {
    "clean": 0,
    "withWarnings": 0,
    "failed": 0,
    "templateOnly": 0,
    "allTemplates": true,
    "composeProjects": 0
    },
    "templates": [
    {
    "name": "string",
    "file": "string",
    "class": "autostart",
    "counted": true,
    "status": "clean",
    "warningCount": 0,
    "error": "string",
    "autostartPosition": 0
    }
    ],
    "composeProjects": [
    {
    "name": "string",
    "containers": [
    "string"
    ],
    "status": "clean",
    "error": "string"
    }
    ]
    }