Команды для сервера Kaspersky Password Manager для бизнеса

Параметр

Описание

kpmctl modify

Windows: ACCEPT_EULA=1

Linux/Docker: --accept_eula=1

Значение по умолчанию — 0 (не принимается).

Принятие условий Лицензионного соглашения. Текст Лицензионного соглашения включен в дистрибутив Kaspersky Password Manager для бизнеса.

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

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

Нет

Windows: ACCEPT_PRIVACY_POLICY=1

Linux/Docker:

--accept_privacy_policy=1,

--accept_pp=1

Значение по умолчанию — 0 (не принимается).

Принятие Политики конфиденциальности. Текст Политики конфиденциальности включен в дистрибутив Kaspersky Password Manager для бизнеса.

Чтобы установить приложение или обновить версию приложения, вы должны принять Политику конфиденциальности.

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

Нет

Параметр

Описание

kpmctl modify

Windows: N/A

Linux:

--security_group,

--service_group,

--group_name

Значение по умолчанию null.

Docker: N/A

Название группы безопасности.

Максимальная длина составляет 256 символов.

Требуется только для Linux.

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

Нет

Windows: SERVICE_ACCOUNT_NAME

Linux:

--service_login,

--service_account_name,

--service_user,

--account_name

Для Linux: Поддерживаются только учетные записи типа User.

Docker: Не требуется.

Значение по умолчанию null.

Имя пользователя, под которым будет работать служба сервера Kaspersky Password Manager для бизнеса.

Максимальная длина составляет 256 символов.

Windows: Если параметр SERVICE_ACCOUNT_NAME не указан во время тихой установки, новая учетная запись службы создается автоматически.

Linux: Поддерживаются только учетные записи типа User.

* Обязательный параметр для Windows и Linux.

Нет

Windows: SERVICE_ACCOUNT_PWD

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

Linux/Docker: N/A

Значение по умолчанию null.

Пароль пользователя, под которым будет запускаться служба сервера Kaspersky Password Manager для бизнеса.

Для MSA аккаунтов (Managed Service Account) пароль не устанавливается.

Максимальная длина составляет 256 символов.

* Обязательный параметр для Windows.

Нет

Windows: Для Windows этот параметр можно задать только с помощью KpmCtl.

Linux/Docker: --use_http

Значение по умолчанию False (используется HTTPS).

По умолчанию сервер Kaspersky Password Manager для бизнеса настроен на использование протокола HTTPS. Укажите параметр --use_http=true , чтобы настроить сервер на использование HTTP.

Если указан параметр --use_http, параметры сертификата --tls_cert и --tls_pwd не требуются.

Да

Windows: KPM_SERVER_PORT

Значение по умолчанию – 3000.

Linux/Docker:

--server_port,

--app_port

Значение по умолчанию – 443.

Номер порта, используемый сервером Kaspersky Password Manager для бизнеса для приема HTTP или HTTPS соединений в зависимости от настроенного протокола.

Допустимые значения от 0 до 65535. Максимальная длина составляет 5 символов. Если оставить поле пустым, установщик будет использовать значение по умолчанию.

Допустимы только непустые значения.

Да

Windows: KPM_SERVER_CERT

Linux/Docker:

--tls_cert,

--tls_certificate_path,

--tls_cert_path,

--kpm_server_cert

Значение по умолчанию null.

Путь к файлу сертификата сервера (PFX) на устройстве.

Если указан параметр --use_http, этот параметр является необязательным. Если значение указано, оно сохраняется, но игнорируется, поскольку сервер Kaspersky Password Manager для бизнеса настроен на использование протокола HTTP.

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

* Обязательный, если сервер Kaspersky Password Manager для бизнеса настроен на использование HTTPS.

Да

Windows: KPM_SERVER_CERT_PWD

Linux/Docker:

--tls_pwd,

--tls_certificate_password,

--tls_cert_pwd,

--kpm_server_cert_pwd

Значение по умолчанию null.

Пароль для доступа к сертификату.

Если указан параметр --use_http, этот параметр является необязательным. Если значение указано, оно сохраняется, но игнорируется, поскольку сервер Kaspersky Password Manager для бизнеса настроен на использование протокола HTTP.

Максимальная длина составляет 2047 символов.

Да

Windows: ADMIN_AUTH_CERT

Linux/Docker: --admin_auth_cert

Значение по умолчанию null.

Путь к открытому сертификату аутентификации администратора (PEM/CER/DER).

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

Да

Параметр

Описание

kpmctl modify

Windows: DB_TYPE

Linux/Docker:

Этот параметр указывается в составе следующих параметров:

--connection_url,

--conn_url,

--db_url

Значение по умолчанию null.

Тип базы данных.

• MySQL – будет использоваться либо MySQL, либо MariaDB.
• MSSQL – будет использоваться Microsoft SQL Server.
• PostgreSQL – один из следующих вариантов:
  • PostgreSQL
  • Postgres Pro
  • Platform V Pangolin
  • Jatoba

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где postgresql - тип базы данных.

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

Да

Windows: DB_SERVER_NAME

Linux/Docker:

Этот параметр указывается в составе следующих параметров:

--connection_url,

--conn_url,

--db_url

Пустое значение недопустимо и приводит к ошибке.

Полное имя сервера базы данных или экземпляра СУБД.

Максимальная длина:

• Microsoft SQL Server: 270 символов
• MySQL или PostgreSQL: 253 символов

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где localhost - экземпляр базы данных.

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

Да

Windows: DB_NAME

Linux/Docker:

Этот параметр указывается в составе следующих параметров:

--connection_url,

--conn_url,

--db_url

Пустое значение недопустимо и приводит к ошибке.

Имя базы данных.

Максимальная длина:

• MySQL: 64 символов
• PostgreSQL: 63 символов
• Microsoft SQL Server: 128 символов

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где KpmDb - имя базы данных.

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

Да

Windows: DB_PORT

Linux/Docker:

Этот параметр указывается в составе следующих параметров:

--connection_url,

--conn_url,

--db_url

Значения по умолчанию:

• PostgreSQL: 5432
• MySQL: 3306
• Microsoft SQL Server: Порт не запрашивается.

Номер порта для подключения к базе данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где 5432 - номер порта.

Допустимые значения от 0 до 65535.

Да

Windows: DB_AUTH_TYPE

Linux/Docker:

Этот параметр указывается в составе следующих параметров: ConnectionStrings.ReadWriteConnection, ConnectionStrings.ReadOnlyConnection

Значения по умолчанию:

• Для Microsoft SQL Server: Windows
• Для других СУБД: SQLServer

Метод аутентификации для подключения к базе данных.

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

Да

Windows: DB_USER_NAME

Linux/Docker:

Этот параметр указывается в составе следующих параметров:

--connection_url,

--conn_url,

--db_url

Значение по умолчанию null.

Имя пользователя для подключения к базе данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где kpmuser - логин аккаунта.

Во время тихой установки специальные символы в логине необходимо экранировать.

* Обязательный, если для типа аутентификации базы данных установлено значение SQLServer.Если значение пустое, требуется авторизация в базе данных.

Да

Windows: DB_USER_PWD

Linux/Docker:

Этот параметр указывается в составе следующих параметров:

--connection_url,

--conn_url,

--db_url

Значение по умолчанию null.

Пароль для подключения к базе данных.

Пример:

postgresql://kpmuser:pwd@localhost:5432/KpmDb

где pwd - пароль аккаунта.

Во время тихой установки специальные символы в пароле необходимо экранировать.

Ограничение для MariaDB 10.11 или более поздних версий в Windows:

При установке под учетной записью locadmin установщик может принять недействительный или пустой пароль. Установка завершится, но службы Kaspersky Password Manager для бизнеса не запустятся.

Не используйте учетную запись root для аутентификации в MariaDB.

* Обязательный, если для типа аутентификации базы данных установлено значение SQLServer.

Если значение пустое, потребуется пароль к базе данных.

Да

Параметр

Описание

kpmctl modify

Windows: ENABLE_DOMAINAUTH

Linux/Docker:

--auth_schemas,

--authentication_schemas

Значение по умолчанию null или 0.

Указывает, используется ли доменная аутентификация клиентом Kaspersky Password Manager для бизнеса на сервере Kaspersky Password Manager для бизнеса.

Для Windows: Должен быть установлен в значение True, если оба параметра Enable OAuth и Enable Basic Auth имеют значение False. Если это условие не выполняется, установка из командной строки завершится с ошибкой.

В Linux/Docker для доменной аутентификации используется Kerberos. Адрес сервера Kaspersky Password Manager для бизнеса, указанный в клиентском приложении Kaspersky Password Manager для бизнеса, должен совпадать с SPN службы. Использование IP-адреса или альтернативного DNS-имени, не зарегистрированного в SPN, приводит к ошибке аутентификации.

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

Да

Windows: ENABLE_BASICAUTH

Linux/Docker:

--auth_schemas,

--authentication_schemas

Значение по умолчанию null или 0.

