Переменные окружения и аргументы командной строки Агентов

Переменные окружения и другие параметры конфигурирования

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

Для включения переопределения значений параметров Агента ВРМ через переменные окружения используются два способа:

  • активация параметра «Разрешить переопределение значений через переменные окружения» в графическом интерфейсе Агента ВРМ. Для ОС Linux должен быть задан файл с перечислением переменных окружения и их значениями /etc/default/termidesk-agent;

  • или назначение параметру env значения True в конфигурационном файле /etc/termidesk/agent.cfg. Для ОС Linux должен быть задан файл с перечислением переменных окружения и их значениями /etc/default/termidesk-agent.

Для других Агентов дополнительные действия не требуются.

В ОС Microsoft Windows задание настроек Агента ВРМ может быть выполнено из командной строки. Для этого:

  • открыть командную строку от имени администратора;

  • вызывать Агент ВРМ из каталога C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe;

  • выполнить:

"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" update --host 192.0.2.30 --key 0123456789 --loglevel 20000 --httpd-port=43900

где:

--host 192.0.2.30 - IP-адрес компонента «Универсальный диспетчер» («Портала администратора»);

--key 0123456789 - значение мастер-ключа для подключения к компоненту «Универсальный диспетчер» («Порталу администратора»);

--loglevel 20000 - категория сообщений;

--httpd-port=43900 - порт Агента ВРМ.

Пример получения полной информации по доступным аргументам командной строки с выводом в файл C:\agent_help_all.txt:

"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" -h > C:\agent_help_all.txt

Агент ВРМ также предусматривает возможность конфигурирования переносимых профилей и настройки аутентификации пользователей ВРМ через файл с помощью модуля pam_tdsk. Для подробной информации следует обратиться к подразделам Перемещаемые профили, Технология единого входа, Настройка аутентификации пользователей ВРМ через файлдокумента СЛЕТ.10001-01 90 02 «Руководство администратора. Настройка программного комплекса».

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

Таблица 1. Переменные окружения и аргументы CLI Агента ВРМ
Переменная окружения Значение по умолчанию Описание Аргумент командной строки

TDSK_AD_JOIN_METHOD

Не задано

Управляет способом ввода ВРМ в домен MS AD.

Переменная окружения используется только в ОС Linux.

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

  • adcli - ввод ВРМ в домен MS AD с использованием утилиты adcli;

  • samba - ввод ВРМ в домен MS AD с использованием средств пакета samba

Не задано

TDSK_VDI_URL

Не задано

Задает URL-адрес компонента «Универсальный диспетчер» («Портала администратора») для подключения к нему

--host

TDSK_VDI_KEY

Не задано

Задает значение мастер-ключа для подключения к компоненту «Универсальный диспетчер» («Порталу администратора»).

Для получения значения мастер-ключа в «Портале администратора» нужно перейти «Системные параметры - Системные настройки - Безопасность»

--key

TDSK_VDI_LOGLEVEL

20000

Задает категорию сообщений, которые будут записываться в журнал Агента ВРМ.

Возможные значения (может указываться как цифровое значение, так и буквенное):

  • 20000 - соответствует уровню DEBUG;

  • 30000 - соответствует уровню INFO;

  • 40000 - соответствует уровню WARN;

  • 30000 - соответствует уровню ERROR;

  • 40000 - соответствует уровню FATAL.

Пример для ОС Linux:

sudo termidesk-agent-config update --loglevel 20000
sudo termidesk-agent-config update --loglevel INFO

Пример для ОС Microsoft Windows:

"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" update --loglevel 20000
"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" update --loglevel INFO

--loglevel

Не задано

Не задано

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

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

  • True - использовать подстановку значений параметров из переменных окружения;

  • False - не использовать подстановку значений параметров из переменных окружения.

Если не задать значение, то будет использоваться True.

Пример для ОС Linux:

sudo termidesk-agent-config update --env=True
sudo termidesk-agent-config update --env

Пример для ОС Microsoft Windows:

"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" update --env=True
"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" update --env

--env

TDSK_METRIC_INTERVAL

3

Интервал (в секундах) получения и обновления метрик узла Агентом ВРМ. Переменная окружения доступна с версии 5.1.

По умолчанию интервал 3 секунды, однако через REST API получить метрики можно в любой момент

Не задано

SSSD_DEFAULT_CONF

/etc/sssd/sssd.conf

Задает путь к конфигурационному файлу, в котором задано значение параметра use_fully_qualified_names.

В зависимости от значения параметра use_fully_qualified_names будут применены действия:

  • суффикс домена не будет подставлен, если use_fully_qualified_names = False или отсутствует;

  • суффикс домена будет подставлен, если use_fully_qualified_names = True

Не задано

TDSK_LOG_ROTATE_COUNT

5

Задает максимальное количество файлов журналов. Переменная окружения доступна с версии 6.0

Не задано

TDSK_LOG_ROTATE_MAX_SIZE

10

Задает максимальный размер (МБ) файла журнала. Переменная окружения доступна с версии 6.0

Не задано

LOUDPLAY_LISTEN_IPV4

127.0.0.1

Задает IP-адрес сервера Loudplay для взаимодействия с ним

Не задано

LOUDPLAY_LISTEN_PORT

10061

Задает порт сервера Loudplay для взаимодействия с ним

Не задано

LOUDPLAY_CONNECT_DELAY

30

Задает время ожидания (в секундах), по истечении которого Агент ВРМ отключит неактивную сессию пользователя на сервере Loudplay

Не задано

TDSK_CONFIG_DIR

Не задано

Задает место хранения файлов конфигурации Агента ВРМ.

