Клиент. Интерфейс командной строки

Интерфейс командной строки Клиента

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

Для получения краткой информации по доступным аргументам командной строки следует вызвать приложение termidesk-client с аргументом --help:

termidesk-client --help

Для получения полной информации по доступным аргументам командной строки следует вызвать приложение termidesk-client с аргументом --help-all:

termidesk-client --help-all

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

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

  • вызывать Клиент из каталога C:\Program Files\UVEON\Termidesk Client;

  • перенаправить вывод команды в файл. В указанном файле будет показан результат выполнения команды.

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

"C:\Program Files\UVEON\Termidesk Client\termidesk-client.exe" --help-all > C:\client_help_all.txt

Список доступных аргументов и переменных окружения приведен в таблице (см. таблицу Список аргументов командной строки и переменных окружения для Клиента).

В ОС Microsoft Windows указанные аргументы также воспринимаются, однако результат не выводится в командную строку.

После установки Клиента в ОС добавилась служба Termidesk TBUS, необходимая для взаимодействия компонентов Termidesk. Запуск службы осуществляется автоматически, через приложение C:\Program Files\UVEON\Termidesk Client\termidesk-tbus.exe.

Приложение termidesk-tbus.exe поддерживает ключ -e, позволяющий запустить termidesk-tbus.exe как исполняемый файл, а не как службу.

При задании переменных окружения стоит учесть, что они также влияют на настройки ПО Termidesk Viewer.
Таблица 1. Список аргументов командной строки и переменных окружения для Клиента
Параметр Переменная окружения Описание Значение по умолчанию

URL

TDSK_VDI_URL

Адрес подключения к серверу или приложению. Параметр доступен с версии 4.3.

Допустимые схемы:

  • https://192.0.2.10 - подключение к серверу;

  • daass://192.0.2.10/foo/bar - подключение к приложению.

Начиная с Termidesk версии 5.1 поддерживается подключение к серверу с указанием URI сайта, например: https://192.0.2.10/site

Не задано

--debug

TDSK_DEBUG

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

В ОС macOS следует использовать:

TDSK_DEBUG=1 /Applications/Termidesk\ Client.app/Contents/MacOS/Termidesk\ Client

Не задано

--lang

TDSK_LANG

Выбор языка для приложения. Параметр доступен с версии 5.0. По умолчанию язык будет определен из региональных настроек, установленных в ОС.

Возможные значения: «ru», «en»

auto

--timeout

TDSK_TIMEOUT

Время ожидания сетевых подключений

60

--user-auth

TDSK_USER_AUTH

Имя домена аутентификации для подключения. Параметр доступен с версии 4.3.

Не задано

--user-name

TDSK_USER_NAME

Имя пользователя для подключения. Параметр доступен с версии 4.3.

Ограничения:

  • если имя содержит пробел, то нужно заключить его в двойные кавычки: --user-name "User 1";

  • (только для ОС Linux) если имя содержит специальные символы, то нужно заключить его в одинарные кавычки: --user-name 'User!123456';

  • (только для ОС Linux) если имя содержит и пробел, и специальные символы, то нужно заключить его в одинарные кавычки: --user-name 'User! 123456'

Не задано

--user-password

TDSK_USER_PASSWORD

Пароль пользователя для подключения. Параметр доступен с версии 4.3.

Ограничения:

  • если пароль содержит пробел, то нужно заключить его в двойные кавычки: --user-password "Password 1";

  • (только для ОС Linux) если пароль содержит специальные символы, то нужно заключить его в одинарные кавычки: --user-password 'Password!123456';

  • (только для ОС Linux) если пароль содержит и пробел, и специальные символы, то нужно заключить его в одинарные кавычки: --user-password 'Password! 123456'

Не задано

--version

Не задана

Вывод текущей версии Клиента

Не задано

--workplace-name

Не задана

Имя публикации для подключения к фонду РМ. Параметр доступен с версии 6.1. Пример использования приведен в подразделе Прямое подключение к РМ.

