Help Center/ Elastic Cloud Server/ User Guide/ Passwords and Key Pairs/ Password Reset/ One-Click ECS Password Reset Plug-in/ Installing the One-Click Password Reset Plug-in on an Individual ECS
Updated on 2026-03-06 GMT+08:00
View PDF
Share

Installing the One-Click Password Reset Plug-in on an Individual ECS

Scenarios

The offline password reset depends on the one-click password reset plug-in. If the one-click password reset plug-in is not installed or has been deleted from an ECS, you can install the plug-in on an individual ECS as instructed in this section if you want to reset the password offline.

By default, the password reset plug-in has been installed on ECSs created using public images. If you use an ECS created using a private image, you are advised to install the one-click password reset plugin on it.

Notes

  1. After the installation is complete, do not uninstall the plug-in by yourself. Otherwise, the password reset may fail.
  2. After you reinstall or change the OS of an ECS, the offline password reset function becomes invalid. If you want to continue using this function, reinstall the password reset plug-in.
  3. After you replace the system disk of an ECS, the offline password reset function becomes invalid. If you want to continue using this function, reinstall the password reset plug-in.
  4. The password reset plug-in cannot be installed on ECSs running CoreOS or KylinOS.
  5. If the one-click password reset plug-in is not installed before the password is lost or expires, the password cannot be reset afterwards.
  6. The one-click password reset plug-in can be installed only after an EIP is bound to the ECS.

Prerequisites

  • You can remotely log in to the ECS.
  • For a Windows ECS, ensure that the C: drive is writable and the available space is greater than 300 MB.
  • For a Linux ECS, ensure that the root directory is writable and the available space is greater than 300 MB.
  • For a Linux ECS, disable SELinux if it has been enabled.
  • For an ECS created from the SUSE 11 SP4 image, the memory must be greater than or equal to 4 GiB.
  • DHCP is enabled in the VPC that the ECS belongs to.
  • The ECS network connectivity is normal.
  • The NIC has been set to DHCP so that the ECS can dynamically obtain an IP address.

    For details about how to set the NIC to DHCP for a Linux ECS, see Configuring DHCP.

    For details about how to set the NIC to DHCP for a Windows ECS, see Configuring DHCP.

  • The outbound rule of the ECS security group must meet the following requirements:
    • Protocol: TCP
    • Port: 80
    • Destination: 169.254.0.0/16
    If you use the outbound rules of the default security group, the preceding requirements are met by default. The outbound rules of the default security group are as follows:
    • Protocol: All
    • Port: All
    • Destination: 0.0.0.0/0

