Skip to content

travelerUtil commands

The travelerutil is a command line tool located in the <domino data>\traveler\util directory. Enter travelerUtil help while running the tool to display the full list of options.

Note: For Linux , travelerUtil must be run as the Domino user.

Stop the Traveler server before running the travelerUtil tool. For some operations, you may also need to stop Domino.

Commands should be given in the following format:

Linux: ./travelerUtil <optionals> <options>

Where <optionals> may be omitted and includes:

  • debug

    Enables additional debugging to the console and logs.

Where <options> include:

  • log clear

    Deletes the logs.

  • log collect

    Zips the logs to a dated file.

  • support <number> <files>

    Uploads files to Traveler Support. Options include:

    • <number> - Required support number.

      Format: CS followed by 7 numbers.

    • <files> - Optional space separated list of files to upload.

      If omitted, a log collect will be performed to create a new file that will then be uploaded.

      Files can be base file names in the logs directory or fully qualified file names in any directory.

  • support show

    Show the SFTP credentials used to upload support information.

  • support remove

    Removes any stored SFTP credentials used to upload support information.

    Note: This option requires that Domino is not running.

  • support set [user=username] [pw=password]

    Sets the SFTP credentials used to upload support information. Credentials are encrypted for storage.

    Note: If the password contains special characters like '$', ';' or '&' on Linux or '&' on Windows, do not include the password on the command line and the program will prompt for the password. On Linux the character can be escaped like this: \$. This option requires that Domino is not running.

  • db show

    Shows the database.

  • db check

    Verifies that the database configuration works for a DB connection.

  • db set [-f] [url=dburl] [path=libPath] [user=username] [pw=password]

    Sets the database credentials and URL if they pass validation. Use -f to force the credentials even if validation fails. The credentials are encrypted for storage. The URL should specify the full JDBC URL to access the database, although it is optional if the URL has already been set. The Library path is required and should specify the full path to the database library jar file.

    schemaname in URL for DB2 on IBM i must be same as NTS_DB2_SCHEMA=<schemaname> in notes.ini. If not specified, using default schemaname LNT. This option requires that Domino is not running.

    If the password contains special characters like '$', ';' or '&' on Linux or '&' on Windows, do not include the password on the command line and the program will prompt for the password.

    On Linux the character can be escaped like this: \$. This option requires that Domino is not running.

  • ssl show

    Shows the SSL certificate store information.

  • ssl remove

    Removes any stored SSL credentials.

    Note: This option requires that Domino is not running.

  • ssl check

    Validates the SSL certificate store password(s).

  • ssl set [-f] [key=password] [trust=password] [keystore=keystorefile] [truststore=truststorefile]

    Sets the SSL certificate key store password and trust store password if they pass validation. Use -f to set even if validation fails. The credentials are encrypted for storage. The keystorefile is the fully qualified path to the keystore which contains the certificate to use for SSL encryption.

    Note: The trust store password and file are optional and only needed if the trust store has been configured.

    If the password contains special characters like '$', ';' or '&'on Linux or '&' on Windows, do not include the password onthe command line and the program will prompt for the password. On Linux the character can be escaped like this: \$. This option requires that Domino is not running.

  • push <provider> show

    Shows the credentials associated with the proxy for push <provider>. Where <provider> is one of the following options:

    • apnsAppleVerseIBMProduction
    • apnsAppleVerseIBMProductionSandbox
    • fcm
    • push <provider> remove

    Removes any stored credentials associated with the proxy for push <provider>.

    Note: This option requires that Domino is not running.

  • push <provider> set [user=username] [pw=password]

    Sets the credentials associated with the proxy for push <provider>. Credentials are encrypted for storage.

    Note: If the password contains special characters like '$', ';' or '&'on Linux or '&' on Windows, do not include the password onthe command line and the program will prompt for the password.On Linux the character can be escaped like this: \$. This option requires that Domino is not running.

  • netaddr

    Displays network interface(s) available.

Parent topic:Assigning preferences and security settings to devices