Ограничения:

  • если имя содержит пробел, то нужно заключить его в двойные кавычки: --workplace-name "Brest 1";

  • (только для ОС Linux) если имя содержит специальные символы, то нужно заключить его в одинарные кавычки: --workplace-name 'Brest!123456';

  • (только для ОС Linux) если имя содержит и пробел, и специальные символы, то нужно заключить его в одинарные кавычки: --workplace-name 'Brest! 123456'.

Пример команды для запуска из ОС Microsoft Windows:

"C:\Program Files\UVEON\Termidesk Client\termidesk-client.exe" <https://IP-адрес_или_FQDN_сервера_Termidesk> --workplace-name <имя_публикации> --protocol <имя_протокола_доставки> --user-name <имя_пользователя> --user-auth <имя_домена_аутентификации> --user-password <пароль_пользователя>

Пример команды для запуска из ОС Linux:

termidesk-client <https://IP-адрес_или_FQDN_сервера_Termidesk> --workplace-name <имя_публикации> --protocol <имя_протокола_доставки> --user-name <имя_пользователя> --user-auth <имя_домена_аутентификации> --user-password <пароль_пользователя>

Не задано

--protocol

Не задана

Протокол доставки для подключения к РМ. Параметр доступен с версии 6.1. Пример использования приведен в подразделе Прямое подключение к РМ.

Допустимые значения:

  • идентификатор протокола доставки. Пример: --protocol ce5ecd63-041f-5d5e-99c9-9de93a7a663d;

  • наименование протокола доставки. Пример: --protocol TERA

Не задано

Не задан

TDSK_RDS_GATEWAYHOSTNAME

Имя шлюза (FQDN) для приложения mstsc.exe. Для корректной работы может потребоваться отредактировать файл hosts в ОС. Используется при подключении к шлюзу MS RDS через компонент «Шлюз»

Не задано

Не задан

TDSK_RDP_SIGN_SHA256

Отпечаток сертификата для подписи файла формата RDP. Параметр доступен с версии 5.0.

Может быть задан как через указанную переменную окружения, так и через конфигурационный файл Termidesk Client.ini в параметре RDPSignSHA256.

Для использования идентификатора протокола доставки пользователь должен получить его у администратора. Администратор может получить идентификатор протокола доставки из:

  • таблиц базы данных Termidesk;

  • журнала Клиента (в этом случае подключение к РМ по протоколу досавки должно произойти хотя бы один раз). Требуемый идентификатор можно найти в записи «transports».

Задание параметра через конфигурационный файл, а не через переменную окружения, имеет бОльший приоритет.

Используется для подключения к РМ через компонент «Шлюз» с использованием утилиты mstsc.exe. Параметр актуален только при подключении через утилиту mstsc.exe, соответственно, может работать только в среде ОС Microsoft Windows.

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

  • сертификат (открытый ключ), использующийся для подписи, должен быть передан на узел с Клиентом совместно с закрытым ключом к нему;

  • на узел с Клиентом должен быть установлен как сертификат, использующийся для подписи, так и закрытый ключ к нему. На узел должен быть установлен корневой сертификат, который использовался для выдачи сертификата, использующегося для подписи;

  • в поле «Common Name» сертификата, использующегося для подписи, должен быть задан FQDN узла с Клиентом.

Подпись файла формата RDP и подключение на заданный в сертификате FQDN происходит только если отпечаток сертификата задан, иначе подключение инициируется на IP-адрес 127.0.0.1.

Пример значения отпечатка сертификата при задании через переменную окружения: TDSK_RDP_SIGN_SHA256 = 76FC4AFA6967D8EDDB3786C0364F767BF9C10397

Не задано

Интерфейс командной строки ПО Termidesk Viewer

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

Для получения краткой информации по доступным аргументам командной строки следует вызвать приложение vdi-viewer с аргументом --help:

vdi-viewer --help

Для получения полной информации по доступным аргументам командной строки следует вызвать приложение vdi-viewer с аргументом --help-all:

vdi-viewer --help-all

Для использования интерфейса командной строки ПО Termidesk Viewer в ОС Microsoft Windows нужно:

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

  • вызывать приложение vdi-viewer из каталога C:\Program Files\UVEON\Termidesk Viewer;

  • перенаправить вывод команды в файл. В указанном файле будет показан результат выполнения команды.

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

"C:\Program Files\UVEON\Termidesk Viewer\vdi-viewer.exe" --help-all > C:\viewer_help_all.txt

Список доступных аргументов приведен в таблице (см. таблицу Список аргументов командной строки и переменных окружения ПО Termidesk Viewer).

В ОС Microsoft Windows указанные аргументы также воспринимаются, однако результат не выводится в командную строку.

При задании переменных окружения стоит учесть, что они также влияют на настройки Клиента.
Таблица 2. Список аргументов командной строки и переменных окружения ПО Termidesk Viewer
Параметр Переменная окружения Описание Значение по умолчанию

--debug

TDSK_DEBUG

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

В ОС macOS следует использовать:

TDSK_DEBUG=1 /Applications/Termidesk\ Client.app/Contents/MacOS/Termidesk\ Client

Не задано

--lang

TDSK_LANG

Выбор языка для приложения. Параметр доступен с версии ПО Termidesk Viewer 1.9.0. По умолчанию язык будет определен из региональных настроек, установленных в ОС.

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

auto

--timeout

TDSK_TIMEOUT

Время ожидания подключения к компоненту «Шлюз» (в секундах). Параметр доступен с версии ПО Termidesk Viewer 1.5.0.

С версии 1.10.0 параметр влияет также на время ожидания подключения к РМ по протоколу RDP. Для этого подключения может указан диапазон от 0 до 600 секунд. Крайне малые значения через переменную окружения задавать не рекомендуется, т.к. она влияет на настройки Клиента

60

--version

Не задана

Вывод текущей версии ПО Termidesk Viewer

Не задано

--video-codec

TDSK_VIDEO_CODEC

Кодек видеокамеры. Параметр доступен с версии ПО Termidesk Viewer 1.6.

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

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

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

libtheora

Не задан

TDSK_RDP_PRT_UNIVERSAL

Определяет драйвер, который будет использован при перенаправлении принтера по протоколу RDP. Параметр доступен с версии ПО Termidesk Viewer 1.10.0.

Наличие переменной TDSK_RDP_PRT_UNIVERSAL активирует перенаправление принтера с использованием универсального драйвера (Microsoft Software Printer Driver). Для перенаправления принтера с использованием нативного драйвера переменную нужно удалить

Не задано

Не задан

TDSK_FILECOPY_BANDWIDTH

Задает ограничение скорости передачи (Кбайт/с) файла по протоколу TERA.

Отсутствие переменной эквивалентно значению 0.

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

  • 0 - скорость неограниченна;

  • 1 - 10000 - значение скорости

Не задано

Не задан

TDSK_DISPLAY_BANDWIDTH

Задает ограничение скорости (Кбайт/с) видеоканала при подключении по протоколу TERA.

Отсутствие переменной эквивалентно значению 0.

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

  • 0 - скорость неограниченна;

  • 1 - 10000 - значение скорости

Не задано

Параметры для TERA-подключения

--loginctrl

TDSK_LOGINCTRL

Режим работы ПО Termidesk Viewer при завершении сессии. Параметр доступен с версии ПО Termidesk Viewer 6.1.

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

  • enable - ПО Termidesk Viewer завершит работу при завершении или переключении сессии;

  • disable - ПО Termidesk Viewer не будет завершать работу при завершении или переключении сессии;

  • значение не задано - поведение зависит от режима аутентификации пользователя в РМ:

    • если пользователь аутентифицировался с использованием технологии единого входа (SSO), то ПО Termidesk Viewer завершит работу при завершении или переключении сессии;

    • если пользователь аутентифицировался с предъявлением пароля, то при завершении сессии отобразится экран блокировки с полем для ввода пароля для дальнейшей работы пользователя

