Installation - License

The purpose of this tutorial is to show you how to install a license fileon the Callbox. (Same process applies to UEsim as well). There are several different license scheme for Amarisoft as listed below :

• Fixed License : This is the license key tied up to host ID of the PC where the lte service is running. This is the most commonly used license type.
• USB License : This is the license key tied up to USB stick that is plugged into the PC where the lte service is running
• Floating License : This is the license key provided by the license server located anywhere your system get access to via network.
• Demo License : This is the license key provided only for demo / evaluation purpose. You need to reach out to sales@amarisoft.com to get the demo license. This is not for commercial usage.

NOTE : This tutorial is for Fixed License installation for now.

Table of Contents

• Installation - License
• Introduction
• Summary of the Tutorial
• Download license
• Install
• Getting the license Info
• Handling License Issues

Introduction

Amarisoft Callbox is a robust and flexible software-based test solution widely used in cellular network development, validation, and quality assurance workflows. It emulates various elements of a mobile network (including eNodeB, gNodeB, EPC, and core network components) and is integral in radio protocol conformance, interoperability, and functional testing for 4G and 5G technologies. Licensing is a critical aspect of Amarisoft Callbox and UEsim systems, controlling access to features and ensuring compliance with software usage agreements. Amarisoft employs several licensing schemes: Fixed License (tied to a host machine), USB License (bound to a dongle), Floating License (managed by a network server), and Demo License (for evaluation purposes). Each licensing model is architected to balance security, flexibility, and operational requirements. The Fixed License, the focus of this tutorial, is the most prevalent—binding the license to a specific hardware identifier (host ID) and thus ensuring that the software operates only on the authorized machine. Understanding the licensing process is essential for uninterrupted operation of Amarisoft Callbox and UEsim systems, as improper installation may prevent access to vital testing features and halt development workflows. This tutorial provides a step-by-step technical guide for installing a Fixed License on the Callbox, with procedures equally applicable to UEsim, ensuring you can swiftly and securely activate your Amarisoft environment.

• Context and Background
  • Amarisoft Callbox and UEsim are advanced software tools used for simulating and testing cellular networks (LTE, 5G NR, and core network functions).
  • Licensing mechanisms control access to software features, enforce compliance, and protect intellectual property.
  • Four main licensing schemes exist: Fixed, USB, Floating, and Demo—each serving different operational and business needs.
  • The Fixed License is tightly coupled to the host PC’s hardware, providing a secure and predictable deployment model.
• Relevance and Importance
  • Correct license installation is foundational for system activation and continued access to Amarisoft’s advanced features.
  • Improper licensing can cause service interruptions, hinder testing, and disrupt deployment pipelines.
  • This tutorial focuses specifically on the Fixed License, the most common deployment model for development and production environments.
• Learning Outcomes
  • Understand the different Amarisoft licensing schemes and their operational implications.
  • Gain hands-on experience installing a Fixed License file on Callbox and UEsim.
  • Learn best practices for validating license installation and troubleshooting common issues.
  • Acquire the skills necessary to maintain licensing compliance and ensure uninterrupted system operation.
• Prerequisite Knowledge and Skills
  • Familiarity with Linux or Windows command line interface—as license installation typically involves shell operations.
  • Basic understanding of Amarisoft Callbox or UEsim system architecture.
  • Access privileges to the target host where the license will be installed.
  • Possession of a valid Fixed License file provided by Amarisoft (associated with the host machine’s hardware ID).

Summary of the Tutorial

This tutorial covers the procedures for handling Amarisoft license files, including downloading, installing, verifying, and troubleshooting license issues.

• License Download Procedure:
  • Access the Amarisoft web download site to obtain your license file.
  • Download the provided license file to your local system.
• License Installation Procedure:
  • Navigate to the {HOME} directory, typically /root for Amarisoft Callbox.
  • Check for the existence of the .amarisoft directory under /root.
  • If the .amarisoft directory does not exist (such as on a new installation), create it manually under /root.
  • Place the downloaded license file into the /root/.amarisoft directory.
• License Verification Procedure:
  • To verify that the license is installed and functioning, use the license command in the screen window.
• Handling License Issues:
  • If a license problem occurs (e.g., license expired or missing), an error message including the Host ID will be displayed.
  • Send the Host ID to Amarisoft to request a new or updated license file.
  • Once received, repeat the installation procedure by placing the new license file in the /root/.amarisoft directory.

