License System

MINI-LINK 6654 and MINI-LINK 6655

Description

74/1551-HRA 901 20/11 Uen B

Copyright

© Ericsson AB 2018. All rights reserved. No part of this document may be

reproduced in any form without the written permission of the copyright owner.

Disclaimer

The contents of this document are subject to revision without notice due to
continued progress in methodology, design and manufacturing. Ericsson shall
have no liability for any error or damage of any kind resulting from the use of this
document.

Trademark List

74/1551-HRA 901 20/11 Uen B | 2018-11-29

 Contents

Contents

1 License System Overview 1

2 Licenses 3
2.1 Licensing of Features 3
2.2 Licensing Modes 3
2.3 Unlocked Periods 4
2.4 License Handling 9

3 Inventory and Reports 11

4 Fingerprint 13

5 Removable Memory Module 14

6 Information Handling for Licensing Mode 15

7 Monitoring Mode 16

8 License Management Tools 17

74/1551-HRA 901 20/11 Uen B | 2018-11-29

License System

74/1551-HRA 901 20/11 Uen B | 2018-11-29

 License System Overview

1 License System Overview

The licensed software features for the MINI-LINK 6600 products are divided into
three types according to the Ericsson Software Model (ESM):

— Base Package: for example, it contains the MINI-LINK 6600 R1 Basic SW

License and other functions included in the standard product offering.

— Value Packages: available for different areas containing licenses to enhance

functionality.

— Capacity Licenses: for increasing the capacity above the level provided in the
standard product offering.

Under certain circumstances, the system or the user is entitled to an unlock

period, during which license controlled features can be used without sufficient
license.

The Base Package provides a fully functional Network Element (NE) and is the
part of the standard product offering.

Value Packages and Capacity Licenses, when enabled, enhance the functionality
and the capacity of the NE. The basic features are licensed through the Base
Package. The Base Package is mandatory and is valid for the full MINI-LINK
6600 R1 release.

License-controlled features have two licensing modes:

— Locked Mode

— Unlocked Mode

Licenses need to be installed in the NE to permanently enable MINI-LINK 6600

features.

To make the license installation easier, the licenses of an NE are contained in a

License Key File (LKF). The LKF can be uploaded to an FTP server and, from
there, downloaded and installed on the NE. The license installation can be made
both locally and remotely, without disturbing the traffic through the NE. Licenses
can also be preinstalled at delivery, when a complete and preconfigured NE is
ordered.

Note: In MINI-LINK 6600 warnings are issued to show where features are
used without sufficient licenses. Install the correct number of licenses on
the LKF or possibly reconfigure the NE to remove the raised license
warnings.

Alternatively, use Monitoring Mode, for more information, see Monitoring Mode
on page 16.

74/1551-HRA 901 20/11 Uen B | 2018-11-29 1

 License System

For a detailed description of the different licences, see MINI-LINK 6600 R1 ESM
and Capacity Licenses.

2 74/1551-HRA 901 20/11 Uen B | 2018-11-29

 Licenses

2 Licenses

All NEs have a baseline of features that are available with the Basic SW license in
the Base Package. Optional value packages and Capacity features are controlled
by one or more license keys and can be enabled by installing the required licenses
when needed. The licenses installed on an NE can be viewed locally or remotely,
as they are a part of the NE inventory.

For more information on license installation and management, see Installing and
Managing Licenses.

2.1 Licensing of Features

The basic, optional, and capacity features in MINI-LINK 6600 are licensed
through Software Licenses.

2.1.1 Basic SW License

A Basic SW license is required to use the basic features and is therefore
mandatory. The Basic SW license is always connected to a certain main release
and is preinstalled in production when possible.

2.1.2 Optional and Capacity SW Licenses

A SW license for an optional or capacity feature enables only the specific feature
related licenses.

2.2 Licensing Modes

License controlled features have two licensing modes: locked mode and unlocked
mode. Table 1 shows an overview regarding the different licensing modes.

Table 1 Licensing Modes

Licensing License Status System Response
Mode
Unlocked Installed License controlled features are never blocked
Mode or degraded.
Not installed License controlled features are never blocked
or degraded.
The following alarm is raised due to unlocked
mode:

74/1551-HRA 901 20/11 Uen B | 2018-11-29 3

 License System

Licensing License Status System Response

Mode
—License Handling Is in an Unlocked Period

The alarm is raised with Minor severity if

none of the license controlled features is
used without the corresponding licenses
installed.
The alarm is raised with Major severity if any
license controlled feature is used without the
corresponding license installed.
The following alarm is raised when the
license controlled feature is used without the
corresponding license installed:
—FAL <Number> License Missing –
<KeyProductName> (Major)

For more information about the raised

