Installing the Gateway Server using the wizard

Where you are in the Installation process

You can install the Gateway Server using one of the following settings:

  • Typical: Installs the Gateway Server using the default settings, but you can customize the installation directory.
  • Custom: Enables you to customize the security level for the network communication between the Gateway Server and Capacity Agents.

When you install the Gateway Server, a Capacity Agent is also installed along with the Gateway Server on the same computer. 

To perform a typical installation of the Gateway Server

  1. Log in to the computer where you want to install the Gateway Server.

    • (Windows) Log in as a user with administrator privileges.
    • (Linux) Log in as the root user or as a non-privileged TSCO Gateway Server Installation Owner user account.

  2. Extract the Gateway Server installer files to a temporary directory.

    • (Windows) Extract TSCO_GatewayServer_<version>_MSwindows.zip
    • (Linux) Run this command: tar -xvf TSCO_GatewayServer_<version>_Linux.tar

  3. (Linux) Set the DISPLAY environment variable to ensure that the wizard-based installer launches the screens appropriately:
    export DISPLAY=<IP address of the computer>:0.0

  4. Run the installer:

    • (Windows) Run setup.exe from the windows_gateway_server directory.
    • (Linux) As a non-root user, run setup.sh from the linux_x86_console directory.

  5. Review the welcome page, and click Next.

  6. Read the license agreement, agree to the terms, and click Next.

  7. Ensure that the Gateway Server component is selected for installation, and click Next.

  8. Ensure that Typical (use default settings) is selected, and click Next.

  9. Retain the default installation directory path, or change it, and then click Next. Ensure that this directory has sufficient storage space.
    (Windows)     C:\Program Files\BMC Software\Patrol3

    (Linux) /opt/bmc/Patrol3

  10. Select HTTP or HTTPS, and click Next. The default selection is HTTPS, which enables TLS for secure communication between the Gateway Server and the Application Server.

  11. If you selected HTTPS in the previous step, provide the following details of the Application Server to retrieve its server certificate, and click Next:

    • The host name and port number
    • The administrator user name and password
      When you click Next, the specified Application Server details are validated.
  12. (Linux) Type a user name for running the installer or retain the specified logged-in user name.

  13. Select a network protocol, and click Next.

    network_configuration.png

  14. Review the installation details, and click Install.
    A message confirming the completion of installation process is displayed.

  15. Click View log to view the installation log details on the screen.

  16. Click Done to exit the installation program.

  17. (Linux) Run the following command as a root user to configure the embedded Capacity Agent:

    1. Change to the root user.
    2. Change to the installation directory. The default is /opt/bmc/Patrol3.
    3. Run the following command:
      ./b1config<version>.sh

    where version indicates the version of the installed Gateway Server.

  18. Verify that the installation is successful:

    • Verification steps for Windows:

      To verify the installation of the embedded Capacity Agent
      1. On the computer where the Gateway Server is installed, click Start > Settings > Control Panel.
      2. Double-click PATROL - Perform Agent.
      3. Verify that the status of the BGS_SDService service daemon is Running.
      To verify the installation of the environment variables
      1. Open the command prompt, and run the following command:
        echo %best1_home%
      2. Ensure that the following installation location is displayed:
        C:\Program Files\BMC Software\Patrol3\BEST1\NTC
      To verify data collection

      To verify that the Gateway Server collects data from the embedded Capacity Agent and the Agents that are installed on other computers, do the following:

      1. Click Start > All Programs > BMC Software > Gateway Server > Collect Data.
      2. Click Start a collect process on a Console or Agent computer, and click Next.
      3. Select one of the following collection modes, and click Next.
        • Standard Mode: Transfers the collected data across a network from the target computers to the Gateway Server.
        • Secure Mode: Transfers the collected data locally.
        • Collect from a policy file: Transfers data from the computer names that are defined in a text file.
      1. If you selected Collect from a policy file, select the policy file, and click Next. You are directed to Step f.
      2. Specify one the following options to add the computers from which you want to collect data, and click Next.
        • Agent computers or network address: Type the names (host names or fully qualified domain names) or IP addresses of the computers on which you have installed Capacity Agents. Separate names with a comma (,). If this field is left blank, data collection starts from the embedded Capacity Agent.
        • Optional name of Agent computer: Type the name of computer where the agent is installed. If the computer has identification other than its network name, type that name. For example, a computer with the network name 1on_subnet5 might be a mail server with an internal name emailC. The specified name appears as a directory name where the collected data is stored. For example, C:\Program Files\BMC Software\BEST1\NTC\History\emailC. The specified name appears as a directory name where the collected data is stored. For example, C:\Program Files\BMC Software\BEST1\NTC\History\emailC.
          If this field is left blank, the folder name in the collection repository takes the network name. For example, C:\Program Files\BMC Software\BEST1\NTC\History\1on_subnet5.
        • File with list of computers to collect: Specify the text file that contains the agent computer names from which you want to collect data.
      1. Type the path of the data collection directory on the agent and Gateway Server computers, and click Next.
        • Repository on the Console: Select the path to the data collection directory on the computer where the Gateway Server is installed.
        • Repository on the Agent: Select the path to the temporary repository on the computer where the agent is installed.
        • Select the action that must start after the data collection wizard is exited.
      1. Select the frequency for collecting and summarizing data, and click Next.
        • Collect data every: Specify the frequency at which the data collector must place the collected data in the memory. The default value is 10 seconds.
        • Summarize data every: Select the interval, in minutes, at which the Capacity Agent summarizes data and saves it in the repository.
      2. Specify one of the following data collection schedules, and click Next.
        • Begin immediately: Begins collection immediately after existing the wizard and stops after 24 hours.
        • Begin: Begins collection after the specified time and ends after the specified duration.
        • Begin and end by date and time: Starts and ends collection on the specified dates and at the specified times.
      2. Review the settings and click Finish.
      3. When the collection duration ends, confirm that the correct files are created and transferred from the agent computers to the Gateway Server computer in the following formats:
        • repository\computerName\date.time\type-of-stats\raw.udr

        • repository\computerName\date.time\type-of-stats\raw.lox
          (The default repository on the Gateway Server computer is C:\Program Files\BMC Software\Patrol3\NTC\history).

          The temporary default repository on the agent computer is C:\Program Files\BMC Software\Patrol3\BEST1version\History. This directory serves as a repository until the data is transferred to the Gateway Server computer.

    • Verification steps for Linux:

      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 this command to verify that the General Manager service is running:
        telnet <GW_server_hostname> 10129
      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. Change to the non-root user.
        2. Run the following commands:
          • For the Korn or Bourne shell:
            1. BEST1_HOME=usr/adm/best1_<version>
            2. 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 Mar 15 00:06:00 2017 Agent Query Request Starting(/usr/adm/best1_10.7.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. 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... Tue Mar 14 22:30:04 2017 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 ... Tue Mar 14 22:35:50 2017 Agent Query Request Starting(/usr/adm/best1_10.7.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 Mar-14-2017.22.30/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.

To perform a custom installation of the Gateway Server

  1. Log in to the computer where you want to install the Gateway Server.
    • (Windows) Log in as a user with administrator privileges.
    • (Linux) Log in as the root user or as a non-privileged TSCO Gateway Server Installation Owner user account.
  2. Extract the Gateway Server installer files to a temporary directory.
    • (Windows) Extract TSCO_GatewayServer_<version>_MSwindows.zip
    • (Linux) Run this command: tar -xvf TSCO_GatewayServer_<version>_Linux.tar
  3. (Linux) Set the DISPLAY environment variable to ensure that the wizard-based installer launches the screens appropriately:
    export DISPLAY=<IP address of the computer>:0.0
  4. Run the installer:
    • (Windows) Run setup.exe from the windows_gateway_server directory.
    • (Linux) As a non-root user, run setup.sh from the linux_x86_console directory.
  5. Review the welcome page, and click Next.
  6. Read the license agreement, agree to the terms, and click Next.
  7. Ensure that the Gateway Server component is selected for installation, and click Next.
  8. Select Custom (configure advanced features), and click Next.
  9. Retain the default installation directory path, or change it, and then click Next. Ensure that this directory has sufficient storage space.
    (Windows)     C:\Program Files\BMC Software\Patrol3(Linux) /opt/bmc/Patrol3
  10. Select HTTP or HTTPS, and click Next. The default selection is HTTPS, which enables TLS for secure communication between the Gateway Server and the Application Server.
  11. If you selected HTTPS in the previous step, provide the following details of the Application Server to retrieve its server certificate, and click Next:
    • The host name and port number
    • The administrator user name and password
      When you click Next, the specified Application Server details are validated.
  12. Select one of the following security levels, and click Next.
    • Basic: Maintains network communication between the Gateway Server and Capacity Agents.
    • Advanced: Disables network communication between the Gateway Server and Capacity Agents. Use this security level when you want to initiate secure agent data collection. Go to Step 14.
  2. (Linux) Type the non-root user name you want to use for running the Gateway Server, and click Next. By default, the logged-in user name is displayed.
  3. If you selected Basic in the previous step, configure the following parameters, and click Next.
    • Service Daemon: Type the port number to be used by the service daemon. The default port is 10128.
    • Capacity Optimization Agent. Type the port number to be used by the Capacity Agent. The default port is 6767.
    • Status Reporting: Type the port number to be used for status reporting. The default port is 6768.
    • Gateway Server: Type the port number to be used by the Gateway Server. The default port is 10129.
    • History Data Repository: Retain the default directory path to save the historical data or type the directory path of your choice.
    • (Linux) Collect Data Repository: Retain the default directory path to save the collected data temporarily or type the directory path of your choice.
    • (Linux) Service Daemon installation directory: Retain the default directory path where the service daemon is installed or type the directory path of your choice.
    • Enable collection of historical data: Specify whether you want to collect historical data. By default, the historical data is collected.
    • Set TrueSight Capacity Optimization Agent to start automatically: Specify whether you want to start the Capacity Agent immediately after installation. By default, the Agent does not start after installation.
    • (Linux) Create Default Link: Specify whether you want to create the usr/adm/best1_default link to identify the current installation. By default, the link is created.
    • Maximum process command length to collect: Select the maximum length (in bytes) of the process command that the Capacity Agent must collect. The default value is 2048.
    • (Linux) Specify whether you want to run the service daemon (bgssd.exe) in the standalone mode. By default, the service daemon is configured to run by using the inetd or xinetd service.
  2. Select one of the following options if you have PATROL Agent installed:
    • Configure PATROL Agent to use the new TrueSight Capacity Optimization data collector being installed.
    • Configure PATROL Agent to use the existing TrueSight Capacity Optimization data collector.
    • Do not configure PATROL Agent to use the TrueSight Capacity Optimization data collector.
  2. Select a network protocol, and click Next.network_configuration.png
  3. Review the installation details, and click Install.
    A message confirming the completion of installation process is displayed.
  4. Click View log to view the installation log details on the screen.
  5. Click Done to exit the installation program.

  6. (Linux) Run the following command as a root user to configure the embedded Capacity Agent:

    1. Change to the root user.
    2. Change to the installation directory. The default is /opt/bmc/Patrol3.
    3. Run the following command:
      ./b1config<version>.sh

    where version indicates the version of the installed product component.

  7. Verify that the installation is successful:
    • Verification steps for Windows:
      To verify the installation of the embedded Capacity Agent
      1. On the computer where the Gateway Server is installed, click Start > Settings > Control Panel.
      2. Double-click PATROL - Perform Agent.
      3. Verify that the status of the BGS_SDService service daemon is Running.
      To verify the installation of the environment variables
      1. Open the command prompt, and run the following command:
        echo %best1_home%
      2. Ensure that the following installation location is displayed:
        C:\Program Files\BMC Software\Patrol3\BEST1\NTC
      To verify data collection
      To verify that the Gateway Server collects data from the embedded Capacity Agent and the Agents that are installed on other computers, do the following:
      1. Click Start > All Programs > BMC Software > Gateway Server > Collect Data.
      2. Click Start a collect process on a Console or Agent computer, and click Next.
      3. Select one of the following collection modes, and click Next.
        • Standard Mode: Transfers the collected data across a network from the target computers to the Gateway Server.
        • Secure Mode: Transfers the collected data locally.
        • Collect from a policy file: Transfers data from the computer names that are defined in a text file.
      1. If you selected Collect from a policy file, select the policy file, and click Next. You are directed to Step f.
      2. Specify one the following options to add the computers from which you want to collect data, and click Next.
        • Agent computers or network address: Type the names (host names or fully qualified domain names) or IP addresses of the computers on which you have installed Capacity Agents. Separate names with a comma (,). If this field is left blank, data collection starts from the embedded Capacity Agent.
        • Optional name of Agent computer: Type the name of computer where the agent is installed. If the computer has identification other than its network name, type that name. For example, a computer with the network name 1on_subnet5 might be a mail server with an internal name emailC. The specified name appears as a directory name where the collected data is stored. For example, C:\Program Files\BMC Software\BEST1\NTC\History\emailC. The specified name appears as a directory name where the collected data is stored. For example, C:\Program Files\BMC Software\BEST1\NTC\History\emailC.
          If this field is left blank, the folder name in the collection repository takes the network name. For example, C:\Program Files\BMC Software\BEST1\NTC\History\1on_subnet5.
        • File with list of computers to collect: Specify the text file that contains the agent computer names from which you want to collect data.
      1. Type the path of the data collection directory on the agent and Gateway Server computers, and click Next.
        • Repository on the Console: Select the path to the data collection directory on the computer where the Gateway Server is installed.
        • Repository on the Agent: Select the path to the temporary repository on the computer where the agent is installed.
        • Select the action that must start after the data collection wizard is exited.
      1. Select the frequency for collecting and summarizing data, and click Next.
        • Collect data every: Specify the frequency at which the data collector must place the collected data in the memory. The default value is 10 seconds.
        • Summarize data every: Select the interval, in minutes, at which the Capacity Agent summarizes data and saves it in the repository.
      2. Specify one of the following data collection schedules, and click Next.
        • Begin immediately: Begins collection immediately after existing the wizard and stops after 24 hours.
        • Begin: Begins collection after the specified time and ends after the specified duration.
        • Begin and end by date and time: Starts and ends collection on the specified dates and at the specified times.
      2. Review the settings and click Finish.
      3. When the collection duration ends, confirm that the correct files are created and transferred from the agent computers to the Gateway Server computer in the following formats:
        • repository\computerName\date.time\type-of-stats\raw.udr
        • repository\computerName\date.time\type-of-stats\raw.lox
          (The default repository on the Gateway Server computer is C:\Program Files\BMC Software\Patrol3\NTC\history).
          The temporary default repository on the agent computer is C:\Program Files\BMC Software\Patrol3\BEST1version\History. This directory serves as a repository until the data is transferred to the Gateway Server computer.
    • Verification steps for Linux:
      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 this command to verify that the General Manager service is running:
        telnet <GW_server_hostname> 10129
      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. Change to the non-root user.
        2. Run the following commands:
          • For the Korn or Bourne shell:
            1. BEST1_HOME=usr/adm/best1_<version>
            2. 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 Mar 15 00:06:00 2017 Agent Query Request Starting(/usr/adm/best1_10.7.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. 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... Tue Mar 14 22:30:04 2017 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 ... Tue Mar 14 22:35:50 2017 Agent Query Request Starting(/usr/adm/best1_10.7.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 Mar-14-2017.22.30/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.

Next step in the Installation process

Now that you have successfully installed the Gateway Server, you must install the Capacity Agents.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*