/domain/<DOMAIN>/sip/user/ - команды управления конфигурацией абонентов SIP
В данном разделе приводится описание команд управления конфигурацией абонентов SIP.
<DOMAIN> - имя виртуальной АТС.
Набор параметров SIP
В данном разделе описываются параметры SIP-интерфейсов.
Различают:
- параметры SIP-транка (TR) — просмотр и установка командами
/domain/DOMAIN/trunk/sip/... - параметры локального SIP-абонента (SUB) — просмотр и установка командами
/domain/DOMAIN/sip/user/...
Пометка "info" означает что параметр не имеет возможности настройки командами адаптера (формируется на основе других параметров или внешних воздействий/событий).
Пометка "rt" означает realm-time параметр, не имеющий хранения в общей базе интерфейсов.
При отображении значения, все значения параметров приводятся к "читаемому" виду адаптером.
В "сыром" виде, хранимом в базе, значениями параметров можно оперировать командами /domain/DOMAIN/iface/...
Если рабочее имя параметра отличается от хранимого в базе, что второе указывается дополнительно в скобках.
Следует иметь ввиду, что хранимое в базе значение может отличаться от текущего. Работа с параметрами интерфейса напрямую (не через команды адаптера) допускается лишь в случаях крайней необходимости: устранение аварий, временное решение каких-либо проблем или ошибок.
Также может отличаться состав параметров. Так не все рабочие параметры могут быть отображены в базе (в частности, параметры, используемые "по умолчанию"). Или в базе могут присутствовать устаревшие параметры (не всегда импорт данных при переходе на новую версию может автоматически зачистить неиспользуемые данные).
Если в таблице не указано значение по умолчанию ("-"), то значение по умолчанию не определено и устанавливается протокол-адаптером SIP.
Таблица — Описание параметров SIP-интерфейса
| Название параметра | Тип | Описание | Значение по умолчанию |
|---|---|---|---|
| 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 |
| 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 |
| 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 | default |
| nat_traversal | TR, SUB | Флаг, означающий использование реального адреса назначения, вместо контакта. Для транков актуален для динамических (требующих регистрации). Значения: - true — опция включена; - false — опция выключена. | 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 | TR | Переопределние КПВ где MODE:
Если данное свойство выставлено на интерфейсе, и произошел вызов на транк, то будет КПВ будет переопределяться. | 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 | Контекст маршрутизации | - |
| 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) | Отображение Display Name в зависимости от типа кодировки Значения: - utf-8 — использование кодировки UTF-8 для данного абонента - latin1 — использование кодировки latin1 для данного абонента - cp1251 — использование кодировки cp1251 для данного абонента | - |
| symbol_hash_as_is | TR, SUB | Передача символа '#' не в Hex-формате (%23). Значения: - false — решётка передаётся в hex-формате (%23); - true — решётка передаётся символом '#'. | false |
| trunk | 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-адаптера:
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 ... [**********************************************************************] 36mks check authentication info for 1 interfaces ... [**********************************************************************] 7ms Executed on the sip1@ecss1 ┌────────────────────┬─────────┬────────────┬────────────────┐ │ User │ Use QOP │ Trusted IP │ LDAP account │ ├────────────────────┼─────────┼────────────┼────────────────┤ │ 240502@biysk.local │ true │- │ no_information │ └────────────────────┴─────────┴────────────┴────────────────┘ ┌─────────────┐ │ elements: 1 │ └─────────────┘ [exec at: 18.03.2019 22:38:53, exec time: 118ms, nodes: sip1@ecss1]
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]:/$ domain/biysk.local/sip/call-list --more 2 min
Executed on the sip1@ecss1
┌────────────────────┬────────────────────────────┬───────────┬──────────────────────────────────────────┬───────────────────────────────────────────────────────┐
│ Interface URI │ Direction │ State │ Time │ Additional info │
├────────────────────┼────────────────────────────┼───────────┼──────────────────────────────────────────┼───────────────────────────────────────────────────────┤
│ 240244@biysk.local │ sip[240244] -> ssw[240470] │ connected │ Start: Mon, 18 Mar 2019 13:49:54 │ Node: sip1@ecss1, <0.29555.0> │
│ │ │ │ Last activity: Mon, 18 Mar 2019 13:52:48 │ CallRef: 3833844896 │
│ │ │ │ │ Call-ID: "8f84-46ae" │
│ │ │ │ │ SessionID: <<"8cfadbfb0e6c517c">> │
│ │ │ │ │ Session handler: {amqp_io_2,<0.29555.0>} │
│ 240470@biysk.local │ sip[240470] <- ssw[240244] │ connected │ Start: Mon, 18 Mar 2019 13:49:54 │ Node: sip1@ecss1, <0.29557.0> │
│ │ │ │ Last activity: Mon, 18 Mar 2019 13:52:48 │ CallRef: 3833844896 │
│ │ │ │ │ Call-ID: "BA:8cfadbfb0e6c517c:8cfadc03a5511282" │
│ │ │ │ │ SessionID: <<"BA:8cfadbfb0e6c517c:8cfadc03a5511282">> │
│ │ │ │ │ Session handler: {amqp_io_7,<0.29557.0>} │
└────────────────────┴────────────────────────────┴───────────┴──────────────────────────────────────────┴───────────────────────────────────────────────────────┘
┌────────────┐
│ 2 sessions │
└────────────┘
[exec at: 18.03.2019 13:52:49, exec time: 75ms, 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 [change-group] Group 800.gr isn't exists continue: yes/no ?> yes 1 make users list ... [**********************************************************************] 92mks 1 interfaces apply ... [**********************************************************************] 1ms Executed on the sip1@ecss2 ok [exec at: 19.03.2019 10:42:30, exec time: 4s 816ms, nodes: sip1@ecss2]
admin@[mycelium1@ecss1]:/$ domain/biysk.local/sip/user/change-group loc.gr 24081{0-9}@biysk.local 800.gr
10 make users list ...
[**********************************************************************] 127mks
5 interfaces apply ...
[**********************************************************************] 12ms
Executed on the sip1@ecss1
ok
[exec at: 19.03.2019 10:43:00, exec time: 509ms, nodes: sip1@ecss1]
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* 324 make users list ... [**********************************************************************] 803mks Executed on the sip1@ecss2 Intermediate (incomplete) result: check for user 240462@biysk.local by sip1@ecss2 (node control: false) ... 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 240466@biysk.local by sip1@ecss2 (node control: false) ... Executed on the sip1@ecss2 Intermediate (incomplete) result: check for user 240469@biysk.local by sip1@ecss2 (node control: false) ... Executed on the sip1@ecss2 ┌────────┬────────────────────┬────────────┬───────────────────────────────────────────────────────────────────────┐ │ Group │ User │ Accessible │ Check info │ ├────────┼────────────────────┼────────────┼───────────────────────────────────────────────────────────────────────┤ │ loc.gr │ 240462@biysk.local │ true │ OPTIONS to <sip:240462@192.168.2.6>: 200 OK, cseq: 875088 OPTIONS. │ │ │ │ │ Request by node: sip1@ecss2 │ │ │ │ │ │ │ loc.gr │ 240464@biysk.local │ true │ OPTIONS to <sip:240464@192.168.2.200>: 200 OK, cseq: 979690 OPTIONS. │ │ │ │ │ Request by node: sip1@ecss2 │ │ │ │ │ │ │ loc.gr │ 240465@biysk.local │ false │ User isn't registered now │ │ │ │ │ │ │ loc.gr │ 240466@biysk.local │ true │ OPTIONS to <sip:240466@192.168.2.6>: 200 OK, cseq: 7954 OPTIONS. │ │ │ │ │ Request by node: sip1@ecss2 │ │ │ │ │ │ │ loc.gr │ 240467@biysk.local │ false │ User isn't registered now │ │ │ │ │ │ │ loc.gr │ 240469@biysk.local │ true │ OPTIONS to <sip:240469@192.168.2.6>: 200 OK, cseq: 118367 OPTIONS. │ │ │ │ │ Request by node: sip1@ecss2 │ └────────┴────────────────────┴────────────┴───────────────────────────────────────────────────────────────────────┘ [exec at: 19.03.2019 10:47:39, exec time: 451ms, nodes: sip1@ecss2]
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 ... [**********************************************************************] 46mks clean to 1 interfaces ... [**********************************************************************] 6ms Executed on the sip1@ecss2 complete [exec at: 19.03.2019 11:39:56, exec time: 6s 582ms, nodes: sip1@ecss2]
admin@[mycelium1@ecss1]:/$ domain/biysk.local/sip/user/clean loc.gr 24065* qop-authentication --force 324 make users list ... [**********************************************************************] 379mks clean to 10 interfaces ... [**********************************************************************] 51ms Executed on the sip1@ecss2 complete [exec at: 19.03.2019 11:56:23, exec time: 378ms, nodes: sip1@ecss2]
declare
Команда декларации абонента (группы абонентов).
При декларации создаются соответствующие интерфейсы и алиасы.
При требовании аутентификации для абонента (абонентов) можно сразу прописать параметры аккаунта (логин, пароль).
Путь команды:
/domain/<DOMAIN>/sip/user/declare
Синтаксис:
declare <ROUTING_CONTEXT> <GROUP> <USER_INTERFACE> <ALIAS> <QOP_AUTH> <LOGIN> <PASSWORD>
Параметры:
<ROUTING_CONTEXT> - название существующего контекста маршрутизации;
<GROUP> - название группы пользователей (может быть задана существующая или новая группа пользователей);
<USER_NUMBER> - номер создаваемого SIP-абонента.
Номер может быть задано шаблоном: 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 ... [**********************************************************************] 112mks 1 users interfaces declaration ... [**********************************************************************] 21ms 1 users aliases declaration ... [**********************************************************************] 46ms 7 interfaces recall to base [**********************************************************************] 10ms Executed on the sip1@ecss1 ┌────────────────────────┐ │ declared 1 subscribers │ └────────────────────────┘ [exec at: 19.03.2019 13:22:47, exec time: 242ms, nodes: sip1@ecss1]
Декларация 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 ...
[**********************************************************************] 213mks
10 users interfaces declaration ...
[**********************************************************************] 165ms
10 users aliases declaration ...
[**********************************************************************] 33ms
10 interfaces recall to base
[**********************************************************************] 16ms
Executed on the sip1@ecss2
┌─────────────────────────┐
│ declared 10 subscribers │
└─────────────────────────┘
[exec at: 19.03.2019 13:18:38, exec time: 369ms, nodes: sip1@ecss2]
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@ecss2
[{old,1000},{new,5}]
[exec at: 19.03.2019 13:24:43, exec time: 113ms, nodes: sip1@ecss2]
admin@[mycelium1@ecss1]:/$ domain/biysk.local/sip/user/errors Executed on the sip1@ecss1 ┌────────────────────┬─────────────────────┬────────────────────────────────────────────────────────────────┐ │ Uri │ Last event time │ Event │ ├────────────────────┼─────────────────────┼────────────────────────────────────────────────────────────────┤ │ 240544@biysk.local │ 2019-03-19 07:38:37 │ Wrong authentication (first: 2019-03-19 07:38:37, 2/2 time(s)) │ │ 240550@biysk.local │ 2019-03-19 07:38:37 │ Wrong authentication (first: 2019-03-19 07:38:37, 0/2 time(s)) │ │ 240592@biysk.local │ 2019-03-19 07:38:37 │ Wrong authentication (first: 2019-03-19 07:38:37, 2/2 time(s)) │ │ 240602@biysk.local │ 2019-03-19 07:38:37 │ Wrong authentication (first: 2019-03-19 07:38:37, 0/2 time(s)) │ │ 240635@biysk.local │ 2019-03-19 07:38:37 │ Wrong authentication (first: 2019-03-19 07:38:37, 0/2 time(s)) │ └────────────────────┴─────────────────────┴────────────────────────────────────────────────────────────────┘ [exec at: 19.03.2019 13:26:06, exec time: 92ms, nodes: sip1@ecss1]
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 ... [**********************************************************************] 89mks 1 users information read ... [**********************************************************************] 8ms Executed on the sip1@ecss1 ┌─────────────────────┬────────────────────────────────────────────────────────────────────────────────┐ │ User │ 240101@biysk.local │ ├─────────────────────┼────────────────────────────────────────────────────────────────────────────────┤ │internal iface name │063015220171e7f3 │ │isActive │true │ │group │loc.gr │ │authentication │240101:******** (ds) use qop: true │ │contacts definition │q: 1.0; ip-set: ipset1; on port: 5060; sip │ │ │ registred by node: sip1@ecss1 │ │ │ sip transport: udp │ │ │ user-agent: Yealink SIP-T28P 2.73.14.3 │ │ │ <sip:240101@192.168.2.26:5060;transport=UDP;line=20457>;expires=744 │ │declared by │admin at 13.03.2020 15:02:40 │ │ │ │ │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.1.201:5062;received=194.150.142.251 │ │ │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 │16.06.2020 12:18:02 │ │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.14.3 │ └─────────────────────┴────────────────────────────────────────────────────────────────────────────────┘ [exec at: 18.06.2020 11:00:30, exec time: 26ms, nodes: sip1@ecss1]
Сводная общая информация о всех sip-абонентах:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/sip/user/info
330 users check for active ...
[**********************************************************************] 25ms
Executed on the sip1@ecss2
┌────────┬─────────┬────────────────────────────────────────────────────────────────────────────────┐
│ Group │ Dynamic │ Parameters │
├────────┼─────────┼────────────────────────────────────────────────────────────────────────────────┤
│ loc.gr │ false │ 'number of users' = 330 │
│ │ │ 'number of registered users' = 201 │
│ │ │ gate = {gate_amqp,<<"acp.adapter.init.ex">>,<<"acp.sip.sip1.ipset1.init.rk">>} │
│ │ │ owner = "sip1" │
└────────┴─────────┴────────────────────────────────────────────────────────────────────────────────┘
[exec at: 19.03.2019 10:20:19, exec time: 298ms, nodes: sip1@ecss2]
Регистрационная информация по абонентам из диапазона:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/info loc.gr 24046{4-6}@biysk.local
3 make users list ...
[**********************************************************************] 250mks
3 users information read ...
[**********************************************************************] 7ms
Executed on the sip1@ecss1
┌────────────────────┬────────┬─────────────────┬────────┬──────────────────────┬──────────────────────────────────────────────────────────────────┬───────────────────────────────────────┐
│ User │ Number │ Is active on DS │ Group │ Login │ Registration │ Extended information │
├────────────────────┼────────┼─────────────────┼────────┼──────────────────────┼──────────────────────────────────────────────────────────────────┼───────────────────────────────────────┤
│ 240464@biysk.local │ 240464 │ true │ loc.gr │ 240464:******** (ds) │ q: 1.0; ip-set: ipset1; on port: 5060; sip │ internal iface name: 06301521aa3fe8d9 │
│ │ │ │ │ │ registred by node: sip1@ecss1 │ sip domain: biysk.local │
│ │ │ │ │ │ sip transport: system (udp_only) │ │
│ │ │ │ │ │ user-agent: TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10 │ │
│ │ │ │ │ │ <sip:240464@192.168.2.200:5064>;expires=1453 │ │
│ │ │ │ │ │ │ │
│ 240465@biysk.local │ 240465 │ true │ loc.gr │ 240465:******** (ds) │ q: 1.0; ip-set: ipset1; on port: 5060; sip │ internal iface name: 06301521ac323499 │
│ │ │ │ │ │ registred by node: sip1@ecss1 │ sip domain: biysk.local │
│ │ │ │ │ │ sip transport: system (udp_only) │ │
│ │ │ │ │ │ user-agent: TAU-2M.IP/2.0.0.229 SN/VI39005419 sofia-sip/1.12.10 │ │
│ │ │ │ │ │ <sip:240465@192.168.2.200:5065>;expires=1596 │ │
│ │ │ │ │ │ │ │
│ 240466@biysk.local │ 240466 │ false │ loc.gr │ 240466:******** (ds) │ Contacts list is empty │ internal iface name: 063015220b839f5b │
│ │ │ │ │ │ │ sip domain: biysk.local │
│ │ │ │ │ │ │ last via: │
│ │ │ │ │ │ │ SIP/2.0/UDP 10.25.1.15:5041 │
│ │ │ │ │ │ │ SIP/2.0/UDP 192.168.2.26:5060 │
│ │ │ │ │ │ │ last time: │
│ │ │ │ │ │ │ 2020-06-16 09:35:57 │
└────────────────────┴────────┴─────────────────┴────────┴──────────────────────┴──────────────────────────────────────────────────────────────────┴───────────────────────────────────────┘
┌─────────────┐
│ elements: 3 │
└─────────────┘
[exec at: 18.06.2020 11:07:14, exec time: 24ms, nodes: sip1@ecss1]
Полная информация по абоненту:
admin@mycelium1@ecss1:/$ domain/biysk.local/sip/user/info loc.gr 240470@biysk.local --show-password 1 make users list ... [**********************************************************************] 43mks 1 users information read ... [**********************************************************************] 17ms Executed on the sip1@ecss1 ┌─────────────────────┬────────────────────────────────────────────────────────────────────────────────┐ │ User │ 240470@biysk.local │ ├─────────────────────┼────────────────────────────────────────────────────────────────────────────────┤ │internal iface name │06301521af32b2ea │ │isActive │true │ │group │loc.gr │ │authentication │240470:******** (ds) use qop: true │ │contacts definition │q: 1.0; ip-set: ipset1; on port: 5060; sip │ │ │ registred by node: sip1@ecss1 │ │ │ sip transport: udp │ │ │ user-agent: RG-1404GF-W/1.11.0 SN/VI25002012 sofia-sip/1.12.10 │ │ │ <sip:240470@192.168.2.26:5060;transport=UDP;line=1311>;expires=834 │ │declared by │admin at 13.03.2020 15:02:35 │ │ │ │ │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 10.25.1.23:5069;received=10.25.1.23;rport=5069 │ │ │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.06.2020 03:19:50 │ │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: 18.06.2020 11:09:37, exec time: 34ms, nodes: sip1@ecss1]
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* 324 make users list ... [**********************************************************************] 637mks 5 users check for active ... [**********************************************************************] 477mks Executed on the sip1@ecss2 ┌──────┬──────────────────┬───────────────────────────────────────────────────────────────────┐ │group │ user │ current contact(s) │ ├──────┼──────────────────┼───────────────────────────────────────────────────────────────────┤ │loc.gr│240470@biysk.local│<sip:240470@192.168.2.6:5060;transport=UDP;line=1311>;expires=1748 │ │loc.gr│240471@biysk.local│<sip:240471@192.168.2.6:5060;transport=UDP;line=8035>;expires=882 │ │loc.gr│240473@biysk.local│<sip:240473@192.168.2.6:5060;transport=UDP;line=62384>;expires=1286│ │loc.gr│240474@biysk.local│<sip:240474@192.168.2.6:5060;transport=UDP;line=25653>;expires=1072│ │loc.gr│240475@biysk.local│<sip:240475@192.168.2.6:5060;transport=UDP;line=11697>;expires=710 │ └──────┴──────────────────┴───────────────────────────────────────────────────────────────────┘ ┌─────────────┐ │ elements: 5 │ └─────────────┘ [exec at: 19.03.2019 13:43:09, exec time: 291ms, nodes: sip1@ecss2]
admin@[mycelium1@ecss1]:/$ domain/biysk.local/sip/user/list --forbidden Executed on the sip1@ecss1 ┌────────────────────┬───────────────────────┬──────────────────────────────────────────────────────────────┐ │request by transport│time of the last trying│ info │ ├────────────────────┼───────────────────────┼──────────────────────────────────────────────────────────────┤ │240544@biysk.local │2019-03-19 07:38:37 │Wrong authentication (first: 2019-03-19 07:38:37, 2/2 time(s))│ │240550@biysk.local │2019-03-19 07:38:37 │Wrong authentication (first: 2019-03-19 07:38:37, 0/2 time(s))│ │240592@biysk.local │2019-03-19 07:38:37 │Wrong authentication (first: 2019-03-19 07:38:37, 2/2 time(s))│ │240602@biysk.local │2019-03-19 07:38:37 │Wrong authentication (first: 2019-03-19 07:38:37, 0/2 time(s))│ │240635@biysk.local │2019-03-19 07:38:37 │Wrong authentication (first: 2019-03-19 07:38:37, 0/2 time(s))│ └────────────────────┴───────────────────────┴──────────────────────────────────────────────────────────────┘ ┌─────────────┐ │ elements: 5 │ └─────────────┘ [exec at: 19.03.2019 13:40:58, exec time: 73ms, nodes: sip1@ecss1]
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* 324 make users list ... [**********************************************************************] 780mks 6 users information read ... [**********************************************************************] 1ms Executed on the sip1@ecss2 ┌────────────────────┬────────┬─────────┬───────────────────────────────────────────┬───────────────────────────────────────────┐ │ Interface │ Number │ Dynamic │ Contact │ Registration info │ ├────────────────────┼────────┼─────────┼───────────────────────────────────────────┼───────────────────────────────────────────┤ │ 240462@biysk.local │ 240462 │ false │ q: 1.0; ip-set: ipset1; on port: 5060; sip│ registered on: │ │ │ │ │ │ node: sip1@ecss1 port: udp 192.168.2.61:│ │ │ │ │ registred by node: sip1@ecss1 │5060 │ │ │ │ │ sip transport: udp │ last via list: │ │ │ │ │ user-agent: Brcm-Callctrl/v1.10.3 M5T SIP│ SIP/2.0/UDP 192.168.2.6:5060;received=19│ │ │ │ │ Stack/4.1.2.2 │2.168.2.6;rport=5060 │ │ │ │ │ <sip:240462@192.168.2.6:5060;transport=UD│ SIP/2.0/UDP 10.28.32.131;received=10.28.│ │ │ │ │P;line=20445>;expires=69 │32.131 │ │ │ │ │ │ last user agent: │ │ │ │ │ │ Brcm-Callctrl/v1.10.3 M5T SIP Stack/4.1.│ │ │ │ │ │2.2 │ │ │ │ │ │ │ │ 240464@biysk.local │ 240464 │ false │ q: 1.0; ip-set: ipset1; on port: 5060; sip│ registered on: │ │ │ │ │ │ node: sip1@ecss1 port: udp 192.168.2.61:│ │ │ │ │ registred by node: sip1@ecss1 │5060 │ │ │ │ │ sip transport: system (udp_only) │ last via list: │ │ │ │ │ user-agent: TAU-2M.IP/2.0.0.229 SN/VI3900│ SIP/2.0/UDP 192.168.2.200:5064;received=│ │ │ │ │5419 sofia-sip/1.12.10 │192.168.2.200;rport=5064 │ │ │ │ │ <sip:240464@192.168.2.200:5064>;expires=1│ last user agent: │ │ │ │ │336 │ 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: │ │ │ │ │ │ node: sip1@ecss1 port: udp 192.168.2.61:│ │ │ │ │ registred by node: sip1@ecss1 │5060 │ │ │ │ │ sip transport: udp │ last via list: │ │ │ │ │ user-agent: VP-12/1.2.1.454 SN/VI51000844│ SIP/2.0/UDP 192.168.2.6:5060;received=19│ │ │ │ │ sofia-sip/1.12.10 │2.168.2.6;rport=5060 │ │ │ │ │ <sip:240466@192.168.2.6:5060;transport=UD│ SIP/2.0/UDP 10.25.1.5:5041;received=10.2│ │ │ │ │P;line=29316>;expires=894 │5.1.5;rport=5041 │ │ │ │ │ │ last user agent: │ │ │ │ │ │ VP-12/1.2.1.454 SN/VI51000844 sofia-sip/│ │ │ │ │ │1.12.10 │ │ │ │ │ │ │ │ 240469@biysk.local │ 240469 │ false │ q: 1.0; ip-set: ipset1; on port: 5060; sip│ registered on: │ │ │ │ │ │ node: sip1@ecss1 port: udp 192.168.2.61:│ │ │ │ │ registred by node: sip1@ecss1 │5060 │ │ │ │ │ sip transport: udp │ last via list: │ │ │ │ │ user-agent: Brcm-Callctrl/v1.10.3 M5T SIP│ SIP/2.0/UDP 192.168.2.6:5060;received=19│ │ │ │ │ Stack/4.1.2.2 │2.168.2.6;rport=5060 │ │ │ │ │ <sip:240469@192.168.2.6:5060;transport=UD│ SIP/2.0/UDP 10.28.32.131;received=10.28.│ │ │ │ │P;line=58471>;expires=69 │32.131 │ │ │ │ │ │ last user agent: │ │ │ │ │ │ Brcm-Callctrl/v1.10.3 M5T SIP Stack/4.1.│ │ │ │ │ │2.2 │ └────────────────────┴────────┴─────────┴───────────────────────────────────────────┴───────────────────────────────────────────┘ ┌─────────────┐ │ elements: 4 │ └─────────────┘ [exec at: 19.03.2019 14:03:53, exec time: 392ms, nodes: sip1@ecss2]
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 ... [**********************************************************************] 33mks 1 interfaces check for existing ... [**********************************************************************] 18mks 1 users leave ... [**********************************************************************] 12ms 1 interfaces remove from DS ... [**********************************************************************] 7ms Executed on the sip1@ecss1 Complete [exec at: 19.03.2019 14:16:57, exec time: 5s 499ms, nodes: sip1@ecss1]
Удаление диапазона абонентов:
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 ...
[**********************************************************************] 63mks
4 interfaces check for existing ...
[**********************************************************************] 39mks
4 users leave ...
[**********************************************************************] 66ms
4 interfaces remove from DS ...
[**********************************************************************] 11ms
Executed on the sip1@ecss2
Complete
[exec at: 19.03.2019 14:18:39, exec time: 2s 660ms, nodes: sip1@ecss2]
Удаление всей группы абонентов:
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 ... [**********************************************************************] 48mks 10 users leave ... [**********************************************************************] 165ms 10 interfaces remove from DS ... [**********************************************************************] 22ms Executed on the sip1@ecss1 Intermediate (incomplete) result: Group 85.gr has been removed (all interfaces in this group was removed) ... Executed on the sip1@ecss1 Complete [exec at: 19.03.2019 14:19:35, exec time: 2s 543ms, nodes: sip1@ecss1]
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@[ds1@ecss1]:/$ domain/biysk.local/sip/user/set loc.gr 240101@biysk.local rfc-4028-control false 1 make users list ... [**********************************************************************] 210mks set for 1 users ... [**********************************************************************] 6ms Executed on the sip1@ecss1 [exec at: 20.03.2019 23:46:52, exec time: 100ms, nodes: sip1@ecss1]
Пример назначения профиля(режима):
Значения могут быть:
- auto - автоматическое определение (по заголовку User-Agent);
- none - режим профилей игнорируется (сейчас используется по умолчанию этот режим);
- coral - для абонентов Coral;
- PROFILE_NAMES - список имеющихся профилей, из которых выбирается лишь один.
admin@ds1@ecss1:/$ domain/biysk.local/sip/user/set loc.gr 240244@biysk.local client-profile GrandStream Yealink auto coral none admin@ds1@ecss1:/$ domain/biysk.local/sip/user/set loc.gr 240244@biysk.local client-profile Yealink 1 make users list ... [**********************************************************************] 95mks set for 1 users ... [**********************************************************************] 5ms Executed on the sip1@ecss1 [exec at: 15.05.2019 12:44:10, exec time: 119ms, nodes: sip1@ecss1]
stop-registration
Данной командой производится принудительное завершение регистрации.
Сброс регистрации применяется как к конкретному URI абонента, так и к диапазону по маске.
Может понадобиться, например, для выведения шлюза из работы (для его замены).
Путь команды:
/domain/<DOMAIN>/sip/user/stop-registration
Синтаксис:
stop-registration <GROUP> <USER_INTERFACE> [--force]
Параметры:
<GROUP> - название группы пользователей. Символ "*" используется для указания всех групп;
<USER_INTERFACE> - название интерфейса или шаблон;
[--force] - выполнить команду без подтверждения.
Пример:
admin@[ds1@ecss1]:/$ domain/biysk.local/sip/user/stop-registration loc.gr 240464@biysk.local --force 1 make users list ... [**********************************************************************] 35mks stop registration to 1 interfaces ... [**********************************************************************] 12ms set 1 interfaces to inactive state on DS ... [**********************************************************************] 22ms Executed on the sip1@ecss2 1 users are de-registered (directly expired): 708c5bf76388b92e (240464@biysk.local) ... 708c5bf76388b92e (240464@biysk.local) [exec at: 20.03.2019 23:40:07, exec time: 155ms, nodes: sip1@ecss2]
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 - полный вывод;
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 = blf 240475 240475 : seizure : [Calling = home475:240475, Called = undefined:419145] 240475 : active : [Calling = home475:240475, Called = undefined:419145] 240475 : release : [Calling = home475:240475, Called = undefined:419145] 240475 : seizure : [Calling = home475:240475, Called = undefined:240471] 240475 : alerting : [Calling = home475:240475, Called = undefined:240471] 240475 : release : [Calling = home475:240475, Called = undefined:240471] Command has been canceled: interrupted
subscription-stop
Команда предназначена для просмотра подписок пользователя.
Путь команды:
/domain/<DOMAIN>/sip/user/subscription-stop
Синтаксис:
subscription <GROUP> <USER_INTERFACE> [--force]
Параметры:
<GROUP> - название группы пользователей. Символ "*" используется для указания всех групп;
<USER_INTERFACE> - название интерфейса или шаблон.
--force - выполнить команду без запроса подтверждения.
Пример:
admin@[mycelium1@ecss1]:/$ domain/biysk.local/sip/user/subscription-stop loc.gr 240101@biysk.local blf [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]