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 21.02. Open link

Configuring PATROL Agents to support a forward proxy server

This topic provides instructions to configure a PATROL Agent to communicate with the 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 to create an additional layer of security. Setting up a proxy server is optional. To understand how to create a proxy server as a docker container, see Installing a Squid proxy server.



Note

You can configure a PATROL Agent for the forward proxy support only on Windows and Linux operating systems.



PATROL Agent uses the following variables to configure the proxy server:

  • /AgentSetup/integration/forwardProxyServer
  • /AgentSetup/integration/forwardProxyUser
  • /SecureStore/mca/tenant/forwardProxyPassword

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

  • During the installation of PATROL Agents

  • After the installation of PATROL Agents

To configure the proxy server during the installation of PATROL Agents

While installing a PATROL Agent, you can provide the proxy server details in the RunSilentInstall install command as shown in the following example:

RunSilentInstall.exe -apikey=a3908418-a963-4e3b-91d1-0664eaf73217 -forwardProxyServer=proxyServer.bmc.com:3128 -forwardProxyUser=user1 -forwardProxyPassword=user123

 For more information, see Installing PATROL Agents.

To configure the proxy server after the installation of PATROL Agents

After a PATROL Agent is installed, provide the proxy server details by configuring the following variables using the pconfig utility:

  • /AgentSetup/integration/forwardProxyServer

  • /AgentSetup/integration/forwardProxyUser

  • /SecureStore/mca/tenant/forwardProxyPassword

The following example shows how to set these configuration variables:

PATROL_CONFIG "/AgentSetup/integration/forwardProxyServer" = {REPLACE = "proxyServer.bmc.com:3128"}
PATROL_CONFIG "/AgentSetup/integration/forwardProxyUser" = {REPLACE = "user1"}
PATROL_CONFIG "/SecureStore/mca/tenant/forwardProxyPassword" = {REPLACE = "MCA/user123"}

Note: Restart the PATROL Agent for the forwardProxyPassword changes to take effect.

For more information about the pconfig utility, see Using the pconfig utility to modify PATROL Agent configuration variables.


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

Comments

  1. Peng Li

    There is a spelling error, the  "forwardProxyPasswd should be "forwardProxyPassword"

    Jul 12, 2021 12:50
    1. Shreya Gurukiran

      Hi Peng Li,

      We confirmed with our SMEs. This does not seem to be a spelling error. 'forwardProxyPasswd' is the correct variable name. Hence, closing the comment.

      Regards,

      Shreya


      Jul 13, 2021 06:54
      1. Peng Li

        C:\Temp\Predefined_Package_For_Windows_x64\bmc_products>RunSilentInstall.exe -help

        BMC TrueSight OM PATROL installer:

        Usage: RunSilentInstall.exe [ -version ] [ -license ] [ -no_restart ] [ -validate ] [ -log_path= ] [ -apikey= ] [-forwardProxyServer=] [-forwardProxyUser=] [-forwardProxyPassword=] [ -publish_host_name= ] [ -closeResults ]

        -version: report the version of the utility -license: report the EULA license file -closeResults: Allow execution without prompting the user for install confirmation. -log_path: Directory path where the files RunSilentInstall logging files will be generated. -no_backup: Disable backup while upgrading PatrolAgent. -no_restart: running patrol agents will not be restarted -validate: Allow user to perform validation of stored credentials. -apikey: API key for connecting to the TrueSight server -forwardProxyPassword: PROXY Server password -forwardProxyServer: PROXY Server hostname -forwardProxyUser: PROXY Server username -publish_host_name: host name that will be displayed in the TrueSight server Press any key to exit...

        Jul 25, 2021 08:06
        1. Peng Li

          -bash-4.2$ curl -k -X GET -H "Accept: application/octet-stream" -H "Authorization:apiKey d252e151-cba5-4af0-85f4-ccf62c7cf1ab" https://delta-poc-ca1.onbmc.com:443/tsws/api/v1.0/files?packagename=Predefined_Package_For_Linux_x64 > Predefined_Package_For_Linux_x64.tar.gz && tar xpf Predefined_Package_For_Linux_x64.tar.gz && cd bmc_products && ./RunSilentInstall.sh -apikey=d252e151-cba5-4af0-85f4-ccf62c7cf1ab -forwardProxyServer=ubuntu.bmc.localdomain:3129 -forwardProxyUser=testuser -forwardProxyPasswd=bmcAdm1n; % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 100 102M 0 102M 0 0 213k 0 --:--:-- 0:08:11 --:--:-- 230k ERROR! Arguments: -forwardProxyPasswd is not valid.

          Jul 25, 2021 08:08
          1. Shreya Gurukiran

            Hi Peng Li,

            Thanks for your feedback. Closing this comment as it is now fixed.

            Regards,

            Shreya

            Sep 02, 2021 12:56