|| 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

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

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

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

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. Проблемы — список сработавших триггеров. В таблице отображается название устройства, на котором сработал триггер (в виде активной ссылки), название триггера, время его срабатывания и уровень важности.

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

Группы

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

...

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

Image RemovedImage Added

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

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

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

Image Modified

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

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

Устройства

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

Image Modified

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

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

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

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

Image Added

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

Image Removed

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

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

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

Image RemovedImage Added

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

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

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

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

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

Scroll Pagebreak

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

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

Image RemovedImage Added

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

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

Image Modified

Адаптер

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

Image RemovedImage 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 Modified

...

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

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

События

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

Image RemovedImage Added

Настройки

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

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

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

Image Added

Доступ

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

Image RemovedImage Added

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

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

Группы

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

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

Image RemovedImage Added

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

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

...

и кнопка для удаления устройств из группы (3)

...

.

Image Added

...

...

Image Removed

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

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

Image RemovedImage Added