edit-icon download-icon

CLI parameters

Last Updated: Sep 07, 2018

The Cloud Migration tool supports command line interface (CLI) parameters for version 1.2.8 and later. Run the help command in the path of the Cloud Migration tool to view the list of the parameters. You can configure the Cloud Migration tool, adjust user-defined usage habits, and clear the client_data file with one click. No need to open the various JSON files.

If you are using a version earlier than 1.2.8 of the Cloud Migration tool, download the compressed package file for a better experience.

To use CLI parameters, you must have some prior knowledge of the migration tool. To learn more about the tool, see the usage of the Cloud Migration tool.

Cloud Migration tool parameters for Windows

A complete list of CLI parameters of the Cloud Migration tool for Windows is as follows:

  1. usage: go2aliyun_client.exe [options]
  2. options:
  3. --help show usage.
  4. --version show version.
  5. --nocheckversion no check for new version.
  6. --noenterkey no enter key to exit.
  7. --progressfile set progress file path.
  8. --cleardata clear client data and server ecs.
  9. --accesssid=<accesss_id> set access id.
  10. --secretkey=<secret_key> set secret key.
  11. --regionid=<region_id> set region id.
  12. --imagename=<image_name> set image name.
  13. --systemdisksize=<sdsize> set system disk size.
  14. --platform=<platform> set platform.
  15. --architecture=<arch> set architecture.
  16. --datadisks=<data_disks> set data disks.
  17. data_disks=data_disk_index|data_disk_size|src_path;
  18. e.g. --data_disks=1|100|D:;2|150|E:
  19. --bandwidthlimit=<limit> set bandwidth limit.
  20. --netmode=<net_mode> set net mode.
  21. --vpcid=<vpc_id> set vpc id.
  22. --vswitchid=<vswitch_id> set vswitch id.
  23. --zoneid=<zone_id> set zone id.
  24. --securegroupid=<sgid> set secure group id.

Cloud Migration tool parameters for Linux

A complete list of CLI parameters of the Cloud Migration tool for Linux is as follows:

  1. usage: ./go2aliyun_client [options]
  2. options:
  3. --help show usage.
  4. --version show version.
  5. --nocheckversion no check for new version.
  6. --noenterkey no enter key to exit.
  7. --progressfile set progress file path.
  8. --cleardata clear client data and server ecs.
  9. --accesssid=<accesss_id> set access id.
  10. --secretkey=<secret_key> set secret key.
  11. --regionid=<region_id> set region id.
  12. --imagename=<image_name> set image name.
  13. --systemdisksize=<sdsize> set system disk size.
  14. --platform=<platform> set platform.
  15. --architecture=<arch> set architecture.
  16. --datadisks=<data_disks> set data disks.
  17. data_disks=data_disk_index|data_disk_size|src_path;
  18. e.g. --data_disks=1|100|/mnt/disk1;2|150|/mnt/disk2
  19. --bandwidthlimit=<limit> set bandwidth limit.
  20. --netmode=<net_mode> set net mode.
  21. --vpcid=<vpc_id> set vpc id.
  22. --vswitchid=<vswitch_id> set vswitch id.
  23. --zoneid=<zone_id> set zone id.
  24. --securegroupid=<sgid> set secure group id.

Parameter description

General parameters

General parameters are usually used for adjusting usage habits and interactive interfaces of the Cloud Migration tool. They do not affect configurations of the tool or the cloud migration process. The general parameters of the Cloud Migration tool for both Windows and Linux are as follows:

Parameter Description
nocheckversion The migration tool stops version update reminds.
noenterkey The migration tool does not give a prompt before completion. Instead, it exits directly.
progressfile Sets the migration progress output file. The file contains two rows in the following format:
  • The first row contains one of the four progress indicators: PrepareForRsync (data transmission preparation stage), DoRsync (data transmission stage), CreateImage (image creation stage), and Finished (cloud migration finished stage).
  • The second row contains the progress value, which shows the progress of each stage. The value is an Integer ranging from 0 to 100.
cleardata Clears the client_data file and releases the running intermediate instance.

Note: Do not use the cleardata parameter before your cloud migration job is complete. Otherwise, the cloud migration are interrupted and the migration progress becomes invalid.

User_config parameters

The relevant CLI parameters for user_config configuration are as follows. For more information about user_config, see the usage of the Cloud Migration tool.

Note: After you use CLI parameters to configure user_config, the Cloud Migration tool uses your new configuration and ignores the configuration file.

  1. --accesssid=<accesss_id> # Sets AccessKey ID in user_config.
  2. --secretkey=<secret_key> # Sets AccessKey Secret in user_config.
  3. --regionid=<region_id> # set Region ID in user_config.
  4. --imagename=<image_name> # Sets user-defined image name in user_config.
  5. --systemdisksize=<sdsize> # Sets system disk capacity in user_config.
  6. --platform=<platform> # Sets the mapping image releasing platform in user_config.
  7. --architecture=<arch> # Sets the image architecture in user_config.
  8. --datadisks=<data_disks> # Sets data disks in user_config. Disk values are separated by vertical bars (|) and semicolons (;), for example, data_disk_index|data_disk_size|src_path;
  9. --bandwidthlimit=<limit> # Sets the upper limit of the public network outbound bandwidth in user_config.

Client_data parameters

The following section describes relevant parameters for cloud migration through VPC intranet. For more information, see VPC Internal Network Cloud Migration.

  1. --netmode=<net_mode> # Sets cloud migration method in client_data. The values can be 0, 1, or 2.
  2. --vpcid=<vpc_id> # Sets the VPC that has configured Express Connect or VPN Gateway in client_data.
  3. --vswitchid=<vswitch_id> # Sets the VSwitch under the VPC in client_data.
  4. --securegroupid=<sgid> # Sets the security group under the VPC in client_data.
Thank you! We've received your feedback.