📘Приложение Д

Мониторинг Мастер-домена КОСКО УПАТС.

содержит информацию по мониторингу копии КОСКО УПАТС из Мастер-домена

Мониторинг Мастер-домена

Осуществляется мониторинг всей копии КОСКО УПАТС, включая все сайты, роли, домены и их текущую назгрузку.

Основные предназначения

• отслеживание достаточности текущих вычислительных ресурсов на сайтах

• отслеживание доступности всех узлов

• сбор необходимых логов по ролям и звонкам

• мониторинг состояния отдельных Ролей

При работе Мониторинга запросы выполняются от WS роли, на которой авторизован пользователь. Таким образом в зависимости от точки авторизации ответы могут отличаться. Например, при авторизации через WS роль Мастер-сайта ответы будут "как видно с мастер-сайта", а при авторизации через WS рабочего сайта ответы будут "как видно с этого рабочего сайта".

Дефолтный пользователь admin и пароль admin.

Web интерфейс приложения Мониторинг

Аутентификация

Для работы в Web интерфейсе управления КОСКО УПАТС необходимо пройти процедуру аутентификации. Для этого в адресной строке браузера необходимо ввести IP-адрес или URL (fqdn) имя Web-сервера для управления.

Web-сервер КОСКО УПАТС обрабатывает все запросы, которые к нему
приходят вне зависимости от URL назначения. Задача системного
администратора только корректно прописать DNS A-записи без
необходимости настройки КОСКО УПАТС.

Рис. 1. Страница аутентификации

Для прохождения процедуры аутентификации необходимо заполнить поля:

Домен Имя Домена, к которому нужно подключиться. Может быть
Мастер доменом или Коммуникационным. После прохождения
процедуры аутентификации можно переключаться между всеми
КД, доступными пользователю
Логин Логин пользователя
Пароль Пароль пользователя

Разные Web-серверы настроены на обслуживание различных доменов
КОСКО УПАТС. Привязка осуществляется в конфигурационном файле. По
умолчанию через Web-сервер можно получить доступ только к тем
доменам, которые обслуживаются на текущем Сайте (Сайте, где работает
текущий Web-сервер).

После нажатия на Войти система проверит корректность введенных данных.

• Если все верно, то откроется Главная страница

• Если в учетных данных найдена ошибка, то появится сообщение об ошибке

В случае 3 - х ошибок аутентификации в течении 1 минуты IP адрес источника будет заблокирован на 3 минуты. Если в эти 3 минуты

попробовать войти снова, то счетчик времени блокировки сбросится на 3 минуты вне зависимости от корректности введенных значений. Блокировка действует на Web-сервере

После успешной аутентификации создается сессия, устанавливается cookie (RCookie) браузера и все запросы идут через эту сессию. Для одновременной работы в двух Доменах или под разными учетными записями необходимо открыть два разных браузера или использовать режим инкогнито для второй сессии

Главная страница

Здесь представлены доступные пользователю приложения - администрирования и ролевые. Набор приложений определяется ролями доступа пользователя в текущем домене. При нажатии на область блока приложения производится его запуск в текущем окне. При необходимости приложение можно открыть в новом окне/вкладке средствами браузера.

У пользователя одновременно может быть открыто любое количество
приложений. В рамках одной сессии браузера все приложения работают под одной
cookie (RCookie). Смена аутентификации в любом окне может привести к
ошибкам сохранения данных в другом.

Общий вид раздела:

Рис. 2. Главная страница администрирования

Логотип КОСКО УПАТС в верхней части страницы является ссылкой, по которой можно перейти в данное окно из любого раздела системы.

В правой верхней части доступна информация о текущем пользователе и активном домене. При нажатии на кнопку откроется раскрывающийся список, можно выбрать любой из доступных пользователю доменов (без дополнительной аутентификации).

Рис. 3. Переключение между доступными доменами

Домены отбираются по правилам совпадения id, login, password текущего
пользователя в доменах системы. Для автоматической работы этой
функции предназначен режим Клонирования пользователя в Мастер домене.

Всякий раз, при выборе нового домена, список разделов главной страницы может изменяться, в зависимости от настроенных в новом домене ролей доступа.

Если пользователю доступен только один текущий домен, то
возможность переключаться между доменами будет заблокирована.

Для завершения сеанса работы и выхода из системы достаточно нажать кнопку в верхней правой части окна.

Рабочее окно Монитора

Рис. 4. Общий вид раздела

Запрос к мониторингу формируется из заполнения полей:

1. Объект. Выбирается из списка доступных объектов

2. Метод. Выбирается из списка доступных методов для выбранного объекта. Если у Объекта один метод, то он выбирается автоматически

3. Дополнительные поля для метода. Большинство полей являются опциональными. Если поле обязательное и не заполнено, то система не позволит получить данные и выдаст ошибку. Примеры дополнительных полей ◦ Сайт ◦ Нода ◦ Сервер

Рис. 5. Пример формирования запроса трассировки звонков и сценариев

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

• JSON

• Список

• Таблица

• Формированная таблица

Формат результата в JSON

Результат запроса выводится в виде структурированной JSON структуры

