Интерфейс командной строки серверной части Termidesk Profiles

Утилита trp_cli

Утилита trp_cli используется для настройки серверной части Termidesk Profiles из интерфейса командной строки.

Доступные команды утилиты trp_cli приведены в таблице (см. таблицу Список доступных команд утилиты trp_cli).

Таблица 1. Список доступных команд утилиты trp_cli
Параметр Описание

--help

Вывод справки по использованию аргументов командной строки.

Для вызова справки нужно выполнить:

sudo /opt/termidesk/trp-server/sbin/trp_cli --help

--version

Вывод версии приложения.

Для вывода версии нужно выполнить:

sudo /opt/termidesk/trp-server/sbin/trp_cli --version

--admin-username, -U

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

При использовании домена аутентификации MS AD учетная запись администратора указывается в формате UPN (admin@domain.local) или в формате короткого имени учетной записи (admin).

При использовании домена аутентификации OIDC формат учетной записи администратора зависит от используемой службы идентификации IdP. Например:

  • при использовании Keycloak указывается имя учетной записи (admin);

  • при использовании Google указывается адрес электронной почты (admin@idp.local).

Пример использования:

sudo /opt/termidesk/trp-server/sbin/trp_cli --admin-username <admin@domain.local>

config

Управление системными настройками серверной части Termidesk Profiles.

Управление параметрами конфигурирования доступно только авторизованному пользователю ОС, являющегося членом группы termidesk.

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

Поддерживаются подкоманды:

  • list - вывод конфигурационных параметров и их значений;

  • update - обновление значения параметра.

Подкоманда list принимает аргументы:

  • -s - секция.

Подкоманда update принимает аргументы:

  • -s - секция;

  • -k - ключ;

  • -v - значение.

Пример использования:

sudo /opt/termidesk/trp-server/sbin/trp_cli config update -s general -k nbds.nbds_max -v 32

passphrase

Получение пароля преобразованного образа Перемещаемого Профиля пользователя.

Команда passphrase принимает аргументы:

  • -u - имя пользователя в домене аутентификации MS AD;

  • -d - имя домена аутентификации MS AD;

  • -i - наименование преобразованного образа.

Пример использования:

sudo /opt/termidesk/trp-server/sbin/trp_cli passphrase -u <username> -d <domain.local> -i <win10>
Таблица 2. Перечень доступных параметров для управления системными настройками
Параметр Описание

Секция audit

audit.file.enable

Управление сохранением событий аудита серверной части Termidesk Profiles в файл журнала.

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

  • «True» - записывать сообщения в файл журнала;

  • «False» - не записывать сообщения в файл журнала

audit.file.path

Путь к файлу журнала серверной части Termidesk Profiles

audit.file.backup_count

Количество резервных копий файла журнала

audit.file.max_size

Максимальный размер (в байтах) файла журнала

audit.database.enable

Управление сохранением событий аудита серверной части Termidesk Profiles в БД.

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

  • «True» - записывать сообщения в БД;

  • «False» - не записывать сообщения в БД

audit.database.record_ttl

Время хранения (в сутках) событий аудита серверной части Termidesk Profiles в БД

audit.syslog.enable

Управление перенаправлением потока событий аудита серверной части Termidesk Profiles на отдельный syslog-сервер.

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

  • «True» - перенаправлять сообщения на отдельный syslog-сервер;

  • «False» - не перенаправлять сообщения на отдельный syslog-сервер

audit.syslog.addresses

IP-адреса или имена узлов, на которых развернута служба syslog-сервера

audit.syslog.socktype

Выбор протокола работы для службы syslog-сервера.

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

  • «UDP»;

  • «TCP»;

  • «TLS»

audit.syslog.facility

Категория сообщений syslog для их классификации при передаче в журнал мониторинга

Секция general

nbds.nbds_max

Максимальное количество шаблонов и базовых образов Перемещаемого Профиля, доступных для одновременной настройки и подключения

nbds.max_part