Пример: администратор хочет изменить место хранения файла конфигурирования Агента ВРМ.

Для этого ему нужно:

  • создать файл agent.cfg с настройками или скопировать его из /etc/termidesk;

  • поместить agent.cfg в нужный каталог. Каталог должен обладать свойствами:

    • права доступа: rw-r—​r-- (в восьмеричной записи - 644);

    • владелец и группа: root:root;

  • создать файл /etc/default/termidesk-agent. Указать в нем каталог, откуда будет считан конфигурационный файл:

TDSK_CONFIG_DIR=/etc/opt/termidesk

  • перезапустить службу termidesk-agent:

sudo systemctl restart termidesk-agent

Не задано

TDSK_HTTP_PORT

43900

Сетевой порт HTTP-сервера Агента ВРМ.

Начиная с Termidesk VDI версии 6.1 для работы Агента ВРМ более не выбираются случайные RPC-порты из диапазона 43900-44000. Теперь порт задаются вручную через конфигурационный файл или через переменную окружения.

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

Возможные значения: от 1 до 65535

--httpd-port

TDSK_HTTP_INTERFACE

Не задано

Сетевой интерфейс, используемый для подключения к компоненту «Универсальный диспетчер». Переменная окружения доступна с версии 7.0.

В качестве значения используется наименование сетевого интерфейса.

Пример для ОС Linux:

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

Не задано

TDSK_LOG_SRV_DIR

Не задано

Каталог хранения журналов службы Агента ВРМ

Не задано

TDSK_LOG_USER_DIR

Не задано

Каталог хранения журналов для непривилегированного пользователя

Не задано

TDSK_SETUP_NONINTERACTIVE

Не задано

«Тихий» режим установки.

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

  • 1 - активировать режим.

Используется при необходимости установки Агента ВРМ без отображения дополнительных окон

Не задано

TERA_QXL_CONFIG_FILE

Не задано

Путь к конфигурационному файлу TERA для ВМ. Используется для считывания параметров, заданных в настройках TERA. Если значение не задано, то используется путь /etc/X11/xorg.conf.d/30-teraqxl.xorg.conf

Не задано
Таблица 2. Переменные окружения Агента УВ
Переменная окружения Значение по умолчанию Описание

TVMD_ILEVEL_SOCKET

63

Задает значение метки целостности на создаваемый TVMD-сокет. Параметр задается в конфигурационном файле /etc/termidesk/termidesk-vmsd.conf.

По умолчанию после установки конфигурационный файл может не существовать. В этом случае нужно:

  • создать каталог /etc/termidesk/:

sudo mkdir /etc/termidesk

  • изменить права на каталог:

sudo chmod 755 /etc/termidesk

  • создать конфигурационный файл:

sudo touch /etc/termidesk/termidesk-vmsd.conf

  • изменить права на файл:

sudo chmod 644 /etc/termidesk/termidesk-vmsd.conf

Изменение значения метки целостности может понадобиться, если ОС имеет уровень целостности, отличный от 16. При возникновении ситуации, когда уровень целостности ОС отличается от 16, следует:

  • узнать текущий уровень целостности, выставляемый ОС для ВМ, командой:

cat /etc/libvirt/libvirtd.conf | grep ilev_vm

  • если полученный уровень отличается, то добавить параметр TVMD_ILEVEL_SOCKET с нужным значением уровня (например,TVMD_ILEVEL_SOCKET=16) в конфигурационный файл /etc/termidesk/termidesk-vmsd.conf

LIBVIRT_PASSWORD_SCRIPT

Не задано

Задает путь для исполняемого файла, реализующего альтернативный механизм сброса сессий (см. подраздел Использование альтернативного механизма сброса сессий)
Таблица 3. Переменные окружения и аргументы CLI видеоагента
Переменная окружения Значение по умолчанию Описание Аргумент командной строки

TDSK_DEBUG

Не задано

Включение режима отладки.

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

Не задано

Не задано

Не задано

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

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

sudo /usr/local/sbin/video_agent -h

-h

Не задано

/dev/video0

Устройство вывода видео

-o

Не задано

Не задано

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

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

sudo /usr/local/sbin/video_agent -v

-v

TDSK_VIDEO_CODEC

libtheora

Кодек видеокамеры.

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

  • libtheora - нативный метод кодирования Theora;

  • theora - кодирование через конвейер Gstreamer

-c
Таблица 4. Переменные окружения Агента смарт-карт
Переменная окружения Значение по умолчанию Описание

TDSK_DEBUG

Не задано

Включение режима отладки. Может также использоваться файл /etc/reader.conf.d/exconf/vscard (см. подраздел Настройка Агента виртуальных смарт-карт).

Возможные значения: yes
Таблица 5. Переменные окружения сессионного Агента
Переменная окружения Значение по умолчанию Описание

CONFIG_DIR

/etc/opt/termidesk-session-agent

Задает каталог хранения конфигурационных файлов сессионного Агента.

Пример: администратор хочет изменить место хранения файла конфигурирования сессионного Агента.

Для этого нужно:

  • создать файл session_agent.ini с настройками или скопировать его из существующего каталога;

  • поместить session_agent.ini в нужный каталог. Каталог должен обладать свойствами:

    • права доступа: rwxr-xr-x (в восьмеричной записи - 755);

    • владелец и группа: termidesk:termidesk;

  • создать файл /etc/default/termidesk-session-agent (если он не существует). Указать в нем каталог в переменной CONFIG_DIR, откуда будет считан конфигурационный файл. Пример:

CONFIG_DIR=/etc/opt/termidesk/session-agent

  • перезапустить службу termidesk-session-agent.service:

sudo systemctl restart termidesk-session-agent.service