ОНЛАЙН КОНСОЛЬ МОНИТОРИНГА УТМ

В клиенте Мониторинга (КМ) начиная с версии 2.0.3-b217 реализовано взаимодействие с УТМ через протокол мгновенных сообщений (XMPP). Данный протокол применен с целью поддержки взаимодействия между пользователем и УТМ:

– в режиме онлайн

– с использованием смартфона

– с применением произвольного клиента мгновенных сообщений

– с группой УТМ

– посредством системы текстовых команд

Данный протокол ориентирован для специалистов, занимающихся поддержкой работоспособности УТМ.

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

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

Протокол XMPP (Jabber) позволяет мгновенно отправлять команды удалённому компьютеру, на котором установлен УТМ и Мониторинг, и оперативно получать на них ответы.

Чтобы отправить команду используя данный протокол необходимо настроить Мониторинг УТМ и установить любой Jabber клиент.

Посмотреть список Jabber клиентов

На данный момент работоспособность функционала протестирована на четырёх клиентах:

Навигация

Автоматическая регистрация
Ручная регистрация
Настройка клиента Мониторинга
Настройка Jabber клиента
Настройка встроенного Jabber клиента
Пример настройки онлайн консоли
Обзор команд
    Остановить службу Transport
    Запустить службу Transport
    Остановить службу Transport-Updater
    Запустить службу Transport-Updater
    Показать состояние УТМ
    Получить лог transport_info.log
    Отправить запрос в ЕГАИС
    Показать информацию о системе
    Показать версию УТМ
    Получить новый отчёт
    Показать текущие значения отчёта
    Рестарт службы Transport
    Рестарт службы Transport-Updater
    Получить лог
    Показать логи
    Перевыпуск сертификата ГОСТ
    Показать информацию о сертификате ГОСТ
    Отображение списка алиасов контейнера ГОСТ аппаратного ключа
    Удаление выбранного алиаса контейнера ГОСТ аппаратного ключа
    Показать информацию о сертификате RSA
    Перевыпуск сертификата RSA
    Запрос наличия обновления УТМ
    Запуск обновления УТМ
    Включить/выключить аппаратный ключ
    Изменить период отправки Мониторинга (мс)
    Получить список команд
    Отправка cfg файла

 

Автоматическая регистрация

 

Начиная с версии 221 клиент мониторинга (Jabber бот) поддерживает функцию авторегистрации на XMPP сервере. Если ранее клиент мониторинга не был настроен, то после обновления с верси 220 до версии 221 или после чистой установки версии 221 и выше - клиент мониторинга (Jabber бот) автоматически зарегистрируется на XMPP сервере с логином, равным fsrar id и случайным паролем. Условия успешной автоматической регистрации:
- должны быть указаны параметры:
 jabber.server=vm10558.vps.agava.net
 jabber.port=5222
 jabber.auto.registration.enable=true
 jabber.domain=
Данные значения являются значениями по умолчанию.
- не должно существовать аккаунта [fsrar id(логин)]@vm10558.vps.agava.net на XMPP сервере

Зарегистрировавшись на XMPP сервере, Jabber бот будет выполнять команды по XMPP протоколу только от пользователей личного кабинета, у которых данный абонент присутствует в списке абонентов http://waybill.me/egais/view/abonents и которые подтвердили (прикрепили) свой xmpp аккаунт.
Данная функция контролируется параметром "jabber.refresh.access.list.from.server.enable", список пользователей записывается в "server.jabber.access.list", а переодичность обновления равна 1 часу.

В соответствии с Правилами ресурса каждому зарегистрированному пользователя личного кабинета и каждому клиенту мониторинга, имеющему уникальный fsrar id предоставляется xmpp (Jabber) аккаунт на сервере vm10558.vps.agava.net:5222, с логинами, соответствующими логинам личных кабинетов и fsrar id, соответственно.

Чтобы начать пользоваться своим XMPP аккаунтом его нужно подтвердить. Для этого достаточно перейти в раздел "Мой профиль" и ввести новый или текущий пароль и нажать "Сохранить". После этого напротив логина личного кабинета появится индикатор: "Есть аккаунт XMPP"

Данный индикатор означает, что у пользователя 999957062730 есть подтверждённый XMPP аккаунт 999957062730@vm10558.vps.agava.net.
Причём после нажатия кнопки сохранить созданный XMPP аккаунт будет иметь тот же пароль, что и аккаунт личного кабинета waybill.me
При первичной регистрации пользователя личного кабинета xmpp аккаунт подтверждается автоматически.