These procedures ensure proper management and troubleshooting of Amarisoft license files for both new and existing installations.

Download license

Amarisoft will provide the license in your web download site as shown below. Download the license file

The panel lists one row for each license you own. The Type column says Fixed here, so this key is bound to one host. The Code(s) column carries that host ID, 12-58-29-6b-22-cd-44-fe. Check that the code matches the machine you are installing on before you download anything.

Software update validity tells you how long the update entitlement still runs. This one has 1 month and 18 days left. After that date the software update service is no longer available for this key.

The Licenses column on the right holds the files themselves. Two are listed here, EPC/5GC and eNB/gNB-600. Each name is a link and downloads one key file. Take the ones that match the products you run on this host.

Install

Installation of license is done just by putting the license file into a specific directory. There is no specific installation program (script).

If you go the the {HOME} directory (in most case /root is the home directory for Amarisoft Callbox), you would see the directory .amarisoft. (NOTE : In some cases (like you just installed the callbox on brand new PC), you may not find this directory. In that case, create the directory .amarisoft )

pwd is run first and returns /root. That is the home directory of the root user on a Callbox. It is where the license directory has to sit.

The .amarisoft entry is the underlined one in the ls -al output. It is an ordinary directory owned by root with mode drwxr-xr-x. The name starts with a dot, so a plain ls will not list it. Use ls -al or ls -a when you go looking for it.

If the directory is really not there, create it with mkdir /root/.amarisoft. The lteenb documentation also lets you move this path with the AMARISOFT_PATH shell variable. On a Callbox delivered as it is you do not need to touch that.

Go to the directory /root/.amarisoft. (NOTE : If you use the Amari Callbox or UE sim as it is, you would always have this directory. But if you want to install the license to a new computure of your own, create this directory under /root directory)

The prompt reads root@CBC-2021050100, so the command is typed as root on the Callbox itself. Root is required here because /root carries mode dr-xr-x--- and no other user can enter it.

After the cd the prompt tail changes from ~ to .amarisoft. That is how you can tell the listing in the next step was taken inside the license directory.

Check if there is license file. If you get a new license key, put the license file in this directory

This Callbox already has one file in the directory, ltedev.key, 543 bytes and owned by root. That single file is the license. There is no installer and no script to run after you copy it in.

Mode -rw-r--r-- with owner root is enough. Keep the file under the name it was downloaded with. The lteenb documentation asks for lteenb.key in this same directory, so each product looks for its own file name here.

To replace an expired key, copy the new file into this directory and restart the lte service.

Getting the license Info

This section is for a system that is already running normally. It shows how to read out what the installed license actually says, without opening the key file. The expiry date and the host ID are the two values Amarisoft asks for when you renew.

If you have normal / functioning license, you can still get the license with the command 'license' in screen window as shown below

license is a monitor command, so it is typed at the prompt inside a screen window and not in a shell. The prompt here is (mme), which is the core window of the session.

The first line names who the license is issued to. The second gives the date the support and software update entitlement ends, 2024-10-22 in this case. That is the same validity the download site reports as a remaining time.

License ID is the host ID the key is bound to, 6d-68-da-96-70-22-cd-79. It is the 16 digit hexadecimal code that identifies the PC. The last line gives the UID, 3715_27_6090. Quote both values when you contact Amarisoft about this license.

Handling License Issues

If you have any problem with license (e.g, license expired, no license file etc). You would get the message as shown below with Host ID . Send the Host ID to Amarisoft and request proper license file. Then Amarisoft will provide the license in your web download site

The three steps run in order. service lte restart restarts the lte service. screen -r attaches to the screen session that the service created. The mme window is where the core prints its banner, and on this machine the failure.

The failing line is No license found, and it comes right after the Core version 2021-11-19 banner. The core stops there and does not go any further. Below it the software prints where to go, https://support.amarisoft.com for a ticket or delivery@amarisoft.com by mail.

The value you have to send is the Host ID, 6d-68-da-96-70-22-cd-79. That is the 16 digit hexadecimal code identifying this PC. The same lines are repeated further down as shell comments, and the launch is tried again with the same result. The error stays until the key file is in /root/.amarisoft. After you copy it in, run service lte restart again and attach with screen -r to check.