|| DeviceType | Облачный сервис мониторинга и управления конфигурациями "ELTEX" |
|| DocTitleAdditional | Руководство по эксплуатации |
|| DeviceName | ECCM |
|| DocTitleAdditional | Руководство пользователя |
|| fwversion | 0.6 |
|| username | eccm |
|| password | eccm |

Введение

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

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

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

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

Image Removed

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

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

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

Image RemovedImage Added

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

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

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

Image RemovedImage Added

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

Image Modified

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

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

Image Modified

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

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

Image RemovedImage Added

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

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

Группы

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

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

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

Image RemovedImage Added

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

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

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

Image Modified

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

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

Устройства

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

Image Modified

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

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

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

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

Image Added

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

Image Removed

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

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

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

Image RemovedImage Added

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

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

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

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

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

Scroll Pagebreak

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

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

Image RemovedImage Added

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

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

Image Modified

Адаптер

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

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

Image Added

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

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

Image RemovedImage Added

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

Image Modified

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

События

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

Image RemovedImage Added

Задачи

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

Image RemovedImage Added

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

Мониторинг

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

Image RemovedImage Added

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

Типы данных 

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

Image Modified

Временной

...

диапазон выборки

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

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

Image RemovedImage Added

График

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

Image RemovedImage Added

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

ПО

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

Image Removed

Image Added

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

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

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

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

Image Modified

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

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

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

Image RemovedImage Added

Устройства 

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

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

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

Image Removed

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

Image Added

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

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

Image Modified

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

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

Image Modified

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

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

При использованиии

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

Image RemovedImage Added

Применить

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

Image RemovedImage Added

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

Сравнение

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

Image Removed

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

Image Added

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

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

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

Image RemovedImage Removed

Второй способ - на странице управления устройством на Image AddedImage Added

...

...

...

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

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

Image RemovedImage Added

Задачи

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

Image Removed

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

Image Added

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

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

События

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

Image Added

Настройки

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

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

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

Image Added

Доступ

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

Image Added

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

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

Группы

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

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

Image Added

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

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

Image Added

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

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

Image Added