Help Center/ Server Migration Service/ Best Practices/ Customizing Agent Images/ Using Custom Agent Images
Updated on 2026-01-13 GMT+08:00
View PDF

Using Custom Agent Images

You can customize agent images by referring to Creating a Windows Agent Image and Creating a Linux Agent Image. Then you can use these custom agent images for migration by modifying the SMS Agent configuration file.

Precautions

SMS only provides standard, security-hardened agent images for testing use. You need to use your custom agent images for migration.

  • You are advised to use your custom agent images for migration of sensitive data. Before the migration, you need to scan and evaluate security risks in your agent images. Huawei Cloud can provide help for you. You are responsible for possible migration failures and data losses caused by the security risks identified in your agent images.
  • The agent images provided by SMS are only for migration testing. You are not advised to use them for other purposes.
  • In your custom agent images created using SMS agent images, do not change the IP address 169.254.XX.XX contained in the scripts. The IP address is used by ECS to access the metadata service.

Windows Agent (Python 3)

  1. Sign in to the SMS console.
  2. In the navigation pane, choose Agents.
  3. Download Windows Agent (Python 3), upload it to the source server, and double-click SMS-Agent-Py3.exe to install the SMS-Agent. After the installation is complete, the SMS-Agent GUI opens.
  4. Enter an AK/SK pair and SMS domain name to start the SMS-Agent.
  5. Go to the directory where the SMS-Agent was installed (typically C:\SMS-Agent-Py3\config).
  6. In the cloud-region.json file, search for "windows_ssh_image_id" and replace the image ID with the ID of your custom image, as shown in the figure below.

Windows Agent (Python 2)

  1. Sign in to the SMS console.
  2. In the navigation pane, choose Agents.
  3. Download Windows Agent (Python 2), upload it to the source server, and double-click SMS-Agent-Py2.exe to install the SMS-Agent. After the installation is complete, the SMS-Agent CLI opens.
  4. Enter an AK/SK pair and SMS domain name to start the SMS-Agent.
  5. Go to the directory where the SMS-Agent was installed (typically C:\SMS-Agent-Py2\config).
  6. In the cloud-region.json file, search for "windows_ssh_image_id" and replace the image ID with the ID of your custom image, as shown in the figure below.

Using a Linux Agent Image

  1. Sign in to the SMS console.
  2. In the navigation pane, choose Agents.
  3. Download the Linux Agent installation package to the source server to be migrated.
  4. On the source server, decompress the installation package.

    tar -zxvf SMS-Agent.tar.gz

  5. Start the Agent.

    ./startup.sh

  6. Enter an AK/SK pair and SMS domain name to start the SMS-Agent.
  7. Go to the directory where the SMS-Agent was installed (typically ~\SMS-Agent\agent\config\cloud-region.json).
  8. In the cloud-region.json file, search for "linux_image_id" and replace the image ID with the ID of your custom image, as shown in the figure below.

Parent topic: Customizing Agent Images