Объект gw

Доступные команды объекта gw приведены в таблице (см. Доступные команды объекта gw).

Таблица 1. Доступные команды объекта gw
Команда Описание

set gw mgt <параметр> <значение>

Настройка управляющего сервера.

Параметром может быть:

  • listen – настройка прослушивания входящих подключений;

  • metrics – настройка получения метрик Шлюза;

  • path – путь для получения статистики Шлюза (по умолчанию – /api/health);

  • ssl-profile-id – Серверный SSL-Профиль;

  • token – токен доступа для получения статистики Шлюза.

Для интеграции с Termidesk значение может быть получено из параметра HEALTH_CHECK_ACCSESS_KEY, определенного в конфигурационном файле /etc/opt/termidesk-vdi/termidesk.conf узла компонента «Универсальный диспетчер» Termidesk.

Для параметра listen могут устанавливаться дополнительные параметры:

  • ip – IP-адрес прослушивания входящих подключений;

  • port – порт прослушивания входящих подключений.

Для параметра metrics могут устанавливаться дополнительные параметры:

  • path – путь для получения метрик Шлюза (по умолчанию – /api/health/metrics);

  • token – токен доступа для получения метрик Шлюза

Для интеграции с Termidesk значение может быть получено из параметра METRICS_ACCSESS_KEY, определенного в конфигурационном файле /etc/opt/termidesk-vdi/termidesk.conf узла компонента «Универсальный диспетчер» Termidesk.

set gw rabbitmq <параметр> <значение>

Настройка клиента RabbitMQ.

Параметром может быть:

  • exchange – координатор маршрутизации сообщений, определенный в RabbitMQ. Отвечает за маршрутизацию сообщений в разные очереди;

  • ipset-id – IP-Фонд для взаимодействия с RabbitMQ;

  • pass – пароль пользователя для подключения к серверу RabbitMQ;

  • refreshtime – интервал (в секундах) обновления регистрационной информации (URL и другие данные) Шлюза (значение от 10 до 100000, по умолчанию – 60);

  • routingkey – ключ маршрутизации RabbitMQ, используемый для маршрутизации задачи в очереди (по умолчанию – termidesk_appnode);

  • single – способ передачи данных (по умолчанию – false);

  • ssl-profile-id – Клиентский SSL-Профиль (по умолчанию – backend-default);

  • timeout – время (в секундах) ожидания ответа от сервера RabbitMQ (значение от 1 до 60, по умолчанию – 10);

  • url – URL-адрес для подключения к серверу RabbitMQ;

  • user – имя пользователя для подключения к серверу RabbitMQ.

Для параметра single возможны значения:

  • true – передача данных до первого подтверждения;

  • false – передача данных по циклу (бесконечно)

set gw server <имя>

Создание Шлюза

set gw server <имя> <параметр> <значение>

Настройка параметров Шлюза.

Параметром может быть:

  • checktoken – настройка взаимодействия с компонентом «Универсальный диспетчер» Termidesk;

  • description – комментарий для сервера;

  • rabbitmq – настройка клиента RabbitMQ;

  • ssl-profile-id – Серверный SSL-Профиль;

  • tcp-downstream – настройка переподключения Шлюза к рабочим местам Termidesk;

  • tera-udp – настройка поддержки протокола UDP для протокола TERA на Шлюзе;

  • vip – настройка Виртуального Сервера;

  • vrf – имя VRF (по умолчанию – default);

  • websocket – настройка подключения к компоненту «Клиент» Termidesk.

Для параметра checktoken могут устанавливаться дополнительные параметры:

  • ipset-id – IP-Фонд, используемый для взаимодействия с компонентом «Универсальный диспетчер» Termidesk;

  • ssl-profile-id – Клиентский SSL-Профиль (по умолчанию – backend-default);

  • url – URL, поддерживаемый компонентом «Универсальный диспетчер» Termidesk с ролью «Портал пользователя» для обслуживания API-запросов по валидации подключений, запрашиваемых через Шлюз.

Cледует использовать актуальные значения версий API для соответствующей версии компонента «Универсальный диспетчер» Termidesk.

Для параметра rabbitmq могут устанавливаться дополнительные параметры:

  • exchange – координатор маршрутизации сообщений, определенный в RabbitMQ. Отвечает за маршрутизацию сообщений в разные очереди;

  • ipset-id – IP-Фонд для взаимодействия с RabbitMQ;

  • pass – пароль пользователя для подключения к серверу RabbitMQ;

  • refreshtime – интервал (в секундах) обновления регистрационной информации (URL и другие данные) Шлюза (значение от 10 до 100000, по умолчанию – 60);

  • routingkey – ключ маршрутизации RabbitMQ, используемый для маршрутизации задачи в очереди (по умолчанию – termidesk_appnode);

  • single – способ передачи данных (по умолчанию – false). Возможные значения: true – передача данных до первого подтверждения, false – передача данных по циклу (бесконечно);

  • ssl-profile-id – Клиентский SSL-Профиль (по умолчанию – backend-default);

  • timeout – время (в секундах) ожидания ответа от сервера RabbitMQ (значение от 1 до 60, по умолчанию – 10);

  • url – URL-адрес для подключения к серверу RabbitMQ;

  • user – имя пользователя для подключения к серверу RabbitMQ.

Для параметра tcp-downstream могут устанавливаться дополнительные параметры:

  • ipset-id – IP-Фонд для взаимодействия с рабочим местом Termidesk;

  • reconnect – количество разрешенных переподключений сессии пользователя (значение от 0 до 10, по умолчанию – 0);

Разные протоколы удаленного доступа могут требовать разных значений параметра:

  • для RDP нужно использовать ненулевое значение, поскольку некоторые функции (например, перенаправление USB в гостевую ОС рабочего места по протоколу RDP) могут требовать переподключения;

  • для TERA и SPICE нужно использовать значение по умолчанию (0).

  • ssl-profile-id – Клиентский SSL-Профиль (по умолчанию – backend-default).

Для параметра tera-udp могут устанавливаться дополнительные параметры:

  • src ip – IP-адрес источника, т.е. адрес, с которого Шлюз устанавливает UDP-соединение с рабочим местом Termidesk;

Для параметра src ip значение 0.0.0.0 указывает на использование всех IP-адресов.

  • src port – порт источника (по умолчанию – 0);

  • src vrf – VRF источника (по умолчанию – default);

  • vip ip – IP-адрес Виртуального Сервера для TERA;

Параметр vip ip может принимать любое значение, т.е. IP-адрес может отличаться от IP-адреса Шлюза или может быть таким же. Указывается IP-адрес именно Виртуального Сервера, если Шлюз скрывается за Виртуальным Сервером.

  • vip port – порт Виртуального Сервера для TERA (по умолчанию – 443);

  • vrf – VRF для TERA (по умолчанию – default).

Для параметра vip могут устанавливаться дополнительные параметры:

  • ip – IP-адрес Виртуального Сервера;

  • port – порт Виртуального Сервера.

Для параметра websocket могут устанавливаться дополнительные параметры:

  • pingtimeout – время ожидания (в секундах) соединения (значение от 0 до 100000, по умолчанию – 30)