Утилита termidesk-vdi-manage

Утилита termidesk-vdi-manage используется для настройки «Универсального диспетчера» из интерфейса командной строки.

Для вызова утилиты следует:

  • в интерфейсе командной строки переключиться на пользователя termidesk:

sudo -u termidesk bash
  • вывести список команд утилиты:

/opt/termidesk/sbin/termidesk-vdi-manage help

Каждая подкоманда в приведенных ниже командах поддерживает вывод справки через ключ -h. В командах поддерживаются аргументы вывода:

  • --version - вывод версии программы;

  • -v {0,1,2,3}, --verbosity {0,1,2,3} - уровень детализации сообщений;

  • --settings <настройки> - путь к модулю настроек Python;

  • --pythonpath <каталог Python> - каталог, который нужно добавить в путь Python, например /home/djangoprojects/myproject;

  • --traceback - вызов исключений;

  • --no-color - вывод команды без подсвечивания;

  • --force-color - вывод команды с принудительным подсвечиванием;

  • --skip-checks - пропуск проверки системы.

Для управления параметрами поставщиков ресурсов, доменов аутентификации, протоколов доставки и других компонентов, настраиваемых через «Портал администратора» Termidesk VDI, следует обратиться к командам секции [termidesk].

Большая часть команд из вывода /opt/termidesk/sbin/termidesk-vdi-manage help предназначена для работы с БД и фреймворком Django и не приведена здесь.

Команды секции [termidesk] приведены в таблице (см. таблицу Команды секции [termidesk]).

Таблица 1. Команды секции [termidesk]
Параметр Описание '

tdsk_auth

Управление доменами аутентификации. Для просмотра списка ключей следует воспользоваться аргументом -h:

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_auth -h

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

  • create - создание домена аутентификации;

  • list - вывод списка доменов аутентификации;

  • remove - удаление домена аутентификации;

  • login - аутентификация в указанный домен;

  • logout - завершение сессии

tdsk_auth create

Создание домена аутентификации. Подкоманда create принимает аргументы:

  • --type - задание типа домена аутентификации. Доступны: IPAuth («IP аутентификация»), KerberosAuthenticatorPlugin («FreeIPA»), SAMLAuthenticator («SAML»), SimpleLdapAuthenticator («Microsoft AD DS/LDAP»);

  • --params - задание параметров домена аутентификации. Формат: имя1=значeние1 имя2=значение2 и т.д. Доступные параметры для указанного типа домена аутентификации можно получить через команду --list , например:

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_auth create --type IPAuth --name test --small_name test
  • --list - вывод параметров домена аутентификации;

  • --test - проверка параметров без создания домена аутентификации;

  • --quiet - вывод только сообщений об ошибках;

  • --name <ИМЯ> - имя домена аутентификации;

  • --small_name <короткое имя> - короткое имя домена аутентификации. Допустимые символы: a-z, A-Z, 0-9. Максимальная длина 32 символа;

  • --priority <приоритет> - числовое значение приоритета домена аутентификации, по умолчанию «1»;

  • --comments <комментарий> - комментарий к создаваемому домену

tdsk_auth list

Вывод списка доменов аутентификации.

Подкоманда list принимает аргумент --output json для вывода списка в формате JSON

tdsk_auth remove

Удаление домена аутентификации.

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

  • --output json - вывод параметров в формате JSON;

  • --silent - «тихое» удаление для выполнения команды из исполняемого файла;

  • --uuid <идентификатор> - идентификатор объекта для удаления.

tdsk_auth login

Аутентификация в указанный домен.

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

  • --uuid <идентификатор> - идентификатор объекта для аутентификации;

  • --small_name <короткое имя> - короткое имя домена аутентификации;

  • --output json - вывод параметров в формате JSON.

tdsk_auth logout

Завершение сессии в указанном домене.

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

  • --token <токен> - токен сессии пользователя;

  • --output json - вывод параметров в формате JSON

tdsk_clear_cache

Удаляет ненужные кешированные данные. Для просмотра списка ключей следует воспользоваться аргументом -h:

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_clear_cache -h

