Maintenance outage for upgrade on Sunday, September 22

This site, docs.bmc.com, will be inaccessible for two hours starting at 9 AM CDT, Sunday, September 22, for a platform upgrade.

    Page tree
    Skip to end of metadata
    Go to start of metadata

    Use this command to modify the default encryption key available with TrueSight IT Data Analytics.

    TrueSight IT Data Analytics protects passwords provided while configuring an object on the UI by using a 16-bytes default encryption key.

    As an administrator, you can use this command to change the default encryption key for enhancing security against unauthorized access.

    The new encryption key set by using this command applies to passwords provided while creating (or updating) data collectors, collection profiles, credentials, and external configurations. The new key must be 16-bytes in size (or 16 characters in length).

    Best practice

    While running this command, avoid creating or updating objects that require specifying a password.

    To understand the syntax and examples, see:

     

    Syntax

    Note

    Before you run the command, note the following points:

    configureencryptionkey -d <hostname> -p <portNumber> -u <username> -w <password> ops -k <operationName> [-l <locale>] [-v] [-s]
    • Angle brackets (< >) indicate a variable value that needs to be user defined.
    • Square brackets ([ ]) indicate optional parameters.

    The following table describes the parameters used in the syntax:

    ParameterDescription 
    -d
    Host name of the Console Server
    -p
    Port number of the Console Server.
    -u
    User name to use to connect with the Console Server.
    -w
    Password corresponding to the user name to use to connect with the Console Server.
    -ops



    Name of the operation that you want to perform.

    Based on the operation type, the value can be:

    OperationValue
    View the current encryption key

    Specify the value, get.

    Example: -ops get

    Modify the encryption key

    Specify the following value:

    modify -k <newEncryptionKey>

    In the preceding syntax, newEncryptionKey refers to the new encryption key that want to use. This key must be 16 characters long and must be enclosed in double quotes on Windows and single quotes on Linux.

    Example: -ops modify -k "encrypt!0nX@mp|e"

    The key can include alphanumeric characters and special characters.

    However, if you are using double quotes as a character in the encryption key (on Windows), make sure you escape the double quotes by placing a backward slash (\) in front of the double quotes.

    Example: "P@ssw@rd\"admin10"

    Similarly, if you are using single quotes as a character in the encryption key (on Linux), you need to escape the single quotes by placing a backward slash (\) in front of the single quotes. Additionally, the backward slash also needs to be enclosed in single quotes.

    Example: 'P@ssw@rd'\''admin10'

    -l

    (Optional) Indicates the locale in which you want to display messages when the command is run.

    You can set one of the following locales:

    • English
    • Simplified Chinese
    • German
    • French

    By default, the messages are displayed in the locale of the system on which the CLI is run.

    The value can be set to one of the following depending on the locale you choose:

    • English: en
    • Simplified Chinese: chs
    • German: de
    • French: fr

    Example: If you want to set the locale as Simplified Chinese, you need to specify, l=chs.

    -v
    (Optional) Version of the IT Data Analytics product.
    -s
    (Optional) Indicates an HTTPS connection.

    Example inputs

    The following example provides the input for viewing the current encryption key.

    configureencryptionkey -d localhost -p 9797 -u admin -w admin12345 -ops get

    The following example provides the input for modifying the encryption key.

    configureencryptionkey -d localhost -p 9797 -u admin -w admin12345 -ops modify -k encrypt!0nX@mp|e