ELTEX Cloud Configuration Manager
Руководство по эксплуатации
Версия ПО 1.3.0

Введение

ECCM (ELTEX Cloud Configuration Manager) — это централизованная система управления сетевым оборудованием. Управление системой осуществляется с помощью web-интерфейса, который предоставляет удобные инструменты для настройки системы и сетевого оборудования под нужды пользователя. Данное руководство содержит описание интерфейса пользователя и основных приемов работы с ним.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Персональная страница 

Раздел с информацией о пользовательском аккаунте, отражающий его роль и группы, в которых он состоит:

Группы

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

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

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

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

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

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

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

1. Инструменты управления устройствами:
   • Добавить устройства
   • Переместить — переместить устройство в другую группу
   • Удалить — удалить устройство из системы
   • Заблокировать/Разблокировать — в статусе "Заблокировано" устройство перестает опрашиваться системой, при этом все данные мониторинга и конфигурации устройства, полученные ранее, будут сохранены.
2. Фильтр таблицы устройств.
3. Таблица устройств, в которой отображаются данные о состоянии устройств, входящих в выбранную группу. Стоит обратить внимание на следующие столбцы:
   • IP — IP-адрес устройства. Отображается в виде ссылки, по которой можно перейти на страницу управления устройством.
   • Статус — статус доступности устройства. Проверяется периодическим ICMP-пингом с сервера на устройство. В случае потери 3-х пингов подряд устройство считается недоступным. В этом случае оно будет считаться вышедшим из строя, а его строка подсветится красным цветом.
   • Длительность текущего статуса — время, прошедшее после смены статуса устройства. Высчитывается каждый раз при обновлении таблицы. 
   • Триггеры — отношение сработавших триггеров к общему количеству триггеров.

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

В этом окне можно добавить новые устройства в систему. Каждое устройство отображается в отдельной строке, в которой нужно указать его IP и модель. Система проводит проверку введенных данных и в поле Статус отображает, возможно ли добавить устройство в систему (статус == OK), или есть какие-либо ошибки (например некорректный IP-адрес или недостаток лицензий для выбранной модели).

Элементы интерфейса:

1. IP — поле для указания IP-адреса нового устройства. В это поле можно скопировать список адресов, разделенных пробелом. Они автоматически будут преобразованы в несколько строк.
2. Модель — в этом поле отображается название модели, а в скобках указано количество устройств, которое можно добавить согласно установленной лицензии.
3. Статус — результат проверки введенных данных. Возможные статусы:
   1. OK — проверка прошла успешно, это устройство можно добавить в систему
   2. INVALID_IP — адрес не прошел валидацию: формат некорректен, или есть лишние символы
   3. NO_LICENSE — достигнут лимит количества устройств данной модели в лицензии
   4. DUPLICATE_IP — в системе или в списке устройств на добавление уже есть устройство с указанным IP-адресом
4. Кнопка для удаления устройства из списка
5. Кнопка для добавления дополнительного устройства в список
6. Кнопки управления:
   • Отменить — закрыть окно без сохранения.
   • Добавить устройства — добавить все устройства, прошедшие валидацию (имеющие статус "ОК"). Не прошедшие валидацию устройства будут проигнорированы.

Устройства

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

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

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

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

Интерфейс для работы с отдельным устройством.

Состоит из следующих элементов:

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

Информация об устройстве

На данной странице отображаются собранные инвентарные данные об устройстве:

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

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

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

Элементы управления:

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

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

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

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

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

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

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

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

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

Доступ

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

По умолчанию для доступа к устройству используются глобальные параметры, которые можно изменить в разделе "Настройки" -> "Доступ". Чтобы настроить индивидуальные параметры доступа к устройству, нужно выставить флаг "Индивидуальные". При включении этой опции необходимо задать логины и пароли для доступа к устройству по SSH и SFTP.

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

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

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

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

События

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

Задачи

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

• Статус — текущий статус выполнения задачи.
• Тип — суть задачи.
• Описание — параметры, с которыми задача была запущена.
• Создано в — дата и время создания задачи.
• Запущено в — дата и время запуска задачи в активную работу. Может не совпадать с датой создания, т.к. задача может находиться в очереди обработчика.
• Остановлено в — дата и время завершения работы над задачей. При этом задача может завершиться успешно или не успешно.
• Лог — открыть журнал выполнения задачи из Ansible.

Мониторинг

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

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

Типы данных 

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

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

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

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

График

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

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

ПО

Раздел, позволяющий добавлять, удалять и просматривать прошивки устройств.

В рабочей области расположены следующие элементы:

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

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

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

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

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

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

Устройства 

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

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

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

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

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

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

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

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

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

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

Применить

На данном шаге на экране отображаются все ранее указанные параметры:

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

Сравнение

Раздел для сравнения конфигураций друг с другом. Содержит следующие элементы:

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

Выбор устройства и конфигурации

Для сравнения конфигураций устройств нажмите кнопку "Выберите устройство". Установите флаг напротив необходимого устройства:

Нажмите "Выберите конфигурацию". Установите флаг напротив необходимой конфигурации:

Область для отображения конфигурации

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

Задачи

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

Таблица состоит из следующих полей:

