×
 
 
  •  
$helper.renderConfluenceMacro('{bmc-global-announcement:$space.key}')

Important

   

This documentation space contains information about PATROL Agents when deployed in a BMC Helix Operations Management environment. If you are a TrueSight Operations Management user, see PATROL Agent 23.1 Open link

BMC PATROL Agent for BMC Helix Operations Management 23.1 Installing

Installing PATROL Agents

This topic provides instructions for installing PATROL Agents.

Installing a PATROL Agent using the API Key

Step 1: Creating deployable packages

On the Administration > Repository > Deployable Packages tab, click Create, and do the following:

  1. Select the operating system and platform for which you want to create a package. The list of platforms changes according to the operating system that you select.

  2. Select one of the following PATROL Agent components, and select a version:

    • PATROL Agent for Windows
    • PATROL Agent for Unix

    If you want to install any monitoring solutions along with the PATROL Agent, select the required monitoring solutions.

  3. Specify the PATROL Agent installation directory:

    • Proceed with the default installation directory.
    • Enter a different directory for installation.

    • Leave the field blank and proceed with the installation.
      When you leave the field blank, the correct directory is automatically selected through the BMC_BASE variable.

  4. Specify the PATROL 3.x product directory and click Next.
    Follow the instructions in the Important Instructions section of the wizard.
    (UNIX only) Enter the root account password.

    Important

    Using root account might create security risks.

    If you do not want to enter the root password, leave the field blank. You must run the hostname_port_install.log_rootscripts script file post installation. For more information, see post installation steps.

  5. Enter the PATROL Agent account credentials.

  6. Enter the PATROL Agent port number.

  7. Choose to restart the PATROL agent automatically or manually, and click Next.

    Note

    If you have not provided the root credentials, do not choose to restart the PATROL Agent automatically during package creation.

  8. Specify the streaming endpoint details. This will be used for automatic registration of the PATROL Agent with BMC Helix Operations Management. Enter the details in the following format: 

    https:<IP address or FQDN of the load balancer>:<port_no>

  9. Enter a comma-separated list of tags for associating PATROL Agents to monitoring policies.
    PATROL Agents use the specified tags to get configuration details from BMC Helix Operations Management. Enter the tag name in the following format:
    <Tag Name>:<Description>
    Note: If the description contains a blank space, enclose it within double quotes.
    For example, WinOS:"Windows OS Monitoring"

  10. Choose if you want to manage the PATROL Agent configuration via a monitoring policy, and click Next.

  11. Configure the firewall settings.
    You can choose to automatically add the components to the firewall exception list.

    Note

    Ensure that you enable the outbound connection to the default port 443 for HTTPS communication between PATROL Agent and BMC Helix Operations Management.

  12. Review the package details.

  13. Enter a name and an optional description for the package.
    The description is displayed when the packages are listed in the Deployable Packages tab.

  14. Select the package file format. 

  15. Save the deployable package.

  16. Select one of the following:

    • Save: Save the package for future installation on the current host or other hosts.
    • Save and Download: Save and download the package and note the downloaded package location. You will need the downloaded package location details while deploying the package.
    • Close: Cancel the package creation and go back to the Administration > Repository page.
Step 2: Downloading deployable packages

On the Administration > Repository > Deployable Packages tab, do the following:

  1. Click the Download  icon next to a package.
  2. From the package menu, select Download, and note the location. You will need this information while performing Step 3.
  3. On the Administration > Repository > Deployable Packages page, click Copy API Key and note the information. You will need this information while performing Step 3. 
Step 3: Deploying packages
  1. Log in to the host computer on which you plan to install the PATROL Agent.
  2. Copy the API key that you saved in Step 2 to a temporary text file.
  3. Copy the package that you downloaded in Step 2 to a temporary directory.
  4. Extract the package. It is extracted to the <PA_EXTRACTED_PACKAGE>\bmc_products directory.

  5. From the bmc_products directory, run the following command: 

    #Syntax
