Updated on 2025-08-07 GMT+08:00

Installing UniAgents

UniAgents centrally manage the life cycle of collection plug-ins and deliver instructions (such as script delivery and execution). UniAgents do not collect metric data themselves. O&M data is collected by collection plug-ins. You can install collection plug-ins through the access center and create collection tasks to collect metric data.

AOM allows you to install UniAgents on cloud servers in a VPC.

Prerequisite

Ensure that the network between the installation host and the host where the UniAgent is to be installed is normal.

Constraints

  • For details about the Linux and Windows OSs supported by the UniAgent, see Collection Management Restrictions.
  • To switch from the new UniAgent page to the old one, choose Settings > Global Settings > Collection Settings > UniAgents in the navigation tree on the left and click Back to Old Version in the upper right corner. To go to the new UniAgent page, click Try New Version in the upper right corner of the UniAgents page.

Installation Methods

Install a UniAgent on a host manually or remotely. Select an installation mode based on site requirements.

Table 1 Installation methods

Method

Scenario

Manual UniAgent Installation

Suitable for initial installation and single-node installation scenarios. Log in to the host where the UniAgent is to be installed and manually run the installation command.

When installing a UniAgent for the first time, you must install it manually.

Remote UniAgent Installation

Suitable for the scenario where UniAgents are installed in batches. Set a host where a UniAgent has been installed to be an installation host, and use it to install UniAgents on other hosts. (Enter the information about the hosts where UniAgents are to be installed on the installation page.)

Manual UniAgent Installation

