BoKS Manager 7.0 and later includes licensing enforcement controls. If you are upgrading from an earlier version, you need to request a license from FoxT Customer Support as part of the upgrade process in order for your upgraded domain to function correctly. See the relevant steps in the procedure for installing the Master for information about how to do this. For more details about licensing, see “Licensing Background” in the BoKS 7.0 Installation Guide.

Licensing Basics

Your license specifies the number of hosts of each host type that are allowed in the domain. You can have more than one license in the BoKS database at any one time, and as long as there is at least one valid license in the database, and you are not exceeding the number of hosts of that type allowed, adding a host is allowed.

If you exceed the licensed limit for any particular host type, you will be unable to register any new host of that type. Note that this can affect registering hosts, but also changing the type of a host, and importing host definitions.

Domain ID

When you set up the Master a domain id is generated that uniquely defines the new domain. The domain id is then used by Fox Technologies customer support to create the license for your particular domain. The domain id is stored in the database and replicated to the Replica servers as part of the normal database replication. It is also a part of any database backup taken with boks_bru. This means that your domain id remains unchanged during upgrade from BoKS 7.0 or in disaster recovery situations.

The domain id can be displayed by running bksdef (without any options). It is also available in the file $BOKS_etc/ on the master.

Default license

BoKS Manager includes a special default license that ensures you can install a limited number of hosts . This license is not tied to a domain id and is designed so that you can get the first few hosts in your basic domain up and running without licensing restrictions stopping this.

Listing licenses

In the FoxT Control Center you can display information about licensing for the domain by clicking on "Domain" and expanding the section "License information" at the bottom of the page.

The same information is also available on the command line by running the command bokslicense -l located in $BOKS_sbin (default /opt/boksm/sbin/).

Importing of license file

Import the license file to your database as follows using the program $BOKS_sbin/bokslicense:

  1. Log in to the Master and become root or enter another role with administrative privileges.
  2. Ensure that a valid license file is available for import on the Master.
  3. Start a BoKS shell.

For example:

# /opt/boksm/sbin/boksadm

BoKS #

Run the bokslicense program with the -i option and path to the license file as arguments.

For example:

BoKS # bokslicense -i < /tmp/bokslic1.lic

Where bokslic1.lic is the signed license file to be imported.

Getting a license file

There are two different scenarios for getting a license file.

  1. You have purchased new or additional licenses.
    In this case your sales representative will provide the required sales information such as type of license and number of licenses to FoxT support in order for the license file to be generated.
  2. You need an updated license file.
    There can be a number of reasons to request an updated license.
    Example scenarios are because you have many BoKS domains and you want to distribute licenses differently between domains or possibly because your license is about to expire and you need a new one.

In both scenarios you will need to provide FoxT with the domain id (see section 'Domain ID' above) of the domain you need a license for. FoxT support are responsible for generating the license file and sending it to you in a secure fashion.


If you upgrade to BoKS Manager 7.0 from an earlier version that does not include licensing controls, the domain id which is generated when you install the version 7.0 BoKS Master is imported into the BoKS database from the file $BOKS_etc/ when you restore your old database as part of the upgrade. However, no licenses have at this stage been imported to the database, so you must first import the default license ($BOKS_etc/boks_default_license.lic). Note that once you have restored the old database, you must send the domain id file to Fox Technologies customer support in order to obtain your license file that you can then also import into the BoKS database.

Converting between host types

You do not need to re-import the license file when you promote a Replica to the Master. The domain id file, $BOKS_etc/, which is used for BoKS licensing, is automatically created from the contents of the database when you promote a Replica to the Master. When a Master is demoted to another host type, the file is removed.

License logging

The following licensing-related events are recorded in the BoKS audit log:

• When a license is imported using bokslicense.

• When a license is removed using bokslicense.

• When a host is registered causing licensing limits to be reached (note that this and other registration operations can be an auto-registration of a host pre-registration or a change in host type for an already registered host).

• When a host is registered causing licensing limits to be further exceeded during the grace period.

• When a host is registered but the license is due to expire in 30 days or less.

• When a host is removed causing licensing limits to be reached (i.e. licensing limits are no longer exceeded).

• When a host is removed but the license is due to expire in 30 days or less.

• A daily message is written to the log when the license has expired or is due to expire in 30 days or less (this is the result of a boks_cron check on the license status set to run each night).

Note: Audit log messages relating to the license having expired or having 30 days or less to expiry are by default configured as alarmlogs.

Grace period

Should you exceed the number of permitted registered hosts in the BoKS database as specified in your license, a grace period begins giving you time to purchase additional licenses as required. The grace period time depends on the specifics of your license, and is counted from the time the first additional host is registered, also known as the “date of first violation”.

Important: The grace period does not apply to expired licenses. If the license has expired, even if it is within the grace period, adding new hosts will be prohibited until the license is made current.

When you register the first additional host, the grace period begins. During the grace period, you can continue to register hosts within the number limit specified by your license, however each time you register a host you are notified that you have exceeded the number of licensed hosts. At the end of the grace period, you can no longer register any new hosts until you either purchase additional licenses or remove some other hosts to free up license berths.

No valid license

If you do not have a valid license, either because it has expired or your grace period for a specific host type has ended, you will not be able to add additional hosts to the database.

Still have questions? We can help. Submit a case to Technical Support.

Last Modified On: August 28, 2019