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

sudo -u termidesk bash
/opt/termidesk/sbin/termidesk-vdi-manage help

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

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

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

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

ПараметрОписание
drop_tables

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

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

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

  • --noinput, --no-input - сообщает Django НЕ запрашивать у пользователя ввод;
  • -R  <МАРШРУТИЗАТОР>, --router  <МАРШРУТИЗАТОР> - использование указанного маршрутизатора БД вместо определенного в настройках settings.py;
  • -S <СХЕМА>, --schema <СХЕМА> - удаление указанной схемы вместо public;
  •  --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 - пропуск проверки системы
tdsk_auth

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

/opt/termidesk/sbin/termidesk-vdi-manage tdsk_auth -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 - пропуск проверки системы.

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

  • create - создание домена аутентификации;
  • list - вывод списка доменов аутентификации;
  • remove - удаление домена аутентификации;
  • login - аутентификация в указанный домен;
  • logout - завершение сессии.

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

  • --type -  задание типа домена аутентификации. Доступны: SimpleLdapAuthenticator («MS Active Directory (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 <комментарий> - комментарий к создаваемому домену.

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

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

  • --output json - вывод параметров в формате JSON;
  • --silent - «тихое» удаление для выполнения команды из исполняемого файла;
  • --uuid <идентификатор> - идентификатор объекта для удаления.

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

  • --uuid <идентификатор> - идентификатор объекта для аутентификации;
  • --small_name <короткое имя> - короткое имя домена аутентификации;
  • --output json - вывод параметров в формате JSON.

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

  • --token <токен> - токен сессии пользователя;
  • --output json - вывод параметров в формате JSON
tdsk_clearsessions

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

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

  • -chunk <количество> - количество сессий для удаления, по умолчанию 1000;
  • --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 - пропуск проверки системы
tdsk_config

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

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

  • --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 - пропуск проверки системы.

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

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

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

  • --key <ключ> -  ключ параметра;
  • --value <значение> - значение параметра
tdsk_graph_models

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

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

Пример использования команды приведен в подразделе Генерация отчета по моделям данных и структурам БД Termidesk.

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

  • 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 - выключение наследования;
  • --hide-relations-from-fields, -R - 
  • --disable-sort-fields, -S - 
  • --json - вывод в формат JSON;
  • --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 - пропуск проверки системы
tdsk_versionПолучение версии «Агрегатора»