Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

Initial system configuration via the command-line interface (CLI)

Раскрыть
titleпример первоначальной конфигурации через Example of initial configuration via CoCon (CLI)

Adding media resources using the command-line interface (CLI)

A media resource is a description of the media server parameters required for operation.

Примечание

To use the media resource and establish connections, it is necessary to activate it in the media resource creation command:

Добавление медиа-ресурсов в интерфейсе командной строки (CLI)

Медиаресурс — это описание параметров медиасервера, необходимых для работы с ним.

Примечание

Для возможности использования медиаресурса и установления соединений , необходимо выполнить активизацию  в команде создания медиаресурса -  /system/media/resource/declare (параметр parameter "is active"=true) или  or /system/media/resource/set   (параметр parameter "active"=true), если при создании активизация не была выполнена. Так же можно выполнить активизацию через веб интерфейс , приложение -  сетевые окончания MSR if activation was not performed during creation. Activation can also be performed through the web interface, application - MSR network terminations (MSR-registrars).


Раскрыть
titledeclare

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> — core node name;

<contact> — <contact> — contact uri декларируемого медиаресурса;
<zone> — логическая зона обслуживания MSR;
<site> — идентификатор сети обслуживания MSR;
<is active> — состояние активности медиаресурса, значения true/false;
<msr> — имя MSR;
<acc_id> — номер идентификатор ресурса;
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<iface> — название интерфейса.


Раскрыть
titleset

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> - активация | зона | сайт;
<value> - значение параметра.

Пример:

Активируем связь MSR- и Core-подсистем. Для этого пропишите команды

site> — activation | zone | site;
<value> — parameter value.

Example:

Enable communication between the MSR and Core subsystems. To do this, enter the following commands:

Блок кода
titleвыполняется в in CoCon
/system/media/resource/set core1@ecss1 net.20@msr.ecss1 active true


Блок кода
titleвыполняется в in CoCon
/system/media/resource/set core1@ecss2 net.20@msr.ecss2  active true


Блок кода
titleвыполняется в in CoCon
/system/media/resource/set core1@ecss1 net.20@msr.ecss2  active true


Блок кода
titleвыполняется в in CoCon
/system/media/resource/set core1@ecss2 net.20@msr.ecss1  active true


Без форматирования
languagebash
/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  │
└─────────────┴──────────────────┴──────────┴───────┘


Раскрыть
titleinfo

info
Команда для просмотра информации о состоянии подключения конкретного медиаресурса.

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

Command pathПуть команды:

/system/media/resource/info

СинтаксисSyntax:

info <node>  <contact> <node>  <contact>

ПараметрыParameters:

<contact> — <contact> — contact uri декларируемого медиаресурса;
<node> — имя нодыof the declared media resource;
<node> — node name.

Пример:

Блок кода
languagebash
/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


Раскрыть
titlelist

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 — отображать только активные медиаресурсы (по умолчанию);
register — отображать только зарегистрированные медиаресурсы;
short — отобразить минимальную информацию;
all — отображать все задекларированные медиаресурсы.
По умолчанию команда выдает список зарегистрированных медиасерверов.

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.

ExampleПример:

Блок кода
languagebash
/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 │
└─────────────┴───────────┴─────────────┴───────────┴──────┴────────┴───────────┴───────────┴─────────────────┴────────┴────────────┴────────┴─────────┴───────┴──────────────────┴────────────┴─────────┘
Добавление управления регистратором для MSR медиа менеджера в интерфейсе командной строки

Adding registrar control for MSR media manager in the Command Line Interface (CLI)


/system/media/registrar/ - команды управления регистратором для MSR медиа менеджераregisrtrar control commands for the MSR media manager


Раскрыть
titleset

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> - имя настраиваемого параметра;

<VALUE> - значение настраиваемого параметра

Где

— 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
  • common - тип выставляемого параметра;
  • <common parameter> - общий параметр медиарегистратора для всех нод: registration-timeout;
  • private - тип выставляемого параметра;
  • <node name> - имя ноды на которой находится медиарегистратор;
  • 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 <private parameter> - параметр медиарегистратора, который выставляется на <node name>: is-active, listen-interface & , and listen-port.