Рис. 6. Пример JSON структуры, возвращаемой в ответ на запрос по объекту Трассировка
звонков и сценариев

Кнопки и в правом верхнем углу позволяют выстроить результат в формированную JSON структуру или в сплошной текст

В структуру JSON возможно вносить изменения (в любом месте Результата можно кликнуть и

внести текст). Кнопка позволяет "восстановить" структуру - убрать комментарии, незначащие символы, исправить кавычки, встроить объекты JavaScript

Формат результата в списке

Результат запроса выводится в виде массива данных

Рис. 7. Пример Списка, формируемого в ответ на запрос по объекту Трассировка звонков и
сценариев

Кнопки и в правом верхнем углу позволяют развернуть и свернуть сформированный список

Формат результата в таблице

Результат запроса выводится в виде таблицы данных

Рис. 8. Пример Таблицы, формируемой в ответ на запрос по объекту Трассировка звонков и
сценариев

Таблица строится на базе сформированного списка и может содержать объединяющие ячейки в строках и столбцах.

Формат результата в формированной таблице

Результат запроса выводится в виде таблицы данных без объединяющих ячеек. Позволяет copy/paste данные напрямую в другие приложения, работающие с таблицами (например, MS Excel).

Монитор Мастер сайта

Позволяет посмотреть состояние объектов и событий в реальном времени из Мастер- домена.

Состояние системы

Отображает информация по состоянию системы. Единое окно для получения текущего состояния КОСКО УПАТС.

Метод state

Анализирует текущее состояние системы и отображает только проблемные зоны.

Рис. 9. Метод state

Название Описание
Уровень анализа Применяется только в случае отсутствия заполненного поля Ключи.
Возможные значения:

• Нормальный или пусто - общий анализ состояния

• Эвристический - дополнительно проводится анализ на системных настроек

Ключи Список ключей анализа. Полный список можно получить по
запросу Метод keys. Полное описание ключей в Ключи метода
State.

Время ожидания Предельное время выполнения запроса в мс
Возврат всех
ключей

Если Да, то в результате будут выведены все ключи проверки. Если
Нет, то только ключи где были найдены ошибки.

Ключи метода State

Ключ Описание
Уровень анализа = Нормальный
unavailable_sites Недоступные сайты.
unavailable_servers Недоступные серверы.
inactive_nodes Неактивные ноды.
timeout_nodes Таймаут сбора информации с ноды.
current_time Текущее время отличается на нодах.
disk_space Недостаточно места на диске на сервере.
mem_usage Недостаточно свободной оперативной памяти на сервере.
cpu_usage Превышение загрузки CPU.
config_diffs Конфигурация отличается на нодах.
basic_roles_not_found

Отсутствуют базовые роли на сайте.

solution_roles_not_found

Отсутствуют роли необходимые для функционирования solution.

fsync_roles_not_found

Не найдена роль fsync.

mgc_mg_connects Отличается количество подключенных mg к mgc и активных mg.
assembly_diffs Отличается информация о версии продукта (assembly.info) на
нодах.

Ключ Описание
global_sync Отличаются глобальные имена на сайтах.
unavailable_dc_dom
ains

Недоступные домены на нодах.

node_startup Нода запущена менее 60 сек. назад.
role_startup Роль запущена менее 60 сек. назад либо возникла ошибка при
запуске роли.
role_state Состояния незапущенных ролей на нодах.
distributed_apps Не запущенные перетекающие роли на сайте.
unavailable_global_names

Недоступные глобальные имена в рамках ролей на нодах.

roleapps Информация о ролевых приложениях, ошибки установки или
процесс установки.
connects Присутствуют кросссайтовые коннекты между нодами.
certificate Ошибки и предупреждения по SSL сертификатам используемым в
ролях.
Уровень анализа = Эвристический
version_diffs Суммарный hash бинарных файлов (*.beam) приложений
платформы их зависимостей и erlang отличается на серверах.
version_files_diffs Суммарный hash бинарных файлов (*.beam) платформы отличается
на серверах.

Метод node

Выводит полную информацию по указанной ноде.

Название Описание
Нода Название^ Ноды^ в^ формате^ <node_name>@<ip_addr>^ или^ all^ (все^ ноды)^
Уровень анализа Применяется только в случае отсутствия заполненного поля Ключи.
Возможные значения:

• Нормальный или пусто - общий анализ состояния

• Эвристический - дополнительно проводится анализ на системных настроек

Ключи Список ключей анализа. Полный список можно получить по
запросу Метод keys. Полное описание ключей в Ключи метода
Node.

Название Описание
Роли Возвращать только указанные роли в ноде(ах). Список ролей через
разделитель , или ;.

Ключи метода Node