Максимальное количество разделов шаблона или базового образа Перемещаемого Профиля, доступных для одновременного монтирования

server.url

IP-адрес или FQDN для подключения к серверной части Termidesk Profiles

server.port

Порт для подключения к серверной части Termidesk Profiles

tasks.storage_mount.interval

Периодичность (в секундах) проверок состояния монтирования хранилища

tasks.storage_mount.repetitions

Количество проверок состояния монтирования хранилища

tasks.nbd_sync.interval

Периодичность (в секундах) проверок соответствия доступного количества NBD для подключения шаблонов и базовых образов Перемещаемого профиля значению параметра nbds.nbds_max

tasks.nbd_sync.repetitions

Количество проверок соответствия доступного количества NBD для подключения шаблонов и базовых образов Перемещаемого Профиля значению параметра nbds.nbds_max

Секция monitoring

logging.level

Минимальный уровень событий, записываемых в журнал мониторинга.

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

  • «ERROR»;

  • «WARNING»;

  • «INFO»;

  • «DEBUG»

logging.file.enable

Управление сохранением событий серверной части Termidesk Profiles в файл журнала.

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

  • «True» - записывать сообщения в файл журнала;

  • «False» - не записывать сообщения в файл журнала

logging.file.path

Путь к файлу журнала серверной части Termidesk Profiles

logging.file.backup_count

Количество резервных копий файла журнала

logging.file.max_size

Максимальный размер (в байтах) файла журнала

logging.database.enable

Управление сохранением событий серверной части Termidesk Profiles в БД.

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

  • «True» - записывать сообщения в БД;

  • «False» - не записывать сообщения в БД

logging.database.record_ttl

Время хранения (в сутках) событий серверной части Termidesk Profiles в БД

logging.syslog.enable

Управление перенаправлением потока событий серверной части Termidesk Profiles на отдельный syslog-сервер.

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

  • «True» - перенаправлять сообщения на отдельный syslog-сервер;

  • «False» - не перенаправлять сообщения на отдельный syslog-сервер

logging.syslog.addresses

IP-адреса или имена узлов, на которых развернута служба syslog-сервера

logging.syslog.socktype

Выбор протокола работы для службы syslog-сервера.

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

  • «UDP»;

  • «TCP»;

  • «TLS»

logging.syslog.facility

Категория сообщений syslog для их классификации при передаче в журнал мониторинга

Секция security

server.schema_url

Протокол для подключения к серверной части Termidesk Profiles

server.cert_key

Путь к ключу сертификата для защищенного подключения к серверной части Termidesk Profiles

server.cert_path

Путь к файлу сертификата для защищенного подключения к серверной части Termidesk Profiles

cors.allowed_origins

Список разрешенных источников для взаимодействия с API серверной части.

Пример использования:

sudo /opt/termidesk/trp-server/sbin/trp_cli config update -s security -k cors.allowed_origins -v "['*']"

cors.allowed_methods

Список разрешенных запросов для взаимодействия с API серверной части.

Возможные значения: «"GET"», «"POST"», «"PUT"», «"DELETE"», «"OPTIONS"», «"PATCH"»

Пример использования:

sudo /opt/termidesk/trp-server/sbin/trp_cli config update -s security -k cors.allowed_methods -v "['GET', 'POST']"

cors.allowed_headers

Список разрешенных заголовков для взаимодействия с API серверной части.

Пример использования:

sudo /opt/termidesk/trp-server/sbin/trp_cli config update -s security -k cors.allowed_headers -v "['*']"

cors.allow_credentials

Разрешение передачи учетных данных при взаимодействии с API серверной части.

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

  • «True» - разрешить передачу;

  • «False» - запретить передачу.

Пример использования:

sudo /opt/termidesk/trp-server/sbin/trp_cli config update -s security -k cors.allow_credentials -v True

cors.max_age

Время (в секундах) кэширования результатов проверки CORS API серверной части

Пример использования:

sudo /opt/termidesk/trp-server/sbin/trp_cli config update -s security -k cors.max_age -v 86400