Creating a storage passphrase

The storage passphrase (also known as key encryption passphrase) is used to generate the key encryption key (KEK) for a storage bucket. Create a storage passphrase from the command line after you install Global Mailbox.

About this task

You can create a storage passphrase only by using the command line. To set the storage passphrase:


  1. Open the /MailboxUtilities/admin/bin directory.
  2. Run the script
    For example, ./ set --adminUser=<user> --adminPassword=<password> --passphrase=<passphrase>
  3. Enter the following parameters and values to suit your needs, in the format:
    Global Mailbox Administrator user. Optional. Utility prompts for value if not provided. For example: --adminUser="userid"
    Global Mailbox Administrator password. Required if --adminUser is specified. Otherwise, utility prompts for value. For example: --adminPassword="password"
    The character string to use as the passphrase for storage.
    The script prompts for value if --passphrase is not specified.
    Restriction: Due to a limitation in how the PBE passphrase can be configured and used in Sterling B2B Integrator, run the storagePassphrase script before creating any variants, set the same passphrase in Sterling B2B Integrator, and do not update the storage passphrase. If you update the passphrase, then any variants that were encrypted with the old passphrase become unusable, when Sterling B2B Integrator tries to access the variants.