RunSilentInstall.exe -apikey=<TOKEN> -proxyserver=<FQDN of the PATROL Agent forward proxy server>:<port> -proxyuser=<Proxy Username> -proxypasswd=<password for the proxy server>
 
#Example 1 - Install with API key and forward proxy server option
RunSilentInstall.exe -apikey=a1236789-123f-1d23-12d4-1234abc12345 -forwardProxyServer=proxyServer.bmc.com:3128


#Example 2 - Install with API key and forward proxy server options that include forward proxy credentials
RunSilentInstall.exe -apikey=a1236789-123f-1d23-12d4-1234abc12345 -forwardProxyServer=http://proxyServer1.bmc.com:3128 -forwardProxyUser=user2 -forwardProxyPasswd=user456


#Example 3 - Install with API key and without forward proxy server options
RunSilentInstall.exe -apikey=a1236789-123f-1d23-12d4-1234abc12345

    Note

    API key

    PATROL Agents use the API key to encrypt message requests sent to BMC Helix Operations Management. You can set the API key in one of the following ways:

    • During the installation of PATROL Agents: As explained in the preceding example, provide the API key details when you run the RunSilentInstall command.

    • After the installation of PATROL Agents: You can update the API key after the installation. For details, see Support for HTTP communication.

    PATROL Agent forward proxy server

    You can set up a proxy server in your infrastructure environment so that PATROL Agents can communicate with BMC Helix Operations Management via the proxy server. Setting up a proxy server is optional.

    You can configure the proxy server details in one of the following ways:

    • During the installation of PATROL Agents: As explained in the preceding example, provide the proxy server details, user name, and password when you run the RunSilentInstall command.

    • After the installation of PATROL Agents: You can configure the forward proxy server details in the PATROL Agent after the installation. For details, see Configuring PATROL Agents to support a forward proxy server.

  6. Review the log file to check the installation status.

Installing the PATROL Agent using the Copy Install Script option

  1. From the predefined or custom package Actions menu, select Copy Install Script.
    Default predefined packages:
    • (Microsoft Windows) Predefined_Package_For_Windows_x64
    • (Linux) Predefined_Package_For_Linux_x64
    Note: If you plan to run the copy install script using a custom package, ensure that the package includes the PATROL Agent component.
  2. Log in to the host computer on which you want to deploy the package, and create a new PATROL Agent user.
  3. In the home directory of the new user, create a directory.
  4. Provide read/write/execution permission to the PATROL user for the directory.
  5. Paste and run the install script in this directory. For pre-defined packages, the default directory is:
    (Microsoft Windows) <installation_directory>\BMC Software
    (Linux) /opt/bmc
  6. Provide the following information when prompted:
    • (Linux) Root login name and password
    • PATROL default account login name and password
  7. (Linux) In the directory that has read/write/execute permission for the PATROL user, paste and run the install script.
  8. (Microsoft Windows) Open the Windows PowerShell, paste and run the install script.

(UNIX only) Post upgrade/installation steps — Run hostname__install.log_rootscripts