Ключ Описание
Уровень анализа = Нормальный
node Полное имя ноды.
available Доступность ноды (проходит ли вызов метода с ноды сборщика
статистики).
is_open Открытая ли нода.
start_utc Время старта ноды в UTC.
now_utc Текущее время на ноде в UTC.
config_hash Hash конфигурации на ноде.
connected Список подключенных нод.
cpu Показатели загрузки CPU на сервере с нодой.
disk_space Свободное место на диске сервера в KB.
eaddr Адрес на котором поднята нода.
globals_hash Hash глобальных имен зарегистрированных на ноде.
ifaces Интерфейсы на сервере.
mem Показатели загрузки оперативной памяти на сервере с нодой.
parentnode Родительская нода (ServerShell).
roleapps Информация о ролевых приложениях либо false в случае
отсутствия обслуживания на ноде.
roles Список ролей обслуживаемых на ноде.
versions Версия продукта на сервере.
Уровень анализа = Эвристический
sourcecode_hash Суммарный hash бинарных файлов (*.beam) приложений
платформы их зависимостей и erlang на сервере.
sourcecode_data_beam

Суммарный hash бинарных файлов (*.beam) платформы на сервере.

sourcecode_data_all Суммарный hash всех файлов платформы на сервере.

Метод keys

Отображает все ключи, которые доступны в системе для Метод state и Метод node

Название Описание
Режим Выбор между State и Node. Определяет для какого метода
возвращать ключи
Возврат системных
ключей

Определяет необходимость возврата системных ключей. По
умолчанию Нет

Метод sites

Отображает все сайты в системе. В выводе отображается только факт существования сайта в системе, без детализации доступности.

Рис. 10. Метод site

Метод nodes

Отображает все ноды в системе. В выводе отображается только факт существования ноды в системе, без детализации состояния.

Рис. 11. Метод node

Метод roles

Отображает все роли в системе.

Рис. 12. Метод roles

Название Описание
Отображать опции ролей Отображает параметры ролей, указанные в
конфиг-файле.

Доступные опции:

• Не отображать

• Отображать

Метод domains

Отображает все КД в системе, в виде структуры с указанием на каком сайте обслуживается каждый КД.

Рис. 13. Метод domains

Метод version

Отображает информацию по версии системы и всех используемых компонентах.

Рис. 14. Метод version

Сбор лог-файлов

Опрос системы на предмет какие лог-файлы доступны на серверах и сбор необходимых лог-файлов в zip-архив. Операция нагрузочная и может занять продолжительное время.

Метод read

Отображает все доступные лог-файлы по ролевым нодам. Максимальный объем - 500MB до сжатия.

Рис. 15. Метод read

Название Описание
Сайт Фильтр по указанному сайту
Нода Фильтр по указанной ноде

Метод collect

Централизовано осуществляет сбор указанных лог-файлов на серверах системы в соответствии с заданным фильтром.

Затем выгружает на компьютер администратора подготовленный zip-архив, внутри сохранена структура серверных каталогов.

Рис. 16. Метод collect

Название Описание

Нода/Роль/Тип Маска фильтров в соответствии с которой будут собраны лог- файлы. Примеры:

• [email protected]..**/sip/trn - лог trn из папки sip у ноды [email protected]..**

• */sip/trn - логи trn из папки sip со всех нод

• /sip/ - все логи из папки sip со всех нод

• / /cdr - логи cdr из всех папок всех нод

• //* - все логи по всем папкам всех нод

• [email protected]..**/erlang/5 - сборка erlang.log и 5 его предыдущих из ноды [email protected]..**

Сайт Фильтр по сайту

Начало (мин.назад) Время назад в минутах, которое является временем начала сбора логов. По умолчанию 10

Продолжительность

Продолжительность окна сбора логов с момента начала По
умолчанию 10

Трассировка звонков и сценариев

Данный объект предназначен для сбора логов по звонкам и сценариям. Для звонков возможен сбор логов в форматах SVG, PlantUML, zip-архив. Сбор логов осуществляется по любому звонку, последний SIP пакет в котором был менее 10 минут назад. Система автоматически включает в выборку все связанные звонки (правое/левое плечо, переводы и т.д.)

Метод calls

Данные отображаются по всем звонкам (активным и завершенным), в рамках которых за последние 10 минут были SIP пакеты. Это основной метод получения информации по звонкам от системы, вне зависимости от того, был звонок успешным (разговор абонента А с абонентом B состоялся) или неуспешным.

Рис. 17. Метод calls

В ответе выводятся данные по каждой ноде, которая обслуживает звонок. Основные ключи Результата:

Название Описание
srvidx Идентификатор роли (roleid).
role Тип роли.
node Нода на которой запущена роль.
addr Адрес ноды.
online Доступность ноды для сбора статистики.
calls Плечи звонков обслуживаемые ролью.
calls.callid callid стороны А. Поле часто используется для последующего
сбора логов по звонку.
calls.from uri стороны А

Название Описание
calls.remoteip Адрес стороны Б.
calls.tick Timestamp (в мс) получения запроса.
calls.time Время получения запроса.
calls.to uri стороны Б.
calls.media Данные об использовании медиа.
calls.media.mgc Ключ роли mgc обслуживающей стороны звонка
calls.media.mgc_srvidx

Идентификатор роли (roleid) mgc.

calls.media.mgc_node

Нода mgc.

calls.media.mg Ключ используемой роли mg.
calls.media.msid Идентификатор sip-владельца медиа.
calls.media.ctx Номер контекста.

Метод clear

Очистка таблиц звонков.

