Activating Licenses

This section describes how you can activate the CipherTrust Manager and Connectors licenses. Activating a license involves generating a license and adding it to the CipherTrust Manager.

This section covers the following information:

• Activating a CipherTrust Manager License

• Activating a Connector License

Activating a CipherTrust Manager License

You need a valid and active license on each Virtual CipherTrust Manager instance to access all administration features. You can find the details of your EIDs and available licenses after you have logged on to the License Portal.

You need one Virtual CipherTrust Manager license per Virtual CipherTrust Manager instance. The license will not replicate across a cluster.

Generate a CipherTrust Manager License

1. Log on to the License Portal. Refer to Logging on to the Portal for details. The Products tab is displayed.

2. Under Products, expand the CipherTrust Manager license. You might have a "k170v" or "k470" license depending on the performance level you purchased. A k170v license is shown as an example.

   

   Note

   Alternatively, use the Search option located at the top right corner to locate a specific product. You can locate details of your ordered products by either searching the partial or complete product name (product version is NOT required).

3. Under Actions, click Activate for the desired entitlement. The Order Activation page is displayed.

   

4. Select the product and enter 1 in the Quantity To Activate.

5. Obtain the Key Manager Lock Code:

   1. Log on to the CipherTrust Manager GUI.

   2. Open the Admin Settings application.

   3. In the left pane, click Licensing.

   4. Click the Lock codes tab.

   5. Click to expand Key Manager Lock Code.

      

   6. Copy the Key Manager Lock Code. This lock code is needed to activate a CipherTrust Manager license.

6. Return to the License Portal.

7. Paste the copied lock code in the Product Lock Code field under Product Locking.

   

8. Select the desired Time Zone.

9. Click Activation. This initiates the entitlement activation process.

A message stating that activation is completed successfully is displayed on the Order Activation page.

The generated license file is available for download. Now, you should add the license to the CipherTrust Manager, as described below.

Add the License to the CipherTrust Manager

1. Click Download License File. The license.zip file is downloaded to your local machine.

2. Extract the ZIP file. The default license file is lservrc.

3. Open the lservrc file in a text editor.

4. Review the license string. For example, a sample string is given below. Actual string for your license will be different.

   16 Virtual_KeySecure Ni LONG NORMAL STANDALONE AGGR 1_KEYS INFINITE_KEYS 11 SEP 2020 4 0 11 SEP 2023 3 59 NiL SLM_CODE CL_ND_LCK NiL *1MKGRPVF5ATYYQ30400 NiL NiL NiL 5_MINS NiL 0 BW0lQ8jO9Y1Qj:7Ad9acfol7VHKOLethx27eRl58TZVUMuWObisxl,2LhpWLfptGVbsDyuPcZJJnccohVRArKQ3C##AID=bc91784c-eec3-4742-8002-f03859d6f52b
   

5. Copy the entire license string.

6. On the CipherTrust Manager GUI:

   1. Open the Admin Settings application.

   2. In the left pane, click Licensing.

   3. Click the Features tab, if needed.

   4. Click Add license. The Add License dialog box is displayed.

   5. Paste the copied license string to the License String box.

      

   6. Click Add.

Now your CipherTrust Manager has an Active license. The CipherTrust Manager license is displayed in the features list. The Expiration date indicates how long the license is valid.

To view more details about the license, click the overflow () icon.

Repeat these steps for every Virtual CipherTrust Manager instance. CipherTrust Manager licenses are not replicated across a cluster.

Activate a CipherTrust Manager license using KSCTL

1. Retrieve the 'Key Manager Lock Code'.

   ksctl licensing lockdata
   

2. Log on to the License Portal. Refer to Logging on to the Portal for details. The Products tab is displayed.

3. Under Products, expand the CipherTrust Manager license. You might have a "k170v" or "k470" license depending on the performance level you purchased. A k170v license is shown as an example.

   

   Note

   Alternatively, use the Search option located at the top right corner to locate a specific product. You can locate details of your ordered products by either searching the partial or complete product name (product version is NOT required).

4. Under Actions, click Activate for the desired entitlement. The Order Activation page is displayed.

   

5. Select the product and enter 1 in the Quantity To Activate.

6. Paste the copied lock code in the Product Lock Code field under Product Locking.

   

7. Select the desired Time Zone.

8. Click Activation. This initiates the entitlement activation process.

9. Copy the License String. The license string is needed to install the license on CipherTrust Manager GUI.

   Note

   The license string generated for one CipherTrust Manager cannot be used on any other CipherTrust Manager.