alarms, see the applicable alarm description
as follows:
—License Handling Is in an Unlocked Period

—FAL <Number> License Missing -

<KeyProductName>
Locked Mode Installed License related features are not blocked or
degraded.
Not installed License controlled features are blocked or
degraded as follows:
—An unlocked period expires and there is no
available license for the startup
configuration.

—The following alarm is raised: FAL

<Number> License Missing –
<KeyProductName> (Critical)

For more information about the raised

alarm, see FAL <Number> License Missing
- <KeyProductName>.

Configuration of the license controlled

features is not possible without the required
licenses.

2.3 Unlocked Periods

Under certain circumstances, the system or the user is entitled to an unlock
period, during which license controlled features can be used without sufficient

4 74/1551-HRA 901 20/11 Uen B | 2018-11-29

 Licenses

license. If a licensed feature is used without sufficient licenses, a license failure

alarm is raised. License failure alarms can be removed by installing a license for
the optional or capacity feature in question or by possibly reconfiguring the NE.

Note: The countdown of the unlock period is stopped during a restart or

downtime.

If the unlock period expires and some license controlled functionality are
already configured, the functionality will be limited. For example, the
capacity on a radio link may be limited to the basic capacity of the Radio
Link. See MINI-LINK 6600 R1 ESM and Capacity Licenses for details
regarding the consequences of missing licenses fir the different functions
and capacities.

The rest of this section describes the different types of unlock periods.

2.3.1 System Activated Unlocked Periods

Under certain circumstances, the NE can automatically enter an unlocked period,
during which it is possible to use all license controlled features.

— SW Upgrade to a New Main SW Release

The NE enters this unlocked period when the software in an NE is upgraded

to a new main release and the Basic SW license of the new release is
required. This type of unlocked period allows the user to install the new Basic
SW license to the NE after the upgrade.

Enter Unlocked Exit Unlocked Number of Restriction of

Unlocked Period Period Days in the Usage
Period Condition Unlocked
Period
The NE All license —The 180 The NE can
automatically controlled unlocked enter the
enters the features are period unlocked
unlocked possible to expires. period 1 time
period when use. per main SW
the SW is —There are no release.
upgraded to a missing
new main SW licenses.
release.(1)
(1)The NE does not enter the unlocked period if there are no missing licenses.

— SW Upgrade from an Unlocked Mode Release to a Locked Mode Release

The NE enters this unlocked period when the software in an NE, which only
supports unlocked mode, is upgraded to a release that supports locked mode.

74/1551-HRA 901 20/11 Uen B | 2018-11-29 5

 License System

This type of unlocked period allows the user to install missing licenses to the
NE after the upgrade.

Enter Unlocked Exit Unlocked Number of Restriction of

Unlocked Period Period Days in the Usage
Period Condition Unlocked
Period
The NE All license —The 180 The NE can
automatically controlled unlocked enter the
enters the features are period unlocked
unlocked possible to expires. period 1 time.
period when use.
the SW is —There are no
upgraded missing
from a release licenses.
that only
supports
unlocked
mode to a
release that
supports
locked mode.
(2)

(1)The NE does not enter the unlocked period if there are no missing licenses.

— Contact Lost with RMM/LKF

The NE enters this unlocked period when the contact with the RMM/LKF is
lost. This type of unlocked period allows time to the user to repair the RMM
or the HW unit that contains the RMM.

Enter Unlocked Exit Unlocked Number of Restriction of

Unlocked Period Period Days in the Usage
Period Condition Unlocked
Period
The NE All license —The 180 N/A
automatically controlled unlocked
enters the features that period
unlocked were expires.
period if connected to
contact with the licenses on —Contact
the installed the RMM are with
LKF is lost in the only ones RMM/LKF is
runtime due to that can be reestablishe
RMM removal, used. d.
RMM memory
failure, or
other RMM

6 74/1551-HRA 901 20/11 Uen B | 2018-11-29

 Licenses

Enter Unlocked Exit Unlocked Number of Restriction of

Unlocked Period Period Days in the Usage
Period Condition Unlocked
Period
communicatio
n error.(3)
(1)The deletion of the LKF due to factory reset does not activate the unlocked period.

2.3.2 User Activated Unlocked Periods

The user can enter an unlocked period, during which it is possible to use all
license controlled features.

— Integration Unlock

Use Integration Unlock feature, which unlock the system and allows the user
to configure the system as wanted before requesting and installing licenses.

Enter Unlocked Exit Unlocked Numb Toke Refill of

Unlocked Period Period er of ns(1) Integration
Period Condition Days Unlock Tokens
in the
Unlock
ed
Period
The user The NE is —The 60 1 Tokens are
activates completely unlocked refilled as
Integration unlocked. All period follows:
Unlock license expires.
feature. controlled —Manually,
features are —Manually by when the
possible to user PNM is
use. command.(2) repaired at
Ericsson
Repair Center.

