История страницы

ecss-license-agent is a component of the SSW and is part of the ecss-node package. It requires no separate configuration.

The Ecss License Provider can be installed on either the SSW or a dedicated server. If the Ecss License Provider is already installed on your project, you only need to add an entry for the new component in the LP configuration file, and the next step, "LP Installation," will not be required.

To install the ecss-license-provider package, it is necessary to run the following command:

sudo apt install ecss-license-provider 

When installing the ecss-license-provider package, you will be asked the following questions:

The data is saved in a file - /etc/ecss/ecss-license-provider/config.env:

ECSS_LM_HOST=0.0.0.0
ECSS_LM_PORT=4321
ECSS_LM_LOG_LEVEL=info
RELEASE_COOKIE=ecss-abf-lm-cluster

Run the command:

sudo nano /etc/ecss/ecss-license-provider/config.yaml

elm_addresses: []
licenses: []
ecss_nodes: []

In the elm_adresses field specify a list of ELM servers to which you want to connect to obtain licenses. The first address in the list is used as the primary address. Additional address lines act as backups.

example:
- "elm.eltex-co.ru:8099"
- "192.168.111.22:8099"
- "elm-3.eltex.loc:8099"

Next, the licenses themselves are specified in the licenses field.

• id – can be any, as long as it is unique for each license. This only affects the license address on the LP itself (e.g., 0, 1, 2, 3).
• kind – only ssw is supported for SSW.
• type – select elm if this license needs to be requested from the ELM server. If you need to use a file-based SSW license, select ecss_license.
  • For elm type, you must specify the license_key and product_id fields to identify the license.
  • For ecss_license type, specify the license field, which contains the static license key.

ecss_nodes block

Specify the details of the services that will receive the license. In our case, it is the SSW. The service is defined by three parameters:

• id – the service identifier; must match the ECSS_ID of the licensed SSW.
• kind – the type of service being licensed. Similar to the license block, only ssw is supported for SSW.
• license_id – the identifier of the license that will be sent to this service. Corresponds to the license identifiers from the licenses block.

[A-Za-z0-9][A-Za-z0-9.-][A-Za-z0-9]

elm_addresses:
 - "elm.eltex-co.ru:8099"
 - "192.168.111.22:8099"
 - "elm-3.eltex.loc:8099"
licenses:
 - id: 0
   kind: SSW
   type: elm
   license_key: "ssw1test"
   product_id: "ECSS1000001"
 - id: 1
   kind: ssw
   type: ecss_license
   license: "af615ebb92d381125ff"
ecss_nodes:
 - id: abf.test
   kind: ssw
   license_id: 0

Restart the ecss-license-provider.service to update the configuration from the /etc/ecss/ecss-license-provider/config.yaml file using the following command:

sudo systemctl restart ecss-license-provider.service

If LP is already installed and used on the local network, you need to add the new SSW parameters to the /etc/ecss/ecss-license-provider/config.yaml configuration file in the licenses and ecss_nodes blocks.

Run the command:

sudo nano /etc/ecss/ecss-license-provider/config.yaml

Example:

elm_addresses:
 - "elm.eltex-co.ru:8099"
 - "192.168.111.22:8099"
 - "elm-3.eltex.loc:8099"
licenses:
 - id: 0
   kind: SSW
   type: elm
   license_key: "ssw1test"
   product_id: "ECSS1000001"
 - id: 1
   kind: ssw
   type: ecss_license
   license: "af615ebb92d381125ff"
 - id: 2
   kind: SSW
   type: elm
   license_key: "ssw2test"
   product_id: "ECSS1000002"
ecss_nodes:
 - id: 1.test
   kind: ssw
   license_id: 0
 - id: 2.test
   kind: ssw
   license_id: 1
 - id: 3.test
   kind: ssw
   license_id: 2

elm_addresses:
 - "elm.eltex-co.ru:8099"
 - "192.168.111.22:8099"
 - "elm-3.eltex.loc:8099"