Cписок параметров доступных для настройкиList of parameters available for configuration:

  • is-active - позволяет включить или выключить регистратор — enables or disables the registrar (false - деактивирует регистратор, регистратор перестает принимать SIP трафикdeactivates the registrar, the registrar stops receiving SIP traffic);
  • listen-

    interface - имя интерфейса, который использует регистратор

    interface — the name of the interface the registrar uses;

  • listen-

    port - порт, на котором регистратор принимает запросы на регистрацию (по умолчанию

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

  • registration-timeout — re-

    таймер перерегистрации, диапазон значений от 60 до 86400.

В общих параметрах доступна настройка времени регистрации, по умолчанию установлено 60 секунд.

  • 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Пример:
Установить время регистрации 60 секунд:

Без форматирования
/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> - нода ядра, для которой настраивается Registrar-сервер;

<FIELD> - имя настраиваемого параметра;

<VALUE> - значение настраиваемого параметра.

Настраиваемые параметры

— 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 - активен ли Registrar-сервер, принимает значения — whether the Registrar server is active, true | false;
  • listen-ip - ip-адрес, на котором Registrar-сервер будет принимать соединения (по умолчанию — the IP address on which the Registrar server will accept connections (default 0.0.0.0);
  • listen-port - сетевой порт, на котором Registrar-сервер будет принимать соединения (по умолчанию 5000).port — the network port on which the Registrar server will accept connections (default 5000).

Set the IP address for receiving connections from the media serverУстановить ipадрес для приема соединений от медиасервера:

Блок кода
titleвыполняется в in CoCon
/system/media/registrar/set private core1@ecss1 listen-ip 10.0.20.51


Блок кода
titleвыполняется в in CoCon
/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.


Раскрыть
titleinfo

info

Команда просмотра текущих настроек Registrar-сервера.

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, последует вывод следующей информацииAfter all services are started, the nodes will take some time to establish communication. Once all nodes are loaded, the following information will be output when the system-status query is executed:

Без форматирования
languagebash
/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

В примере выше видно, что ноды вошли в кластер и MSR зарегистрировались на ноде ecss-core.

Создание и настройка группы SIP-IP-адресов

In the example above, the nodes have joined the cluster and the MSR have registered on the ecss-core node.

Creating and configuring a SIP IP address group (IP-set)

Произведите настройку адаптера SIP согласно ТЗConfigure the SIP adapter according to the specifications:

Блок кода
titleвыполняется в in CoCon
/cluster/adapter/sip1/sip/network/set ip_set test_set node-ip node = sip1@ecss1 ip = 10.0.20.31


Блок кода
titleвыполняется в in CoCon
/cluster/adapter/sip1/sip/network/set ip_set test_set node-ip node = sip1@ecss2 ip = 10.0.20.32


Блок кода
titleвыполняется в in CoCon
/cluster/adapter/sip1/sip/network/set ip_set test_set listen-ports list = [5060]


Без форматирования
languagebash
/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.
Создание Домена и подключение IP

Creating a domain and connecting an IP-set

Создайте Домен (виртуальную АТС) и присвойте ему созданную выше группу (IP-set) настроек SIP-адаптера

Create a Domain (virtual PBX) and assign it the SIP adapter settings group (IP set) created above:

Блок кода
titleвыполняется в in CoCon
/domain/declare test_domain --add-domain-admin-privileges --add-domain-user-privileges


Блок кода
titleвыполняется в in CoCon
/domain/test_domain/sip/network/set ip_set [test_set]


Блок кода
languagebash
/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"].

После создания домена, администратор системы должен открыть доступ на управление услугами оператору Домена (виртуальной АТС). Для этого использовать команду разрешения оператору Домена (виртуальной АТС) "test_domain" управлять  всеми услугами After creating a domain, the system administrator should grant access to the Domain (virtual PBX) operator to manage services. To do this, use the "test_domain" command to allow the Domain (virtual PBX) operator to manage all services:

Блок кода
titleвыполняется в in CoCon
/cluster/storage/ds1/ss/access-list add test_domain *


Без форматирования
languagebash
/cluster/storage/ds1/ss/access-list add test_domain *
Supplementary services successfully added in the domain test_domain.

Для возможности применения пакета услуг у абонентов сразу после создания, необходимо настроить политику применения лицензионных пакетов услуг (детальную информацию вы можете посмотреть здесь )

To enable subscribers to apply a service package immediately after creation, it is necessary to configure a licensed service package application policy.

Create a license application policy named Создать политику применения лицензии с именем - "new_sub"

Блок кода
languagebash
titleвыполняется в in CoCon
/domain/test_domain/ss/licence/politics/declare new_sub "Задаются при создании абонента"


Без форматирования
/domain/test_domain/ss/licence/politics/declare new_sub "Задаются при создании абонента"
Licence politic new_sub successfully declared.

Задать имя пакета услуг дополнительных сервисов, для этого использовать следующие командыTo set the name of the additional services package, use the following commands:

Блок кода
languagebash
titleвыполняется в in CoCon
/cluster/storage/ds1/licence/show-licence 1

нас интересует следующая информация The following information is important:

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

. . .  

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

имя пакета услуг в  примере The service package name in this example is "ECSS-ADV".Добавить в созданную политику пакет лицензионных услуг с именем

Add the license service package named "ECSS-ADV" (именно так он описан в лицензии)that's how it's described in the license) to the created policy:

Блок кода
languagebash
titleвыполняется в in CoCon
/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.

Пакет  добавлен, но в настоящий момент политика не активна (не может быть применена к абоненту).  Для активации политики new_sub выполнить следующую командуThe package has been added, but the policy is currently not active (cannot be applied to the subscriber). To activate the new_sub policy, run the following command:

Блок кода
languagebash
titleвыполняется в in CoCon
/domain/test_domain/ss/licence/politics/activate new_sub


Без форматирования
/domain/test_domain/ss/licence/politics/activate new_sub
Licence politic new_sub successfully activated.

Теперь при создании абонентов можем использовать дополнительные услугиNow we can use additional services when creating subscribers.