Утилита 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, следует обратиться к командам секции [termidesk].

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

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

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

aggr_clear_resources

Удаляет из БД информацию о РМ пользователей.

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

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

tdsk_auth

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

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

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

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

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

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

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

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

tdsk_auth create

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

  • --type - задание типа домена аутентификации. Доступны: SimpleLdapAuthenticator («Microsoft AD DS/LDAP»), OIDCAuth («OIDC»), BuiltinAuthenticator («Встроенный»);

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

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_auth create --type OIDCAuth --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 <значение> - значение параметра

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_setup

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

tdsk_version

Получение версии «Агрегатора»