Указывает, используется ли базовая аутентификация (аккаунт Kaspersky Password Manager для бизнеса) клиентом Kaspersky Password Manager для бизнеса на сервере Kaspersky Password Manager для бизнеса.

Для Windows: Должен быть установлен в значение True, если оба параметра Enable Domain Auth и Enable OAuth имеют значение False. Если это условие не выполняется, установка из командной строки завершится с ошибкой.

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

Да

Windows: ENABLE_OAUTH

Linux/Docker:

--auth_schemas,

--authentication_schemas

Значение по умолчанию null или 0.

Указывает, используется ли SSO-аутентификация клиентом Kaspersky Password Manager для бизнеса на сервере Kaspersky Password Manager для бизнеса.

Для Windows: Должен быть установлен в значение True, если оба параметра Enable Domain Auth и Enable Basic Auth имеют значение False. Если это условие не выполняется, установка из командной строки завершится с ошибкой.

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

Да

Windows: AUTHORITY

Linux/Docker: --oauth_authority

Значение по умолчанию null.

URL-адрес AD FS (Active Directory Federation Services).

Обязателен, если Enable OAuth = True. Если установлено значение False, этот параметр игнорируется.

Максимальная длина составляет 256 символов.

Для успешного подключения установщика к серверу ADFS необходимо установить корневой сертификат выбранного сервера ADFS в хранилище Trusted Root Certification Authorities на текущем устройстве.

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

Да

Windows: AUDIENCE

Linux/Docker: --oauth_audience

Значение по умолчанию null.

URL-адрес клиентского приложения.

Обязателен, если Enable OAuth = True. Если установлено значение False, этот параметр игнорируется.

Максимальная длина составляет 256 символов.

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

Да

Параметр

Описание

kpmctl modify

Windows: LDAP_ENFORCE_USERS_STATUS_CHECK

Linux/Docker: --ldap_enforce_users_status_check

Значение по умолчанию 0.

Указывает, используется ли LDAP для хранения информации об аккаунтах пользователей Kaspersky Password Manager для бизнеса.

Нет

Windows: LDAP_DOMAIN

Linux/Docker:

Параметр указывается в составе следующего параметра:

--ldap_url

Значение по умолчанию null.

Домен LDAP сервера.

Пример:

--ldap_url="ldaps://luser:lpass@ldapserver.ru:636/dc=avp,dc=ru"

где dc=avp,dc=ru - домены LDAP сервера.

Обязателен, если LDAP Enforce Users Status Check = True.

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

Да

Windows: LDAP_SERVER

Linux/Docker:

Параметр указывается в составе следующего параметра:

--ldap_url

Значение по умолчанию null.

Адрес LDAP сервера.

Пример:

--ldap_url="ldaps://luser:lpass@ldapserver.ru:636/dc=avp,dc=ru"

где ldapserver.ru - адрес сервера LDAP.

Обязателен, если LDAP Enforce Users Status Check = True.

Максимальная длина составляет 256 символов.

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

Да

Windows: LDAP_USE_SSL

Linux/Docker:

Параметр указывается в составе следующего параметра:

--ldap_url

Значение по умолчанию 1 (True).

Указывает, нужно ли использовать шифрование SSL.

Пример:

--ldap_url="ldaps://luser:lpass@ldapserver.ru:636/dc=avp,dc=ru"

где буква 's' в ldaps означает, что SSL включен.

Обязателен, если LDAP Enforce Users Status Check = True.

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

Да

Windows: LDAP_SERVER_PORT

Linux/Docker:

Параметр указывается в составе следующего параметра:

--ldap_url

Значения по умолчанию:

• 636 если Use SSL = True
• 389 если Use SSL = False

Номер порта для подключения к серверу LDAP.

Пример:

--ldap_url="ldaps://luser:lpass@ldapserver.ru:636/dc=avp,dc=ru"

где 636 - номер порта.

Обязателен, если LDAP Enforce Users Status Check = True.

Допустимые значения от 0 до 65535. Максимальная длина составляет 5 символов. Если оставить поле пустым, установщик будет использовать значение по умолчанию.

Да

Windows: LDAP_AUTH_TYPE

Linux/Docker:

--ldap_auth_type,

--ldap_authentication_type,

--ldap_auth

Значение по умолчанию null.

Тип авторизации сервера Kaspersky Password Manager для бизнеса на сервере LDAP.

Обязателен, если LDAP Enforce Users Status Check = True.

Возможные значения: Basic, Negotiate, Anonymous.

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

Да

Windows: LDAP_USER_NAME

Linux/Docker:

Параметр указывается в составе следующего параметра:

