IBM Support

WebSphere Application Server Configuration Comparison Tool

Question/Answer


Question

How to check multiple server and resource configurations to:

  • check for potential inconsistent behavior between application servers in a cluster.
  • check for configuration creep.
  • check for migration of configuration from version to version.

 

Important Note:  The WebSphere Application Server Configuration Comparison Tool is published "as is."  Please do not open a Case or PMR for tool usage issues.  Best effort support can be obtained via the question and answer section of this document. 

Cause

Manually configured application servers and resources are likely to have configuration differences. Finding these differences by navigating to configuration panels is error prone and time consuming. Applications servers and resources should be periodically checked for configuration differences.

Answer

The Configuration Comparison Tool (CCT) is a lightweight wsadmin script and Python report generation script which will produce HTML reports on configuration settings for the following types of resources.

  • Application Servers
  • Node Agents
  • Global Security configuration (not Domain Security)
  • SSL Configurations
  • Data Sources
  • J2C Resource Adapters
  • JDBC Drivers
  • Object Cache instances
  • Servlet Cache instances
  • Service Integration Bus instances
  • Resource Environment Providers
  • Resource Environment Entries

 

CCT usage scenarios:

  • Isolating configuration creep: Periodic configuration snapshots can be gathered and archived. These can be used to see what configuration changes that have been made over time.
  • Troubleshooting inconsistent cluster member configuration: Servers and node/server specific resource configuration anomalies can causes unexpected runtime behavior from different servers within a cluster.
  • Assisting in migration to a new version of WebSphere: Cross version configuration reports can help ensure a complete migration of server and resource settings.

 

Download tool: cct-20181229.tar_0.gz

Important note: For users of this tool prior to June 2018, see the "Properties file considerations" in the WAS_Configuration_Comparison_Tool.pdf presentation for important information on how loading properties has changed.

Tar File Contents:

  • WAS_Configuration_Comparison_Tool.ppt - Tool documentation.
  • ConfigDump.py - Script to acquire cell and standalone configurations.
  • ConfigReport.py - Script to generate server and resource reports.
  • ConfigUtils.py, WAuJ.py, WAuJ_utilities.py - Scripts supporting ConfigDump.py and ConfigReport.py.
  • ConfigReport.properties - Sample properties file for report generation.
  • ConfigReportAttributes.properties - Properties file defining configuration attributes to include in reports, modify with care.

 

Change history:

  • January 17th, 2018
    • Initial publication
  • January 19th, 2018
    • ConfigDump.py on Windows systems that do not have a Unix shell (sh) will fail. Added messages documenting a workaround.
    • Updated PDF presentation with ConfigReport.py prerequisites and syntax.
  • May 27th, 2018
    • Added a report key at the top of all report documenting values in match column and cell background colors.
    • Added capability to replace a string with another value or a regular expression for the purposes of matching.
    • Cell, node and server names are replaced with .* by default for matching purposes.
  • June 2nd, 2018
    • New report properties file processing introduced.
    • Individual report properties may be set on the command line.
    • Reports may be abbreviated to attributes that have differences only.
    • A node agent report was added.
    • Thread Pool Manager and all thread pools are now reported.
  • June 17th, 2018
    • Added ability to compare all SSL configurations, not just cell defaults.
    • Enhanced Resources report to compare SSL configurations by the same name automatically.
    • Added cipher report to compare which ciphers may be inconsistent between SSL configs.
    • Updated ConfigDump.py to explicitly gather configuration data for all SSL configurations. Configuration dumps done with prior versions of ConfigDump.py may not pick up all SSL configurations.
    • Enhanced Cell Summary report to list all SSL Configuration aliases and scopes.
    • Corrected a bug which broke individual JVM argument comparisons.
  • August 2, 2018
    • Corrected issue in ConfigDump.py preventing it from running. 
    • Accounted for configuration anomalies with incomplete and orphaned variable substitution entries.
    • Corrected path separator issue on Linux for report generation.
  • August 3, 2018
    • Resource Environment Provider reports.
    • Resource Environment Entry reports.
  • October 31, 2018
    • Corrected character truncation for generic JVM arguments as well as extraneous characters with leading and trailing arguments. 
  • November 14, 2018
    • Added application comparison reports.
      • Built in "Applications" report that compares configurations by deployed module name.
      • User defined reports that allow comparing any applications with each other.
    • Updated documentation.
      • Reordered presentation pages.
      • Added page for installation instructions
      • Added page detailing available resource reports
      • Added page detailing built in reports. 
  • December 29th, 2018
    • Generate sample wsadmin scripts which will make configuration values consistent for resources identified in a given report. 

Document information

More support for: WebSphere Application Server

Component: Not Applicable

Software version: 7.0, 8.0, 8.5, 8.5.5, 9.0

Operating system(s): AIX, HP-UX, Linux, Solaris, Windows

Software edition: Base, Network Deployment

Reference #: 2010928

Modified date: 29 December 2018