Diagnostic commands

This section provides details on commands for getting diagnostic information about the HCL Traveler server.

DumpDoc

This tell command copies a document from the specified database to Dumpdoc.nsf stored in the traveler log directory. The dumpdoc.nsf can then be uploaded to Support for investigating problems with a specific document.

DumpDoc <doc#> <user> - Dumps a document based on its GUID (UNID of document) or noteId from the user mail database. <user> can be any unique user identifier or MailServer!!Mailpath.

Dump `user`

The Dump command dumps the user metadata to a dump file in the HCL Traveler log directory under /dumps. The name of the file is in the format [User CN Name]_YYYYMMDD.HHMMSS.log. These files are useful for users who are having problems with data not arriving at their devices or users who are missing documents. The metadata is mainly the mapping tables between the Domino® UNID of the documents that are synced with the device identifiers for the same document. There is no real data (for example, no document data, no body, and no subjects) dumped in the file. The following is an example of a dump for a document:

LGUID: 148575     BACKEND_GUID: 886B8668148DBE98852575E100455A83  TYPE: EMail     FOLDER: 38D46BF5E8F08834852564B500129B2C
------------------------------------------------------------------------------------------
LGUID: 148575 ModTimeInGud: 1246058875 ModTimeInDevice: 1246020108 ModTimeInBe:1246020108850 FolderGudRecordId: -100 Caches: 2, 1, 1246020108 Type: 5155 Folder: 5127 Hashcode: 1598039802
  22154: Appl9C908NAT203 timeSyncInDevice: 0 time_sent:0 DeviceRecordId: null tsTaggedForSlowSync: 0 mChangeData: 0 mChangeMove: 0 mChangeRead: 1
  152752: IMEI:351880010448512 timeSyncInDevice: 0 time_sent:0 DeviceRecordId: null tsTaggedForSlowSync: 0 mChangeData: 1 mChangeMove: 0 mChangeRead: 0
------------------------------------------------------------------------------------------

Log collect

This command creates a zip file containing all existing log and HCL Traveler Java™ dump files. Additionally, all HCL Traveler configuration files, as well as any generated NSD files, are copied into the new directory. This command should be performed before contacting HCL Traveler Support. For more information, refer to Gathering log files for support.

Note: This command (for versions 8.5.3 and later) no longer deletes NTS*.log files

Support

The command tell traveler support <number> (where <number> is a properly formatted case number) performs a systemdump of all log files, collects them in one zipped file, automatically uploads (FTP) the output from the log collect to HCL Support under the designated case number.

Note: If you have already performed a systemdump and have a list of file logs to send to HCL support, add [log file list] to the command:

tell traveler support <number> [log file list]

Where

[log
            file list]

is a list of your log files to upload. In this case, the command will not perform a systemdump of log files and collect them, rather it will only upload the files defined by [log file list] to HCL Support under the designated case number. For more than one file, you must separate them with a space and place the "\" character on either side of each filename.

SystemDump <options>

This is a non-disruptive command that provides a current snapshot of the HCL Traveler system. The current system information is dumped to a dump file in the HCL Traveler log directory under /dumps, along with a Java™ dump that is stored in the IBM_TECHNICAL_SUPPORT directory. Perform this command before contacting HCL Traveler Support.

For a full list of options, issue the tell traveler systemdump help command. The options indicate what categories of data are to be collected. When specified without any options, the command is issued with a default set of options. You can see the default set at the top of the resulting systemdump log. If a specific set of options is specified (comma separated), only the diagnostic data associated with those options is generated. By using a - or +, you can get a systemdump with the default options plus or minus the listed option. For example, to request that an NSD also be captured, issue the command: tell traveler systemdump +nsd.