Таким образом, если до подтверждения XMPP аккаунт не существовал, то он создаётся с тем же паролем, что и личный кабинет. Если существовал, то у XMPP аккаунта обновляется только пароль. Список контактов сохранятся.

В итоге, после подтверждения xmpp аккаунта в личном кабинете и после того, как клиент мониторинга обновит список разрешенных пользователей, остаётся нажать на кнопку "Добавить всех моих абонентов в список контактов xmpp" в разделе "мой профиль" и можно отправлять команды клиенту Мониторинга. Проще всего это сделать, перейдя на страницу абонента, выбрав вкладку "Консоль", нажать на "Войти в Jabber чат (XMPP)". Откроется страница:

Необходимо ввести пароль и нажать "Вход". После подключения, поле "логин абонента" будет заполнено автоматически, а также будет отображаться статус в виде зелёного/красного индикатора. Данная форма позволяет отправлять клиенту Мониторинга сообщения и файлы размером до 8 МБ. Теперь можно писать команды в поле ввода сообщений, отправка производится нажатием клавиш клавиатуры CTRL + ENTER или нажатием стрелки справа.

Кнопка "Подписаться на статус (добавить в контакты)" позволяет добавлять абонента в список контактов. Нажатием на кнопку "Показать статус абонента" можно увидеть онлайн статус, отображаемый в виде зелёного/красного индикатора. Кнопка "Мои контакты" - покажет список контактов. Вся служебная информация выводится внизу страницы.

При переустановке службы Мониторинга необходимо сохранить конфигурационные файлы для того, чтобы Jabber бот смог успешно авторизоваться на сервере. В случае если пароль от Jabber бота утерян, то есть возможность изменить пароль XMPP аккаунта. Для этого необходимо перейти на страницу абонента, выбрать вкладку "настройки", а затем в поле "новый пароль xmpp" ввести пароль и нажать кнопку "изменить пароль xmpp".

Внимание! При удалении аккаунта личного кабинета также будет удалён xmpp аккаунт с логином, совпадающем с логином личного кабинета, независимо от того был ли он подтверждён.

Ручная регистрация

 

Для каждого устройства, на котором установлен УТМ и Мониторинг необходимо создать аккаунт на сервере. Помимо этого, необходимо создать один основной XMPP аккаунт, с которого можно будет отправлять сообщения всем клиентам Мониторинга. Т.е. если всего имеется 5 магазинов, то необходимо создать 6 XMPP аккаунтов. Для регистрации XMPP аккаунта необходимо перейти по ссылке. Откроется следующая форма:

Можно придумать любое имя пользователя и пароль, но лучше:

  • Для КМ:

Имя пользователя = fsrar id

  • Для основного аккаунта:

Имя пользователя = ИНН

Рекомендуем записать имя пользователя и пароль – в дальнейшем эти данные нужно будет ввести в Jabber клиент.

 

Настройка клиента Мониторинга УТМ

 

На каждом устройстве, на котором установлен клиент Мониторинга УТМ, необходимо открыть конфигурационный файл monitoring.properties

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

На Windows: C:\UTM\monitoring\updatable\terminal-monitoring-2.0.3-b***\conf

На Linux: \opt\UTM\monitoring\updatable\terminal-monitoring-2.0.3-b***\conf

И заполнить раздел «Settings for jabber client» следующими значениями:

jabber.server=vm10558.vps.agava.net

jabber.port=5222

В поле jabber.login – указать имя пользователя, придуманное при регистрации Jabber аккаунта для КМ.

jabber.password – указать пароль, придуманный при регистрации Jabber аккаунта для КМ.

jabber.access.list – указать имя пользователя, придуманное при регистрации основного Jabber аккаунта. В этом поле указывается имя пользователя, которому будет разрешено отправлять команды данному устройству. Другие пользователи не смогут управлять клиентом Мониторинга. Разрешено вводить до 10 записей, разделяя каждую пробелом.

Затем необходимо перезапустить службу Мониторинга.

При успешной настройки в логах \\UTM\monitoring\l\monitoring.log будет запись:

DEBUG es.programador.c.a.a.a - Вход Jabber бота под ником magazin-1 с паролем 123456

 

Настройка Jabber клиента

 

