В данном разделе приводится описание команд управления конфигурацией абонентов SIP.

<DOMAIN> — имя виртуальной АТС.

Набор параметров SIP

В данном разделе описываются параметры SIP-интерфейсов.

Различают:

параметры SIP-транка (TR) — просмотр и установка командами /domain/DOMAIN/trunk/sip/...
параметры локального SIP-абонента (SUB) — просмотр и установка командами /domain/DOMAIN/sip/user/...
параметры интерфейса SIP (IF) — просмотр и установка командами /domain/DOMAIN/iface/user-set/...
Пометка "info" означает, что параметр не имеет возможности настройки командами адаптера (формируется на основе других параметров или внешних воздействий/событий).
Пометка "rt" означает realm-time параметр, не имеющий хранения в общей базе интерфейсов.

При отображении значения, все значения параметров приводятся к "читаемому" виду адаптером. В "сыром" виде, хранимом в базе, значениями параметров можно оперировать командами /domain/DOMAIN/iface/... Если рабочее имя параметра отличается от хранимого в базе, что второе указывается дополнительно в скобках.

Следует иметь ввиду, что хранимое в базе значение может отличаться от текущего. Работа с параметрами интерфейса напрямую (не через команды адаптера) допускается лишь в случаях крайней необходимости: устранение аварий, временное решение каких-либо проблем или ошибок.

Также может отличаться состав параметров. Так не все рабочие параметры могут быть отображены в базе (в частности, параметры, используемые "по умолчанию"). Или в базе могут присутствовать устаревшие параметры (не всегда импорт данных при переходе на новую версию может автоматически зачистить неиспользуемые данные).

Если в таблице не указано значение по умолчанию ("-"), то значение по умолчанию не определено и устанавливается протокол-адаптером SIP.

Таблица — Описание параметров SIP-интерфейса