--ldap_url

Значение по умолчанию null.

Имя аккаунта, под которым сервер Kaspersky Password Manager для бизнеса будет аутентифицироваться на сервере LDAP.

Обязателен, если LDAP Auth Type = Basic.

Имя аккаунта необходимо указывать без доменной части. Поддерживаемый формат: username. Не поддерживаются: username@domain, domain\username, и Distinguished Name (DN). Неверный формат приведет к ошибке "Не удалось подключиться к серверу LDAP".

Для Linux: Специальные символы в имени аккаунта необходимо экранировать.

Пример:

--ldap_url="ldaps://luser:lpass@ldapserver.ru:636/dc=avp,dc=ru"

где luser - имя пользователя LDAP.

Максимальная длина составляет 256 символов.

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

Да

Windows: LDAP_USER_PWD

Linux/Docker:

Параметр указывается в составе следующего параметра:

--ldap_url

Значение по умолчанию null.

Пароль для аккаунта, под которым сервер Kaspersky Password Manager для бизнеса будет аутентифицироваться на сервере LDAP.

Обязателен, если LDAP Auth Type = Basic.

Для Linux: Специальные символы в пароле необходимо экранировать.

Пример:

--ldap_url="ldaps://luser:lpass@ldapserver.ru:636/dc=avp,dc=ru"

где lpass - пароль пользователя LDAP.

Максимальная длина составляет 256 символов.

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

Да

Windows: LDAP_SKIP_BIND_CHECK

Linux/Docker: N/A

Значение по умолчанию 0 (False).

kpmctl modify: --ldap_skip_bind_check

Определяет, выполняется ли проверка подключения и аутентификации к LDAP-серверу во время установки сервера Kaspersky Password Manager для бизнеса.

Если параметр указан:

• Установка не блокируется из-за недоступности LDAP.
• Сценарии проверки LDAP-соединения не выполняются.
• Корректность настроек LDAP после установки сервера не гарантируется.

Возможные значения:

--ldap_skip_bind_check или --ldap_skip_bind_check=True

--ldap_skip_bind_check=False

Да

Параметр

Описание

kpmctl modify

Windows: SMTP_SENDER_EMAIL

Linux/Docker: --smtp_sender_email

Значение по умолчанию null.

Адрес электронной почты отправителя писем (поле ОТ), которые будут отправляться пользователям с сервера Kaspersky Password Manager для бизнеса.

Максимальная длина составляет 254 символов.

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

Да

Windows: SMTP_SERVER

Linux/Docker:

Параметр указывается в составе следующего параметра:

--smtp_url

Значение по умолчанию null.

Адрес SMTP сервера.

Пример:

--smtp_url="smtps://suser:spass@mailserver.local:587/"

где mailserver.local - адрес SMTP сервера.

Укажите IP-адрес сервера или полное доменное имя (FQDN).

Максимальная длина составляет 254 символов.

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

Да

Windows: SMTP_USE_SSL

Linux/Docker:

Параметр указывается в составе следующего параметра:

--smtp_url

Значение по умолчанию 1 (True).

Указывает, нужно ли использовать шифрование SSL.

Пример:

--smtp_url="smtps://suser:spass@mailserver.local:587/"

где буква 's' в smtps означает, что SSL включен.

Да

Windows: SMTP_SERVER_PORT

Linux/Docker:

Параметр указывается в составе следующего параметра:

--smtp_url

Значения по умолчанию:

• 465 если Use SSL = True
• 25 если Use SSL = False

Номер порта для подключения к серверу SMTP.

Пример:

--smtp_url="smtps://suser:spass@mailserver.local:587/"

где 587 - номер порта.

Допустимые значения от 0 до 65535. Максимальная длина составляет 5 символов. Если оставить поле пустым, установщик будет использовать значение по умолчанию.

Да

Windows: SMTP_AUTH_TYPE

Linux/Docker:

--smtp_auth_type,

--smtp_authentication_type,

–--smtp_auth

Значение по умолчанию null.

Тип авторизации сервера Kaspersky Password Manager для бизнеса на сервере SMTP.

Для Windows: Всегда требуется.

Для Linux/Docker: Требуется, если указан хотя бы один параметр, включенный в --ldap_url.

Возможные значения: Basic, Negotiate, Anonymous.

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

Да

Windows: SMTP_USER_NAME

Linux/Docker:

Параметр указывается в составе следующего параметра:

--smtp_url

Значение по умолчанию null.

Имя аккаунта, под которым сервер Kaspersky Password Manager для бизнеса будет аутентифицироваться на сервере LDAP.