tdsk_clearsessions

Порционная очистка сессий.

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

  • -chunk <количество> - количество сессий для удаления, по умолчанию 1000

tdsk_config

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

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

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

  • set - установка значения конфигурационному параметру

tdsk_config set

Установка значения конфигурационному параметру.

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

  • --key <ключ> - ключ параметра;

  • --value <значение> - значение параметра.

Пример команды для смены значения параметра metrics.cacheSize («Размер кеша») секции Metrics на «9»:

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_config set --key metrics.cacheSize --value 9

tdsk_exp_2fa_add_statictoken

Добавление токена пользователю.

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

  • username - имя пользователя, с которым будет ассоциирован токен;

  • -t <токен>, --token <токен> - токен, который нужно добавить. Если этот параметр пропущен, он будет сгенерирован случайным образом;

  • --auth_uuid <идентификатор> - идентификатор домена аутентификации

tdsk_exp_2fa_clear_totpdevice

Удаление TOTP-устройства пользователя.

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

  • username - имя пользователя, которому нужно удалить TOTP-устройство;

  • --auth_uuid <идентификатор> - идентификатор домена аутентификаци

tdsk_gateways

Управление профилями шлюзов.

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

  • create - создание профиля шлюза;

  • list - вывод списка профилей шлюзов;

  • remove - удаление профиля шлюза

tdsk_gateways create

Cоздание профиля шлюза.

Для подкоманды create поддерживаются следующие аргументы:

  • --type - задание типа профиля шлюза. Доступен: TermideskGateway;

  • --params - задание параметров профиля шлюза. Формат: имя1=значeние1 имя2=значение2 и т.д. Доступные параметры для указанного типа профиля шлюза можно получить через команду --list, например:

 /opt/termidesk/sbin/termidesk-vdi-manage tdsk_gateways create --type TermideskGateway --list --name test_gateway
  • --list - вывод параметров профиля шлюза;

  • --test - проверка параметров без создания профиля шлюза;

  • --quiet - вывод только сообщений об ошибках;

  • -- name <имя> - наименование профиля шлюза;

  • --comments <комментарий> - комментарий к создаваемому профилю шлюза;

  • --priority <приоритет> - числовое значение приоритета профиля шлюза.

Пример создания профиля шлюза через подкоманду create:

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_gateways create --type TermideskGateway --params gatewayUrl=wss://192.0.2.1:10000 tunnelWait=35 --name test_gateway --priority 1

tdsk_graph_models

Создание файла GraphViz с описанием моделей БД для указанных имен приложений.

Можно передать несколько имен приложений, и все они будут объединены в одну модель.

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

  • app_label - наименование приложения;

  • --pygraphviz - использование PyGraphViz для создания изображения;

  • --pydot - использование PyDot(Plus) для создания изображения;

  • --disable-fields, -d - не показывать поля;

  • --group-models, -g - сгруппировать модели в соответствии с их применением;

  • --all-applications, -a - включить все приложения для вывода модели;

  • --output <путь к файлу>, -o <путь к файлу> - запись вывода в файл;

  • --layout <макет>, -l <макет> - использование макета GraphViz для визуализации. Поддерживаются: circo, dot, fdpneato, nop, nop1, nop2, twopi;

  • --verbose-names, -n - использование подробных имен для моделей и полей;

  • --language <локализация>, -L <локализация> - указания языка, который будет использоваться для подробных имен;

  • --exclude-columns <столбцы>, -x <столбцы> - исключение определенных столбцов;

  • --exclude-models <модели>, -X <модели> - исключение определенных моделей;

  • --include-models <модели>, -I <модели> - ограничение только указанными моделями;

  • --inheritance, -e - включение наследования (используется по умолчанию);

  • --no-inheritance, -E - выключение наследования

tdsk_group

Управление группой РМ. Поддерживается подкоманда create

tdsk_group create

Создание группы РМ.

