Tool name:
RealmInformationCollector

Description:
Collects diagnostic information from a Universal Messaging realm server
installation and stores it in a zip archive.

Usage:
runUMTool RealmInformationCollector -mode=<mode> -instance=<instance>
[optional_args]

Examples:

RealmInformationCollector -mode=offline -instance=umserver

RealmInformationCollector -mode=offline -instance=umserver
-include=data,heapdumps

RealmInformationCollector -mode=offline -instance=*

RealmInformationCollector -mode=live -instance=umserver,umserver2
-include=heapdump

RealmInformationCollector -mode=live -instance=umserver,umserver2
-exclude=jaas,plugins

RealmInformationCollector -mode=live -instance=umserver,umserver2
-outputfile=/path/to/outputfile.zip

Required arguments:

mode : Operating mode, either 'offline' or 'live'.
The chosen mode determines what information is collected.
If 'offline' is specified, the tool will ensure that all instances to collect
information from are not running.
If 'live' is specified, the tool will ensure that all instances are running.

In live mode, certain Universal Messaging directories/files are not collected,
because reading them may cause failures on the server.
For example, if the content of the data directory is needed, it can be
collected only in offline mode.

The following collectors will be executed by default in live mode:

tanukilogs - Collects Tanuki wrapper logs of an UM server instance.

secfile - Collects the security file of an UM server instance.

installlogs - Collects SoftwareAG installer logs.

tanukiconf - Collects Tanuki wrapper configuration of an UM server
instance.

env - Collects environment information from a running UM server.

license - Collects the license file of an UM server instance.

realmconfig - Exports realm configuration from a running UM server instance.

instancemgr - Collects Universal Messaging instance manager logs.

healthchecker - Acquires health information from a running UM server instance
using UM HealthChecker tool

jaas - Collects JAAS configuration of an UM server instance.

threaddump - Generates 3 thread dumps of a running UM server instance.

plugins - Collects plugins directory of an UM server instance.

Collectors not enabled per default in live mode (need to be explicitly included):

heapdump - Acquires heap dump from a running UM server instance.
Note: This collector is not available on all platforms.

heapdumps - Collects heap dumps directory of an UM server instance.

The following collectors will be executed by default in offline mode:

tanukilogs - Collects Tanuki wrapper logs of an UM server instance.

secfile - Collects the security file of an UM server instance.

installlogs - Collects SoftwareAG installer logs.

tanukiconf - Collects Tanuki wrapper configuration of an UM server instance.

license - Collects the license file of an UM server instance.

instancemgr - Collects Universal Messaging instance manager logs.

jaas - Collects JAAS configuration of an UM server instance.

logs - Collects logs of an UM server instance.

plugins - Collects plugins directory of an UM server instance.

Collectors not enabled per default in offline mode (need to be explicitly
included):

data - Collects data directory of an UM server instance.

heapdumps - Collects heap dumps directory of an UM server instance.


instance :
Specifies a comma-separated list of realm server instance names to
collect information from. Specify '*' to include all available instances.

Optional Parameters:

outputfile :
The directory or file to write generated archive to.
If a directory is specified, it must exist.
If a file is specified and it is already present, the tool will fail.
If this argument is omitted, the tool will generate the archive in the
current working directory.

exclude :
Specifies a comma-separated list of collector names to exclude.
See 'mode' for list of available collectors.

include :
Specifies a comma-separated list of collector names to include.
See 'mode' for list of available collectors.

username :
Your Universal Messaging server username.

password :
Your Universal Messaging server password.