Обязателен, если SMTP Auth Type = Basic.

Для Linux: Специальные символы в имени аккаунта необходимо экранировать.

Максимальная длина составляет 256 символов.

Пример:

--smtp_url="smtps://suser:spass@mailserver.local:587/"

где suser - имя пользователя SMTP.

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

Да

Windows: SMTP_USER_PWD

Linux/Docker:

Параметр указывается в составе следующего параметра:

--smtp_url

Значение по умолчанию null.

Пароль для аккаунта, под которым сервер Kaspersky Password Manager для бизнеса будет аутентифицироваться на сервере LDAP.

Обязателен, если SMTP Auth Type = Basic.

Для Linux: Специальные символы в пароле необходимо экранировать.

Максимальная длина составляет 256 символов.

Пример:

--smtp_url="smtps://suser:spass@mailserver.local:587/"

где suser пароль пользователя SMTP.

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

Да

Windows: SMTP_SKIP_CONNECTION_CHECK

Linux/Docker: N/A

Значение по умолчанию 0 (False).

kpmctl modify: --smtp_skip_connection_check

Определяет, выполняется ли проверка подключения и аутентификации к SMTP-серверу во время установки сервера Kaspersky Password Manager для бизнеса.

Если параметр указан:

• Установка не блокируется из-за недоступности SMTP.
• Сценарии проверки SMTP-соединения не выполняются.
• Корректность настроек SMTP после установки сервера не гарантируется.

Возможные значения:

• --smtp_skip_connection_check или --smtp_skip_connection_check=True
• --smtp_skip_connection_check=False

Да

Параметр

Описание

kpmctl modify

Windows: SETTINGS_PICKUP

Linux/Docker: --settings_pickup

Значение по умолчанию 0 (False).

При значении 1 этот параметр применяет настройки из резервной копии.

Возможные значения:

• 1 – Восстанавливать автоматически.
• 0 или null – Не восстанавливать.

Установка завершится с ошибкой, если:

• Параметр может принимать любое значение, отличное от 0 или 1, либо значение не указывается.
• Параметр установлен на 1, но файл резервной копии не найден.

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

Нет

Windows: BACKUP_PATH

Linux/Docker: --backup_path

Значение по умолчанию 0 (False).

Путь к файлу резервной копии.

Требуется, если Settings Pickup = 1. Если Settings Pickup = 0, параметр игнорируется.

Файл по указанному пути должен существовать и представлять собой действительный ZIP-архив (проверяются его структура, целостность и содержимое).

Максимальная длина составляет от 3 до 256 символов.

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

Нет

Windows: BACKUP_ENABLED

Linux/Docker: N/A

Значение по умолчанию 0 (False).

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

Возможные значения:

• 1 – Сохранить.
• Любое другое значение, или если параметр равен null – Не сохранять.

Нет

Windows: BACKUP_PASSWORD

Linux/Docker: --backup_password

Значение по умолчанию null.

Пароль для резервной копии настроек.

Требуется для импорта резервной копии, защищенной паролем.

Максимальная длина составляет от 0 до 64 символов.

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

Нет

Параметр

Описание

kpmctl modify

Windows: /qn , /quiet

Linux/Docker: --silent

Значение по умолчанию 0 (False).

Запускает установку приложения в тихом режиме.

Нет

Windows: INSTALL_LICENSING

Linux/Docker: --install_licensing

При установке в Windows, Linux и Docker через командную строку значение равно null.

Контролирует установку службы лицензирования на текущее устройство.

Возможные значения:

• 1 – Установить службу лицензирования на этом сервере.
• Любое другое значение или если параметр равен null – не устанавливать службу лицензирования.

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

Нет

Хост службы лицензирования

Windows: N/A

Linux/Docker: N/A

Значение по умолчанию localhost.

Адрес службы лицензирования.

Нет

Порт службы лицензирования

Windows: N/A

Linux/Docker: N/A

Значение по умолчанию 48093.

Порт службы лицензирования.

Нет

Windows: LOGS_PATH

Linux/Docker: N/A

Информацию о значениях по умолчанию см. в статье.

Путь к файлу журнала.

Если путь не указан, используется значение по умолчанию. Если указанный каталог не существует, установщик создаст его автоматически.

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

Нет

Windows: ORGANIZATION_PWD

Linux/Docker: --organization_pwd

Значение по умолчанию null.

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

Пароль организации должен соответствовать требованиям генерации мастер-пароля по умолчанию (длинна 16 символов, включая специальные символы, заглавные и строчные буквы, цифры).

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

Нет