Подкоманда create поддерживает следующие аргументы:

  • --quiet - вывод только сообщений об ошибках;

  • --name <имя> - имя создаваемой группы;

  • --comments <комментарий> - комментарий к создаваемой группе;

  • --priority <приоритет> - числовое значение приоритета группы

tdsk_license

Управление лицензией Termidesk VDI.

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

  • install - установить лицензию;

  • show - вывести информацию об установленной лицензии;

  • remove - удалить лицензию из БД

tdsk_license install

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

Пример команды для установки лицензии:

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_license install <путь к файлу лицензии>

tdsk_license show

Вывод информации об установленной лицензии. Для вывода в формате JSON следует использовать аргумент --output:

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_license show --output json

tdsk_license remove

Удаление лицензии из БД. Перед выполнением команды необходимо авторизоваться:

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_auth login
/opt/termidesk/sbin/termidesk-vdi-manage tdsk_license remove

tdsk_net

Управление объектом «Сеть». Поддерживается подкоманда create

tdsk_net create

Создание объекта «Сеть».

Подкоманда create поддерживает следующие аргументы:

  • --quiet - вывод только сообщений об ошибках;

  • --name <имя> - имя создаваемой сети;

  • --netRange <диапазон> - диапазон IP-адресов. Допустимы различные форматы, например: A.B.C.*, A.B.C.D/N, A.B.C.D - E.F.G.D

tdsk_openbao_migrate

Миграция способа хранения паролей и переход с конфигурационного файла на использование хранилища OpenBao

tdsk_openbao_reverse_migrate

Миграция способа хранения паролей и переход c хранилища OpenBao на конфигурационный файл

tdsk_osm

Управление параметрами гостевой ОС. Поддерживается подкоманда create

tdsk_osm create

Создание параметров гостевой ОС.

Подкоманда create поддерживает следующие аргументы:

  • --params - задание параметров гостевой ОС. Формат: имя1=значeние1 имя2=значение2 и т.д.;

  • --list - вывод параметров гостевой ОС;

  • --test - проверка параметров без создания объекта;

  • --quiet - вывод только сообщений об ошибках;

  • --name <ИМЯ> - наименование параметров гостевой ОС;

  • --comments <комментарий> - комментарий к создаваемым параметрам

tdsk_pool

Управление фондами РМ.

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

  • create - создание фонда РМ;

  • list - вывод списка фондов РМ

tdsk_pool create

Создание фонда РМ.

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

  • --quiet - вывод только сообщений об ошибках;

  • --name <имя> - имя фонда РМ;

  • --comments <комментарий> - комментарий к создаваемому фонду РМ;

  • --published_name <имя> - имя публикации;

  • --service_id <идентификатор> - указание идентификатора шаблона РМ;

  • --osmanager_id <идентификатор> - указание идентификатора параметров гостевой ОС РМ;

  • --image_id <идентификатор> - указание идентификатора изображения гостевой ОС;

  • --servicesPoolGroup_id <идентификатор> - указание идентификатора группы РМ;

  • --cache_l1_srvs <значение> - количество РМ в кеше 1-го уровня;

  • --cache_l2_srvs <значение> - количество РМ в кеше 2-го уровня;

  • --max_srvs <значение> - максимальное количество РМ

tdsk_pool list

Вывод списка фондов РМ.

Подкоманда list принимает аргумент --output json для вывода списка в формате JSON

tdsk_prov

Управление поставщиками ресурсов.

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

  • create - создание поставщика ресурсов;

  • list - вывод списка поставщиков ресурсов;

  • id {id} - действия с поставщиком ресурсов с идентификатором id

tdsk_prov create

