In this section:

Related articles:

NWDL Overview

SBC SWe deployments support a domain-based licensing model referred to as Network-Wide Domain Licensing (NWDL). In contrast to node-locked licensing, a domain license is tied to an administrative domain rather than the hardware ID for a specific host server or the UUID for a specific node instance. A domain license is bound to the domain through public/private key-pairing and it defines the features and capacity allowed for all nodes within the domain. NWDL provides flexibility in cloud environments where the number and placement of nodes sometimes varies. Contact your Ribbon representative for more information on available licensing options and to complete the ordering process that is required prior to implementing NWDL.

Note

The NWDL license model is supported on the following virtual/cloud platforms.

  • OpenStack
  • VMWARE (N:1)
  • Amazon Web Services(AWS)
  • RHV

The NWDL license model is currently not supported on hardware SBC platforms (5400/7000).

NWDL is implemented using license management capabilities within the Insight Element Management System (EMS). The EMS provides the public key used to bind the license to the local domain and is used for associating license data with eligible nodes. The basic steps to implement domain licensing are as follows:

  • Log into the EMS managing the SBC SWe cluster and copy the EMS domain public key.
  • Submit the copied public key, along with the order details, to the self-service licensing portal to generate a license bundle file that incorporates the domain public key.
  • Install the NWDL license bundle on the EMS.
  • From the EMS, add the feature licenses to the SBC cluster configuration. The licenses are added to the OAM which then replicates the configuration (including licenses) to the SBC nodes. 

Refer to the License Management section in EMS documentation for specific procedures to locate and copy the public key, install a license bundle, and associate feature licenses with SBC nodes.

After these preparations are completed on the EMS, enable domain-based licensing on the SBC cluster by configuring the license mode as "domain." Save and activate the configuration. The OAM node for the cluster provides the configuration update to each SBC node in the cluster. The nodes then enable or disable features based on the license definition in their configuration.

Important

The NWDL license bundle must be added to the SBC cluster configuration before or at the same time you change the license mode to "domain." Changing license mode to domain on an active system without an NWDL license bundle installed will result in a service outage.

Note

If you push the count-based license, the "show table system licenseInfo" table displays "USAGE LIMIT" as 999999.
If you push the ON/OFF-based license, the "show table system licenseInfo" table displays "USAGE LIMIT" as 1.

Note

The in-use column does not increment for the active sessions if the license type is ON/OFF.

Adding License Capacity

In domain licensing mode, you can add to your existing license definition following the same process to load another license bundle file onto the EMS, and using the EMS to assign the additional features licenses to the SBC clusters. The resulting set of licenses features and capacity for the cluster is the aggregate of the existing license and the added license.

Full-Capacity Licensing Option

When configured for NWDL, the SBC supports a "full-capacity" option in which the counts for individual, counted license features are no longer used to limit activity on the SBC. Enabling the full-capacity feature effectively enables feature use up to the capacity of the node. Actual license usage is reported to Ribbon using EMS statistics.

The full-capacity feature requires the SBC-CAPACITY-D license key in the license file. Contact your Ribbon representative for more information on the use of the full-capacity licensing option. 

Note

The NWDL architecture permits the nodes to burst to capacity when the "D" feature ID is present (SBC-RTU-D).

Note

If the License SBC-CAPACITY-D is present, the SBC does not need to register with the License Manager.

Call processing and operations are not interrupted regardless of the registration state of the SBC with the License Manager. Even if the SBC cannot register with the License Manager, calls are not interrupted. If the SBC remains disconnected from the managing EMS/RAMP instance for an extended period, it will result in the SBC operating in an unsanctioned manner from a licensing perspective. You must reconnect the SBC to the managing EMS/RAMP instance. Contact Ribbon Global Product Support for more information regarding the need for the SBC to remain in constant contact with the managing EMS/RAMP instance.

Configuring NWDL Options

Use the SBC CLI or access the SBC Configuration Manager UI from the EMS to enable domain license mode and optionally specify license capacity limits for the nodes in the cluster. Refer to Modifying SBC Cluster Configuration.

Enable Domain License Mode

Caution

To avoid a service outage, ensure your NWDL licenses are already installed if you reconfigure an SBC cluster into domain license mode.


By default, SBC license mode is set to nodeLocked. Use the following CLI commands to place the SBC in domain (NWDL) license mode:

Enable Domain License Mode using CLI
% set system licenseMode mode domain
% commit

Or, in the SBC Configuration Manager UI:

  1. Go to All > System > License Mode  The License Mode window opens.
  2. In Mode, select Domain.
  3. Click Save.

Displaying Domain License Bundle Information

Use the following command to output information on the domain license bundles loaded into the system.

 > show table system licenseDomainBundleInfo

Alternatively, in the SBC Configuration Manager UI, go to All > System > License Domain Bundle Info  

The License Domain Bundle Info window opens with the following license details:

  • Active License Mode – The licensing mode currently in use by the SBC
  • Bundle Name – License bundle name
  • Expiration Date – License expiration date
  • Feature Name – license keys for each licensed feature
  • Generation Date – The date the license was generated
  • Install Date – The date the license was installed
  • License ID – License identifier
  • Line ID – The line ID for the license feature entry
  • Purchase Order ID – The purchase order ID specified when the license was generated
  • Usage Limit – Usage limit for the licensed feature