PP.Util

PP.Util - это консольное приложение в составе «Форсайт. Аналитическая платформа», выполняющее различные вспомогательные действия при настройке BI-сервера. Приложение входит в состав продукта «Форсайт. Аналитическая платформа» и расположено:

Для запуска приложения в ОС Linux используйте скрипт PP.Util_start.sh. Один запуск приложения может выполнять только одно из выбранных действий. Необходимое действие выбирается путём указания соответствующего набора параметров.

Запуск приложения PP.Util должен осуществляться под тем же пользователем, под которым будет выполняться работа BI-сервера:

В ОС Windows при установке BI-сервера на веб-сервер IIS по умолчанию пул приложения будет запускаться под учётной записью Network Service.

Описание наборов параметров

Для просмотра консольной справки по доступным наборам параметров в ОС Linux запустите скрипт PP.Util_start.sh без параметров. Необязательные параметры будут указаны в квадратных скобках. При указании набора параметров в синтаксисе приложения квадратные скобки не используются.

Параметры:

/create_audit_user metabase_id login password audit_login audit_password [db_login [db_password]]

Создание учётных данных служебного пользователя подсистемы безопасности на сервере базы данных.

metabase_id. Идентификатор репозитория. Обязательный параметр;

Примечание. Репозиторий с указанным идентификатором должен содержаться в списке репозиториев. Если в настройках подключения к репозиторию указана пользовательская схема, то учётные данные служебного пользователя будут созданы для неё.

login. Имя владельца схемы ADMIN для подключения к репозиторию. Обязательный параметр;
password. Пароль владельца схемы ADMIN для подключения к репозиторию. Обязательный параметр;
audit_login. Имя создаваемого служебного пользователя. Обязательный параметр;

Примечание. Имя служебного пользователя P4AUDIT зарезервировано системой и недоступно для использования.

audit_password. Пароль создаваемого служебного пользователя. Обязательный параметр;
db_login. Имя пользователя базы данных, у которого есть привилегии на создание пользователей в СУБД. Необязательный параметр. Если имя пользователя не указано, то оно будет запрошено в интерактивном режиме;
db_password. Пароль пользователя базы данных, у которого есть привилегии на создание пользователей в СУБД. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

После выполнения действий будут созданы учётные данные служебного пользователя на сервере базы данных.

Пример:

/create_audit_user REPOSITORY_ID USER_NAME USER_PASSWORD SERVICE_USER_NAME SERVICE_USER_PASSWORD

Параметры:

/save_audit_creds [/ALG enc_alg] [/SCOPE scope] [realm|/DC] login [password]

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

enc_alg. Алгоритм шифрования, который будет применяться при шифровании учётных данных:

gos. По умолчанию. Используется шифрование алгоритмом GOST R 34.11-2012;
pro. Используется шифрование с помощью Data Protection API (DPAPI) в ОС Windows. Данный алгоритм шифрования недоступен для ОС Linux;
sim. Учётные данные сохраняются в открытом виде.

Важно. Для обеспечения безопасности в промышленной эксплуатации продукта «Форсайт. Аналитическая платформа» используйте значение gos или pro.

Необязательный параметр. Если параметр не задан, то используется значение по умолчанию;

scope. Способ сохранения учётных данных:

hkcu. Только для текущего пользователя. Учётные данные будут храниться в ветке реестра текущего пользователя [HKEY_CURRENT_USER\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\Audit\Credentials\Item0] и доступны для использования только текущему пользователю на компьютере;

hklm. Для всех пользователей. Учётные данные будут храниться в ветке реестра локальной машины [HKEY_LOCAL_MACHINE\SOFTWARE\Foresight\Foresight Analytics Platform\10.0\Audit\Credentials\Item0] и доступны для использования всем пользователям на компьютере;

file. По умолчанию. В файл settings.xml.

В ОС Windows учётные данные будут храниться в файле settings.xml, расположенном по пути %PROGRAMDATA%\Foresight\Foresight Analytics Platform.

Примечание. По умолчанию папка ProgramData скрыта в операционной системе.

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

Необязательный параметр, используется только в ОС Windows. Если параметр не задан, то используется значение по умолчанию.

В ОС Linux учётные данные могут храниться только в файле settings.xml, расположенном по пути /opt/foresight/fp10.x-biserver/etc.

realm|/DC. Область действия учётных данных служебного пользователя. Выберите один из способов:

