Tell command reference

A list of all tell commands and their effects.

Table 1. Tell commands
Command	Result
Active	Displays the users who are currently syncing with the server. For more information, see User commands.
AIS show	Shows the Adaptive Initial Sync (AIS) state per application for all users who are not already in a normal state. Possible states are: INITIAL_STATE - waiting for the devices to sync the initial, restricted set of data INITIAL_COMPLETED_STATE - The devices have completed the sync of the initial, restricted set of data and are now eligible for promotion PROMOTE_NEXT_PS_STATE - Ready to be promoted to the full device filter settings PROMTED_STATE - Prime sync and devices syncs are running to apply the full device filter settings to all devices. NORMAL_STATE - AIS completed and the devices are using their respective device filter settings. Users in this state are not listed in the results.
Available `on/off`	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, and all new session requests must be handled by other IBM Traveler servers in the HA pool. If there are existing user sessions on this server, they will eventually move to other servers over time 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.
BannedDoc dump	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.
Bind show	Shows which users have been explicitly bound to a server. By default this list will be empty.
Bind showall	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.
Cleanup <option>	Performs Traveler database cleanup according to <option> specified. Option can be: Show - Displays the cleanup actions that would performed but does not execute the cleanup Users - Removes all devices where the last sync time is older than the user cleanup timeout Bind - Cleans any BIND table entries for an unknown server Outbox - Cleans database records leftover from Exchange ActiveSync device SendMail options Admin - Identifies and removes orphan admin database records GudRecordEx - Cleans orphaned entries in the ts_gud_record_ex database table. If <option> is not specified, performs all cleanup options except Show.
Client show type	Displays the available client builds and assignments. If type is omitted, all types are displayed. With new installs, the list may be empty because IBM Traveler no longer ships client install packages. `type` can be any of the following: Android_Installer Android_Sync Nokia_Installer Nokia_Sync_S60_3 Nokia_Sync_S60_5 Nokia_Sync_S63 Nokia_Sync WM_Installer WM_Sync WM_Sync_6_PPC WM_Sync_6_SP WM_Sync_6_PPC_<Locale> WM_Sync_6_SP_<Locale> Where `<Locale>` 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
Client refresh `option`	Checks for new clients. Accepts an optional parameter of `FULL` or `PATCH`. If not specified, it defaults to the setting for `NTS_CLIENT_UPDATE` in the notes.ini.
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.
Config `regex`	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.*`
DBMaint Run	Immediately performs online maintenance. If the server is standalone, then it will configure maintenance to run on restart.
DBMaint Show	Displays various database maintenance scheduling information.
DBMaint Fragmentation	Recommends database maintenance based on fragmentation levels.
DBMaint Set Interval <days>	Sets the interval of days in which automatic database maintenance will perform.
DBMaint Set Time <hh:mm>	Sets the time in 24-hour format in which automatic database maintenance will perform.
DBMaint Set Day <monday-sunday/off>	Sets the day of the week on which the first scheduled automatic maintenance will start. Set this to `Off` if you want the first scheduled maintenance to be based off of the last maintenance time.
DBMaint Set Threshold <on/off>	Configures automatic database maintenance to check fragmentation levels before execution.
DBMaint Set Auto <on/off>	Enables automatic database maintenance. Re-enablement will reschedule maintenance if either the time or interval have changed.
DBMaint Set Indexes <number>	Configures the number of fragmented indexes for the fragmentation threshold.
DBMaint Set Ownership	Configures ownership of database maintenance to the executing server. This server will be the only server that can perform automatic database maintenance.
DBMaint Set Percent <0-100>	Only applicable for SQL Server. Configures the fragmentation percentage of indexes for the fragmentation threshold.
DBMaint Set Functions <1-4>	Only applicable for DB2. Configures the number of functions that are used to determine if an index is fragmented for the fragmentation threshold.
Delete `device` `user`	Deletes all data associated with the specified user, including all device profiles. For more information, see Resetting users and devices.
Dump `user`	Dumps the information about the specified user to a file. For more information, see Diagnostic commands.
DumpDoc `doc# user`	Dumps a document based on the document ID, where the `doc#` is either the UNID or the noteId from the user's mail file. The `User` field can be any unique user identifier or `MailServer!!Mailpath`.
HADR delete `server`	Removes the server from the High Availability pool. You must take the server offline before executing this action.
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 show [Verbose]	For a High Availability server, shows the status of all IBM Traveler servers in the pool. For a standalone server, shows the status of the standalone server. You can use the `Verbose` flag to show additional information.
Help	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 OR it expires after `NTS_LOG_USER_EXPIRATION` days. For more information on `NTS_LOG_USER_EXPIRATION`, refer to Notes.ini settings.
Log AddUserPerm `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. It does not expire after `NTS_LOG_USER_EXPIRATION` days. As a result, using this command, admins only have to set it once, instead of every fourteen days, as with `Log AddUser`. For more information on `NTS_LOG_USER_EXPIRATION` refer to Notes.ini settings.
Log Clear	Deletes the logs.
Log Collect	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.
Log Help	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 *.
Log Show	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 IBM 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.
Memory	Displays the amount of memory that IBM Traveler is using and how much memory is free for use. For more information, see Resource usage.
Policy Help	Displays help about Policy command options.
Policy Update `user`	Pushes updates to IBM Traveler policy settings to users now. This command only affects IBM 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. For more information, see Resetting users and devices.
Security Add `device` `user`	Adds the device.
Security AllStatus	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 device security data from IBM Traveler. It is no longer mandatory for administrators to manually perform `tell traveler security delete` to remove the device security administration data from IBM Traveler after a device has been deleted or reset. Starting with version 9.0.1.10, IBM Traveler will automatically quarantine deleted devices and move them into the deleted state. These deleted devices will not be seen in the "Devices" view, however they will continue to be seen in the "Devices Security" view for up to 30 days. IBM Traveler keeps deleted device security data for the 30 day period in order to Publish device security data to the IBM Traveler Web Administration Console so that Administrators can take further action on those deleted devices. Allow IBM Traveler Administration REST API consumers query for a list of all deleted devices. Allow sufficient time for any security actions taken against the device to complete. If there is no device activity for 30 days, the corresponding device security data will be automatically removed. This means any security action previously completed or still pending against the device will be lost. However, if a deleted or reset device happens to connect and/or sync with IBM Traveler within the 30 day window, it will be moved to an active state and will resurface in the "Devices" view. A `notes.ini` setting, `NTS_ADMIN_CLEANUP_TIMEOUT`, is available to customize the 30 day period for security data removal. If an administrator wants the security data to be immediately removed during device deletion, they can assign a value of 0 to this `ini` setting. This forces IBM Traveler to remove both the device and its security data when `tell traveler delete` or `tell traveler reset` is performed. Any previous security (such as approval, deny, or wipe) actions taken against the device will be immediately lost. In environments where `NTS_ADMIN_CLEANUP_TIMEOUT = 0` has been set, we recommend not to delete a device immediately after a security action has been issued. Instead, wait for the server and/or device to complete the action before deleting the device. For example, if a device or application wipe has been issued and the device is deleted immediately following that wipe, even before the device acknowledges the wipe, the wipe action will be lost from IBM Traveler. Note: There is still no explicit indication available on the IBM Traveler Administration UI to highlight devices in the deleted state. If a device is deleted, it will not appear in the "Devices" view.
Security DeleteAll	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.
Security Help	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. (Deprecated)
Security smsRemove `device` `user`	Removes the SMS address for the device. (Deprecated)
Security Status `user`	Displays status of user and devices owned.
Shutdown	Stops the server from accepting new work requests, allows current work to complete, and then quits.
Stat Clear	Clears the IBM Traveler server statistics.
Stat Help	Displays help about Stat command options.
Stat Show	Displays the IBM Traveler server statistics. For more information, see Statistics.
Status	Performs checks to determine if IBM 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.
Support <case number> `log file list`	Performs a systemdump, creates a log file collection, and automatically uploads it to IBM® Support. Where `number` is a properly formatted case number. The syntax must be the letters TS followed by nine numbers. 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 IBM 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 case. `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. Note: The command tell traveler pmr is deprecated. Prior to IBM Traveler 10, the notes.ini NTS_PMRUPLOAD_VALIDATION=false must be set to allow a case number to be used with the pmr command.
SystemDump	Saves the current IBM Traveler Server system state to a file. For more information, see Diagnostic commands.
SystemDump Help	Displays help about SystemDump command options.
Threads	Display server thread pools and thread information
Tablerepair help	Displays usage information for the `tablerepair` command.
Tablerepair show <table>	Displays the number of users having records that might prevent a Primary Key from being added to the table. Option for `table`: `GUIDMAP, PUSH, REPLICAS, TS_FILTERS` or `*` for all.
Tablerepair repair <table> <number of users>	Repairs the table listed for the number of users specified by issuing a reset for the user. The Primary Key for the table will be added automatically once the table is repaired. Options for `table`: `GUIDMAP, PUSH, REPLICAS, TS_FILTERS` or `` for all. Options for `number of users`: `Integer > 1` or `` to indicate all.
User `user`	Displays all the information and devices associated with the specified user. This command also validates whether the user is correctly configured for IBM Traveler server. For more information, see User commands.
Users	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.
Version	Displays the version information for the IBM Traveler server.