Installing the Password Reset Plug-in on a Linux ECS

  1. Check whether the one-click password reset plug-in has been installed on the ECS.

    1. Log in to the ECS as user root.
    2. Check whether CloudResetPwdAgent has been installed:

      ls -lh /Cloud*

      Figure 1 Checking whether the plug-in has been installed

      Check whether the obtained information is similar to that shown in Figure 1.

      • If yes, the plug-in has been installed.
      • If no, the plug-in has not been installed. Perform the following steps to install it.

  2. Download the plug-in package CloudResetPwdAgent.zip and verify its integrity by referring to Obtaining the One-Click Password Reset Plug-in and Verifying Its Integrity (Linux).

    The package can be stored in any directory.

  3. Run the command below to decompress CloudResetPwdAgent.zip.

    The package can be decompressed to any directory.

    unzip -o -d decompressed-directory CloudResetPwdAgent.zip

    For example:

    If the plug-in is decompressed to /home/linux/test, run the following command:

    unzip -o -d /home/linux/test CloudResetPwdAgent.zip

  4. Install the one-click password reset plug-in.

    1. Run the following command to access the CloudResetPwdAgent.Linux file:

      cd {plug-in decompressed directory}/CloudResetPwdAgent/CloudResetPwdAgent.Linux

      For example:

      If the plug-in is decompressed to /home/linux/test, run the following command:

      cd /home/linux/test/CloudResetPwdAgent/CloudResetPwdAgent.Linux

    2. Run the following command to grant execute permissions to the setup.sh file:

      chmod +x setup.sh

    3. Run the following command to install the plug-in:

      sudo sh setup.sh

      If "cloudResetPwdAgent install successfully." is displayed and "Failed to start service cloudResetPwdAgent" is not displayed, the installation is successful.
      • You can also check whether the password reset plug-in has been installed using the methods provided in 1.
      • If the installation failed, check that the installation environment meets requirements and install the plug-in again.

  5. Modify the file permissions of the password reset plug-in.

    chmod 700 /CloudrResetPwdAgent/bin/cloudResetPwdAgent.script

    chmod 700 /CloudrResetPwdAgent/bin/wrapper

    chmod 600 /CloudrResetPwdAgent/lib/*

Installing the Password Reset Plug-in on a Windows ECS

  1. Log in to the ECS.
  2. Check whether the password reset plug-in CloudResetPwdAgent has been installed on the ECS.

    Start Task Manager and check whether cloudResetPwdAgent is displayed on the Services tab. As shown in the Figure 2, the password reset plug-in has been installed on the ECS.

    Figure 2 Successful plug-in installation
    • If yes, no further action is required.
    • If no, go to 3.

  3. Download the plug-in package CloudResetPwdAgent.zip and verify its integrity by referring to Obtaining the One-Click Password Reset Plug-in and Verifying Its Integrity (Windows).

    The package can be stored in any directory.

  4. Decompress CloudResetPwdAgent.zip.

    The package can be decompressed to any directory.

  5. Install the plug-in.

    1. Double-click setup.bat in CloudResetPwdAgent.Windows.

      The password reset plug-in starts to be installed.

    2. View Task Manager and check whether the installation is successful.

      If cloudResetPwdAgent is displayed in the Task Manager, as shown in Figure 3, the installation is successful. Otherwise, the installation failed.

      Figure 3 Successful plug-in installation

      If the installation failed, check that the installation environment meets requirements and install the plug-in again.

Follow-up Procedure

  • After the one-click password reset plug-in is installed, you can add it to the startup items if it cannot automatically start upon ECS startup. For details, see What Do I Do If the One-Click Password Resetting Plug-In Failed to Start?
  • After the one-click password reset plug-in is installed, do not delete the CloudResetPwdAgent process. Otherwise, one-click password reset will not be available.
  • If you have updated the one-click password reset plug-in, newly created ECSs work in PIPE mode by default to prevent the plug-in from using service ports. Existing ECSs still work in AUTO mode, in which the plug-in selects an idle port with the smallest port number from 31000 to 32999.

Related Operations

The following describes how to uninstall, stop, and restart the one-click password reset plug-in. For Linux ECSs, CentOS 7.5 is used as an example. For operations on other Linux distributions, see the help documents provided on the corresponding official website.

  • Uninstall plug-in: If you do not need to use the one-click password reset function, perform the following operations to uninstall the plug-in:
    • Linux ECS
      1. Log in to the ECS.
      2. Switch to the bin directory and delete the cloudResetPwdAgent service.

        cd /CloudrResetPwdAgent/bin

        sudo ./cloudResetPwdAgent.script remove

      3. Delete the plug-in.

        sudo rm -rf /CloudrResetPwdAgent

      4. Check whether CloudResetPwdUpdateAgent exists. If it exists, go to the bin directory and delete the cloudResetPwdUpdateAgent service.

        cd /CloudResetPwdUpdateAgent/bin

        sudo ./cloudResetPwdUpdateAgent.script stop

        sudo ./cloudResetPwdUpdateAgent.script remove

      5. Delete the plug-in.

        sudo rm -rf /CloudResetPwdUpdateAgent

    • Windows ECS
      1. Uninstall and delete CloudResetPwdAgent.
        1. Switch to the C:\CloudResetPwdAgent\bin folder.
        2. Double-click UninstallApp-NT.bat.
        3. Delete the files in C:\CloudResetPwdAgent.
      2. (Optional) Uninstall and delete CloudResetPwdUpdateAgent.
        The plug-in varies depending on the Windows version. Check whether CloudResetPwdUpdateAgent exists. If it exists, perform the following operations to uninstall and delete it. If it does not exist, skip this step.
        1. Go to the C:\CloudResetPwdUpdateAgent folder.
        2. Double-click UninstallApp-NT.bat.
        3. Delete the files in C:\CloudResetPwdUpdateAgent.

          If the deletion fails, delete CloudResetPwdUpdateAgent from Task Manager first and then delete the files in C:\CloudResetPwdUpdateAgent.

  • Stop plug-in: If you do not need to use the one-click password reset function, perform the following operations to stop the plug-in:
    • Linux ECS
      1. Log in to the ECS.
      2. Switch to the bin directory and stop the cloudResetPwdAgent service.

        cd /CloudrResetPwdAgent/bin

        sudo ./cloudResetPwdAgent.script stop

      3. Check whether CloudResetPwdUpdateAgent exists. If it exists, go to the bin directory and stop the cloudResetPwdUpdateAgent service.

        cd /CloudResetPwdUpdateAgent/bin

        sudo ./cloudResetPwdUpdateAgent.script stop

    • Windows ECS
      1. Stop CloudResetPwdAgent.
        1. Log in to the ECS.
        2. Open Task Manager.
        3. On the Services tab, right-click the CloudResetPwdAgent service and select Stop from the shortcut menu.
      2. (Optional) Stop CloudResetPwdUpdateAgent.
        The plug-in varies depending on the Windows version. Check whether CloudResetPwdUpdateAgent exists. If it exists, perform the following operations to stop it. If it does not exist, skip this step.
        1. Log in to the ECS.
        2. Open Task Manager.
        3. On the Services tab, right-click the CloudResetPwdUpdateAgent service and select Stop from the shortcut menu.
  • Restart plug-in: If the one-click password reset function is abnormal, perform the following operations to restart the plug-in:
    • Linux ECS
      1. Log in to the ECS.
      2. Switch to the bin directory and restart the cloudResetPwdAgent service.

        cd /CloudrResetPwdAgent/bin

        sudo ./cloudResetPwdAgent.script reboot

      3. Check whether CloudResetPwdUpdateAgent exists. If it exists, go to the bin directory and restart the cloudResetPwdUpdateAgent service.

        cd /CloudResetPwdUpdateAgent/bin

        sudo ./cloudResetPwdUpdateAgent.script reboot

    • Windows ECS
      1. Restart CloudResetPwdAgent.
        1. Log in to the ECS.
        2. Open Task Manager.
        3. On the Services tab, right-click the CloudResetPwdAgent service and select Restart from the shortcut menu.
      2. (Optional) Restart CloudResetPwdUpdateAgent.
        The plug-in varies depending on the Windows version. Check whether CloudResetPwdUpdateAgent exists. If it exists, perform the following operations to restart it. If it does not exist, skip this step.
        1. Log in to the ECS.
        2. Open Task Manager.
        3. On the Services tab, right-click the CloudResetPwdUpdateAgent service and select Restart from the shortcut menu.
Parent Topic: One-Click ECS Password Reset Plug-in