hdbuserstore: Command Reference and Syntax

You can store and manage connection details in the user store using the hdbuserstore program. Run the commands using the syntax below:


hdbuserstore [OPTION]... COMMAND [PARAMETER]...

Command Options

* -h
  Displays a help message

* -H [HOST]
  Assumes host name [HOST]

* -i
  Enables interactive mode

* -u [USER]
  Executes the command on the user store of user [USER]

* -v
  Executes the command in verbose mode

Commands

* HELP

  * Parameter: -
  * Displays a help message

* LIST

  * Parameter: KEY
  * Lists entries with the specified key
  * Passwords are not displayed

* DELETE

  * Parameter: KEY
  * Deletes entries with the specified key

* SET

  * Parameter: KEY

    * Sets the entry key
    * Note:

      * Underscores, hyphens, periods, and alphanumerical characters (0-9, a-z, A-Z) are allowed
      * The resulting key is always upper case (0-9, A-Z)
  * Parameter: ENV

    * Sets the connection environment in the format:

      * [host]:[port]
      * [host]:[port]@[tenant_database], where port is the SQL port number of the system database
  * Parameter: USERNAME

    * Sets the user name for the profile
  * Parameter: PASSWORD

    * Sets the password for the profile
    * Note:

      * It is recommended to run the SET command in interactive mode so you are prompted to enter the password
      * If you enter the password directly in the command, it is stored in your shell’s command history

* CHANGEKEY

  * Parameter: -
  * Randomly generates a new master encryption key and re-encrypts the passwords of all keys with the new master key

* ADDFROMDIR

  * Parameter: DIR
  * Adds entries from a store specified by the DIR parameter to the secure user store without overwriting existing keys
  * You must have read permission for both the SSFS_HDB.DAT and SSFS_HDB.KEY files in the specified directory
  * Note:

    * This command does not copy trace configurations stored in the SSFS_HDB.DAT file
  * If this command reads a key name in the store and the same key name is already in use, the existing key remains unchanged
  * If this command is interrupted, the keys that have already been added are not automatically rolled back
  * An intermittent store backup file is created for manual recovery
  * The backup file is created before each key is added and is automatically removed after each successful single key operation

* LISTFROMDIR

  * Parameter: DIR
  * Lists entries from a store in the store directory
  * You must have read permission for both the SSFS_HDB.DAT and SSFS_HDB.KEY files