Словари
Описание параметров
Словари – это ресурсы, в которых хранятся данные, которые могут использоваться другими ресурсами и сервисами KUMA.
Словари могут использоваться в следующих сервисах и функциях KUMA:
Доступные параметры:
- Название (обязательно) – уникальное имя для этого типа ресурса. Должно содержать от 1 до 128 символов в кодировке Unicode.
- Тенант (обязательно) – название тенанта, которому принадлежит ресурс.
- Описание – вы можете добавить до 4000 символов в кодировке Unicode, описывающих ресурс.
- Тип (обязательно) – тип словаря. От выбранного типа зависит формат данных, которые может содержать словарь:
- В тип Словарь можно добавлять пары ключ–значение.
Не рекомендуется добавлять в словари этого типа более 50 000 записей.
При добавлении в словарь строк с одинаковыми ключами каждая новая строка будет записана поверх уже существующий строки с тем же самым ключом. В итоге в словарь будет добавлена только одна строка.
- В тип Таблица можно добавлять данные в виде сложных таблиц. С этим типом словарей можно взаимодействовать с помощью REST API.
- В тип Словарь можно добавлять пары ключ–значение.
- Блок параметров Значения – содержит таблицу с данными словаря:
Для типа Словарь в блоке отображается перечень пар Ключ – Значение. Таблицу можно дополнять строками с помощью кнопки
. Удалить строки можно с помощью кнопки 
, которая отображается при наведении курсора мыши на нужную строку. В поле Ключ допустимо указать уникальное значение: максимум 128 символов в кодировке Unicode, первый символ не может быть $. В поле Значение допустимо указать значение: максимум 255 символов в кодировке Unicode, первый символ не может быть $. Допускается добавить одну или несколько пар Ключ – Значение.- Для типа Таблица в блоке отображается таблица с данными. Таблицу можно дополнять строками и столбцами с помощью кнопки . Удалить строки и столбцы можно с помощью кнопок , которые отображаются при наведении курсора мыши на нужную строку или заголовок нужного столбца. Заголовки столбцов доступны для редактирования.
Если словарь содержит больше 5000 записей, они не отображаются в веб-интерфейсе KUMA. Для просмотра содержимого таких словарей содержимое необходимо экспортировать в формат CSV. Если CSV-файл отредактировать и снова импортировать в KUMA, словарь будет обновлен.
- Для типа Таблица в блоке отображается таблица с данными. Таблицу можно дополнять строками и столбцами с помощью кнопки
Импорт и экспорт словарей
Данные словарей можно импортировать или экспортировать в формате CSV (в кодировке UTF-8) с помощью кнопок Импортировать CSV и Экспортировать CSV.
Формат CSV-файла зависит от типа словаря:
- Тип Словарь:
{КЛЮЧ},{ЗНАЧЕНИЕ}\n - Тип Таблица:
{Заголовок столбца 1},{Заголовок столбца N},{Заголовок столбца N+1}\n{Ключ1},{ЗначениеN},{ЗначениеN+1}\n{Ключ2},{ЗначениеN},{ЗначениеN+1}\nКлючи должны быть уникальными как для CSV-файла, так и для словаря. В таблицах ключи указываются в первом столбце. Ключ должен содержать от 1 до 128 символов в кодировке Unicode.
Значения должны содержать от нуля до 256 символов в кодировке Unicode.
При импорте содержимое словаря перезаписывается загружаемым файлом. При импорте в словарь также изменяется название ресурса, чтобы отразить имя импортированного файла.
При экспорте, если ключ или значение содержат символы запятой или кавычек (, и "), они заключаются в кавычки ("). Кроме того, символ кавычки (") экранируется дополнительной кавычкой (").
Если в импортируемом файле обнаружены некорректные строки (например, неверные разделители), то при импорте в словарь такие строки будут проигнорированы, а при импорте в таблицу процесс импорта будет прерван.
Взаимодействие со словарями через API
С помощью REST API можно считывать содержимое словарей типа Таблица, а также изменять его, даже если эти ресурсы используются активными сервисами. Это позволяет, например, настроить обогащение событий данными из динамически изменяемых таблиц, выгружаемых из сторонних приложений.
Предустановленные словари
В поставку KUMA включены перечисленные в таблице ниже словари.
Предустановленные словари
Название словаря | Тип | Описание |
[OOTB] Ahnlab. Severity | dictionary | Содержит таблицу соответствия между идентификатором приоритета и его названием. |
[OOTB] Ahnlab. SeverityOperational | dictionary | Содержит значения параметра SeverityOperational и соответствующее ему описание. |
[OOTB] Ahnlab. VendorAction | dictionary | Содержит таблицу соответствия между идентификатором выполняемой операции и её названием. |
[OOTB] Cisco ISE Message Codes | dictionary | Cодержит коды событий Cisco ISE и соотвествующие им имена. |
[OOTB] DNS. Opcodes | dictionary | Содержит таблицу соответствия между десятичными кодами операций DNS и их описаниями, зарегистрированными IANA. |
[OOTB] IANAProtocolNumbers | dictionary | Содержит номера портов транспортных протоколов (TCP, UDP) и соответствующие им имена сервисов, зарегистрированные IANA. |
[OOTB] Juniper - JUNOS | dictionary | Содержит идентификаторы событий JUNOS и соответствующие им описания. |
[OOTB] KEDR. AccountType | dictionary | Содержит идентификатор типа учетной записи и соответствующее ему наименование типа. |
[OOTB] KEDR. FileAttributes | dictionary | Cодержит идентификаторы атрибутов файлов, хранимые файловой системой, и соответствующие им описания. |
[OOTB] KEDR. FileOperationType | dictionary | Содержит идентификаторы операций с файлами из API KATA и соответствующие им названия операции. |
[OOTB] KEDR. FileType | dictionary | Содержит идентификаторы изменённого файла из API KATA и соответствующие им описания типов файлов. |
[OOTB] KEDR. IntegrityLevel | dictionary | Содержит SID параметра INTEGRITY LEVEL операционной системы Microsoft Windows и соответствующие им описания. |
[OOTB] KEDR. RegistryOperationType | dictionary | Содержит идентификаторы операций с реестром из API KATA и соответствующие им значения. |
[OOTB] Linux. Sycall types | dictionary | Содержит идентификаторы системных вызовов ОС Linux и соответствующие им названия. |
[OOTB] MariaDB Error Codes | dictionary | Словарь содержит коды ошибок СУБД MariaDB и используется нормализатором [OOTB] MariaDB Audit Plugin syslog для обогащения событий. |
[OOTB] Microsoft SQL Server codes | dictionary | Содержит идентификаторы ошибок MS SQL Server и соответствующие им описания. |
[OOTB] MS DHCP Event IDs Description | dictionary | Содержит идентификаторы событий DHCP сервера Microsoft Windows и соответствующие им описания. |
[OOTB] S-Terra. Dictionary MSG ID to Name | dictionary | Содержит идентификаторы событий устройств S-Terra и соответствующие им имена событий. |
[OOTB] S-Terra. MSG_ID to Severity | dictionary | Содержит идентификаторы событий устройств S-Terra и соответствующие им значения Severity. |
[OOTB] Syslog Priority To Facility and Severity | table | Таблица содержит значения Priority и соответствующие ему значения полей Facility and Severity. |
[OOTB] VipNet Coordinator Syslog Direction | dictionary | Содержит идентификаторы направления (последовательность специальных символов), используемые в ViPNet Coordinator для обозначения направления, и соответствующие им значения. |
[OOTB] Wallix EventClassId - DeviceAction | dictionary | Cодержит индентифкаторы событий Wallix AdminBastion и соответствующие им описания. |
[OOTB] Windows.Codes (4738) | dictionary | Содержит коды операции, присутствующие в событии аудита MS Windows с идентификатором 4738, и соотвествующие им имена. |
[OOTB] Windows.Codes (4719) | dictionary | Содержит коды операции, присутствующие в событии аудита MS Windows с идентификатором 4719, и соотвествующие им имена. |
[OOTB] Windows.Codes (4663) | dictionary | Содержит коды операции, присутствующие в событии аудита MS Windows с идентификатором 4663, и соотвествующие им имена. |
[OOTB] Windows.Codes (4662) | dictionary | Содержит коды операции, присутствующие в событии аудита MS Windows с идентификатором 4662, и соотвествующие им имена. |
[OOTB] Windows. EventIDs and Event Names mapping | dictionary | Содержит идентификаторы событий ОС Windows и соответствующие имена событий. |
[OOTB] Windows. FailureCodes (4625) | dictionary | Содержит идентификаторы из полей Failure Information\Status и Failure Information\Sub Status события 4625 Microsoft Windows и соответствующие им описания. |
[OOTB] Windows. ImpersonationLevels (4624) | dictionary | Содержит идентификаторы из поля Impersonation level событий с идентификатором 4624 Microsoft Windows и соответствующие им описания. |
[OOTB] Windows. KRB ResultCodes | dictionary | Содержит коды ошибок Kerberos v5 и соответствующие им описания. |
[OOTB] Windows. LogonTypes (Windows all events) | dictionary | Содержит идентификаторы типов входов пользователя и соответствующие им наименования. |
[OOTB] Windows_Terminal Server. EventIDs and Event Names mapping | dictionary | Содержит индентификаторы событий Microsoft Terminal Server и соотвествующие им имена. |
[OOTB] Windows. Validate Cred. Error Codes | dictionary | Содержит идентификаторы типов входов пользователя и соответствующие им наименования. |
[OOTB] ViPNet Coordinator Syslog Direction | dictionary | Содержит идентификаторы направления (последовательность специальных символов), используемые в ViPNet Coordinator для обозначения направления и соотвествующие им значения. |
[OOTB] Syslog Priority To Facility and Severity | table | Cодержит значения Priority и соотвествуюие ему значения полей Facility and Severity. |
