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

Для подключения к интерфейсу пользователя необходимо ввести в адресной строке браузера ссылку http://<ECCM_ADDRESS>:8080, где <ECCM_ADDRESS> — это адрес сервера ECCM в вашей сети (это может быть IP-адрес или доменное имя, если у вас настроен DNS).

Откроется страница с формой авторизации:

Введите логин eccm и пароль eccm в соответствующие поля и нажмите кнопку Войти. 

Интерфейс системы управления

Пользовательский интерфейс представляет собой одностраничное Web-приложение, которое состоит из нескольких основных частей:

1. Панель навигации по разделам.
2. Счетчики сообщений и системных уведомлений.
3. Данные об учетной записи пользователя.
4. Кнопка для выхода из системы. При нажатии на нее сессия будет разорвана.
5. Рабочая область. В зависимости от выбранного раздела здесь будут представлены различные виджеты.
6. Кнопка сворачивания панели навигации (для расширения рабочей области).

Фильтры в таблицах

Для составления поисковых запросов в таблицах с большим объемом данных используются фильтры, представляющие собой строку, в которую можно ввести выражение для поиска информации. При установке курсора в поле ввода отображается список полей, по которым можно выполнить поиск. Например, фильтр в разделе "Устройства" выглядит следующим образом:

Фильтры поддерживают использование логических операторов OR, AND, группировки выражений с помощью скобок:

При поиске данных по полям с цифровыми значениями можно использовать операторы '==', '>', '<', как указано в строке Фильтр на рисунке выше.

Для строковых значений поддерживается только оператор '==', но имеется возможность заменять неопределенную часть выражения символом '*':

Сводная информация

Здесь расположены виджеты, отображающие данные о состоянии системы:

1. Общая статистика — счетчики, показывающие отношение недоступных устройств к общему количеству устройств в системе, а также отношение сработавших триггеров (преднастроенных порогов, пересечение которых требует особого внимания) к общему количеству устройств. Виджет дает представление об общих проблемах в сети.
2. Статистика недоступных устройств по группам — счетчики недоступных устройств по каждой административной группе. Если группа содержит устройства, к которым был потерян доступ, ее рамка подсвечивается цветом. Если недоступно менее 5% — розовым, если более 5% — красным.
3. Недоступные устройства — список устройств, к которым был потерян доступ. В таблице отображается название устройства (в виде активной ссылки), время потери доступа и длительность этого состояния.
4. Проблемы — список сработавших триггеров. В таблице отображается название устройства, на котором сработал триггер (в виде активной ссылки), название триггера, время его срабатывания и уровень важности.

Виджеты автоматически обновляются каждую минуту. В случае возникновения проблем с доступом на сервер, на странице кэшируются последние данные, и отображается время последнего успешного обновления.

Группы

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

В верхней части страницы отображается навигационная цепочка в стиле "breadcrumbs" (хлебные крошки). Она отображает путь к текущей группе и позволяет выполнить быстрый возврат к любой из родительских групп.

Группы подразделяются на два типа: тип 'DEVICES' для устройств и тип 'GROUPS' для групп. В группе типа 'GROUPS' отображаются вложенные группы, а счетчики отображают суммарную информацию всем группам типа 'DEVICES', входящим в них:

В таблице отображается информация:

1. Имя группы — активная ссылка для перехода в группу.
2. Всего устройств — счетчик суммарного количества устройств в группе или в дочерних группах.
3. Устройства с проблемами — счетчик суммарного количества устройств в группе или в дочерних группах, в которых обнаружены сработавшие триггеры.
4. Недоступные устройства — счетчик суммарного количества устройств в группе или в дочерних группах, к которым был потерян доступ с сервера управления.

В группе типа 'DEVICES' отображается список устройств, принадлежащих этой группе:

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

• IP — адрес устройства. Отображается в виде ссылки, по которой можно перейти на страницу управления устройством.
• Статус — статус доступности устройства, проверяется периодическим ICMP-пингом с сервера на устройство. В случае потери 3х пингов подряд, устройство считается недоступным. В этом случае оно будет считаться вышедшим из строя, а его строка подсветится красным цветом.
• Длительность текущего статуса — время, прошедшее после смены статуса устройства, высчитывается каждый раз при обновлении таблицы. 
• Триггеры — отношение сработавших триггеров к общему количеству триггеров на устройстве.

Устройства

Раздел для представления всех устройств в системе с возможностью фильтровать список устройств по инвентарным данным. 

В таблице отображается информация:

1. ID — порядковый номер устройства в системе управления, присваивается при добавлении устройства в систему. Нумерация начинается от 100, каждый номер уникален и не может быть использован повторно.
2. Серийный номер — комбинация цифр и букв, которая вычитывается с устройства по SNMP и хранится в базе данных.
3. IP — IP-адрес устройства в сети управления устройствами (каждое устройство имеет уникальный IP-адрес). Отображается в виде ссылки, по которой можно перейти на страницу управления устройством.
4. Hostname — имя хоста, вычитывается с устройства по SNMP и хранится в базе данных.
5. MAC — MAC-адрес устройства, вычитывается с устройства по SNMP и хранится в базе данных.
6. Серия — название модельного ряда, вычитывается с устройства по SNMP и хранится в базе данных.
7. Модель — название модели, вычитывается с устройства по SNMP и хранится в базе данных.
8. Версия — номер прошивки, установленной на устройстве, вычитывается с устройства по SNMP и хранится в базе данных.
9. Статус — статус доступности устройства, проверяется периодическим ICMP-пингом с сервера на устройство.

Страница устройства

Интерфейс для работы с отдельным устройством. Состоит из следующих элементов:

1. Заголовок — содержит название устройства и его IP-адрес
2. Меню со вкладками: 
   • Конфигурация
   • Адаптер
   • Обновление ПО
   • События
   • Задачи
   • Мониторинг
3. Блок функций 1
4. Таблица конфигураций
5. Редактор конфигураций/Функционал для управления конфигурацией устройства
6. Блок функций 2

Конфигурация

Функционал для управления конфигурацией устройства. Элементы управления:

1. Блок функций 1:
   1. Перезагрузить — отправка команды для перезагрузки устройства.
   2. Синхронизировать — вычитывание текущей конфигурации с устройства. Если она не будет совпадать с RUNNING конфигурацией, она будет сохранена в системе как новая конфигурация.
   3. Сравнение — переход к сравнению двух выбранных конфигураций. Для перехода требуется выбрать (отметить галочками) две конфигурации из списка.
2. Блок функций 2:
   1. Редактировать — открытие редактора конфигурации.
   2. Скачать — получить выбранную конфигурацию в виде текстового файла.
   3. Применить — применить выбранную конфигурацию на устройство.
3. Таблица конфигураций — отображается список имеющихся конфигураций для устройства. 
4. Превью конфигурации — панель для отображения выбранной конфигурации (выбор производится по клику на строке конфигурации (не по галочке))

Типы конфигураций

RUNNING — последняя полученная с устройства конфигурация.

DRAFT — конфигурация, подготовленная для применения на устройство.

BACKUP — резервная копия конфигурации с устройства перед применением новой конфигурации. В случае изменения текущей конфигурации, новая получает тип RUNNING, а устаревшая — BACKUP.

Редактор конфигурации

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

1. Аннотация — комментарий к конфигурации. Указывается при создании новой конфигурации, после этого изменить аннотацию нельзя.
2. Область редактирования — текстовый редактор, позволяющий работать с большим объемом информации и обеспечивающий подсветку синтаксиса и внесенных изменений.
3. Кнопки управления:
   1. Отменить — закрыть окно без сохранения.
   2. Сохранить — сохранить изменения, создав новую конфигурацию с типом "Черновик" ("DRAFT").
   3. Сохранить и применить — сохранить новую конфигурацию как черновик и сразу же попытаться применить ее на устройство.

Редактор предоставляет инструменты для поиска по всей конфигурации. Для того, чтобы воспользоваться им, нужно установить курсор в область редактирования и нажать сочетание клавиш Сtrl+F:

Адаптер

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

Обновление ПО

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

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

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

События

Отображет список событий, произошедших с этим устройством. Важные события, сообщающие о проблемах обозначаются красным цветом.

Задачи

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

1. Статус - текущий статус выполнения задачи.
2. Описание - параметры, с которыми задача была запущена.
3. Создано в - дата и время создания задачи.
4. Запущено в - дата и время запуска задачи в активную работу, может не совпадать с датой создания, т.к. задача может находиться в очереди обработчика.
5. Остановлено в - дата и время завершения работы над задачей. При этом задача может завершить успешно и не успешно.
6. Лог - открывает лог выполнения задачи из Ansible.

Мониторинг

Отображение данных мониторинга устройства. 

1. Выбор типа данных
2. Выбор временного диапазоны выборки
3. График 

Типы данных 

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

Временной диапаозн выборки

Позоволяет установить диапазон времени, в котором находятся интересующие нас данные. По умолчанию отображается диапазон с 00:00 текущего дня.

Для выбора даты и времени предусмотрены соответствующие инструменты:

График

В области отображения графика находтся элементы:

1. Временная шкала с превью графика, позволяет указать нужны диапазон времени для отображения из выборки, полученной с сервера.
2. Интерактивная легенда, позволяющая включать и отключать отдальные линии графиков.

ПО

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

1. Таблица прошивок, добавленных в систему.
2. Кнопка для добавления новой прошивки.
3. Кнопка для удаления выбранных прошивок (становится неактиыной, если не выбрано ни одной прошивки).

Добавление новой прошивки

Для добавления новой прошивки перед пользователем открывается диалоговое окно, требующее заполнить несколько полей и указать файл с ПО:

1. Вендор - производитель устройства, для которого загружается прошивка
2. Серия - серия устройств (модельный ряд).
3. Версия - номер прошивки в принятом у вендора формате, для прошивок Eltex это 'X.X.X build X'.
4. Описание - комментарий к загружаемомму файлу.
5. Выберите файл ПО - кнопка для открытия диалога для выбора файла на компьютере пользователя.
6. Отменить - закрыть окно.
7. Загрузить - кнопка для начала загрузки. Неактивна до тех пор, пока не заполнены все требуемые поля.

Обновить группу устройств

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

Устройства 

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

1. Таблица, содержащая список всех устройств данной модели.
2. Таблица выбранных устройств, которые будут обновлены.

Выбор прошивки

На этом шаге нужно выбрать прошивку, на которую будут обновлены выбранные ранее устрйоства:

Установка расписания

Позволяет настроить время начала и завершения выполнения задачи.

Предлагаемые опции:

1. Начать в ближайшее время - поставить задачи в очередь планировщика сразу после создания. Начало выполнения будет зависеть от загруженности планировщика. Снятие этого флага позволяет установить начало окна проведения операции обновления.
2. Не запускать новые подзадачи после указанного времени - позволяет ограничить окно проведения операции обновления, запрещая запуск дополнительных задач. При этом выполненные операции не будут отменены, но устройства, для которых обновление не было запущено останутся без обновления.
3. Стратегия - способ запуска задач:
   1. Параллельно - одновременный запуск задач, задействуя все имеющиеся обработчики.
   2. Последовательно - обновление устройств по порядку, используя один обработчик.

При использованиии "Начать в ближайшее время" и "Не запускать новые подзадачи после указанного времени" отображаются инструменты для выбора даты и времени начала и завершения окна для проведения обновления:

Применить

Экран для создания задачи, отображает все ранее указанные параметры:

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

Сравнение

Раздел для сранения конфигураций друг с другом:

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

Выбор конфигурации

Может быть выполнен двумя способами.

Первый, в разделе "Сравнение" выбрать устройства и их конфигурации с помощью кнопок "Выберите устройство" и "Выберите конфигурацию":

Второй способ - на странице управления устройством на вкладке "Конфигурация" выбрать две конфигурации и нажать кнопку "Сравнить"

Рабочая область

После выбора двух конфигураци, они сопоставляются друг с другом и различия отмечаются цветом:

Задачи

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

1. Статус - текущий статус выполнения задачи.
2. Описание - параметры, с которыми задача была запущена.
3. Создано в - дата и время создания задачи.
4. Запущено в - дата и время запуска задачи в активную работу, может не совпадать с датой создания, т.к. задача может находиться в очереди обработчика.
5. Остановлено в - дата и время завершения работы над задачей. При этом задача может завершить успешно и не успешно.
6. Лог - открывает лог выполнения задачи из Ansible.
7. Подазачи - групповые операции представляют собой задачи, объединяющие несколько задач для работы над каждым отдельным устройством, называемых подзадачами. При отображении таблицы задач все подазадачи скрыты и отображается только родительская задача с интегральным статусом. Эта кнопка используется для отображения всех подзадач для групповой операции.
   
   

События

Отображет список событий, произошедших в системе. Важные события, сообщающие о проблемах обозначаются красным цветом, информационные - заленым.

Настройки

Раздел содержащий настройки системы.

Содержит две вкладки:

1. Доступ
2. Группы

Доступ

Интерфейс для настройки доступа к устройствам, с помощью адапетера. 

1. Выбор настраиваемого адапетера:
   1. ESR Ansible - адаптер применяемый для устройств ESR от Eltex.
   2. Generic - адаптер для устройств других производителей.
2. ssh - логин и пароль для доступа к устройствам по протоколу SSH.
3. sftp - логин и пароль для доступа к устрйоствам по SFTP.
4. кнопки для сохранения и сброса настроек.

Настройки протоколов идентичны для обоих адаптеров.

Группы

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

Для группы типа 'GROUPS' отображатся список групп (3) и инструменты для добавления новой группы (2): 

Чтобы добавить новую группу, необходимо указать ее название и нажать кнопку "Создать"

Для групп типа "DEVICES" отображается список устройств, находящихся в группе (1), кнопка для добавления устройств (2), и кнопка для удаления устройств из группы (3) - при удалении устройства из группы, они все равно остаются в ситеме. 

Добавление устройств в группу

Для обавления устройств у группу открывается отдельная таблица с устройствами (1). В группу можно добавить только те устройства, которые ранее не были добавлены в проекцию (группа верхнего уровня), они отображены белым цветом (2). Устройства, которые уже есть в этой проекции отображаются серым цветом (3) неактивны. Для применения или отвены изменений на странице находятся кнопки управления "Отменить" и "Добавить" (4).