This topic describes the common commands and error codes for the mgwutil command line interface.
Common commands
The following tables list the common commands for the mgwutil command line interface.
Create and delete classes
Command | Description |
Create a job. | |
create-address | Create a data address. |
create-agent | Create an agent. |
Create a channel. | |
Create a migration report. | |
delete-job | Delete a job. |
delete-address | Delete a data address. |
Delete an agent. | |
Delete the channel. |
Update and validation commands
Command | Description | ||||||||
update-job | Update a job. This is a composite operation that includes the following commands:
| ||||||||
Retry failed files in a job. | |||||||||
update-address | Update the agent for a data address (add, remove, or set). | ||||||||
Verify whether a data address is valid. | |||||||||
update-address | Update tunnel rate limiting. |
Query and list commands
Command | Description |
get-job | Retrieves job details. |
get-report | Retrieves a migration report. |
list-job | Lists jobs. |
list-job-history | Lists historical job run records. |
Retrieves data address details. | |
get-agent | Retrieves agent details. |
get-tunnel | Retrieves tunnel details. |
Common error codes
Error codes indicate error categories. For details, see the error message (ErrorMsg).
ErrorCode | Description |
InvalidCommand | The command is invalid. Check the command for typos or verify that it exists. |
NewClientErr | Failed to create a client. |
InvalidArgument | The argument is invalid. Check the command-line parameter names, values, or count. |
EmptyDomain | The domain name cannot be empty. Provide a valid domain name. |
EmptyAccessId | The AccessId cannot be empty. Provide a valid AccessId. |
EmptyAccessSecret | The AccessSecret cannot be empty. Provide a valid AccessSecret. |