License Management

License Elements #

edgeCore permits use of the product according to the following constraints:

  • On a particular IP address.
  • For a specified duration.
  • With a maximum number of user sessions.
  • With a maximum number of account domains.
  • With a maximum number of account users.

In addition to edgeCore, particular Adapters (or plugins) can be licensed. These plugins are constrained only by the maximum number of permitted Pipeline Connections nodes that are associated with this Adapter (this may or may not be related to the number of low-level network connections to a backend server).

Initial Installation #

When edgeCore has been started for the first time and after initial login by an administrator, a red banner will be presented indicating that the system is unlicensed and the administrator will be prompted to install a valid license:

Clicking “Update License” will allow the user to choose a valid license file from the file system and load the license into edgeSuite.

View Current License Status #

Upon opening the Manage License page (System Menu->Manage->License) the overall license status is presented. This includes:

  • The IP address of the currently licensed server.
  • The date that this license expires.
  • The maximum number of concurrent user login sessions permitted.
  • The maximum number of account domains permitted.
  • The maximum number of account users permitted.

In addition, any licensed Adapters are listed. Each row represents a single licensed Adapter, along with the vendor that produced the product used by that adapter, and the maximum number of permitted Pipeline Connections nodes that are associated with that Adapter.

View Adapter Status #

Open the Adapter page (System Menu→ManageAdapters) to view the consumption of licensed connections for each installed Adapter.

If the licensed connection limit is exceeded for any connection type then some connections will no longer work due to insufficient licenses. The system will automatically allocate licenses with priority to the oldest connections. If this is not suitable then the administrator can manually disable connections to bring the license usage back to the connection limit.

Update License #

Clicking Update License… on the Manage License dialog (System Menu->System->License) will display the following dialog:

Clicking the drop zone brings up a file chooser, which allows an administrator to select and upload a license into edgeSuite:

The license content is displayed. Clicking Install will essentially replace the existing license (if any) and apply the new license configuration.

Running Without a License

You do not need a license to start up Edge. You can install and start up the system without a license. The application will have very limited functionality, but will allow you to navigate to the above screens and then install a license. You can alternatively install a license from the command line. See below for details.

Install via Edge CLI (v3.8.5+) #

To install a license via command line using the new Edge CLI, the server must be running. The command is as follows:

bin/es-cli.sh license -f FILENAME --user username [--pass password]

FILENAME should point to an existing license file, and the credentials should be for a user with administrative access. The password can be passed as an argument, or it can be omitted from the arguments and entered via a masked password prompt that will appear after pressing Enter once the command and other arguments have been typed. See Edge CLI for more information and additional examples.

Install via Legacy Edge CLI #

The license command in the legacy Edge CLI (edge.sh) will be deprecated in edgeCore 4.0. For now, however, it is still available and can be run as follows:

bin/edge.sh license -f FILENAME

The server can be either running or offline. If it is offline, the command will be run once the server has started.

Obtain a License #

To request a license, contact your product reseller, account manager, or Edge Support.