В Jabber клиенте необходимо добавить учётную запись типа XMPP или Jabber. Для логина указать имя пользователя, придуманное при регистрации основного Jabber аккаунта.

Сервер – vm10558.vps.agava.net

Порт – 5222

После добавления учётной записи её статус должен быть онлайн. Затем в список контактов необходимо добавить контакты, созданные при регистрации Jabber аккаунта для КМ.

 

Настройка встроенного Jabber клиента

 

Встроенный Jabber клиент доступен в личном кабинете Мониторинга. Клиент появляется при открытии любой страницы абонента и позволяет управлять клиентом Мониторинга в режиме Онлайн. Ниже описан порядок действий для настройки Jabber клиента.

Рассмотрим пример настройки для одного магазина.

1. Переходим по ссылке и создаём аккаунт для клиента Мониторинга (который установлен на устройстве в магазине):

Например, имя пользователя – magazin-1

Пароль – 123456

2. Создаём основной аккаунт (аккаунт администратора):

Например, имя пользователя – admin-magazina

3. В конфигурационном файле monitoring.properties прописываем следующие значения:

###############################################
# Settings for jabber client
###############################################
jabber.server=vm10558.vps.agava.net
jabber.port=5222
jabber.login=magazin-1
jabber.password=123456
jabber.access.list=admin-magazina

4. Перезапускаем службу Мониторинга.

5. Для открытия Jabber клиента необходимо перейти в раздел Мои абоненты и открыть страницу любого абонента. Справа внизу экрана отобразится Jabber клиент.

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

7. Во вкладке "Вход" вводим учётные данные основного аккаунта (аккаунта администратора). В поле "XMPP Username" вводим - admin-magazina. Разрешено вводить логин как в формате - "login@domain", например "admin@host888.com", так и в формате "login" без домена, если аккаунт зарегистрирован на vm10558.vps.agava.net, как на скриншоте ниже:

8. После успешного входа мессенджер имеет следующий вид:

9. Добавим абонента (Клиент мониторинга, который установлен в магазине) в список контактов. Для этого необходимо нажать на кнопку "Добавить контакт" и ввести логин в формате "login@domain". В данном примере вводим: magazin‑1@vm10558.vps.agava.net и нажимаем "Добавить".

10. Список контактов будет выглядеть следующим образом:

11. При нажатии на контакт откроется окно чата, в которое можно вводить команды клиенту Мониторинга. Посмотреть список команд

12. Внимание! При выходе из личного кабинета Мониторинга встроенный Jabber клиент остаётся залогининым. Если требуется выйти из аккаунта - необходимо нажать на выбор статуса и нажать "выйти".

Пример настройки онлайн консоли

 

Рассмотрим пример настройки онлайн консоли для одного магазина. В качестве Jabber клиента используется приложение IM+ для Android. При регистрации были созданы 2 аккаунта:

Для клиента Мониторинга (который установлен на устройстве в магазине):

Имя пользователя – magazin-1

Для основного аккаунта:

Имя пользователя – admin-magazina

В конфигурационном файле monitoring.properties прописаны следующие значения:

###############################################

# Settings for jabber client

###############################################

jabber.server=vm10558.vps.agava.net

jabber.port=5222

jabber.login=magazin-1

jabber.password=123456

jabber.access.list=admin-magazina

Перезапускаем службу Мониторинга.

Открываем приложение IM+

Нажимаем «уч.записи»

Выбираем Jabber

В качестве логина указываем имя пользователя, придуманное при регистрации основного Jabber аккаунта. В примере это – admin-magazina. Заполняем пароль.

В поле сервер указываем – vm10558.vps.agava.net

В поле порт – 5222

Приоритет и ресурс можно оставить по умолчанию.

Нажимаем «Сохранить и подключится»

Если всё указано верно, то откроется следующее окно:

Теперь нужно добавить в список контактов пользователя, придуманного при регистрации Jabber аккаунта для КМ. В приеме это – magazin-1

Для этого нужно нажать на значок

Откроется следующая форма:

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

В поле ID контакта необходимо указать – magazin-1@vm10558.vps.agava.net

Нажимаем «Добавить контакт»

Видим, что в списке контактов появился наш контакт, который является клиентом Мониторинга.

Теперь можем отправлять команды. Для этого нажимаем на строку:

Откроется чат, в котором можно отправлять команды клиенту Мониторинга:

 

Обзор команд

 

Актуальное описание команд доступно в разделе помощь –> консоль


Остановить службу Transport

