Updated on 2026-07-13 GMT+08:00

Installing the SMS-Agent on Windows

Without installing the Agent on the source server, SMS cannot collect server information or initiate a migration task. Before the migration, you must install the Agent on the source server to be migrated. During the installation, you need to enter the AK/SK pair of the Huawei Cloud account you are migrating to. After the Agent is started, it automatically reports source server information to SMS. The information is used for migration only. To learn what source server information is collected by SMS, see What Information Does SMS Collect About Source Servers?

Before using SMS to migrate servers, you need to manually install and register the SMS-Agent on each server to be migrated. If there are more than 50 servers to migrate, you can create a batch server migration workflow on MgC to automate batch installation and registration of the Agent.

The SMS-Agent version varies depending on the Windows version. For details, see Table 1.

Table 1 SMS-Agent versions

OS Version

SMS-Agent version

Description

Windows Server 2012, Windows Server 2016, Windows Server 2019, Windows Server 2022, Windows 8.1, and Windows 10

GUI-based Windows Agent (Python 3)

Windows Agent (Python 2) can run on Windows of later versions.

Windows Server 2008 and Windows 7

CLI-based Windows Agent (Python 2)

Constraints

You need to log in to the source Windows server as Administrator.

Prerequisites

Downloading the SMS-Agent Installation File

  1. Sign in to the SMS console.
  2. In the navigation pane, choose Agents. The Agents page is displayed.
  3. Select the Windows card, locate the Agent that matches the source server OS, and click the icon next to Agent.

    • GUI-based Windows Agent (Python 3): Windows Server 2012, Windows Server 2016, Windows Server 2019, Windows Server 2022, Windows 10, and Windows 8.1
    • CLI-based Windows Agent (Python 2): Windows Server 2008 and Windows 7

  4. Read and agree to the service agreement, and click Yes to download the Agent installation file.
  5. Click next to CMS File and CRL File to download them to the source server.

  6. Verify the integrity of the Agent installation file. For details, see How Do I Verify the Integrity of the Agent Installation File?

Installing the SMS-Agent

Select the installation method based on the OS version.

  • Windows Agent (Python 3): Windows Server 2012, Windows Server 2016, Windows Server 2019, Windows Server 2022, Windows 8.1, and Windows 10
  • Windows Agent (Python 2): Windows Server 2008 and Windows 7
  1. Transmit the SMS-Agent-Py3.exe file to the source server.
  2. Log in to the source server as user Administrator and double-click the SMS-Agent-Py3.exe file.
  3. Click Install and wait for the installation to complete.
  4. Click Finish to open the SMS-Agent GUI.
  5. Enter the AK/SK pair for the Huawei Cloud account that you are migrating to and the SMS domain name. You can obtain the SMS domain name on the Agents page of the SMS console, as shown in Figure 2.

    Figure 1 Starting the Agent
    Figure 2 Obtaining the SMS domain name

  6. Determine whether to use an HTTP/HTTPS proxy server for the migration.

    • If you do not need to use an HTTP/HTTPS proxy, select Direct Connection.
    • If you need to use an HTTP/HTTPS proxy, select Use Proxy and set parameters such as the IP address, port number, username, and password of the proxy server based on Table 2.
      Table 2 Proxy parameter settings

      Parameter

      Description

      Proxy server IP

      Enter the IP address of the proxy server, not that of the target server. The input format is https://your-proxy-addr.com. Replace your-proxy-addr.com with the actual proxy server address. HTTPS is recommended.

      Port

      Enter the proxy port opened on the proxy server.

      External user name

      Enter a proxy username if any; otherwise, leave it blank.

      Password

      Enter a proxy password if any; otherwise, leave it blank.

  7. If the EPS service has been enabled for your Huawei Cloud account, after you entered the AK/SK pair, the Agent will list all enterprise projects your account is allowed to access. You can select the enterprise project you would like to migrate the source server to. This enables you to isolate permissions, resources, and finance during the migration. For details, see Migrating a Server into an Enterprise Project.
  8. Click start.
  9. Carefully review the Privacy Statement and click Yes if you want to continue.

    When the message "Upload success. Waiting for the SMS instruction" is displayed, the SMS-Agent has been started. You can sign in to the SMS console and perform subsequent operations.

  1. Transmit the SMS-Agent-Py2.exe file to the source server.
  2. Log in to the source server as user Administrator and double-click the SMS-Agent-Py2.exe file.
  3. Click Install and wait for the installation to complete.
  4. Click Finish to open the SMS-Agent CLI.

    If you need to rerun the SMS-Agent, double-click agent-start.exe in the C:\SMS-Agent-Py2 directory.

  5. Determine whether to use an HTTP/HTTPS proxy server for the migration. If your source server cannot access Huawei Cloud over the Internet, you can use a proxy server. You will need to configure the proxy server yourself. In a migration over a private line or VPN, a proxy server is only used for registering the source server with SMS. It is not used for data migration.

    • If you do not need an HTTP/HTTPS proxy server, skip this step and go to the next step.
    • If you need to use an HTTP/HTTPS proxy, do as follows:
      1. Go to the directory where the Agent was installed (typically C:\SMS-Agent-Py2\config).
      2. Edit the auth.cfg file. Do not edit the auth.cfg file unless you need to use an HTTP/HTTPS proxy.
        [proxy-config]
        enable = true
        proxy_addr = https://<your-proxy-address>.com
        proxy_port = <proxy-port>
        proxy_user =
        use_password = false

        Configure the parameters according to the table below.

        Table 3 Proxy parameter settings

        Parameter

        Description

        enable

        To use a proxy server, set enable to true.

        proxy_addr

        Enter the IP address of the proxy server, not that of the target server. The proxy is used by the source server to access SMS. Replace your-proxy-addr.com with the IP address of your own proxy server. Configure the protocol based on your proxy server. HTTPS is recommended.

        proxy_port

        Enter the proxy port opened on the proxy server.

        proxy_user

        Enter the proxy username if available, for example, root. Otherwise, leave it blank.

        use_password

        If the proxy server has a password, set this parameter to true. Otherwise, set it to false.

  6. When prompted, enter the AK/SK pair for the Huawei Cloud account that you are migrating to and the SMS domain name. You can obtain the SMS domain name on the Agents page of the SMS console, as shown in Figure 3.

    If the EPS service has been enabled for your Huawei Cloud account, after you entered the AK/SK pair, the Agent will list all enterprise projects your account is allowed to access. You can select the enterprise project you would like to migrate the source server to. This enables you to isolate permissions, resources, and finance during the migration. For details, see Migrating a Server into an Enterprise Project.
    Figure 3 Obtaining the SMS domain name

    After the authentication succeeds, the SMS-Agent starts to report source server information to SMS, and the window is closed. You can go to the Servers page on the SMS console to check the record of the source server.

Troubleshooting

Uninstalling the SMS-Agent

After the migration is complete, you can uninstall the SMS-Agent from the source server. For details, see Uninstalling the SMS-Agent from Windows.