• Статус — текущий статус выполнения задачи.
• Тип — суть задачи.
• Описание — параметры, с которыми задача была запущена.
• Создано в — дата и время создания задачи.
• Запущено в — дата и время запуска задачи в активную работу. Может не совпадать с датой создания, т.к. задача может находиться в очереди обработчика.
• Остановлено в — дата и время завершения работы над задачей. При этом задача может завершиться успешно или не успешно.
• Лог — открыть журнал выполнения задачи из Ansible.
• Подзадачи — задачи для работы над каждым отдельным устройством. При отображении таблицы задач все подзадачи скрыты, и отображается только родительская задача с интегральным статусом. Эта кнопка используется для отображения всех подзадач для групповой операции.

События

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

Настройки

Раздел общих настроек системы. Содержит две вкладки:

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

Доступ

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

Настройки разделены на две группы в зависимости от протокола:

1. SSH и SFTP — используются для управления устройствами и передачи файлов на устройства.  Для настройки доступны логин и пароль.
2. SNMP — используется для мониторинга устройств и получения инвентарных данных. Для настройки доступно read community.

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

Пользователи

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

1. Кнопки добавления и удаления пользователей.

2. Таблица пользователей.

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

Создание новой учетной записи 

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

1. Атрибуты учетной записи (обязательные поля отмечены знаком "*"):
   
   • Логин и пароль — используются для авторизации в системе.
   • Роль — определяет набор привилегий, доступных пользователю в системе.
   • Фамилия, Имя, Отчество — необходимы для идентификации человека, которому принадлежит учетная запись.
   • E-mail — адрес для отправки уведомлений пользователю. 
2. Группы устройств и системных объектов, к которым пользователю будет предоставлен доступ.
3. Кнопки отмены и сохранения.

Добавление групп для пользователя

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

1. Строка навигации — отображает текущую выбранную группу. Именно эта группа будет сохранена в учетную запись пользователя после нажатия кнопки "Добавить".

2. Таблица вложенных групп — позволяет выбрать одну из дочерних групп и перейти дальше по дереву.

   Для возвращения в родительскую группу нужно кликнуть по ее названию в строке навигации.

3. Кнопки отмены и сохранения.

Роли

Интерфейс для управления ролями пользователей системы.

1. Кнопки для добавления и удаления ролей.
2. Таблица ролей.

Предустановленный набор ролей

В систему по умолчанию добавлено три роли:

1. SuperAdmin — роль для управления системой ECCM. Привилегии: управление пользователями, ролями. Управление глобальными настройками доступа к устройствам. А также все возможности, доступные другим ролям.
2. Administrator — роль для специалистов, пользующихся системой для настройки оборудования. Привилегии: управление оборудованием (ввод/вывод устройств в работу, конфигурация, обновление, перезагрузка), управление группами устройств. Также доступны возможности, предоставленные оператору.
3. Operator — роль для осуществления мониторинга работы оборудования. Привилегии: просмотр данных мониторинга (состояние устройств, статистика, аварии, отчеты).

Создание новой роли

1. Название роли.
2. Описание — краткое пояснение, для кого и для чего предназначена роль.
3. Набор привилегий, доступных пользователю в этой роли. Пользователь может применять свои привилегии ко всем устройствам и объектам, которые находятся в его группах.
4. Кнопки отмены и сохранения.

Таблица привилегий

Лицензия

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

1. id — уникальный номер лицензии.
2. Издатель — название компании или имя сотрудника, выпустившего лицензию.
3. Получатель — название организации, приобретающей лицензию.
4. Дата издания — дата генерации лицензии.
5. Дата истечения — дата, после которой лицензия считается недействительной. После наступления этой даты доступ к управлению устройствами будет ограничен.

Описание интерфейса 

1. Инструменты управления лицензиями:
   • Загрузить — загрузить на сервер новый лицензионный файл.
   • Экспортировать — получить файл активной лицензии.
2. Информация об установленной в систему лицензии: основные данные и суммарное количество поддерживаемых моделей устройств, поддерживаемых.
3. Список моделей и количество единиц оборудования каждой модели, которое поддержано в лицензии.

Загрузка новой лицензии

После нажатия кнопки "Загрузить" будет открыто системное окно, в котором нужно выбрать новый файл с лицензией и загрузить его на сервер. После этого ECCM произведет анализ загруженной лицензии и откроет окно для сравнения новой лицензии с активной.

Элементы интерфейса:

1. Название загруженного файла
2. Информация об активной лицензии
3. Информация о новой лицензии
4. Таблица для сравнения количества поддерживаемых устройств 
5. Кнопки для отмены и подтверждения действия.

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

Резервное копирование

Раздел предназначен для создания копий (экспорта) списка устройств из системы в файл типа csv, а также для импорта списков устройств в систему. 

Для экспорта списка устройств нажмите кнопку "Экспорт устройств": файл будет скачан браузером.

Формат файла экспорта/импорта:

GROUP;IP;MODEL
eccm/group1/;172.24.0.8;ESR-1000
eccm/group1/;172.24.0.7;ESR-100
eccm/group1/;172.24.0.6;ESR-20
eccm/group1/;172.24.0.5;ESR-10
eccm/group1/;172.24.0.9;ESR-1200

где:

GROUP — группа, в которой находилось, или куда нужно поместить устройство

IP — IP-адрес устройства

MODEL — модель устройства

В качестве разделителя используется символ точка с запятой ';'.

Импорт устройств

Для импорта устройств нажмите кнопку "Импорт устройств" и выберите подходящий файл для импорта. Файл будет загружен в систему и обработан, после чего откроется диалоговое окно добавления устройств:

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