licenses:
 - id: 0
   kind: SSW
   type: elm
   license_key: "ssw1test"
   product_id: "ECSS1000001"
 - id: 1
   kind: ssw
   type: ecss_license
   license: "af615ebb92d381125ff"
 - id: 2
   kind: SSW
   type: elm
   license_key: "ssw2test"
   product_id: "ECSS1000002"
 - id: 3
   kind: SSW
   type: elm
   license_key: "ssw3test"
   product_id: "ECSS1000003"
ecss_nodes:
 - id: 1.test
   kind: ssw
   license_id: 0
 - id: 2.test
   kind: ssw
   license_id: 1
 - id: 3.test
   kind: ssw
   license_id: 2
 - id: abf.test
   kind: ssw
   license_id: 3

Restart the ecss-license-provider.service to update the configuration from the /etc/ecss/ecss-license-provider/config.yaml file using the following command:

sudo systemctl restart ecss-license-provider.service

/system/clusters/set [ecss1, ecss2]

/system/licence/manager/set --hosts [https://10.0.10.51:4321, https://10.0.10.52:4321]

If LP is installed on SSW hosts, specify OAM IP addresses.

/system/licence/manager/show-status           
┌───────────────────────┬───────┬─────┐
│         Host          │Current│Alive│
├───────────────────────┼───────┼─────┤
│https://10.0.10.51:4321│*      │true │
│https://10.0.10.52:4321│       │true │
└───────────────────────┴───────┴─────┘

Failure to connect to the License Manager/ELM will be equivalent to a loss of access to the token, leading to critical crashes and a transition to emergency mode, after which, if the connection is not restored, the system will switch to the default license.

_{This behavior only applies when operating in ELM mode.}

/cluster/storage/ds1/licence/request

/cluster/storage/ds1/licence/list-licence 
┌──┬───────────────────┬────────────┬──────┬────────────────┬────────────────────┬────────────────────┬─────────┐
│Id│Creation date(UTC) │   SSW ID   │Active│  Description   │Comm. Exp. Date(UTC)│Expiration date(UTC)│Time left│
├──┼───────────────────┼────────────┼──────┼────────────────┼────────────────────┼────────────────────┼─────────┤
│1 │12.03.2026 18:40:00│ECSS 010070 │*     │ECSS TPM License│13.03.2027 06:59:59 │14.03.2026 10:44:05 │1d 6h 59m│
│0 │01.01.1990 00:00:00│ECSS DEFAULT│      │Default licence │                    │                    │         │
└──┴───────────────────┴────────────┴──────┴────────────────┴────────────────────┴────────────────────┴─────────┘

TPM is a complete analogue of the licensing that was used previously, with a token and passport, without connection to the LP.

/cluster/storage/ds1/licence/list-licence 
┌──┬───────────────────┬────────────┬──────┬────────────────┬────────────────────┬────────────────────┬─────────┐
│Id│Creation date(UTC) │   SSW ID   │Active│  Description   │Comm. Exp. Date(UTC)│Expiration date(UTC)│Time left│
├──┼───────────────────┼────────────┼──────┼────────────────┼────────────────────┼────────────────────┼─────────┤
│1 │03.02.2026 16:26:34│ECSS2000009 │*     │ECSS ELM License│03.02.2027 16:26:34 │14.03.2026 10:49:12 │1d 6h 59m│
│0 │01.01.1990 00:00:00│ECSS DEFAULT│      │Default licence │                    │                    │         │
└──┴───────────────────┴────────────┴──────┴────────────────┴────────────────────┴────────────────────┴─────────┘

To use the media resource and establish connections, it is necessary to activate it in the media resource creation command: /system/media/resource/declare (parameter "is active"=true) or /system/media/resource/set (parameter "active"=true), if activation was not performed during creation. Activation can also be performed through the web interface, application - MSR network terminations (MSR-registrars).

declare

The command to declare a media server connection to ECSS-10.

To operate in preconfigured mode, one can pre-register media resources with known information.

To do this, it is necessary to create a description of known media servers with all parameters specified, allowing to start working with the media server immediately after its registration.

The command to create a media server configuration:

Command path:

/system/media/resource/declare

Syntax:

declare <node> by_contact <contact> <zone> <site> <is active>

or

declare <node> by_iface <msr> <acc_id> <iface> <zone> <site> <is active>

Parameters:

<node> — core node name;

<contact> — contact uri of the declared media resource;

<zone> — logical service zone of the MSR;

<site> — MSR service network identifier;

<is active> — media resource activity status, true/false values;

<msr> — MSR name;

<acc_id> — resource identifier number;

<iface> — interface name.

set

A command for changing media resource settings.

Command path:

/system/media/resource/set

Syntax:

set <node|*> <contact> <active|zone|site> <value>

Parameters:

<node|*> — node name;
<contact> — contact uri of the declared media resource;
<active|zone|site> — activation | zone | site;
<value> — parameter value.

/system/media/resource/set core1@ecss1 net.20@msr.ecss1 active true

/system/media/resource/set core1@ecss2 net.20@msr.ecss2  active true

/system/media/resource/set core1@ecss1 net.20@msr.ecss2  active true

/system/media/resource/set core1@ecss2 net.20@msr.ecss1  active true

/system/media/resource/set core1@ecss1 net.20@msr.ecss1 active true  
  Media resource:
┌─────────────┬──────────────────┬──────────┬───────┐
│    Node     │     Contact      │ Property │ Value │
├─────────────┼──────────────────┼──────────┼───────┤
│ core1@ecss1 │ net.20@msr.ecss1 │ active   │ true  │
└─────────────┴──────────────────┴──────────┴───────┘
/system/media/resource/set core1@ecss2 net.20@msr.ecss2 active true 
  Media resource:
┌─────────────┬──────────────────┬──────────┬───────┐
│    Node     │     Contact      │ Property │ Value │
├─────────────┼──────────────────┼──────────┼───────┤
│ core1@ecss2 │ net.20@msr.ecss2 │ active   │ true  │
└─────────────┴──────────────────┴──────────┴───────┘
/system/media/resource/set core1@ecss1 net.20@msr.ecss2 active true 
  Media resource:
┌─────────────┬──────────────────┬──────────┬───────┐
│    Node     │     Contact      │ Property │ Value │
├─────────────┼──────────────────┼──────────┼───────┤
│ core1@ecss1 │ net.20@msr.ecss2 │ active   │ true  │
└─────────────┴──────────────────┴──────────┴───────┘
/system/media/resource/set core1@ecss2 net.20@msr.ecss1 active true 
  Media resource:
┌─────────────┬──────────────────┬──────────┬───────┐
│    Node     │     Contact      │ Property │ Value │
├─────────────┼──────────────────┼──────────┼───────┤
│ core1@ecss2 │ net.20@msr.ecss1 │ active   │ true  │
└─────────────┴──────────────────┴──────────┴───────┘

info

A command for viewing connection status information for a specific media resource.

Command path:

/system/media/resource/info

Syntax:

info <node>  <contact>

Parameters:

<contact> — contact uri of the declared media resource;
<node> — node name.

/system/media/resource/info core1@ecss1 net.20@msr.ecss1
  Media resource specific for node core1@ecss1:
┌─┬─────────────────┬─────────────────────┐
│F│    Parameter    │        Value        │
├─┼─────────────────┼─────────────────────┤
│r│ Contact         │ net.20@msr.ecss1    │
│r│ Status          │ registered          │
│r│ Cc-status       │ connected           │
│r│ Cc-status uptime│ 00:39:35            │
│r│ Cc-id           │ db21af              │
│r│ Address         │ 10.0.20.51:5700     │
│r│ Register time   │ 2025/12/02 16:43:07 │
│r│ Expired         │ 84                  │
│r│ Iface           │ net.20(10.0.20.51)  │
│ │ Active          │ true                │
│ │ Zone            │ default             │
│ │ Site            │ local               │
│r│ MSR version     │ 3.18.1.0.10         │
│r│ MSR load        │ 0                   │
│r│ MSR perf coef   │ 1.0                 │
└─┴─────────────────┴─────────────────────┘

Legend:
Column F - means Flag, values r - flag for readonly parameter

list
A command for viewing a list of media resources in the ECSS-10 system.

Command path:

/system/media/resource/list

Syntax:

list [active | all | register]

Parameters:

active — display only active media resources (default);
register — display only registered media resources;
short — display minimal information;
all — display all declared media resources.

By default, the command displays a list of registered media servers.

/system/media/resource/list all
  All media resource selected list specific:
┌─────────────┬───────────┬─────────────┬───────────┬──────┬────────┬───────────┬───────────┬─────────────────┬────────┬────────────┬────────┬─────────┬───────┬──────────────────┬────────────┬─────────┐
│    Node     │    MSR    │     MSR     │    MSR    │ MSR  │ Cc-id  │ Cc-status │ Cc-uptime │   Cc-address    │ Iface  │   Iface    │ Active │  Zone   │ Site  │     Contact      │   Status   │ Expired │
│             │           │   version   │ perf coef │ load │        │           │           │                 │  name  │    addr    │        │         │       │                  │            │         │
├─────────────┼───────────┼─────────────┼───────────┼──────┼────────┼───────────┼───────────┼─────────────────┼────────┼────────────┼────────┼─────────┼───────┼──────────────────┼────────────┼─────────┤
│ core1@ecss1 │ msr.ecss1 │ 3.18.1.0.10 │       1.0 │    0 │ db21af │ connected │ 00:40:22  │ 10.0.20.51:5700 │ net.20 │ 10.0.20.51 │ true   │ default │ local │ net.20@msr.ecss1 │ registered │     156 │
│             │ msr.ecss2 │ 3.18.1.0.10 │       1.0 │    0 │ 263898 │ connected │ 00:40:22  │ 10.0.20.52:5700 │ net.20 │ 10.0.20.52 │ true   │ default │ local │ net.20@msr.ecss2 │ registered │     156 │
│ core1@ecss2 │ msr.ecss1 │ 3.18.1.0.10 │       1.0 │    0 │ db21af │ connected │ 00:41:11  │ 10.0.20.51:5700 │ net.20 │ 10.0.20.51 │ true   │ default │ local │ net.20@msr.ecss1 │ registered │     106 │
│             │ msr.ecss2 │ 3.18.1.0.10 │       1.0 │    0 │ 263898 │ connected │ 00:44:00  │ 10.0.20.52:5700 │ net.20 │ 10.0.20.52 │ true   │ default │ local │ net.20@msr.ecss2 │ registered │     177 │
└─────────────┴───────────┴─────────────┴───────────┴──────┴────────┴───────────┴───────────┴─────────────────┴────────┴────────────┴────────┴─────────┴───────┴──────────────────┴────────────┴─────────┘

set

A command for changing common and individual parameters.

Command path:

/system/media/registrar/set

Syntax for setting common parameters:

set common <FIELD> <VALUE>

Parameters:

<FIELD> — name of the parameter being configured;

<VALUE> — value of the parameter being configured

Where:

• common — the type of parameter being set;
• <common parameter> — a common media registrar parameter for all nodes: registration-timeout;
• private — the type of parameter being set;
• <node name> — the name of the node on which the media registrarresides;
• <private parameter> — a media registrar parameter that is set on <node name>: is-active, listen-interface, and listen-port.

List of parameters available for configuration:

• is-active — enables or disables the registrar (false - deactivates the registrar, the registrar stops receiving SIP traffic);

• listen-interface — the name of the interface the registrar uses;

• listen-port — the port on which the registrar accepts registration requests (default 5000);

• registration-timeout — re-registration timer, range from 60 to 86400.

In the general settings you can set the registration time; by default it is 60 seconds.

Example:
Set the registration time to 60 seconds:

/system/media/registrar/set common registration-timeout 60
Common parameter registration-timeout set to 60.

Syntax for configuring individual parameters:

system/media/registrar/set private <CORE> <FIELD> <VALUE>

Parameters:

<CORE> — the core node for which the Registrar server is being configured;

<FIELD> — the name of the configurable parameter;

<VALUE> — the value of the configurable parameter.

Configurable parameters:

• is-active — whether the Registrar server is active, true | false;
• listen-ip — the IP address on which the Registrar server will accept connections (default 0.0.0.0);
• listen-port — the network port on which the Registrar server will accept connections (default 5000).

/system/media/registrar/set private core1@ecss1 listen-ip 10.0.20.51

/system/media/registrar/set private core1@ecss2 listen-ip 10.0.20.52

/system/media/registrar/set private core1@ecss1 listen-ip 10.0.20.51   
Private parameter listen-ip set to 10.0.20.51 at node core1@ecss1.

/system/media/registrar/set private core1@ecss2 listen-ip 10.0.20.52
Private parameter listen-ip set to 10.0.20.52 at node core1@ecss2.

info

Command for viewing the current Registrar server settings.

Command path:

/system/media/registrar/info

/system/media/registrar/info
 Common parameters:
┌───────────────────────────┬───────┐
│         Parameter         │ Value │
├───────────────────────────┼───────┤
│ registration-timeout, sec │   180 │
└───────────────────────────┴───────┘
 Private parameters:
┌─────────────┬────────┬───────────┬────────────┬─────────────┐
│    Node     │ Status │ Is-active │ Listen-ip  │ Listen-port │
├─────────────┼────────┼───────────┼────────────┼─────────────┤
│ core1@ecss2 │ active │ true      │ 10.0.20.52 │        5000 │
│ core1@ecss1 │ active │ true      │ 10.0.20.51 │        5000 │
└─────────────┴────────┴───────────┴────────────┴─────────────┘

/system-status 
Checking...
┌─┬───────────────┬───────────────────────────┬───────────────────────────────┬─────────────────────┬───────┐
│ │     Node      │          Release          │         Erlang nodes          │    Mnesia nodes     │Uptime │
├─┼───────────────┼───────────────────────────┼───────────────────────────────┼─────────────────────┼───────┤
│ │core1@ecss1    │ecss-core-3.18.1.0.1656    │core1@ecss1,core1@ecss2        │not running          │43m 43s│
│ │core1@ecss2    │ecss-core-3.18.1.0.1656    │core1@ecss1,core1@ecss2        │not running          │47m 5s │
│ │ds1@ecss1      │ecss-ds-3.18.1.0.1656      │ds1@ecss1,ds1@ecss2            │ds1@ecss1,ds1@ecss2  │43m 43s│
│ │ds1@ecss2      │ecss-ds-3.18.1.0.1656      │ds1@ecss1,ds1@ecss2            │ds1@ecss1,ds1@ecss2  │47m 4s │
│ │md1@ecss1      │ecss-mediator-3.18.1.0.1656│md1@ecss1,md1@ecss2            │md1@ecss1,md1@ecss2  │43m 43s│
│ │md1@ecss2      │ecss-mediator-3.18.1.0.1656│md1@ecss1,md1@ecss2            │md1@ecss1,md1@ecss2  │47m 5s │
│ │mycelium1@ecss1│ecss-mycelium-3.18.1.0.1656│mycelium1@ecss1,mycelium1@ecss2│not running          │43m 43s│
│ │mycelium1@ecss2│ecss-mycelium-3.18.1.0.1656│mycelium1@ecss1,mycelium1@ecss2│not running          │47m 4s │
│ │sip1@ecss1     │ecss-pa-sip-3.18.1.0.1656  │sip1@ecss1,sip1@ecss2          │sip1@ecss1,sip1@ecss2│43m 43s│
│ │sip1@ecss2     │ecss-pa-sip-3.18.1.0.1656  │sip1@ecss1,sip1@ecss2          │sip1@ecss1,sip1@ecss2│47m 5s │
└─┴───────────────┴───────────────────────────┴───────────────────────────────┴─────────────────────┴───────┘

All services are started.

  Active media resource selected list specific:
┌─────────────┬───────────┬─────────────┬───────────┬───────────┐
│    Node     │    MSR    │     MSR     │ Cc-status │ Cc-uptime │
│             │           │   version   │           │           │
├─────────────┼───────────┼─────────────┼───────────┼───────────┤
│ core1@ecss1 │ msr.ecss1 │ 3.18.1.0.10 │ connected │ 00:42:49  │
│             │ msr.ecss2 │ 3.18.1.0.10 │ connected │ 00:42:48  │
│ core1@ecss2 │ msr.ecss1 │ 3.18.1.0.10 │ connected │ 00:43:38  │
│             │ msr.ecss2 │ 3.18.1.0.10 │ connected │ 00:46:27  │
└─────────────┴───────────┴─────────────┴───────────┴───────────┘

Alarms list on md1:
┌──────────────┬───────────────┬───────────────┬────────────────────┬────────────────────┬────────────────────┬────────────────────────────────────────────────────────────┐
│     Date     │   Severity    │   Location    │       Cause        │       Class        │      Instance      │                          Message                           │
├──────────────┼───────────────┼───────────────┼────────────────────┼────────────────────┼────────────────────┼────────────────────────────────────────────────────────────┤
└──────────────┴───────────────┴───────────────┴────────────────────┴────────────────────┴────────────────────┴────────────────────────────────────────────────────────────┘
Selected: 0
Total: 0

/cluster/adapter/sip1/sip/network/set ip_set test_set node-ip node = sip1@ecss1 ip = 10.0.20.31

/cluster/adapter/sip1/sip/network/set ip_set test_set node-ip node = sip1@ecss2 ip = 10.0.20.32

/cluster/adapter/sip1/sip/network/set ip_set test_set listen-ports list = [5060]

/cluster/adapter/sip1/sip/network/set ip_set test_set node-ip node = sip1@ecss1 ip = 10.0.20.31   
Property "ip_set" successfully changed from: 

   to
test_set: no ports set
test_set: sip1@ecss1 10.0.20.31
test_set: dscp 0.


/cluster/adapter/sip1/sip/network/set ip_set test_set node-ip node = sip1@ecss2 ip = 10.0.20.32
Property "ip_set" successfully changed from: 
test_set: no ports set
test_set: sip1@ecss1 10.0.20.31
test_set: dscp 0
   to
test_set: no ports set
test_set: sip1@ecss1 10.0.20.31
test_set: sip1@ecss2 10.0.20.32
test_set: dscp 0.


/cluster/adapter/sip1/sip/network/set ip_set test_set listen-ports list = [5060]
Property "ip_set" successfully changed from: 
test_set: no ports set
test_set: sip1@ecss1 10.0.20.31
test_set: sip1@ecss2 10.0.20.32
test_set: dscp 0
   to
test_set: 5060
test_set: sip1@ecss1 10.0.20.31
test_set: sip1@ecss2 10.0.20.32
test_set: dscp 0.

/domain/declare test_domain --add-domain-admin-privileges --add-domain-user-privileges

/domain/test_domain/sip/network/set ip_set [test_set]

/domain/declare test_domain --add-domain-admin-privileges --add-domain-user-privileges
New domain test_domain is declared


/domain/test_domain/sip/network/set ip_set [test_set]
Property "ip_set" successfully changed from: 
[]
   to
["test_set"].

/cluster/storage/ds1/ss/access-list add test_domain *

/cluster/storage/ds1/ss/access-list add test_domain *
Supplementary services successfully added in the domain test_domain.

/domain/test_domain/ss/licence/politics/declare new_sub "ЗадаютсяSet when приcreating созданииa абонентаsubscriber"

/domain/test_domain/ss/licence/politics/declare new_sub "ЗадаютсяSet when приcreating созданииa абонентаsubscriber"
Licence politic new_sub successfully declared.

/cluster/storage/ds1/licence/show-licence 1

/cluster/storage/ds1/licence/show-licence 1
SSW ID                                                < ИмяName SSW ID >
Description                                           Testing License                    Лицензия для тестирования Локация Location 2.

. . .  

Supplementary Services licence package(s)             
 name                                                 'ECSS-ADV'
 limit                                                50000
 description                                          "Весь пакет услугThe whole package of services"
 SS list                                              [1,2,3,4,5]
                                                      
. . . 

/domain/test_domain/ss/licence/politics/package-add new_sub ECSS-ADV 

/domain/test_domain/ss/licence/politics/package-add new_sub ECSS-ADV 
Licence packages ["ECSS-ADV"] successfully added to politic new_sub.

/domain/test_domain/ss/licence/politics/activate new_sub

/domain/test_domain/ss/licence/politics/activate new_sub
Licence politic new_sub successfully activated.