—Automatically
by the NE,
when
installing a
new LKF with
higher
sequence
number than
the previous
one.

74/1551-HRA 901 20/11 Uen B | 2018-11-29 7

 License System

(1)Tokens limit the number of times the unlock feature is used.

(2)The user cannot execute this command if any licenses are missing.

— Maintenance Unlock

Under certain circumstances the user is entitled to use Maintenance Unlock

feature for urgent maintenance purposes. This feature resets the
Maintenance Unlock mechanism at one time for one MINI-LINK 6600.

Enter Unlocked Exit Unlocked Numb Toke Refill of

Unlocked Period Period er of ns(3) Maintenance
Period Condition Days Unlock Tokens
in the
Unlock
ed
Period
The user The NE is —The 7 2 To refill the
activates the completely unlocked tokens, the
Maintenance unlocked. All period Maintenance
Unlock license expires. Unlock refill
feature. controlled license is
features are —Manually by required. If the
possible to user number of the
use. command.(4) tokens is less
than two, the
NE
automatically
sends an alarm
and requires the
installation of a
new LKF with
the refill.
(1)Tokens limit the number of times the unlock feature is used.
(2)The user cannot execute this command if any licenses are missing.

— Emergency Unlock

Use Emergency Unlock feature in extraordinary situations, for example,

natural disasters or major network malfunction. This feature resets the
Emergency Unlock mechanism at one time for one MINI-LINK 6600.

8 74/1551-HRA 901 20/11 Uen B | 2018-11-29

 Licenses

Enter Unlocked Exit Unlocked Numb Toke Refill of

Unlocked Period Period er of ns(5) Emergency
Period Condition Days Unlock Tokens
in the
Unlock
ed
Period
The user The NE is —The 7 2 To refill the
activates the completely unlocked tokens, the
Emergency unlocked. All period Emergency
Unlock license expires. Unlock refill
feature. controlled license is
features are —Manually by required. If the
possible to user number of the
use. command.(6) tokens is less
than two, the
NE
automatically
sends an alarm
and requires the
installation of a
new LKF with
the refill.
(1)Tokens limit the number of times the unlock feature is used.
(2)The user cannot execute this command if any licenses are missing.

2.4 License Handling

Licenses are delivered in an LKF, together with a receipt and a functional
specification. The functional specification, also referred to as license certificate, is
a document that lists all ordered licenses for a particular NE. It includes the
product number of each license, a short description of the feature, quantity, and
validity dates.

The software installed on the NE contains both the basic features, optional
features, and capacity features. The basic features support initial installation and
operation at basic capability level. The licensed optional or capacity features
offer the possibility to expand the NE with, for example, traffic capacity or
increased protection levels. The licenses unlock the requested features on a
software level, and there is no need to change the plug-in units as long as the
plug-in unit can handle the desired functionality.

Licenses are either preinstalled on the RMM at delivery or delivered and installed
later by the user. The latter is used when the orders for hardware and licenses are
handled separately, or when upgrade licenses are ordered for already installed
hardware.

74/1551-HRA 901 20/11 Uen B | 2018-11-29 9

 License System

2.4.1 License Request File

The License Request File (LRF) is an Extensible Markup Language (XML) file that
is used for requesting licenses to the NE. The LRF indicates by default which
licenses the NE needs. It is possible to manually add or remove the number of
licenses in the LRF.

2.4.2 License Key File

The LKF is an XML file containing licenses. It is identified by the name of the
system used to generate the LKF, the RMM fingerprint of the NE it is generated
for, and a sequence number. LKFs are generated using the Ericsson licensing
system.

The sequence number is increased every time an issuer generates an LKF for a
specific RMM fingerprint. The sequence number of the LKF that is installed must
be equal or higher than the sequence number of the LKF that is currently in use.
This means that it is not possible to install licenses from older LKFs, or to
downgrade using an older LKF.

The LKF also has a signature, which is an encrypted character string used to
verify the license to use in a specific NE. The license content of an LKF can only
be changed by generating a new file. Changes made directly in the LKF cause an
incorrect signature. The LKF is then corrupted and cannot be used.

A new generated LKF contains both the new licenses and all the previously
installed licenses that are not substituted.

2.4.3 License Upgrade

To upgrade the licenses on MINI-LINK 6600, new licenses must be uploaded to
an FTP server. The license installation, which copies the LKF from the FTP server
to the MINI-LINK 6600, can be made both locally and remotely, without
disturbing the traffic through the MINI-LINK 6600.

10 74/1551-HRA 901 20/11 Uen B | 2018-11-29

 Inventory and Reports

3 Inventory and Reports

