Общие сведения

Продукт «Служба управления конфигурациями» (LCM) предоставляет графический интерфейс администратора для выполнения следующих операций:

  • просмотр списка пользователей;

  • просмотр списка устройств;

  • над коллекцией устройств:

    • создание;

    • просмотр;

    • редактирование;

    • пересчет;

    • удаление;

  • просмотр/применение конфигураций;

  • просмотр информации о примененных конфигурациях;

  • остановка/активация применения конфигураций к коллекции устройств;

  • работа с дополнительными настройками:

    • сопоставление пользователей и устройств;

    • инвентаризация устройств.

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

Главная страница графического интерфейса администратора продукта «Служба управления конфигурациями» представлена на Рис. 1.

main page
Рис. 1. Главная страница графического интерфейса администратора

Где:

  • Пользователи — список пользователей;

  • Устройства — список устройств;

  • Коллекции устройств — группы устройств, объединенных по одному или нескольким признакам;

  • Конфигурации — список действий для применения к коллекции устройств;

  • Применение конфигураций — информация о применении конфигураций к коллекциям со статусами применения;

  • Настройки — раздел содержит:

    • Сопоставление пользователей и устройств — функциональность для сопоставления пользователя с устройством;

    • Инвентаризация устройств — инвентаризация устройств, включая создание и управление кастомными атрибутами;

  • filtr — фильтры.

Основные сценарии использования

Основные сценарии использования графического интерфейса продукта «Служба управления конфигурациями»:

Работа с пользователями

Администратору доступны операции:

Просмотр списка пользователей и подробной информации о пользователе

Для просмотра списка пользователей на боковой панели главной страницы выберите Пользователи.

На экране отобразится список пользователей с окном быстрого просмотра информации о первом пользователе из списка:

main page

Для настройки отображения столбцов в списке пользователей:

  1. Нажмите правой кнопкой мыши на любом имени столбца.

  2. Выберите необходимые столбцы.

user tabl

Для просмотра подробной информации:

  1. Выберите пользователя.

  2. В окне быстрого просмотра нажмите на Открыть.

    user list ful

Работа с устройствами

Администратору доступны операции:

Просмотр списка устройств и подробной информации об устройстве

Для просмотра списка устройств на боковой панели главной страницы выберите Устройства.

На экране отобразится список устройств с окном быстрого просмотра информации о первом устройстве из списка:

image2023 8 28 14 53 13

Для настройки отображения столбцов в списке устройств:

  1. Нажмите правой кнопкой мыши на любом имени столбца.

  1. Выберите необходимые столбцы.

device tab

Для просмотра подробной информации:

  1. Выберите устройство.

  2. В окне быстрого просмотра выполните одно из следующих действий:

    • нажмите на Показать больше;

      device open

    • нажмите на Открыть.

      image2023 8 28 14 57 44

Работа с коллекциями устройств

Администратору доступны операции:

Создание/изменение коллекции устройств

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

  1. На боковой панели главной страницы выберите Коллекции устройств.

  2. Нажмите на кнопку Создать:

    col cr

  3. В открывшейся форме заполните поля:

    image2023 8 28 15 28 46

    • Название — название коллекции (должно быть уникальным);

    • Описание — краткое описание коллекции;

    • Обновление коллекции:

      • Не обновлять — обновление коллекции возможно только в ручном режиме (статическая коллекция);

      • Обновлять по расписанию (время сервера) — обновление коллекции происходит по заданному расписанию (динамическая коллекция);

    • SQL-запрос — SQL-запрос для формирования списка устройств в составе коллекции.

      При использовании некорректного запроса коллекция не будет создана и сохранена. Правила составления SQL-запроса см. в разделе «Требования к SQL-запросу».

  4. Нажмите на кнопку Выполнить запрос.

    Происходит валидация SQL-запроса.

    Если SQL-запрос выполнился с ошибкой, то выводится предупреждение:

    image2023 8 28 16 15 40

    Если SQL-запрос выполнился без ошибки, то выводится список устройств, добавленных в коллекцию, и сообщение об успешной валидации запроса:

    image2023 8 28 16 16 21

  5. Нажмите на кнопку Создать.

    Кнопка Создать активна только в случае выполнения SQL-запроса без ошибок.