10. Activate your product by entering the License String.

    ksctl licensing licenses add -l "<license string>"
    

11. Repeat these steps for every Virtual CipherTrust Manager instance. CipherTrust Manager licenses are not replicated across a cluster.

Activating a Connector License

To register and use a Connector on your CipherTrust Manager, you need to have a valid and active license for that Connector on your appliance. You can find the details regarding your EID and your available Connector licenses on the License Portal.

Instructions provided in this section apply to all the supported Connectors. Exceptions are: for CipherTrust Cloud Key Manager (CCKM), the usage unit is Cloud Units; for DDC, the unit is Data Allowance; and for CTE and similar Connectors, the unit is Clients.

Generate a Connector License

1. Log on to the License Portal.

2. Under Products, expand the Connector license that you would like to activate.

   

   Note

   Alternatively, use the Search option located at the top right corner to locate a specific product. You can locate details of your ordered products by either searching the partial or complete product name (product version is NOT required).

3. Under Actions, click Activate for the desired entitlement. The Order Activation page is displayed.

4. (Flex connectors only) Select the desired Variant.

5. Select the product and enter the Quantity To Activate.

6. Obtain the Connector Lock Code:

   1. Log on to the CipherTrust Manager GUI.

   2. Open the Admin Settings application.

   3. In the left pane, click Licensing.

   4. Click the Lock codes tab.

   5. Click to expand Connector Lock Code.

      

   6. Copy the Connector Lock Code. Every CipherTrust Manager appliance has a unique Connector Lock Code. This lock code is needed to activate a Connector license for the CipherTrust Manager.

   Note

   In a CipherTrust Manager cluster, the Connector Lock Code is applicable to all nodes of the cluster to enforce connector licenses across the cluster nodes. When a Connector license is activated for one CipherTrust Manager appliance, the license is replicated on all the nodes of the cluster.

7. Return to the License Portal.

8. Paste the copied lock code in the Product Lock Code field under Product Locking.

   

9. Click Activation. This initiates the entitlement activation process.

A message stating that activation is completed successfully is displayed on the Order Activation page.

The generated license file is available for download. Now, you should add the license to the CipherTrust Manager, as described below.

Add the License to the CipherTrust Manager

To add the license to the CipherTrust Manager:

1. Click Download License File. The license.zip file is downloaded to your local machine.

2. Extract the ZIP file. The default license file is lservrc.

3. Open the lservrc file in a text editor.

4. Review the license string. For example, a sample string is given below. Actual string for your license will be different.

   16 ProtectApp 1 LONG NORMAL STANDALONE AGGR 15_KEYS INFINITE_KEYS 21 SEP 2020 4 0 NEVER NiL SLM_CODE CL_ND_LCK NiL *1XHNSF77G7HNWRD0400 NiL NiL NiL 5_MINS NiL 0 xa8art1Fe2UypKVmcutYV44c2Jj3jRAB:RRNwbdZfa3HHkJ2vXmNQ54MLqPrBlj6LnBOf,mXzD6GU7z,0HzsyqLr##AID=67e179ea-f756-4657-8e18-f940652e2e32
   

5. Copy the entire license string.

6. On the CipherTrust Manager GUI.

   1. Open the Admin Settings application.

   2. In the left pane, click Licensing.

   3. Click the Features tab, if needed.

   4. Click Add license. The Add License dialog box is displayed.

   5. Paste the copied license string to the License String box.

      

   6. Click Add.

Now your Connector has an Active license. The Connector license is displayed in the features list. The Expiration date indicates how long the license is valid.

To view more details about the license, click the overflow () icon.

To view the usage of a feature licenses, expand the feature. The Client Usage section shows the count of licenses consumed in the current domain. The Domain Level Usage section shows the consumption of CTE licenses in all domains, and in individual domains. For example, expanding CipherTrust Transparent Encryption shows:

Likewise, you can see the the consumption of KMIP licenses in all domains (Domain Level Usage), and in individual domains.

Similarly, expanding Cloud Key Manager shows:

Connector License Activation After System Reset

If adding a connector license fails with Error[150]: The specified lock code is invalid., and you have recently reset the system, the Connector Lock Code likely changed. The following remedies are available:

1. Restore a CipherTrust Manager backup file containing the desired Connector Lock Code, if one is available, and retry adding the license.

2. Add the reset CipherTrust Manager to another CipherTrust Manager cluster node with the desired Connector Lock Code. The Connector Lock Code and installed connector licenses replicate to the reset CipherTrust Manager. You can add license files associated with the Connector Lock Code on any cluster node.

3. If a suitable backup file or cluster node is not available, contact customer support.