...

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

Введение

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

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

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

...

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

Scroll Pagebreak

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

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

...

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

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

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

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

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

...

Порядок использования фильтров:

• Зайдите на страницу с таблицей. По умолчанию на ней имеется один незаполненный фильтр.
• В карточке фильтра нажмите на поле "Фильтр" и выберите название таблицы для фильтрации.
• Далее выберите операцию в поле "Операция". По умолчанию выбраны операторы CONTAINS или EQ.
• В поле "Значение" введите значение для поиска.
• Нажмите кнопку "Применить фильтр". На странице отобразятся строки, соответствующие искомому значению.
• Для возврата в исходное состояние удалите все имеющиеся фильтры на странице, используя кнопку удаления, и после этого нажмите кнопку "Применить фильтр".

Пример поиска устройств модели ESR-10 со статусом UP и заданной частью IP-адреса:

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

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

...

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

Карты сети

В данном разделе содержится информации о картах сети. Карта сети — это логико-графико-схематическое представление взаимодействия сетевых устройств.

...

1. Инструменты управления картами:
   • Создать — создать новую карту сети.
   • Удалить — удалить выбранные карты из списка.
2. Список карт, доступных в системе. Стоит обратить внимание на следующие столбцы:
   • Название карты.
   • Группа — группа устройств, которые доступны для использования на карте.

Просмотр карты сети

Для просмотра карты сети необходимо кликнуть на ее название в списке. На странице карты отображается кнопка редактирования карты (1) и сама карта сети (2).

Scroll Pagebreak

Элементы карты сети

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

• Узел сети — отображает устройство сети (в качестве имени устройства используется его IP и hostname) и его статус:

  Цвет узла	Статус узла	Описание статуса
  	UP	Устройство доступно
  	OTHER	Устройство ещё не синхронизировано
  	DOWN	Устройство недоступно

  
  

• Связь между узлами — отображает вектор связи между сетевыми устройствами для представления топологии сети (на связи подписаны интерфейсы устройств, через которые они соединены друг с другом).

Создание карты

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

Редактирование карты

Для редактирования карты сети необходимо выбрать карту в разделе "Карты сети", перейти на страницу просмотра карты и нажать кнопку "Редактировать". Откроется редактор карты сети.

Редактор карты сети

Страница для создания новой/редактирования уже существующей карты сети.

...

1. Название — имя создаваемой карты сети.
2. Группа — группа устройств, доступных для использования в редакторе (можно задать только при создании новой карты).
3. Добавить устройство — кнопка, открывающая список устройств из выбранной группы для добавления их на карту.
4. Удалить — кнопка для удаления выбранного устройства с карты.
5. Сохранить — кнопка для сохранения данных карты сети.
6. Вернуться — кнопка для возврата к списку карт сети (без сохранения изменений/создания новой карты).

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

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

...

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

Удаление устройства

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

...

Подтвердите действие:

Добавление связи

Для добавления связи между узлами необходимо, чтобы на карте было 2 устройства и более. Наведите курсор мыши на первый узел устройства:

...

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

Удаление связи

Для удаления связи между узлами сети сделайте клик на связь между узлами:

...

Подтвердите действие удаления связи:

Scroll Pagebreak

Группы

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

...

1. Навигационная цепочка
2. Инструменты управления устройствами:
   • Добавить устройства
   • Переместить — переместить устройство в другую группу
   • Удалить — удалить устройство из системы
   • Заблокировать/Разблокировать — в статусе "Заблокировано" устройство перестает опрашиваться системой, при этом все данные мониторинга и конфигурации устройства, полученные ранее, будут сохранены.
3. Фильтр таблицы устройств
4. Таблица устройств, в которой отображаются данные о состоянии устройств, входящих в выбранную группу. Стоит обратить внимание на следующие столбцы:
   • 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. Кнопки управления:
   • Отменить — закрыть окно без сохранения.
   • Добавить устройства — добавить все устройства, прошедшие валидацию (имеющие статус "ОК"). Не прошедшие валидацию устройства будут проигнорированы.

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

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

...

После завершения выбора устройств нажмите кнопку "Добавить устройства" (5).

Scroll Pagebreak

Устройства

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

...

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

Scroll Pagebreak

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

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

...

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

Scroll Pagebreak

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

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

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

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

...

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

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

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

...

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

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

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

...

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

Доступ

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

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

Scroll Pagebreak

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

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

...

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

Scroll Pagebreak

События

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

Задачи

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

...

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

Мониторинг

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

...

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

Типы данных 

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

Scroll Pagebreak

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

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

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

График

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

...

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

Сравнение

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

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

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

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

...

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

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

ПО

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

...

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

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

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

...

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

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

Устройства 

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

...

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

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

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

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

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

...

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

Применить

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

...

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

Групповое конфигурирование

Раздел для создания и применения шаблонов конфигурации на группу устройств. Интерфейс содержит две вкладки:

• Запуск — для создания задачи применения конфигурации на группу устройств
• Шаблоны — интерфейс создания и управления шаблонами конфигураций

Шаблоны

Интерфейс для создания и редактирования шаблонов конфигурации состоит включает в себя список шаблонов конфигураций (1) и область редактирования шаблона (2).

Создание шаблона

Для создания шаблона укажите его название в соответствующем поле.

...

После этого сохраните изменения, нажав на кнопку Сохранить.

Запуск

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

1. Выбор устройств
2. Выбор шаблона
3. Установка расписания
4. Применить

Выбор устройств

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

Выбор шаблона

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

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

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

...

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

Применить

В интерфейсе резюмируются ранее настроенные параметры расписания, отображаются выбранный шаблон и список устройств.

Scroll Pagebreak

Задачи

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

...

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

Scroll Pagebreak

События

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

Настройки

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

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

Доступ

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

...

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

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

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

...

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

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

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

   
   

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

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

...

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

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

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

...

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

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

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

   
   

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

Роли

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

...

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

Scroll Pagebreak

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

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

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

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

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

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

Лицензия

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

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

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

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

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

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

...

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

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

Раздел предназначен для создания копий (экспорта) списка устройств из системы в файл типа 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

...

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

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

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

...