When deploying the package silently, if you did not enter the root password, you must run the <hostname>_<port>_install.log_rootscripts script and make some other minor modifications. 

  1. Stop the PATROL Agent process if it is running:
    For more information, see Starting and stopping the PATROL Agent.
  2. Navigate to the unpacked installation files directory:
         cd <installation_directory>/log/<date_time_of_install>_install/
         Example: /opt/bmc/log/2021_07_08_05_57_59_install/
  3. Switch to the root user by using the following command and entering the root password:
         su
  4. As root user, rename the <hostname>_<port>_install.log_rootscripts file to <hostname>_<port>_install.log_rootscripts.sh by running the following command:
         mv <hostname>_<port>_install.log_rootscripts <hostname>_<port>_install.log_rootscripts.sh
         Example: mv myhostname_3181_install.log_rootscripts myhostname_3181_install.log_rootscripts.sh
  5. As root user, assign the permissions to run the <hostname>_<port>_install.log_rootscripts.sh file:
          chmod 755 <hostname>_<port>_install.log_rootscripts.sh
          Example: chmod 755 myhostname_3181_install.log_rootscripts.sh
  6. As root user, run <hostname>_<port>_install.log_rootscripts.sh:
         ./<hostname>_<port>_install.log_rootscripts.sh
           Example: ./myhostname_3181_install.log_rootscripts.sh
  7. Run patrolrc.sh to load environment variables:
    1. Navigate to Patrol3 directory:
      cd <installation_directory>/Patrol3
      Example: cd /opt/bmc/Patrol3
    2. Run patrolrc.sh:
      . ./patrolrc.sh
  8. Navigate to the Patrol Agent’s bin directory and run migrate_kdb_password.sh:
    1. Navigate to the Patrol bin directory:
      cd $PATROL_HOME/bin
    2.  Run the migrate_kdb_password.sh script:
      ./migrate_kdb_password.sh

  9. Verify the PatrolAgent/snmpmagt binaries are owned by the root account and that the sticky bit is set:
          ls -tl PatrolAgent
    The following output is displayed:
          -rws r-xr-x 1 root patrol 12641000 Feb 10 10:39 PatrolAgent
     The s indicates the sticky bit is set successfully on the PatrolAgent binary. (Same for the snmpmagt binary, if present.)

    Learn more about the sticky bit Open link

  10. Ensure the access file is owned by the default account:
      sudo chown <default_account>:<default_account> <install_directory>/common/security/keys/access
          Example: sudo chown patrol:patrol /opt/bmc/common/security/keys/access
  11. As the default account, start the PATROL Agent.
     For more information, see Starting and stopping the PATROL Agent . Open link
Was this page helpful? Yes No Submitting... Thank you
Last modified by Ashwini Shirsath on Apr 17, 2024

Comments

  1. Betty Neumann

    users are opening cases for the documentation and the format of the new API Keys - can we update the doc? The documentation of how to load PATROL agents onto 23.1 BHOM Tenant.
    Installing PATROL Agents does not reflect the updated API Key format:

    The format of apikey has changed in the command
    RunSilentInstall.exe -apikey=a3908418-a963-4e3b-91d1-0664eaf73217

    The old method was to use the BHOM->Administration->Repository->API_KEY and essentially insert it into the RunSilentInstall.exe command, or after installation, to add it manually to the opendatagateway.current file on the PATROL host.
    The Old api_key was in the format: 84a14846-d6e7-4a7a-9369-e697972f0284

    The New 23.1 api_key is in the format: 735207751::B1OJN5I12OYVKOSVQLOG2NMU6QMK93::9ESHHKbG3IOXPrKjLSJz8q5rZ2hWyYjaBycSYKcWKaUWdmPUfV

    Mar 17, 2023 05:05
  2. Muhammad Aliff Muazzam Jaafar

    Hi BMC,

    Please note that link to the (post installation steps) [https://docs.bmc.com/docs/display/HMPAMaster/.Installing+PATROL+Agents+v23.1.00#id-.InstallingPATROLAgentsv23.1.00-PAUNIX] is broken.

    Page Not Found.

    Please fix it

    Apr 16, 2024 09:37
    1. Ashwini Shirsath

      Hi Muhammad Aliff Muazzam Jaafar,

      Thank you for bringing this to our notice.

      We fixed the broken link.

      Thank you,
      Ashwini

      Apr 17, 2024 06:45

Log in or register to comment.

Installing
Configuring after installation
© Copyright 2014 - 2023 BMC Software, Inc.
Legal notices

Powered by Atlassian Confluence and Scroll Viewport

© Copyright 2005-2024 BMC Software, Inc. Use of this site signifies your acceptance of BMC’s Terms of Use . BMC, the BMC logo, and other BMC marks are assets of BMC Software, Inc. These trademarks are registered and may be registered in the U.S. and in other countries.