/domain/<DOMAIN>/sip/user/ - команды управления конфигурацией абонентов SIP
В данном разделе приводится описание команд управления конфигурацией абонентов SIP.
<DOMAIN> — имя виртуальной АТС.
Набор параметров SIP
authentication
Команда просмотра информации о параметрах авторизации абонента.
При запросе выполняется запрос на LDAP-сервер для получения данных абонентского аккаунта.
Путь команды:
/domain/<DOMAIN>/sip/user/authentication
Синтаксис:
authentication <GROUP> <USER_INTERFACE>
Параметры:
<GROUP> - название группы пользователей. Символ "*" используется для указания всех групп;
<USER_INTERFACE> - название интерфейса, задается в формате: Имя_пользователя@Домен_SIP_регистрации. Символ "*" используется для указания всех интерфейсов.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/authentication loc.gr 240502@biysk.local 1 make users list ... [**********************************************************************] 83mks check authentication info for 1 interfaces ... [**********************************************************************] 15ms Executed on the sip1@ecss2 ┌────────────────────┬─────────┬────────────┬────────────────┐ │ User │ Use QOP │ Trusted IP │ LDAP account │ ├────────────────────┼─────────┼────────────┼────────────────┤ │ 240502@biysk.local │ true │- │ no_information │ └────────────────────┴─────────┴────────────┴────────────────┘ ┌─────────────┐ │ elements: 1 │ └─────────────┘ [exec at: 12.03.2021 14:06:42, exec time: 41ms, nodes: sip1@ecss2 v.3.14.8.26]
call-list
Команда просмотра списка активных вызовов через выбранный интерфейс.
Путь команды:
/domain/<DOMAIN>/sip/user/call-list
Синтаксис:
call-list [<GROUP>] [<INTERFACE>] [<OPTIONS>]
Параметры:
<GROUP> - название группы интерфейсов. Символ "*" указывается для экспорта всех групп интерфейсов;<INTERFACE> - логическое имя интерфейса;
<OPTIONS> - дополнительные действия:
- --complete - установка данного флага позволяет отобразить все интерфейсы, на которые были приняты вызовы;
- --more T [sec|min|hour] - установка данного флага позволяет отобразить все вызовы, длительность которых более установленного времени;
- --less T [sec|min|hour] - установка данного флага позволяет отобразить все вызовы, длительность которых менее установленного времени.
Пример:
admin@[mycelium1@ecss1#ECSS 010070]:/$ domain/ramm/sip/user/call-list sip.ab *
Executed on the sip1@ecss1
┌───────────────┬────────────────────────────┬───────────┬──────────────────────────────────────────┬─────────────────────────────────────────┐
│ Interface URI │ Direction │ State │ Time │ Additional info │
├───────────────┼────────────────────────────┼───────────┼──────────────────────────────────────────┼─────────────────────────────────────────┤
│ 156@ramm │ sip[156] <- ssw[Anonymous] │ connected │ Start: Tue, 22 Jun 2021 11:56:22 │ Node: sip1@ecss1, <0.680.1> │
│ │ │ │ Last activity: Tue, 22 Jun 2021 11:56:24 │ CallRef: 3716590779 │
│ │ │ │ │ Call-ID: "0658527768ccad5c" │
│ │ │ │ │ SessionID: <<"0658527768ccad5c">> │
│ │ │ │ │ Session handler: {amqp_io_6,<0.680.1>} │
│ 158@ramm │ sip[158] -> ssw[156] │ connected │ Start: Tue, 22 Jun 2021 11:56:22 │ Node: sip1@ecss1, <0.672.1> │
│ │ │ │ Last activity: Tue, 22 Jun 2021 11:56:24 │ CallRef: 3716590779 │
│ │ │ │ │ Call-ID: "1-308@192.168.116.181" │
│ │ │ │ │ SessionID: <<"0658527766b282c9">> │
│ │ │ │ │ Session handler: {amqp_io_16,<0.672.1>} │
└───────────────┴────────────────────────────┴───────────┴──────────────────────────────────────────┴─────────────────────────────────────────┘
┌────────────┐
│ 2 sessions │
└────────────┘
[exec at: 22.06.2021 11:56:24, exec time: 14ms, nodes: sip1@ecss1]
change-group
Команда изменения группы интерфейса.
Путь команды:
/domain/<DOMAIN>/sip/user/change-group
Синтаксис:
change-group <GROUP> <USER INTERFACE> <OTHER GROUP> [--force]
Параметры:
<GROUP> - название группы интерфейсов;
<USER INTERFACE> - логическое имя интерфейса.
<OTHER GROUP> - название группы интерфейсов, на которую производится замена. При отсутствии создается новая;
--force - выполнение команды без запроса подтверждения.
Примеры:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/change-group loc.gr 240800@biysk.local 800.gr 1 make users list ... [**********************************************************************] 187mks [change-group] Group 800.gr isn't exists continue: yes/no ?> yes Warning: obsolete command. It will be removed at ECSS-10 v3.15. Use command /domain/<DOMAIN>/sip/user/set <GROUP> <URI> group <NEW_GROUP> Executed on the sip1@ecss1 Intermediate (incomplete) result: Group 800.gr has been removed (all interfaces in this group was removed) ... Warning: obsolete command. It will be removed at ECSS-10 v3.15. Use command /domain/<DOMAIN>/sip/user/set <GROUP> <URI> group <NEW_GROUP> Executed on the sip1@ecss1 ok [exec at: 12.03.2021 14:13:57, exec time: 3s 810ms, nodes: sip1@ecss1 v.3.14.8.26]
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/change-group loc.gr 24081{0-9}@biysk.local 800.gr
10 make users list ...
[**********************************************************************] 352mks
[change-group] Group 800.gr isn't exists
continue: yes/no ?> yes
Warning: obsolete command. It will be removed at ECSS-10 v3.15. Use command /domain/<DOMAIN>/sip/user/set <GROUP> <URI> group <NEW_GROUP>
Executed on the sip1@ecss2
Intermediate (incomplete) result:
Group 800.gr has been removed (all interfaces in this group was removed)
...
Warning: obsolete command. It will be removed at ECSS-10 v3.15. Use command /domain/<DOMAIN>/sip/user/set <GROUP> <URI> group <NEW_GROUP>
Executed on the sip1@ecss2
ok
[exec at: 12.03.2021 14:15:51, exec time: 2s 573ms, nodes: sip1@ecss2 v.3.14.8.26]
check
Команда проверки доступности абонентского устройства по сигнализации.
Путь команды:
/domain/<DOMAIN>/sip/user/check
Синтаксис:
check <GROUP> <USER_INTERFACE> [timerF = <TIMEOUT>]
Параметры:
<GROUP> - название группы интерфейсов;
<USER_INTERFACE> - название интерфейса, задается в формате: Имя_пользователя@Домен_SIP_регистрации. Символ "*" используется для указания маски интерфейсов, например:
./user/check test.subscribers * ./user/check test.subscribers 10000* ./user/check test.subscribers 100000@eltex.local timerF = 5000
<TIMEOUT> - тайм-аут ожидания ответа, в пределах которого отправляются повторные запросы, если удаленная сторона не отвечает. По умолчанию 5000 мс.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/check loc.gr 24046* 320 make users list ... [**********************************************************************] 2ms Executed on the sip1@ecss2 Intermediate (incomplete) result: check for user 240464@biysk.local by sip1@ecss2 (node control: false) ... Executed on the sip1@ecss2 Intermediate (incomplete) result: check for user 240465@biysk.local by sip1@ecss2 (node control: false) ... Executed on the sip1@ecss2 Intermediate (incomplete) result: check for user 240466@biysk.local by sip1@ecss2 (node control: false) ... Executed on the sip1@ecss2 ┌────────┬────────────────────┬────────────┬───────────────────────────────────────────────────────────────────────┐ │ Group │ User │ Accessible │ Check info │ ├────────┼────────────────────┼────────────┼───────────────────────────────────────────────────────────────────────┤ │ loc.gr │ 240462@biysk.local │ false │ User isn't registered now │ │ │ │ │ │ │ loc.gr │ 240464@biysk.local │ true │ OPTIONS to <sip:240464@192.168.2.200>: 200 OK, cseq: 641361 OPTIONS. │ │ │ │ │ Request by node: sip1@ecss2 │ │ │ │ │ │ │ loc.gr │ 240465@biysk.local │ true │ OPTIONS to <sip:240465@192.168.2.200>: 200 OK, cseq: 664446 OPTIONS. │ │ │ │ │ Request by node: sip1@ecss2 │ │ │ │ │ │ │ loc.gr │ 240466@biysk.local │ true │ OPTIONS to <sip:240466@192.168.2.26>: 200 OK, cseq: 676624 OPTIONS. │ │ │ │ │ Request by node: sip1@ecss2 │ │ │ │ │ │ │ loc.gr │ 240467@biysk.local │ false │ User isn't registered now │ │ │ │ │ │ │ loc.gr │ 240469@biysk.local │ false │ User isn't registered now │ └────────┴────────────────────┴────────────┴───────────────────────────────────────────────────────────────────────┘ [exec at: 12.03.2021 14:43:17, exec time: 174ms, nodes: sip1@ecss2 v.3.14.8.26]
clean
Команда предназначена для установки параметров в значение по умолчанию.
Путь команды:
/domain/<DOMAIN>/sip/user/clean
Синтаксис:
clean <GROUP> <USER_INTERFACE> <PARAMETER> [--force]
Параметры:
<GROUP> - название группы интерфейсов;
<USER_INTERFACE> - название интерфейса, задается в формате: Имя_пользователя@Домен_SIP_регистрации. Символ "*" используется для указания маски интерфейсов. Доступен также ввод диапазона интерфейсов:
./user/clean test.subscribers * trusted-ip
./user/clean test.subscribers 10000*
./user/clean test.subscribers 100000@eltex.local
./user/clean test.subscribers 100{000-399}@eltex.local
<PARAMETER> - параметр, значение которого нужно установить по умолчанию, список приведен выше.
[--force] - удаление без дополнительного подтверждения (опциональный параметр).
Примеры:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/clean 800.gr 240813@biysk.local register-expire-max [clean] Set parameters to default value continue: yes/no ?> yes 1 make users list ... [**********************************************************************] 93mks Executed on the sip1@ecss2 complete [exec at: 12.03.2021 15:04:04, exec time: 2s 489ms, nodes: sip1@ecss2 v.3.14.8.26]
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/clean loc.gr 24065* qop-authentication --force 320 make users list ... [**********************************************************************] 541mks clean to 10 interfaces ... [**********************************************************************] 37ms Executed on the sip1@ecss1 complete [exec at: 12.03.2021 15:04:24, exec time: 103ms, nodes: sip1@ecss1 v.3.14.8.26]
declare
Команда декларации абонента (группы абонентов).
При декларации создаются соответствующие интерфейсы и алиасы.
При требовании аутентификации для абонента (абонентов) можно сразу прописать параметры аккаунта (логин, пароль).
Путь команды:
/domain/<DOMAIN>/sip/user/declare
Синтаксис:
declare <ROUTING_CONTEXT> <GROUP> <USER_INTERFACE> <ALIAS> <QOP_AUTH> <LOGIN> <PASSWORD>
Параметры:
<ROUTING_CONTEXT> - название существующего контекста маршрутизации;
<GROUP> - название группы пользователей (может быть задана существующая или новая группа пользователей);
<USER_INTERFACE> - интерфейс создаваемого SIP-абонента в формате <НОМЕР>@<DOMAIN>.
<ALIAS> - альтернативный номер абонента, при указании значения "none" создается sip-абонент без алиаса; при указании значения "alias-as-user " - создается SIP-абонент с алиасом
<QOP_AUTH> - поддержка QOP-аутентификации (повышенный уровень защиты). Опциональный параметр:
- no_qop_authentication - использовать QOP-аутентификацию;
- qop_authentication - не использовать QOP-аутентификацию.
<LOGIN> - имя декларируемого пользователя. Опциональный параметр. Имя пользователя может быть впоследствии добавлено/изменено как терминальными командами, так и на LDAP-сервере:
- login_as_number - в качестве имен пользователей использовать декларируемые номера;
- none - не назначать параметры авторизации при декларации;
- common_login <LOGIN> - общее имя <LOGIN> для всех декларируемых абонентов.
<PASSWORD> - пароль декларируемых пользователей. Не указывается, если в качестве <LOGIN> выбрано "none". Пароли проверяются на соответствие требованиям, установленным в профиле безопасности (/system/security/profile/), параметр restrictions.
- auto_generation - каждому декларируемому абоненту генерируется персональный пароль. Полученные пароли можно будет посмотреть командами "user info" или "user authentication";
- публичный пароль (символьная строка) - всем декларируемым абонентам будет назначен единый заданный пароль.
Пример:
Декларация одного абонента с номером 240815 без требования аутентификации:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/declare ctx_from_smgreg 800.gr 240815 alias-as-user no_qop_authentication none Executed on the sip1@ecss1 Intermediate (incomplete) result: Declaration for range: 240815@biysk.local..240815@biysk.local (1) ... 1 interfaces check for existing ... [**********************************************************************] 70mks 1 users interfaces declaration ... [**********************************************************************] 9ms 1 users divided into 1 parts to declare ... [**********************************************************************] 74mks 1 users aliases declaration ... [**********************************************************************] 15ms 1 interfaces recall to base [**********************************************************************] 11ms Executed on the sip1@ecss1 ┌────────────────────────┐ │ declared 1 subscribers │ └────────────────────────┘ [exec at: 12.03.2021 14:44:51, exec time: 115ms, nodes: sip1@ecss1 v.3.14.8.26]
Декларация 10 абонентов с требованием аутентификации при регистрации, qop требуется, сразу создаются аккаунты с автоматической генерацией паролей:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/declare ctx_from_local 85.gr 24084{0-9} alias-as-user qop_authentication common_login test48-1 auto-generation
Executed on the sip1@ecss2
Intermediate (incomplete) result:
Declaration for range: 240840@biysk.local..240849@biysk.local (10)
...
10 interfaces check for existing ...
[**********************************************************************] 127mks
10 users interfaces declaration ...
[**********************************************************************] 88ms
10 users divided into 1 parts to declare ...
[**********************************************************************] 70mks
10 users aliases declaration ...
[**********************************************************************] 15ms
10 interfaces recall to base
[**********************************************************************] 7ms
Executed on the sip1@ecss2
┌─────────────────────────┐
│ declared 10 subscribers │
└─────────────────────────┘
[exec at: 12.03.2021 14:45:18, exec time: 188ms, nodes: sip1@ecss2 v.3.14.8.26]
errors
Команда просмотра информации об ошибках в регистрации абонентов.
Путь команды:
/domain/<DOMAIN>/sip/user/errors
Синтаксис:
errors <PARAMETER> [VALUE]
Параметры:
<PARAMETER> - назначаемое действие, принимает значение:
- clear-table - удаление всех записей об ошибках регистрации;
- set-limit <LIMIT> - установление максимального количества записей (<LIMIT>), значение должно быть целым;
- uri <URI> - просмотр информации об ошибках для определенного URI;
- all - просмотр информации обо всех ошибках;
- known - просмотр информации об ошибках регистрации известных абонентов;
- unknown - просмотр информации об ошибках регистрации неизвестных абонентов;
<VALUE> - значение.
Примеры:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/errors set-limit 5
Executed on the sip1@ecss1
[{old,1000},{new,5}]
[exec at: 12.03.2021 14:45:41, exec time: 33ms, nodes: sip1@ecss1 v.3.14.8.26]
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/errors Executed on the sip1@ecss2 ┌────────────────────┬─────────────────────┬────────────────────────────────────────────────────────────────┐ │ Uri │ Last event time │ Event │ ├────────────────────┼─────────────────────┼────────────────────────────────────────────────────────────────┤ │ 240547@biysk.local │ 2021-03-12 04:26:01 │ Wrong authentication (first: 2021-03-12 04:26:01, 0/1 time(s)) │ │ 240562@biysk.local │ 2021-03-12 01:59:14 │ Wrong authentication (first: 2021-03-12 01:59:14, 0/1 time(s)) │ │ 240565@biysk.local │ 2021-03-12 05:53:47 │ Wrong authentication (first: 2021-03-12 05:53:47, 0/1 time(s)) │ │ 240578@biysk.local │ 2021-03-12 06:23:02 │ Wrong authentication (first: 2021-03-09 19:42:39, 0/3 time(s)) │ │ 240651@biysk.local │ 2021-03-12 12:43:19 │ Wrong authentication (first: 2021-03-09 19:42:39, 0/4 time(s)) │ └────────────────────┴─────────────────────┴────────────────────────────────────────────────────────────────┘ [exec at: 12.03.2021 14:46:07, exec time: 14ms, nodes: sip1@ecss2 v.3.14.8.26]
info
Команда для просмотра информации о параметрах абонентского интерфейса (группы абонентских интерфейсов).
Путь команды:
/domain/<DOMAIN>/sip/user/info
Синтаксис:
info <GROUP> [<USER_INTERFACE>] [<OPTIONS>]
Параметры:
<GROUP> - название группы пользователей. Символ "*" используется для указания всех групп; <USER_INTERFACE> - название интерфейса, задается в формате: Имя_пользователя@Домен_SIP_регистрации. Символ "*" используется для указания всех интерфейсов;
<OPTIONS>:
- --ldap-account - выполнять запрос на LDAP-сервер (отображение логина и пароля). По умолчанию запрос не выполняется - отображается только требование авторизации;
- --show-password - показывать логин и пароль.
Если в профиле безопасности (/system/security/profile/) параметр show_password_at_cli = off, то в выводе пароль скрывается, и вместо него показываются ********. В случае, если <USER_INTERFACE> = '*' то для отображения пароля в режиме on_request нужно ввести дополнительный флаг --show-password. Если был указан определенный пользователь, то в режиме on_request пароль покажется автоматически
Примеры:
Информация по одному абоненту:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/info loc.gr 240101@biysk.local 1 make users list ... [**********************************************************************] 68mks 1 users information read ... [**********************************************************************] 11ms Executed on the sip1@ecss1 ┌─────────────────────┬────────────────────────────────────────────────────────────────────────────────┐ │ User │ 240101@biysk.local │ ├─────────────────────┼────────────────────────────────────────────────────────────────────────────────┤ │internal iface name │064bc9652bfe3487 │ │isActive │true │ │group │loc.gr │ │authentication │240101:ext_101_SSW-3 (ds) use qop: true │ │contacts definition │q: 1.0; ip-set: ipset1; on port: 5060; sip │ │ │ registered by node: sip1@ecss1 │ │ │ sip transport: udp │ │ │ user-agent: Yealink SIP-T28P 2.73.193.50 │ │ │ <sip:240101@192.168.2.26:5060;transport=UDP;line=20457>;expires=883 │ │declared by │admin at 28.01.2021 16:08:34 │ │ │ │ │access_group │all │ │alarm_enable │false │ │aliases activities │240101:true │ │allow │INVITE, INFO, PRACK, ACK, BYE, CANCEL, OPTIONS, NOTIFY, SUBSCRIBE, REFER, UPDATE│ │ │, MESSAGE │ │allow events │refer, talk, hold │ │auto-answer-version │Alert-Info: Auto Answer (default by domain) │ │category_to_sip │default │ │client-profile │none │ │compact-form │defaut (default) │ │digest │true │ │display-name-encoding│default │ │dtmf-duration │100 │ │dtmf-relay │false │ │fork-mode │all-contacts, allow repeated IP: true │ │last via │SIP/2.0/UDP 192.168.2.26:5060;received=192.168.2.26;rport=5060 │ │my_from │biysk.local │ │nat_traversal │false │ │options_control │disable │ │original-cdpn-to │true │ │published presence │none │ │referred-by-as-cgpn │false │ │register-expire-max │3600 │ │register-expire-min │90 │ │host-to-invite │registered-domain │ │registrator │node: sip1@ecss1 port: udp 192.168.2.61:5060 │ │regs_time │19.02.2021 01:26:46 │ │remote-ctr-indication│rpi │ │req100rel │false │ │rfc-4028-control │force │ │routing.context │ctx_from_local │ │sip-domain │biysk.local │ │sip-modifications │[] │ │supported │[req100rel] │ │symbol_hash_as_is │false │ │sip-transit │[] │ │trusted-ip │unassigned │ │user agent │Yealink SIP-T28P 2.73.193.50 │ └─────────────────────┴────────────────────────────────────────────────────────────────────────────────┘ [exec at: 12.03.2021 14:46:32, exec time: 21ms, nodes: sip1@ecss1 v.3.14.8.26]
Сводная общая информация о всех sip-абонентах:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/info
3 group check for lookup active users ...
[**********************************************************************] 49ms
Executed on the sip1@ecss2
┌─────────┬─────────┬────────────────────────────────────────────────────────────────────────────────┐
│ Group │ Dynamic │ Parameters │
├─────────┼─────────┼────────────────────────────────────────────────────────────────────────────────┤
│ 800.gr │ false │ 'number of users' = 1 │
│ │ │ 'number of registered users' = 0 │
│ │ │ gate = {gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>} │
│ │ │ owner = "sip1" │
│ │ │ │
│ 85.gr │ false │ 'number of users' = 10 │
│ │ │ 'number of registered users' = 0 │
│ │ │ gate = {gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>} │
│ │ │ owner = "sip1" │
│ │ │ │
│ loc.gr │ false │ 'number of users' = 320 │
│ │ │ 'number of registered users' = 205 │
│ │ │ gate = {gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>} │
│ │ │ group = {gate_amqp,<<"acp.adapter.init.ex">>, │
│ │ │ <<"acp.sip.sip1.ipset1.init.rk">>} │
│ │ │ owner = "sip1" │
│ │ │ │
│ summary │ ------- │ 'number of users' = 331 │
│ │ │ 'number of registered users' = 205 │
└─────────┴─────────┴────────────────────────────────────────────────────────────────────────────────┘
[exec at: 12.03.2021 14:47:34, exec time: 62ms, nodes: sip1@ecss2 v.3.14.8.26]
Регистрационная информация по абонентам из диапазона:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/info loc.gr 24046{4-6}@biysk.local
3 make users list ...
[**********************************************************************] 70mks
3 users information read ...
[**********************************************************************] 12ms
Executed on the sip1@ecss1
┌────────────────────┬────────┬─────────────────┬────────┬──────────────────────┬──────────────────────────────────────────────────────────────────────┬───────────────────────────────────────┐
│ User │ Number │ Is active on DS │ Group │ Login │ Registration │ Extended information │
├────────────────────┼────────┼─────────────────┼────────┼──────────────────────┼──────────────────────────────────────────────────────────────────────┼───────────────────────────────────────┤
│ 240464@biysk.local │ 240464 │ true │ loc.gr │ 240464:zoakoSh8 (ds) │ q: 1.0; ip-set: ipset1; on port: 5060; sip │ internal iface name: 064bc964face07a5 │
│ │ │ │ │ │ registered by node: sip1@ecss1 │ sip domain: biysk.local │
│ │ │ │ │ │ sip transport: udp │ │
│ │ │ │ │ │ user-agent: TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10 │ │
│ │ │ │ │ │ <sip:240464@192.168.2.200:5064>;expires=826 │ │
│ │ │ │ │ │ │ │
│ 240465@biysk.local │ 240465 │ true │ loc.gr │ 240465:uica1oeN (ds) │ q: 1.0; ip-set: ipset1; on port: 5060; sip │ internal iface name: 064bc964fbacf7eb │
│ │ │ │ │ │ registered by node: sip1@ecss1 │ sip domain: biysk.local │
│ │ │ │ │ │ sip transport: udp │ │
│ │ │ │ │ │ user-agent: TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10 │ │
│ │ │ │ │ │ <sip:240465@192.168.2.200:5065>;expires=1167 │ │
│ │ │ │ │ │ │ │
│ 240466@biysk.local │ 240466 │ true │ loc.gr │ 240466:ext_466 (ds) │ q: 1.0; ip-set: ipset1; on port: 5060; sip │ internal iface name: 064bc9653091d158 │
│ │ │ │ │ │ registered by node: sip1@ecss2 │ sip domain: biysk.local │
│ │ │ │ │ │ sip transport: udp │ │
│ │ │ │ │ │ user-agent: VP-12/2.5.0.203 sofia-sip/1.12.10 │ │
│ │ │ │ │ │ <sip:240466@192.168.2.26:5060;transport=UDP;line=60614>;expires=603 │ │
└────────────────────┴────────┴─────────────────┴────────┴──────────────────────┴──────────────────────────────────────────────────────────────────────┴───────────────────────────────────────┘
┌─────────────┐
│ elements: 3 │
└─────────────┘
[exec at: 12.03.2021 14:47:56, exec time: 21ms, nodes: sip1@ecss1 v.3.14.8.26]
Полная информация по абоненту:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/info loc.gr 240470@biysk.local --show-password 1 make users list ... [**********************************************************************] 131mks 1 users information read ... [**********************************************************************] 11ms Executed on the sip1@ecss2 ┌─────────────────────┬────────────────────────────────────────────────────────────────────────────────┐ │ User │ 240470@biysk.local │ ├─────────────────────┼────────────────────────────────────────────────────────────────────────────────┤ │internal iface name │064bc964febdde57 │ │isActive │false │ │group │loc.gr │ │authentication │240470:eGhohxie (ds) use qop: true │ │contacts definition │Contacts list is empty │ │declared by │admin at 28.01.2021 16:08:31 │ │ │ │ │access_group │all │ │alarm_enable │false │ │aliases activities │240470:true │ │allow │INVITE, ACK, BYE, CANCEL, OPTIONS, PRACK, MESSAGE, SUBSCRIBE, NOTIFY, REFER, UPD│ │ │ATE, INFO │ │allow events │none │ │auto-answer-version │Alert-Info: Auto Answer (default by domain) │ │category_to_sip │default │ │client-profile │none │ │compact-form │defaut (default) │ │digest │true │ │display-name-encoding│default │ │dtmf-duration │100 │ │dtmf-relay │false │ │fork-mode │all-contacts, allow repeated IP: true │ │last via │SIP/2.0/UDP 192.168.2.26:5060;received=192.168.2.26;rport=5060 │ │my_from │biysk.local │ │nat_traversal │false │ │options_control │disable │ │original-cdpn-to │true │ │published presence │none │ │referred-by-as-cgpn │false │ │register-expire-max │3600 │ │register-expire-min │90 │ │host-to-invite │registered-domain │ │registrator │node: sip1@ecss1 port: udp 192.168.2.62:5060 │ │regs_time │18.02.2021 14:44:30 │ │remote-ctr-indication│rpi │ │req100rel │false │ │rfc-4028-control │force │ │routing.context │ctx_from_local │ │sip-domain │biysk.local │ │sip-modifications │[] │ │supported │[req100rel] │ │symbol_hash_as_is │false │ │sip-transit │[] │ │trusted-ip │unassigned │ │user agent │RG-1404GF-W/1.11.0 SN/VI25002012 sofia-sip/1.12.10 │ └─────────────────────┴────────────────────────────────────────────────────────────────────────────────┘ [exec at: 12.03.2021 14:48:25, exec time: 26ms, nodes: sip1@ecss2 v.3.14.8.26]
list
Команда для просмотра списка пользователей по указанному правилу.
Путь команды:
/domain/<DOMAIN>/sip/user/list
Синтаксис:
list <KEY> | <GROUP> <KEY> | <GROUP> <KEY> <IFACE_TEMPLATE>
Параметры:
<KEY> - название параметра, по которому формировать список :
- --active - зарегистрированные абоненты;
- --inactive - незарегистрированные абоненты
- --forbidden - авторизация запрещена;
<GROUP> - название группы пользователей. Символ "*" используется для указания всех групп;
<IFACE_TEMPLATE> - шаблон имени интерфейса. Символ "*" используется для указания маски интерфейсов.
Примеры:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/list loc.gr --active 24047* 320 make users list ... [**********************************************************************] 419mks 5 users check for active ... [**********************************************************************] 298mks Executed on the sip1@ecss1 ┌─────┬────┬──────────────────┐ │group│user│current contact(s)│ ├─────┼────┼──────────────────┤ └─────┴────┴──────────────────┘ ┌────────────────┐ │ elements: none │ └────────────────┘ [exec at: 12.03.2021 14:49:15, exec time: 75ms, nodes: sip1@ecss1 v.3.14.8.26]
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/list --forbidden Executed on the sip1@ecss2 ┌────────────────────┬───────────────────────┬──────────────────────────────────────────────────────────────┐ │request by transport│time of the last trying│ info │ ├────────────────────┼───────────────────────┼──────────────────────────────────────────────────────────────┤ │240547@biysk.local │2021-03-12 04:26:01 │Wrong authentication (first: 2021-03-12 04:26:01, 0/1 time(s))│ │240562@biysk.local │2021-03-12 01:59:14 │Wrong authentication (first: 2021-03-12 01:59:14, 0/1 time(s))│ │240565@biysk.local │2021-03-12 05:53:47 │Wrong authentication (first: 2021-03-12 05:53:47, 0/1 time(s))│ │240578@biysk.local │2021-03-12 06:23:02 │Wrong authentication (first: 2021-03-09 19:42:39, 0/3 time(s))│ │240651@biysk.local │2021-03-12 12:43:19 │Wrong authentication (first: 2021-03-09 19:42:39, 0/4 time(s))│ └────────────────────┴───────────────────────┴──────────────────────────────────────────────────────────────┘ ┌─────────────┐ │ elements: 5 │ └─────────────┘ [exec at: 12.03.2021 14:49:41, exec time: 15ms, nodes: sip1@ecss2 v.3.14.8.26]
registered
Команда для просмотра списка зарегистрированных в данный момент абонентов.
Просмотр доступен по всей группе, по маске, по определенному абоненту.
Путь команды:
/domain/<DOMAIN>/sip/user/registered
Синтаксис:
registered [<GROUP> [<USER_INTERFACE>]]
Параметры:
<GROUP> - название группы пользователей. Символ "*" используется для указания всех групп;
<USER_INTERFACE> - название интерфейса, задается в формате: Имя_пользователя@Домен_SIP_регистрации. Символ "*" используется для указания всех интерфейсов или маски номера.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/registered loc.gr 24046* 320 make users list ... [**********************************************************************] 412mks 6 users information read ... [**********************************************************************] 535mks Executed on the sip1@ecss1 ┌────────────────────┬────────┬─────────┬─────────────────────────────────────────────────────────────────────┬─────────────────────────────────────────────────────────────────────┐ │ Interface │ Number │ Dynamic │ Contact │ Registration info │ ├────────────────────┼────────┼─────────┼─────────────────────────────────────────────────────────────────────┼─────────────────────────────────────────────────────────────────────┤ │ 240464@biysk.local │ 240464 │ false │ q: 1.0; ip-set: ipset1; on port: 5060; sip │ registered on: │ │ │ │ │ registered by node: sip1@ecss1 │ node: sip1@ecss1 port: udp 192.168.2.61:5060 │ │ │ │ │ sip transport: udp │ last via list: │ │ │ │ │ user-agent: TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10 │ SIP/2.0/UDP 192.168.2.200:5064;received=192.168.2.200;rport=5064 │ │ │ │ │ <sip:240464@192.168.2.200:5064>;expires=693 │ │ │ │ │ │ │ last user agent: │ │ │ │ │ │ TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10 │ │ │ │ │ │ │ │ 240465@biysk.local │ 240465 │ false │ q: 1.0; ip-set: ipset1; on port: 5060; sip │ registered on: │ │ │ │ │ registered by node: sip1@ecss1 │ node: sip1@ecss1 port: udp 192.168.2.61:5060 │ │ │ │ │ sip transport: udp │ last via list: │ │ │ │ │ user-agent: TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10 │ SIP/2.0/UDP 192.168.2.200:5065;received=192.168.2.200;rport=5065 │ │ │ │ │ <sip:240465@192.168.2.200:5065>;expires=1034 │ │ │ │ │ │ │ last user agent: │ │ │ │ │ │ TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10 │ │ │ │ │ │ │ │ 240466@biysk.local │ 240466 │ false │ q: 1.0; ip-set: ipset1; on port: 5060; sip │ registered on: │ │ │ │ │ registered by node: sip1@ecss2 │ node: sip1@ecss2 port: udp 192.168.2.62:5060 │ │ │ │ │ sip transport: udp │ last via list: │ │ │ │ │ user-agent: VP-12/2.5.0.203 sofia-sip/1.12.10 │ SIP/2.0/UDP 192.168.2.26:5060;received=192.168.2.26;rport=5060 │ │ │ │ │ <sip:240466@192.168.2.26:5060;transport=UDP;line=60614>;expires=470│ last user agent: │ │ │ │ │ │ VP-12/2.5.0.203 sofia-sip/1.12.10 │ └────────────────────┴────────┴─────────┴─────────────────────────────────────────────────────────────────────┴─────────────────────────────────────────────────────────────────────┘ ┌─────────────┐ │ elements: 3 │ └─────────────┘ [exec at: 12.03.2021 14:50:09, exec time: 96ms, nodes: sip1@ecss1 v.3.14.8.26]
elph-registered
Команда для просмотра списка зарегистрированных в данный момент абонентов, использующих Elph.
Просмотр доступен по всему домену либо по группе.
Путь команды:
/domain/<DOMAIN>/sip/user/elph-registered
Синтаксис:
registered [<GROUP> ]
Параметры:
<GROUP> - название группы пользователей. Символ "*" используется для указания всех групп.
Пример:
admin@[sip1@ecss1#ECSS-CB-DEMO]:/$ domain/test.domain/sip/user/elph-registered * Executed on the sip1@ecss1 ┌──────────────────┬────────┬─────────┬──────────────────────────────────────────────┬─────────────────────────────────────────────────────────┐ │ Interface │ Number │ Dynamic │ Contact │ Registration info │ ├──────────────────┼────────┼─────────┼──────────────────────────────────────────────┼─────────────────────────────────────────────────────────┤ │ 1006@test.domain │ 1006 │ false │ q: 1.0; ip-set: lab.ims; on port: 5060; sip │ registered on: │ │ │ │ │ registered by node: sip1@ecss1 │ node: sip1@ecss1 port: tcp 10.25.88.84:5060 │ │ │ │ │ sip transport: tcp │ last via list: │ │ │ │ │ user-agent: Elph-desktop 2.1.136 │ SIP/2.0/TCP 192.168.114.122;received=95.167.221.157 │ │ │ │ │ <sip:1006@95.167.221.157:12702>;expires=603 │ last user agent: │ │ │ │ │ │ Elph-desktop 2.1.136 │ └──────────────────┴────────┴─────────┴──────────────────────────────────────────────┴─────────────────────────────────────────────────────────┘ ┌─────────────┐ │ elements: 1 │ └─────────────┘
remove
Данной командой выполняется удаление абонента (группы абонентов).
При удалении удаляются соответствующие интерфейсы и алиасы.
Удаление применяется к конкретному URI абонента, к диапазону URI (начинающихся с одной комбинации символов), ко всей группе абонентов.
При удалении будет предложено удалить также и аккаунт(ы) на LDAP-сервере.
Путь команды:
/domain/<DOMAIN>/sip/user/remove
Синтаксис:
remove <GROUP> <USER_INTERFACE> [--force]
Параметры:
<GROUP> - название группы пользователей. Символ "*" используется для указания всех групп;
<USER_INTERFACE> - название удаляемого интерфейса, задается в формате: Имя_пользователя@Домен_SIP_регистрации;
Имя пользователя может быть задано шаблоном: Prefix_Symbols{Start_Digits-Stop_Digits}.
[--force] - удаление без дополнительного подтверждения (опциональный параметр).
Пример:
Удаление одного абонента:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/remove 800.gr 240815@biysk.local [remove] Remove interfaces. Undo will be impossible continue: yes/no ?> yes 1 make users list ... [**********************************************************************] 101mks 1 interfaces check for existing ... [**********************************************************************] 215mks 1 users leave ... [**********************************************************************] 19ms 1 interfaces divided into 1 parts to remove from DS ... [**********************************************************************] 31mks 1 interfaces remove from DS ... [**********************************************************************] 23ms Executed on the sip1@ecss2 Intermediate (incomplete) result: Group 800.gr has been removed (all interfaces in this group was removed) ... Executed on the sip1@ecss2 Complete [exec at: 12.03.2021 15:05:09, exec time: 2s 231ms, nodes: sip1@ecss2 v.3.14.8.26]
Удаление диапазона абонентов:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/remove loc.gr 24079{5-9}@biysk.local
[remove] Remove interfaces. Undo will be impossible
continue: yes/no ?> yes
5 make users list ...
[**********************************************************************] 38mks
5 interfaces check for existing ...
[**********************************************************************] 47mks
5 users leave ...
[**********************************************************************] 65ms
5 interfaces divided into 1 parts to remove from DS ...
[**********************************************************************] 70mks
5 interfaces remove from DS ...
[**********************************************************************] 5ms
Executed on the sip1@ecss1
Complete
[exec at: 12.03.2021 15:05:35, exec time: 4s 398ms, nodes: sip1@ecss1 v.3.14.8.26]
Удаление всей группы абонентов:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/remove 85.gr * [remove] Remove interfaces. Undo will be impossible continue: yes/no ?> yes 10 interfaces check for existing ... [**********************************************************************] 288mks 10 users leave ... [**********************************************************************] 94ms 10 interfaces divided into 1 parts to remove from DS ... [**********************************************************************] 56mks 10 interfaces remove from DS ... [**********************************************************************] 8ms Executed on the sip1@ecss2 Intermediate (incomplete) result: Group 85.gr has been removed (all interfaces in this group was removed) ... Executed on the sip1@ecss2 Complete [exec at: 12.03.2021 15:05:59, exec time: 2s 473ms, nodes: sip1@ecss2 v.3.14.8.26]
set
Данной командой выполняется настройка параметров абонентов и группы.
Пароли проверяются на соответствие требованиям, установленным в профиле безопасности (/system/security/profile/), параметр restrictions.
Путь команды:
/domain/<DOMAIN>/sip/user/set
Синтаксис:
set <GROUP_NAME> <SIP_URI> <PARAMETER> <VALUE>
Параметры:
<GROUP_NAME> - имя группы интерфейсов, логическая привязка интерфейсов в определенной виртуальной АТС;
<SIP_URI> - SIP URI абонента, задается в виде: username@host, где username – номер абонента; host – название SIP-домена;
Список может быть задан диапазоном {a-b} или перечислением {a,b}, где a,b – натуральные числа.
Пример. Интерфейсы 1111@eltex.local, 1112@eltex.local, 1113@eltex.local можно задать в виде 111{1-3}@eltex.local или 111{1,2,3}@eltex.local или {1111,1112,1113}@eltex.local.
<PARAMETER> - имя изменяемого параметра, список приведен выше;
<VALUE> - значение изменяемого параметра, список приведен выше.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/set loc.gr 240244@biysk.local category_to_sip category 1 make users list ... [**********************************************************************] 33mks set for 1 users ... [**********************************************************************] 5ms Executed on the sip1@ecss1 [exec at: 12.03.2021 15:01:02, exec time: 20ms, nodes: sip1@ecss1 v.3.14.8.26]
Пример назначения профиля (режима):
Значения могут быть:
- auto - автоматическое определение (по заголовку User-Agent);
- none - режим профилей игнорируется (сейчас используется по умолчанию этот режим);
- coral - для абонентов Coral;
- PROFILE_NAMES - список имеющихся профилей, из которых выбирается лишь один.
stop-registration
Данной командой производится принудительное завершение регистрации.
Сброс регистрации применяется как к конкретному URI абонента, так и к диапазону по маске.
Может понадобиться, например, для выведения шлюза из работы (для его замены).
Путь команды:
/domain/<DOMAIN>/sip/user/stop-registration
Синтаксис:
stop-registration <GROUP> <USER_INTERFACE> [--force]
Параметры:
<GROUP> - название группы пользователей. Символ "*" используется для указания всех групп;
<USER_INTERFACE> - название интерфейса или шаблон;
[--force] - выполнить команду без подтверждения.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/stop-registration loc.gr 240464@biysk.local --force 1 make users list ... [**********************************************************************] 283mks stop registration to 1 interfaces ... [**********************************************************************] 11ms 1 users divided into 1 parts to declare ... [**********************************************************************] 282mks set 1 interfaces to inactive state on DS ... [**********************************************************************] 27ms Executed on the sip1@ecss2 1 users are de-registered (directly expired): 064bc964face07a5 (240464@biysk.local) ... 064bc964face07a5 (240464@biysk.local) [exec at: 12.03.2021 15:02:05, exec time: 60ms, nodes: sip1@ecss2 v.3.14.8.26]
subscription-list
Команда предназначена для просмотра статистики подписок пользователя.
Путь команды:
/domain/<DOMAIN>/sip/user/subscription-list
Синтаксис:
subscription-list
subscription-list where Column =|/=|<|>|<=|>= Value
subscription-list where Column =|/=|<|>|<=|>= Value order_by Column asc|desc
subscription-list order_by Column asc|desc
Параметры:
- full - полный вывод;
- debug - показывает последний event, пришедший с ядра;
- order_by - сортировка;
- where - фильтры.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/sip/user/subscription-list ┌─┬────┬──────┬──────┬──────────────────┬──────────────────┬───────┐ │#│Type│ From │ To │ Subscriber │ Target │Expired│ ├─┼────┼──────┼──────┼──────────────────┼──────────────────┼───────┤ │1│blf │240101│240470│240101@biysk.local│240470@biysk.local│1580 │ │2│blf │240101│240464│240101@biysk.local│240464@biysk.local│1578 │ │3│blf │240244│240464│240244@biysk.local│240464@biysk.local│1124 │ │4│blf │240244│240474│240244@biysk.local│240474@biysk.local│1124 │ └─┴────┴──────┴──────┴──────────────────┴──────────────────┴───────┘ [exec at: 23.03.2019 08:31:36, exec time: 412ms, nodes: sip1@ecss1]
subscription-monitor
Команда предназначена для мониторинга подписок пользователя.
Путь команды:
/domain/<DOMAIN>/sip/user/subscription-monitor
Синтаксис:
monitor event = <TypeService> <Address1> <Address2> ...
Прерывание мониторинга - Ctrl+C
Параметры:
<Address> - используемый адрес домена;
<TypeService> - мониторинг услуг blf или голосовой почты.
Пример:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/subscription-monitor event = * 240101 trying : 2516270882@192.168.2.201 : early : 2516270882@192.168.2.201 : Aleksandr Zhivonitko:240101 -> :240501 confirmed : 2516270882@192.168.2.201 : Aleksandr Zhivonitko:240101 -> :240501 terminated : 2516270882@192.168.2.201 : Aleksandr Zhivonitko:240101 -> :240501 Command has been canceled: interrupted
subscription-stop
Команда предназначена для остановки подписок пользователя.
Путь команды:
/domain/<DOMAIN>/sip/user/subscription-stop
Синтаксис:
subscription <SRC_USER_INTERFACE><TYPE><DST_USER_INTERFACE> [--force]
Параметры:
<SRC_USER_INTERFACE> - название интерфейса подписчика. Символ "*" используется для указания всех пользователей;
<TYPE> - тип подписки (blf, conference-info, presence, ss-info, voicemail). Символ "*" используется для указания всех типов;
<DST_USER_INTERFACE> - название интерфейса, на который подписан пользователь. Символ "*" используется для указания всех пользователей.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/sip/user/subscription-stop 240101@biysk.local blf 240258@biysk.local [subscription-stop] record(s) will be removed continue: yes/no ?> yes Executed on the sip1@ecss1 5 subscriptions are stoped [exec at: 23.03.2019 09:12:38, exec time: 3s 442ms, nodes: sip1@ecss1]