...
A Shared Block | |||||
---|---|---|---|---|---|
| |||||
|
Введение
ECCM (ELTEX Cloud Configuration Manager) — это централизованная система управления сетевым оборудованием. Управление системой осуществляется с помощью web-интерфейса, который предоставляет удобные инструменты для настройки системы и сетевого оборудования под нужды пользователя. Данное руководство содержит описание интерфейса пользователя и основных приемов работы с ним.
Доступ к пользовательскому интерфейсу
Для подключения к интерфейсу пользователя необходимо ввести в адресной строке браузера ссылку http://<ECCM_ADDRESS>:80/, где <ECCM_ADDRESS> — это адрес сервера ECCM в вашей сети (это может быть IP-адрес или доменное имя, если у вас настроен DNS).
...
Введите логин eccm и пароль eccm в соответствующие поля и нажмите кнопку "Войти".
Scroll Pagebreak |
---|
Интерфейс системы управления
Пользовательский интерфейс представляет собой одностраничное web-приложение, которое состоит из нескольких основных частей:
...
- Панель навигации по разделам.
- Счетчики сообщений и системных уведомлений.
- Данные об учетной записи пользователя.
- Кнопка для выхода из системы. При нажатии на нее сессия будет разорвана.
- Рабочая область. В зависимости от выбранного раздела здесь будут представлены различные виджеты.
- Кнопка сворачивания панели навигации (для расширения рабочей области).
Фильтры в таблицах
Для составления поисковых запросов в таблицах с большим объемом данных используются фильтры, представляющие собой строку, в которую можно ввести выражение для поиска информации. При установке курсора в поле ввода отображается список полей, по которым можно выполнить поиск. Например, фильтр в разделе "Устройства" выглядит следующим образом:
...
Для строковых значений поддерживается только оператор '==', но имеется возможность заменять неопределенную часть выражения символом '*':
Scroll Pagebreak |
---|
Сводная информация
Здесь расположены виджеты, отображающие данные о состоянии системы:
...
Виджеты автоматически обновляются каждую минуту. В случае возникновения проблем с доступом на сервер на странице кэшируются последние данные, и отображается время последнего успешного обновления.
Scroll Pagebreak |
---|
Персональная страница
Раздел с информацией о пользовательском аккаунте, отражающий его роль и группы, в которых он состоит:
Группы
Раздел для представления информации об устройствах системы, разделенных на административные группы. Позволяет добавлять и удалять группы и устройства в системе.
...
- Инструменты управления устройствами:
- Добавить устройства
- Переместить — переместить устройство в другую группу
- Удалить — удалить устройство из системы
- Заблокировать/Разблокировать — в статусе "Заблокировано" устройство перестает опрашиваться системой, при этом все данные мониторинга и конфигурации устройства, полученные ранее, будут сохранены.
- Фильтр таблицы устройств.
- Таблица устройств, в которой отображаются данные о состоянии устройств, входящих в выбранную группу. Стоит обратить внимание на следующие столбцы:
- IP — IP-адрес устройства. Отображается в виде ссылки, по которой можно перейти на страницу управления устройством.
- Статус — статус доступности устройства. Проверяется периодическим ICMP-пингом с сервера на устройство. В случае потери 3-х пингов подряд устройство считается недоступным. В этом случае оно будет считаться вышедшим из строя, а его строка подсветится красным цветом.
- Длительность текущего статуса — время, прошедшее после смены статуса устройства. Высчитывается каждый раз при обновлении таблицы.
- Триггеры — отношение сработавших триггеров к общему количеству триггеров.
Scroll Pagebreak |
---|
Добавление устройств
В этом окне можно добавить новые устройства в систему. Каждое устройство отображается в отдельной строке, в которой нужно указать его IP и модель. Система проводит проверку введенных данных и в поле Статус отображает, возможно ли добавить устройство в систему (статус == OK), или есть какие-либо ошибки (например некорректный IP-адрес или недостаток лицензий для выбранной модели).
...
- IP — поле для указания IP-адреса нового устройства. В это поле можно скопировать список адресов, разделенных пробелом. Они автоматически будут преобразованы в несколько строк.
- Модель — в этом поле отображается название модели, а в скобках указано количество устройств, которое можно добавить согласно установленной лицензии.
- Статус — результат проверки введенных данных. Возможные статусы:
- OK — проверка прошла успешно, это устройство можно добавить в систему
- INVALID_IP — адрес не прошел валидацию: формат некорректен, или есть лишние символы
- NO_LICENSE — достигнут лимит количества устройств данной модели в лицензии
- DUPLICATE_IP — в системе или в списке устройств на добавление уже есть устройство с указанным IP-адресом
- Кнопка для удаления устройства из списка
- Кнопка для добавления дополнительного устройства в список
- Кнопки управления:
- Отменить — закрыть окно без сохранения.
- Добавить устройства — добавить все устройства, прошедшие валидацию (имеющие статус "ОК"). Не прошедшие валидацию устройства будут проигнорированы.
Scroll Pagebreak |
---|
Устройства
Раздел для отображения всех устройств системы с возможностью фильтровать список устройств по инвентарным данным.
...
- ID — порядковый номер устройства в системе управления, присваивается при добавлении устройства в систему. Нумерация начинается от 100, каждый номер уникален и не может быть использован повторно.
- Серийный номер — комбинация цифр и букв, которая вычитывается с устройства по SNMP и хранится в базе данных.
- IP — IP-адрес устройства в сети управления устройствами (каждое устройство имеет уникальный IP-адрес). Отображается в виде ссылки, по которой можно перейти на страницу управления устройством.
- Hostname — имя хоста, вычитывается с устройства по SNMP и хранится в базе данных.
- MAC — MAC-адрес устройства, вычитывается с устройства по SNMP и хранится в базе данных.
- Серия — название модельного ряда, вычитывается с устройства по SNMP и хранится в базе данных.
- Группа — группа, к которой относится устройство.
- Модель — название модели, вычитывается с устройства по SNMP и хранится в базе данных.
- Версия — номер прошивки, установленной на устройстве, вычитывается с устройства по SNMP и хранится в базе данных.
- Статус — статус доступности устройства, проверяется периодическим ICMP-пингом с сервера на устройство.
Scroll Pagebreak |
---|
Страница устройства
Интерфейс для работы с отдельным устройством.
...
- Заголовок — содержит название устройства и его IP-адрес.
- Меню со вкладками:
- Информация об устройстве
- Конфигурация
- Адаптер
- Обновление ПО
- События
- Задачи
- Мониторинг.
Информация об устройстве
На данной странице отображаются собранные инвентарные данные об устройстве:
Конфигурация
Функционал для управления конфигурацией устройства.
...
- Блок функций 1:
- Перезагрузить — отправить команду для перезагрузки устройства.
- Синхронизировать — получить текущую конфигурацию с устройства. Если она не будет совпадать с последней полученной с устройства (RUNNING) конфигурацией, она будет сохранена в системе как новая конфигурация.
- Сравнение — перейти к сравнению двух выбранных конфигураций. Для перехода требуется выбрать (отметить галочками) две конфигурации из списка.
- Блок функций 2:
- Создать черновик / Создать макрос — создать новую пустую конфигурацию.
- Редактировать — открыть редактор конфигурации.
- Скачать — получить выбранную конфигурацию в виде текстового файла.
- Применить / Запустить — применить выбранную конфигурацию на устройство.
- Таблица конфигураций — отобразить список имеющихся конфигураций для устройства.
- Превью конфигурации — панель для отображения выбранной конфигурации (выбор производится по клику на строке конфигурации (не по флажку, расположенному напротив)).
Типы конфигураций
RUNNING — последняя полученная с устройства конфигурация.
...
BACKUP — резервная копия конфигурации с устройства перед применением новой конфигурации. В случае смены текущей конфигурации на новую ей назначается тип BACKUP, а новой — RUNNING.
Редактор конфигурации
Позволяет создать копию (DRAFT) текущей версии конфигурации. При этом существующая конфигурация останется в базе данных и изменена не будет, оставляя возможность вернуться к ней.
...
Редактор предоставляет инструменты для поиска по всей конфигурации. Для того чтобы воспользоваться поиском, нужно установить курсор в область редактирования и нажать сочетание клавиш Сtrl+F:
Доступ
Настройка Ansible-адаптера для выполнения операций на устройстве. Например, для применения конфигурации или перезагрузки.
По умолчанию для доступа к устройству используются глобальные параметры, которые можно изменить в разделе "Настройки" -> "Доступ". Чтобы настроить индивидуальные параметры доступа к устройству, нужно выставить флаг "Индивидуальные". При включении этой опции необходимо задать логины и пароли для доступа к устройству по SSH и SFTP.
Scroll Pagebreak |
---|
Обновление ПО
Интерфейс для обновления прошивки на устройстве. В таблице отображается список ПО, имеющегося на сервере для данного типа устройства (добавление новых прошивок выполняется в разделе ПО). Если на сервере есть прошивка той же версии, которая установлена на устройстве, она будет отмечена красным индикатором (radiobutton) слева:
...
Если на сервере отсутствует прошивка, установленная сейчас на устройстве, в диалоговом окне отобразится сообщение с предупреждением.
События
Отображает список событий, произошедших с устройством. Важные события, сообщающие о проблемах, обозначаются красным цветом.
Scroll Pagebreak |
---|
Задачи
В таблице отображаются задачи, созданные пользователем для этого устройства. Системные задачи, например периодическая синхронизация, будут скрыты.
...
- Статус — текущий статус выполнения задачи.
- Тип — суть задачи.
- Описание — параметры, с которыми задача была запущена.
- Создано в — дата и время создания задачи.
- Запущено в — дата и время запуска задачи в активную работу. Может не совпадать с датой создания, т.к. задача может находиться в очереди обработчика.
- Остановлено в — дата и время завершения работы над задачей. При этом задача может завершиться успешно или не успешно.
- Лог — открыть журнал выполнения задачи из Ansible.
Мониторинг
Отображение данных мониторинга устройства.
...
- Выбор типа данных
- Выбор временного диапазона выборки
- График
Типы данных
Полный список типов собираемых данных зависит от конкретного устройства и его конфигураций, например от количества имеющихся процессорных ядер или сконфигурированных сущностей. Кроме этого есть общие метрики для всех устройств, например доступность по ICMP. Все собираемые данные отображаются в выпадающем списке:
Временной диапазон выборки
Позволяет установить диапазон времени, в котором находятся интересующие данные. По умолчанию отображается диапазон с 00:00 текущего дня.
Для выбора даты и времени предусмотрены соответствующие инструменты:
Scroll Pagebreak |
---|
График
В области отображения графика находятся элементы:
...
- Временная шкала с превью графика, которая позволяет указать конкретный диапазон времени для отображения данных из выборки, полученной с сервера.
- Интерактивная легенда, позволяющая включать и отключать отдельные линии графиков.
ПО
Раздел, позволяющий добавлять, удалять и просматривать прошивки устройств.
...
- Кнопки для добавления и удаления файлов ПО
- Таблица прошивок, добавленных в систему.
Scroll Pagebreak |
---|
Добавление новой прошивки
При нажатии на кнопку добавления новой прошивки открывается диалоговое окно со следующими элементами:
...
Примечание |
---|
Для серии MES5448/MES7048 необходимо дополнительно добавить загрузчик и указать его версию. |
Scroll Pagebreak |
---|
Обновить группу устройств
Интерфейс предназначен для создания задач на обновление группы устройств, которые могут быть выполнены по заданному расписанию. Структура раздела построена в виде пошагового мастера. На рисунке ниже рамкой выделены шаги, а в нижней части располагаются кнопки для навигации:
Устройства
На этом шаге происходит выбор группы устройств, над которыми будут выполняться дальнейшие действия. Для этого используются две таблицы:
...
При выборе первого устройства в верхней таблице (1) автоматически отфильтровываются устройства других моделей. Все выбранные устройства добавляются в нижнюю таблицу (2).
Scroll Pagebreak |
---|
Выбор прошивки
На этом шаге нужно выбрать прошивку, которая будет загружена на выбранные ранее устройства, установив флаг напротив неё:
Установка расписания
Позволяет настроить время начала и завершения выполнения задачи.
...
При выборе опций "Начать в ближайшее время" и "Не запускать новые подзадачи после указанного времени" отображаются инструменты выбора даты и времени начала и завершения обновления:
Применить
На данном шаге на экране отображаются все ранее указанные параметры:
...
После нажатия кнопки "Применить" будет создана задача, выполнение которой начнется в указанное время.
Scroll Pagebreak |
---|
Сравнение
Раздел для сравнения конфигураций друг с другом. Содержит следующие элементы:
- Инструменты для выбора устройства и конфигурации.
- Область для отображения конфигурации.
Выбор устройства и конфигурации
Для сравнения конфигураций устройств нажмите кнопку "Выберите устройство". Установите флаг напротив необходимого устройства:
...
Подсказка |
---|
Сравнение двух конфигураций можно также провести в разделе "Устройства", выбрав две конфигурации на вкладке "Конфигурация" необходимого устройства и нажав кнопку "Сравнение". |
Область для отображения конфигурации
После выбора двух конфигураций они сопоставляются друг с другом, и различия отмечаются цветом:
Scroll Pagebreak |
---|
Задачи
В разделе отображается таблица с задачами, выполняемыми в системе от имени пользователя. Периодические системные задачи, такие как синхронизация устройств, по умолчанию скрыты. Их можно отобразить, нажав "Показать" в последнем столбце таблицы.
...
- Статус — текущий статус выполнения задачи.
- Тип — суть задачи.
- Описание — параметры, с которыми задача была запущена.
- Создано в — дата и время создания задачи.
- Запущено в — дата и время запуска задачи в активную работу. Может не совпадать с датой создания, т.к. задача может находиться в очереди обработчика.
- Остановлено в — дата и время завершения работы над задачей. При этом задача может завершиться успешно или не успешно.
- Лог — открыть журнал выполнения задачи из Ansible.
- Подзадачи — задачи для работы над каждым отдельным устройством. При отображении таблицы задач все подзадачи скрыты, и отображается только родительская задача с интегральным статусом. Эта кнопка используется для отображения всех подзадач для групповой операции.
Scroll Pagebreak |
---|
События
Отображает список событий, произошедших в системе. Важные события, сообщающие о проблемах, выделяются красным цветом, информационные — зеленым.
Настройки
Раздел общих настроек системы. Содержит две вкладки:
- Доступ
- Группы
Scroll Pagebreak |
---|
Доступ
Интерфейс для настройки параметров по умолчанию для доступа к устройствам.
...
Каждая секция настраивается отдельно и имеет свою кнопку для сохранения новых значений.
Пользователи
Раздел для управления учетными записями пользователей системы.
...
- Кнопки добавления и удаления пользователей.
Таблица пользователей.
Подсказка Для редактирования существующей учетной записи нужно дважды кликнуть левой кнопкой мыши по соответствующей строке.
Scroll Pagebreak |
---|
Создание новой учетной записи
При нажатии кнопки "Добавить" откроется диалоговое окно, в котором необходимо указать параметры для новой учетной записи:
...
- Атрибуты учетной записи (обязательные поля отмечены знаком "*"):
- Логин и пароль — используются для авторизации в системе.
- Роль — определяет набор привилегий, доступных пользователю в системе.
- Фамилия, Имя, Отчество — необходимы для идентификации человека, которому принадлежит учетная запись.
- E-mail — адрес для отправки уведомлений пользователю.
- Группы устройств и системных объектов, к которым пользователю будет предоставлен доступ.
- Кнопки отмены и сохранения.
Scroll Pagebreak |
---|
Добавление групп для пользователя
Элементы интерфейса окна добавления группы:
...
Строка навигации — отображает текущую выбранную группу. Именно эта группа будет сохранена в учетную запись пользователя после нажатия кнопки "Добавить".
Таблица вложенных групп — позволяет выбрать одну из дочерних групп и перейти дальше по дереву.
Подсказка Для возвращения в родительскую группу нужно кликнуть по ее названию в строке навигации.
- Кнопки отмены и сохранения.
Роли
Интерфейс для управления ролями пользователей системы.
...
- Кнопки для добавления и удаления ролей.
- Таблица ролей.
Scroll Pagebreak |
---|
Предустановленный набор ролей
В систему по умолчанию добавлено три роли:
- SuperAdmin — роль для управления системой ECCM. Привилегии: управление пользователями, ролями. Управление глобальными настройками доступа к устройствам. А также все возможности, доступные другим ролям.
- Administrator — роль для специалистов, пользующихся системой для настройки оборудования. Привилегии: управление оборудованием (ввод/вывод устройств в работу, конфигурация, обновление, перезагрузка), управление группами устройств. Также доступны возможности, предоставленные оператору.
- Operator — роль для осуществления мониторинга работы оборудования. Привилегии: просмотр данных мониторинга (состояние устройств, статистика, аварии, отчеты).
Создание новой роли
- Название роли.
- Описание — краткое пояснение, для кого и для чего предназначена роль.
- Набор привилегий, доступных пользователю в этой роли. Пользователь может применять свои привилегии ко всем устройствам и объектам, которые находятся в его группах.
- Кнопки отмены и сохранения.
Таблица привилегий
Название привилегии | Описание |
---|---|
Сравнение конфигураций | доступ к функционалу сравнения конфигураций разных версий и устройств |
Сводная информация | доступ к разделу "Сводная информация" и информационным виджетам |
Устройства - настройка адаптеров | доступ к странице настройки адаптера устройства |
Устройства - конфигурирование | доступ к странице управления конфигурацией устройства |
Устройства - обновление ПО | доступ к странице обновления прошивки устройства |
Устройства - мониторинг | доступ к странице отображения метрик устройства |
Устройства - просмотр | доступ к разделу "Устройства" для просмотра устройств единым списком |
События | раздел для отображения событий, произошедших с устройствами |
Хранилище ПО | раздел для управления прошивками, хранящимися в системе |
Группы - управление | доступ к разделу "Группы" и управлению группами и устройствами |
Группы - мониторинг | доступ к разделу "Группы" для просмотра информации об устройствах с разделением по группам |
Настройки - доступ | раздел настроек доступа к устройствам |
Настройки - резервное копирование | раздел для импорта и экспорта списка устройств |
Настройки - лицензия | раздел для управления лицензией |
Настройки - пользователи | раздел для управления учетными записями пользователей и ролями |
Задачи | раздел для отображения результатов выполнения задач |
Групповое обновление устройств | раздел для запуска задач массового обновления устройств |
Лицензия
Система лицензирования предназначена для ограничения бесконтрольного коммерческого использования ECCM. Лицензия определяет количество устройств каждой модели, которые будут обслуживаться системой. Лицензии имеют несколько свойств:
- id — уникальный номер лицензии.
- Издатель — название компании или имя сотрудника, выпустившего лицензию.
- Получатель — название организации, приобретающей лицензию.
- Дата издания — дата генерации лицензии.
- Дата истечения — дата, после которой лицензия считается недействительной. После наступления этой даты доступ к управлению устройствами будет ограничен.
Описание интерфейса
- Инструменты управления лицензиями:
- Загрузить — загрузить на сервер новый лицензионный файл.
- Экспортировать — получить файл активной лицензии.
- Информация об установленной в систему лицензии: основные данные и суммарное количество поддерживаемых моделей устройств, поддерживаемых.
- Список моделей и количество единиц оборудования каждой модели, которое поддержано в лицензии.
Scroll Pagebreak |
---|
Загрузка новой лицензии
После нажатия кнопки "Загрузить" будет открыто системное окно, в котором нужно выбрать новый файл с лицензией и загрузить его на сервер. После этого ECCM произведет анализ загруженной лицензии и откроет окно для сравнения новой лицензии с активной.
...
Если новая лицензия устарела или не поддерживает работу всех добавленных в систему устройств, при ее применении будет отображена ошибка.
Scroll Pagebreak |
---|
Резервное копирование
Раздел предназначен для создания копий (экспорта) списка устройств из системы в файл типа 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 |
...
В качестве разделителя используется символ точка с запятой ';'.
Scroll Pagebreak |
---|
Импорт устройств
Для импорта устройств нажмите кнопку "Импорт устройств" и выберите подходящий файл для импорта. Файл будет загружен в систему и обработан, после чего откроется диалоговое окно добавления устройств:
...