The collector script

The collector script gathers information about your WebSphere Application Server installation and packages it in a JAR file that you can send to IBM Customer Support to assist in problem determination and analysis. The information includes logs, property files, configuration files, operating system and Java data, and prerequisite software presence and levels.

The Collector program is designed to run to completion despite errors such as files or commands not found, in order to collect as much data as possible.

Note: When reporting a problem to IBM Support Personnel, include the output from running the collector tool with the -Summary option. For more information see the parameter description below.

Product

The collector script is available in WebSphere Application Server and WebSphere Application Server Network Deployment.

Authority

To run this script, your user profile must have *ALLOBJ authority.

Syntax

The syntax of the collector script is:

collector [ -instance instance ] [ -JarOutName jarfile ]
  [ -Summary ] [ -IncludeInstalledApps ]

Parameters

The parameters of the collector script are:

• -instance
  Optional. The value instance specifies the name of the WebSphere Application Server instance for which you want to collect information. Specify this parameter if you want to collect information for an instance other than the default instance. The default value is default.

• -JarOutName
  Optional. The value jarfile specifies the fully qualified path name of the JAR file to which the collector tool writes the output. The location of the JAR file must be outside of the /QIBM/ProdData/WebAS5 directory structure for the product. By default, the script creates a JAR file in the current working directory. The format of the file name is:

  iSeriesHostName--fullyQualifiedInstancePathName-WASEnv.jar

  It is recommended that you specify the -JarOutName parameter.

  Notes:

  • If you specify a jar file name that exceeds sixty characters, it is truncated to the first sixty characters of the name.
  • The QEJBSVR user profile must have *RWX authority to the directory to contain the output jar file.

• -Summary
  Optional. If you specify this option, the script generates a summary report of the WebSphere Application Server version and fix level, in addition to information about the OS/400 release level and Java Development Kit level. The summary report is written to the display as well as to file Collector_Summary.txt in the current working directory. When you report a problem to IBM Support, include the Collector_Summary.txt file or output. When you run the collector script with the -Summary parameter, the script does not generate a JAR file.

• -IncludeInstalledApps
  Optional. By default, the installedApps directory for your instance is not included in the JAR file that the collector tool generates. Specify the -IncludeInstalledApps parameter if you want to include the installedApps directory the generated JAR file.

Examples

collector -Summary

This example generates an output file named Collector_Summary.txt in the current working directory. This file contains information on the hostname of the system, installed WebSphere Application Server level, operating system level and Java Development Kit level.

collector -JarOutName /temp/WASEnv.jar

This example collects information on the default WebSphere Application Server instance and writes the output to WASEnv.jar, which is located in /temp directory.

collector -instance testinst -JarOutName /home/myprofile/testinst_svc.jar

This example collects information on the instance testinst and writes the output to testinst_svc.jar in the /home/myprofile directory.