configureencryptionkey CLI command

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:

 

Related topics

Managing-the-product-from-the-command-line-interface

Security-considerations

Security-planning

Configuring-a-secured-connection

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:

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

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*