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

Коллекция устройств может быть создана на основе:

SQL-запроса;
набора правил;
CSV-файла.

Создание коллекции устройств на основе SQL-запроса

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

На боковой панели главной страницы выберите Коллекции устройств.
Нажмите на кнопку Создать и в выпадающем списке выберите Коллекцию (SQL-запрос):
На странице создания коллекции заполните поля:
- Имя (обязательное поле) — имя коллекции длиной не менее трех символов (должно быть уникальным);
- Описание — краткое описание коллекции;
- Зона доступа (обязательное поле) — выберите из списка зону доступа;
- Расположение — выберите в дереве папку, в которой должна располагаться коллекция устройств; при необходимости воспользуйтесь поиском — наберите не менее трех символов, содержащихся в наименовании искомой папки, в поле ввода;
- Обновление коллекции — периодичность обновления:
  - Не обновлять — обновление коллекции возможно только в ручном режиме (статическая коллекция);
  - Ежедневно — обновление коллекции происходит ежедневно, один или несколько раз в день (динамическая коллекция);
    
    При настройке обновления коллекции несколько раз в день может быть установлен временной интервал.
  - Еженедельно — обновление коллекции происходит еженедельно в заданный день недели (или несколько дней) и заданное время (динамическая коллекция);
  - Ежемесячно — обновление коллекции происходит ежемесячно в заданное число месяца и время (динамическая коллекция);
- SQL-запрос для формирования списка устройств в составе коллекции.
  Требования к SQL-запросу:
  
  SQL-запрос должен иметь тип select и в списке извлекаемых столбцов содержать minion_id;
  
  при создании SQL-запроса не допускается использовать следующие операторы:
  
  drop;
  
  alter;
  
  create;
  
  update;
  
  delete;
  
  insert;
  
  truncate.
  
  Шаблоны SQL-запросов:
  
  запрос с использованием базовой информации по пользователям и устройствам:
  
  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.minion_id = umm.machine_fqdn where <...>
  
  запрос с использованием подробной информации по устройствам:
  
  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 <...>
  
  запрос с использованием информации, доступной в модуле «Инвентаризация»:
  
  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.minion_id = 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 <...>
  
  Если SQL-запрос не отвечает требованиям и является некорректным, коллекция не будет создана и сохранена.
Нажмите на кнопку Выполнить.

Происходит валидация SQL-запроса:
- если SQL-запрос выполнился с ошибкой, выводится предупреждение:
- если SQL-запрос выполнился без ошибки, выводится список устройств, добавленных в коллекцию, и сообщение об успешной валидации запроса:
  Корректно созданный SQL-запрос может быть сохранен в виде шаблона для повторного использования при создании и редактировании коллекций устройств.
  
  Для создания шаблона:
  
  Составьте SQL-запрос и нажмите на кнопку Выполнить.
  
  Если SQL-запрос выполнился без ошибки, нажмите на Сохранить шаблон.
  
  Введите название шаблона (должно быть уникальным) и нажмите на кнопку Сохранить.
  
  Для использования сохраненного шаблона:
  
  Нажмите на Использовать шаблон.
  
  В строке поиска наберите название шаблона или выберите его из выпадающего списка.
  
  Подтвердите использование шаблона, нажав на кнопку Использовать.
Нажмите на кнопку Создать.

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

Редактирование коллекции устройств на основе SQL-запроса

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

На боковой панели главной страницы выберите Коллекции устройств.
Выберите коллекцию устройств на основе SQL-запроса.
В списке действий на панели быстрого просмотра нажмите Редактировать.

На странице редактирования внесите изменения в атрибуты коллекции:

Если изменения затрагивают непосредственно SQL-запрос, то перед сохранением изменений необходимо провалидировать запрос, нажав на Выполнить.

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

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

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

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

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

На боковой панели главной страницы выберите Коллекции устройств.
Нажмите на кнопку Создать и в выпадающем списке выберите Коллекцию (набор правил):

На странице создания коллекции заполните поля:

Имя (обязательное поле) — имя коллекции длиной не менее трех символов (должно быть уникальным);
Описание — краткое описание коллекции;
Зона доступа (обязательное поле) — выберите из списка зону доступа;
Обновление коллекции — периодичность обновления:
- Не обновлять — обновление коллекции возможно только в ручном режиме (статическая коллекция);
- Ежедневно — обновление коллекции происходит ежедневно, один или несколько раз в день (динамическая коллекция);
  
  При настройке обновления коллекции несколько раз в день может быть установлен временной интервал.
- Еженедельно — обновление коллекции происходит еженедельно в заданный день недели (или несколько дней) и заданное время (динамическая коллекция);
- Ежемесячно — обновление коллекции происходит ежемесячно в заданное число месяца и время (динамическая коллекция);
Расположение — выберите в дереве папку, в которой должна располагаться коллекция устройств; при необходимости воспользуйтесь поиском — наберите не менее трех символов, содержащихся в наименовании искомой папки, в поле ввода;
набор правил вхождения устройств в коллекцию:
- Базовое множество (обязательно) — правило, в которое может быть добавлено получение набора устройств одним из способов:
  - из всего множества устройств (по умолчанию): флажок Включить в базовое множество все устройства:
  - из других коллекций.
    
    Для этого:
    
    Снимите флажок Включить в базовое множество все устройства.
    
    Нажмите на строку Найти и добавить коллекции и в выпадающем списке выберите коллекции:

Ограничение (опционально) — правила, в которых указываются ограничения на базовое множество.

Для добавления группы правил (при необходимости):

Нажмите на Добавить группу правил:
Нажмите на Добавить атрибут:

Из выпадающего списка выберите (или воспользуйтесь строкой поиска) атрибут.

