-
Notifications
You must be signed in to change notification settings - Fork 101
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding DMT command reference content to 5.3 (#968)
- Loading branch information
Showing
2 changed files
with
93 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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, dmt start>> | ||
* <<dmt status, dmt status>> | ||
* <<dmt cancel, dmt cancel>> | ||
* <<dmt estimate, dmt estimate>> | ||
|
||
== 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] | ||
---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters