diff --git a/docs/modules/migrate/pages/dmt-command-reference.adoc b/docs/modules/migrate/pages/dmt-command-reference.adoc new file mode 100644 index 000000000..82b8733fc --- /dev/null +++ b/docs/modules/migrate/pages/dmt-command-reference.adoc @@ -0,0 +1,92 @@ += DMT Command Reference + +The DMT commands allow you to manage your migration. + +The DMT commands have the following format: + +[source,bash] +---- +dmt [command] [flags] +---- + +== Commands + +* <> +* <> +* <> +* <> + +== dmt start + +Starts a new migration with the specified configuration. + +Usage: + +[source,bash] +---- +dmt start [dmt-config-path] [flags] +---- + +Parameters: + +[cols="1m,1a,2a,1a"] +|=== +|Parameter|Required|Description|Default + +|`--output-dir`, `-o` +|Optional +|Output directory for the migration report. +|Current working directory + +|`--yes` +|Optional +|If set, the migration starts immediately, without any confirmation. +|`false` + +|=== + +== dmt status + +Displays the status of the currently running migration. + +Usage: + +[source,bash] +---- +dmt status [flags] +---- + +Parameters: + +[cols="1m,1a,2a,1a"] +|=== +|Parameter|Required|Description|Default + +|`--output-dir`, `-o` +|Optional +|Output directory for the migration report. +|Current working directory + +|=== + +== dmt cancel + +Cancels the migration. + +Usage: + +[source,bash] +---- +dmt cancel +---- + +== dmt estimate + +Estimates the duration of the migration using the specified configuration. + +Usage: + +[source,bash] +---- +dmt estimate [dmt-config-path] +---- diff --git a/docs/modules/migrate/partials/nav.adoc b/docs/modules/migrate/partials/nav.adoc index 536f12ba9..0fd65cb9d 100644 --- a/docs/modules/migrate/partials/nav.adoc +++ b/docs/modules/migrate/partials/nav.adoc @@ -1,5 +1,6 @@ ** xref:deploy:versioning-compatibility.adoc[Versioning and Compatibility] ** xref:migrate:data-migration-tool.adoc[] +*** xref:migrate:dmt-command-reference.adoc[] ** xref:migrate:migration-tool-imdg.adoc[] ** xref:migrate:upgrading-from-jet.adoc[] ** xref:migrate:upgrading-from-imdg-4.adoc[]