Skip to main content

MigrationContainerTemplate

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.

MigrationContainerTemplate
{
"name": "string",
"file": "string",
"class": "autostart",
"status": "clean",
"warningCount": 0,
"error": "string",
"stack": "string",
"autostartPosition": 0,
"autostartWaitSeconds": 0,
"creatable": true,
"preselected": true,
"created": true
}