IBM Support

How to configure web server plug-in settings in WebSphere Proxy Server?

Question & Answer


Question

The WebSphere Proxy Server creates a web server plug-in config file every time it is started or stopped. How can I configure the plug-in settings that will appear in the plugin-cfg.xml file created by WebSphere Proxy Server?

Answer

If you are using a web server (for example, IBM HTTP Server) and plug-in as a front-end for WebSphere Application Server like this:

Browser --> IBM HTTP Server/Plug-in --> WebSphere Application Server

Then, do not use the instructions in this technote. Instead you should refer to the following page in the Information Center, Web server plug-in properties.

If you are using a web server (for example, IBM HTTP Server) and plug-in as a front-end for WebSphere Proxy Server like this:

Browser --> IBM HTTP Server/Plug-in --> WebSphere Proxy Server --> WebSphere Application Server

Then yes, you should use the instructions in this technote. And also see this page in the Information Center, Routing requests from a plug-in to a proxy server.

When the plug-in is routing to a WebSphere Proxy Server, you need to use the plugin-cfg.xml file that is created by the WebSphere Proxy Server.

  1. Unmap the application modules from the web server, and enable them to use WebSphere Proxy Server instead, like this: Applications > Application Types > app_name > Manage Modules

  2. Select all of the modules and map them to only the application server or cluster where they run. If they are mapped to the web server (for example, webserver1), you will need to remap them so that they are no longer mapped to the web server.

  3. Click OK and Save.

  4. Click on the web_module_name > Web Module Proxy Configuration and check the Enable Proxy box. Click OK and Save.

  5. Enable plug-in generation within the WebSphere Proxy Server settings like this:

    Servers > Server Types > WebSphere proxy servers > proxy_name > HTTP Proxy Server Settings > Proxy settings

  6. Locate the Generate Plug-in Configuration drop-down menu, and select Cell. Click OK and Save.

    If you are using a cluster of WebSphere Proxy Servers you will find the Proxy Settings here instead:

    Clusters > Proxy server clusters > cluster_name > HTTP Proxy Server Settings > Proxy settings

  7. Set the Generate Plug-in Configuration drop-down to Cell. Click OK and Save.

Now you should notice that every time the WebSphere Proxy Server is started or stopped it will create a plugin-cfg.xml file in the {WAS_ROOT}/profiles/profilename/etc directory. If you hand edit the settings in this file, it will just get overwritten the next time the WebSphere Proxy Server is stopped or started.

In order to make permanent changes to the plugin-cfg.xml file, created by WebSphere Proxy Server, you must configure them as JVM Custom Properties in the Process Definition of the WebSphere Proxy Server, like this: Servers > Server Types > WebSphere proxy servers > proxy_name > Java and Process Management > Process Definition > Java Virtual Machine > Custom properties

Here is a list of some of the plug-in related properties you can use:

PropertyDescription
com.ibm.ws.odr.plugincfg.log.Namefull path and filename to use for Plug-in file
com.ibm.ws.odr.plugincfg.log.LogLevelLogLevel setting for Plug-in
com.ibm.ws.odr.plugincfg.property.https.keyringfull path and filename for Plug-in keystore (for example, plugin-key.kdb) file
com.ibm.ws.odr.plugincfg.property.https.stashfilefull path and filename for Plug-in stash (for example, plugin-key.sth) file

For a more complete list of plug-in related custom properties, see these pages

After adding the Custom Properties, click OK and Save. If using a Proxy Server Cluster, you will need to add the same custom properties in all of the WebSphere Proxy Servers in the Cluster.

Finally, stop / restart the WebSphere Proxy Server (or Proxy Cluster) and look for the newly created plugin-cfg.xml file in the {WAS_ROOT}/profiles/profile_name/etc directory. You need to manually copy this file to the appropriate directory on the web server system.

Related Information

[{"Product":{"code":"SSEQTP","label":"WebSphere Application Server"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Proxy server","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"7.0","Edition":"","Line of Business":{"code":"LOB15","label":"Integration"}}]

Document Information

Modified date:
15 June 2018

UID

swg21470435