Enabling a proxy server using physical hostnames or IP addresses

When you set up your proxy server, on each client accessing the cluster, you create and maintain a proxy.conf file that maps the IBM® Spectrum Symphony management hostnames or IP addresses to the proxy server, allowing a client to discover the management hosts to which to connect. If your hosts are fairly static (that is, do not change frequently), you can use their actual physical actual hostnames and IP addresses.

About this task

If the hostnames or addresses do change, ensure that you also change the proxy.conf file on each client.

If your hosts change frequently, consider using virtual hostnames and IP addresses instead.

Procedure

  1. Create a proxy server configuration file, called proxy.conf, with the proxy server host information (with a fixed hostname or IP address) and information for each IBM Spectrum Symphony management host (with the actual physical host name or IP address of each host).
    For example, with the following configuration in the proxy.conf file, IBM Spectrum Symphony packages are sent to the proxy server (proxyHost) instead of to the IBM Spectrum Symphony hosts (named symHost1 and symHost2):
    #VEMKD
    proxyHost:7870 symHost1:7870
    proxyHost:9870 symHost2:7870
    
    #EGO_SERVICE_CONTROLLER
    proxyHost:7872 symHost1:7872
    proxyHost:9872 symHost2:7872
    
    #RS
    proxyHost:7873 symHost1:7873 
    proxyHost:9873 symHost2:7873 
    
    #SD
    proxyHost:7874 symHost1:7874
    proxyHost:9874 symHost2:7874
    proxyHost:7875 symHost1:7875
    proxyHost:9875 symHost2:7875
    
    #SSM
    proxyHost:31000-32000 symHost1:31000-32000
    proxyHost:41000-42000 symHost2:31000-32000

    Note that the lines prefixed with a # symbol are comments for informational purposes only. If you include comments, add them on a separate line.

  2. Copy your proxy.conf file to the EGO_CONFDIR directory on the client.
    Important: Do not copy the proxy.conf file to the EGO_CONFDIR directory on the cluster. If you do, the changes impact the whole cluster.
    Tip: If you want to load proxy.conf from a specific location, set the PROXY_PATH environment variable to the desired directory by using the setSymEnvclient client API. If PROXY_PATH is not set, the proxy.conf file is loaded from EGO_CONFDIR.
  3. Optional: Configure error detection for the proxy.conf file:
    1. Switch to the following directory:
      • Windows: Installation_top\soam\conf (or %SOAM_HOME%\conf)
      • Linux®: $EGO_TOP/soam/conf (or $SOAM_HOME/conf)
    2. Change the log level in cli.log4j.properties to ALL.
    3. Run the soamview app command for the changes to test for errors.

      If there are errors, check your proxy.conf file and try again.

      If IBM Spectrum Symphony cannot find the proxy server information in proxy.conf, it sends network packages to the IBM Spectrum Symphony cluster hosts directly. No error is reported.

What to do next

If the management host hostnames or IP addresses specified in your proxy.conf file change over time, ensure that you also change the proxy.conf file to reflect the changes.

If you require disabling the proxy server, remove the proxy.conf file from the EGO_CONFDIR directory on the client.