The NE can generate a license report file containing the license inventory report
with the following information:

— General licensing data:

• Date when NE license status report file is generated

• NE name

• IP-address

• Fingerprint

• Available Integration Unlock tokens

• Date when Integration Unlock is used

• Available Maintenance Unlock tokens

• Total number of performed Maintenance Unlocks

• Date of the latest performed Maintenance Unlock

• Available Emergency Unlock tokens

• Total number of performed Emergency Unlocks

• Date of the latest performed Emergency Unlock

• Inventory data for all licenses

— Data per license:

• Installed

The number of licenses that are installed on the NE.

• Unlocked by user

The number of licenses that the user unlocked.

• Available for use

The number of licenses that are possible to use.

• In use

The actual number of licenses used.

74/1551-HRA 901 20/11 Uen B | 2018-11-29 11

 License System

The report file is protected with an MD5 checksum.

MINI-LINK 6600 transfers the license report file to an FTP server destination.
The report file is archived and zipped to .tgz format when transferred to the FTP
destination.

12 74/1551-HRA 901 20/11 Uen B | 2018-11-29

 Fingerprint

4 Fingerprint

The fingerprint for an RMM is an identifier required for license control and
delivery. It is used to bind the LKF with its licenses to the individual NE to unlock
features. The fingerprint is the unique identity of the RMM for which the LKF is
generated. The licenses contained in an LKF can only be installed on the NE
where the RMM fingerprint matches the fingerprint stated in the LKF.

74/1551-HRA 901 20/11 Uen B | 2018-11-29 13

 License System

5 Removable Memory Module

The RMM is the physical media where the licenses are stored. It is a removable
secure smart card placed in a socket on the PNM. All licenses stored in the RMM
are controlled by the PNM, and are bound to the RMM fingerprint.

The RMM also stores the current configuration of the NE. If the PNM needs to be
replaced, the RMM can be moved to the new PNM with all licenses and
configuration information intact.

To use licenses, PNMs without a possibility to use an RMM must be replaced with
an PNM where an RMM can be used. For PNMs lacking an RMM, an RMM must
be ordered.

For information regarding how to replace the RMM, see Replacing an RMM.

14 74/1551-HRA 901 20/11 Uen B | 2018-11-29

 Information Handling for Licensing Mode

6 Information Handling for Licensing Mode

While the licenses are stored on the RMM, the licensing mode information is
stored in the internal flash memory of the PNM.

The following licensing mode information is associated to the PNM:

— Licensing mode: either locked mode or unlocked mode.

— When the NE is in unlocked mode, the type of the unlocked period used.

— When the NE is in unlocked mode, the start time of the unlocked period.

— When the NE is in unlocked mode, the remained time of the unlocked period.

An PNM replacement has effect on the licensing mode, even if the RMM from the
old PNM is used. When performing an PNM replacement, it is not possible to keep
the licensing mode of the old PNM. The licensing mode of the new PNM is
applicable after the replacement.

Before any PNM replacement, it is recommended to investigate the software and

the licensing mode of the new PNM. For more information on the possible
replacement cases, see Replacing an PNM.

74/1551-HRA 901 20/11 Uen B | 2018-11-29 15

 License System

7 Monitoring Mode

An alternative to the Licensing Mode is the use of Monitoring mode, referring to

the process of monitoring the use of licensed features in a MINI-LINK network. In
this mode the operator is able to configure license controlled features without
first installing a valid software license key for each feature. The only license that
is needed to be activated and installed on all the NEs is Enable Monitoring
license. After the Enable Monitoring license is installed, Ericsson performs an
audit on regular basis. In Monitoring mode, all new licenses remain unactivated
in the Ericsson license register and the operator is allowed to unlock the license
controlled features without installing the corresponding license keys on the NE.
An initial business agreement is the prerequisite for running Monitoring mode.

For more information, refer to Managing Licenses in Monitoring Mode.

16 74/1551-HRA 901 20/11 Uen B | 2018-11-29

 License Management Tools

8 License Management Tools

The following license management tools are available:

— MINI-LINK Node GUI, which is a local management tool for installation and
configuration of an individual NE. It includes tools to create license requests,
install received LKFs, and view installed licenses. The management
operations available in MINI-LINK Node GUI are described in Installing and
Managing Licenses.

— ServiceOn Element Manager, which is used for central management of one or

more NEs from a remote location. For more information regarding ServiceOn
Element Manager, see the corresponding Customer Product Information.

— Command Line Interface (CLI), which is a text-based configuration tool

similar to industry standards used for configuration and troubleshooting. For
more information about the CLI, see CLI User Guide.

74/1551-HRA 901 20/11 Uen B | 2018-11-29 17

 License System

18 74/1551-HRA 901 20/11 Uen B | 2018-11-29