Для изменения коллекции устройств:

  1. На боковой панели главной страницы выберите Коллекции устройств.

  2. Выберите коллекцию устройств.

  3. В окне быстрого просмотра нажмите на Изменить.

  4. Внесите изменения в коллекцию.

  5. Нажмите на кнопку Сохранить.

    col edit
Требования к SQL-запросу

Коллекции устройств могут быть статическими и динамическими.

Статические коллекции

Список устройств в статических коллекциях обновляется только при создании или вручную.

SQL-запрос должен иметь тип select и в списке извлекаемых колонок содержать столбец minion_id.

При создании SQL-запроса нельзя использовать следующие операторы:

  • drop;

  • alter;

  • create;

  • update;

  • delete;

  • insert;

  • truncate.
Шаблоны SQL-запросов

  1. Запрос с использованием базовой информации по пользователям и устройствам:

    select m.minion_id
from users u
join user_machine_mappings umm on umm.user_fdn = u.full_domain_name
join machines m on m.fqdn = umm.machine_fqdn
where <...>

  2. Запрос с использованием подробной информации по устройствам:

    select m.minion_id
from machines m
left join machine_disks md on md.minion_id = m.minion_id
left join machine_networks mn on mn.minion_id = m.minion_id
where <...>

  3. Запрос с использованием информации, доступной в модуле «Инвентаризация»:

    select m.minion_id
from users u
join user_machine_mappings umm on umm.user_fdn = u.full_domain_name
join machines m on m.fqdn = umm.machine_fqdn
left join machine_disks md on md.minion_id = m.minion_id
left join machine_networks mn on mn.minion_id = m.minion_id
where <...>
Динамические коллекции

Список АРМ в динамических коллекциях обновляется по заданному расписанию, а также при создании и редактировании. Расписание обновления представляет собой выражение cron-like для фреймворка Quartz.

Пересчет коллекции устройств

Если в систему добавлены/удалены устройства, отвечающие маске в SQL-запросе существующей коллекции, то необходимо пересчитать (обновить) коллекцию устройств.

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

Для пересчета коллекции устройств:

  1. На боковой панели главной страницы выберите Коллекции устройств.

  2. Выберите коллекцию устройств.

  3. Выполните одно из следующих действий:

    • в окне быстрого просмотра нажмите на Пересчитать:

      col upd1

    • в окне быстрого просмотра нажмите на Открыть. Далее нажмите на кнопку Пересчитать:

      col upd2

Просмотр списка коллекций устройств и подробной информации о коллекции устройств

Для просмотра списка коллекций устройств выберите Коллекции устройств:

image2023 8 28 16 18 54

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

Для настройки отображения столбцов в списке коллекций устройств:

  1. Нажмите правой кнопкой мыши на любом имени столбца.

  2. Выберите необходимые столбцы.

col tab

Для просмотра подробной информации:

  1. Выберите коллекцию.

  2. В окне быстрого просмотра нажмите на Открыть.

    image2023 8 28 16 17 15

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

Для удаления коллекции устройств:

  1. На боковой панели главной страницы выберите Коллекции устройств.

  2. Выберите коллекцию устройств.

  3. В окне быстрого просмотра нажмите на Удалить коллекцию:

col del

  • если у коллекции нет связок с конфигурациями в статусе «Применяется», то коллекция удаляется. Выводится сообщение об успешном удалении;

  • если у коллекции есть связки с конфигурациями в статусе «Применяется», то выводится окно с информацией:

    col del2

Работа c конфигурациями

Администратору доступны операции:

Просмотр списка конфигураций и подробной информации о конфигурации

Для просмотра списка конфигураций выберите Конфигурации.

На экране отобразится список доступных конфигураций с окном быстрого просмотра информации о первой конфигурации:

conf list

Для настройки отображения столбцов в списке конфигураций:

  1. Нажмите правой кнопкой мыши на любом имени столбца.

  2. Выберите необходимые столбцы.

conf tab

Для просмотра подробной информации:

  1. Выберите конфигурацию.

  2. В окне быстрого просмотра нажмите на Открыть.

    conf full

В экране отобразится подробная информация о конфигурации.

Под заголовком Версии отображаются все доступные версии данной конфигурации. При нажатии на 3t vert в строке версии можно выполнить следующие действия над версией конфигурации:

conf full2

Применение конфигурации к коллекции устройств

Применение конфигурации возможно из разделов:

  • Коллекции устройств;

  • Конфигурации;

  • Применение конфигураций.

Применение конфигурации из раздела Коллекции устройств

Для применения конфигурации:

  1. На боковой панели главной страницы выберите Коллекция устройств.

  2. Выберите коллекцию устройств.

  3. В окне быстрого просмотра нажмите на Применить конфигурацию:

    conf prim3

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

    conf col

  5. Нажмите на кнопку Применить.

Применение конфигурации из раздела Конфигурации

Применить конфигурацию можно двумя способами:

Применение конфигурации через окно быстрого просмотра

Для применения конфигурации:

  1. На боковой панели главной страницы выберите Конфигурации.

  2. Выберите конфигурацию.

  3. В окне быстрого просмотра нажмите на Применить конфигурацию:

    conf prim1

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

    conf conf

  5. Нажмите на кнопку Применить.

Применение конфигурации через окно с подробной информацией

Для применения конфигурации:

  1. На боковой панели главной страницы выберите Конфигурации.

  2. Выберите конфигурацию.

  3. В окне быстрого просмотра нажмите на Открыть.

  4. В таблице Версии напротив версии, которую необходимо применить, нажмите на 3t vert и выберите Применить:

    conf full2

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

    conf conf

  6. Нажмите на кнопку Применить.

Применение конфигурации из раздела Применение конфигураций

Для применения конфигурации:

  1. На боковой панели главной страницы выберите Применение конфигураций.

  2. Нажмите на кнопку Создать:

    conf prim conf

  3. В открывшейся форме выберите:

    • название конфигурации;

    • версия конфигурации;

    • имя коллекции устройств:

      conf pr1

  4. Нажмите на кнопку Применить.

Просмотр результата применения конфигураций

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

На экране отобразится список примененных конфигураций с окном быстрого просмотра информации о первой примененной конфигурации:

prim conf

Для настройки отображения столбцов:

  1. Нажмите правой кнопкой мыши на любом имени столбца.

  2. Выберите необходимые столбцы.

prim conf tab

Для просмотра подробной информации:

  1. Выберите строку применения конфигурации.

  2. В окне быстрого просмотра нажмите на Открыть.

prim podr

Результат применения конфигурации:

  • Всего — общее количество устройств;

  • Установлено — выполнена успешная установка конфигурации на устройство;

  • Ожидает установки — устройство, на которое требуется установка конфигурации, временно недоступно;

  • Ошибка — установка конфигурации на устройство завершено с ошибкой. Для получения информации об ошибке нажмите на vopr.

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

Остановка/активация применения конфигураций к коллекции устройств

Статусы применения конфигурации:

  • prim — конфигурация применяется к коллекции;

  • stop — применение конфигурации к коллекции остановлено;

  • err — в процессе применения конфигурации к коллекции произошла ошибка.

Для остановки применения конфигурации:

  1. На боковой панели главной страницы выберите Применение конфигураций.

  2. Выберите конфигурацию.

    Выбранная конфигурация должна иметь статус prim.

  3. В окне быстрого просмотра нажмите на Остановить выполнение:

    prim stop

  4. Подтвердите остановку применения конфигурации нажав на кнопку Да, остановить:

    prim stop1

Статус конфигурации изменится на stop.