Используется для очистки таблиц перед совершением тестового звонка. Помогает быстро делать последующую выборку интересующего CallID из Метод calls

Метод closure

Отображение всех связанных CallID и ролей обслуживания с целевым.

Название Описание
callid Callid по которому происходит поиск соответствий
Список callID Список^ Callid^ по^ которому^ происходит^ поиск^ соответствий^ (через^ ,^ )^

Целевые показатели в ответе:

srvidx Идентификатор роли (roleid).
role Тип роли.
node Нода на которой запущена роль.
addr Адрес ноды.
online Доступность ноды для сбора статистики.
closure Список связанных callid в рамках роли.

Метод closure_total

Поиск связанных callid по всем sip-ролям системы, сгруппированные в один список

Название Описание
callid callid по которому происходит поиск соответствий
callids Список callid по которому происходит поиск соответствий
Сайт Фильтр по указанному сайту
Сервер Фильтр по указанной роли. Возможные значения:

• Id роли (целое число). Например, server=** Адрес на котором поднята роль. Например, server=192.168.*.**

• Полное имя ролевой ноды (RoleNodeName@IpAddr). Например, [email protected].*.**

• Имя ролевой ноды (RoleNodeName). Например, server=ws1

Серверы Фильтр^ по^ указанным^ ролям.^ Возможные^ значения^ -^ *^ Id^ ролей
(целое число). Например, server=32,33,34

Метод trn

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

• zip-архив

• визуальную диаграмму uml (SVG файл)

• uml файл (plantUml файл)

Рис. 18. Метод trn

Название Описание

Сallid для сбора логов

callid по которому происходит поиск соответствий trn

Список CallID для которых собрать логи

список callid по которому происходит поиск соответствий и сбор
trn-логов всех звонков

Формат ответа • SVG диаграмма – страница содержащая plantuml диаграмма в формате svg

• файл в формате plantuml - текстовый файл формата UML для дальнейшейго построения диаграммы

• zip-архив trn логов - сбор файлов лога, упаковка в zip-архив и загрузка в браузер

На SVG диаграмме при нажатии на время пакета отображается текст SIP-
пакета.

Метод trn_sec

Возвращает zip-архив содержащий TRN-логи по указанному CallId или списку со всех SIP ролей за последние N секунд.

Рис. 19. Метод trn_sec

Название Описание
Глубина сбора trn-
логов(сек)

Целое число секунд. Возможные значения: от 0 до 3600. По
умолчанию: 0
Сallid для сбора
логов

callid по которому происходит поиск соответствий trn

Список CallID для
которых собрать
логи

список callid по которому происходит поиск соответствий и сбор
trn-логов всех звонков

Метод scripts

Сбор логов по сценариям указанного типа с ролей на текущем сайте.

Рис. 20. Метод scripts

Название Описание

Тип сценария Тип сценария по которому необходимо собрать логи. Возможные значения:

• IVR - сбор логов по IVR сценариям

• SVC - сбор логов по SVC сценариям

Начало (мин. назад)

С какого момента начать сбор логов (количество минут в прошлое
от текущего момента)

Продолжительность

Продолжительность лога для сборки в минутах. Возможные
значения от 1 до 1440

Код сценария Код сценария по которому необходимо собрать логи. Если не указан, то сбор по всем сценариям указанного типа

Моделирование маршрутизации

Данный объект предназначен для моделирования маршрутизации звонка с использованием заданных параметров, без осуществления самого звонка.

Метод apply

Отображает все проверенные маршруты и причины, почему правило не было использовано. Итоговый результат звонка идет в последней строке вывода.

Рис. 21. Метод apply

Название Описание

Направление источника

Направление источника звонка. Возможен выбор источника
звонка из 2-х вариантов:

• Внутренний абонент - инициатор звонка является абонентом домена КОСКО УПАТС

• Внешняя линия - звонок пришел в КОСКО УПАТС через Оператора SIP телефонии

КД источника звонка

Коммуникационный домен, из которого инициирован звонок

Номер источника Имя пользователя (логин) или номер источника звонка (абонента А).

• Для Направление источника = Внутренний абонент система определит sipuser, кто инициировал звонок.

• Для Направление источника = Внешняя линия, система возьмет за номер источника, который пришел в INVITE.

Набранный номер Номер, вызываемый абонентом-инициатором звонка (абонентом А)

Код оператора SIP Для Направление источника = Внешняя линия указывается код Оператора SIP телефонии, откуда пришел звонок

Моделирование нормализации номеров внешних линий

Данный объект позволяет моделировать работу правил модификации внешних линий (нормализация CalledNum, CallerNum при звонках через SIP-операторов).

Метод apply

Отображает все правила модификации, которые были применены при звонке. Итоговый результат нормализации идет в последней строке вывода.

Рис. 22. Метод apply

Название Описание

Домен моделирования

Домен по которому необходимо посмотреть правила
нормализации.

Направление источника

Выбор источника звонка из 2 - х вариантов:

• Внутренний абонент - инициатор звонка является абонентом домена КОСКО УПАТС

• Внешняя линия - звонок пришел в КОСКО УПАТС через Оператора SIP телефонии