realm. Если в списке репозиториев содержится более одного репозитория и учётные данные служебного пользователя должны отличаться для каждого из них, то задайте идентификатор вида «SERVER_DATABASE|TYPE» для сервера базы данных, указанного в настройках подключения к конкретному репозиторию, где:

SERVER_DATABASE. IP-адрес или псевдоним, под которым зарегистрирован сервер базы данных;

Примечание. При настройке подключения к репозиторию на каждом клиентском компьютере или на компьютере с установленным BI-сервером IP-адрес или псевдоним сервера должен совпадать с сервером, указанным в параметре SERVER_DATABASE.

TYPE. Тип используемого драйвера. Допустимы следующие значения: «POSTGRES», «MSSQL», «ORCL»;

Например: "127.0.0.1|POSTGRES".

Примечание. Для избежания синтаксических ошибок значение задаётся в верхних двойных кавычках.

/DC. Если в списке репозиториев содержится один или более репозиториев, но учётные данные служебного пользователя должны быть одинаковыми для всех репозиториев, то используйте данный параметр без указания дополнительных настроек.

Обязательный параметр;

login. Имя существующего служебного пользователя. Обязательный параметр, является регистрозависимым;
password. Пароль существующего служебного пользователя. Необязательный параметр, является регистрозависимым. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Примечание. Параметр /save_audit_creds можно использовать в сокращенном виде - /sac.

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

Примеры:

в ОС Linux:

/save_audit_creds /DC SERVICE_USER_NAME SERVICE_USER_PASSWORD

в ОС Windows:

/save_audit_creds /SCOPE hkcu "10.30.210.10|POSTGRES" SERVICE_USER_NAME SERVICE_USER_PASSWORD

Параметры:

/save_creds [/ALG enc_alg] metabase_id [/DC|/GC] login [password]

Сохранение учётных данных в настройках подключения к репозиторию. Учётные данные сохраняются в зашифрованном виде в подразделе реестра, где хранятся настройки подключения к репозиторию.

enc_alg. Алгоритм шифрования, который будет применяться при шифровании учётных данных:

gos. По умолчанию. Используется шифрование алгоритмом GOST R 34.11-2012;
pro. Используется шифрование с помощью Data Protection API (DPAPI) в ОС Windows. Данный алгоритм шифрования недоступен для ОС Linux;
sim. Учётные данные сохраняются в открытом виде.

Необязательный параметр. Если параметр не задан, то используется значение по умолчанию;

metabase_id. Идентификатор репозитория. Обязательный параметр;
/DC|/GC. Назначение учётных данных. Выберите один из способов:

/DC. Учётные данные для подключения к репозиторию по умолчанию;
/GC. Учётные данные для гостевого подключения к репозиторию.

Необязательный параметр. Если параметр не задан, то используются учётные данные пользователя, заданные в параметрах login и password;

Примечание. Параметр не должен использоваться при сохранении учётных данных владельца схемы, если предполагается использование встроенной авторизации.

login. Имя пользователя для подключения к репозиторию. Обязательный параметр;
password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Примечание. Параметр /save_creds можно использовать в сокращенном виде - /sc.

Пример:

/save_creds REPOSITORY_ID /DC USER_NAME USER_PASSWORD

Параметры:

/encrypt_creds login [password]

Шифрование имени пользователя и пароля с использованием алгоритма GOST R 34.11-2012 и вывод полученных значений в консоль. Результатом работы команды будет пара атрибутов: Crs и Crsa. Данные атрибуты с зашифрованными учётными данными могут использоваться в файле settings.xml или реестре при настройке подключения к службе каталогов LDAP-сервера и при настройке аутентификации на сервере состояний.

login. Имя пользователя. Обязательный параметр;
password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Примечание. Параметр /encrypt_creds можно использовать в сокращенном виде - /ec.

Пример:

/encrypt_creds USER_NAME USER_PASSWORD

Параметры:

/save_cert cert_file metabase_id login [password]

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

cert_file. Абсолютный или относительный путь к файлу с сертификатом безопасности. Обязательный параметр;
metabase_id. Идентификатор репозитория. Обязательный параметр;
login. Имя пользователя для подключения к репозиторию. Обязательный параметр;
password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Примечание. Параметр /save_cert можно использовать в сокращенном виде - /ce.

Пример:

/save_cert /tmp/server.cer REPOSITORY_ID USER_NAME USER_PASSWORD

Параметры:

/save_private_key key_file cert_id [enc_alg]

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

