TERMIDESK ИНСТРУКЦИЯ ПО ИСПОЛЬЗОВАНИЮ СЛЕТ.10001-01 91 01 (Версия 5.0. Выпуск от мая 2024)
СЛЕТ.10001-01 91 01
ОГЛАВЛЕНИЕ
1 .
ОБЩИЕ СВЕДЕНИЯ
5
1.1 .
О документе
5
1.2 .
Назначение
5
1.3 .
Типографские соглашения
6
2 .
НАЧАЛО РАБОТЫ С REST API КОМПОНЕНТА «УНИВЕРСАЛЬНЫЙ ДИСПЕТЧЕР»
7
2.1 .
Получение токена
7
2.2 .
Формат URL-команд
8
2.3 .
Список доступных модулей
8
2.4 .
Электронный справочник по командам
9
3 .
ДОСТУПНЫЕ КОМАНДЫ REST API КОМПОНЕНТА «УНИВЕРСАЛЬНЫЙ
ДИСПЕТЧЕР»
12
3.1 .
Доступные команды модуля «webui»
12
3.1.1 .
Команды, связанные со списками устройств доступа
12
3.2 .
Команды, связанные со списками доступа
12
3.2.1 .
Команды, связанные с объектами инфраструктуры
12
3.2.2 .
Команды, связанные с журналами событий
13
3.2.3 .
Команды, связанные с доменами аутентификации
13
3.2.4 .
Команды, связанные с панелью мониторинга
15
3.2.5 .
Команды, связанные с изображениями гостевых ОС
15
3.2.6 .
Команды, связанные с графическим интерфейсом
15
3.2.7 .
Команды, связанные с получением индекса
15
3.2.8 .
Команды, связанные с функциями мониторинга
15
3.2.9 .
Команды, связанные с аутентификацией на основе адресов сети
16
3.2.10 .
Команды, связанные с параметрами гостевых ОС
16
3.2.11 .
Команды, связанные с глобальными политиками
16
3.2.12 .
Команды, связанные с поставщиками ресурсов
17
3.2.13 .
Команды, связанные с управлением полномочиями (ролями)
17
Выпуск от мая 2024
2
СЛЕТ.10001-01 91 01
3.2.14 .
Команды, связанные с отчетами
18
3.2.15 .
Команды, связанные с фондами ВРМ
18
3.2.16 .
Команды, связанные с группами ВРМ
21
3.2.17 .
Команды, связанные с сессиями пользователей
21
3.2.18 .
Команды, связанные с системными параметрами
22
3.2.19 .
Команды, связанные с протоколами доставки
22
3.2.20 .
Команды, связанные с работой мастеров
22
3.2.21 .
Команды, связанные со списком ВРМ
23
3.3 .
Доступные команды модуля «agent»
23
3.4 .
Доступные команды модуля «auth»
24
3.5 .
Доступные команды модуля «client»
24
3.6 .
Доступные команды модуля «health»
24
3.7 .
Доступные команды модуля «wsproxy»
25
3.8 .
Доступные команды модуля «discover»
25
4 .
НАЧАЛО РАБОТЫ С REST API КОМПОНЕНТА «УДАЛЕННЫЙ ПОМОЩНИК»
26
4.1 .
Формат URL-команд для компонента «Удаленный помощник»
26
4.2 .
Электронный справочник по командам REST API компонента «Удаленный помощник» .. 26
5 .
ДОСТУПНЫЕ КОМАНДЫ REST API КОМПОНЕНТА «УДАЛЕННЫЙ ПОМОЩНИК» ..27
5.1 .
Доступные команды модуля «settings»
27
6 .
НАЧАЛО РАБОТЫ С REST API КОМПОНЕНТА «ОРКЕСТРАТОР»
28
6.1 .
Формат URL-команд для компонента «Оркестратор»
28
6.2 .
Электронный справочник по командам REST API компонента «Оркестратор»
28
7 .
ДОСТУПНЫЕ КОМАНДЫ REST API КОМПОНЕНТА «ОРКЕСТРАТОР»
29
7.1 .
Доступные команды модуля «health»
24
7.1.1 .
Команды, связанные с проверкой состояния Termidesk
29
7.2 .
Доступные команды модуля «infra»
29
7.3 .
Команды, связанные с управлением инфраструктурой Termidesk
29
7.4 .
Доступные команды для управления компонентом «Универсальный диспетчер»
29
Выпуск от мая 2024
3
СЛЕТ.10001-01 91 01
7.4.1 . Команды, связанные с управлением доменами аутентификации
29
7.5 .
Команды, связанные с управлением поставщиками ресурсов
30
7.6 .
Команды, связанные с управлением шаблонами ВМ
30
7.6.1 . Команды, связанные с управлением параметрами гостевых ОС
30
7.6.2 . Команды, связанные с управлением протоколами доставки
30
7.6.3 . Команды, связанные с управлением фондами рабочих мест
31
7.6.4 . Команды, связанные с аудитом и мониторингом Termidesk
31
7.6.5 . Команды, связанные с управлением сессиями
31
7.6.6 . Команды, связанные с запросами о данных ВМ
31
8 .
ПРИНЯТЫЕ ТЕРМИНЫ И ОПРЕДЕЛЕНИЯ
33
9 .
ПЕРЕЧЕНЬ СОКРАЩЕНИЙ
35
Выпуск от мая 2024
4
СЛЕТ.10001-01 91 01
1 . ОБЩИЕ СВЕДЕНИЯ
1.1 . О документе
Настоящий документ является инструкцией по использованию интерфейса REST API
программного комплекса «Диспетчер подключений виртуальных рабочих мест Termidesk» (далее -
Termidesk).
В этом руководстве приведены шаги по началу работы с интерфейсом, а также список доступных
команд.
1.2 . Назначение
REST API позволяет:
получить данные (GET-запросы);
создать новые элементы данных (POST-запросы);
изменить данные (PUT-запросы);
удалить данные (DELETE-запросы);
обновить данные (PATCH-запросы).
Для передачи команд через REST API может использоваться утилита curl.
Curl
-
кроссплатформенная служебная программа командной строки, позволяющая
взаимодействовать с множеством различных серверов по множеству различных протоколов с
синтаксисом URL.
При работе с внешней утилитой curl возникает ряд особенностей:
для отправки запроса GET использовать опцию -X 'GET';
для отправки запроса DELETE использовать опцию -X 'DELETE';
для отправки запроса PUT использовать опцию -X 'PUT';
для отправки запроса POST использовать опцию -X 'POST';
для отправки запроса PATCH использовать опцию -X 'PATCH'.
Возвращаемые форматы задаются заголовком accept, например:
curl ... -H "accept:application/json"
Пример POST-запроса для «Универсального диспетчера» Termidesk:
1
curl -X 'POST' \
2
3
-H 'accept: application/json' \
4
-H 'Content-Type: application/json' \
5
-H 'X-Auth-Token: 7bjqtodywjd69dkpdta9ncqprifkr3pu' \
6
-d '{
7
"name": "string",
8
"comments": "string",
Выпуск от мая 2024
5
СЛЕТ.10001-01 91 01
9
"service_id": "string",
10
"osmanager_id": "string",
11
"image_id": "string",
12
"help_url": "string",
13
"servicesPoolGroup_id": "string",
14
"cache_l1_srvs": 2147483647,
15
"cache_l2_srvs": 2147483647,
16
"max_srvs": 2147483647,
17
"debug_mode": true,
18
"backup": true,
19
"fallbackAccess": "string"
20
}'
Результирующий формат указывается в ответном заголовке content-type.
1.3 . Типографские соглашения
В настоящем документе приняты следующие типографские соглашения:
моноширинный шрифт
- используется для выделения фрагментов текста программ,
наименований файлов и папок (директорий), путей перемещения, строк комментариев,
различных программных элементов (объект, класс, тип, переменная, команда, макрос и т. д.),
а также вводимого и выводимого текста в режиме командной строки;
«кавычки» - текст, заключенный в кавычки, используется для обозначения наименований
документов, названий компонентов Termidesk, пунктов меню, наименований окон, вкладок,
полей, других элементов графического интерфейса, а также вводимого и выводимого текста
в режиме графического интерфейса;
[квадратные скобки] - текст, заключенный в квадратные скобки, используется для
наименования экранных кнопок;
<угловые скобки> - текст, заключенный в угловые скобки, используется для наименования
клавиш клавиатуры.
Выпуск от мая 2024
6
СЛЕТ.10001-01 91 01
2 . НАЧАЛО РАБОТЫ С REST API КОМПОНЕНТА «УНИВЕРСАЛЬНЫЙ
ДИСПЕТЧЕР»
2.1 . Получение токена
Перед использованием REST API нужно получить токен
(-H
'X-Auth-Token:
7bjqtodywjd69dkpdta9ncqprifkr3pu' из примера выше), который необходимо подставлять во
все последующие запросы, кроме запросов health. Для получения токена необходимо
авторизоваться в Termidesk, для этого:
выполнить
URL-команду:
authenticators;
запомнить значения параметров authUuid, authSmallName, auth;
выполнить URL-команду:
login
и
заполнить
экранные
поля
«Логин»,
«Пароль»,
«Название
аутентификатора» (значение параметра auth из предыдущей команды), «UUID
аутентификатора» (значение параметра authUuid из предыдущей команды), «Короткое
название аутентификатора» (значение параметра authSmallName из предыдущей команды).
В приведенных командах disp.termidesk.local - сетевой адрес или полное доменное имя узла
компонента «Универсальный диспетчер» Termidesk.
Для запросов проверки состояния сервера /api/health используется токен, определенный в
конфигурационном файле /etc/opt/termidesk-vdi/termidesk.conf в значении переменной
HEALTH_CHECK_ACCESS_KEY.
Формат запроса к /api/health выглядит следующим образом:
1
curl -X 'GET' \
2
3
-H 'accept: application/json' \
4
-H 'Authorization: Token
072bfec46ac7c42078bb41ff5f6d1ae201006f0824fb4b2bb8ab8befacb01058'
где:
Token 072... - токен, определенный в переменной HEALTH_CHECK_ACCESS_KEY файла /etc/opt/
termidesk-vdi/termidesk.conf;
Для форматированного вывода рекомендуется установить пакет jq:
:~$ sudo apt install jq
И выполнить запрос, добавив в конец команды « | jq»:
1
curl -X 'GET' \
2
3
-H 'accept: application/json' \
Выпуск от мая 2024
7
СЛЕТ.10001-01 91 01
4
-H 'Authorization: Token
072bfec46ac7c42078bb41ff5f6d1ae201006f0824fb4b2bb8ab8befacb01058' | jq
В случае, если запрос завершится ошибкой вида «curl: (60) SSL: no alternative certificate subject
name matches target host name... curl failed to verify the legitimacy... », нужно дополнить запрос
флагом --insecure, который отключит проверку валидности сертификатов:
Выполнение запроса без использования проверки SSL допустимо только на тестовых
стендах. Для исправления ошибки в производственной среде необходимо установить на
сервер Termidesk валидные сертификаты.
1
curl -X 'GET' \
2
3
-H 'accept: application/json' \
4
-H 'Authorization: Token
072bfec46ac7c42078bb41ff5f6d1ae201006f0824fb4b2bb8ab8befacb01058' --insecure |
jq
2.2 . Формат URL-команд
Общий вид команд реализован следующим образом:
/api/<module>/<ver>/<name>/,
где:
<module> - наименование модуля, реализованного в REST API;
<ver> - версия;
<name> - наименование элемента. После наименования элемента также могут быть включены
уникальные номера объектов и наименования других элементов.
Пример команды через curl:
1
curl -X 'GET' \
2
3
-H 'accept: application/json' \
4
-H 'X-Auth-Token: 7bjqtodywjd69dkpdta9ncqprifkr3pu'
2.3 . Список доступных модулей
В REST API реализовано следующее логическое разделение на модули:
«discover» - используется для отображения списка модулей API, предоставляемого сервером
(команда /api/discover/);
«agent» - модуль взаимодействия с компонентом «Агент» виртуального рабочего места
(ВРМ);
«auth» - модуль для аутентификации пользователей веб-интерфейса;
«client» - модуль взаимодействия с компонентом «Клиент»;
«health» - модуль проверки состояния Termidesk;
Выпуск от мая 2024
8
СЛЕТ.10001-01 91 01
«webui» - модуль управления функциями, доступными через веб-интерфейс Termidesk;
«wsproxy» - модуль взаимодействия с компонентом «Шлюз».
При этом список отображаемых модулей зависит от типа портала, который был выбран при
установке «Универсального диспетчера»:
«Портал администратора»: доступны «auth», «discover», «health», «agent», «webui»;
«Портал пользователя»: доступны «auth», «discover», «health», «client», «wsproxy», «agent»;
«Портал администратора» и «Портал пользователя»: доступны все модули.
2.4 . Электронный справочник по командам
Полная информация о параметрах и командах REST API доступна при вводе URL-команды
полное доменное имя узла «Универсального диспетчера» Termidesk.
Доступ предоставляется после авторизации в Termidesk.
По нажатию кнопки [Try it out] (см. Рисунок 1) в пространстве команд какого-либо модуля можно
составить запрос и отправить его на выполнение кнопкой [Execute] (см. Рисунок 2). После нажатия
будет отображена также команда для запроса через curl.
Для ввода токена доступа к определенным командам необходимо нажать кнопку [Authorize] и
ввести необходимые ключи:
«bearerAuth» - токен для аутентификации в модулях раздела «external». Получить токен
можно в модуле «auth» по URL: /external/login;
«legacyTokenAuth» - альтернативный способ аутентификации в модулях раздела «webui».
Может быть получен в модуле «auth» по URL: /legacy/login. Наименование в заголовках
запросов: X-Auth-Token;
«healthTokenAuth» - токен для аутентификации в модулях раздела «health». Указывается в
формате: Token <значение>. Значение токена определено в конфигурационном файле /etc/
opt/termidesk-vdi/termidesk.conf, в значении переменной HEALTH_CHECK_ACCESS_KEY.
Выпуск от мая 2024
9
СЛЕТ.10001-01 91 01
Рисунок 1 - Расположение экранных кнопок для получения доступа к формированию запроса
Выпуск от мая 2024
10
СЛЕТ.10001-01 91 01
Рисунок 2 - Расположение экранной кнопки для формирования запроса
Выпуск от мая 2024
11
СЛЕТ.10001-01 91 01
3 . ДОСТУПНЫЕ КОМАНДЫ REST API КОМПОНЕНТА «УНИВЕРСАЛЬНЫЙ
ДИСПЕТЧЕР»
3.1 . Доступные команды модуля «webui»
3.1.1 . Команды, связанные со списками устройств доступа
Доступные администратору URL-команды перечислены в таблице (см. Таблица 1).
Таблица 1 - Перечень URL-команд, связанных со списками устройств доступа
URL-команда
Тип
Описание
/api/webui/draft/access-devices
GET
Возвращает список устройств доступа
/api/webui/draft/access-devices/{uuid}
GET
Возвращает устройство доступа с
идентификатором {uuid}
/api/webui/draft/access-devices/{uuid}/ PATCH
Изменяет статус устройства доступа с
{status}
идентификатором {uuid}
3.2 . Команды, связанные со списками доступа
Доступные администратору URL-команды перечислены в таблице (см. Таблица 2).
Таблица 2 - Перечень URL-команд, связанных со списками доступа
URL-команда
Тип
Описание
/api/webui/draft/acl
GET
Возвращает список объектных разрешений
/api/webui/draft/acl
POST
Обновляет объектное разрешение
/api/webui/draft/acl/{ID}
GET
Возвращает объектное разрешение с
идентификатором {ID}
/api/webui/draft/acl/{ID}
PUT
Обновляет объектное разрешение с
идентификатором {ID}
/api/webui/draft/acl/{ID}
DELETE
Удаляет объектное разрешение с
идентификатором {ID}
/api/webui/draft/acl/gui/{data_type}
GET
Возвращает описание для графического
интерфейса
/api/webui/draft/acl/permissions/
GET
Возвращает список разрешений для
{data_type}
переданного типа объекта
/api/webui/draft/acl/types
GET
Возвращает список доступных типов
объектных разрешений
3.2.1 . Команды, связанные с объектами инфраструктуры
Доступные администратору URL-команды перечислены в таблице (см. Таблица 3).
Таблица 3 - Перечень URL-команд, связанных с объектами инфраструктуры
URL-команда
Тип
Описание
/api/webui/draft/appnodes/brokers
GET
Возвращает список объектов инфраструктуры
(«Универсальных диспетчеров»)
Выпуск от мая 2024
12
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/webui/draft/appnodes/brokers/
DELETE
Удаляет объект инфраструктуры
{uuid}
(«Универсальный диспетчер») с
идентификатором {uuid}
/api/webui/draft/appnodes/gateways
GET
Возвращает список объектов инфраструктуры
(«Шлюзов»)
/api/webui/draft/appnodes/gateways/
DELETE
Удаляет объект инфраструктуры («Шлюз») с
{uuid}
идентификатором {uuid}
/api/webui/draft/appnodes/portals
GET
Возвращает список объектов инфраструктуры
(порталов)
/api/webui/draft/appnodes/portals/
DELETE
Удаляет объект инфраструктуры (портал) с
{uuid}
идентификатором {uuid}
/api/webui/draft/appnodes/
GET
Возвращает список объектов инфраструктуры
vmcontrollers
(«Менеджеров рабочих мест»)
/api/webui/draft/appnodes/
DELETE
Удаляет объект инфраструктуры («Менеджер
vmcontrollers/{uuid}
рабочих мест») с идентификатором {uuid}
3.2.2 . Команды, связанные с журналами событий
Доступные администратору URL-команды перечислены в таблице (см. Таблица 4).
Таблица 4 - Перечень URL-команд, связанных с журналами событий
URL-команда
Тип
Описание
/api/webui/draft/audit/events
GET
Возвращает список событий аудита
/api/webui/draft/audit/events/types
GET
Возвращает список доступных типов событий
аудита
3.2.3 . Команды, связанные с доменами аутентификации
Доступные администратору URL-команды перечислены в таблице (см. Таблица 5).
Таблица 5 - Перечень URL-команд, связанных с доменами аутентификации
URL-команда
Тип
Описание
/api/webui/draft/authenticators
GET
Возвращает список доменов аутентификации
/api/webui/draft/authenticators
POST
Создает домен аутентификации
/api/webui/draft/authenticators/
GET
Возвращает список групп домена
{auth_uuid}/groups
аутентификации
/api/webui/draft/authenticators/
POST
Создает группу домена аутентификации
{auth_uuid}/groups
/api/webui/draft/authenticators/
GET
Возвращает группу с идентификатором {uuid}
{auth_uuid}/groups/{uuid}
домена аутентификации с идентификатором
{auth_uuid}
/api/webui/draft/authenticators/
PUT
Обновляет группу домена аутентификации
{auth_uuid}/groups/{uuid}
/api/webui/draft/authenticators/
DELETE
Удаляет группу домена аутентификации
{auth_uuid}/groups/{uuid}
Выпуск от мая 2024
13
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/webui/draft/authenticators/
GET
Возвращает список ВРМ группы домена
{auth_uuid}/groups/{uuid}/servicesPools
аутентификации
/api/webui/draft/authenticators/
GET
Возвращает список пользователей группы
{auth_uuid}/groups/{uuid}/users
домена аутентификации
/api/webui/draft/authenticators/
GET
Возвращает список доступных групп для домена
{auth_uuid}/groups/external
аутентификации
/api/webui/draft/authenticators/
GET
Возвращает список доступных типов групп
{auth_uuid}/groups/types
домена аутентификации
/api/webui/draft/authenticators/
GET
Возвращает описание для графического
{auth_uuid}/groups/gui/{group_type}
интерфейса группы с типом {group_type}
/api/webui/draft/authenticators/
GET
Возвращает список пользователей домена
{auth_uuid}/users
аутентификации
/api/webui/draft/authenticators/
POST
Создает пользователя домена аутентификации
{auth_uuid}/users
/api/webui/draft/authenticators/
GET
Возвращает пользователя с идентификатором
{auth_uuid}/users/{uuid}
{uuid} домена аутентификации
/api/webui/draft/authenticators/
PUT
Обновляет пользователя домена аутентификации
{auth_uuid}/users/{uuid}
/api/webui/draft/authenticators/
DELETE
Удаляет пользователя домена аутентификации
{auth_uuid}/users/{uuid}
/api/webui/draft/authenticators/
GET
Возвращает журнал пользователя домена
{auth_uuid}/users/{uuid}/log
аутентификации
/api/webui/draft/authenticators/
GET
Возвращает список ВРМ пользователя домена
{auth_uuid}/users/{uuid}/servicesPools
аутентификации
/api/webui/draft/authenticators/
GET
Возвращает список ассоциированных
{auth_uuid}/users/{uuid}/userServices
виртуальных машин для пользователя домена
аутентификации
/api/webui/draft/authenticators/
GET
Возвращает список доступных пользователей
{auth_uuid}/users/external
для домена аутентификации
/api/webui/draft/authenticators/
GET
Возвращает описание для графического
{auth_uuid}/users/gui
интерфейса
/api/webui/draft/authenticators/
GET
Возвращает список доступных типов
{auth_uuid}/users/types
пользователей домена аутентификации
/api/webui/draft/authenticators/{uuid}
GET
Возвращает домен аутентификации
/api/webui/draft/authenticators/{uuid}
PUT
Обновляет домен аутентификации
/api/webui/draft/authenticators/{uuid}
DELETE
Удаляет домен аутентификации
/api/webui/draft/authenticators/{uuid}/
GET
Возвращает журнал домена аутентификации
log
/api/webui/draft/authenticators/types
GET
Возвращает список доступных типов доменов
аутентификации
/api/webui/draft/authenticators/gui/
GET
Возвращает описание для графического
{data_type}
интерфейса домена аутентификации с типом
{data_type}
Выпуск от мая 2024
14
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/webui/draft/authenticators/test/
POST
Тестирует параметры домена аутентификации
{type}
3.2.4 . Команды, связанные с панелью мониторинга
Доступные администратору URL-команды перечислены в таблице (см. Таблица 6).
Таблица 6 - Перечень URL-команд, связанных с панелью мониторинга
URL-команда
Тип
Описание
/api/webui/draft/dashboard
GET
Просмотр списка объектов панели мониторинга
3.2.5 . Команды, связанные с изображениями гостевых ОС
Доступные администратору URL-команды перечислены в таблице (см. Таблица 7).
Таблица 7 - Перечень URL-команд, связанных с изображением гостевых ОС
URL-команда
Тип
Описание
/api/webui/draft/gallery/images
GET
Возвращает список изображений
/api/webui/draft/gallery/images
POST
Создает изображение
/api/webui/draft/gallery/images/{uuid} GET
Возвращает изображение с идентификатором
{uuid}
/api/webui/draft/gallery/images/{uuid} PUT
Обновляет изображение
/api/webui/draft/gallery/images/{uuid} DELETE
Удаляет изображение
/api/webui/draft/gallery/images/gui
GET
Возвращает описание для графического
интерфейса
3.2.6 . Команды, связанные с графическим интерфейсом
Доступные администратору URL-команды перечислены в таблице (см. Таблица 8).
Таблица 8 - Перечень URL-команд, связанных с вызовом функций графического интерфейса
URL-команда
Тип
Описание
/api/webui/draft/gui/callback/{callback} GET
Доступ к callback-функциям графического
интерфейса
3.2.7 . Команды, связанные с получением индекса
Доступные администратору URL-команды перечислены в таблице (см. Таблица 9).
Таблица 9 - Перечень URL-команд, связанных с получением индекса
URL-команда
Тип
Описание
/api/webui/draft
GET
Определяет текущую версию REST API
3.2.8 . Команды, связанные с функциями мониторинга
Доступные администратору URL-команды перечислены в таблице (см. Таблица 10).
Выпуск от мая 2024
15
СЛЕТ.10001-01 91 01
Таблица 10 - Перечень URL-команд, связанных с функциями мониторинга
URL-команда
Тип
Описание
/api/webui/draft/monitoring
GET
Просмотр всех журналов в виде списка
3.2.9 . Команды, связанные с аутентификацией на основе адресов сети
Доступные администратору URL-команды перечислены в таблице (см. Таблица 11).
Таблица 11 - Перечень URL-команд, связанных с IP-аутентификацией
URL-команда
Тип
Описание
/api/webui/draft/networks
GET
Возвращает список сетей
/api/webui/draft/networks
POST
Создает сеть
/api/webui/draft/networks/{uuid}
GET
Возвращает сеть с идентификатором {uuid}
/api/webui/draft/networks/{uuid}
PUT
Обновляет сеть
/api/webui/draft/networks/{uuid}
DELETE
Удаляет сеть
/api/webui/draft/networks/gui
GET
Возвращает описание для графического
интерфейса
3.2.10 . Команды, связанные с параметрами гостевых ОС
Доступные администратору URL-команды перечислены в таблице (см. Таблица 12).
Таблица 12 - Перечень URL-команд, связанных с параметрами гостевых ОС
URL-команда
Тип
Описание
/api/webui/draft/osmanagers
GET
Возвращает список параметров гостевых ОС
/api/webui/draft/osmanagers
POST
Создает параметры гостевых ОС
/api/webui/draft/osmanagers/{uuid}
GET
Возвращает параметры гостевых ОС с
идентификатором {uuid}
/api/webui/draft/osmanagers/{uuid}
PUT
Обновляет параметры гостевых ОС
/api/webui/draft/osmanagers/{uuid}
DELETE
Удаляет параметры гостевых ОС
/api/webui/draft/osmanagers/types
GET
Возвращает список типов параметров гостевых
ОС
/api/webui/draft/osmanagers/gui/
GET
Возвращает описание для графического
{data_type}
интерфейса для параметров с типом {data_type}
3.2.11 . Команды, связанные с глобальными политиками
Доступные администратору URL-команды перечислены в таблице (см. Таблица 13).
Таблица 13 - Перечень URL-команд, связанных с глобальными политиками
URL-команда
Тип
Описание
/api/webui/draft/policies
GET
Список всех доступных политик
/api/webui/draft/policies/{uuid}
GET
Получить информацию о политике с типом
{data_type}
Выпуск от мая 2024
16
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/webui/draft/policies/{uuid}
PUT
Обновить параметры политики
/api/webui/draft/policies/{uuid}
DELETE
Сброс глобальной политики
/api/webui/draft/policies/gui/
GET
Спецификация полей графического интерфейса
{policy_type}
для политики конкретного типа
3.2.12 . Команды, связанные с поставщиками ресурсов
Доступные администратору URL-команды перечислены в таблице (см. Таблица 14).
Таблица 14 - Перечень URL-команд, связанных с поставщиками ресурсов
URL-команда
Тип
Описание
/api/webui/draft/providers
GET
Возвращает список поставщиков ресурсов
/api/webui/draft/providers
POST
Создает поставщика ресурсов
/api/webui/draft/providers/{uuid}
GET
Возвращает поставщик ресурсов с
идентификатором {uuid}
/api/webui/draft/providers/{uuid}
PUT
Обновляет поставщик ресурсов
/api/webui/draft/providers/{uuid}
DELETE
Удаляет поставщик ресурсов
/api/webui/draft/providers/{uuid}/
PATCH
Переводит поставщик ресурсов в режим
maintenance
техобсуживания
/api/webui/draft/providers/types
GET
Возвращает список доступных типов
поставщиков техобслуживания
/api/webui/draft/providers/test/
POST
Тестирует параметры поставщика ресурсов
{prov_type}
/api/webui/draft/providers/gui/
GET
Возвращает описание для графического
{prov_type}
интерфейса
/api/webui/draft/providers/
GET
Возвращает список шаблонов ВРМ поставщика
{provider_uuid}/services
ресурсов
/api/webui/draft/providers/
POST
Создает шаблон ВРМ
{provider_uuid}/services
/api/webui/draft/providers/
GET
Возвращает шаблон ВРМ с идентификатором
{provider_uuid}/services/{uuid}
{uuid} поставщика ресурсов
/api/webui/draft/providers/
PUT
Обновляет шаблон ВРМ с идентификатором
{provider_uuid}/services/{uuid}
{uuid} поставщика ресурсов
/api/webui/draft/providers/
DELETE
Удаляет шаблон ВРМ с идентификатором
{provider_uuid}/services/{uuid}
{uuid} поставщика ресурсов
/api/webui/draft/providers/
GET
Возвращает список доступных типов шаблонов
{provider_uuid}/services/types
ВРМ поставщика ресурсов
/api/webui/draft/providers/
GET
Возвращает описание для графического
{provider_uuid}/services/gui/
интерфейса для шаблона ВРМ с типом
{service_type}
{service_type} поставщика ресурсов
3.2.13 . Команды, связанные с управлением полномочиями (ролями)
Доступные администратору URL-команды перечислены в таблице (см. Таблица 15).
Выпуск от мая 2024
17
СЛЕТ.10001-01 91 01
Таблица 15 - Перечень URL-команд, связанных с управлением ролями
URL-команда
Тип
Описание
/api/webui/draft/rbac
GET
Возвращает список ролей
/api/webui/draft/rbac
POST
Создает роль
/api/webui/draft/rbac/{id}
GET
Возвращает роль
/api/webui/draft/rbac/{id}
PUT
Обновляет роль
/api/webui/draft/rbac/{id}
DELETE
Удаляет роль
/api/webui/draft/rbac/gui
GET
Возвращает описание для графического
интерфейса
/api/webui/draft/rbac/permissions
GET
Возвращает список разрешений для ролей
3.2.14 . Команды, связанные с отчетами
Доступные администратору URL-команды перечислены в таблице (см. Таблица 16).
Таблица 16 - Перечень URL-команд, связанных с отчетами
URL-команда
Тип
Описание
/api/webui/draft/reports
GET
Возвращает список отчетов
/api/webui/draft/reports
POST
Создает отчет
/api/webui/draft/reports/{id}
GET
Возвращает отчет
/api/webui/draft/reports/{id}
PUT
Обновляет отчет
/api/webui/draft/reports/{id}
DELETE
Удаляет отчет
/api/webui/draft/reports/{id}/
GET
Генерирует отчет с идентификатором {id}
generate
/api/webui/draft/reports/gui/
GET
Возвращает описание для графического
{data_type}
интерфейса
/api/webui/draft/reports/types
GET
Возвращает список доступных типов отчетов
3.2.15 . Команды, связанные с фондами ВРМ
Доступные администратору URL-команды перечислены в таблице (см. Таблица 17).
Таблица 17 - Перечень URL-команд, связанных с фондами ВРМ
URL-команда
Тип
Описание
/api/webui/draft/servicespools
GET
Возвращает список фондов ВРМ
/api/webui/draft/servicespools
POST
Создает фонд ВРМ
/api/webui/draft/servicespools/{uuid}
GET
Возвращает фонд ВРМ
/api/webui/draft/servicespools/{uuid}
PUT
Обновляет фонд ВРМ
/api/webui/draft/servicespools/{uuid}
DELETE
Удаляет фонд ВРМ
/api/webui/draft/servicespools/gui
GET
Возвращает описание для графического
интерфейса
Выпуск от мая 2024
18
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/webui/draft/servicespools/types
GET
Возвращает список доступных типов для фондов
ВРМ
/api/webui/draft/servicespools/
GET
Возвращает список групп фонда ВРМ
{servicespool_uuid}/groups
/api/webui/draft/servicespools/
POST
Добавляет группу в фонд ВРМ
{servicespool_uuid}/groups
/api/webui/draft/servicespools/
GET
Набор операций для управления группой из
{servicespool_uuid}/groups/{uuid}
фонда ВРМ
/api/webui/draft/servicespools/
DELETE
Удаляет группу с идентификатором {uuid} из
{servicespool_uuid}/groups/{uuid}
фонда ВРМ
/api/webui/draft/servicespools/
GET
Возвращает описание для графического
{servicespool_uuid}/groups/gui
интерфейса
/api/webui/draft/servicespools/
GET
Список всех политик фонда ВРМ
{servicespool_uuid}/policies
/api/webui/draft/servicespools/
PUT
Создает политику фонда ВРМ
{servicespool_uuid}/policies
/api/webui/draft/servicespools/
GET
Получает информацию о политиках фонда ВРМ
{servicespool_uuid}/policies/{uuid}
/api/webui/draft/servicespools/
PUT
Обновляет параметры политики фонда ВРМ
{servicespool_uuid}/policies/{uuid}
/api/webui/draft/servicespools/
DELETE
Сброс политики фонда ВРМ
{servicespool_uuid}/policies/{uuid}
/api/webui/draft/servicespools/
GET
Спецификация полей графического интерфейса
{servicespool_uuid}/policies/gui/
для политики типа {data_type}
{policy_type}
/api/webui/draft/servicespools/
GET
Запускает процедуру публикации фонда ВРМ
{servicespool_uuid}/publications/
publish
/api/webui/draft/servicespools/
GET
Возвращает список публикаций фонда ВРМ
{servicespool_uuid}/publications
/api/webui/draft/servicespools/
GET
Возвращает публикацию с идентификатором
{servicespool_uuid}/publications/
{uuid}
{uuid}
/api/webui/draft/servicespools/
GET
Запускает отмену публикации фонда ВРМ.
{servicespool_uuid}/publications/
Повторный вызов запускает форсированную
{uuid}/cancel
отмену публикации фонда ВРМ
/api/webui/draft/servicespools/
GET
Возвращает описание для графического
{servicespool_uuid}/publications/gui
интерфейса
/api/webui/draft/servicespools/
GET
Возвращает список протоколов доставки из
{servicespool_uuid}/transports
фонда ВРМ
/api/webui/draft/servicespools/
POST
Добавляет протокол доставки в фонд ВРМ
{servicespool_uuid}/transports
/api/webui/draft/servicespools/
GET
Возвращает протокол доставки с
{servicespool_uuid}/transports/{uuid}
идентификатором {uuid} из фонда ВРМ
Выпуск от мая 2024
19
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/webui/draft/servicespools/
DELETE
Удаляет протокол доставки с идентификатором
{servicespool_uuid}/transports/{uuid}
{uuid} из фонда ВРМ
/api/webui/draft/servicespools/
GET
Возвращает описание для графического
{servicespool_uuid}/transports/gui
интерфейса
/api/webui/draft/servicespools/
GET
Возвращает список пользователей фонда ВРМ
{servicespool_uuid}/users
/api/webui/draft/servicespools/
POST
Добавляет пользователя в фонд ВРМ
{servicespool_uuid}/users
/api/webui/draft/servicespools/
GET
Набор операций для управления пользователями
{servicespool_uuid}/users/{uuid}
из фонда ВРМ
/api/webui/draft/servicespools/
DELETE
Удаляет пользователя из фонда ВРМ
{servicespool_uuid}/users/{uuid}
/api/webui/draft/servicespools/
GET
Возвращает описание для графического
{servicespool_uuid}/users/gui
интерфейса
/api/webui/draft/servicespools/
GET
Получение списка ВРМ, находящихся в кеше
{servicespool_uuid}/cache
фонда ВРМ
/api/webui/draft/servicespools/
GET
Возвращает ВРМ, находящееся в кеше фонда
{servicespool_uuid}/cache/{uuid}
ВРМ
/api/webui/draft/servicespools/
DELETE
Удаляет ВРМ, находящееся в кеше из фонда ВРМ
{servicespool_uuid}/cache/{uuid}
/api/webui/draft/servicespools/
PATCH
Назначает пользователю ВРМ, находящееся в
{servicespool_uuid}/cache/{uuid}/
кеше
assign
/api/webui/draft/servicespools/
GET
Возвращает описание для графического
{servicespool_uuid}/cache/{uuid}/
интерфейса ВРМ, находящегося в кеше
assign/gui
/api/webui/draft/servicespools/
GET
Возвращает журнал ВРМ, находящегося в кеше
{servicespool_uuid}/cache/{uuid}/log
/api/webui/draft/servicespools/
PATCH
Управление режимом техобслуживания ВРМ,
{servicespool_uuid}/cache/{uuid}/
находящегося в кеше
maintenance
/api/webui/draft/servicespools/{uuid}/
PATCH
Управление состоянием выбранного ВРМ,
cache/{service_uuid}/machine
находящегося в кеше
/api/webui/draft/servicespools/{uuid}/
GET
Возвращает журнал фонда ВРМ
log
/api/webui/draft/servicespools/
GET
Получает список назначенных ВРМ из фонда
{servicespool_uuid}/services
ВРМ
/api/webui/draft/servicespools/
GET
Возвращает назначенное ВРМ из фонда ВРМ
{servicespool_uuid}/services/{uuid}
/api/webui/draft/servicespools/
DELETE
Удаляет назначенное ВРМ из фонда ВРМ
{servicespool_uuid}/services/{uuid}
/api/webui/draft/servicespools/
GET
Возвращает журнал назначенного ВРМ
{servicespool_uuid}/services/{uuid}/
log
Выпуск от мая 2024
20
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/webui/draft/servicespools/{uuid}/
PATCH
Переводит фонд ВРМ в режим техобслуживания
maintenance
и возвращает из него
/api/webui/draft/servicespools/{uuid}/
PATCH
Управление состоянием назначенного ВРМ
services/{service_uuid}/machine
/api/webui/draft/servicespools/
PATCH
Откат назначенной ВМ на базовый снапшот
{servicespool_uuid}/services/{uuid}/
refresh
/api/webui/draft/servicespools/
PATCH
Замена назначенного экземпляра ВМ на новый
{servicespool_uuid}/services/{uuid}/
(запись в базе данных о ВРМ остается та же)
replace
/api/webui/draft/servicespools/
PATCH
Управление режимом техобслуживания
{servicespool_uuid}/services/{uuid}/
назначенного ВРМ
maintenance
/api/webui/draft/servicespools/
POST
Отправка сообщения назначенным ВРМ
{servicespool_uuid}/services/message
/api/webui/draft/servicespools/
GET
Возвращает описание для графического
{servicespool_uuid}/services/message/
интерфейса метода отправки сообщения ВРМ
gui
3.2.16 . Команды, связанные с группами ВРМ
Доступные администратору URL-команды перечислены в таблице (см. Таблица 18).
Таблица 18 - Перечень URL-команд, связанных с группами ВРМ
URL-команда
Тип
Описание
/api/webui/draft/spgroups
GET
Возвращает список групп
/api/webui/draft/spgroups
POST
Создает группу
/api/webui/draft/spgroups/{uuid}
GET
Возвращает группу с идентификатором {uuid}
/api/webui/draft/spgroups/{uuid}
PUT
Обновляет группу
/api/webui/draft/spgroups/{uuid}
DELETE
Удаляет группу
/api/webui/draft/spgroups/gui
GET
Возвращает описание для графического
интерфейса
3.2.17 . Команды, связанные с сессиями пользователей
Доступные администратору URL-команды перечислены в таблице (см. Таблица 19).
Таблица 19 - Перечень URL-команд, связанных с сессиями пользователей
URL-команда
Тип
Описание
/api/webui/draft/spsessions
GET
Возвращает список активных сессий
пользователей
/api/webui/draft/spsessions/{uuid}
GET
Возвращает активную сессию пользователя
/api/webui/draft/spsessions/{uuid}/
PATCH
Сбрасывает активную сессию пользователя
disconnect
Выпуск от мая 2024
21
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/webui/draft/spsessions/{uuid}/
PATCH
Останавливает активную сессию пользователя
logoff
/api/webui/draft/spsessions/{uuid}/
PATCH
Генерация уникального URL для подключения к
raconnect
«Удаленному помощнику»
3.2.18 . Команды, связанные с системными параметрами
Доступные администратору URL-команды перечислены в таблице (см. Таблица 20).
Таблица 20 - Перечень URL-команд, связанных с системными параметрами
URL-команда
Тип
Описание
/api/webui/draft/tconfig
GET
Возвращает список системных параметров
/api/webui/draft/tconfig
PUT
Сохранение параметров конфигурации
3.2.19 . Команды, связанные с протоколами доставки
Доступные администратору URL-команды перечислены в таблице (см. Таблица 21).
Таблица 21 - Перечень URL-команд, связанных с протоколами доставки
URL-команда
Тип
Описание
/api/webui/draft/transports
GET
Возвращает список протоколов доставки
/api/webui/draft/transports
POST
Создает протокол доставки
/api/webui/draft/transports/{uuid}
GET
Возвращает протокол доставки
/api/webui/draft/transports/{uuid}
PUT
Обновляет протокол доставки
/api/webui/draft/transports/{uuid}
DELETE
Удаляет протокол доставки
/api/webui/draft/transports/types
GET
Возвращает список типов протоколов
доставки
/api/webui/draft/transports/gui/
GET
Возвращает описание для графического
{transport_type}
интерфейса
/api/webui/draft/transports/test/
POST
Тестирует параметры протокола доставки
{transport_type}
3.2.20 . Команды, связанные с работой мастеров
Доступные администратору URL-команды перечислены в таблице (см. Таблица 22).
Таблица 22 - Перечень URL-команд, связанных с работой мастеров
URL-команда
Тип
Описание
/api/webui/draft/wizards
GET
Возвращает список мастеров
/api/webui/draft/wizards/{uuid}
DELETE
Удаляет мастер с идентификатором {uuid}
/api/webui/draft/wizards/{uuid}/
PATCH
Создает объект после валидации собранных
finish
данных. Удаляет мастер из временного хранилища
/api/webui/draft/wizards/{uuid}/
PATCH
Обрабатывает данные для указанного шага мастера
step/{step}
Выпуск от мая 2024
22
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/webui/draft/wizards/{uuid}/
GET
Возвращает спецификацию действий и полей
step/{step}/gui
/api/webui/draft/wizards/types
GET
Возвращает список доступных типов мастеров
3.2.21 . Команды, связанные со списком ВРМ
Доступные администратору URL-команды перечислены в таблице (см. Таблица 23).
Таблица 23 - Перечень URL-команд, связанных со списком ВРМ
URL-команда
Тип
Описание
/api/webui/draft/workplaces
GET
Возвращает список ВРМ
3.3 . Доступные команды модуля «agent»
Доступные администратору URL-команды перечислены в таблице. Команды приведены для
последней опубликованной в API версии.
Версия API /api/agent/v1.1 удалена. Старые версии компонента «Агент» (ниже 4.2),
использовавшие этот API, перестанут работать без обновления на новую версию.
Таблица 24 - Перечень URL-команд модуля «agent»
URL-команда
Тип
Описание
/api/agent/v1.5/{uuid}/events/
PATCH
Уведомление о подключении пользователя к
connected
рабочему месту
/api/agent/v1.5/{uuid}/events/
PATCH
Уведомление об отключении пользователя от
disconnected
рабочего места
/api/agent/v1.5/{uuid}/legacy/
PATCH
Обработка внутренних процессов рабочего места
osmanager
/api/agent/v1.5/{uuid}/log
PATCH
Добавление записи в журнал рабочего места
/api/agent/v1.5/{uuid}/notifyComms
PATCH
Сохранение URL для коммуникации в параметрах
рабочего места
/api/agent/v1.5/{uuid}/policies
GET
Получение информации о политиках рабочего
места
/api/agent/v1.5/{uuid}/service_info
GET
Получение информации о рабочем месте
/api/agent/v1.5/{uuid}/settings
GET
Получение информации о настройках рабочего
места
/api/agent/v1.5/{uuid}/version
PATCH
Сохранение версии агента
/api/agent/v1.5/init
POST
Инициализация агента на рабочем месте
/api/agent/v1.5/test
PATCH
Запрос проверки корректности мастер-ключа
Выпуск от мая 2024
23
СЛЕТ.10001-01 91 01
3.4 . Доступные команды модуля «auth»
Доступные администратору URL-команды перечислены в таблице (см. Таблица 25).
Версия API /api/auth/v1 удалена. Старые версии компонента «Клиент», использовавшие
этот API, перестанут работать без обновления на новую версию.
Таблица 25 - Перечень URL-команд модуля «auth»
URL-команда
Тип
Описание
/api/auth/v1.4/authenticators
GET
Получение списка аутентификаторов
/api/auth/v1.4/legacy/login
POST
Аутентификация пользователя на базе
аутентификатора, логина и пароля.
При отправке запроса необходимо обязательно указать
один из параметров:
«authId»;
«auth»;
«authSmallName».
/api/auth/v1.4/legacy/logout
GET
Прекращение действие токена/сессии пользователя.
Токен аутентификации должен передаваться в
заголовке X-Auth-Token
/api/auth/v1.4/legacy/logout
POST
Прекращение действие токена/сессии пользователя.
Токен аутентификации должен передаваться в
заголовке X-Auth-Token
/api/auth/v1.4/settings
GET
Получение глобальных настроек сервера
3.5 . Доступные команды модуля «client»
Доступные администратору URL-команды перечислены в таблице (см. Таблица 26).
Таблица 26 - Перечень URL-команд модуля «client»
URL-команда
Тип
Описание
/api/client/v1.3/connectionInfo/
GET
API для выдачи параметров подключения компоненту
{uuid}
«Клиент» для RDP протоколов
/api/client/v1.3/enable/{service}/ GET
API для работы с TicketStore
{transport}
/api/client/v1.3/
GET
API для выдачи параметров подключения компоненту
preconnectionInfo/{uuid}
«Клиент» для RDP протоколов. Компонент «Клиент»
использует метод для проверки готовности сервиса к
подключению и уточнения используемого протокола. По
полученным данным принимает решение: завершить
неудачное подключение, подождать и повторить,
подключаться новым/старым методом
/api/client/v1.3/servicesList
GET
Получение списка сервисов
3.6 . Доступные команды модуля «health»
Доступные администратору URL-команды перечислены в таблице (см. Таблица 27).
Выпуск от мая 2024
24
СЛЕТ.10001-01 91 01
Таблица 27 - Перечень URL-команд модуля «health»
URL-команда
Тип
Описание
/api/health
GET
Проверка состояния сервера
Собираются общие показатели и набор числовых метрик.
Оценка состояния должна производиться в инициаторе запроса на основе набора правил и
пороговых значений с учетом конкретной конфигурации системы.
Для разных конфигураций системы один и тот же показатель в абсолютном выражении может
соответствовать состоянию и «PASS», и «FAIL».
3.7 . Доступные команды модуля «wsproxy»
Доступные администратору URL-команды перечислены в таблице (см. Таблица 28).
Таблица 28 - Перечень URL-команд модуля «wsproxy»
URL-команда
Тип
Описание
/api/wsproxy/v1/verify/{token}
POST
Валидация токена компонента «Шлюз» для подключения
к компоненту «Универсальный диспетчер».
В случае успеха возвращает параметры целевого хоста
для подключения через компонент «Шлюз»
/api/wsproxy/v1.1/verify/{token}
POST
Валидация токена компонента «Шлюз» для подключения
к компоненту «Универсальный диспетчер» с поддержкой
информации по протоколу (TCP или UDP).
Запрос доступен с Termidesk версии 5.0.
В отличие от запроса версии v1 передается
дополнительное поле «proto» с указанием значения
протокола, по умолчанию TCP:
1
HTTP 200
2
{
3
"host": "192.0.2.1",
4
"port": 6195,
5
"ssl_target": true,
6
"proto": "tcp"
7
}
3.8 . Доступные команды модуля «discover»
Доступные администратору URL-команды перечислены в таблице (см. Таблица 29).
Таблица 29 - Перечень URL-команд модуля «discover»
URL-команда
Тип
Описание
/api/discover/
GET
Возвращает список модулей API, предоставляемых
компонентом «Универсальный диспетчер»
Выпуск от мая 2024
25
СЛЕТ.10001-01 91 01
4 . НАЧАЛО РАБОТЫ С REST API КОМПОНЕНТА «УДАЛЕННЫЙ ПОМОЩНИК»
4.1 . Формат URL-команд для компонента «Удаленный помощник»
Общий вид команд реализован следующим образом:
/api/<module>,
где:
<module> - наименование модуля, реализованного в REST API.
Список модулей API, предоставляемого компонентом, может быть получен URL-командой /api/
discover/.
Пример команды через curl:
1
curl -X 'GET' \
2
3
-H 'accept: application/json' \
4
-H 'X-CSRFToken:
HjXcGpVu8bSPEoq4NQ0qo0KpdfwoEbuTbElG3J7uSFr2aK3oPtNqlnw4VEARS2HY'
где:
assistant.termidesk.local
- сетевой адрес или полное доменное имя узла компонента
«Удаленный помощник» Termidesk;
X-CSRFToken
- уникальный идентификатор запроса, генерируемый Django. Значение токена
уникально и время его жизни ограничено.
4.2 . Электронный справочник по командам REST API компонента «Удаленный помощник»
Полная информация о параметрах и командах REST API доступна при вводе URL-команды
где
assistant.termidesk.local - сетевой адрес или полное доменное имя узла компонента
«Удаленный помощник» Termidesk.
Выпуск от мая 2024
26
СЛЕТ.10001-01 91 01
5 . ДОСТУПНЫЕ КОМАНДЫ REST API КОМПОНЕНТА «УДАЛЕННЫЙ
ПОМОЩНИК»
5.1 . Доступные команды модуля «settings»
Доступные администратору URL-команды перечислены в таблице (см. Таблица 30).
Таблица 30 - Перечень URL-команд модуля «settings»
URL-команда
Тип
Описание
/assistant/api/{session_id}/
GET
Получение информации о сессии.
settings
Пример запроса через утилиту curl:
1
assistant.termidesk.local/
assistant/api/' -H 'accept:
application/json' -H 'Content-
Type: application/json' -d
"string"
где:
--insecure - отключение проверки валидности
сертификатов. Выполнение запроса без использования
проверки SSL допустимо только на тестовых стендах. В
производственной среде необходимо установить валидные
сертификаты;
assistant.termidesk.local - сетевой адрес или полное
доменное имя узла серверной части компонента «Удаленный
помощник» Termidesk
/assistant/api
PUT
Создание сессии и возврат относительной ссылки на
подключение
Выпуск от мая 2024
27
СЛЕТ.10001-01 91 01
6 . НАЧАЛО РАБОТЫ С REST API КОМПОНЕНТА «ОРКЕСТРАТОР»
6.1 . Формат URL-команд для компонента «Оркестратор»
Общий вид команд реализован следующим образом:
/api/<ver>/<module>,
где:
<ver> - версия API;
<module> - наименование модуля, реализованного в REST API.
Пример команды через curl:
1
curl -X 'GET' \
2
3
-H 'accept: application/json' \
4
-H 'X-ORC-TOKEN-APP:
HjXcGpVu8bSPEoq4NQ0qo0KpdfwoEbuTbElG3J7uSFr2aK3oPtNqlnw4VEARS2HY'
где:
orchestrator.termidesk.local - сетевой адрес или полное доменное имя узла компонента
«Оркестратор» Termidesk;
X-ORC-TOKEN-APP - токен аутентификации компонента «Оркестратор» в поставщике ресурсов
OpenStack. Значение токена уникально и время его жизни ограничено.
6.2 . Электронный справочник по командам REST API компонента «Оркестратор»
Полная информация о параметрах и командах REST API доступна при вводе URL-
команды https://orchestrator.termidesk.local/api/docs/,
где
orchestrator.termidesk.local - сетевой адрес или полное доменное имя узла компонента
«Оркестратор» Termidesk.
Выпуск от мая 2024
28
СЛЕТ.10001-01 91 01
7 . ДОСТУПНЫЕ КОМАНДЫ REST API КОМПОНЕНТА «ОРКЕСТРАТОР»
7.1 . Доступные команды модуля «health»
7.1.1 . Команды, связанные с проверкой состояния Termidesk
Доступные администратору URL-команды перечислены в таблице (см. Таблица 31).
Таблица 31 - Перечень URL-команд, связанных с проверкой состояния Termidesk
URL-команда
Тип
Описание
api/draft/health
GET
Проверка состояния Termidesk
api/draft/orc/health
GET
Проверка состояния компонента «Оркестратор»
Termidesk
7.2 . Доступные команды модуля «infra»
7.3 . Команды, связанные с управлением инфраструктурой Termidesk
Доступные администратору URL-команды перечислены в таблице (см. Таблица 32).
Таблица 32 - Перечень URL-команд, связанных с управлением инфраструктурой Termidesk
URL-команда
Тип
Описание
api/draft/infra
POST
Создание ВМ для поставщика ресурсов OpenStack
api/draft/configure_infra
POST
Подготовка среды функционирования Termidesk на
ВМ
api/draft/install_termidesk
POST
Установка программного комплекса Termidesk на ВМ
7.4 . Доступные команды для управления компонентом «Универсальный диспетчер»
7.4.1 . Команды, связанные с управлением доменами аутентификации
Доступные администратору URL-команды перечислены в таблице (см. Таблица 33).
Таблица 33 - Перечень URL-команд, связанных с управлением доменами аутентификации
URL-команда
Тип
Описание
/api/draft/auth
POST
Добавление домена аутентификации
/api/draft/auth/types
GET
Возвращение списка типов доменов
аутентификации
/api/draft/auth
GET
Возвращение списка доменов аутентификации
/api/draft/auth/<id>/groups
GET
Возвращение списка групп пользователей домена
аутентификации
/api/draft/auth/<id>/groups
POST
Добавление группы домена аутентификации
/api/draft/auth/<id>/users
GET
Возвращение списка пользователей домена
аутентификации
/api/draft/auth/<id>/users
POST
Добавление пользователя домена аутентификации
/api/draft/auth/<id>/users/<user>/
GET
Возвращение списка фондов ВРМ, назначенных
pools
пользователю
Выпуск от мая 2024
29
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/draft/auth/<id>/users/<user>/vms
GET
Возвращение списка ВРМ, назначенных
пользователю
7.5 . Команды, связанные с управлением поставщиками ресурсов
Доступные администратору URL-команды перечислены в таблице (см. Таблица 34).
Таблица 34 - Перечень URL-команд, связанных с управлением поставщиками ресурсов
URL-команда
Тип
Описание
/api/draft/providers
POST
Добавление поставщика ресурсов
/api/draft/providers/overview
GET
Возвращение списка поставщиков ресурсов
/api/draft/providers/<id>/services/
GET
Возвращение списка шаблонов ВРМ
overview
/api/draft/providers/<id>/services/types
GET
Возвращение списка типов шаблонов ВМ
/api/draft/providers/<uid>/services/gui/
GET
Возвращение описания графического интерфейса
<type>
шаблонов ВРМ
7.6 . Команды, связанные с управлением шаблонами ВМ
Доступные администратору URL-команды перечислены в таблице (см. Таблица 35).
Таблица 35 - Перечень URL-команд, связанных с управлением шаблонами ВМ
URL-команда
Тип
Описание
/api/draft/providers/<uuid>/services
POST
Создание шаблона ВРМ
/api/draft/providers/<prov>/services/
GET
Возвращение информации о шаблоне ВРМ
<id>
7.6.1 . Команды, связанные с управлением параметрами гостевых ОС
Доступные администратору URL-команды перечислены в таблице (см. Таблица 36).
Таблица 36 - Перечень URL-команд, связанных с управлением параметрами гостевых ОС
URL-команда
Тип
Описание
/api/draft/osmanagers
POST
Добавление параметра управления гостевой ОС
7.6.2 . Команды, связанные с управлением протоколами доставки
Доступные администратору URL-команды перечислены в таблице (см. Таблица 37).
Таблица 37 - Перечень URL-команд, связанных с управлением протоколами доставки
URL-команда
Тип
Описание
/api/draft/transports
POST
Добавление протокола доставки
/api/draft/transports/types
GET
Возвращение списка типов протоколов доставки
/api/draft/transports/overview
GET
Возвращение списка протоколов доставки
Выпуск от мая 2024
30
СЛЕТ.10001-01 91 01
7.6.3 . Команды, связанные с управлением фондами рабочих мест
Доступные администратору URL-команды перечислены в таблице (см. Таблица 38).
Таблица 38 - Перечень URL-команд, связанных с управлением фондами рабочих мест
URL-команда
Тип
Описание
/api/draft/pools
GET
Возвращение списка фондов ВРМ
/api/draft/pools
POST
Добавление фонда ВРМ
/api/draft/pools/<id>
GET
Возвращение информации о фонде ВРМ
/api/draft/pools/<id>/vms
GET
Возвращение списка назначенных ВРМ
/api/draft/pools/<id>/cache
GET
Возвращение списка ВРМ, находящихся в кеше
/api/draft/pools/<id>/groups
POST
Добавление группы в фонд ВРМ
/api/draft/pools/<id>/transports
POST
Добавление протокола доставки в фонд ВРМ
/api/draft/pools/gui
GET
Возвращение описания графического интерфейса
фонда ВРМ
/api/draft/pools/<id>/groups/overview
GET
Возвращение списка групп фонда ВРМ
/api/draft/pools/<id>/transports/
GET
Возвращение списка протоколов доставки фонда
overview
ВРМ
7.6.4 . Команды, связанные с аудитом и мониторингом Termidesk
Доступные администратору URL-команды перечислены в таблице (см. Таблица 39).
Таблица 39 - Перечень URL-команд, связанных с аудитом и мониторингом Termidesk
URL-команда
Тип
Описание
/api/draft/monitoring
GET
Возвращение списка операций
/api/draft/audit
GET
Возвращение списка событий аудита
7.6.5 . Команды, связанные с управлением сессиями
Доступные администратору URL-команды перечислены в таблице (см. Таблица 40).
Таблица 40 - Перечень URL-команд, связанных с управлением сессиями
URL-команда
Тип
Описание
/api/draft/sessions
GET
Возвращение списка активных сессий
пользователей
/api/draft/sessions/<session>/logoff
PATCH
Останов активной сессии пользователя
7.6.6 . Команды, связанные с запросами о данных ВМ
Доступные администратору URL-команды перечислены в таблице (см. Таблица 41).
Таблица 41 - Перечень URL-команд, связанных с запросами о данных ВМ
URL-команда
Тип
Описание
/api/draft/util/resources
GET
Возвращение списка ВМ поставщика ресурсов
OpenStack
Выпуск от мая 2024
31
СЛЕТ.10001-01 91 01
URL-команда
Тип
Описание
/api/draft/util/images
GET
Возвращение списка образов ВМ поставщика ресурсов
OpenStack
Выпуск от мая 2024
32
СЛЕТ.10001-01 91 01
8 . ПРИНЯТЫЕ ТЕРМИНЫ И ОПРЕДЕЛЕНИЯ
Термин
Определение
Компонент «Агент»
Собирательное название для следующих компонентов Termidesk:
«Агент виртуального рабочего места»;
«Агент узла виртуализации»;
«Сессионный агент»;
«Видеоагент»;
«Агент виртуальных смарт-карт».
Самостоятельный компонент, отвечающий за контролируемую доставку ВРМ, взаимодействие
с «Универсальным диспетчером» и «Менеджером рабочих мест»
Компонент «Агент
Компонент Termidesk. Устанавливается в гостевую ОС при подготовке базового ВРМ.
виртуального
Выполняет взаимодействие с «Универсальным диспетчером», конфигурирует ВРМ, фиксирует
рабочего места»
действия пользователя, реализует передачу управляющих сообщений
Виртуальное
Также: ВРМ.
рабочее место
Развернутая на ВМ ОС с установленным «Агентом виртуального рабочего места» и
необходимым прикладным ПО. Подключение к ВРМ происходит при помощи протоколов
удаленного доступа, чаще всего называемыми протоколами доставки
Гостевая ОС
ОС, функционирующая на ВМ
Группы рабочих
Также: группы ВРМ.
мест
Функциональное объединение множества фондов ВРМ по определенному признаку
Домен
Способ проверки субъектов и их полномочий
аутентификации
Компонент
Компонент Termidesk. Отделяемый компонент программного комплекса, отвечающий за
«Менеджер рабочих
взаимодействие с поставщиком ресурсов и управления жизненным циклом ВРМ, включая
мест»
создание, настройку, запуск, отключение и удаление.
Является обработчиком фоновых задач.
Устанавливается из пакета termidesk-vdi. Наименование службы после установки:
termidesk-taskman.service
Компонент
Компонент Termidesk. Самостоятельный компонент, отвечающий за согласованную работу
«Оркестратор»
всех компонентов программного комплекса при децентрализованном развертывании, для нужд
отказоустойчивости и комплексирования с облачными службами
Поставщик ресурсов
ОС, платформа виртуализации или терминальный сервер (MS RDS/STAL), предоставляющие
вычислительные мощности, ресурсы хранения данных, а также сетевые ресурсы для
размещения фондов ВРМ
Протокол доставки
Поддерживаемый в Termidesk протокол удаленного доступа к ВРМ
Компонент
Компонент Termidesk. Отделяемый компонент программного комплекса, отвечающий за
«Универсальный
идентификацию пользователей, назначение им ВРМ и контроля доставки ВРМ.
диспетчер»
Устанавливается из пакета termidesk-vdi. Наименование службы после установки:
termidesk-vdi.service
Фонд рабочих мест
Также: фонд ВРМ.
Совокупность подготовленных ВРМ для доставки по одному или нескольким протоколам
удаленного доступа в зависимости от полномочий пользователей
Компонент «Шлюз»
Компонент Termidesk. Самостоятельный компонент, отвечающий за туннелирование
протоколов доставки, использующих транспортный протокол TCP.
В более старой реализации устанавливается из пакета termidesk-vdi. Наименование службы
после установки: termidesk-wsproxy.service.
В новой реализации устанавливается из пакета termidesk-gateway, поддержка старой
реализации удалена, начиная с Termidesk версии 5.0. Наименование службы после установки:
termidesk-gateway.service.
Выпуск от мая 2024
33
СЛЕТ.10001-01 91 01
Термин
Определение
Портал
Предоставляет веб-интерфейс для управления Termidesk и интерфейс swagger для доступа к
администратора
ограниченному списку модулей документации по командам REST API («auth», «discover»,
«health», «agent», «webui»).
Портал пользователя Предоставляет пользовательский веб-интерфейс Termidesk (без доступа к функциям
управления) и интерфейс swagger для доступа к ограниченному списку модулей
документации по командам REST API
Портал
Предоставляет функции обоих вариантов - и «Портала администратора», и «Портала
универсальный
пользователя». При этом активируется доступ ко всем модулям документации по командам
REST API, предоставляемым интерфейсом swagger
Ключ
Применяется в контексте файла, не опции в команде. Последовательность псевдослучайных
чисел, сгенерированная особым образом
Сертификат
Артефакт, содержащий информацию о владельце ключа и подтверждающий принадлежность
ключа владельцу
Выпуск от мая 2024
34
СЛЕТ.10001-01 91 01
9 . ПЕРЕЧЕНЬ СОКРАЩЕНИЙ
Сокращение
Пояснение
ВРМ
Виртуальное рабочее место
ОС
Операционная система
API
Application Programming Interface (интерфейс прикладного
программирования)
ID
Identification Data (идентификатор)
RDP
Remote Desktop Protocol (протокол удаленного рабочего стола)
Termidesk
Программный комплекс «Диспетчер подключений виртуальных рабочих
мест Termidesk»
URL
Uniform Resource Locator (унифицированный указатель ресурса)
Выпуск от мая 2024
35