КД источника Домен, в котором инициирован звонок.

Номер источника Имя пользователя (логин) или номер источника (абонента А).

• Для Направление источника = Внутренний абонент система определит sipuser, кто инициировал звонок.

• Для Направление источника = Внешняя линия, система возьмет за номер источника, который пришел в INVITE.

КД получателя Домен, в который направлен звонок

Номер получателя Номер, вызываемый абонентом А

Идентификатор оператора SIP

Необходимо указать код Оператора SIP телефонии (провайдера),
откуда пришел звонок.

Моделирование нормализации звонков между доменами

Данный объект позволяет моделировать работу правил нормализации Номера А при звонках между абонентами разных доменов.

Метод apply

Отображает все правила модификации, которые были применены при звонке. Итоговый результат нормализации идет в последней строке вывода.

Рис. 23. Метод apply

Название Описание
КД источника
звонка

Домен, в котором инициирован звонок.

Название Описание

SIP логин источника звонка

Имя пользователя (логин) или номер источника (абонента А).

КД получателя Домен, в который направлен звонок

Номер получателя Имя пользователя или номер в КД получателя, на которого будет отправлен вызов

Активные абоненты доменов

Данный объект отображает статистику по ролям с типом States (поддержка состояний объектов и пользователей).

Метод currentload

Отображает учетные записи SIP, которые в данный момент зарегистрированы в запрашиваемом КД. Отображает состояние зарегистрированных учетных записей SIP.

Рис. 24. Метод currentload

Название Описание
Модификатор Режим отображения. Возможные значения:

• active - текущие состояния объектов в домене. По умолчанию

• count - количество резервированных состояний.

Название домена Домен, в котором будет выполнен запрос.

Применяется если вход выполнен в Мастер-Домене, а получить
данные надо по-одному из рабочих КД.

Основные поля в ответе:

username - имя пользователя учетной записи SIP state - текущее состояние учетной записи SIP

Метод details

Отображает информацию по одному пользователю.

Рис. 25. Метод details

Название Описание
Название Домена Домен, в котором будет выполнен запрос
Номер или Логин
абонента

Номер или логин, по которому необходимо получить данные

Активные регистрации SIP устройств

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

Метод active

Отображает учетные записи SIP, которые в данный момент зарегистрированы в запрашиваемом КД.

Рис. 26. Метод active

Название Описание
Название Домена Домен, в котором будет выполнен запрос.

Применяется если произведен вход в Мастер-Домен, а сбросить
регистрацию надо в каком-то дочернем КД.

Либо если вход в КД, а получить данные надо по одному из его
дочерних КД.

Основные поля в ответе:

• username - имя пользователя учетной записи SIP

• addr - IP-адрес SIP-клиента, если SIP-клиент за NAT, то отображается локальный внутренний адрес.

• expires - время до момента перерегистрации

• path.domain - IP-адрес SG

• path.port - порт назначения, который использует SG для приема пакетов

• path.proto - внутренний транспортный протокол между SG и B2BUA, всегда = TCP

• path.user - внутренний идентификатор учетной записи SIP

• port - исходящий порт, с которого SIP-клиент отправляет пакеты

• proto - транспортный протокол, используемый между SIP-клиентом и SG

Метод unregistered

Позволяет отобразить все незарегистрированные учетные записи по КД.

Если в запросе не указан desttd, то domain = домен,в котором делается запрос. Если desttd указан, то значение подставляется в поле domain

Рис. 27. Метод unregistered

Название Описание
Название Домена Домен, в котором будет выполнен запрос. Применяется если вход в
Мастер-Домен, а сбросить регистрацию надо в каком-то дочернем
КД.

Основные поля в ответе:

• sipusers: username - имя пользователя учетной записи, которая в данный момент не зарегистрирована в КД.

Метод count

Отображает количество всех зарегистрированных учетных записей у запрашиваемого КД и всех его дочерних доменов.

Рис. 28. Метод count

Название Описание
Название Домена Домен, в котором будет выполнен запрос. Применяется если вход в
Мастер-Домен, а сбросить регистрацию надо в каком-то дочернем
КД.

Основные поля в ответе:

• total - общее количество зарегистрированных учетных записей SIP

• domains - распределение регистраций по доменам

Метод delete

Позволяет удалить все регистрации конкретной учетной записи SIP user@domain или определенные регистрации пользователя udp:192.168..:**** у user@domain

Если в запросе не указан desttd, то domain = домен,в котором делается запрос. Если desttd указан, то значение подставляется в поле domain

Рис. 29. Метод delete

Название Описание

Название Домена (^) Домен, в котором будет выполнен запрос. Применяется если произведен вход в Мастер-Домен, а сбросить регистрацию надо в каком-то дочернем КД. SIP Login Имя^ пользователя^ учетной^ записи^ SIP,^ у^ которой^ необходимо^ сбросить регистрацию Контакты Указывается в формате proto:IP:Port если надо сбросить определенную регистрацию (-ии) у пользователя. Возможно указать несколько через запятую. Пример udp:192.168..:50**,tcp:192.168..:50**

Активные подписи на состояния (BLF)