key_file. Абсолютный или относительный путь к файлу с закрытым ключом. Обязательный параметр;
cert_id. Идентификатор сертификата безопасности в репозитории. Обязательный параметр. Данный идентификатор будет получен после выполнения команды «/save_cert»;
enc_alg. Алгоритм шифрования, который будет применяться при шифровании файла с закрытым ключом перед сохранением в реестре:

gos. По умолчанию. Используется шифрование алгоритмом GOST R 34.11-2012;
pro. Используется шифрование с помощью Data Protection API (DPAPI) в ОС Windows. Данный алгоритм шифрования недоступен для ОС Linux;
sim. Данные закрытого ключа сохраняются в открытом виде без шифрования.

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

Пример:

/save_private_key /tmp/server.key SERVER gos

Параметры:

/create_svclog_tables database_id metabase_id login [password [db_login [db_password]]]

Создание системных таблиц репозитория для хранения лога выполнения операций. Таблицы создаются как на физическом уровне (на сервере СУБД), так и на уровне репозитория (объекты репозитория - Таблица).

database_id. Идентификатор объекта «База данных», на который будут настроены создаваемые в репозитории таблицы. Обязательный параметр;
metabase_id. Идентификатор репозитория, в котором будут созданы таблицы. Обязательный параметр;
login. Имя пользователя для подключения к репозиторию. Обязательный параметр;
password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме;
db_login. Имя пользователя для авторизации при подключении к базе данных, указанной в параметре database_id. Необязательный параметр. Если имя пользователя не указано, то он будет запрошен в интерактивном режиме;
db_password. Пароль пользователя для авторизации при подключении к базе данных, указанной в параметре database_id. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Примечание. Учётные данные db_login, db_password указываются, если это обусловлено настройками соответствующей базы данных в репозитории.

Пример:

/create_svclog_tables OBJ_DB REPOSITORY_ID USER_NAME USER_PASSWORD DB_USER_NAME DB_USER_PASSWORD

Параметры:

/clear_svclog_tables metabase_id login [password [db_login [db_password]]]

Очистка системных таблиц репозитория с логами выполнения операций.

metabase_id. Идентификатор репозитория. Обязательный параметр;
login. Имя пользователя для подключения к репозиторию. Обязательный параметр;
password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме;
db_login. Имя пользователя для авторизации при подключении к базе данных, указанной в параметре database_id. Необязательный параметр. Если имя пользователя не указано, то он будет запрошен в интерактивном режиме;
db_password. Пароль пользователя для авторизации при подключении к базе данных, указанной в параметре database_id. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Пример:

/clear_svclog_tables REPOSITORY_ID USER_NAME USER_PASSWORD DB_USER_NAME DB_USER_PASSWORD

Параметры:

/iisdiag [/C] metabase_id login [password]

Проверка типовых проблем установки BI-сервера на IIS.

/C. Не проверять настройки, задаваемые в IIS, проверять только те настройки, которые производит инсталлятор при установке BI-сервера.

Необязательный параметр. Если параметр не задан, то выполняется проверка настроек, заданных в IIS, и настроек BI-сервера;

metabase_id. Идентификатор репозитория. Обязательный параметр;

login. Имя пользователя для подключения к репозиторию. Обязательный параметр;
password. Пароль пользователя. Необязательный параметр. Если пароль не указан, то он будет запрошен в интерактивном режиме.

Пример:

/iisdiag /C REPOSITORY_ID USER_NAME USER_PASSWORD

Примечание. Если с помощью PP.Util были сохранены учётные данные и после этого был изменён пароль пользователя операционной системы, под которым работает BI-сервер, то заново пересохраните все учётные данные.

При использовании наборов параметров create_audit_user, save_cert, create_svclog_tables, clear_svclog_tables запрашивается единица лицензирования AnalyticsPlatform. В ОС Linux укажите системную переменную LSFORCEHOST или LSHOST одним из способов:

sudo LSFORCEHOST=<имя сервера лицензий или NO-NET> /opt/foresight/fp10.x-biserver/bin/PP.Util_start.sh /create_audit_user REPOSITORY_ID USER_NAME USER_PASSWORD SERVICE_USER_NAME SERVICE_USER_PASSWORD

sudo -E /opt/foresight/fp10.x-biserver/bin/PP.Util_start.sh /create_audit_user REPOSITORY_ID USER_NAME USER_PASSWORD SERVICE_USER_NAME SERVICE_USER_PASSWORD

Для получения подробной информации о переменных LSFORCEHOST и LSHOST обратитесь к подразделу «Работа с сервером лицензий».