Не задано

--keepalive

Не задана

Время ожидания (в секундах) подтверждения приема от TERA. Если в течение заданного времени ответ не получен, то произойдет автоматическое рассоединение. Параметр доступен с версии ПО Termidesk Viewer 6.1.

Параметр действует только для протокола TERA. Для протоколов RDP и SPICE используется значение по умолчанию (15 секунд).

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

  • 0 - ожидание подтверждения приема отключено;

  • 1 - 7200

15

--credentials_username

Не задана

Идентификатор пользователя и контекст для аутентификации в TERA через поставщик учетных данных (Credentials Provider, в версии 6.1 только для ОС Microsoft Windows). Параметр доступен с версии ПО Termidesk Viewer 6.1.

При вызове ПО Termidesk Viewer с этим параметром будет запрошен ввод пароля (аутентификатора Credentials Provider).

Особенности:

  • параметр (параметры), введенный через интерактивный режим имеет приоритет выше, чем параметр (параметры), полученный из других источников;

  • если параметр задан в интерфейсе командной строки, то он переопределяет любые другие значения (например, из файла с расширением .vv);

  • если параметр не задан в интерфейсе командной строки, то используются значения из файла с расширением .vv);

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

Формат: <имя_пользователя>@<домен>

Не задано

--timezone_sync

TDSK_SYNC_TIMEZONE

Режим работы ПО Termidesk Viewer для синхронизации временной зоны между пользовательской рабочей станцией и РМ. Параметр доступен с версии ПО Termidesk Viewer 6.1.

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

  • enable - ПО Termidesk Viewer будет синхронизировать временную зону;

  • disable - ПО Termidesk Viewer не будет синхронизировать временную зону;

  • значение не задано - поведение зависит от настроек политик, пришедших от сервера и от настроек TERA

Не задано

--time_sync

TDSK_SYNC_TIME

Режим работы ПО Termidesk Viewer для синхронизации времени между пользовательской рабочей станцией и РМ. Параметр доступен с версии ПО Termidesk Viewer 6.1.

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

* enable - ПО Termidesk Viewer будет синхронизировать время; * disable - ПО Termidesk Viewer не будет синхронизировать время; * значение не задано - поведение зависит от настроек политик, пришедших от сервера и от настроек TERA

Не задано

--audio_latency

TDSK_AUDIO_LATENCY

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

Параметр доступен с версии ПО Termidesk Viewer 6.1.

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

  • 0 - задержка не используется;

  • 1 - 10 000. Рекомендуемое значение: 100 - 250.

Особенности:

  • значение до 400 применяется для нестабильного подключения или далеко расположенных участников подключения;

  • при появлении помех в воспроизведении аудио-материала (щелчков, треска) джиттер-буфер можно увеличить на 100 мс. Следует помнить, что большое увеличение параметра не рекомендуется, т.к.может появиться дискомфорт при прослушивании голоса в аудиоконференциях

100

Не задан

TERA_UDP_FAILURE_TIMEOUT

Время ожидания (в миллисекундах) для повторных попыток взаимодействия с TERA-сервером по UDP-каналу. Время ожидания всегда постоянно.

Если значение не задано, то используется значение по умолчанию (15 секунд). Значение не может быть меньше 10 000

15 000

Не задан

TERA_UDP_QUALITY_TIMEOUT

Время ожидания (в миллисекундах) повторного переключения в UDP-канал.

Время ожидания адаптивно: каждая следующая неудачная попытка увеличивает интервал ожидания следующего подключения, но не более 5 раз. Таким образом при настройке по умолчанию следующие попытки произойдут: через 1.5 минут, 3 минуты, 4.5 минуты, 6 минут, 7.5 минут. Если в интервале не менее 5 секунд ошибок не будет обнаружено, то время ожидания сбросится к начальному значению.

Если значение не задано, то используется значение по умолчанию (90 секунд). Значение не может быть меньше 10 000

90 000