Для активации применения конфигурации:

  1. На боковой панели главной страницы выберите Применение конфигураций.

  2. Выберите конфигурацию.

    Выбранная конфигурация должна иметь статус stop.

  3. В окне быстрого просмотра нажмите на Возобновить применение:

    prim voz

  4. Подтвердите активацию применения конфигурации нажав на кнопку Да, возобновить:

    prim voz1

Статус конфигурации изменится на prim.

Работа с настройками

Администратору доступны операции:

Сопоставление пользователей и устройств

Для выполнения сопоставления пользователей с устройствами:

  1. На боковой панели главной страницы выберите Настройки > Сопоставление пользователей и устройств > Ручное (через файл):

    set sopost

  2. Загрузите файл формата CSV cо списком пользователей и сопоставленными с ними устройствами.

    После успешной загрузки файла отобразится список с сопоставлением устройств и пользователей:

    set sopost2

  3. Нажмите на кнопку Применить.

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

set sopost3
Требования к формату CSV-файла

CSV-файл должен быть определенного формата: содержать 3 столбца и в качестве разделителя использовать точку с запятой (;):

<operation>;<user_name>@<user_domain>;<fqdn>

Где:

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

    1. R — (от англ.: remove) удалить связь между пользователем и устройством.

    2. RA — (от англ.: remove all) удалить все связи, существующие по указанному пользователю/устройству. Требуется заполнить или логин@домен пользователя, или полное доменное имя машины.

    3. A — (от англ.: add) создать или обновить связь между пользователем и устройством.

  2. Параметр второго столбца user_name должен содержать логин пользователя в указанном домене. Например, aarshavin или fmdostoevskiy.

  3. Параметр второго столбца user_domain должен содержать домен пользователя и соответствовать полному имени домена пользователя, выгруженному с сервера LDAP. Например, inno.tech или saratov.vtb.ru.

  4. Параметр третьего столбца fqdn должен содержать полное доменное имя АРМ, выгруженного из модуля координации, например: kassa256.vtb.ru.

  • При создании CSV-файла важно учитывать регистр имен устройств. Например, Laptop1.sochi.vtb.ru и LAPTOP1.sochi.vtb.ru будут интерпретированы по-разному. Полное имя устройства должно абсолютно совпадать с реальным именем.

  • Допустимо использовать только файлы с кодировкой:

    • csv;

    • csv macintosh;

    • csv ms dos.

Пример заполнения CSV-файла:

A;username1@domain.name;notebook1.domain.name
A;username1@domain.name;notebook2.domain.name
A;username2@domain.name;notebook1.domain.name
RA;username1@domain.name;
RA;username2@domain.name;
RA;;notebook1.domain.name
R;username2@domain.name;notebook2.domain.name

Строки, не соответствующие описанному формату записи, будут проигнорированы.

Записи в файле обрабатываются пакетами (батчами) по очереди и последовательно с группировкой по типу операции. Записи группируются по типам в следующем порядке:

  1. Удаление конкретного пользователя с конкретного АРМ.

  2. Удаление связок по идентификатору пользователя.

  3. Удаление связок по идентификатору АРМ.

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

Если вы попытаетесь загрузить информацию о соответствии устройства и пользователя, которых еще нет в базе данных (ни устройства, ни пользователя, либо только устройства или только пользователя), система все равно выполнит загрузку. В данном случае проверка на наличие информации об устройстве (таблица machines) и пользователе (таблица users) в базе данных не выполняется.

Управление grain-файлами

Для добавления grain-файла:

  1. На боковой панели главной страницы выберите Настройки > Инвентаризация устройств > Управление пользовательскими атрибутами > Управление grain-файлами.

  2. Нажмите на кнопку Добавить файл:

    set gr1

  3. Заполните поле Описание (опционально) и загрузите заранее подготовленный grain-файл.

    Например:

    set gr2

    Требования к имени grain-файла:

    • может содержать латинские буквы нижнего регистра, цифры, нижнее подчеркивание;

    • должно начинаться с custom_grain_;

    • расширение .py.

  4. Нажмите на кнопку Сохранить.

