Для перехода в режим конфигурации интерфейса командной строки используется команда:
Admin/system@nodename> configure
В режиме конфигурации приглашение командной строки будет выглядеть следующим образом:
Admin/system@nodename#
Общая структура команд в режиме конфигурации
Команды интерфейса командной строки имеют следующую структуру:
<action> <level> <filter> <configuration_info>
Где:
<action> — действие, которое необходимо выполнить;
<level> — уровень конфигурации, уровни соответствуют разделам веб-интерфейса UGMC;
<filter> — идентификатор объекта, к которому происходит обращение;
<configuration_info> — значение параметров, которые необходимо применить к объекту.
Наименование
Описание
<action>
В режиме конфигурации доступны следующие действия:
create — создание новых объектов.
set — редактирование объектов, включение различных параметров.
show — отображение текущих значений. Можно использовать на любом уровне конфигурации — будет отображено все, что находится глубже текущего уровня.
delete — удаление объекта или параметра из списка параметров.
edit — переход на какой-либо уровень конфигурации. Уровень конфигурации будет отображен под командной строкой.
end — переход на один уровень выше.
top — возврат на самый верхний уровень конфигурации.
execute — выполнение команд, которые не относятся к конфигурации устройства (ping, date, traceroute и т.п.) Команда доступна независимо от уровня конфигурации. Подробнее — в разделе «Команды execute».
export — экспорт сертификатов. Подробнее — в разделе «Команды export».
import — импорт конфигурации. Подробнее — в разделе «Команды import».
exit — выход из режима конфигурации.
Например, для просмотра информации о всех интерфейсах необходимо выполнить команду:
Admin/system@nodename# show network interface
С использованием следующей команды производится переход на уровень 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#
Для возврата на самый верхний уровень конфигурации с помощью одной команды можно использовать команду top:
Admin/system@nodename# top
Level: network interface
Admin/system@nodename#
<level>
Уровни в командной строке повторяют веб-интерфейс системной консоли UGMC:
settings — соответствует разделу веб-интерфейса «UserGate».
users — соответствует разделу веб-интерфейса «Пользователи и устройства».
network — соответствует разделу веб-интерфейса «Сеть».
realms — соответствует разделу веб-интерфейса «Управляемые области».
monitoring — соответствует разделу веб-интерфейса «Диагностика и мониторинг».
libraries — соответствует разделу веб-интерфейса «Библиотеки»
<filter>
Идентификатор объекта, к которому происходит обращение. Идентификация происходит по имени объекта. Если имеются объекты с одинаковыми именами или удобнее идентифицировать объект по другому параметру, то используются круглые скобки, в которых необходимо указать параметры (<configuration_info>). В результате будет найден объект, для которого совпали все поля, указанные в круглых скобках.
Например, необходимо вывести информацию об интерфейсе port0 на другом узле кластера. Если использовать команду:
Admin/system@nodename# show network interface adapter port0
Будет отображена информация об интерфейсе port0 текущего узла UGMC. Чтобы отобразить информацию об интерфейсе port0 другого узла (например, с именем another_node), необходимо в скобках явно указать имя узла:
Важно! Круглые скобки должны быть отделены пробелами с обеих сторон
<configuration_info>
Указание параметра с аргументом. Параметр — имя поля, для которого нужно установить аргумент. Аргумент может быть одиночным или множественным.
Одиночный аргумент — значение, соответствующее параметру. Если строка содержит пробелы, то необходимо использовать кавычки.
Например, необходимо создать профиль аутентификации с именем New profile:
Admin/system@nodename# create users auth-profile name "New profile"
Множественные аргументы используются для установки множества значений какого-либо параметра, записываются в квадратных скобках и разделяются пробелами.
Например, необходимо создать список IP-адресов в библиотеке элементов и добавить в него два IP-адреса 10.10.0.1 и 10.10.0.2:
Важно! Квадратные скобки должны быть отделены пробелами с обеих сторон
Команды execute
Команды имеет следующую структуру:
Admin/system@nodename# execute <command-name>
Доступны следующие команды:
Параметр
Описание
clear-cli-history
Удаление истории команд интерфейса CLI. Можно удалить историю всех введенных команд интерфейса CLI или только команд в одном из режимов работы интерфейса (в режиме конфигурации или в режиме диагностики):
В качестве <pin-code> укажите код активации продукта
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— параметр для указания типа браузера. На некоторых сайтах может быть разрешен доступ только с определенных браузеров. Значение параметра указывается в двойных кавычках.
Admin/system@nodename# execute netcheck type tcp address <host-domain-name> data on
Admin/system@nodename# execute netcheck address <host-domain-name>
ping
Проверка доступности узла. Можно задать следующие параметры:
host — IP-адрес или доменное имя узла.
count — количество отправляемых echo-запросов. Если параметр не задан, то отправка пакетов будет происходить, пока соединение не будет прервано пользователем (для прерывания необходимо нажать комбинацию клавиш Ctrl + C).
numeric — не определять имена.
timestamp — отображение временных меток.
interval — интервал времени, через который будет производиться отправка пакетов. Указывается в секундах.
ttl — время жизни пакета;
interface — адрес выбранного интерфейса будет использоваться в качестве адреса источника для выполнения ping;
mtu — максимальный размер блока данных отправляемых пакетов;