When installing a UniAgent for the first time, you must install it manually.

  1. Log in to the AOM 2.0 console.
  2. In the navigation pane on the left, choose Settings > Global Settings.
  3. In the navigation pane, choose Collection Settings > UniAgents. Click Install UniAgent in the upper right corner and select Manual. (When you install the UniAgent for the first time, the Manual page is displayed by default.)
  4. On the Install UniAgent page, set parameters to install a UniAgent.

    Table 2 Parameters for manual installation

    Parameter

    Description

    Example

    UniAgent Version

    Version of a UniAgent. This parameter is mandatory.

    1.1.8

    Access Mode

    There are two access modes: direct access and proxy access.

    • Direct access: A host is directly accessed.
    • Proxy access: Select a proxy area where a proxy has been configured and install the UniAgent on a host through the proxy.

    Direct access

    Proxy Area

    Manages proxies by category. When Access Mode is set to Proxy access, you need to select or add a proxy area.

    A proxy area must contain an available proxy. This proxy must be a cloud host where a UniAgent has been installed.

    Select a proxy area.

    Installation Command

    Command for installing the UniAgent. Commands for Linux and Windows are different.

    Linux

    1. Click to copy the installation command.
    set +o history; 
    curl -k -X GET -m 20 --retry 1 --retry-delay 10 -o /tmp/install_uniagent https://aom-uniagent-xxxxxx/install_uniagent.sh;bash /tmp/install_uniagent -p xxxxxx -d https://aom-uniagent-xxxxxx -m https://aom.mgr-lb. xxxxxx,https://xx.xx.xx.xx:xxxx -v 1.x.x -q false
    set -o history;
    
    Windows
    1. Copy the download address (https://aom-uniagent-{region_name}.obs.{region_name}.{site domain name suffix}/ +uniagentd-{version}-win32.zip) to the browser to download the installation package.

      {region_name} and {version} can be obtained from the installation page.

      • region_name: domain name or IP address of the server where the REST service is deployed. The value varies depending on services and regions.
      • Site domain name suffix: site domain name suffix.
      • version: version of the installed UniAgent.
    2. Decompress the package, click uniagentd.msi, and specify path C:\uniagentd for installation.
    3. Enter the following configuration (obtained from the installation page) to the C:\uniagentd\conf\uniagentd.conf file:
      master=https://aom-mgr-lb.xxxxxxxxxxx,https://xx.xx.xx.xx:xxxxx
      project_id=xxxxxxxxxxxxxx
      public_net=xxxx
    4. Run start.bat in the C:\uniagentd\bin directory as the administrator.

      If you need to verify the SHA256 value of the Windows installation package, check the file downloaded from https://aom-uniagent-{region_name}.obs.{region_name}.{site domain name suffix}/uniagentd-{version}-win32.zip.sha256.

    Copy the Linux installation command.

  5. Copy the installation command and run it on the host to install the UniAgent.

    • Linux host: Use a remote login tool to log in to the target host and run the installation command copied in the previous step as the root user to install the UniAgent.
    • Windows host: Log in to the target host, and download the installation package based on the installation command in the previous step to install the UniAgent.

  6. Check whether the UniAgent is displayed in the UniAgent list.

Remote UniAgent Installation

  1. Log in to the AOM 2.0 console.
  2. In the navigation pane on the left, choose Settings > Global Settings.
  3. In the navigation pane on the left, choose Collection Settings > UniAgents. Click Install UniAgent in the upper right corner.
  4. On the Install UniAgent page, choose Remote and set parameters to install a UniAgent. (When you install the UniAgent for the first time, the Manual page is displayed by default. Remote is not available. Remote installation can be performed only when you have an installation host.)

    Table 3 Parameters for remotely installing a UniAgent

    Parameter

    Description

    Example

    UniAgent Version

    Version of a UniAgent. This parameter is mandatory.

    1.1.8

    Access Mode

    There are two access modes: direct access and proxy access.

    • Direct access: A host is directly accessed.
    • Proxy access: Select a proxy area where a proxy has been configured and remotely install the UniAgent on a host through the proxy.

    Direct access

    Proxy Area

    Manages proxies by category. When Access Mode is set to Proxy access, you need to select or add a proxy area.

    A proxy area must contain an available proxy. This proxy must be a cloud host where a UniAgent has been installed.

    Select a proxy area.

    Installation Host

    An installation host is used to execute commands for remote installation. This parameter is mandatory. To install the UniAgent remotely, ensure that the installation host does not run Windows.

    If no installation host has been configured, perform the following steps:

    1. Select Configure Installation Host from the drop-down list.
    2. In the dialog box that is displayed, select the host to be set as an installation host and specify its name.
    3. Click OK.

    Select an installation host.

    Hosts to Be Installed with UniAgents

    Detailed information about the host where the UniAgent is to be installed. This parameter is mandatory.

    Add a maximum of 100 hosts:

    • Host IP Address: IP address of a host.
    • OS: operating system of the host, which can be Linux or Windows.

      To install the UniAgent remotely, ensure that the host does not run Windows.

    • Login Account: account for logging in to the host. If Linux is used, use the root account to ensure that you have sufficient read and write permissions.
    • Login Port: port for accessing the host.
    • Authentication Mode: Currently, only password-based authentication is supported.
    • Password: password for logging in to the host.
    • Connectivity Test Result: shows whether the network between the installation host and the host where the UniAgent is to be installed is normal.

    After entering the host information, you can delete, copy, or test the connectivity of hosts in the Operation column.

    The connectivity test checks the network between the installation host and the host where the UniAgent is to be installed. The test result is displayed in the Connectivity Test Result column. (Windows hosts do not support connectivity tests.)

    Enter the information about the hosts where UniAgents are to be installed.

    Install ICAgent

    The ICAgent is a plug-in for collecting metrics and logs. The Install ICAgent option is enabled by default. It is optional. To install the ICAgent remotely, ensure that the host does not run Windows.

    -

  5. Click Install. After the installation is complete, you can view the UniAgent status in the UniAgent list.

Checking the UniAgent Status

On the VM Access page, check the UniAgent status of the target host. For details, see Table 4.

Table 4 UniAgent statuses

Status

Description

Running

The UniAgent is working.

Offline

The UniAgent is abnormal.

Installing

The UniAgent is being installed. The installation takes about 1 minute to complete.

Installation failed

The UniAgent fails to be installed. Uninstall the UniAgent and then reinstall it.

Not installed

The UniAgent has not been installed.

Other Operations

If needed, perform the following operations on the host where the UniAgent has been installed.

Table 5 Related operations

Operation

Description

Searching for a host

In the search box above the host list, search for a host by host IP address, imported IP address, host name, installation host name, or proxy IP address.

Refreshing the host list

Click in the upper right corner of the host list to refresh the list.

Customizing columns to display

Click in the upper right corner of the host list to select the columns to display.

Filtering hosts

In the table heading of the host list, click to filter hosts.

Sorting hosts

In the table heading of the host list, click next to UniAgent Heartbeat Time to sort hosts.

Deleting a host

If a UniAgent is Abnormal, Not installed, or Installation failed, you can delete the corresponding host.

Locate the target host and choose Delete in the Operation column.

Precautions:

  • Hosts with UniAgent being installed, upgraded, or uninstalled cannot be deleted. Refresh the page and wait.
  • Running hosts with UniAgent installed cannot be deleted. Uninstall UniAgent first.
  • Hosts set as installation hosts or proxies cannot be deleted. Ensure that they are not installation hosts or proxies.

Configuring an installation host

To set the name of an installation host, do as follows:

Choose Configure Installation Host in the Operation column, and enter a desired name.

Canceling an installation host

To cancel an installation host, do as follows:

Choose Cancel Installation Host in the Operation column to cancel an installation host.

Changing the name of an installation host

To change the name of a configured installation host, do as follows:

Click the name of the installation host. In the dialog box that is displayed, rename it.