Для просмотра подсказки о текущих возможных значениях или для автодополнения команд необходимо нажать клавишу Tab. В подсказке могут использоваться следующие вспомогательные символы:

* — обязательное поле в командах create и ряде других команд;

+ — необязательное/вариативное поле;

> — вложенное поле, после его введения предыдущий список полей становится недоступным, появляется новый список полей, которые можно ввести.

Например:

Admin/system@nodename# set network zone Trusted 
* name                    Name
+ antispoof-enable        Enable/Disable IP spoofing protection
+ antispoof-negate        Enable/Disable Negate ip-spoof addresses
+ description             Description
+ enabled-services        Services list to enable
+ geoip                   IP spoofing protection by geo IP code
+ ip-list                 IP spoofing protection by IP list
> dos-protection-icmp     Confugure DoS protection per IP for ICMP packets
> dos-protection-syn      Confugure DoS protection per IP for SYN packets
> dos-protection-udp      Confugure DoS protection per IP for UDP packets
> service-addresses       Access control service addresses

Общая структура команд в режиме конфигурации

Команды интерфейса командной строки имеют следующую структуру:

<action> <level> <filter> <configuration_info>

где:

<action> — действие, которое необходимо выполнить.

<level> — уровень конфигурации; уровни соответствуют разделам веб-интерфейса UGMC.

<filter> — идентификатор объекта, к которому происходит обращение.

<configuration_info> — значение параметров, которые необходимо применить к объекту <filter>.

Наименование	Описание
<action>	В режиме конфигурации доступны следующие действия: execute — выполнение команд, которые не относятся к конфигурации UserGate (ping, date, traceroute и т.п.) Команда доступна независимо от уровня конфигурации (<level>). set — редактирование всех объектов, а также включение различных параметров, например, radmin. end — переход на один уровень выше. show — отображение текущих значений. Можно использовать на любом уровне конфигурации — будет отображено всё, что находится глубже текущего уровня. edit — переход на какой-либо уровень конфигурации. Уровень конфигурации будет отображён под командной строкой. top — возврат на самый верхний уровень конфигурации. exit — выход из режима конфигурации. export — экспорт конфигурации. import — импорт конфигурации. create — создание новых объектов. delete — удаление объекта или параметра из списка параметров. Например, для просмотра информации о всех интерфейсах необходимо выполнить команду: `Admin/system@nodename# show network interface` С использованием следующей команды производится переход на уровень network interface. Текущий уровень будет отображён под командной строкой: `Admin/system@nodename# edit network interface Admin/system@nodename# Level: network interface` После перехода на уровень network interface для отображения всех интерфейсов используется команда show без указания уровня: `Admin/system@nodename# show adapter: port0 interface-name : port0 node-name : node1 zone : Management enabled : on ip-addresses : 192.168.56.3/24 iface-mode : dhcp ... ... ... Level: network interface` Для возвращения c уровня network interface обратно на общий уровень режима конфигурации необходимо набрать команду end: `Admin/system@nodename# end Level: network interface Admin/system@nodename# end Level: network Admin/system@nodename#`
<level>	Уровни в командной строке повторяют веб-интерфейс системной консоли UGMC: network — соответствует разделу веб-интерфейса Сеть. settings — соответствует разделу веб-интерфейса UserGate. users — соответствует разделу веб-интерфейса Пользователи и устройства. libraries — соответствует разделу веб-интерфейса Библиотеки. monitoring — соответствует разделу веб-интерфейса Диагностика и мониторинг. realms — соответствует разделу веб-интерфейса Управляемые области.
<filter>	Идентификатор объекта, к которому происходит обращение. Идентификация происходит по имени объекта. Если имеются объекты с одинаковыми именами или удобнее идентифицировать объект по другому параметру, то используются круглые скобки, в которых необходимо указать <configuration_info> (рассмотрено далее в разделе). В результате будет найден объект, для которого совпали все поля, указанные в круглых скобках. Например, необходимо вывести информацию об интерфейсе port0 на другом узле кластера. Если использовать команду: `Admin/system@nodename# show network interface adapter port0` то будет отображена информация об интерфейсе port0 текущего узла UGMCe. Чтобы отобразить информацию об интерфейсе port0 другого узла (например, с именем another_node), необходимо в скобках явно указать имя узла: `Admin/system@nodename# show network interface adapter ( node-name another_nodename interface port0 )` Важно! Круглые скобки должны быть отделены пробелами с обеих сторон.
<configuration_info>	Набор пар: параметр-аргумент. Параметр — имя поля, для которого нужно установить аргумент. Аргумент может быть одиночным или множественным. Одиночный аргумент — значение, соответствующее параметру. Если строка содержит пробелы, то необходимо использовать кавычки. Например, необходимо создать профиль аутентификации с именем New profile: `Admin/system@nodename# create users auth-profile name "New profile"` Множественные аргументы используются для установки множества значений какого-либо параметра; записываются в квадратных скобках и разделяются пробелами. Например, необходимо создать список IP-адресов в библиотеке элементов и добавить в него два IP-адреса 10.10.0.1 и 10.10.0.2: `Admin/system@nodename# create libraries ip-list name testlist ips [ 10.10.0.1 10.10.0.2 ]` Важно! Квадратные скобки должны быть отделены пробелами с обеих сторон.

