# Managing the Endpoint from the Command Line Interface
Терминал TrueConf Group предоставляет возможность управления не только с пульта и через веб-интерфейс, но и с помощью интерфейса командной строки (Command Line Interface, CLI). Для этого используется подключение по SSH из любого имеющегося у вас приложения, например, PuTTY или OpenSSH.
Данная возможность также позволяет легко интегрировать TrueConf Group в системы управления переговорными комнатами (например, Unitsolutions Coordinator), и вывести в интерфейс планшета кнопки для контроля терминала.
# Как подключиться
Шаг 1. Чтобы подключиться к терминалу из командной строки, сначала требуется установить пароль доступа:

В панели управления перейдите в раздел Configuration → Maintenance.
Укажите пароль для доступа к терминалу по SSH в поле секции .
Нажмите Apply для сохранения пароля на устройстве. В целях безопасности он скрывается, но вы всегда сможете его посмотреть с помощью кнопки
.
Шаг 2. Теперь вам требуется подключиться из SSH-клиента. Используется логин admin
:
- Установите (если ранее этого не сделали) и запустите клиент SSH, например, из пакета OpenSSH или любой другой. Во многих операционных системах он уже присутствует, например, в Windows 10 и новее достаточно просто выполнить команду:
ssh admin@[group_ip]
где [group_ip]
— IP-адрес вашего терминала.
2. Укажите созданный на шаге 1 пароль.
3. Появится приветственный текст CLI TrueConf Group. Теперь вы можете ввести любые поддерживаемые команды:
C:\Users\operator>ssh admin@10.110.8.223
admin@10.110.8.223's password:
Last login: Thu Apr 21 22:55:57 2022 from 192.168.43.85
Welcome in Trueconf Group Control Console! Enter "help" to get list of available commands
TCG console>
Чтобы вывести список команд, используйте команду HELP
.
Для вывода информации о конкретной команде [command]
введите [command] HELP
.
# Commands
ANSWER — принять входящий вызов
Параметр | Описание |
---|---|
VIDEO | Принять входящий вызов, если для него выключен автоприём. Это можно проверить в панели управления в разделе Configuration → Calls. |
AUDIOCODEC — разрешить или запретить использование аудиокодека
Параметр | Описание |
---|---|
[CODEC] ON | Разрешить использовать аудиокодек [CODEC] |
[CODEC] OFF | Запретить использовать аудиокодек [CODEC] |
[CODEC] GET | Получить текущее состояние кодека [CODEC] |
GET | Получить текущее состояние всех аудиокодеков |
Learn more about all codecs supported by the endpoint in the Supported protocols and codecs section.
AUDIOMUTE — управление микрофоном
Параметр | Описание |
---|---|
ON | Отключить микрофон |
OFF | Включить микрофон |
GET | Получить текущее состояние микрофона |
REGISTER | Получать уведомления об изменении состояния микрофона. Если оператор терминала будет включать/выключать микрофон, то в консоли будут выводиться соответсвенно сообщения: event: audiomute off и event: audiomute on Данные сообщения будут поступать до их отключения с помощью команды UNREGISTER и только в текущем сеансе подключения по SSH. |
UNREGISTER | Отключить уведомления об изменении состояния микрофона |
AUTOANSWER — настройка автоматического приёма вызовов
Параметр | Описание |
---|---|
YES | Автоматический приём первого входящего вызова. Аналогично выставлению значения Auto у параметра Settings → Calls → → |
NO | Отключение автоответа на входящий вызов. Аналогично выставлению значения у параметра Settings → Calls → → |
DND | Запрет входящих вызовов, все они будут автоматически сбрасываться. Аналогично выставлению значения у параметра Settings → Calls → → |
GET | Получить текущее значение параметра автоприёма вызова |
CALLINFO — получить информацию о текущем вызове
Команда выводит техническую информацию об одном или нескольких (в случае использования функции MCU) активных подключениях. Параметр CallID
нужен для идентификации вызова и используется в других командах. Пример работы команды:
TCG console>CALLINFO
Active calls:
CallID:"8"
Direction:Outgoing
Contact URI:"sip:admin@demoi.trueconf.com"
User agent:"TrueConf Server 5.0.0.1586"
Duration:230 sec
Bitrate:"1008"
Audio in: Compression:"G.722.1C (32 kbit/s)", Bitrate:"32", Packets:"11304", Lost packets:"0", Loss rate:"0"%, Jitter:"30"
Audio out: Compression:"G.722.1C (48 kbit/s)", Bitrate:"48", Packets:"11301", Lost packets:"0", Loss rate:"0"%, Jitter:"10"
Video in: Codec:"H264", Bitrate:"960", Resolution:"1280x720", Frame rate:"27", Packets:"35495", Lost packets:"0", Lossrate:"0%", Jitter:"11%"
Video out: Codec:"H264", Bitrate:"960", Resolution:"1280x720", Frame rate:"30", Packets:"39959", Lost packets:"0", Lossrate:"0%", Jitter:"2%
CAMERA — управление PTZ камерой
Параметр | Описание |
---|---|
LEFT, RIGTH, UP, DOWN | Повернуть камеру соответсвенно влево, вправо, вверх, вниз |
ZOOM+, ZOOM- | Приблизить или отдалить изображение |
STOP | Остановить перемещение камеры |
Проверить правильность настроек камеры можно в панели управления терминалом в разделе Settings → → .
CAMERAMUTE — управление передачей изображения с камеры
Параметр | Описание |
---|---|
ON | Отключить видеопоток от камеры |
OFF | Включить видеопоток от камеры |
GET | Получить текущее состояние камеры |
REGISTER | Подписаться на получение уведомлений на отключение/включение камеры: в консоль будут выводиться соответственно сообщения event: cameramute on и event: cameramute off .Данные сообщения будут поступать до их отключения с помощью команды UNREGISTER и только в текущем сеансе подключения по SSH. |
UNREGISTER | Отключить уведомления об изменении состояния камеры |
CONTENT — управление показом контента
Параметр | Описание |
---|---|
PREVIEW | Включить предварительный просмотр контента, не отправляя его в конференцию |
SHARE | Начать трансляцию контента в конференцию |
STOP | Остановить трансляцию контента |
DIAL — вызов абонента
Параметр | Описание |
---|---|
URI | Осуществить исходящий вызов по заданному URI |
Пример уведомления при исходящем вызове (обратите внимание, что выводится CallID
абонента, в примере он равен 4
):
Outgoing call [4], ringing:
Name:"Room"
Contact URI:"sip:ROOM@VIDEO.SERVER.COM:5060"
Protocol:"SIP"
User agent:"TrueConf Server 5.0.2.1033"
Пример уведомления об успешном приёме исходящего вызова:
Outgoing call [4] confirmed:
Name:"Room"
Contact URI:"sip:ROOM@VIDEO.SERVER.COM:5060"
Protocol:"SIP"
User agent:"TrueConf Server 5.0.2.1033"
Уведомление об отмене на стороне абонента приёма исходящего вызова:
Dial failed
HANGUP — завершить вызов
Параметр | Описание |
---|---|
VIDEO [CallID] | Завершить подключение с ID [CallID] . Значение [CallID] выводится при установлении соединения, например, как показано в примере уведомлений для команды DIAL |
ALL | Завершить все текущие подключения |
Пример работы команды:
TCG console>hangup video 266
Hangup the video call [266] passed
TCG console>
Hangup call [266]:
Name:"Room"
Contact URI:"h323:room@video.company.com:1720"
Protocol:"H.323"
HOSTNAME — получить или установить имя системы
Параметр | Описание |
---|---|
SET [NAME] | Установить имя системы |
GET | Вывести имя системы |
IPADDRESS — получить IP-адрес TrueConf Group
Параметр | Описание |
---|---|
GET | Вывести IP-адрес TrueConf Group |
SHOW | Вывести расширенную информацию о настройках сетевых интерфейсов |
Пример работы команды IPADDRESS SHOW
:
TCG console>TCG console>ipaddress show
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
inet 127.0.0.1/8 scope host lo
valid_lft forever preferred_lft forever
2: eth0: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc pfifo_fast state UP group default qlen 1000
link/ether 3c:7c:3f:7e:df:f2 brd ff:ff:ff:ff:ff:ff
inet 10.110.8.223/20 brd 10.110.15.255 scope global noprefixroute dynamic eth0
valid_lft 22047sec preferred_lft 22047sec
inet6 fe80::fe24:7d8f:e7f3:a62c/64 scope link noprefixroute
valid_lft forever preferred_lft forever
LAYOUT — управление раскладкой (в групповой конференции при использовании функции MCU)
Параметр | Описание |
---|---|
EQUAL | Установить раскладку с одинаковым размером видеоокон |
TOP | Установить раскладку с приоритетным окном сверху |
BOTTOM | Установить раскладку с приоритетным окном снизу |
LEFT | Установить раскладку с приоритетным окном слева |
RIGHT | Установить раскладку с приоритетным окном справа |
AUTO | Установить автоматическую раскладку |
GET | Получить текущий тип раскладки |
LISTDEVICE — получить список доступных аудио и видео устройств, подключенных к терминалу
Параметр | Описание |
---|---|
Без параметра | Вывести информацию обо всех аудио/видео устройствах |
AUDIO | Получить список всех аудиоустройств, подключенных к терминалу |
AUDIO CAPTURE | Получить список всех устройств захвата звука, подключенных к терминалу |
AUDIO RENDER | Получить список всех устройств воспроизведения аудио, подключенных к терминалу |
VIDEO | Получить список всех видеоустройств, подключенных к терминалу |
VIDEO CAPTURE | Получить список всех устройств захвата изображения, подключенных к терминалу |
VIDEO RENDER | Получить список всех устройств вывода изображения (дисплеев), подключенных к терминалу |
При использовании любой из команд у каждого устройства выводится его идентификатор в параметре id
— он используется при выполнении других команд работы с оборудованием, например, для выбора устройства SETDEVICE
.
Пример получения списка всех аудио и видео устройств:
TCG console>listdevice
Available audio capture devices:
id="1", "Line in", active:False, default:False, level:100%, boost:0, aec:0, agc:False, noise suppressor:False
id="2", "HDMI1", active:False, default:False, level:100%, boost:0, aec:0, agc:False, noise suppressor:False
id="3", "HDMI2", active:False, default:False, level:100%, boost:0, aec:0, agc:False, noise suppressor:False
id="4", "eMeet M2 [USB Audio]", active:True, default:False, level:100%, boost:0, aec:0, agc:False, noise suppressor:False
Available audio render devices:
id="1": "Display port", active:False, default:False, level:86%
id="2": "HDMI", active:False, default:False, level:52%
id="3": "Line out", active:False, default:False, level:17%
id="4": "eMeet M2 [USB Audio]", active:True, default:False, level:4%
id="5": "All outputs", active:False, default:False, level:50%
Available video capture devices:
id="1": "Clevermic 1212U/HD Camera", video:1280x720@60.01
id="2": "HDMI1/MZ0380:RAW 00.00 12abf55f", video:1920x1080@0.0
id="3": "HDMI2/MZ0380:RAW 01.00 12abf55f", video:1920x1080@0.0
id="4": "USB/file", video:1920x1080@25.0
Available video render devices:
id="1": "BenQ GL2460", port: HDMI", active:True
MULTIPOINT — управление функцией MCU
Параметр | Описание |
---|---|
ON | Активация функции MCU |
OFF | Отключение функции MCU |
GET | Вывести текущий статус функции MCU |
PROTOCOL — управление использованием протоколов SIP и H.323
Параметр | Описание |
---|---|
PROTOCOL SIP [ON/OFF] | Включение/отключение работы по протоколу SIP |
PROTOCOL H323 [ON/OFF] | Включение/отключение работы по протоколу H.323 |
PROTOCOL SIP SRTP [ON/OFF/MANDATORY] | Управление использованием SRTP кодирования при звонках по протоколу SIP: ON — использование кодирования предпочтительно, но необязательно; OFF — не используется; MANDATORY — терминал не будет соединяться с абонентами, у которых отсутсвует поддержка SRTP |
PROTOCOL H323 H235 [ON/OFF/MANDATORY] | Управление использованием H.235 кодирования при звонках по протоколу H.323: ON — использование кодирования предпочтительно, но необязательно; OFF — не используется; MANDATORY — терминал не будет соединяться с абонентами, у которых отсутсвует поддержка H.235 |
PROTOCOL SIP GET | Вывести текущий статус использования протокола SIP |
PROTOCOL H323 GET | Вывести текущий статус использования протокола H.323 |
PROTOCOL SIP SRTP GET | Вывести текущий статус использования SRTP кодирования при звонках по протоколу SIP |
PROTOCOL H323 H235 GET | Вывести текущий статус использования H.235 кодирования при звонках по протоколу H.323 |
Одновременно отключить оба протокола SIP и H.323 нельзя. Если один из них деактивирован и происходит попытка отключения второго, то первый автоматически активируется.
REBOOT — выполнить перезагрузку TrueConf Group
Команда аналогична нажатию кнопки в разделе Settings → Power supply → Power control панели управления терминалом.
Данная команда выполняется сразу после её отправки, без предварительного запроса подтверждения (в отличие от аналогичного действия в панели управления).
SELFVIEW — установить режим отображения собственного локального видео (селфвью) на экране терминала (не влияет на его отображение в раскладке)
Параметр | Описание |
---|---|
ON | Отображать локальное видео |
OFF | Скрывать локальное видео |
TOGGLE | Переключить локальное видео |
GET | Запросить состояние локального видео |
SETDEVICE — выбрать устройство для захвата или вывода медиапотоков
В перечисленных далее командах используется параметр DeviceId
— идентификатор устройства. Его можно получить с помощью команды LISTDEVICE
.
Параметр | Описание |
---|---|
AUDIO CAPTURE [DeviceId] | Выбрать устройство DeviceId для захвата звука |
AUDIO RENDER [DeviceId] | Выбрать устройство DeviceId для вывода звука |
VIDEO CAMERA [DeviceId] | Выбрать устройство DeviceId для захвата основного видеопотока (в качестве камеры) |
VIDEO PRESENTATION [DeviceId] | Выбрать устройство DeviceId для захвата дополнительного видеопотока (в качестве контента) |
SETDEVICE VIDEO PRIMARY [DeviceId] | Выбрать дисплей для отображения видео основного потока |
SETDEVICE VIDEO SECONDARY [DeviceId] | Выбрать дисплей для отображения видео дополнительного потока |
VIDEODUAL ALL | Включить второй дисплей |
VIDEODUAL OFF | Отключить второй дисплей |
VIDEODUAL MIRROR | Дублирование на втором дисплее изображения основного монитора |
VIDEODUAL PRESENTATION | Выводить на втором мониторе дополнительный поток (демонстрируемый контент) |
SHUTDOWN — выключить TrueConf Group
Команда аналогична нажатию кнопки в разделе Settings → Power supply → Power control панели управления терминалом.
Данная команда выполняется сразу после её отправки, без предварительного запроса подтверждения (в отличие от аналогичного действия в панели управления).
SPEAKERMUTE — управление выводом звука
Параметр | Описание |
---|---|
ON | Отключить вывод звука |
OFF | Активировать вывод звука |
GET | Запросить состояние вывода звука |
REGISTER | Подписаться на получение уведомлений на отключение/включение вывода аудио: в консоль будут выводиться соответственно сообщения event: speakermute on и event: speakermute off .Данные сообщения будут поступать до их отключения с помощью команды UNREGISTER и только в текущем сеансе подключения по SSH. |
UNREGISTER | Отключить уведомления об изменении состояния вывода звука |
VIDEOCODEC — разрешить или запретить использование видеокодека
Параметр | Описание |
---|---|
[CODEC] ON | Разрешить использовать видеокодек [CODEC] |
[CODEC] OFF | Запретить использовать видеокодек [CODEC] |
[CODEC] GET | Получить текущее состояние кодека [CODEC] |
GET | Получить текущее состояние всех видеокодеков |
Learn more about all codecs supported by the endpoint in the Supported protocols and codecs section.
VIDEOMIXER — задать режим микширования потоков для многоточечного соединения (MCU)
Параметр | Описание |
---|---|
VIDEOLESSON | Режим видеоурока, при котором подключенные участники видят и слышат только ведущего, в качестве которого выступает терминал. При этом все слышат друг друга. |
ALL | Режим "все на экране", когда все участники видят и слышат друг друга |
ACTIVESPEAKER | Режим активации по голосу, при котором все видят и слышат друг друга, и в приоритетном видеоокне в раскладке будет отображаться активный говорящий |
VOLUME — управление уровнем громкости для вывода звука
Параметр | Описание |
---|---|
UP | Повышение уровня громкости |
DOWN | Понижение уровня громкости |
GET | Вывести в консоль текущий уровень громкости (в процентах) |
REGISTER | Подписаться на получение уведомлений об увеличении/уменьшении уровня громкости: в консоль будут выводиться соответственно сообщения event: volume up и event: volume down .Данные сообщения будут поступать до их отключения с помощью команды UNREGISTER и только в текущем сеансе подключения по SSH. |
UNREGISTER | Отключить уведомления об изменении громкости звука |
WHOAMI — вывод информации о TrueConf Group
Пример работы команды:
TCG console>whoami
Information about the system:
Display Name:"TCG 223"
Serial Number:"TCG01B9209863"
License Type:"permanent"
Software version:"1.0.59.10 Apr 13 2022"
IP address:"10.110.8.223"
MAC:"3C:7C:3F:7E:DF:F2"
SIP:""TCG 223" <sip:10.110.8.223>"
H323:""
H323 Gatekeeper:""
SIP Server:""
H323 Name:""
H323 Extension:""
Display information:
Name:"27EA33"
Connected:"True"
Active:"True"
Mode:"1920x1080@60.0 [60.0]"