This topic provides a detailed description of the IBM® Lotus Notes® Traveler console commands. You can perform the following tasks on the Domino console to start, stop, and restart Lotus Traveler server.
command allows the administrator to access and display information about Lotus Note Traveler server. You can run the
command on the Domino console.
When you have multiple Lotus Notes Traveler in your environment, you can run the tell command with the
parameter to send the command to a specific server or to broadcast a command. When this parameter is not specified, the default is to process the command locally. Specifying
sends the command to the specified server. Specifying
broadcasts the command to all servers except the local.
For example, to check the status of all the Lotus Notes Traveler servers in the HA pool, run
The status command is forwarded to each server in the pool and the response is displayed on the local console where the command was originally issued.
Displays the users who are currently synchronizing with the server.
Allows an administrator to make a server unavailable from servicing requests. Issuing tell traveler available off sets the availability index to a negative value. The effect is that the server will not service new device requests, causing any existing user processing to move to other servers until only the users explicitly bound to the server remain. This can be useful when trying to troubleshoot a server or in preparation for taking a server offline for maintenance or other purposes.
BannedDoc show DocID UserID
Shows the specified banned document. DocID is the UNID or a noteID of a document.
BannedDoc show * UserID
Lists all of the banned documents for the specified user.
BannedDoc show *
Lists all of the banned documents on the system.
BannedDoc Remove DocID UserID
Removes the ban for a particular document. DocID is the UNID or a noteID of a document.
BannedDoc Remove * UserID
Removes the ban for all banned documents for the specified user.
BannedDoc Remove *
Removes the ban for all banned documents on the server.
BannedDoc Add DocID UserID
Bans a particular document from syncing. DocID is the UNID or a noteID of a document.
Attempts to dump all of the banned documents to DumpDoc.nsf. This should only be used if providing IBM support the documents in question for troubleshooting purposes.
Shows which users have been explicitly bound to a server. By default this list will be empty.
Shows all of the registered users in the High Availability pool, along with which server they are running on.
Bind enable UserID
Binds the user to the local server. Note that once this user is bound to a server, if that server becomes unavailable, then the user will not failover to another server in the pool.
Bind disable UserID
Removes the binding for the user.
Client show type
Displays the available client builds and assignments. If type is omitted, all types are displayed.
type can be any of the following:
Where is CA, CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, JA, KO,NB_NO, NL, PL, PT, PT_BR, RU, SK, SV, TR, ZH_CN or ZH_TW
Checks for new clients.
Client promote type level
Makes the specified build the default for clients of the given type.
Client delete type level
Deletes the specific build of the given type.
Client addassignment type level user|group
Assigns user or group to the specified build of the given type. user or group can be a comma separated list.
Client removeassignment type level user|group
Removes the specific assignment for user|group from the specified build of the given type. user|group can be a comma separated list. user|group of * means "all".
Client setassignment type level user|group
Combination of removeassignment * and addassignment user|group. user|group can be a comma separated list.
Displays any or all configuration parameters. If regex is not specified, all configuration parameters will be shown. The regular expression pattern can be a full name or a regex like NTS_SSL.*
Delete device user
Deletes all data associated with the specified user, including all device profiles.
Dumps the information about the specified user to a file.
Shows the status of all Lotus Notes Traveler servers in the pool.
HADR ping server
This command sends an internal ping request to the specified server. The response will indicate success if the server is active or a failure if the server cannot be contacted.
HADR delete server
Removes the server from the High Availability pool. You must take the server offline before executing this action.
Displays help topics.
Log AddHandler handler
Add a handler to the list of handlers.
handler choices: activity, error, usage, logNsf, console, errorConsole.
Log AddPackage pkg
Adds a package to the log filter. Only packages in the filter list are logged. * can be used after the package name. Use Log AddPackage * to log all packages.
Log AddUser level user
Logs records for this user at the specified log level. This level overrides the system log level until this user is removed from the list.
Deletes the logs.
Moves the logs and debug data to a subdirectory.
Log Count #
Sets maximum number of activity files to keep.
Log Export file
Exports the log settings to the fully qualified file name.
Log Fields fields
Controls which fields are logged in the activity file: S=Subject, B=Body, L=Location, A=Address, P=Phone, *=show all fields, blank=hide all fields. For example, "Log Fields SB" shows Subject and Body fields only.
Log Handler handler propname propvalue
Set a handler property.
handler choices: activity, error, usage, logNsf, console, errorConsole.
propname choices: level, formatter, filter, limit, count, pattern, append.
If no parameters are specified, the possible settings for each handler will be listed.
Displays help about Log command options.
Log Level level
Sets the logging capture level to FINEST, FINER, FINE, INFO, WARNING, or SEVERE.
Log MaxEntrySize #
Maximum size for a single log entry (minimum is 500 bytes)
Log RemoveHandler handler
Remove a handler from the list of handlers. Same handler choices as AddHandler.
Log RemovePackage pkg
Removes a package from the log filter.
Log RemoveUser user
Removes a user from the list of users that are logging. Remove all users by specifying *.
Displays current log settings.
Log Size #
Maximum size in megabytes before the activity file overwrites itself.
Log Usage on/off
Enables or disables usage logging.
Log XML propname propvalue
Set a property for the XML handler.
propname choices: limit, count, pattern, append.
If no parameters are specified, the current XML handler settings will be listed.
Mailreplicas show user
Shows current mail replica information being used by Lotus Notes Traveler for the user.
Mailreplicas update user server
Search for the user's mail replica information using the cldbdir.nsf located on server. If found, use this information as the user's mail replica data.
Displays the amount of memory that Lotus Notes Traveler is using and how much memory is free for use.
Performs a systemdump of log files, creates a log file collection, and automatically uploads it to IBM Support.
Where pmr_number is a properly formatted PMR number. The syntax must be "5 numeric, 3 alphanumeric, 3 numeric". Separators can be commas or periods.
Where log file list is a list of files to upload. If log file list is not present, the server performs a systemdump, log collection and uploads the resulting Lotus Notes Traveler log archive. If log file list is present, a new log collection is not performed, but instead each log file is uploaded for this PMR. log file list can be one or more file names, separated by spaces with \" surrounding the file name if it contains spaces itself. A quotation mark (") by itself is not sufficient, the tell command processor in Domino® will strip it off; it must be \" and included in the command usage details. You would typically only ever use the command to upload a specific zip file if a previous FTP attempt had failed. The file names can be relative files names (in the Traveler logs directory) or fully qualified file names including path information.
Displays help about Policy command options.
Policy Update user
Pushes updates to Lotus Notes Traveler policy settings to users now. This command only affects Lotus Notes Traveler users on Domino mail servers before Domino 8.0.1. Specify * to indicate all users.
Reset device user
Forces a sync reset for a device.
Security Add device user
Adds the device.
Displays status of all users and devices.
Security approval flag device user
Sets the approval state for a user's device. flag can be either Approve or Deny.
Security Delete device user
Removes the device.
Remove all users and devices.
Security flagsAdd flag device user
Sets the flag for the device. The flag options are all, wipeDevice, wipeApps, wipeStorageCard, and lock.
Security flagsRemove flag device user
Removes the flag for the device. The flag options are the same as those for Security flagsAdd.
Displays help about Security command options.
Security Policy device user
Displays device security policy compliance status.
Security Send device user
Sends the security message to the device using all available means.
Security smsAdd sms device user
Sets the SMS address for the device.
Security smsRemove device user
Removes the SMS address for the device.
Security Status user
Displays status of user and devices owned.
Displays all the information associated with the specified user and all the devices. This command also validates whether the user is correctly configured for Lotus Notes Traveler server.
Stops the server from accepting new work requests, allows current work to complete, and then quits.
Clears the Lotus Notes Traveler server statistics.
Displays help about Stat command options.
Displays the Lotus Notes Traveler server statistics.
Performs checks to determine if Lotus Notes Traveler Server is operating normally, and reports the results of the check to the administrator.
StopSync device user
Stops any active synchronizations for a device.
Saves the current Lotus Notes Traveler Server system state to a file.
Displays help about SystemDump command options.
Display server thread pools and thread information
Displays all the information and devices associated with the specified user. This command also validates whether the user is correctly configured for Lotus Notes Traveler server.
Displays the users allocated on the server. This is useful in an HA environment for understanding how users are spread over the various HA servers. This is not a specific HA command.
Displays the version information for the Lotus Notes Traveler server.
Managing a Lotus Notes® Traveler HA pool, in many ways, is very similar to managing a set of stand-alone Lotus Notes Traveler servers. Lotus Notes Traveler servers are started and stopped individually. There is no command to start or shutdown all servers. When any server is shutdown in a pool, the other Lotus Notes Traveler servers detect this outage and handle the device requests.
commands have been updated to be HA pool-aware. There are several
commands specifically for the HA environment. Where necessary, commands automatically route a request to another server or broadcast a request to all the servers in the pool without the administrator requesting that action explicitly. For example, you can use
to show the details for a user. This command is forwarded to the appropriate server for the user automatically. Another example is setting the log levels. The log levels are managed across the pool of servers, so to set log levels to
and all servers are notified that the log levels is changed. Command
is updated, where applicable, to provide any new parameters that relate to working with a pool of servers.