ARSSUPPORT utility

You can use ARSSUPPORT, a Java™ based tool that runs on your IBM® i server, to generate information about a Content Manager OnDemand instance. The information includes details about the instance configuration and system environment, and diagnostic information such as system log entries. This tool is especially helpful when you need to report problems to IBM support.

ARSSUPPORT is run every time an instance is started. It is also run both before and after a Content Manager OnDemand server version upgrade.

ARSSUPPORT archives all of the files that it generates into one compressed file named arssupport.zip. The compressed file is placed in the odsupport subdirectory of the output directory that you specify. When ARSSUPPORT is run as part of instance startup or server version upgrade, the compressed file is placed in /QIBM/UserData/OnDemand/instance/odsupport, where instance is the name of the instance for which it is run.

The ARSSUPPORT utility is delivered in the arssupport.jar file. See examples of how to run the utility in the Examples section.

Syntax

Parameters

Note: Similar to the -h parameter, help and usage information is displayed if you run ARSSUPPORT without specifying any parameters. In that case, the arssupport.zip output file is not produced.

-h: Use this parameter to display help and usage information about this tool.
-I instance: Specify the instance name to collect the instance information. If this parameter is not specified, QUSROND is used.
-l: Specify to retrieve Content Manager OnDemand system log entries. When used without the -m parameter, the log entries for the past 60 minutes are retrieved. It requires the -u and -p parameters.
-m minutes: Specify how many past minutes of the system log entries to retrieve from the Content Manager OnDemand server. The limit is 600000 minutes.
-o outputpath: Specify the output directory name. If this parameter is not specified, the output directory is the current directory.
-p password: Content Manager OnDemand password. Required if -l is specified.
-u userid: Content Manager OnDemand user ID. Required if -l is specified.
-v: Enables verbose mode.

Examples (shown as separate QSHELL commands)

To run the utility, use the QSHELL command (entered all on one line as one command from the QSHELL command prompt) on the IBM i system that is running Content Manager OnDemand. In the examples, instance is your Content Manager OnDemand instance name, admin is a system administrator user that is defined to the instance, and xxxxxxxx is the password for the system administrator user.

Example 1: In this example, collect the standard ARSSUPPORT information for the default QUSROND instance without including any system log entries. The instance server does not need to be active. The output file named arssupport.zip is placed in a directory named /directory_name/odsupport, where directory_name is the name of a directory that you specify.

java -Dfile.encoding=ISO8859_1 -cp /qibm/proddata/ondemand/support/arssupport.jar
   com/ibm/cm/od/arssupport -o /directory_name

Example 2: In this example, a user named admin with a password of xxxxxxxx is used to log on to the default QUSROND instance and collect 60 minutes of system log messages in addition to collecting the standard ARSSUPPORT output. The instance server must be active. The output file named arssupport.zip is placed in a directory named /directory_name/odsupport, where directory_name is the name of a directory that you specify.

java -Dfile.encoding=ISO8859_1 -cp /qibm/proddata/ondemand/support/arssupport.jar
   com/ibm/cm/od/arssupport -o /directory_name -l -u admin -p xxxxxxxx

Example 3: In this example, a user named admin with a password of xxxxxxxx is used to log on to the Content Manager OnDemand instance named instance and collect 30 minutes of system log messages in addition to collecting the standard ARSSUPPORT output. The instance server must be active. The output file named arssupport.zip is placed in a directory named odsupport that is created in the current directory.

java -Dfile.encoding=ISO8859_1 -cp /qibm/proddata/ondemand/support/arssupport.jar
   com/ibm/cm/od/arssupport -I instance -l -m 30 -u admin -p xxxxxxxx