This topic provides a more detailed look at some key IBM
® Lotus Notes
® Traveler Tell commands: Delete
, Log collect
, Mem Show
, Stat Show
, and SystemDump
Delete user versus Reset user
These two commands perform close to the same function. They should be used as a last resort to resolve user issues with Lotus Notes
Traveler. Both commands cause devices to retrieve all of the Lotus Notes
Traveler data again, but Delete also deletes all of the user's preference information. If a forced reset of the user data is needed, use the Reset command. Both commands can be made available using the Lotus Notes
For an Apple device user, the commands may also require that the user re-enable automatic push for mail messages by selecting Settings > Mail, Contacts, Calendars > Fetch New Data
and toggling Push to OFF
and then back to ON
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
The Dump command dumps the user metadata to a dump file in the Lotus Notes
Traveler log directory under /dumps
. The name of the file is in the format [User CN Name
.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
This command creates a zip file containing all existing log and Lotus Notes
™ dump files. Additionally, all Lotus Notes
Traveler configuration files, as well as any generated NSD files, are copied into the new directory. This command should be performed before contacting Lotus Notes
This command (for versions 8.5.3 and later) no longer deletes NTS*.log
Use the Mem Show
command to determine the current memory usage for Lotus Notes
Traveler. The Lotus Notes
Traveler server is implemented as a Java Domino
server task, so it uses memory from both the Java
memory heap and native Domino
The following example shows the output of the Tell Traveler mem
command. The command shows a snapshot of the memory and processor usages over the last 24 hours in 15 minute intervals at the top of the display. Each of the intervals show an estimate of the processor usage over the 15 minute interval as well as a current snapshot of both the Java
Memory and C Native memory. This allows the administrator to see trends of the processor and memory usage over a 24 hour period. Detailed memory usage statistics follow the snapshot interval information.
CPU and Memory (MB) Usage History
Date CPU Pct Java Mem C Mem
2010-06-21 09:40:18 EDT 0.26 57 930
2010-06-21 09:55:18 EDT 0.34 78 931
2010-06-21 10:10:18 EDT 0.37 38 931
2010-06-21 10:25:20 EDT 0.45 67 931
2010-06-21 10:40:20 EDT 0.57 91 933
2010-06-21 10:55:20 EDT 0.37 60 933
2010-06-21 11:10:20 EDT 0.42 64 933
2010-06-21 11:25:20 EDT 0.38 47 934
2010-06-21 11:40:20 EDT 0.46 29 934
2010-06-21 11:55:20 EDT 0.41 38 934
2010-06-21 12:10:20 EDT 0.38 40 934
Java Memory Usage
Max Available 512 MB
Current Total 96 MB
Available 57 MB (92 percent of Max)
Allocated 38 MB (7 percent of Max)
C Memory Usage
Total 8388608 MB
Free 8387017 MB
Allocated 934 MB
Java 38 MB
C 934 MB
In this example, the Java
Virtual Machine (JVM) for Lotus Notes
Traveler has allocated only 96 MB of heap memory and 57 MB of that heap is still free. So this server is well below the maximum Java
heap limit of 512 MB. The C Mem Virtual Usage section reports the overall process memory, which includes any memory allocated by the Java
heap and all other Domino
shared memory. In this example 8388608 MB can be used for this process, and there are 8387017 MB free for further allocation. When Lotus Notes
Traveler is running on a 32-bit Domino
server (Either Windows
™ or Linux
™), the limit for the application C memory space is 2 GB by default. If this was a 64-bit Windows
server, then the maximum available memory would be 4 GB if the Domino
server code was 32-bit and higher than 4 GB if the Domino
server code was 64-bit.
The Show command provides a complete user check. The following is the key information that results from a Show command:
- The first sentence says whether Lotus Notes Traveler has access rights to the user mail file.
- The second sentence says whether the user is able to send and receive encrypted mail messages.
- The next section lists the user mail file details and mail replicas.
- The next section indicates if the user is registered with Lotus Notes Traveler. If the user is registered, there are two sections: The first shows information about the last prime sync and the second provides information about devices and when they last connected to the Lotus Notes Traveler server.
The following is an example of the results of a Show command:
Lotus Traveler has validated that it can access the database Mail/jhyoon.nsf.
Encrypting, decrypting and signing messages are enabled because the Notes ID is in the mail file or the ID vault.
Canonical name: CN=First User1/O=Topsail
Mail Server (Home): CN=Bono/O=Topsail
Mail File (Home): Mail/jhyoon.nsf
Mail Server (Current): CN=Bono/O=Topsail
Mail File (Current): Mail/jhyoon.nsf
Mail File Replicas: [CN=Bono/O=Topsail, Mail/jhyoon.nsf], [CN=Fish/O=Topsail, Mail/jhyoon.nsf], [CN=U2/O=Topsail, Mail/jhyoon.nsf], [CN=Rush/O=Topsail, Mail/jhyoon.nsf]
Notes ID: Mail File contains the Notes ID which was last updated by CN=Bono/O=Topsail on Friday, August 7, 2009 10:41:26 AM EDT.
Auto Sync User State: Online
Last Prime Synchronization: Wednesday, August 12, 2009 1:49:50 PM EDT
Device ID: BADAFCCA8F63237F790CB1DE0E70CA22455B3810
Device Description: Microsoft DeviceEmulator:PocketPC/6(5.2.1235):IBM Lotus Notes Traveler/220.127.116.11.200907271508
Security Policy Status: No policy
Security State: Clear
Last Synchronization: Wednesday, August 12, 2009 1:53:03 PM EDT
Auto Sync Device State: Online
Auto Sync Connection State: Connected (Wednesday, August 12, 2009 1:52:41 PM EDT)
Auto Sync Applications to Synchronize: mail, calendar, serviceability, security
Auto Sync Change Flags: clear
This command is useful when the Domino
administrator wants to see all of the synchronizations that are currently running on the system. The following is an example of the results of a ShowActive command:
Number of Active Users: 4
List of Active Users:
d0a2f1e312313a5d6c1f6edd7c778304e05 69824 CN=Jim User1/OU=Somewhere/O=Lotus 6CC4C7EB43518D14E61B4EF6DD3E50EF4296005E
d0a2f1e312313a90fedb2052982c5aeba5 28524 CN=Billy User2/OU=Somewhere/O=Lotus Appl9C909K08201
d0a2f1e312313a8fa62bf3a15f29de52c4e 5141 CN=Greg User3/OU=SomeWhereElse/O=Lotus A47A305E9051F74BC85830E22D8300C921DF904F
d0a2f1e312313aee5d936a53da80a9dbfa7 66978 CN=Jane User4/OU=SomeWhereFarAway/O=Lotus primesync
This command is useful when the Domino
administrator wants a complete list of users that use Lotus Notes
Traveler. It displays all users that are registered with Lotus Notes
This command is useful for a quick check of the status of the Lotus Notes
Traveler server. Stat Show dumps all of the Lotus Notes
Traveler statistics to the Domino
Console. It then provides the percentage of prime syncs and device syncs that were successful, including the average time syncs are taking. The following is an example of the results of a Stat Show command:
DB.Connections = 7
DB.Connections.Idle = 7
DB.Connections.Max = 1000
DCA.C.CheckAccessRights = 495
DCA.C.Count.NSFDbClose = 7524
DCA.C.Count.NSFDbOpen = 7525
DCA.C.Count.NSFNoteClose = 16205
DCA.C.Count.NSFNoteOpen = 16205
DCA.C.HTMLCreateConverter = 1063
DCA.C.HTMLDestroyConverter = 1062
DCA.C.ModDoc.RunCount = 4742
DCA.C.ModDoc.SkippedDocs = 1278
DCA.C.ModDoc.SyncableDocs = 11039
DCA.C.NAMELookup = 4132
DCA.C.NSFDbGetNoteInfo = 3069
DCA.CLOSE_DOCUMENT = 27422
DCA.ChangeDelayCount.000-003 = 4722
DCA.ChangeDelayCount.003-005 = 1569
DCA.ChangeDelayCount.005-010 = 598
DCA.ChangeDelayCount.010-030 = 182
DCA.ChangeDelayCount.030-060 = 63
DCA.ChangeDelayCount.060-120 = 239
DCA.ChangeDelayCount.120-Inf = 649
DCA.OPEN_DOCUMENT = 25228
DeviceSync.Bytes.In.B = 1555581
DeviceSync.Bytes.Out.B = 21509810
DeviceSync.Count.200 = 2268
DeviceSync.Count.408 = 13
DeviceSync.Count.409 = 15
DeviceSync.Count.412 = 11
DeviceSync.Count.500 = 17
DeviceSync.Documents.ToDevice.Calendar.Add = 542
DeviceSync.Documents.ToDevice.Calendar.Delete = 40
DeviceSync.Documents.ToDevice.Calendar.Update = 107
DeviceSync.Documents.ToDevice.Contacts.Add = 629
DeviceSync.Documents.ToDevice.Mail.Add = 3751
DeviceSync.Documents.ToDevice.Mail.Delete = 1712
DeviceSync.Documents.ToDevice.Mail.Update = 479
DeviceSync.Documents.ToDevice.ToDo.Add = 13
DeviceSync.Documents.ToDevice.ToDo.Delete = 1
DeviceSync.Documents.ToDevice.ToDo.Update = 9
DeviceSync.Documents.ToServer.Calendar.Add = 2
DeviceSync.Documents.ToServer.Calendar.Delete = 1
DeviceSync.Documents.ToServer.Calendar.Update = 3
DeviceSync.Documents.ToServer.Mail.Add = 24
DeviceSync.Documents.ToServer.Mail.Delete = 89
DeviceSync.Documents.ToServer.Mail.Update = 182
DeviceSync.Documents.ToServer.ToDo.Delete = 1
DeviceSync.Documents.ToServer.ToDo.Update = 2
DeviceSync.FetchCache.Add = 1760
DeviceSync.FetchCache.Expired = 878
DeviceSync.FetchCache.Missing = 652
DeviceSync.Time.200.Milliseconds = 17721648
DeviceSync.Time.408.Milliseconds = 4502543
DeviceSync.Time.409.Milliseconds = 3948921
DeviceSync.Time.412.Milliseconds = 0
DeviceSync.Time.500.Milliseconds = 0
DeviceSync.Time.Histogram.200.000-001 = 1288
DeviceSync.Time.Histogram.200.001-002 = 230
DeviceSync.Time.Histogram.200.002-005 = 192
DeviceSync.Time.Histogram.200.005-010 = 300
DeviceSync.Time.Histogram.200.010-030 = 180
DeviceSync.Time.Histogram.200.030-060 = 46
DeviceSync.Time.Histogram.200.060-120 = 11
DeviceSync.Time.Histogram.200.120-Inf = 21
DeviceSync.Time.Histogram.408.120-Inf = 10
DeviceSync.Time.Histogram.409.010-030 = 2
DeviceSync.Time.Histogram.409.060-120 = 1
DeviceSync.Time.Histogram.409.120-Inf = 12
DeviceSync.Time.Histogram.412.000-001 = 11
DeviceSync.Time.Histogram.500.000-001 = 17
Monitor.NewAPI.LoopTime = 0
Monitor.NewAPI.Users = 44
Monitor.OldAPI.LoopTime = 0
PrimeSync.Count.200 = 4735
PrimeSync.Count.500 = 60
PrimeSync.Count.Current = 0
PrimeSync.Count.InQueue = 1
PrimeSync.Time.200.Milliseconds = 7527539
PrimeSync.Time.500.Milliseconds = 155745
PrimeSync.Time.Histogram.200.000-001 = 3789
PrimeSync.Time.Histogram.200.001-002 = 504
PrimeSync.Time.Histogram.200.002-005 = 292
PrimeSync.Time.Histogram.200.005-010 = 49
PrimeSync.Time.Histogram.200.010-030 = 47
PrimeSync.Time.Histogram.200.030-060 = 34
PrimeSync.Time.Histogram.200.060-120 = 14
PrimeSync.Time.Histogram.200.120-Inf = 6
PrimeSync.Time.Histogram.500.002-005 = 60
Push.Devices.ActiveSync = 38
Push.Devices.ActiveSync.Connected = 11
Push.Devices.Online = 60
Push.Devices.SMS = 3
Push.Devices.TCP = 25
Push.Devices.TCP.Connected = 8
Push.Devices.Total = 66
Push.Received.ActiveSync = 2288
Push.Received.TCP = 1591
Push.Sent.ActiveSync = 1136
Push.Sent.SMS = 28
Push.Sent.TCP = 3668
Push.Users.Online = 44
Push.Users.Total = 47
ThreadPool.Count.Max.Alarm = 6
ThreadPool.Count.Max.DS = 9
ThreadPool.Count.Max.PS = 10
ThreadPool.Count.Max.TC = 1
ThreadPool.Count.Max.Worker = 5
ThreadPool.GetThreadDelayTime.Alarm.00-02 = 8548
ThreadPool.GetThreadDelayTime.DS.00-02 = 2483
ThreadPool.GetThreadDelayTime.PS.00-02 = 4794
ThreadPool.GetThreadDelayTime.PS.02-05 = 1
ThreadPool.GetThreadDelayTime.TC.00-02 = 12
ThreadPool.GetThreadDelayTime.Worker.00-02 = 8677
There are 47 users known to the system.
6 percent (3) of the users have been offline for more than 24 hours.
93 percent (44) of the users are online or have been within the past 24 hours.
There are 44 mailfiles currently being monitored for these online users.
The current change detection latency of these mailfiles is 0 seconds.
There are 66 devices known to the system.
4 percent (3) of the devices are registered for SMS notifications.
37 percent (25) of the devices are registered for TCP notifications.
57 percent (38) of the devices are registered for ActiveSync notifications.
9 percent (6) of the devices have been offline for more than 24 hours.
90 percent (60) of the devices are online or have been within the past 24 hours.
12 percent (8) of the devices are currently connected to the server via TCP.
16 percent (11) of the devices are currently connected to the server via ActiveSync.
There have been 4,795 prime syncs.
The average prime sync took 1,602 ms.
98 percent (4,735) of the prime syncs were successful.
The average successful prime sync took 1,589 ms.
1 percent (60) of the prime syncs failed.
The average failed prime sync took 2,595 ms.
1 percent (60) of the prime syncs ended in result 500.
The average 500 prime sync took 2,595 ms.
There are an average of 0.116 prime syncs running at any given time.
There have been 2,313 device syncs.
The average device sync took 0 ms and transferred 9,299 bytes.
98 percent (2,268) of the device syncs were successful.
The average successful device sync took 7,813.778 ms.
1 percent (45) of the device syncs failed.
The average failed device sync took 150,919.000 ms.
0 percent (13) of the device syncs ended in result 408.
The average 408 device sync took 346,349.462 ms.
0 percent (15) of the device syncs ended in result 409.
The average 409 device sync took 263,261.400 ms.
0 percent (17) of the device syncs ended in result 500.
The average 500 device sync took 0 ms.
The following list highlights the sync return codes:
- 408=Request Timeout (the device did not respond before the server timed out the session)
- 409=Conflict (the device started a new session that caused this session to be aborted)
- 500=Unknown Error
- 503=Server Busy
The histogram statistics are the number of seconds in each range for a given return code. For example, "PrimeSync.Time.Histogram.200.000-001 = 3789" indicates that there were 3789 prime synchronizations with a 200 (Successful) return code between 0 and 1 seconds. This continues up to "PrimeSync.Time.Histogram.200.120-Inf = 6," which indicates that six prime synchronizations with a 200 return code took more than 120 seconds.
Histograms are useful statistics for seeing whether syncs are taking too long, the system is overloaded, or there is a lot of network delay in the environment. If the system is running slow, the histogram statistics tend toward the larger numbers. The prime sync histogram numbers are the best to check to see how the system is performing overall. The prime synchronizations are not dependent on the carrier network delay or the device speed.
This command gives an administrator a quick look at the status of the system. The status levels are Green, Yellow, and Red. If a system is in a Yellow or Red condition, the status
command provides problem information for the administrator.
The following is an example of a Green status message:
tell traveler status
The Lotus Notes Traveler task has been running since Thu Jun 17 21:52:29 EDT 2010.
The last successful device sync was on Mon Jun 21 03:23:41 EDT 2010.
The overall status of Lotus Notes Traveler is Green.
The following is an example of a Red status message:
tell traveler status
The Lotus Notes Traveler task has been running since Tue Jun 15 17:08:37 EDT 2010.
The last successful device sync was on Mon Jun 21 06:43:01 EDT 2010.
Yellow Status Messages
The response times for opening databases on mail server CN=Mail1/O=Test are above the acceptable threshold.
The response times for opening databases on mail server CN=Mail7/O=Test are above the acceptable threshold.
Red Status Messages
17,238 errors have been logged for user CN=Joe Tester/OU=Test/O=IBM.
There have been 3,845 device sync failures for reasons other than the server is too busy.
The overall status of Lotus Notes Traveler is Red.
This is a non-disruptive command that provides a current snapshot of the Lotus Notes
Traveler system. The current system information is dumped to a dump file in the Lotus Notes
Traveler log directory under /dumps, along with a Java
dump and NSD file that is stored in the IBM_TECHNICAL_SUPPORT directory. Perform this command before contacting Lotus Notes
Tell Traveler PMR
The command tell traveler pmr <pmr_number>
is a properly formatted PMR number) performs a systemdump of all log files, collects them in one zipped file, automatically uploads (FTP) the output from the log collect to ECuRep under the designated PMR number.
If you have already performed a systemdump and have a list of file logs to send to IBM
support, add [log file list]
to the command:
tell traveler pmr <pmr_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 ECuRep under the designated PMR number. For more than one file, you must separate them with a space and place the "\" character on either side of each filename.
Parent topic: Console commands