Managing the App Control Server License
search cancel

Managing the App Control Server License

book

Article ID: 286723

calendar_today

Updated On:

Products

Carbon Black App Control (formerly Cb Protection)

Issue/Introduction

Steps to import a new or renewed license file (.lic), verify the license was successfully applied, and what happens when the license expires.

Environment

  • App Control Console: All Supported Versions

Resolution

Table of Contents

Importing a new or updated Server License

ATTENTION: Customers will now receive multiple Server License files. Only Server version 8.11.0 (and higher) allows for importing multiple Server Licenses. For the time being:

  • Import the individual Server License file associated which the latest expiration date.
  • If messages are displayed about the Total Licenses being exceeded, ignore them for now.

Import License via Console

  1. Log in to the Console and navigate to the gear icon > System Configuration > Licensing.
  2. Select one of the following options:
    • Specify License File: Upload the .lic file directly.
    • Paste License Key: Open the .lic file in a text editor, and copy the entire contents into the box provided.
  3. After importing, verify:
    • Reports > Events shows a new Event with Subtype: License Added.
    • Settings > System Configuration > Licensing shows an updated License Expiration and/or updated Endpoint Limit.

Import License via SQL

  1. Stop the App Control Server and App Control Reporter services.
  2. Run SQL Server Management Studio as the Carbon Black Service Account.
  3. Open the .lic file in a text editor and copy the value in the relevant query:
    • Server 8.11.0 and higher:
      USE das;
      EXECUTE dbo.UpdateLicense 'VALUE FROM LIC', '0'
    • Server 8.10.4 and lower:
      USE das;
UPDATE shepherd_configs 
      SET value = 'VALUE FROM LIC'
WHERE name = 'license'
  4. Start the App Control Server & App Control Reporter services.
  5. Log in to the Console and verify:
    • Reports > Events shows a new Event with Subtype: License Added.
    • Settings > System Configuration > Licensing shows an updated License Expiration and/or updated Endpoint Limit.

When should a new Server License be added, or old ones removed

  • New Server Licenses should be added before the current one expires, regardless of the Start Date associated with them.
  • Old (expired) Server Licenses do not have to be removed, but can be if desired.
    • Do not remove any active, unexpired, Server License.

What happens when the Server License expires

  • 7 days prior to expiration, multiple Events are generated with the Subtype: License Warning
    • An Alert can be created based on this Event.
    • This can be changed with the Shepherd Config Property: LicenseControlExpirationWarningLimitDays
  • On expiration, access to the Console and API will be restricted.
  • No change is made to the Agents, they will continue using the specified Enforcement Level and Approvals.

What happens when the License Endpoint Limit is Exceeded

A warning will be displayed in the Console and the Account Team may reach out to request additional licenses be purchased.

  • Exceeding the Endpoint Limit will not:
    • Impact the ability to log in to the Console.
    • Automatically disable or uninstall Agents.

Determine or update the License Endpoint Limit

  1. Log in to the Console and navigate to Settings > System Configuration > Licensing.
    • Endpoint Limit is displayed here.
    • In Use is determined by machines in Visibility or any of the Control Modes (Low, Medium or High).
  2. Verify Old Computer Cleanup is Enabled and configured correctly.
  3. If using Template Computers or Template Images, verify Clone Cleanup Settings are configured correctly.
  4. Total Licenses In Use is updated each night with the DailyPruneTask.

Using the Same License for Multiple Servers

While it is best practice to have a unique Server License for each App Control Server, the same Server License can be used for multiple installations.

  • The total endpoint count across all Server installations must not exceed the total licensed quantity.
  • Each Server installation must have a unique Server ID.

Please contact the Global Customer Care Team for assistance with Server License modification (date, quantity, etc).

Additional Information

  • The License Key is used to determine the number of Agents allowed to run in each Control Mode (Visibility, Low, Medium, High) and is a very long encoded value.
  • The Activation Key is used for connecting the App Control Server to the Reputation Service, is separated by dashes and associated with the License Key. Example:
    XXXXX-XXXXX-XXXXX-XXXXX-XXXXX
  • Once a .lic file has been imported the details of the file are saved in the DAS database.
  • The .lic file can safely be moved to a backup location in the event the file is needed to re-import for any reason in the future.
  • Contact Global Customer Assistance to make changes to the License Key (endpoint count, renewal, etc).
  • Download license keys for Broadcom, CA, Symantec, and VMware products
Powered by Wolken Software