Создана новая запись grain-файла:

set gr3

Для изменения grain-файл:

  1. Выберите запись grain-файла.

  2. В окне просмотра информации о grain-файле нажмите на Редактировать:

    set gr4

  3. Отредактируйте описание и/или grain-файл:

    set gr5

  4. Нажмите на кнопку Сохранить.

Для удаления grain-файла:

  1. Выберите запись grain-файла.

  2. В окне просмотра информации о grain-файле нажмите на Удалить:

    set gr6

  3. Подтвердите удаление, нажав на кнопку Удалить.

Для скачивания grain-файла на устройство пользователя, в окне просмотра информации о grain-файле нажмите на Скачать:

set gr7

Управление атрибутами

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

  1. На боковой панели главной страницы выберите Настройки > Инвентаризация устройств > Управление пользовательскими атрибутами > Управление атрибутами.

  2. Нажмите на кнопку Добавить атрибут:

    set atrib1

  3. Заполните поля в открывшейся форме:

    Например:

    set atrib2

    Требования к полям атрибута (все поля обязательные):

    • Название — не более 50 символов;

    • Код — уникальный, не более 30 символов;

    • Json Path — json path в формате dot notation;

    • Тип данных — выбрать из выпадающего списка.

  4. Нажмите на кнопку Создать.

    Если заполненные поля не отвечают обязательным требованиям, то выводится предупреждение:

    set atrib3

    Если заполненные поля отвечают обязательным требованиям, то выводится сообщение об успешном создании атрибута.

Создан новый атрибут устройства с названием Атрибут 49:

set atrib4

Для изменения атрибута устройства:

  1. Выберите атрибут.

  2. В окне просмотра параметров атрибута нажмите на Редактировать:

    set atrib5

  3. Отредактируйте поля атрибута:

    set atrib6

  4. Нажмите на кнопку Сохранить.

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

  1. Выберите атрибут.

  2. В окне просмотра параметров атрибута нажмите на Удалить:

    set atrib7

  3. Подтвердите удаление, нажав на кнопку Удалить.

Управление разделами атрибутов

Раздел атрибутов устройств — это раздел, который создается администратором для размещения в нем дополнительных кастомных атрибутов устройства.

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

  1. На боковой панели главной страницы выберите Настройки > Инвентаризация устройств > Управление пользовательскими атрибутами > Управление разделами атрибутов.

  2. Нажмите на кнопку Добавить раздел:

    set razd cr1

  3. Заполните поля в открывшейся форме.

    Например:

    set razd cr2
    Поле Название должно быть уникальным и содержать не более 30 символов.

    При проставлении чексбокса Отображать раздел в краткой информации об устройстве созданный раздел будет отображаться в окне быстрого просмотра информации об устройстве. В противном случае созданный раздел будет отображаться только в окне с подробной информацией об устройстве (подробнее см. раздел «Просмотр списка устройств и подробной информации об устройстве»).

  4. Нажмите на кнопку Сохранить.

Создан новый раздел с названием Параметры внешних дисков:

set razd cr3

Для изменения раздела:

  1. Напротив названия раздела нажмите на edit.

  2. Внесите изменения в открывшейся форме:

    set razd ed

  3. Нажмите на кнопку Сохранить.

Удерживая указателем мыши за move существует возможность перемещать разделы по списку.

Для удаления раздела:

  1. Напротив названия раздела нажмите на del2.

  2. Подтвердите удаление, нажав на кнопку Удалить.

Если удаляемый раздел содержит атрибуты, то выводится диалоговое окно:

set razd atrib
Управление пользовательскими атрибутами в разделе

Для добавления атрибута в раздел:

  1. Выберите раздел.

  2. В раскрывшейся информации о разделе нажмите на кнопку Добавить атрибут:

    set razd atrib2

  3. Из выпадающего списка выберите атрибут:

    set razd atrib3

    К выбору доступны только те атрибуты, которые были ранее созданы пользователем (подробнее см. раздел «Управление атрибутами»).

  4. Нажмите на кнопку Добавить.