Команды execute

Команды имеет следующую структуру:

Admin/system@nodename# execute <command-name>

Доступны следующие команды:

Параметр	Описание
traceroute	Трассировка соединения до определённого хоста. Доступны параметры: hostname <ip-or-domain> — IP-адрс или имя домена, для которого производится трассировка. interface <iface-name> — интерфейс, с которого будут отправляться пакеты. not-map-ip — не искать hostname для IP-адреса при отображении. use-icmp-echo — использовать ICMP echo. port — указать порт вместо порта по умолчанию (1 — 65535). min-interval — минимальный интервал между пакетами. `Admin/system@nodename# execute traceroute hostname <hostname>`
termination	Закрытие сессий администраторов. Подробнее читайте в разделе Управление сессиями администраторов.
ping	Выполнение ping определенного хоста. Можно задать следующие параметры: hostname — IP-адрес или доменное имя хоста. count — количество отправляемых echo-запросов. Если параметр не задан, то отправка пакетов будет происходить, пока соединение не будет прервано пользователем (чтобы прервать отправку: Ctrl+C). numeric — не резолвить имена. timestamp — отображение временных меток. interval — интервал времени, через который будет производиться отправка пакетов; указывается в секундах. ttl — время жизни пакета. interface — адрес выбранного интерфейса будет использоваться в качестве адреса источника для выполнения ping. mtu — размер mtu отправляемых пакетов. virtual-router — имя виртуального маршрутизатора. `Admin/system@nodename# execute ping hostname <hostname> count <number>`
reboot	Перезагрузка устройства.
date	Просмотр текущих даты и времени на сервере.
shutdown	Выключение устройства.
netcheck	Проверка доступности стороннего HTTP/HTTPS-сервера. Могут быть использованы следующие параметры: address — доменное имя хоста для проверки доступности по TCP или URL для HTTP. dns-ip — IP-адрес сервера DNS. dns-tcp — использование TCP вместо UDP для DNS-запроса. check-cert — проверка SSL-сертификата type — проверка доступности по: http. tcp (если порт не указан, то используется порт 80). data — запрос содержимого сайта. По умолчанию запрашиваются только заголовки. timeout — максимальный таймаут ожидания ответа от веб-сервера. user-agent — параметр для указания типа браузера (useragent). На некоторых сайтах может быть разрешен доступ только с определенных браузеров. Значение параметра указывается в двойных кавычках. `Admin/system@nodename# execute netcheck type tcp address <host-domain-name> data on Admin/system@nodename# execute netcheck address <host-domain-name>`
dig	Проверка записи DNS домена. hostname — доменное имя хоста или IP-адрес для реверсивного поиска. reverse-lookup — получение хоста по IP-адресу. dns — указание IP-адреса DNS-сервера. tcp — использование протокола TCP вместо UDP. `Admin/system@nodename# execute dig hostname <host-domain-name> Admin/system@nodename# execute dig hostname <IP-address> reverse-lookup on`