utm stop

Команда останавливает службу Transport (На Linux – UTM).

Запустить службу Transport

utm start

Команда запускает службу Transport (На Linux – UTM).

Остановить службу Transport-Updater

upd stop

Команда останавливает службу Transport-Updater (На Linux – Updater).

Запустить службу Transport-Updater

upd start

Команда запускает службу Transport-Updater (На Linux – Updater).

Показать состояние УТМ

utm

Команда показывает состояние УТМ, его версию, сроки действия сертификатов, наличие ошибок.

Получить лог transport_info.log

utm log

Команда позволяет скачать transport_info.log с удалённого компьютера.

По умолчанию отправляются последние 10000 строк текста. На сервере хранится последний полученный файл transport_info.log. Т.к. скачать файл по ссылке можно с любого устройства, то необязательно пересылать кому-либо весь лог файл, а достаточно скопировать только одну ссылку.

Отправить запрос в ЕГАИС

utm trace

Команда отправляет в ЕГАИС запрос справочника организации (QueryClients_v2). Запрос выполняется по СИО, в котором указан fsrar id абонента, выполняющего данную команду. Такой запрос позволит проверить работоспособность УТМ, а провести анализ документооборота можно с помощью команды "log tra 10 UUID" или "prlog tra 10 UUID". В примере UUID = 81abea57-cbb4-4554-bb2f-4835104dd754

Показать информацию о системе.

sys

Команда показывает основную информацию о системе: загрузку процессора, свободное место на жёстком диске (%), свободную оперативную память (%), mac адрес и версию операционной системы.

Показать версию УТМ

ver

Команда показывает версию Мониторинга, версию УТМ и версию апдэйтера.

Получить новый отчёт

report

Отправить с удалённого компьютера внеочередной отчёт, не дожидаясь окончания текущего периода

Показать текущие значения отчёта

status

Команда показывает текущие значения параметров в передаваемом отчёте

Рестарт службы Transport

restarttra

Команда перезапускает службу Transport (На Linux – UTM). На удалённом компьютере останавливается служба Transport. Затем через 15 секунд служба Transport снова запускается.

Рестарт службы Transport-Updater

restartupd

Команда перезапускает службу Transport-Updater (На Linux – Updater), например, для того, чтобы принудительно проверить и скачать обновления, если они есть, с серверов обновления УТМ. На удалённом компьютере служба Transport-Updater сначала останавливается, затем через 15 секунд вновь запускается. В случае успешного запуска - служба Transport продолжает работать.

Получить лог

log

Формат команды: log [service] [lines] [expression], где

service - [tra, mon, upd] - где tra это служба transport , mon - transport-monitoring, upd - transport-updater. На Linux - tra это служба utm, mon - monitoring, upd - updater. Обязательный параметр

lines - число отправляемых строк. По умолчанию = "10000".

expression - слово, по которому будет произведен поиск строк лог файла. По умолчанию = "". Разрешено вводить только одно слово без пробелов.

Команда позволяет скачать логи УТМ - transport_info.log, update.log, monitoring.log с удалённого компьютера. По умолчанию отправляются последние 10000 строк текста. Например, "log upd" Запросить иное число строк можно дописав соответствующее значение после названия службы через пробел, например: "log tra 50".

На сервере сохраняется только 1 последний запрошенный лог файл для каждого из сервисов. Т.е. 1 файл transport_info.log, 1 файл update.log, 1 файл monitoring.log. Всего на сервере 3 файла. Ссылка позволяет скачать файл с любого устройства, т.е., например, такую ссылку можно передать в техподдержку.

Если требуется найти строки, содержащие определённое слово, необходимо обязательно указать число строк в параметре lines и после этого числа через пробел указать одно искомое слово. Например: "log mon 20 error" или "log tra 10 81abea57-cbb4-4554-bb2f-4835104dd754"

Показать логи

prlog [service] [lines] [expression]

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

Перевыпуск сертификата ГОСТ

Команда запускает процедуру перевыпуска сертификата ГОСТ. На ключевом носителе формируется открытый и закрытый ключ, а запрос на сертификат отправляется в УЦ. Доступны следующие способы перевыпуска:

gost new - перевыпуск с использованием файла cfg_rep.txt из папки ../monitoring/updatable/key-tool/conf

gost new file FILENAME – перевыпуск сертификата с использованием файла из ../monitoring/updatable/i, где FILENAME - имя файла. Перейти к подробному описанию команды "gost new file"