Создание поставщика ресурсов.

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

  • --type - задание типа поставщика ресурсов. Доступны: RedVirtPlatform («РЕД Виртуализация»), SessionsPlatform («Сервер терминалов»), VMmanagerPlatform («VMmanager»), oVirtPlatform («oVirt»), pksvbrestPlatform («ПК СВ "Брест"»), vmwarePlatform («VMware vSphere»), zVirtPlatform («zVirt»), PhysicalMachinesServiceProvider («Автономная машина»);

  • --params - задание параметров поставщика ресурсов. Формат: имя1=значeние1 имя2=значение2 и т.д. Доступные параметры для указанного типа поставщика ресурсов можно получить через команду --list , например:

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_prov create --type RedVirtPlatform --list --name test
  • --list - вывод параметров поставщика ресурсов;

  • --test - проверка параметров без создания поставщика ресурсов;

  • --quiet - вывод только сообщений об ошибках;

  • --name <имя> - наименование поставщика ресурсов;

  • --comments <комментарий> - комментарий к создаваемому поставщику ресурсов

tdsk_prov list

Вывод списка поставщиков ресурсов.

Подкоманда list принимает аргумент --output json для вывода списка в формате JSON

tdsk_prov id {id}

Действия с поставщиком ресурсов с идентификатором id.

Подкоманда id {id} принимает:

  • tpl create - создание шаблона РМ в поставщике ресурсов;

  • tpl list - вывод списка шаблонов РМ поставщика ресурсов;

  • tpl remove - удаление шаблона РМ в поставщике ресурсов

tdsk_refresh_ssa

Регистрация «Сессионного агента» в БД Termidesk

tdsk_setup

Настройка Termidesk VDI после установки. Выполняет миграцию данных, создание таблицы кеша данных, сбор статических файлов, компиляцию файлов

tdsk_trans

Управление протоколами доставки.

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

  • create - создание протокола доставки;

  • list - вывод списка протоколов доставки;

  • remove - удаление протокола доставки;

  • convert - конвертиртация протокола доставки

tdsk_trans create

Создание протокола доставки.

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

  • --type - задание типа протокола. Доступны: HTML5Transport («HTML5»), LoudplayDirectTransport («Loudplay [экспериментальный]»), LoudplayTunneledTransport («Loudplay через шлюз (экспериментальный)»), RDPTransport («RDP»), TDSKSPICETransport («SPICE»), WSTRDPTransport («RDP через шлюз»), TERATransport («TERA»), TerminalTransport («RDP терминальный»);

  • --params - задание параметров протокола доставки. Формат: имя1=значeние1 имя2=значение2 и т.д. Доступные параметры для указанного типа протокола доставки можно получить через команду --list. Например: /opt/termidesk/sbin/termidesk-vdi-manage tdsk_trans create --type RDPTransport --list --name test;

  • --list - вывод параметров протокола доставки;

  • --test - проверка параметров без создания протокола доставки;

  • --quiet - вывод только сообщений об ошибках;

  • --name <имя> - наименование протокола доставки;

  • --comments <комментарий> - комментарий к создаваемому протоколу доставки;

  • --priority <приоритет> - числовое значение приоритета протокола доставки;

  • --allowed_oss <перечень ОС> - перечень разрешенных OC из списка: Android, CrOS, FreeBSD, iPad, iPhone, Linux, Mac, Windows, Windows Phone. Формат: имя1,имя2,имя3;

  • --nets_positive <yes/no> - указание, что протокол должен быть доступен только из сетей, указанных в параметре --networks. Может принимать значения не только yes или no, подходит в целом любое непустое значение;

  • --networks <наименования сетей> - перечень сетей, доступ из которых разрешен для создаваемого протокола доставки. Формат: имя1,имя2,имя3

tdsk_trans list

Вывод списка протоколов доставки.

Подкоманда list принимает аргумент --output json для вывода списка в формате JSON

tdsk_trans remove

Удаление протокола доставки.

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

  • --output json - вывод списка в формате JSON;

  • --silent - выполнение в «тихом» режиме;

  • --uuid <идентификатор> - идентификатор объекта для удаления

tdsk_trans convert

Конвертиртация протокола доставки (RDSTransport, RDSWSTRDPTransport, STALTransport, STALWSTRDPTransport) в новый протокол TerminalTransport.

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

  • --uuid <идентификатор> - идентификатор протокола доставки, который необходимо конвертировать;

  • --all - ковернтировать все протоколы доставки MS RDS и STAL

tdsk_version

Получение версии Termidesk