Данный объект отображает статистику по ролям SUBSCR (подписки на состояния SIP- регистраций, например, для BLF)

Метод currentload

Отображает текущую загрузку объекта.

Рис. 30. Метод currentload

Название Описание
Модификатор Режим отображения. Возможные значения:

• active - текущие подписки на состояния в домене. По умолчанию

• count - количество активных подписок

Название домена Домен, в котором будет выполнен запрос. Применяется если вход
выполнен в Мастер-Домене, а получить данные надо по одному из
рабочих КД.

Применяется если вход выполнен в Мастер-Домене, а получить
данные надо по одному из рабочих КД.

Основные поля в ответе:

• username - имя пользователя учетной записи SIP, на кого оформлена подписка

• expires - таймер обновления подписки

• key - кто запросил подписку в формате

<sip:username@domain_name:50**>;callid= ..... @host;addr=host

Активные конференции

Отображение статистики и текущего состояния по серверам конференций.

Метод currentload

Отображает текущую загрузку объекта.

Рис. 31. Метод currentload

Дополнительные параметры:

Название Описание
Модификатора • servers - загрузка с группировкой по серверам. По умолчанию.

• sites - загрузка с группировкой по сайтам.

• total - общая загрузка по системе

Сайт Фильтр по указанному сайту

Название Описание
сервер Фильтр по указанной роли.

• Id роли (целое число). Например, server=**

• Адрес на котором поднята роль. Например, server=192.168.*.**

• Полное имя ролевой ноды (RoleNodeName@IpAddr). Например, [email protected].*.**

• Имя ролевой ноды (RoleNodeName). Например, server=ws1

Серверы Фильтр по указанным ролям.

Id ролей (целое число). Например, server=32,33,34

Основные поля в ответе:

• callcount - текущее количество звонков

• dlgcount - текущее количество диалогов

Метод rooms

Отображает текущие конференц-комнаты в системе. Дополнительных параметров нет.

Рис. 32. Метод room

Основные поля в ответе:

• rooms - список активных конференц-комнат, в которых есть абоненты на момент выполнения запроса в формате

"<sip:conf#conf_ID@Domain_name>"

Метод participants

Отображает участников конференц-комнаты.

Рис. 33. Метод participants

Название Описание
Конференция Номер конференции, по которой выводится информация.

Основные поля в ответе:

• participants - список участников конференции, в формате

Активные сценарии

Данный объект отображает активные сценарии. Также доступен механизм остановки любого доступного сценария.

Метод active

Отображает текущие активные сценарии.

Рис. 34. Метод active

Основные поля в ответе:

• node - нода на которой был запущен скрипт

• result - результат выполнения запроса

• scripts - параметры сценариев: ◦ instc_scrpid - экземпляр владельца pid процесса ◦ instc_id - идентификатор сценария при его запуске ◦ type - тип сценария ◦ code - код сценария ◦ domain - домен в котором запущен сценарий ◦ ownerpid - владелец pid процесса (супервизор) ◦ starttime - время старта сценария

Метод delete

Прекращает работу сценария.

Рис. 35. Метод delete

Название Описание
Нода Имя ноды, где выполняется сценарий (node name)
Тип сценария Тип сценария для удаления. Возможные варианты:

• SVC

• ICR

Идентификатор Идентификатор сценария (Script ID)

Основные поля в ответе:

• pid - идентификатор процесса

• id - идентификатор сценария

Использование лицензий

Отображает информацию о лицензиях

Метод currentload

Отображает текущую загрузку объекта

Рис. 36. Метод currentload

Название Описание
Модификатор • active - статус серверов.

Название домена Имя КД по-которому вывести данные

Название Описание

Показывать используемые лицензии?

Показыать количество использованных лицензий в домене.
Возможные значения:

• Нет

• Да

Показывать исп. лицензии в поддоменах

Показыать количество использованных лицензий в поддоменах.
Возможные значения:

• Нет

• Да

Отображать КД Фильтр по неактивным или незагруженным доменам

Роль MIC

Отображение статистики по системе с основной конфигурационной роли.

Метод currentload

Отображает текущую загрузку объекта

Рис. 37. Метод currentload

Название Описание

Модификатор • active - статус серверов. Отображает список подключенных серверов всех сайтов к ноде MIC мастер-сайта. Это состояние системы в целом с точки зрения инфраструктуры

• cfgerrors - ошибки в файле конфигурации. Отображает результат проверки файла конфигурации. Если в конфиге были обнаружены ошибки или возникли предупреждения по части логики, они будут выведены в результате

• roles - информация о запущенных ролевых нодах. Отображает какие роли на каких нодах

• rolestate - информация о состоянии ролевых нод. Отображает какие ноды на каких серверах, их состояния

• roleerror - информация об ошибках при старте ролей на ролевых нодах

• roleconnects - информация о коннектах между ролевыми нодами

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

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

Тип Фильтр по данным. Отображает только корректные, только не корректные или все данные.

• Активные

• Неактивные

• Все

Роль WS

Отображает информацию о состоянии работы роли WS

Метод banned

Отображает информацию по заблокированным пользователям и управляет текущем состоянием.

