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

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

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

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

для настройки переносимых профилей следует обратиться к подразделу Настройка переносимых профилей для ОС Astra Linux Special Edition документа СЛЕТ.10001-01 90 02 «Руководство администратора. Настройка программного комплекса»;
для настройки технологии единого входа следует обратиться к подразделу Настройка технологии единого входа в гостевой ОС ВМ документа СЛЕТ.10001-01 90 02 «Руководство администратора. Настройка программного комплекса»;
для настройки аутентификации пользователей ВРМ через файл следует обратиться к подразделу Настройка аутентификации пользователей ВРМ через файл документа СЛЕТ.10001-01 90 02 «Руководство администратора. Настройка программного комплекса».

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

через интерфейс CLI и задание параметров функционирования с помощью аргументов командной строки;
через переменные окружения. Использование переменных окружения может быть задано следующими способами:
- непосредственно в сервисном файле /lib/systemd/system/termidesk-agent.service. Для это нужно изменить указанный файл, добавив в секцию service либо переменную и ее значение (в примере Environment=TDSK_VDI_URL=192.0.2.30), либо указать файл с назначенными переменными:

Environment=TDSK_VDI_URL=192.0.2.30
EnvironmentFile=<путь_к_файлу_с_переменными_окружения>

BASH

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

sudo systemctl daemon-reload
sudo systemctl restart termidesk-agent.service

BASH

- через интерфейс CLI и аргумент --env;
- через задание переменной окружения TDSK_VDI_ENV.

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

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

открыть командную строку от имени администратора;
вызывать Агент ВРМ из каталога C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe;
перенаправить вывод команды в файл. В указанном файле будет показан результат выполнения команды.

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

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

BASH

Переменные окружения Агента ВРМ

Переменная окружения	Значение по умолчанию	Описание	Аргумент командной строки
`TDSK_VDI_URL`	`Не задано`	Задает значение IP-адреса для подключения к компоненту «Универсальный диспетчер». В переменной `TDSK_VDI_URL` задается URL-строка с IP-адресом компонента «Универсальный диспетчер». При использовании аргумента `--host` задается только IP-адрес компонента «Универсальный диспетчер». Пример для ОС Linux: `sudo termidesk-agent-config update --host 192.0.2.30` BASH Пример для ОС Microsoft Windows: `"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" update --host 192.0.2.30` BASH где `192.0.2.30` - IP-адрес компонента «Универсальный диспетчер». Пример IP-адреса приведен в соответствии с RFC 5737, он должен быть заменен на актуальный, используемый согласно схеме адресации, принятой в инфраструктуре организации. Для вызова справки нужно ввести команду: `sudo termidesk-agent-config update --help` BASH	`--host`
`TDSK_VDI_KEY`	`Не задано`	Задает значение мастер-ключа для подключения к компоненту «Универсальный диспетчер». Для получения значения мастер-ключа в «Портале администратора» компонента «Универсальный диспетчер» нужно перейти «Настройки - Системные параметры - Безопасность». Пример ОС Linux: `sudo termidesk-agent-config update --key 0123456789` BASH Пример для ОС Microsoft Windows: `"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" update --key 0123456789` BASH где `0123456789` - значение ключа	`--key`
`TDSK_VDI_SSL`	`Не задано`	Включение использования защищенного SSL-соединения. Пример ОС Linux: `sudo termidesk-agent-config update --ssl` BASH Пример для ОС Microsoft Windows: `"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" update --ssl` BASH Отключение параметра выполняется в графическом режиме Агента ВРМ или с помощью команды: Команда сбрасывает все настройки Агента ВРМ до значений по умолчанию. `sudo termidesk-agent-config delete` BASH	`--ssl`
`TDSK_VDI_ENV`	`Не задано`	Включение подстановки значений параметров из переменных окружения. Пример ОС Linux: `sudo termidesk-agent-config update --env` BASH Пример для ОС Microsoft Windows: `"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" update --env` BASH Отключение параметра выполняется в графическом режиме Агента ВРМ или с помощью команды: Команда сбрасывает все настройки Агента ВРМ до значений по умолчанию. `sudo termidesk-agent-config delete` BASH	`--env`
`TDSK_VDI_LOGLEVEL`	`Не задано`	Задает категорию сообщений, которые будут записываться в журнал Агента ВРМ (возможные значения: `DEBUG`, `INFO`). В текущей версии Агента ВРМ настройка категории сообщений для записи в журнал через CLI не поддерживается. Приведена справочная информация. Пример ОС Linux: `sudo termidesk-agent-config update --loglevel INFO` BASH Пример для ОС Microsoft Windows: `"C:\Program Files\UVEON\Termidesk Agent\TermideskAgentConfig.exe" update --loglevel INFO` BASH	`--loglevel`
`TDSK_PIDFILE`	`/var/run/termidesk.pid`	Данный параметр применяется только для Агента ВРМ на ОС Linux. Задает путь к файлу журнала с идентификаторами запущенных приложений	`Не задано`
`Не задана`	`Не задано`	Данный параметр применяется только для Агента ВРМ на ОС Linux. Команда для входа в графическую сессию пользователя ВРМ. Для работы команды должна выть включена технология единого входа. Пример: `sudo termidesk-agent-config dmctl login --user-name USER --user-password PASSWORD` BASH где: `USER` - имя пользователя; `PASSWORD` - пароль пользователя. Для вызова справки нужно ввести команду: `sudo termidesk-agent-config dmctl login --help` BASH	`dmctl login`
`TDSK_METRIC_INTERVAL`	`3`	Интервал (в секундах) получения и обновления метрик узла Агентом ВРМ. Переменная окружения доступна с версии 5.1. По умолчанию интервал 3 секунды, однако через REST API получить метрики можно в любой момент	`Не задано`

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

