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 -xvf TSCO_GatewayServer_ver<version>_Linux_x86-64.tar
  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.

    Property nameDescription
    Installation settings
    -P installLocation

    Installation directory path.

    Default value: /opt/bmc/Patrol3

    Example: -P installLocation=/opt/bmc/Patrol3

    -J BPA_USER

    Username for installing the Gateway Server.

    Example: -J BPA_USER=sam

    In this example, sam is a non-root username; all installation files in the file system will appear under this name. 

    If no username is provided, default username used by installer is:

    • cpit (when running the installation as root)
    • <current username> (when running installation as any current non-root user)
    Advanced settings
    -J PERFORM_AGENT_START_UNIX

    Start the Continuous Optimization Agent after installing the Gateway Server.

    Default value: False

    Example: -J PERFORM_AGENT_START_UNIX=FALSE

    -J PERFORM_AGENT_ENABLE_HISTORY

    Enable the collection of historical data.

    Default value: True

    Example: J PERFORM_AGENT_ENABLE_HISTORY=TRUE

    -J PERFORM_CREATE_DEFAULT_LINK

    Create the best1_default link in the /usr/adm directory.

    Default value: True

    Example: -J PERFORM_CREATE_DEFAULT_LINK=TRUE

    -J PERFORM_AGENT_PORT

    Port number to be used by the Continuous Optimization Agent.

    Default value: 6767

    Example: -J PERFORM_AGENT_PORT=6767

    -J PERFORM_INVESTIGATE_PORT

    Port number to be used by the Investigate tool.

    Default value: 6768

    Example: -J PERFORM_INVESTIGATE_PORT=6768

    -J PERFORM_GENERAL_MANAGER_PORT

    Port number to be used by the General Manager.

    Default value: 10129

    Example: -J PERFORM_GENERAL_MANAGER_PORT=10129

    -J PERFORM_AGENT_SERVICE_PORT

    Port number to be used by the Agent service.

    Default value: 10128

    Example: -J PERFORM_AGENT_SERVICE_PORT=10128

    -J GWS_PROXY_PORT

    Port number to be used by the Gateway Server proxy.

    Default value: 10130

    Example: -J GWS_PROXY_PORT=10130

    -J PERFORM_AGENT_HISTORY_REPOSITORY

    Directory path to store the historical data.

    Default value: /opt/bmc/Patrol3/perform/history

    Example: -J PERFORM_AGENT_HISTORY_REPOSITORY=/opt/bmc/Patrol3/perform/history

    -J PERFORM_AGENT_COLLECT_REPOSITORY

    Directory path to store the data collected daily.

    Default value: /opt/bmc/Patrol3/perform/collect

    Example: -J PERFORM_AGENT_COLLECT_REPOSITORY=/opt/bmc/Patrol3/perform/collect

    -J PERFORM_AGENT_SD_LOCATION

    Directory path for installing the service daemon.

    Default value: /etc/bgs/SD

    Example: -J PERFORM_AGENT_SD_LOCATION=/etc/bgs/SD

    -J PERFORM_PROCESS_LENGTH

    Process command length that the Agent must collect.

    Default value: 2048. The other valid values are 4096, 8192, 16384, 32768.

    Example: -J PERFORM_PROCESS_LENGTH=2048

    -J PERFORM_SECURITY_CONFIGURATION_TYPE

    Security level that you want to use for communication between the Gateway Server and BMC Helix Continuous Optimization. Use ADVANCED when a direct network connection does not exist between the Agent and the Gateway Server.

    Default value: BASIC

    Example: -J PERFORM_SECURITY_CONFIGURATION_TYPE=BASIC

    -J PERFORM_UNIX_MIGRATE_AGENT_LIST

    Migrate the agent list to use the latest Gateway Server being installed.

    Default value: True

    Example: -J PERFORM_UNIX_MIGRATE_AGENT_LIST=TRUE

    -J PERFORM_UNIX_UNINSTALL

    Uninstall the existing version of the Gateway Server if detected.

    Default value: False

    Example: -J PERFORM_UNIX_UNINSTALL=FALSE

    -J PERFORM_PATROL_CONFIGURATION_TYPE

    Should the existing PATROL agent interact with the embedded Continuous Optimization Agent being installed.

    Default value: NONE, which indicates you do not want to change the existing PATROL agent configuration.

    Example: -J PERFORM_PATROL_CONFIGURATION_TYPE=NONE

    -J PATROL_AGENT_HOME

    Path where the PATROL agent is installed. (Applicable only if you configure the PATROL agent to communicate with the new Continuous Optimization Agent.)

    Default value: /opt/bmc/Patrol3

    Example: -J PATROL_AGENT_HOME=/opt/bmc/Patrol3

    -J PERFORM_CONFIGURE_SERVICE_STANDALONE

    Run the service daemon process separately or with the inetd or xinetd service.

    Default value: True

    Example: -J PERFORM_CONFIGURE_SERVICE_STANDALONE=True

    -J PERFORM_AGENT_IP_TYPE

    Preference for the protocol, whether IPv4 or IPv6.

    Default value: 46, which indicates that the IPv6 protocol must be used only when IPv4 protocol is not available. To use IPv6, type 64.

    Example: -J PERFORM_AGENT_IP_TYPE=46

    Do not modify these settings
    -J INSTALLATION_TYPE

    Retains the default selection to install the Gateway Server using Custom installation.

    Example: -J INSTALLATION_TYPE=Custom

    -J INSTALL_BPA_AGENT

    Retains the default selection to install the Continuous Optimization Agent.

    Example: INSTALL_BPA_AGENT=true

    -J INSTALL_BPA_CONSOLE

    Retains the default value as true for installing the Gateway Server.

    Example: -J INSTALL_BPA_CONSOLE=TRUE

    -J CONNECTION_TYPE

    Retains the default value for the protocol to be used for communication.

    Default value: HTTP

    Example: -J CONNECTION_TYPE=HTTP

    -J BIND_TO_LOOPBACK

    Retains the default value for binding the service to the loopback address. Default value: 1

    Example: -J BIND_TO_LOOPBACK=1

  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 thatRun this command
Port 10129 is enabled on the Gateway Servernetstat -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 Apr 1 10:12:37 2023 
    Agent Query Request Starting(/usr/adm/best1_23.2.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 Apr 1 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 Apr 1 10:12:37 2023 
    Agent Query Request Starting(/usr/adm/best1_23.2.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 Apr-1-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.

Was this page helpful? Yes No Submitting... Thank you

Comments