При выборе атрибутов Пользовательский атрибут с типом "Дата" или Пользовательский атрибут с типом "Строка" на следующем шаге необходимо выбрать сам атрибут, который был ранее создан. Подробнее о создании атрибутов см. в разделе «Управление атрибутами».

Выберите значение атрибута.

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

При удалении группы правил (кнопка Удалить группу правил) удаляются все атрибуты и их значения, которые входят в эту группу правил.

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

Добавление группы правил выполняется так же, как и в разделе Ограничение.

Нажмите на кнопку Выполнить:
Происходит трансляция набора правил в SQL-запрос и выполнение запроса с отображением полученных по запросу записей устройств в коллекции.

Пример:

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

Для создания шаблона:
1. Создайте набор правил и нажмите на кнопку Выполнить.
2. Нажмите на Сохранить шаблон.
3. Введите название шаблона (должно быть уникальным) и нажмите на кнопку Сохранить.
Для использования сохраненного шаблона:
1. Нажмите на Использовать шаблон.
2. В строке поиска наберите название шаблона или выберите его из выпадающего списка.
3. Подтвердите использование шаблона, нажав на кнопку Использовать.
Нажмите на кнопку Создать.

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

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

На боковой панели главной страницы выберите Коллекции устройств.
Выберите коллекцию устройств на основе набора правил.
В списке действий на панели быстрого просмотра нажмите Редактировать.

На странице редактирования внесите изменения в атрибуты коллекции:

Если изменения затрагивают непосредственно набор правил, то перед сохранением изменений необходимо нажать на Выполнить.

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

Создание коллекции устройств на основе CSV-файла

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

Перед выполнением операции создайте CSV-файл в соответствии с требованиями:

формат файла — CSV (расширение *.csv);
кодировка текста в файле — UTF-8;
разделитель между строками — символ перевода строки (LF) в стиле Unix/Linux;
количество столбцов — один;
строка заголовка — отсутствует;
каждая строка содержит идентификатор одного устройства;

в качестве идентификатора устройства может указываться имя хоста, неполное доменное имя или полное доменное имя (FQDN) устройства (например — 1044139-lm-1.r1044139.terra.inno.tech);

При анализе содержимого файла поиск устройств выполняется по маске ID* с учетом указанной зоны доступа. Например, если в файле указан идентификатор устройства 1044139-lm-1.r1044139, в базе данных выполняется поиск устройств, идентификаторы которых соответствуют маске 1044139-lm-1.r1044139*. Таким образом, в коллекцию будут включены устройства с полными доменными именами 1044139-lm-1.r1044139.inno.tech, 1044139-lm-1.r1044139.terra.inno.tech и т. д.

максимальная длина строки — 1000 символов;
в файле отсутствуют пустые строки;
максимальный размер файла по умолчанию (устанавливается конфигурационным параметром osmax.inventory.collections.import-file-max-size-bytes в файле application.properties) — 2 Мб.

Пример CSV-файла с перечнем идентификаторов устройств:

1044139-lm-1.r1044139.terra.inno.tech
1044139-lm-2.r1044139.terra.inno.tech
1044139-lm-3.r1044139.terra.inno.tech
1044139-lm-4.r1044139.terra.inno.tech

Скопируйте созданный CSV-файл на компьютер, с которого осуществляется доступ к веб-интерфейсу «Кабинет администратора».

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

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

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

В списке коллекций устройств в указанном при создании расположении отображается новая строка.

Редактирование коллекции устройств на основе CSV-файла

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

На боковой панели главной страницы выберите Коллекции устройств.
Выберите коллекцию устройств на основе CSV-файла.
В списке действий на панели быстрого просмотра нажмите Редактировать.
На странице редактирования внесите изменения в атрибуты коллекции:
- Имя (обязательное поле) — имя коллекции длиной не менее трех символов (должно быть уникальным);
- Описание — краткое описание коллекции;
- Зона доступа (обязательное поле) — выберите из списка зону доступа;
- Расположение — выберите в дереве папку, в которой должна располагаться коллекция устройств; при необходимости воспользуйтесь поиском — наберите не менее трех символов, содержащихся в наименовании искомой папки, в поле ввода;
Нажмите на кнопку Сохранить.

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

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

Изменение списка устройств в коллекции на основе CSV-файла

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

Доступны две операции:

добавление новых устройств;
удаление добавленных ранее устройств.

Перед выполнением операций создайте CSV-файл с идентификаторами добавляемых или удаляемых устройств в соответствии с теми же требованиями, которые предъявляются к CSV-файлам используемым при создании новой коллекции.

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

На боковой панели главной страницы выберите Коллекции устройств.
Выберите коллекцию устройств, созданную на основе CSV-файла.
В списке действий на панели быстрого просмотра нажмите Добавить/удалить устройства.
На странице добавления/удаления устройства выберите действие из списка:
- Добавить для добавления устройств на основе CSV-файла;
- Удалить для удаления устройств на основе CSV-файла.
Перетащите или загрузите из файловой системы созданный ранее файл в формате CSV со списком идентификаторов устройств.

При возникновении ошибок, связанных с несоответствием загруженного файла требованиям к формату, отображается соответствующее сообщение:

Если файл соответствует требованиям к формату, его имя отобразится в поле:
Нажмите на кнопку Сохранить.

В результате выполнения операции:

выполняется пересчет списка устройств коллекции с учетом зоны доступа;
выполняется проверка наличия устройств с идентификаторами, соответствующими переданным в CSV-файле;
в коллекцию включаются или из коллекции исключаются все найденные по идентификаторам или маске устройства;
формируется запись в истории изменения коллекции.

Отображаются:

сообщение о количестве добавленных или удаленных устройств;
страница с параметрами измененной коллекции со списком включенных в нее устройств.