Installing the Gateway Server


Use the information in this topic to install the Gateway Server silently. When using the Gateway Server, you must install it on the same computer where the Remote ETL Engine is installed. We recommend using a dedicated Remote ETL Engine for processing data from the Gateway Server and a separate Remote ETL Engine for processing data from other on-premises ETLs. The use of separate Remote ETL Engines ensures efficient data processing.

To install the Gateway Server

  1. Navigate to Administration > System > Downloads page.
  2. In the Gateway server for Linux tile, click Download.
    It might take some time to download the files.
  3. After the download is complete, copy the installation files to the computer where you want to install the Gateway Server.
  4. Extract the Gateway Server installation files to the temporary directory by running this command:
    tar -xzvf TSCO_GatewayServer_ver<version>_Linux_x86-64.tar.gz
  5. In the directory where you extracted the Gateway Server installation files, navigate to the ./linux_x86_console/silent directory.
  6. Copy the HO_ConsoleSilentInstallOptions.txt file to a new directory.
    Prefix tags for the silent installation properties:

    • -P: Precedes the directory properties
    • -J: Precedes the Java properties

    This file contains the installation properties that are specified as name and value pairs with prefix tags. You can retain the default values or modify the properties of the file according to your preferences as listed below and save the file. However, we recommend retaining the default values in the options file for the installation.

  7. Change to the directory that contains the extracted Gateway Server installation files.
  8. Start the installation process by running the following command:
    ./setup.sh -i silent -DOPTIONS_FILE=<fileLocationPath>/HO_ConsoleSilentInstallOptions.txt
    The variable <fileLocationPath> represents the location where you saved the options file. If the path contains spaces, enclose the path and options file name in quotation marks.
  9. (Optional) If the installation is executed as a non-root user, the /<installLocation>/b1configVVVV.sh script (where VVVV is the Gateway Server version) must be executed as the root user to complete the installation. The b1configVVVV.sh script is executed automatically when the Gateway Server installation is done by the root user.

To verify the installation

To verify that

Run this command

Port 10129 is enabled on the Gateway Server

netstat -an |grep 10129

General Manager service is running

  • For computers that have telnet:
    telnet <GW_server_hostname> 10129

  • For computers that do not have telnet:
    export BEST1_HOME=/usr/adm/best1_V.V.VV (V.V.VV is the Gateway Server version)
    $BEST1_HOME/bgs/bin/GeneralManagerClient -s localhost:10129 getConsoleVersion

GeneralManagerServer process is up and running

ps -ef |grep GeneralManagerServer

To verify data collection

  1. To configure the BEST1_HOME environment variable, run the following commands:

    1. Change to the non-root user.
    2. Run the following commands:
      • For the Korn or Bourne shell:
        BEST1_HOME=/usr/adm/best1_<version>
        export BEST1_HOME
      • For the C shell:
        setenv BEST1_HOME /usr/adm/best1_<version>
        where version indicates the version of the installed product component.

  2. To test the connection to the Agent, run the following command:
    $BEST1_HOME/bgs/scripts/best1collect -n <targetHostName> -q
    The following example shows the result of running this command on the clm-pun-015565 system:

    [perform@clm-pun-032515 ~]$ $BEST1_HOME/bgs/scripts/best1collect -n clm-pun-015565 -q
    best1collect on clm-pun-032515: requesting Update Status on clm-pun-032515 ...
    Wed Sep 10 10:12:37 2023
    Agent Query Request Starting(/usr/adm/best1_23.4.00/bgs/monitor/log/clm-pun-032515-bgsagent_6767.als) Collect Instance Node Started Started Name Name Name By On
    ------------ -------------- ---------- ---------- ----------------- ------------ -------------- ---------- ---------- -----------------
    *Node: clm-pun-032515 has acknowledged Query request successfully.
  3. To initiate a data collection request, run the following command and replace <nodeName> with the name of the system where you want to initiate the collection request.
    $BEST1_HOME/bgs/scripts/best1collect -n <nodeName> -e +15 -d /tmp -w 1

    The following example shows the result of running this command on the clm-pun-015565 system:

    [perform@clm-pun-032515 scripts]$ $BEST1_HOME/bgs/scripts/best1collect -n clm-pun-015565 -e +15 -d /tmp -w 1
    best1collect on clm-pun-032515: requesting Start Collect on clm-pun-015565 ...
    best1collect requesting bgscollect start on clm-pun-015565...
    Wed Sep 10 10:12:37 2023
    best1collect: Collect process with instance noInstance will be started on node clm-pun-015565. Specified data repository: /tmp.
    *Node: clm-pun-015565 has acknowledged Start request successfully.
  4. To verify the status of data collection, run the following command:
    $BEST1_HOME/bgs/scripts/best1collect -n <nodeName> -Q

    The following example shows the result of running this command on the clm-pun-015565.bmc.com system:

    [perform@clm-pun-032515 scripts]$ $BEST1_HOME/bgs/scripts/best1collect -n clm-pun-015565.bmc.com -Q
    best1collect on clm-pun-032515: requesting Update Status on clm-pun-015565.bmc.com ...
    Wed Sep 10 10:12:37 2023
    Agent Query Request Starting(/usr/adm/best1_23.4.00/bgs/monitor/log/clm-pun-015565-bgsagent_6767.als) Collect Instance Node Started Started Data Length Spill SampleState Config Active Active Term Term LagTime Name Name Name By On Repository HH:MM (Min) (Sec) Groups Data No Data Data No Data (Min)
    ------------ -------------- ---------- --------------------------- ----------------------------- ------ ----- ------------------------ ------ ------ ------- ---- ------- -------
    SYSTEM noInstance clm-pun-015565 perform Sep-10-2023.10.12/tmp 0:15 15 10 UDR_WRITE_ACTIVE 46 19 2 0 25 0
    ------------ -------------- ---------- --------------------------- ----------------------------- ------ ----- ------------------------ ------ ------ ------- ---- ------- -----
    *Node: clm-pun-015565.bmc.com has acknowledged Query request successfully.
  5. Verify that the Active Data parameter shows a value greater than 0, which indicates that the data collector is functioning as expected.

Where to go from here

If you have installed the Gateway Server to collect data, you must install the Continuous Optimization Agent on the infrastructure that you want to monitor.

The Continuous Optimization Agent collects data from the managed systems in your environment. After collecting data, the Agent transfers it to the Gateway Server. You can install the Continuous Optimization Agent by using a Shell script or a Docker container. For instructions, see Installing-the-Continuous-Optimization-Agent.