Upgrading the Gateway Server

Whenever a new version of Gateway Server is available, the status of the Gateway Server is changed to outdated on the Status page. If you are an administrator, you are notified by email about this status change. You can use the download link on the Status page to download the Gateway Server installer and use the instructions in this topic to upgrade the Gateway Server silently.

Before you begin

Upgrade the Gateway Server on the same computer where you have upgraded the Remote ETL Engine.
Note that for using a non-privileged and non-root user account for upgrading the Gateway Server, the user account must already exist on the computer, and it must have access to use cron on the computer.
Ksh library must be available on the Linux system where you want to upgrade the Gateway Server.

In the upgrade process, detects the existing version of the Gateway Server and saves all existing settings for the upgrade process. You can either retain the default values or change them and save the file.

To upgrade the Gateway Server

Log in as a non-root user to the computer where you want to upgrade the Gateway Server and create a temporary directory.
Example: HOCO_temp/BCO/Disk1.

Download the files from Administration > System > Downloads page.
Extract the Gateway Server installation files to the temporary directory by running this command:
tar -xvzf TSCO_GatewayServer_ver<version>_Linux.tar.gz
In the directory where you extracted the Gateway Server installation files, navigate to the ./BCO/Disk1/silent directory.
Copy the HO_ConsoleSilentInstallOptions.txt file to a new directory.
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 upgrade.
Prefix tags for the silent installation properties:
- -P: Precedes the directory properties
- -J: Precedes the Java properties
  The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.
  This macro generates standalone content. As a consequence you need to make sure to use a syntax that separates your macro from the content before and after it so that it's on a line by itself. For example in XWiki Syntax 2.0+ this means having 2 newline characters (a.k.a line breaks) separating your macro from the content before and after it.
Change to the directory that contains the extracted Gateway Server installation files.
Start the upgrade 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.
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 upgrade

Verify that the upgrade is successful.
- To verify that the GatewayManagerServer process is running
  1. Run this command to verify that port 10129 is enabled on the Gateway Server:
    netstat -an |grep 10129
  2. Run one of the following commands to verify that the General Manager service is running:
    1. For computers that have telnet:
      telnet <GW_server_hostname> 10129
    2. 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
  3. Run this command to verify that the 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. 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.
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_25.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.
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 no. Instance will be started on node clm-pun-015565. Specified data repository: /tmp.
*Node: clm-pun-015565 has acknowledged Start request successfully.
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_25.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 Jul-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.
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 upgraded the Gateway Server to collect data, you must upgrade the Agent on the infrastructure that you want to monitor.

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