Рис. 38. Метод banned

Название Описание
Модификатор • read - отображение заблокированных адресов по системе.

• clear - удаление всех заблокированных адресов

• delete - удаление адреса (ipv4/ipv6) из списка блокированных

IP-адрес блокируемый (удаляемый из блокировки) ip адрес.
Доступен только для delete

Роль SG

Отображение статистики по загрузке ролей SG.

Метод currentload

Отображает текущую загрузку объекта. Учитывается количество SIP-пакетов, обработанных сервером, за конечный промежуток времени.

Рис. 39. Метод currentload

Название Описание
Модификатор active - активные gatekepeer. По умолчанию.
Сайт Фильтр по указанному сайту

Название Описание
Сервер Фильтр по указанной роли.
Возможные значения:

• Id роли (целое число). Например, server=**

• Адрес на котором поднята роль. Например, server=192.168.*.**

• Полное имя ролевой ноды (RoleNodeName@IpAddr). Например, [email protected].*.**

• Имя ролевой ноды (RoleNodeName). Например, server=ws1

Серверы Фильтр по указанным ролям.
Возможные значения: Id ролей (целое число). Например,
server=32,33,34

Основные поля в ответе - счетчики обработанных SIP-пакетов за последние 1 и 20 секунд (общий и по категориям)

• count_all

• INVITE

• NOTIFY

• REGISTER

• SUBSCRIBE

Счетчик count_register учитывает успешные регистрации и неуспешные попытки.

Аномально большое число register/INVITE запросов за короткое время
может быть признаком подбора аккаунтов, попытками взлома SIP
сервера.

Метод sipusers

Отображает информацию по подключенным sip-абонентам по всем серверам SG во всех доменах.

Рис. 40. Метод sipusers

Основные поля в ответе:

• "domain" - КД, в котором заведены учетные записи

• "regs": - успешные SIP-регистрации в формате proto:username@host:port

Метод banned

Отображает информацию по заблокированным абонентам и управляет текущем состоянием. Можно создать новую блокировку, удалить все блокировки или одну конкретную блокировку.

Рис. 41. Метод banned

Название Описание

Модификатор • read - отображение заблокированных адресов по системе.

• create - блокирование IP-адреса на указанное время в сек.

• clear - удаление всех заблокированных адресов

• delete - удаление адреса (ipv4/ipv6) из списка блокированных

IP-адрес блокируемый (удаляемый из блокировки) ip адрес. Доступен только для create и delete

Длительность, секунд

длительность блокировки, в сек.
Доступен только для create

Сайт Фильтр по указанному сайту

Название Описание

Сервер Фильтр по указанной роли. Возможные значения:

• Id роли (целое число). Например, server=**

• Адрес на котором поднята роль. Например, server=192.168.*.**

• Полное имя ролевой ноды (RoleNodeName@IpAddr). Например, [email protected].*.**

• Имя ролевой ноды (RoleNodeName). Например, server=ws*

Серверы Фильтр по указанным ролям. Возможные значения: * Id ролей (целое число). Например, server=32,33,34

Роль ESG

Отображение статистики по ролям ESG: статусы подключения к Операторам SIP телефонии и количество звонков/диалогов через ноды ESG

Метод currentload

Отображает текущую загрузку объекта.

Рис. 42. Метод currentload

Название Описание
Модификатор • servers - загрузка с группировкой по серверам. По умолчанию.

• sites - загрузка с группировкой по сайтам.

• total - общая загрузка по системе

Показывать
регистрации

Если указано, то будет выведена информация по всем операторам SIP
с текущем статусом подключения. Действительно только для servers

Доступные значения:

• Нет

• Да

Сайт Фильтр по указанному сайту
Сервер Фильтр по указанной роли. Возможные значения:

• Id роли (целое число). Например, server=**

• Адрес на котором поднята роль. Например, server=192.168.*.**

• Полное имя ролевой ноды (RoleNodeName@IpAddr). Например, [email protected].*.**

• Имя ролевой ноды (RoleNodeName). Например, server=ws*

Серверы Фильтр по указанным ролям. Возможные значения:

• Id ролей (целое число). Например, server=32,33,34

Основные поля в ответе:

callcount - текущее количество звонков dlgcount - текущее количество диалогов code - код подключения к Оператору SIP телефонии d - КД, в котором работает подключение user - логин подключения либо пусто если транк без регистрации domain - SIP сервер port - порт подключения proto - транспортный протокол addrs - используемый Outbound Proxy-сервер regstate - текущее состояние SIP-подключения к оператору pingstate - текущее состояние проверки доступности

Метод banned

Отображает информацию по заблокированным удаленным узлам и управляет текущем состоянием (создает новую блокировку, очищает все блокировки, удаляет конкретную блокировку)

Рис. 43. Метод banned

Название Описание
Модификатор • read - отображение заблокированных адресов по системе

• create - блокирование IP-адреса на указанное время в сек

• clear - удаление всех заблокированных адресов

• delete - удаление адреса (ipv4/ipv6) из списка блокированных

IP-адрес блокируемый (удаляемый из блокировки) ip адрес.
Доступен только для create и delete

