Для перехода в режим конфигурации интерфейса командной строки используется команда:
Admin@nodename> configure
В режиме конфигурации приглашение командной строки будет выглядеть следующим образом:
Admin@nodename#
Общая структура команд в режиме конфигурации
Команды интерфейса командной строки имеют следующую структуру:
<action> <level> <filter> <configuration_info>
Где:
<action> — действие, которое необходимо выполнить;
<level> — уровень контекста конфигурации, который соответствует одному из разделов структуры конфигурации в веб-интерфейсе SWG;
<filter> — идентификатор объекта, к которому происходит обращение;
<configuration_info> — значение параметров, которые необходимо применить к объекту.
|
Наименование
|
Описание
|
|
<action>
|
В режиме конфигурации доступны следующие действия:
-
execute — выполнение команд, которые не относятся к текущей конфигурации устройства (ping, date, traceroute и т. п.) Команда доступна независимо от уровня конфигурации. Подробнее — в разделе «Команды execute».
-
create — создание новых объектов.
-
set — изменение параметров объектов, включение различных параметров.
-
show — отображение текущих значений. Можно использовать на любом уровне конфигурации — будет отображено все, что находится глубже текущего уровня.
-
delete — удаление объекта или параметра из списка параметров.
-
edit — переход на какой-либо уровень конфигурации. Уровень конфигурации будет отображен под командной строкой.
-
end — переход на один уровень конфигурации выше.
-
top — возврат на самый верхний уровень конфигурации.
-
export — экспорт сертификатов. Подробнее — в разделе «Команды export».
-
import — импорт конфигурации. Подробнее — в разделе «Команды import».
-
debug — включение журналирования событий протоколов динамической маршрутизации в режиме отладки. Подробнее — в разделе «Команды debug».
-
exit — выход из режима конфигурации.
Например, для просмотра информации о всех интерфейсах необходимо выполнить команду:
Admin@nodename# show network interface
С использованием следующей команды производится переход на уровень network interface. Текущий уровень будет отображен под командной строкой:
Admin@nodename# edit network interface
Admin@nodename#
Level: network interface
После перехода на уровень network interface для отображения всех интерфейсов используется команда show без указания уровня:
Admin@nodename# show
adapter:
port0
interface-name : port0
node-name : utmcore@dineanoulwer
zone : Management
enabled : on
ip-addresses : 192.168.56.3/24
iface-mode : dhcp
...
...
...
Для возвращения c уровня network interface обратно на общий уровень режима конфигурации необходимо набрать команду end два раза:
Admin@nodename#
Level: network interface
Admin@nodename# end
Level: network
Admin@nodename# end
Admin@nodename#
Для возврата на самый верхний уровень конфигурации с помощью одной команды можно использовать команду top:
Admin@nodename#
Level: network interface
Admin@nodename# top
Admin@nodename#
|
|
<level>
|
Уровни контекста конфигурации в командной строке повторяют разделы конфигурации в веб-интерфейсе UserGate SWG:
-
settings — соответствует разделу веб-интерфейса «UserGate»;
-
users — соответствует разделу веб-интерфейса «Пользователи и устройства»;
-
network — соответствует разделу веб-интерфейса «Сеть»;
-
network-policy — соответствует разделу веб-интерфейса «Политики сети»;
-
security-policy — соответствует разделу веб-интерфейса «Политики безопасности»;
-
global-portal — соответствует разделу веб-интерфейса «Глобальный портал»;
-
upstream-proxy — соответствует разделу веб-интерфейса «Вышестоящие прокси»;
-
libraries — соответствует разделу веб-интерфейса «Библиотеки»;
-
monitoring — соответствует разделу веб-интерфейса «Диагностика и мониторинг»
|
|
<filter>
|
Идентификатор объекта, к которому происходит обращение. Идентификация происходит по имени объекта. Если имеются объекты с одинаковыми именами или удобнее идентифицировать объект по другому параметру, то используются круглые скобки, в которых необходимо указать параметры(<configuration_info>). В результате будет найден объект, для которого совпали все поля, указанные в круглых скобках.
Например, необходимо вывести информацию об интерфейсе port0 на другом узле кластера. Если использовать команду:
Admin@nodename# show network interface adapter port0
Будет отображена информация об интерфейсе port0 текущего узла SWG. Чтобы отобразить информацию об интерфейсе port0 другого узла (например, с именем another_node), необходимо в скобках явно указать имя узла:
Admin@nodename# show network interface adapter ( node-name another_nodename interface port0 )
Важно! Круглые скобки должны быть отделены пробелами с обеих сторон
|
|
<configuration_info>
|
Указание параметра с аргументом. Параметр — имя поля, для которого нужно установить аргумент. Аргумент может быть одиночным или множественным.
Одиночный аргумент — значение, соответствующее параметру. Если строка содержит пробелы, то необходимо использовать кавычки.
Например, необходимо создать группу с именем VPN users:
Admin@nodename# create users group "VPN users"
Множественные аргументы используются для установки множества значений какого-либо параметра. Параметры записываются в квадратных скобках и разделяются пробелами.
Например, необходимо в группу VPN users добавить пользователей user1 и user2. Параметру users необходимо задать аргумент [ user1 user2 ]:
Admin@nodename# set users group "VPN users" users [ user1 user2 ]
Важно! Квадратные скобки должны быть отделены пробелами с обеих сторон
|
Команды execute
Команды имеют следующую структуру:
Admin@nodename# execute <command-name>
Список команд раздела execute.
|
Команда
|
Описание
|
|
cache
|
Очистка кэша LDAP-записей:
Admin@nodename# execute cache ldap-clear
|
|
check-geoip
|
Проверка географической принадлежности IP-адреса по текущей базе GeoIP:
Admin@nodename# execute check-geoip ip <ip-address>
|
|
clear-cli-history
|
Удаление истории команд интерфейса CLI. Можно удалить историю всех введенных команд интерфейса CLI или только команд в одном из режимов работы интерфейса (в режиме конфигурации или в режиме диагностики):
Admin@nodename# execute clear-cli-history
Admin@nodename# execute clear-cli-history modes [ <configure | diagnostic> ]
|
|
configurate-cluster
|
Генерация секретного кода, необходимого для добавления нового узла в кластер конфигурации:
Admin@nodename# execute configurate-cluster generate-secret-key <parameter>
Где:
-
secret — ключ для генерации секретного кола в формате [0–9a–zA–Z]+#[0–9a–zA–Z]+ (например, example#key);
-
expiration-time — срок действия кода в секундах;
-
request-limit — срок действия запроса на генерацию кода.
Важно! Для использования этой команды необходимо наличие лицензии на модуль Cluster
|
|
date
|
Просмотр текущих значений даты и времени на узле:
Admin@nodename# execute date
|
|
dig
|
Проверка записи DNS домена:
Admin@nodename# execute dig host <hostname> <parameters>
Admin@nodename# execute dig host <IP-address> <parameters>
В команде можно использовать следующие параметры:
-
reverse-lookup — получение имени устройства по IP-адресу;
-
dns — указание IP-адреса DNS-сервера;
-
tcp — использование протокола TCP вместо UDP.
|
|
factory-reset
|
Возврат устройства в первоначальное состояние.
Admin@nodename# execute factory-reset
Все данные и параметры будут утеряны. Версия ПО не изменится: сохранится версия, актуальная на момент запуска команды
|
|
firewall
|
Применение всех правил межсетевого экрана с обрывом текущих сессий:
Admin@nodename# execute firewall force-changes
|
|
license
|
Команда регистрации продукта имеет следующую структуру:
Admin@nodename# execute license activate <pin-code>
В качестве <pin-code> укажите код активации продукта
|
|
logs
|
Команда разовой отправки журналов по имеющемуся правилу экспорта журналов:
Admin@nodename# execute logs send-once <export-log-name>
|
|
mc-force-disconnect
|
Команда аварийного отключения узла от MC, с которым он был интегрирован. В зависимости от выбранного аргумента импортированные из MC объекты сохраняются локально или удаляются:
-
keep — отключение от MC с сохранением всех импортированных из MC объектов (библиотеки, правила и т. д.). Импортированные из MC объекты конвертируются в локальные.
-
delete — отключение от MC с удалением всех импортированных из MC объектов (библиотеки, правила и т. д.). Импортированные объекты, которые в настоящий момент используются, конвертируются в локальные.
Admin@nodename# execute mc-force-disconnect keep
Admin@nodename# execute mc-force-disconnect delete
|
|
netcheck
|
Проверка доступности стороннего HTTP или HTTPS-сервера. Могут быть использованы следующие параметры:
-
address — доменное имя узла для проверки доступности по TCP или URL — для HTTP;
-
dns-ip — IP-адрес сервера DNS;
-
dns-tcp — использование TCP вместо UDP для DNS-запроса;
-
check-cert — проверка SSL-сертификата;
-
type — проверка доступности по:
-
data — запрос содержимого сайта. По умолчанию запрашиваются только заголовки;
-
timeout — максимальный тайм-аут ожидания ответа от веб-сервера;
-
user-agent — параметр для указания типа браузера. На некоторых сайтах может быть разрешен доступ только с определенных браузеров. Значение параметра указывается в двойных кавычках.
Admin@nodename# execute netcheck type tcp address <host-domain-name> data on
Admin@nodename# execute netcheck address <host-domain-name>
|
|
ping
|
Проверка доступности определенного узла. Можно задать следующие параметры:
-
host — IP-адрес или доменное имя узла.
-
count — количество отправляемых echo-запросов. Если параметр не задан, отправка пакетов будет происходить, пока соединение не будет прервано пользователем (для прерывания необходимо нажать комбинацию клавиш Ctrl + C).
-
numeric — не определять имена.
-
timestamp — отображение временных меток.
-
interval — интервал времени, через который будет производиться отправка пакетов. Указывается в секундах.
-
ttl — время жизни пакета.
-
interface — адрес выбранного интерфейса будет использоваться в качестве адреса источника для выполнения ping.
-
mtu — максимальный размер блока данных отправляемых пакетов.
-
virtual-router — имя виртуального маршрутизатора.
Admin@nodename# execute ping host <hostname> count <number>
|
|
reboot
|
Перезагрузка устройства:
Admin@nodename# execute reboot
|
|
restore-mac
|
Восстановление mac-адреса интерфейса:
Admin@nodename# execute restore-mac interface <interface-name>
|
|
shutdown
|
Выключение устройства:
Admin@nodename# execute shutdown
|
|
termination
|
Закрытие сессий администраторов или пользователей:
Admin@nodename# execute termination <admin-sessions | user-sessions>
Подробнее — в разделе «Настройка сессий администраторов»
|
|
traceroute
|
Трассировка соединения до определенного узла. Параметры команды:
-
host <ip-or-domain> — IP-адрес или имя домена, для которого производится трассировка;
-
interface <iface-name> — интерфейс, с которого будут отправляться пакеты;
-
not-map-ip — не искать hostname для IP-адреса при отображении;
-
use-icmp-echo — использовать ICMP echo;
-
port — указать порт вместо порта по умолчанию (1 — 65535);
-
min-interval — минимальный интервал между пакетами.
Admin@nodename# execute traceroute host <hostname>
|
|
update
|
Обновление:
|
Часть представленных выше команд, кроме команд обновления, регистрации продукта, управления сессиями администраторов и очистки кэша, также доступны в режиме диагностики и мониторинга. Для их выполнения используется команда:
Admin@nodename> <command-name>
Команды import
Импорт доступен в разделах «Настройки», «Пользователи», «Сеть», «Политики сети», «Политики безопасности», «Глобальный портал».
В разделе «Настройки» (settings) можно импортировать сертификаты. Подробнее — в разделе «Настройка сертификатов».
В разделах «Пользователи» (users), «Сеть» (network), «Политики сети» (network-policy), «Политики безопасности» (security-policy), «Глобальный портал» (global-portal) можно импортировать правила, написанные на UPL. При использовании импорта, все существующие правила будут заменены на указанные.
В разделе «Пользователи» (users) можно импортировать правила captive-портала. Подробнее о правилах — в разделе «Captive-портал».
В разделе «Сеть» (network) можно импортировать правила DNS. Подробнее — в разделе «Настройка правил DNS».
В разделе «Политики сети» (network-policy) можно импортировать правила межсетевого экрана, NAT и маршрутизации, пропускной способности, балансировки нагрузки. Подробнее о правилах читайте в соответствующих разделах: «Настройка правил межсетевого экрана», «Настройка правил NAT и маршрутизации», «Настройка правил пропускной способности». «Настройка балансировки нагрузки».
В разделе «Политики безопасности» (security-policy) можно импортировать правила контентной фильтрации, веб-безопасности, инспектирования SSL, сценариев, ICAP-правил. О добавлении правил читайте в соответствующих разделах: «Настройка фильтрации контента», «Настройка веб-безопасности», «Настройка инспектирования SSL», «Настройка сценариев», «Настройка правил ICAP».
В разделе «Глобальный портал» (global-portal) можно импортировать правила веб-портала и reverse-прокси. Подробнее о создании правил — в разделах: «Настройка веб-портала» и «Настройка правил reverse-прокси».
Команды export
Команда для экспорта сертификатов.
Вы можете экспортировать сертификаты, всю цепочку сертификатов и CSR:
Admin@nodename# export settings certificates <certificate-name>
Admin@nodename# export settings certificates <certificate-name> with-chain on
Подробнее об управлении сертификатами — в разделе «Настройка сертификатов».
Команда debug
Команда debug позволяет включить журналирование событий протоколов маршрутизации в режиме отладки. События записываются в debug-лог. Их просмотр также возможен в режиме мониторинга в консоли CLI (подробнее — в разделе «Диагностика и мониторинг»).
Для включения журналирования конкретного протокола маршрутизации используется команда:
Admin@nodename# debug <protocol> <parameters>
Поддерживаются следующие протоколы:
