Console commands

This topic provides a detailed description of the HCL Traveler console commands.

The HCL Traveler server component functions as a Domino® server add-in task and, as such, responds to Domino® server console commands. You can perform the following tasks on the Domino® console:

  • Start: load traveler
  • Stop: tell traveler quit
  • Restart: restart task traveler

Tell commands

HCL Traveler supports various tell traveler commands through the Domino® console.

Usage: tell traveler options command

Where options may include:

-f <full path to file> - causes Traveler to write the tell command output to that text file instead of the Domino console.

-s (<serverName> | * | *-) - sends the tell command remotely when the server is configured for a High Availability pool.
  • Use <serverName> to send the command to a specifically named server.
  • Use * to send the command to all servers in the High Availability pool.
  • Use *- to send the command to all servers in the High Availability pool except the local server.
and command is one of the supported commands. For example,

tell traveler status - causes Traveler to print a summary of current server status to the Domino console.

tell traveler -f C:\temp\status.txt status - causes Traveler to print a summary of current server status to file C:\temp\status.txt, overwriting whatever was in that file previously.

For an in-depth look at some of the key Tell commands, see the following sections.