Название Описание

Длительность, секунд

длительность блокировки, в сек.
Доступен только для create

Сайт Фильтр по указанному сайту

Сервер Фильтр по указанной роли. Возможные значения:

• Id роли (целое число). Например, server=**

• Адрес на котором поднята роль. Например, server=192.168.*.**

• Полное имя ролевой ноды (RoleNodeName@IpAddr). Например, [email protected].*.**

• Имя ролевой ноды (RoleNodeName). Например, server=ws*

Серверы Фильтр по указанным ролям. Возможные значения: * Id ролей (целое число). Например, server=32,33,34

Роль B2BUA

Отображение статистики по ролям B2BUA и неудачные попытки регистрации.

Метод currentload

Отображает текущую загрузку объекта.

Рис. 44. Метод currentload

Название Описание
Модификатор • servers - загрузка с группировкой по серверам. По умолчанию.

• sites - загрузка с группировкой по сайтам.

• total - общая загрузка по системе

Название Описание
Сайт Фильтр по указанному сайту
Сервер Фильтр по указанной роли.+ Возможные значения:

• Id роли (целое число). Например, server=**

• Адрес на котором поднята роль. Например, server=192.168.*.**

• Полное имя ролевой ноды (RoleNodeName@IpAddr). Например, [email protected].*.**

• Имя ролевой ноды (RoleNodeName). Например, server=ws*

Серверы Фильтр по указанным ролям.
Возможные значения:

• Id ролей (целое число). Например, server=32,33,34

Основные поля в ответе:

callcount - текущее количество звонков dlgcount - текущее количество диалогов

Метод regerror

Отображает статистику по неудачным попыткам регистрации

Рис. 45. Метод currentload

Название Описание
Интервал, сек Интервал в секундах, за который отображать информацию
Количество Максимальное количество строк в выдаче

Основные поля в ответе:

data - запись о неудачной попытке sip-регистрации в формате

Роль MGC

Отображает статистику по серверам MGC(Media Gate Controller).

Метод currentload

Отображает текущую загрузку объекта - статус для каждого MGC, какими MG он управляет.

Рис. 46. Метод currentload

Название Описание
Модификатор • servers - загрузка с группировкой по серверам. По умолчанию.

• sites - загрузка с группировкой по сайтам.

• total - общая загрузка по системе

Сайт фильтр по указанному сайту

Название Описание
Сервер Фильтр по указанной роли.+ Возможные значения:

• Id роли (целое число). Например, server=**

• Адрес на котором поднята роль. Например, server=192.168.*.**

• Полное имя ролевой ноды (RoleNodeName@IpAddr). Например, [email protected].*.**

• Имя ролевой ноды (RoleNodeName). Например, server=ws*

Серверы Фильтр по указанным ролям.
Возможные значения:

• Id ролей (целое число). Например, server=32,33,34

Основные поля в ответе:

srvidx - идентификатор роли в конфиг-файле node - ролевая нода addr - IP-адрес размещения ноды online - состояние ноды state - режим работы (working/reserved) context_count - количество контекстов term_count - количество терминейшинов mg_available_count - количество mg которые могут подключится mg_connected_count - количество подключенных mg mg_disconnected_count - количество отключенных mg

Роль IVR

Отображение статистики по ролям IVR.

Метод currentload

Отображает текущую загрузку объекта.

Рис. 47. Метод currentload

Название Описание
Модификатор • servers - загрузка с группировкой по серверам. По умолчанию.

• sites - загрузка с группировкой по сайтам.

• total - общая загрузка по системе

Сайт Фильтр по указанному сайту

Название Описание
Сервер Фильтр по указанной роли.+ Возможные значения:

• Id роли (целое число). Например, server=**

• Адрес на котором поднята роль. Например, server=192.168.*.**

• Полное имя ролевой ноды (RoleNodeName@IpAddr). Например, [email protected].*.**

• Имя ролевой ноды (RoleNodeName). Например, server=ws*

Серверы Фильтр по указанным ролям.
Возможные значения:

• Id ролей (целое число). Например, server=32,33,34

Основные поля в ответе:

callcount - текущее количество звонков dlgcount - текущее количество диалогов

Роль FSync (Синхронизация файлов)

Отображение состояния и запуск диагностики роли FSync.

Метод read

Отображает текущее состояние роли FSync

Рис. 48. Метод read

Название Описание
site Фильтр по указанному сайту
node Фильтр по указанной ноде

Метод load

Тестирует корректность работы всех ролей FSync в системе. Генерирует случайные файлы и проверяет, что они распределились по всем серверам системы. Операция нагрузочная и достаточно долгая.

Рис. 49. Метод load

Метод reboot

Перезапускает роль fsync

Рис. 50. Метод reboot

Название Описание

Тип перезагрузки • простой - простой запрос на перезапуск системных процессов.

• нормальный - запрос останавливает роль fsync на ноде, удаляет системные процессы, очищает рабочую папку, и вновь запускает роль.

• полный - удаляет системные процессы, очищает рабочую папку, завершает работу всей ноды.

site Фильтр по указанному сайту

node Фильтр по указанной ноде