Название параметра	Тип	Описание	Значение по умолчанию
access_group	TR, SUB	Группа, которая определяет правила доступа для этого пользователя	all
alarm_enable	TR, SUB	Отправка предупреждений при переходе интерфейса в неактивное состояние. Для транков/абонентов: если включена опция периодического опроса (см. настройку options_control). Значения: true — отправка оповещения включена; false — отправка оповещения выключена.	true
alias (aliases_list)	SUB	Cписок алиасов, если пользователь был задекларирован с логическим, а не цифровым номером.	-
aliases activities	SUB (info)	Cписок алиасов с указанием их состояния.	-
allow	SUB (info,rt)	Параметр хранит для абонента запросы, поддерживаемые пользовательским шлюзом, которые были получены в запросе регистрации (используется, чтобы знать, чем отправить запрос "check OPTIONS" или "INVITE"). Устанавливается протокол-адаптером SIP.	-
allow events	SUB (info)	Расширения (Allow-Events), поддерживаемые терминалом SIP-пользователя.	-
authentication	SUB (info)	Параметры аутентификации SIP-пользователя: логин, пароль, требование qop.	none
auto-answer-version	SUB	Автоматический ответ терминала вызываемому абоненту (позволяет средствами протокола SIP установить диалог, не дожидаясь ответа стороной Б). Значения: default — используется настройка на уровне виртуальной АТС; answermode — заголовки `Auto-Answer: auto, Require: answermode` (терминалы, поддерживающие RFC5373); сall-info — шаблон заголовка `Call-Info: <sip:PBX_NAME>; answer-after=0` (Broadsoft, Yealink, Snom); call-info — шаблон заголовка `Call-Info: =\; answer-after=0` (Lynksys, Yealink); call-info — по необходимости возможна строка в произвольном формате; alert-info — шаблон заголовка `Alert-Info: Auto Answer` (Polycom, Yealink); alert-info — шаблон заголовка `Alert-Info: info=alert-autoanswer` (Aastra); alert-info — по необходимости возможна строка в произвольном формате; none — не отправлять команду (терминал не поддерживает ни одну из реализаций авто-ответа).	Alert-Info: Auto Answer
category_to_sip	TR, SUB	Выбор режима передачи категории вызывающей стороны средствами протокола SIP (для обеспечения совместимости с встречными системами различных производителей). Режим передачи может быть задан на уровне домена (Pbx), группы SIP-юзеров, SIP-интерфейса (транка или юзера). В зависимости от уровня, имеются следующие режимы: default — использовать режим, выставленный на уровне домена; category — отправка и прием категории вызывающего абонента в отдельном SIP-заголовке Сategory инициирующего запроса INVITE, в этом случае передается категория ОКС-7 со значениями 0 – 255; сpc — категория передается при помощи тега «cpc=», передаваемого в SIP-заголовке From, в этом случае передается категория АОН со значениями 1-10; сpc-rus — категория передается при помощи тега «cpc-rus=», передаваемого в SIP-заголовке From, в этом случае передается категория АОН со значениями 1-10; none — не передавать категорию средствами SIP.	default
cdpn-transformation	TR	Подмена CDPN в сообщении SetupInd от SIP-адаптера к ядру значением из ACDPN или Redirecting Значения: none — не изменять; by-redirection — подмена номера из Redirecting Number; by-generic-cdpn — подмена из Generic Number, имеющего Number qualifier indicator = 00000001 additional called number; by-generic — подмена из Generic Number, имеющего любой Number qualifier indicator.	none
channel-contact-map	TR	Параметр связывает номер канала с контактом, который уже должен быть создан. Если канал не существует, то он будет создан. Значения: add — добавить; remove — удалить; channel_range — диапазон каналов; contact_range — диапазон контактов.	-
client-profile	SUB	Идентификатор профиля SIP-клиента. Позволяет включать опции специфичные терминалам конкретного производителя или модели (см. настройку профиля абонентов SIP). none — стандартная работа без специфичных опций; auto — клиентский терминал определяется в ходе процедуры регистрации по заданным правилам; ИМЯ_ПРОФИЛЯ — прямое назначение профиля или выбор предустановленного.	none
compact-form	TR, SUB	Использование SIP-заголовков компактной формы. default — автоматический выбор; true — всегда использовать компактную форму; false — всегда использовать полную форму.	-
connect time	TR (info)	Время последнего соединения с транком (либо после пропадания ответов на периодический опрос доступности, либо с момента старта или декларации.	-
contacts definition	SUB (info,rt)	Список зарегистрированных контактов с сопутствующей им информацией: время истечения регистрации, локальная точка регистрации, заголовков Via, User-Agetnt.	-
content_encoding	TR	Кодирование тела SIP-запроса (ответа). В текущей версии ПО поддерживается только один формат кодирования. Значения: gzip — кодирование (сжатие) в формате ZIP; none — кодирование не используется.	none
declared by	TR, SUB (info,rt)	Дата декларации интерфейса и оператор, выполнивший ее.	-
digest	SUB	Требование аутентификации. Для частной сети при настроенных trusted-ip аутентификация может быть излишней.	true
disconnections number	TR (info)	Количество потерь связи с транком (прекращение ответов на периодический опрос доступности).	-
disable-remote-port-control	TR, SUB	Отключение проверки удаленного порта при входящем вызове от абонента. Значения: true — проверка включена; false — проверка выключена.	false
display-name-encoding		Тип схемы для кодирования/декодирования sip url.	win1251
dtmf-duration	TR, SUB	Длительность DTMF-сигнала, передаваемая в исходящем сообщении SIP INFO.	100
dtmf-relay	TR, SUB	Выбор типа MIME для передачи DTMF в теле запроса SIP INFO. При значении "true" используется тип "application/dtmf-relay", иначе "application/dtmf".	false
expand-destinations	TR	Позволяет ввести несколько IP адресов для транка, с которых разрешается принимать входящие вызовы.	-
fork-mode	SUB	Регистрация нескольких контактов SIP-абонента. all-contacts — одновременный запрос на все контакты; find-me-one-by-one — последовательный перебор контактов по списку; find-me-with-q — последовательный перебор с учетом приоритета; disable — отключение исходящего форкинга. Allow-repeat-ip — разрешить перезапись контактов с одного IP-адреса, но разных портов: allow-repeat-ip — существующий контакт будет сохраняться; disallow-repeat-ip — существующий контакт будет перезаписываться. При последовательном переборе контактов (режимы find-me) возможно переключение: previous-continue — при переходе к следующему контакту вызов предыдущего продолжается; previous-stop — при переходе к следующему контакту вызов предыдущего отменяется.	disable
gate	TR, SUB (info)	Имя инициирующей очереди и ключ маршрутизации адаптера на внутреннем транспорте (AMQP). Параметры являются служебными, назначаются всегда автоматически при декларации или регистрации в зависимости от типа транка или юзера.	-
group	TR,SUB	Группа интерфейсов, которой принадлежит SIP-пользователь.	-
history_info	TR	Включение оригинальной информации о переадресации в заголовок History-Info в исходящий INVITE.	false
host	TR	IP-адрес или имя хоста сервера.	-
host-to-invite	SUB	registered-domain — в исходящем INVITE в заголовке To используется домен, полученный в запросе регистрации. sip-domain — в исходящем INVITE в заголовке To используется SIP-домен пользователя.	registered-domain
ice/enabled	IF	Включается, когда необходимо обеспечить корректную работу web-клиента, чтобы вызов уходил с SDP, понятным WebRTC. Значения: false — решётка передается в hex-формате (%23); true — решётка передается символом '#'. Вместе с данным параметром нужно включить nat-traversal. Данный параметр в своей работе конфликтует с core_forking, являясь менее приоритетным.
core_forking	IF	Включается, когда необходимо обеспечить одновременное использование абонентом телефонного аппарата и WebRTC-клиента, работающего по протоколу ice. На все контакты такого пользователя делаются параллельные вызовы. Контакт, ответивший раньше остальных, будет проключен с вызывающим абонентом. Данный параметр в своей работе конфликтует с ice/enabled, являясь более приоритетным.	none
inc_authentication	TR	Требование прокси авторизации со стороны транка. Принимает значения: false — авторизация не требуется; true — авторизация необходима.	false
inc_authentication_type	TR	Тип запроса авторизации: user — в ответе 401, proxy — в ответе 407.	user
inc_authentication_login	TR	Логин для входящей прокси авторизации. Используется, если требуется прокси-авторизация для транка при входящем занятии.	-
inc_authentication_password	TR	Пароль для входящей прокси авторизации. Используется, если требуется прокси-авторизация для транка при входящем занятии.	-
internal iface name	SUB (info)	Идентификатор интерфейса внутри системы.	-
inc-login	TR	логин встречной стороны для аутентификации входящего вызова.	LOGIN
inc-password	TR	пароль встречной стороны для аутентификации входящего вызова.	PASSWORD
ip-set	TR	Привязка транка к локальному адресу (набору адресов). Настроенные ip-set смотри: cluster/adapter/sip1/sip/network/info.	-
isActive	TR, SUB (info)	Состояние интерфейса в данный момент. Значения: true — интерфейс активен (направление доступно или абонент зарегистрирован); false — интерфейс неактивен (определено автоматически или интерфейс выведен из работы целенаправленно). Служебный параметр.	false
isup_r_ccl_send	TR	Поддержка сообщения CCL ISUP-R. При отбое со стороны вызывающего абонента (далее абонента А) на сторону вызываемого абонента (далее абонента Б) вместо SIP/BYE уходит SIP/INFO с инкапсулированным ISUP-R/CCL. Актуально только для режимов с инкапсуляцией ISUP (см. настройку mode). Значения: true — отправка CCL включена; false — отправка CCL выключена.	false
isup-cause-location	TR, SUB	Локализация транка на сети. Используется для определения инициатора разъединения, в частности, при инкапсуляции ISUP/REL. Данная локализация описана в рекомендации ITU Q.850: см. Figure 4/Q.850 — Reference configuration for location field generation; см. Table 4/Q.850 — The setting of location fields by events at nodes of the reference configuration and values expected to be received by user A. Реальные значения (при отображении параметров интерфейсов): user (U); local_private_network (LPN); local_network (LN); transit_network (TN); international_network (INTL); remote_network (RLN); remote_private_network (RPN); Разрешенные значения для ввода (при вводе с терминала используются сокращения): INTL_(International_network); LN___(Public_network_serving_the_local_user; LPN__(Private_network_serving_the_local_user; RLN__(Public_network_serving_the_remote_user; RPN__(Private_network_serving_the_remote_user; TN___(Transit_network); U____(User). По [TAB] параметры разворачиваются в указанном выше виде с подсказкой после символа подчеркивания. К установке применяются только первые значащие символы (до "_"). Например, значения LPN и LPN__(Private_network_serving_the_local) равнозначны.	local_network
last via	SUB (info)	Информация о прохождении запроса регистрации.	-
listen_port	TR	Порт для SIP-сигнализации с транка на стороне SSW. Если на адаптере открыто несколько слушающих портов, то можно различать транки по получению сообщений с одного адреса одной сети, но с разных портов. Номер порта всегда должен быть выбран из имеющегося списка.	-
local-end-point	TR	Транспортные параметры включения транка на стороне ECSS. Включают в себя: ip-set, listen-port, node-control. Node-control включается при необходимости обслуживания вызовов только одним определенным IP-адресом. На локальной стороне.
maddr	TR	Отправка запросов на номер массовой рассылки. Значения: адрес сервера массовой рассылки; "none" (обычная работа — отправка на прямой адрес).	none
mode	TR	Режим инкапсуляции ISUP. Принимает значения: sip-proxy — направление на SIP (прокси,RFC 3261 ); sip-t — направление на SIP-T (RFC 3372); sip-i — направление на SIP-I (ITU Q.1912-5; sip-q — направление на QSIG.	-
my_from	TR, SUB	Назначается для групп транков или абонентов. Назначение исходящего адреса, отличного от локального хоста. Необходимо для обеспечения возможности установки в заголовок "From" (при исходящих запросах на данную транковую группу или абонентов) коллективного адреса нод кластера. Значения: коллективное доменное имя кластера; кастомное имя, из списка public_names (определяется на уровне параметров домена); default — использовать локальное имя хоста, назначенного параметром конфигурации sip.transport/my_sip_address. Опциональные параметры: - --use_login - использовать логин вместо Cgpn в заголовке From - --use number - использовать Cgpn в заголовке From (по умолчанию)	default
nat_traversal	TR, SUB	Включение режима обхода NAT. Опция применима к SIP-пользователям и динамическим SIP-транкам (для которых требуется регистрация на ECSS). Значения: true — опция включена; false — опция выключена. Общий принцип режима NAT-traversal: При включении этого параметра SSW игнорирует поле "Contact" в SIP-сообщениях и отправляет сигнализацию, используя адрес источника (source). Для работы режима необходимо дополнительно настроить параметр udp-src-check на MSR, данный параметр работает аналогично параметру NAT-traversal, но уже не для SIP-сигнализации, а для RTP-потока, он позволяет SSW игнорировать данные источника в SDP и отправлять медиа на адрес источника (см. раздел Настройка программного медиасервера).	false
no_video	IF	На уровне интерфейса добавлено свойство no_video. Возможные значения опции no_video: false — опция включена, значение по умолчанию; if_no_video_from_a — опция отключена. Чтобы в SDP отсутствовала секция видео для исходящего вызова на номер Б, нужно чтобы: на интерфейсе Б свойство no_video было выставлено в if_no_video_from_a; отсутствовала секция видео в SDP входящем вызова от номера А (в рамках вызова с номера А на номер Б); вызов с номера А на номер Б был прямой, т. е. вызов не через IVR, trunk; Б может быть алиасом или транком. Если условия выше были выполнены, то в рамках вызова из медиа профиля абонента Б удаляется секция видео. На основе получившего медиа профиля формируется sdp-template, который засылается на msr в SIP-сообщении INVITE. В результате msr отдает OfferSDP без секции видео в SIP-сообщении 200 OK.	false
options_control	TR, SUB	Периодический контроль доступности направления (транка или контактов юзера). При включении данной опции на транк с заданным интервалом отправляется запрос "SIP/OPTIONS". Если ответа не получено, то направление (контакт) переводится в неактивное состояние и шлется соответствующий alarm (см. настройку alarm_enable). При этом периодический опрос не прекращается. При получении ответа направление (контакт) возвращается (если было неактивно) в активное состояние. Если опция выключена, то контроля доступности нет — считаем направление (контакт) доступным Кроме проверки доступности, результатом запроса "OPTIONS" является информация о параметрах встречной стороны, например, поддержка 100rel (надежная доставка предварительных ответов), timers (session-expire по RFC 4028).	0
original-cdpn-to	TR, SUB	Переключение подстановки CDPN на основе Original CDPN на основе принятых заголовков To либо Diversion.	true
out_login (proxy_out_login)	TR, SUB	Логин для исходящей авторизации. Необходим, если встречная сторона (транк) требует авторизации исходящих от нас запросов.	-
out_password (proxy_out_password)	TR, SUB	Пароль для исходящей авторизации. Необходим, если встречная сторона (транк) требует авторизации исходящих от нас запросов.	-
published presence	SUB (info)	Состояние, опубликованное терминалом SIP-пользователь (PUBLISH, Event: presence). Транслируется подписчикам услуги presence.	-
play-rbt	IF	Переопределение КПВ. где MODE: always — будет генерироваться всегда локальный КПВ early-media — генерация КПВ на получение 180+SDP (Переопределение early-media) ringing — генерация КПВ на получение 180 none — нет переопределения Если данное свойство выставлено на интерфейсе, и произошел вызов на транк, то будет КПВ будет переопределяться.	none
port	TR	Порт назначения для транка.	-
qop-authentication (aut_qop)	SUB	Использование расширенной QOP-авторизации (повышенный уровень защиты). Значения: true — опция включена; false — опция выключена.	false
realUri	TR	Описание параметров удаленной стороны. Формат: {MODE,ISUP,DEST_HOST,DEST_PORT} MODE — режим: sipproxy, sipt (инкапсуляция ISUP по RFC 3372), sipi (инкапсуляция ISUP по ITU Q.1912-5); ISUP — инкапсуляция ISUP: sub (без инкапсуляции), far (с инкапсуляцией); DEST_HOST — адрес удаленной стороны (IP или доменное имя); DEST_PORT — порт удаленной стороны (числовое значение, например, 5060). Служебный параметр формируется автоматически при декларации или смене одного из параметров.	-
referred-by-as-cgpn	TR, SUB	Номер и поля user заголовка Referred-By используется в качестве Cgpn при отправке в ядро SetupInd.	false
register-expire-min	SUB	Минимальное значение периода перерегистрации.	90
register-expire-max	SUB	Максимальное значение периода перерегистрации.	3600
registrator	SUB (info)	Имя и транспортные параметры ноды, которой была обработана регистрация. Выставляется протокол-адаптером SIP.	-
regs_time	SUB (info)	Время регистрации. Устанавливается протокол-адаптером SIP.	-
rel_to_cancel	TR	Включение инкапсуляции ISUP/REL в "SIP/CANCEL". Актуально для режимов с инкапсуляцией ISUP (см. настройку mode). В зависимости от сети, на которой установлен SSW, либо от встречной стороны инкапсуляция может требоваться или быть неподдерживаемой. Значения: false — "CANCEL" без инкапсуляции ISUP/REL; true — "CANCEL" с инкапсуляцией ISUP/REL.	false
remote-client	TR	Выбор предустановленного профиля встречного сервера. Позволяет включать опции специфичные серверам конкретного производителя (см. настройку профиля абонентов SIP). coral — Поддержка сервера CORAL; default — стандартная работа.	default
remote-ctr-indication	TR, SUB	Заголовок для указания об удаленном CTR: rpi — REMOTE-PARTY-ID; pai — P-ASSERTED-IDENTITY; both — одновременное включение REMOTE-PARTY-ID и P-ASSERTED-IDENTITY; none.	rpi
remote-end-point	TR	Транспортные параметры включения транка на встречной стороне. Включают в себя: ip-адрес/доменное имя и порт.
remote-network-type	TR	Тип удаленной сети. Используется для определения инициатора разъединения, в частности, при инкапсуляции ISUP/REL. Значения: private; local; transit; international.	local
req100rel	TR	Требование надежных промежуточных ответов. Надежность обеспечивается отправкой запроса "PRACK" в ответ на соответствующий 1хх (RFC 3262). Значения: true — при отправке ответов группы 1хх включать "Require: 100rel"; false — требование надежности не отправляется; supported — требование надежности не отправляется. Удаленная сторона поддерживает данную опцию, но требование надежности ему не отправляется; unsupported — требование надежности не отправляется. Удаленная сторона не поддерживает данную опцию, но при настройке было задано "требовать надежность". В этом случае требование отправляться не будет, но если в дальнейшем (например, после очередного ответа на "OPTIONS") определится поддержка, то требование начнет ставиться, в этом случае данный параметр поменяет значение на "true".	false
rfc-4028-control	TR, SUB	Поддержка контроля сессии по RFC 4028, даже в случае, если удаленная сторона его не поддерживает. К настройке доступны значения "true" и "false". Значения: true — включено. Обновление сессии производится только в случае если встречная сторона поддерживает timer; false — выключено; force — включено. Обновление сессии производится не зависимо от поддержки timer встречной стороной.	true
route-by-via	TR	Настройка актуальна для динамического транка. Позволяет подставлять в Request-URI информацию из поля Contact, полученную при регистрации. Значения: true; false.	false
routing.context	TR, SUB,IF	Контекст маршрутизации.	-
sip-modifications	TR, SUB	Настройка модификации заголовков SIP в исходящих запросах и ответах. Кроме модификации текста доступно полное исключение заголовка из сообщения. Формат: sip-modifications ignore headers = [HEADER1, HEADER2, ...] — исключение заголовка при отправке сообщения; sip-modifications set PARAMETERS SET header = HEADER, key1 = val1, key2 = val2, ... — правило модификации; sip-modifications clean HEADER — сброс модификации. Описание правил модификации: add_new = TEXT — добавить новый заголовок с TEXT; add_start = STRING — вставить текст в начало; add_end = STRING — добавить текст в конец; delete = STRING — найти и удалить указанный текст; insert = STRING — вставить текст вместо удаленного предыдущей командой.	-
sip-transit	TR, SUB	При звонке SIP/SIP есть возможность транзита отдельных заголовков Формат: sip-transit set PARAMETERS SET key1 = val1, key2 = val2, ... Параметры: headers = [HEADER1, HEADER2, ...] — транзит SIP заголовков в исходящих запросах и ответах на вторую сторону; clean — сброс всех настроек транзита.	-
sip-domain	TR, SUB	SIP-домен в "Request URI", заголовках From, To исходящего от нас запроса. Значения: имя домена; "undefined".	-
supported	SUB (info)	Функции (Supported), поддерживаемые терминалом SIP-пользователя.	-
support_encoding	SUB (info),IF	Отображение Display Name в зависимости от типа кодировки Значения: utf-8 — использование кодировки UTF-8 для данного абонента; latin1 — использование кодировки latin1 для данного абонента; cp1251 — использование кодировки cp1251 для данного абонента.	-
symbol_hash_as_is	TR, SUB	Передача символа '#' не в Hex-формате (%23). Значения: false — решётка передаётся в hex-формате (%23); true — решётка передаётся символом '#'.	false
trunk (trunk name)	TR	Логическое объединение транков (направление). Необходим для группировки SIP-направлений в целях контроля, статистики, СОРМ и т.д. Значением является имя.	-
trusted-ip	SUB	Список доверенных IP-адресов, запросы REGISTER и INVITE, полученные с IP-адреса из этого списка, обрабатываются без аутентификации.	none
tel-uri-in-diversion	TR, SUB	Использование формата "tel:" вместо "sip:" в заголовке Diversion при переадресации звонка.	false
uptime	TR (info)	Длительность последнего соединения с транком (либо после пропадания ответов на периодический опрос доступности, либо с момента старта или декларации.	-
user agent	SUB (info)	Название терминала SIP-пользователя (User-Agent).	-
use-global-callref	TR	Использование GLOBAL CALL REF для ISUP-ETSI. Параметр работает для адаптации диалектов национальных стандартов ОКС-7 при пропускании международного трафика.	false
user-name	TR	Имя юзера при исходящей регистрации транка. Если не назначено (значение none), используется имя транка.	none

Описание параметров кластера SIP:

/adapter/<CLUSTER>/properties

Описание параметров Виртуальной АТС на уровне SIP-адаптера:

domain/<DOMAIN>/sip/properties
domain/<DOMAIN>/sip/properties_sys

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>.

Номер может быть задано шаблоном: Prefix_Symbols{Start_Digits-Stop_Digits}.

<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]