gost new tkn CKA_ID - использовать данные для перевыпуска сертификата из уже имеющегося на ключе файла cfg, где CKA_ID - алиас - название раздела, в котором хранятся сертификаты. Просмотреть список алиасов можно с помощью команды gost list.

Показать информацию о сертификате ГОСТ

gost

Команда показывает краткую информацию о сертификате ГОСТ. Данные считываются из службы transport. Например, чтобы убедиться, был ли перевыпущен сертификат ГОСТ, необходимо сначала перезапустить службу transport, а затем выполнить команду.

Отображение списка алиасов контейнера ГОСТ аппаратного ключа

gost list

Команда возвращает список алиасов CKA_ID в контейнере ГОСТ ключевого носителя.

Удаление выбранного алиаса контейнера ГОСТ аппаратного ключа

gost del CKA_ID

Команда удаляет каталог CKA_ID из контейнера ГОСТ, где CKA_ID - алиас - название раздела, в котором хранятся сертификаты. Просмотреть список алиасов можно с помощью команды gost list.

Показать информацию о сертификате RSA

rsa

Команда позволяет показать краткую информацию о сертификате RSA. Данные считываются из службы transport. Например, чтобы убедиться, был ли перевыпущен сертификат RSA, необходимо сначала перезапустить службу transport, затем выполнить команду.

Перевыпуск сертификата RSA

rsa egais / rsa test

Команда запускает процедуру перевыпуска сертификата RSA. Сертификат формируется на основе КПП, указанного в сертификате ГОСТ, и записывается на аппаратный ключ, заменяя старый. Для функционирования команды должен быть установлен плагин ФСРАР-КРИПТО.

rsa egais - перевыпуск продуктивного сертификата RSA

rsa test - перевыпуск тестового сертификата RSA

Запрос наличия обновления УТМ

update -check

Данная команда проверяет, скачал ли УТМ обновление. Результат выполнения идентичен уведомлению в агенте УТМ о наличии обновления.

Результат выполнения команды:

Ответ апдэйтера на команду [cmd:update -check] : [false] – обновление ещё не скачано УТМ.

Ответ апдэйтера на команду [cmd:update -check] : [true] – обновление доступно для установки.

Запуск обновления УТМ

update -update

Если УТМ скачал обновление и оно доступно для установки, то данная команда запускает процесс обновления. Команда идентична нажатию кнопки «установить обновление» в агенте УТМ.

Результат выполнения команды:

Ответ апдэйтера на команду [cmd:update -update] : [fail] – Обновление не доступно

Ответ апдэйтера на команду [cmd:update -update] : [ok] – УТМ обновлен.

Включить/выключить аппаратный ключ

switch [on|off] [Порядковый номер ключа из списка]

Команда позволяет отобразить информацию о подключённых аппаратных ключах. При наличии резервного аппаратного ключа данная функция позволит удалённо отключить неисправный ключ и включить резервный.

Пример переключения основного ключа на резервный:

switch – показать подключённые аппаратные ключи

switch off 1 – отключить первый ключ из списка выше

switch on 2 – включить второй ключ из списка выше

switch – проверим, что всё сделал правильно

После включения резервного ключа необходимо записать новый RSA сертификат с помощью команды «Перевыпуск сертификата RSA», а затем перезапустить службу transport командой «Рестарт службы Transport».

Изменить период отправки Мониторинга (мс)

delay

Команда позволяет изменить период отправки отчётов. В параметрах указывается время в миллисекундах.

Получить список команд

help

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

Отправка cfg файла

Cfg_rep.txt – файл, содержащий данные для перевыпуска сертификата ГОСТ. Для передачи cfg файла клиенту Мониторинга рекомендуем воспользоваться программой Pidgin.

В Pidgin выбираем нужную запись из списка контактов. В примере – magazin-1@vm10558.vmp.agava.net. Откроется окно чата.

Далее необходимо нажать «Беседа – Отправить файл»

Выбираем нужный файл для отправки и нажимаем «Открыть». Передача файла произойдёт автоматически.

Теперь выбранный файл находится на удалённом компьютере в директории \\UTM\monitoring\updatable\i

Для перевыпуска сертификата ГОСТ, используя переданный файл, необходимо написать команду: "gost new file FILENAME" , где FILENAME – имя переданного файла. В примере – "gost new file cfg_rep.txt"

Последнее редактирование: 13.12.2017