В раздел добавлен пользовательский атрибут Атрибут 49:

set razd atrib4
В один раздел можно добавить не более 20 атрибутов. В случае превышения допустимого количества атрибутов, выводится соответствующее предупреждение.

Удерживая указателем мыши за move существует возможность менять порядок атрибутов в разделе.

Для удаления атрибута из раздела:

  1. Выберите раздел.

  2. В строке атрибута нажмите на del2.

  3. Подтвердите удаление, нажав на кнопку Удалить.

Управление параметрами агента

Агент — это клиентское приложение для управления устройством, на котором оно установлено.

Статусы агента:

  • Не установлен — статус присваивается, когда по истечении заданного времени (по умолчанию 90 дней) от агента не поступают сообщения на сервер управления (master);

  • Установлен — агент установлен на устройство:

    • Активен — агент активен;

    • Неактивен — статус присваивается, когда по истечении заданного времени (по умолчанию 7 дней) от агента не поступают сообщения на master.

Для настройки параметров агента:

  1. На боковой панели главной страницы выберите Настройки > Инвентаризация устройств > Параметры агента.

  2. Задайте параметры агента:

    set agent

    Где:

    • Статус агента «Неактивен» через, дней — количество дней, через которое агенту присваивается статус «Неактивен»;

    • Статус агента «Не установлен» через, дней — количество дней, через которое агенту присваивается статус «Не установлен»;

    • Время обновления статуса агента ежедневно — время, когда происходит обновление статуса агента.

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

  3. Нажмите на кнопку Сохранить.

  4. Подтвердите сохранение, нажав на кнопку Сохранить.

Статус агента и время его последнего обновления отображается в разделе с информацией об устройстве (подробнее см. раздел «Просмотр списка устройств и подробной информации об устройстве).

Загрузка данных из LDAP

В рамках продукта LCM администратор может добавить LDAP-запрос для сбора информации об устройствах на LDAP-серверах.

Для добавления LDAP-запроса:

  1. На боковой панели главной страницы выберите Настройки > Инвентаризация устройств > Загрузка данных из LDAP.

  2. Выберите LDAP-сервер.

  3. Нажмите на кнопку Добавить поисковый запрос:

    set ldap1

  4. Заполните поля в открывшейся форме:

    set ldap2

    Где:

    • Папка для поиска — может содержать DN (Distinguished Name), DC (Domain Component), OU (Organizational UnitName), CN (Common Name) (например, CN=Users,DC=lcm,DC=terra,DC=inno,DC=tech);

    • LDAP-фильтр — фильтр поиска (например, (mail=AArshavin@lcm.terra.inno.tech)).

  5. Нажмите на кнопку Сохранить.

    Выводится информационное окно:

    set ldap3

Поисковый запрос создан и сохранен:

set ldap4

Для редактирования LDAP-запроса:

  1. Выберите LDAP-сервер.

  2. Напротив поискового запроса нажмите на edit.

  3. Отредактируйте поисковый запрос:

    set ldap5

  4. Нажмите на кнопку Сохранить.

Для удаления поискового запроса

  1. Выберите LDAP-сервер.

  2. Напротив поискового запроса нажмите на del2.

  3. Подтвердите удаление, нажав на кнопку Удалить.

Настройка расписания синхронизации LDAP

Администратору доступны настройки расписания обнаружения новых устройств на LDAP-серверах. По умолчанию синхронизация происходит 1 раз в сутки.

Для настройки расписания синхронизации:

  1. На боковой панели главной страницы выберите Настройки > Инвентаризация устройств > Расписание синхронизации LDAP.

  2. Измените время синхронизации или добавьте дополнительное время, нажав на Добавить время обновления:

    set ldap6

  3. Нажмите на кнопку Сохранить.

Новое время обновления добавлено:

set ldap7

Для принудительного запуска синхронизации:

  1. Нажмите на Принудительная синхронизация.

  2. Подтвердите запуск синхронизации, нажав на кнопку Запустить.