Переменные окружения Агента УВ

Переменная окружения	Значение по умолчанию	Описание	Аргумент командной строки
`Не задано`	`Не задано`	Используется для проброса устройств или их отключения. Аргумент командной строки вызывается через `virsh`. Пример: `sudo termidesk-vmsd virsh attach-device` BASH Для вызова справки нужно ввести команды: `sudo termidesk-vmsd virsh attach-device --help sudo termidesk-vmsd virsh detach-device --help` BASH	`attach-device` `detach-device`
`Не задано`	`Не задано`	Используется для взаимодействия с QEMU из командной строки. Реализует функции управления пробросом USB-устройств и установки USB-фильтра. Для вызова справки нужно ввести команду: `sudo termidesk-vmsd virsh qemu-monitor-command --help` BASH Пример добавления USB-фильтра к ВМ «one-184»: `sudo termidesk-vmsd virsh qemu-monitor-command --usbredir-add "0x03:-1:-1:-1:1\|-1:-1:-1:-1:0" --domain-name one-184` BASH Пример использования QEMU для изменения конфигурации ВМ «one-184»: `sudo termidesk-vmsd virsh qemu-monitor-command --from-json '{"execute":"query-kvm"}' --domain-name one-184` BASH	`qemu-monitor-command`
`TVMD_ILEVEL_SOCKET`	`63`	Задает значение метки целостности на создаваемый `TVMD-`сокет. Параметр задается в конфигурационном файле `/etc/termidesk/termidesk-vmsd.conf`. По умолчанию после установки конфигурационный файл не существует. Нужно: создать каталог `/etc/termidesk`/: `sudo mkdir /etc/termidesk` BASH изменить права на каталог: `sudo chmod 755 /etc/termidesk` BASH создать конфигурационный файл: `sudo touch /etc/termidesk/termidesk-vmsd.conf` BASH изменить права на файл: `sudo chmod 644 /etc/termidesk/termidesk-vmsd.conf` BASH Изменение значения метки целостности может понадобиться, если ОС, на которую устанавливается Агент УВ, имеет уровень целостности, отличный от 63. При возникновении ситуации, когда уровень целостности ОС отличается от 63, следует: узнать текущий уровень целостности, выставляемый ОС для ВМ, командой: `cat /etc/libvirt/libvirtd.conf \| grep ilev_vm` BASH если полученный уровень отличается от 63, то добавить параметр `TVMD_ILEVEL_SOCKET` с нужным значением уровня (например, `TVMD_ILEVEL_SOCKET=16`) в конфигурационный файл `/etc/termidesk/termidesk-vmsd.conf`	`--tvmd-ilevel-socket`
`LIBVIRT_PASSWORD_SCRIPT`	`Не задано`	Задает путь для исполняемого файла, реализующего альтернативный механизм сброса сессий (см. подраздел Использование альтернативного механизма сброса сессий)

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

Переменная окружения	Значение по умолчанию	Описание	Аргумент командной строки
`TDSK_DEBUG`	`Не задано`	Включение режима отладки. Возможные значения: `yes`	`Не задано`
`Не задано`	`Не задано`	Вывод справки по использованию аргументов командной строки. Для вызова справки нужно выполнить: `sudo /usr/local/sbin/video_agent -h` BASH	`-h`
`Не задано`	`Не задано`	Получение контрольных сумм входящих данных (используется алгоритм MD5). Служебный параметр, не для использования	`-m`
`Не задано`	`Не задано`	Использование неблокирующего режима чтения. В этом режиме видеоагент продолжает принимать данные, даже если нет обновлений (в блокирующем режиме выполнение видеоагента останавливается до момента поступления новых данных). Служебный параметр, не для использования	`-n`
`Не задано`	`/dev/video0`	Устройство вывода видео	`-o`
`Не задано`	`/dev/virtio-ports/ru.termidesk.RealtimeStreaming.0`	Порт входящих данных. Менять значение не рекомендуется	`-p`
`Не задано`	`Не задано`	Время ожидания между кадрами в порте входящих данных (в микросекундах). Служебный параметр, не для использования	`-s`
`Не задано`	`Не задано`	Время ожидания между попытками открытия порта входящих данных (в секундах). Служебный параметр, не для использования	`-t`
`Не задано`	`Не задано`	Вывод версии приложения. Для вывода версии нужно выполнить: `sudo /usr/local/sbin/video_agent -v` BASH	`-v`
`TDSK_VIDEO_CODEC`	`libtheora`	Кодек видеокамеры. Возможные значения: `libtheora` - нативный метод кодирования Theora; `theora` - кодирование через конвейер Gstreamer.	`-c`

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

Переменная окружения Значение по умолчанию Описание Аргумент командной строки

TDSK_DEBUG

Не задано

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

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

Не задано