Updated on 2024-11-25 GMT+08:00

Installing a UniAgent

Install a UniAgent on a host manually or remotely, or by importing an Excel file.

You can select an installation mode based on site requirements.

Table 1 Installation modes

Mode

Application Scenario

Manual Installation

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

Remote Installation

Remote installation can be performed only when you have an installation host.

NOTE:

An installation host is used to execute commands for remote installation.

Installation by Importing an Excel File

Ensure that an installation host and an Excel file with data are available.

NOTE:

The Excel import function is opened restrictedly. If you need this function, submit a service ticket.

Installation Prerequisite

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

UniAgent Installation Restrictions

For details about the Linux and Windows OSs supported by the UniAgent, see Collection Management Restrictions.

Manual 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, choose Settings. The Global Configuration page is displayed.
  3. In the navigation pane, choose Collection Settings > VM Access. Then click Install UniAgent in the upper right corner. On the displayed page, choose 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.

    Figure 1 Manually installing a UniAgent
    Table 2 Parameters for manual installation

    Parameter

    Description

    Example

    UniAgent Version

    Version of a UniAgent. This parameter is mandatory.

    1.0.8

    Access Mode

    There are three access modes: Direct access (private network), Direct access (public network), and Proxy access.

    • Direct access (private network): intended for Huawei Cloud hosts.
    • Direct access (public network): intended for non-Huawei Cloud hosts.
    • Proxy access: Select a proxy area where a proxy has been configured and remotely install the UniAgent on a host through the proxy. If Proxy access is selected, you need to select a proxy area. The proxy in the proxy area must be a cloud host with UniAgent installed. Also, you need to set it to be an installation host.
    NOTE:

    You can choose Direct access (private network) and Direct access (public network) only in CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, and CN South-Guangzhou.

    Direct access (private network)

    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 -a xxxxxxxxxx -s xxxxxxxxxx -p xxxxxx -d https://aom-uniagent-xxxxxx -m https://uniagent.master.cnxxxxxx,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, for example, myhuaweicloud.com.
      • 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.
    NOTE:
    • 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, such as PuTTY, 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 Installation

  1. Log in to the AOM 2.0 console.
  2. In the navigation pane, choose Settings. The Global Configuration page is displayed.
  3. In the navigation pane, choose Collection Settings > VM Access. Then click Install UniAgent in the upper right corner.
  4. On the Install UniAgent page, choose Remote and set parameters. (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.)

    Figure 2 Remotely installing a UniAgent
    Table 3 Parameters for remotely installing a UniAgent

    Parameter

    Description

    Example

    UniAgent Version

    Version of a UniAgent. This parameter is mandatory.

    1.0.8

    Access Mode

    There are three access modes: Direct access (private network), Direct access (public network), and Proxy access.

    • Direct access (private network): intended for Huawei Cloud hosts.
    • Direct access (public network): intended for non-Huawei Cloud hosts.
    • Proxy access: Select a proxy area where a proxy has been configured and remotely install the UniAgent on a host through the proxy.
    NOTE:

    You can choose Direct access (private network) and Direct access (public network) only in CN North-Beijing4, CN East-Shanghai1, CN East-Shanghai2, and CN South-Guangzhou.

    Direct access (private network)

    Proxy Area

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

    A proxy area is used to manage proxies. A proxy is a Huawei Cloud ECS used for network communication across clouds. Ensure that it is installed with UniAgent and set to be an installation host.

    -

    Installation Host

    An installation host is used to execute commands for remote installation. This parameter is mandatory.

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

    1. Select Configure Installation Host from the drop-down list.
      Figure 3 Configuring an installation host
    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.

    -

    Hosts to Be Installed with UniAgents

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

    Click Add Host and enter the following information:

    Host IP Address: IP address of a host.

    OS: operating system of the host, which can be Linux or Windows.

    NOTE:

    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.

    Operation: Delete, Copy, or Test Connectivity.

    NOTE:
    • You can click Add Host to add up to 100 hosts.
    • The hosts that run Windows do not support connectivity tests.

    -

    Install ICAgent

    An ICAgent is a plug-in for collecting metrics and logs. The Install ICAgent option is enabled by default. It is optional. Enter an AK and SK if needed. (In some regions, you do not need to enter any AK or SK.)

    -

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

Installation by Importing an Excel File

The Excel import function is opened restrictedly. If you need this function, submit a service ticket.

  1. In the navigation pane, choose Settings. The Global Configuration page is displayed.
  2. In the navigation pane, choose Collection Settings > VM Access and click Install UniAgent in the upper right corner.
  3. On the Install UniAgent page, choose Import Excel and set parameters. (When you install the UniAgent for the first time, the Manual page is displayed by default. Import Excel is not available.)

    Figure 4 Installation by importing an Excel file
    Table 4 Parameters for installation by importing an Excel file

    Parameter

    Description

    Example

    UniAgent Version

    Version of a UniAgent. This parameter is mandatory.

    1.1.0

    Installation Host

    An installation host is used to execute commands for Excel-based installation. This parameter is mandatory.

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

    1. Select Configure Installation Host from the drop-down list.
      Figure 5 Configuring an installation host
    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.

    -

    Import Excel

    Only an .xls or .xlsx file with up to 5000 records can be uploaded.

    NOTE:

    To install the UniAgent by importing an Excel file, ensure that the host does not run Windows.

    -

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

UniAgent Statuses

The UniAgent status can be Running, Abnormal, Installing, Installation failed, or Not installed.

Table 5 UniAgent statuses

Status

Description

Running

The UniAgent is working.

Abnormal

The UniAgent is not working. Contact technical support.

Installing

The UniAgent is being installed.

NOTE:

The installation takes about 1 minute to complete.

Installation failed

The UniAgent fails to be installed. Try again.

Not installed

The UniAgent has not been installed on the host. Install the UniAgent by referring to Installing a UniAgent.

After the UniAgent is installed on the host, ports 39338 and 39339 will be enabled to query log levels and collection tasks.

Troubleshooting

If you encounter any problem when installing the UniAgent, see Collection Management FAQs.