generate-key

Enables you to generate new encryption keys for a Watson™ Explorer Engine installation.

Synopsis

generate-key [-h|-help|-?]|[[-key key][-quiet][-yes]]

Description

The generate-key command is location in the bin subdirectory of a Watson Explorer Engine installation. This command enables you to generate new encryption keys for that installation.

If a key already exists in the installation it will be backed up, not overwritten, but any data encrypted using the old key will not be decryptable by the new key. It is recommended that this command only be used during initial configuration of an Watson Explorer Engine installation to prevent data loss.

Options

  • -h|-help|-? Displays the command line help message and then exits.
  • -key Instead of generating a key, you may specify a 128-byte, base64 encoded key to use. They key will be rejected if it is of an invalid length or if the password is considered trivial. zxcvbn is used to determine the strength of the provided password.
  • -quiet Standard messages are suppressed; only fatal errors are displayed. Setting this flag implies -yes.
  • -yes When set the user is not prompted with any questions. It is assumed that the answer to any question would be yes.

Exit Status

  • 0 - Command executed successfully
  • 1 - Command encountered an error
  • 2 - Usage requested by user
Note: On Linux systems, exit codes above 127 are returned by the shell. Consult the documentation for the shell that you are using for more information.