Оглавление |
---|
A Shared Block | |||||
---|---|---|---|---|---|
| |||||
|
Введение
ECCM (ELTEX Cloud Configuration Manager) — это централизованная система управления сетевым оборудованием. Управление системой осуществляется с помощью web-интерфейса, который предоставляет удобные инструменты для настройки системы и сетевого оборудования под нужды пользователя. Данное руководство содержит описание интерфейса пользователя и основных приемов работы с ним.
Доступ к пользовательскому интерфейсу
Для подключения к интерфейсу пользователя необходимо ввести в адресной строке браузера ссылку http://<ECCM_ADDRESS>:8080, где <ECCM_ADDRESS> — это адрес сервера ECCM в вашей сети (это может быть IP-адрес или доменное имя, если у вас настроен DNS).
Откроется страница с формой авторизации:
Введите логин eccm и пароль eccm в соответствующие поля и нажмите кнопку Войти.
Интерфейс системы управления
Пользовательский интерфейс представляет собой одностраничное web-приложение, которое состоит из нескольких основных частей:
- Панель навигации по разделам.
- Счетчики сообщений и системных уведомлений.
- Данные об учетной записи пользователя.
- Кнопка для выхода из системы. При нажатии на нее сессия будет разорвана.
- Рабочая область. В зависимости от выбранного раздела здесь будут представлены различные виджеты.
- Кнопка сворачивания панели навигации (для расширения рабочей области).
Фильтры в таблицах
Для составления поисковых запросов в таблицах с большим объемом данных используются фильтры, представляющие собой строку, в которую можно ввести выражение для поиска информации. При установке курсора в поле ввода отображается список полей, по которым можно выполнить поиск. Например, фильтр в разделе "Устройства" выглядит следующим образом:
Scroll Pagebreak |
---|
Фильтры поддерживают использование логических операторов OR, AND, а также группировку выражений с помощью скобок:
При поиске данных по полям с численными значениями можно использовать операторы '==', '>', '<', как показано в строке Фильтр на рисунке выше.
Для строковых значений поддерживается только оператор '==', но имеется возможность заменять неопределенную часть выражения символом '*':
Scroll Pagebreak |
---|
Сводная информация
Здесь расположены виджеты, отображающие данные о состоянии системы:
- Общая статистика — счетчики, показывающие отношение недоступных устройств к общему количеству устройств в системе, а также отношение сработавших триггеров (преднастроенных порогов, пересечение которых требует особого внимания) к общему количеству устройств. Виджет дает представление об общих проблемах в сети.
- Статистика недоступных устройств по группам — счетчики недоступных устройств по каждой административной группе. Если группа содержит устройства, к которым был утерян доступ, ее рамка подсвечивается цветом. Если недоступно менее 5% — розовым, если более 5% — красным.
- Недоступные устройства — список устройств, доступ к которым был утерян. В таблице отображается название устройства (в виде активной ссылки), время потери доступа и длительность простоя.
- Проблемы — список сработавших триггеров. В таблице отображается название устройства, на котором сработал триггер (в виде активной ссылки), название триггера, время его срабатывания и уровень важности.
Виджеты автоматически обновляются каждую минуту. В случае возникновения проблем с доступом на сервер, на странице кэшируются последние данные, и отображается время последнего успешного обновления.
Scroll Pagebreak |
---|
Группы
Раздел для представления информации об устройствах системы, разделенных на административные группы.
В верхней части страницы отображается навигационная цепочка в стиле "breadcrumbs" (хлебные крошки). Она отображает путь к текущей группе и позволяет выполнить быстрый возврат к любой из родительских групп.
Группы подразделяются на два типа: тип 'DEVICES' для устройств и тип 'GROUPS' для групп. В группе типа 'GROUPS' отображаются вложенные группы, а счетчики отображают суммарную информацию по всем дочерним группам типа 'DEVICES':
В таблице отображается информация:
- Имя группы — активная ссылка для перехода в группу.
- Всего устройств — суммарное количество устройств в группе или в дочерних группах.
- Устройства с проблемами — суммарное количество устройств в группе или в дочерних группах, в которых обнаружены сработавшие триггеры.
- Недоступные устройства — суммарное количество устройств в группе или в дочерних группах, к которым был потерян доступ с сервера управления.
В группе типа 'DEVICES' отображается список устройств, принадлежащих этой группе:
В таблице отображаются данные о состоянии устройств, входящих в выбранную группу. Стоит обратить внимание на следующие столбцы:
- IP — IP-адрес устройства. Отображается в виде ссылки, по которой можно перейти на страницу управления устройством.
- Статус — статус доступности устройства. Проверяется периодическим ICMP-пингом с сервера на устройство. В случае потери 3-х пингов подряд устройство считается недоступным. В этом случае оно будет считаться вышедшим из строя, а его строка подсветится красным цветом.
- Длительность текущего статуса — время, прошедшее после смены статуса устройства. Высчитывается каждый раз при обновлении таблицы.
- Триггеры — отношение сработавших триггеров к общему количеству триггеров на устройстве.
Устройства
Раздел для отображения всех устройств системы с возможностью фильтровать список устройств по инвентарным данным.
В таблице отображается следующая информация:
- ID — порядковый номер устройства в системе управления, присваивается при добавлении устройства в систему. Нумерация начинается от 100, каждый номер уникален и не может быть использован повторно.
- Серийный номер — комбинация цифр и букв, которая вычитывается с устройства по SNMP и хранится в базе данных.
- IP — IP-адрес устройства в сети управления устройствами (каждое устройство имеет уникальный IP-адрес). Отображается в виде ссылки, по которой можно перейти на страницу управления устройством.
- Hostname — имя хоста, вычитывается с устройства по SNMP и хранится в базе данных.
- MAC — MAC-адрес устройства, вычитывается с устройства по SNMP и хранится в базе данных.
- Серия — название модельного ряда, вычитывается с устройства по SNMP и хранится в базе данных.
- Модель — название модели, вычитывается с устройства по SNMP и хранится в базе данных.
- Версия — номер прошивки, установленной на устройстве, вычитывается с устройства по SNMP и хранится в базе данных.
- Статус — статус доступности устройства, проверяется периодическим ICMP-пингом с сервера на устройство.
Scroll Pagebreak |
---|
Страница устройства
Интерфейс для работы с отдельным устройством.
Состоит из следующих элементов:
- Заголовок — содержит название устройства и его IP-адрес
- Меню со вкладками:
- Конфигурация
- Адаптер
- Обновление ПО
- События
- Задачи
- Мониторинг
Scroll Pagebreak |
---|
Конфигурация
Функционал для управления конфигурацией устройства. Элементы управления:
- Блок функций 1:
- Перезагрузить — отправка команды для перезагрузки устройства.
- Синхронизировать — вычитывание текущей конфигурации с устройства. Если она не будет совпадать с последней полученной с устройства (RUNNING) конфигурацией, она будет сохранена в системе как новая конфигурация.
- Сравнение — переход к сравнению двух выбранных конфигураций. Для перехода требуется выбрать (отметить галочками) две конфигурации из списка.
- Блок функций 2:
- Редактировать — открытие редактора конфигурации.
- Скачать — получить выбранную конфигурацию в виде текстового файла.
- Применить — применить выбранную конфигурацию на устройство.
- Таблица конфигураций — отображается список имеющихся конфигураций для устройства.
- Превью конфигурации — панель для отображения выбранной конфигурации (выбор производится по клику на строке конфигурации (не по флажку, расположенному напротив)).
Типы конфигураций
RUNNING — последняя полученная с устройства конфигурация.
DRAFT — конфигурация, подготовленная для загрузки на устройство.
BACKUP — резервная копия конфигурации с устройства перед применением новой конфигурации. В случае смены текущей конфигурации на новую ей назначается тип BACKUP, а новой — RUNNING.
Scroll Pagebreak |
---|
Редактор конфигурации
Позволяет на основе создать копию (DRAFT) текущей версии конфигурации. При этом существующая конфигурация останется в базе данных и изменена не будет, оставляя возможность вернуть к ней устройство.
- Аннотация — комментарий к конфигурации. Указывается при создании новой конфигурации, после этого изменить аннотацию нельзя.
- Область редактирования — текстовый редактор, позволяющий работать с большим объемом информации и обеспечивающий подсветку синтаксиса и внесенных изменений.
- Кнопки управления:
- Отменить — закрыть окно без сохранения.
- Сохранить — сохранить изменения, создав новую конфигурацию с типом "Черновик" ("DRAFT").
- Сохранить и применить — сохранить новую конфигурацию как черновик и сразу же попытаться применить ее на устройство.
Редактор предоставляет инструменты для поиска по всей конфигурации. Для того, чтобы воспользоваться поиском, нужно установить курсор в область редактирования и нажать сочетание клавиш Сtrl+F:
Адаптер
Настройка Ansible-адаптера, который будет применяться к устройству для выполнения операций на нем. Например, для применения конфигурации или перезагрузки.
Обновление ПО
Интерфейс для обновления прошивки на устройстве. В таблице отображается список ПО, имеющегося на сервере для данного типа устройства (добавление новых прошивок выполняется в разделе ПО). Если на сервере есть прошивка той же версии, которая установлена на устройстве, она будет отмечена красным индикатором (radiobutton) слева:
Для того чтобы обновить устройство на другую версию прошивки, достаточно кликнуть на индикатор напротив прошивки. Отобразится сообщение с подтверждением действия:
Если на сервере отсутствует прошивка, установленная сейчас на устройстве, в диалоговом окне появится сообщение с предупреждением.
Scroll Pagebreak |
---|
События
Отображает список событий, произошедших с устройством. Важные события, сообщающие о проблемах, обозначаются красным цветом.
Задачи
В таблице отображаются задачи, созданные пользователем для этого устройства. Системные задачи, например периодическая синхронизация, будут скрыты.
- Статус — текущий статус выполнения задачи.
- Тип — суть задачи.
- Описание — параметры, с которыми задача была запущена.
- Создано в — дата и время создания задачи.
- Запущено в — дата и время запуска задачи в активную работу, может не совпадать с датой создания, т.к. задача может находиться в очереди обработчика.
- Остановлено в — дата и время завершения работы над задачей. При этом задача может завершиться успешно или не успешно.
- Лог — открывает журнал выполнения задачи из Ansible.
Scroll Pagebreak |
---|
Мониторинг
Отображение данных мониторинга устройства.
- Выбор типа данных
- Выбор временного диапазона выборки
- График
Типы данных
Полный список типов собираемых данных зависит от конкретного устройства и его конфигураций, например от количества имеющихся процессорных ядер или сконфигурированных сущностей. Кроме этого есть общие метрики для всех устройств, например доступность по ICMP. Все собираемые данные отображаются в выпадающем списке:
Scroll Pagebreak |
---|
Временной диапазон выборки
Позволяет установить диапазон времени, в котором находятся интересующие данные. По умолчанию отображается диапазон с 00:00 текущего дня.
Для выбора даты и времени предусмотрены соответствующие инструменты:
Scroll Pagebreak |
---|
График
В области отображения графика находятся элементы:
- Временная шкала с превью графика, которая позволяет указать конкретный диапазон времени для отображения данных из выборки, полученной с сервера.
- Интерактивная легенда, позволяющая включать и отключать отдельные линии графиков.
ПО
Раздел для работы с программным обеспечением устройств. Позволяет добавлять, удалять и просматривать прошивки.
В рабочей области расположены следующие элементы:
- Таблица прошивок, добавленных в систему.
- Кнопка для добавления новой прошивки.
- Кнопка для удаления выбранных прошивок (становится неактивной, если не выбрано ни одной прошивки).
Добавление новой прошивки
При нажатии на кнопку добавления новой прошивки открывается диалоговое окно, в котором необходимо заполнить несколько полей и указать файл с ПО:
- Вендор — производитель устройства, для которого загружается прошивка
- Серия — серия устройств (модельный ряд).
- Версия — номер прошивки в принятом у вендора формате, для прошивок Eltex это 'X.X.X build X'.
- Описание — комментарий к загружаемому файлу.
- Выберите файл ПО — кнопка для открытия диалогового окна для выбора файла на компьютере пользователя.
- Отменить — закрыть окно без сохранения изменений.
- Загрузить — кнопка для начала загрузки. Неактивна до тех пор, пока не заполнены все требуемые поля.
Scroll Pagebreak |
---|
Обновить группу устройств
Интерфейс предназначен для создания задач на обновление группы устройств, которые могут быть выполнены по заданному расписанию. Структура раздела построена в виде пошагового мастера. На рисунке ниже рамкой выделены шаги, а в нижней части располагаются кнопки для навигации:
Устройства
На этом шаге происходит выбор группы устройств, над которыми будут выполняться дальнейшие действия. Для этого используются две таблицы:
- Таблица, содержащая список всех устройств данной модели.
- Таблица выбранных устройств, которые будут обновлены.
При выборе первого устройства в верхней таблице (1) автоматически отфильтровываются устройства других моделей. Все выбранные устройства добавляются в нижнюю таблицу (2).
Scroll Pagebreak |
---|
Выбор прошивки
На этом шаге нужно выбрать прошивку, которая будет загружена на выбранные ранее устройства:
Установка расписания
Позволяет настроить время начала и завершения выполнения задачи.
Предлагаемые опции:
- Начать в ближайшее время — поставить задачи в очередь планировщика сразу после создания. Начало выполнения будет зависеть от загруженности планировщика. Снятие этого флага позволяет установить начало окна проведения операции обновления.
- Не запускать новые подзадачи после указанного времени — позволяет ограничить окно проведения операции обновления, запрещая запуск дополнительных задач. При этом выполненные операции не будут отменены, но устройства, для которых обновление не было запущено, останутся без обновления.
- Стратегия — способ запуска задач:
- Параллельно — одновременный запуск задач с использованием всех имеющихся обработчиков.
- Последовательно — обновление устройств по порядку, с использованием одного обработчика.
Scroll Pagebreak |
---|
При выборе опций "Начать в ближайшее время" и "Не запускать новые подзадачи после указанного времени" отображаются инструменты для выбора даты и времени начала и завершения проведения обновления:
Применить
На данном шаге на экране отображаются все ранее указанные параметры:
После нажатия кнопки Применить будет создана задача, выполнение которой начнется в указанное время.
Scroll Pagebreak |
---|
Сравнение
Раздел для сравнения конфигураций друг с другом. Содержит следующие элементы:
- Инструменты для выбора устройства и конфигурации
- Область для отображения конфигурации
Выбор устройства и конфигурации
Выберите устройства и их конфигурации с помощью кнопок "Выберите устройство" и "Выберите конфигурацию":
Подсказка |
---|
Сравнение двух конфигураций можно также провести в разделе Устройства, выбрав две конфигурации на вкладке "Конфигурация" необходимого устройства и нажав кнопку "Сравнение". |
Область для отображения конфигурации
После выбора двух конфигураций они сопоставляются друг с другом, и различия отмечаются цветом:
Scroll Pagebreak |
---|
Задачи
В разделе отображается таблица с задачами, выполняемыми в системе от имени пользователя. Периодические системные задачи, такие как синхронизация устройств, по умолчанию скрыты. Их можно отобразить, нажав "Показать" в последнем столбце таблицы.
Таблица состоит из следующих полей:
- Статус — текущий статус выполнения задачи.
- Тип — суть задачи.
- Описание — параметры, с которыми задача была запущена.
- Создано в — дата и время создания задачи.
- Запущено в — дата и время запуска задачи в активную работу. Может не совпадать с датой создания, т.к. задача может находиться в очереди обработчика.
- Остановлено в — дата и время завершения работы над задачей. При этом задача может завершиться успешно или не успешно.
- Лог — открывает журнал выполнения задачи из Ansible.
- Подзадачи — групповые операции представляют собой задачи, объединяющие несколько задач для работы над каждым отдельным устройством, называемых подзадачами. При отображении таблицы задач все подзадачи скрыты, и отображается только родительская задача с интегральным статусом. Эта кнопка используется для отображения всех подзадач для групповой операции.
Scroll Pagebreak |
---|
События
Отображает список событий, произошедших в системе. Важные события, сообщающие о проблемах, выделяются красным цветом, информационные — зеленым.
Настройки
Раздел, содержащий общие настройки системы.
Содержит две вкладки:
- Доступ
- Группы
Scroll Pagebreak |
---|
Доступ
Интерфейс для настройки доступа к устройствам с помощью адаптера.
- Выбор настраиваемого адаптера:
- ESR Ansible — адаптер, применяемый для устройств ESR от Eltex.
- Generic — адаптер для устройств других производителей.
- ssh — логин и пароль для доступа к устройствам по протоколу SSH.
- sftp — логин и пароль для доступа к устройствам по SFTP.
- Кнопки для сохранения и сброса настроек.
Настройки протоколов идентичны для обоих адаптеров.
Группы
Интерфейс для создания и удаления групп и устройств. В верхней части страницы отображается навигационная цепочка в стиле "breadcrumbs" (отмечено цифрой 1 на рисунке ниже), Она отображает путь к текущей группе и позволяет выполнить быстрый возврат к любой из родительских групп. В зависимости от типа группы в таблице может отображаться разная информация.
Для группы типа 'GROUPS' отображаются инструменты для добавления новой группы (2) и список дочерних групп (3):
Чтобы добавить новую группу, необходимо указать ее название и нажать кнопку "Создать".
Для групп типа "DEVICES" отображается список устройств, находящихся в группе (1), кнопка для добавления устройств (2) и кнопка для удаления устройств из группы (3).
Предупреждение |
---|
При удалении из группы устройства все равно остаются в системе. |
Scroll Pagebreak |
---|
Добавление устройств в группу
При нажатии кнопки добавления устройств в группу открывается отдельная таблица с устройствами. В группу можно добавить только те устройства, которые ранее не были добавлены в проекцию (группу верхнего уровня). Соответствующие им строки выделены белым цветом. Устройства, которые уже есть в этой проекции, выделены серым цветом и неактивны. Для применения или отмены изменений используются кнопки управления "Отменить" и "Добавить" в нижней части экрана.