Настройка библиотек - UserGate :: Портал документации

Списки морфологии создаются на уровне libraries morphology.

Для создания списка морфологии используется следующая команда:

Admin@nodename# create libraries morphology <parameter>

Параметры списка морфологии.

Параметр	Описание
`name`	Название списка морфологии
`description`	Описание списка
`threat-lvl`	Уровень угрозы: `very-low` — очень низкий уровень угрозы; `low` — низкий уровень угрозы; `medium` — средний уровень угрозы; `high` — высокий уровень угрозы; `very-high` — высокий уровень угрозы
`threshold`	Вес морфологической категории, при превышении которого сработает правило
`type`	Тип списка: `local` — локальный. `updatable` — если список является обновляемым, необходимо указать адрес, с которого загружаются обновления (`url`). Периодичность обновления списка указывается параметром `shedule` в формате crontab. Crontab-формат: <минуты: 0–59> <часы: 0–23> <дни месяца: 1–31> <месяцы: 1–12> <дни недели: 0–6, где 0 — воскресенье>. Каждое из полей может быть задано следующим образом: Звездочка (*) — для выбора всех значений. Дефис (-) — для указания диапазона значений. Запятая (,) — в качестве разделителя значений. Косая черта (/) — для указания шага между значениями
`words`	Слова и фразы, которые необходимо добавить в список. `word` — слова и фразы. При добавлении слова в морфологический словарь можно использовать модификатор «!» перед словом, например, «!bassterd». В данном случае жаргонное слово не будет преобразовываться в словоформы, что может серьезно уменьшить вероятность ложной блокировки. `weight` — вес слова или фразы. Если вес не задан, то автоматический устанавливается значение 100. Для добавления слов и фраз: `Admin@nodename# create libraries morphology ... words new word "word or phrase" weight <weight>`

Команда для редактирования списка:

Admin@nodename# set libraries morphology <morphology-list-name> <parameter>

Далее указываются параметры, значения которых необходимо обновить (список параметров представлен в таблице выше).

Команда для добавления в список новых слов или фраз:

Admin@nodename# set libraries morphology <morphology-list-name> words new word "word or phrase" weight <weight>

Команда для замены слова в списке:

 Admin@nodename# set libraries morphology <morphology-list-name> words ( word "old word or phrase" weight <weight> ) word "new word or phrase" weight <weight>

Команды для удаления всего морфологического списка или отдельных слов, содержащихся в нем:

Admin@nodename# delete libraries morphology <morphology-list-name>
Admin@nodename# delete libraries morphology <morphology-list-name> words ( word "word or phrase" weight <weight> )

Команды отображения информации о всех имеющихся морфологических списках:

Admin@nodename# show libraries morphology

Чтобы отобразить информацию об определенном списке, далее необходимо указать название интересующего морфологического списка.

Команда для просмотра содержания определенного морфологического списка:

Admin@nodename# show libraries morphology <morphology-list-name> words

Настройка IP-адресов

IP-списки создаются на уровне libraries ip-list.

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

Admin@nodename# create libraries ip-list <parameter>

Параметры IP-списка.

Параметр	Описание
`name`	Название списка адресов
`description`	Описание списка
`threat-lvl`	Уровень угрозы: `very-low` — очень низкий уровень угрозы; `low` — низкий уровень угрозы; `medium` — средний уровень угрозы; `high` — высокий уровень угрозы; `very-high` — высокий уровень угрозы
`type`	Тип списка: `local` — локальный. `updatable` — если список является обновляемым, необходимо указать адрес, с которого загружаются обновления (`url`). Периодичность обновления списка указывается параметром `shedule` в формате crontab. Crontab-формат: <минуты: 0–59> <часы: 0–23> <дни месяца: 1–31> <месяцы: 1–12> <дни недели: 0–6, где 0 — воскресенье>. Каждое из полей может быть задано следующим образом: Звездочка (*) — для выбора всех значений. Дефис (-) — для указания диапазона значений. Запятая (,) — в качестве разделителя значений. Косая черта (/) — для указания шага между значениями
`lists`	Выбор существующих IP-листов для добавления в создаваемый лист
`ips`	IP-адреса или диапазон IP-адресов, которые необходимо включить в список. Указывается в формате: `<ip>`, `<ip/mask>` или `<ip_range_start-ip_range_end>`

Команда для редактирования списка:

Admin@nodename# set libraries ip-list <ip-list-name> <parameter>

Команда для добавления в список новых адресов:

Admin@nodename# set libraries ip-list <ip-list-name> ips [ <ip1> <ip2> ... ]

Команды для удаления всего списка адресов или IP-адресов, содержащихся в нем:

Admin@nodename# delete libraries ip-list <ip-list-name>
Admin@nodename# delete libraries ip-list <ip-list-name> ips [ <ip1> <ip2>... ]

Команда отображения информации о всех имеющихся списках:

Admin@nodename# show libraries ip-list

Команда для отображения информации об определенном списке:

Admin@nodename# show libraries ip-list <ip-list-name>

Команда для просмотра содержимого списка IP-адресов:

Admin@nodename# show libraries ip-list <ip-list-name> items

Настройка User agent браузеров

Списки user agent браузеров создаются на уровне libraries useragents.

Для создания нового списка используется команда:

Admin@nodename# create libraries useragents <parameter>

Параметры списка user agent браузеров.

Параметр	Описание
`name`	Название списка user agent
`description`	Описание списка
`type`	Тип списка: `local` — локальный. `updatable` — если список является обновляемым, необходимо указать адрес, с которого загружаются обновления (`url`). Периодичность обновления списка указывается параметром `shedule` в формате crontab. Crontab-формат: <минуты: 0–59> <часы: 0–23> <дни месяца: 1–31> <месяцы: 1–12> <дни недели: 0–6, где 0 — воскресенье>. Каждое из полей может быть задано следующим образом: Звездочка (*) — для выбора всех значений. Дефис (-) — для указания диапазона значений. Запятая (,) — в качестве разделителя значений. Косая черта (/) — для указания шага между значениями
`patterns`	Шаблоны User agent. Список User agent браузеров доступен по ссылке

Команда для редактирования существующего списка:

Admin@nodename# set libraries useragents <useragent-list-name> <parameter>

Далее указываются параметры, которые необходимо обновить. Параметры представлены в таблице выше. Чтобы добавить новые User agent браузеров:

Admin@nodename# set libraries useragents <useragent-list-name> [ <useragent1> <useragent2> ... ]

Команды для удаления всего списка или отдельных User agent браузеров, содержащихся в нем:

Admin@nodename# delete libraries useragents <useragent-list-name>
Admin@nodename# delete libraries useragents <useragent-list-name> patterns [ <useragent> ... ]

Команда для отображения информации о всех имеющихся списках:

Admin@nodename# show libraries useragents

Команда для отображения информации об определенном списке. Чтобы просмотреть содержание списка Useragent браузеров:

Admin@nodename# show libraries useragents <useragent-list-name> patterns

Настройка типов контента

Списки типов контента создаются на уровне libraries content-types.

Для создания нового списка типов контента используется команда:

Admin@nodename# create libraries content-types <parameter>

Параметры списка типов контента.

Параметр	Описание
`name`	Название списка типов контента
`description`	Описание списка
`type`	Тип списка: `local` — локальный. `updatable` — если список является обновляемым, необходимо указать адрес, с которого загружаются обновления (`url`). Периодичность обновления списка указывается параметром `shedule` в формате crontab. Crontab-формат: <минуты: 0–59> <часы: 0–23> <дни месяца: 1–31> <месяцы: 1–12> <дни недели: 0–6, где 0 — воскресенье>. Каждое из полей может быть задано следующим образом: Звездочка (*) — для выбора всех значений. Дефис (-) — для указания диапазона значений. Запятая (,) — в качестве разделителя значений. Косая черта (/) — для указания шага между значениями
`mime`	Типы контента, которые необходимо добавить в список. Различные типы контента и их описание доступны по ссылке

Команда для редактирования списка:

Admin@nodename# set libraries content-types <content-types-list-name> <parameter>

Параметры, доступные для обновления, представлены в таблице выше.

Команда для удаления списка с типами контента:

Admin@nodename# delete libraries content-types <content-types-list-name>

Команда для удаления отдельных типов контента из списка:

Admin@nodename# delete libraries content-types <content-types-list-name> mime [ <mime-type> ... ]

Команды для отображения информации о списках типов контента:

Admin@nodename# show libraries content-types
Admin@nodename# show libraries content-types <content-types-list-name>

Команда для отображения типов контента, содержащихся в списке:

Admin@nodename# show libraries content-types <content-types-list-name> mime

Настройка списков URL

Списки URL создаются на уровне libraries url-list.

Для добавления нового списка URL используется команда:

Admin@nodename# create libraries url-list <parameter>

Параметры списка URL.

Параметр	Описание
`name`	Название списка URL
`description`	Описание списка URL
`type`	Тип списка: `local` — локальный. `updatable` — если список является обновляемым, необходимо указать адрес, с которого загружаются обновления (`url`). Периодичность обновления списка указывается параметром `shedule` в формате crontab. Crontab-формат: <минуты: 0–59> <часы: 0–23> <дни месяца: 1–31> <месяцы: 1–12> <дни недели: 0–6, где 0 — воскресенье>. Каждое из полей может быть задано следующим образом: Звездочка (*) — для выбора всех значений. Дефис (-) — для указания диапазона значений. Запятая (,) — в качестве разделителя значений. Косая черта (/) — для указания шага между значениями
`urls`	URL, которые необходимо добавить в список
`case-sensitivity`	Чувствительность к регистру в написании адреса URL: sensitive — чувствительно к регистру букв в адресе; insensitive — нечувствительно к регистру букв в адресе; domain — список адресов доменов

Команда для редактирования списка URL:

Admin@nodename# set libraries url-list <url-list-name> <parameter>

Параметры, значения которых можно обновить, представлены в таблицы выше.

Команды для удаления всего списка URL или отдельных адресов URL:

Admin@nodename# delete libraries url-list <url-list-name>
Admin@nodename# delete libraries url-list <url-list-name> urls [ <url> ... ]

Команды для просмотра информации о всех списках URL, об определенном списке URL или об адресах, входящих в определенный список:

Admin@nodename# show libraries url-list
Admin@nodename# show libraries url-list <url-list-name>
Admin@nodename# show libraries url-list <url-list-name> urls

Настройка календарей

Календари настраиваются на уровне libraries time-sets.

Для создания календаря используется команда:

Admin@nodename# create libraries time-sets <parameter>

Параметры календаря.

Параметр

Описание

name

Название календаря

description

Описание календаря

time-set

Временные интервалы.

interval-name — название интервала повторения.
type — тип интервала повторения:
- daily — ежедневно:
  - time-from — время начала (указывается в формате HH:MM);
  - time-to — время окончания (указывается в формате HH:MM);
  - all-day on — весь день.
- weekly — каждую неделю:
  - time-from — время начала (указывается в формате HH:MM);
  - time-to — время окончания (указывается в формате HH:MM);
  - all-day on — весь день;
  - days [ Mon | Tue | Wed | Thu | Fri | Sat | Sun ] — дни недели.
- monthly — каждый месяц:
  - time-from — время начала (указывается в формате HH:MM);
  - time-to — время окончания (указывается в формате HH:MM);
  - all-day on — весь день;
  - days — числа месяца (от 1 до 31).
- fixed — единовременно:
  - time-from — время начала (указывается в формате HH:MM);
  - time-to — время окончания (указывается в формате HH:MM);
  - all-day on — весь день;
  - fixed-date — нужная дата (указывается в формате YYYY-MM-DD).
- span — повторяющиеся события:
  - time-from — время начала (указывается в формате HH:MM);
  - time-to — время окончания (указывается в формате HH:MM);
  - all-day on — весь день;
  - fixed-date-from — дата начала (указывается в формате YYYY-MM-DD);
  - fixed-date-to — дата окончания (указывается в формате YYYY-MM-DD).
- range — диапазон дат:
  - time-from-enabled <on | off> — включение/отключение указания даты начала интервала;
  - fixed-date-from — дата начала (указывается в формате YYYY-MM-DD);
  - time-from — время начала (указывается в формате HH:MM);
  - time-to-enabled <on | off> — включение/отключение указания даты окончания интервала;
  - fixed-date-to — дата окончания (указывается в формате YYYY-MM-DD);
  - time-to — время окончания (указывается в формате HH:MM).

Команда для редактирования календаря:

Admin@nodename# set libraries time-sets <time-sets-name> <parameter>

Параметры, доступные для обновления, представлены в таблице выше.

Команда для редактирования интервала, заданного в календаре:

Admin@nodename# set libraries time-sets <time-sets-name> ... time-set <time-set-type> ( <time-set-filter> )

Далее указываются новые значения; <time-set-filter> — фильтр из текущих значений интервала.

Команда для добавления нового элемента в существующую группу:

Admin@nodename# create libraries time-sets <time-sets-name> ... time-set <time-set-type> new

Команда для удаления группы элементов:

Admin@nodename# delete libraries time-sets <time-sets-name>

Для для удаления элемента календаря:

Admin@nodename# delete libraries time-sets <time-sets-name> <time-set-type> ( <time-set-filter> )

Команда для отображения информации о всех календарях:

Admin@nodename# show libraries time-sets

Команда для отображения информации об определенном календаре:

Admin@nodename# show libraries time-sets <time-sets-name>

Команда для отображения информации об элементах группы с одинаковым типом повторения:

Admin@nodename# show libraries time-sets <time-sets-name> <time-set-type>

Настройка полос пропускания

Полосы пропускания настраиваются на уровне libraries bandwidth-pools.

Для добавления новой полосы пропускания используется команда:

Admin@nodename# create libraries bandwidth-pools <parameter>

Параметры полосы пропускания.

Параметр	Описание
`name`	Название полосы пропускания
`description`	Описание полосы пропускания
`rate`	Скорость передачи данных; указывается в Кбит/с
`dscp`	Значение DSCP для QoS (при указании будет прописываться в каждый IP-пакет: принимает значения от 0 до 63)

Команда для редактирования параметров полосы пропускания:

Admin@nodename# set libraries bandwidth-pools <bandwidth-name> <parameter>

Параметры, доступные для изменения такие же, как и для команды создания полосы пропускания.

Команда для удаления полосы пропускания:

Admin@nodename# delete libraries bandwidth-pools <bandwidth-name>

Команда для отображения информации о всех полосах пропускания:

Admin@nodename# show libraries bandwidth-pools

Команда для отображения информации об определенной полосе:

Admin@nodename# show libraries bandwidth-pools <bandwidth-name>

Настройка шаблонов страниц

Шаблоны страниц настраиваются на уровне libraries response-pages.

Доступно создание следующих типов шаблонов страниц (<response-page-type>):

blockpage — шаблоны страниц блокировки;
captiveportal-user-auth — шаблоны страниц авторизации captive-портала;
captiveportal-user-session — шаблоны страниц captive-портала, сессия пользователя;
content-warning — шаблоны страниц предупреждения;
ftp-client — шаблоны страниц отображения FTP поверх HTTP;
proxy-portal — шаблоны страниц веб-портала;
pp-login-ssh — шаблоны страниц SSH-логина веб-портала;
pp-login-rdp — шаблоны страниц RDP-логина веб-портала;
totp-init-page — шаблоны страниц инициализации TOTP;
network-error-page — шаблоны страниц сетевых ошибок от прокси-сервера.

Для создания шаблона страницы используется команда:

Admin@nodename# create libraries response-pages <response-page-type> <parameter>

Параметры шаблона страниц.

Параметр	Описание
`name`	Название шаблона страницы
`description`	Описание шаблона
`original-template`	Выбор базового шаблона. Базовые шаблоны для страницы блокировки (`blockpage`): `blockpage-en` — шаблон страницы блокировки на английском языке; `blockpage-ru` — шаблон страницы блокировки на русском языке. Базовые шаблоны для страницы авторизации captive-портала (`captiveportal-user-auth`): `captiveportal_user_auth-en` — шаблон страницы авторизации пользователя с помощью captive-портала на английском языке; `captiveportal_user_auth-ru` — шаблон страницы авторизации пользователя с помощью captive-портала на русском языке; `captiveportal-user-auth-policy-en` — шаблон страницы авторизации пользователя с помощью captive-портала на английском языке. Шаблон, помимо формы авторизации, выводит правила пользования сетью (соглашение об использовании) и требует принятия пользователем правил политики доступа; `captiveportal-user-auth-policy-ru` — шаблон страницы авторизации пользователя с помощью captive-портала на русском языке. Шаблон, помимо формы авторизации, выводит правила пользования сетью (соглашение об использовании) и требует принятия пользователем правил политики доступа; `captiveportal-user-auth-email-en` — шаблон страницы авторизации пользователя с помощью captive-портала на английском языке, позволяющий пользователю самостоятельно зарегистрироваться в системе с подтверждением пользователя по email; `captiveportal-user-auth-email-ru` — шаблон страницы авторизации пользователя с помощью captive-портала на русском языке, позволяющий пользователю самостоятельно зарегистрироваться в системе с подтверждением пользователя по email; `captiveportal-user-auth-sms-en` — шаблон страницы авторизации пользователя с помощью captive-портала на английском языке, позволяющий пользователю самостоятельно зарегистрироваться в системе с подтверждением пользователя по SMS; `captiveportal-user-auth-sms-ru` — шаблон страницы авторизации пользователя с помощью captive-портала на русском языке, позволяющий пользователю самостоятельно зарегистрироваться в системе с подтверждением пользователя по SMS; `captiveportal-user-policy-en` — шаблон страницы авторизации пользователя с помощью captive-портала на английском языке. Шаблон не требует ввода имени и пароля пользователя, а выводит правила пользования сетью (соглашение об использовании) и требует принятия пользователем правил политики доступа. Для работы данного шаблона требуется установить метод «Принять политику» в качестве метода аутентификации в профиле авторизации; `captiveportal-user-policy-ru` — шаблон страницы авторизации пользователя с помощью captive-портала на русском языке. Шаблон не требует ввода имени и пароля пользователя, а выводит правила пользования сетью (соглашение об использовании) и требует принятия пользователем правил политики доступа. Для работы данного шаблона требуется установить метод «Принять политику» в качестве метода аутентификации в профиле авторизации. Базовые шаблоны для страницы captive-портал, сессия пользователя (`captiveportal-user-session`): `captiveportal-user-session-en` — шаблон на английском языке, с помощью которого пользователь может завершить свою авторизованную сессию, перейдя на страницу http://logout.captive или http://<UserGate_IP-address>/cps; `captiveportal-user-session-ru` — шаблон на русском языке, с помощью которого пользователь может завершить свою авторизованную сессию, перейдя на страницу http://logout.captive или http://<UserGate_IP-address>/cps. Базовые шаблоны для страницы предупреждения (`content-warning`): `content-warning-en` — шаблон страницы предупреждения на английском языке, отображаемый при срабатывании правила контентной фильтрации с действием Предупредить; `content-warning-ru` — шаблон страницы предупреждения на русском языке, отображаемый при срабатывании правила контентной фильтрации с действием Предупредить. Базовые шаблоны для страницы отображения FTP поверх HTTP (`ftp-client`): `ftp-client-en` — шаблон на английском языке для отображения контента FTP-серверов поверх HTTP; `ftp-client-ru` — шаблон на русском языке для отображения контента FTP-серверов поверх HTTP. Базовые шаблоны для страницы веб-портала (`proxy-portal`): `proxy-portal-en` — шаблон на английском языке для отображения страницы веб-портала; `proxy-portal-ru` — шаблон на русском языке для отображения страницы веб-портала. Базовые шаблоны для страницы SSH-логина веб-портала (`pp-login-ssh`): `pp-login-ssh-en` — шаблон на английском языке для отображения страницы аутентификации при подключении к ресурсам SSH через веб-портал; `pp-login-ssh-ru` — шаблон на русском языке для отображения страницы аутентификации при подключении к ресурсам SSH через веб-портал. Базовые шаблоны для страницы RDP-логина веб-портала (`pp-login-rdp`): `pp-login-rdp-en` — шаблон на английском языке для отображения страницы аутентификации при подключении к ресурсам RDP через веб-портал; `pp-login-rdp-ru` — шаблон на русском языке для отображения страницы аутентификации при подключении к ресурсам RDP через веб-портал. Базовые шаблоны для страницы инициализации TOTP (`totp-init-page`): `totp-init-page-en` — шаблон на английском языке для отображения страницы инициализации устройства TOTP для VPN-пользователей; `totp-init-page-ru` — шаблон на русском языке для отображения страницы инициализации устройства TOTP для VPN-пользователей. Базовые шаблоны для страницы сетевых ошибок от прокси-сервера (`network-error-page`): `network-error-page-en` — шаблон на английском языке для отображения страницы сетевых ошибок от прокси-сервера; `network-error-page-ru` — шаблон на русском языке для отображения страницы сетевых ошибок от прокси-сервера
`default`	Использовать шаблон по умолчанию: `on`; `off`

Команда для редактирования значений шаблона:

Admin@nodename# set libraries response-pages <response-page-type> <response-page-name> <parameters>

Далее необходимо указать значения параметров; параметры представлены в таблице выше.

Команда для удаления шаблона страницы:

Admin@nodename# delete libraries response-pages <response-page-type> <response-page-name>

Команда для просмотра информации о всех имеющихся шаблонах страниц:

Admin@nodename# show libraries response-pages

Команда для просмотра информации об отдельном типе шаблонов страниц:

Admin@nodename# show libraries response-pages <response-page-type>

Команда для просмотра информации об отдельном шаблоне страницы:

Admin@nodename# show libraries response-pages type <response-page-type> <response-page-name>

Настройка категорий URL

Списки категорий URL настраиваются на уровне libraries url-categories.

Для создания списка категорий URL используется команда:

Admin@nodename# create libraries url-categories <parameter>

Параметры списка категорий URL.

Параметр	Описание
`name`	Название списка URL-категорий
`description`	Описание списка
`categories`	Категории URL, которые необходимо добавить в список

Команда для редактирования параметров списка:

Admin@nodename# set libraries url-categories <list-name> <parameter>

Команда для добавления категорий URL в существующий список:

Admin@nodename# set libraries url-categories <list-name> categories [ <url-category> ... ]

Команда для удаления списка URL-категорий:

Admin@nodename# delete libraries url-categories <list-name>

Команда для удаления отдельных категорий из списка:

Admin@nodename# delete libraries url-categories <list-name> categories [ <url-category> ... ]

Команда для просмотра информации о всех списках URL-категорий:

Admin@nodename# show libraries url-categories

Команда для просмотра информации об определенном списке:

Admin@nodename# show libraries url-categories <list-name>

Команда для отображения категорий URL, входящих в список:

Admin@nodename# show libraries url-categories <list-name> categories

Настройка измененных категорий URL

Настройка измененных категорий URL выполняется на уровне overridden-url-categories.

Для добавления новой измененной категории URL используется команда:

Admin@nodename# create libraries overridden-url-categories <parameter>

Параметры измененной категории URL.

Параметр	Описание
`domain`	Доменное имя ресурса
`description`	Описание изменяемого домена
`categories`	Новые категории сайта (можно указать не более 2-х категорий)

Команда для редактирования параметров:

Admin@nodename# set libraries overridden-url-categories <domain> <parameter>

Команда для удаления сайта с измененными категориями:

Admin@nodename# delete libraries overridden-url-categories <domain>

Команда для отображения всего списка сайтов с измененными категориями:

Admin@nodename# show libraries overridden-url-categories

Команда для отображения информации об определенном сайте с измененными категориями URL:

Admin@nodename# show libraries overridden-url-categories <domain>

Настройка почтовых адресов

Списки почтовых адресов настраиваются на уровне libraries email-list.

Для создания списка почтовых адресов используется команда:

Admin@nodename# create libraries email-list <parameter>

Параметры списка почтовых адресов.

Параметр	Описание
`name`	Название списка почтовых адресов
`description`	Описание списка почтовых адресов
`type`	Тип списка: `local` — локальный. `updatable` — если список является обновляемым, необходимо указать адрес, с которого загружаются обновления (`url`). Периодичность обновления списка указывается параметром `shedule` в формате crontab. Crontab-формат: <минуты: 0–59> <часы: 0–23> <дни месяца: 1–31> <месяцы: 1–12> <дни недели: 0–6, где 0 — воскресенье>. Каждое из полей может быть задано следующим образом: Звездочка (*) — для выбора всех значений. Дефис (-) — для указания диапазона значений. Запятая (,) — в качестве разделителя значений. Косая черта (/) — для указания шага между значениями
`emails`	Почтовые адреса, которые необходимо добавить в список

Команда для редактирования информации осписке почтовых адресов:

Admin@nodename# set libraries email-list <email-list-name> <parameter>

Параметры, доступные для обновления, аналогичны параметрам, доступным при создании группы почтовых адресов.

Команды для удаления списка или почтовых адресов из него:

Admin@nodename# delete libraries email-list <email-list-name>
Admin@nodename# delete libraries email-list <email-list-name> emails [ <email> ... ]

Команды для просмотра информации о всех созданных списках, об определенных списках или для просмотра почтовых адресов, входящих в список:

Admin@nodename# show libraries email-list
Admin@nodename# show libraries email-list <email-list-name>
Admin@nodename# show libraries email-list <email-list-name> emails

Настройка номеров телефонов

Списки номеров телефонов настраиваются на уровне libraries phone-list.

Для создания списка телефонных номеров используется команда:

Admin@nodename# create libraries phone-list <parameter>

Параметры списка телефонных номеров.

Параметр	Описание
`name`	Название списка телефонных номеров
`description`	Описание списка телефонных номеров
`type`	Тип списка: `local` — локальный. `updatable` — если список является обновляемым, необходимо указать адрес, с которого загружаются обновления (`url`). Периодичность обновления списка указывается параметром `shedule` в формате crontab. Crontab-формат: <минуты: 0–59> <часы: 0–23> <дни месяца: 1–31> <месяцы: 1–12> <дни недели: 0–6, где 0 — воскресенье>. Каждое из полей может быть задано следующим образом: Звездочка (*) — для выбора всех значений. Дефис (-) — для указания диапазона значений. Запятая (,) — в качестве разделителя значений. Косая черта (/) — для указания шага между значениями
`phones`	Номера телефонов, которые необходимо добавить в список

Команда для редактирования информации о списке телефонных номеров:

Admin@nodename# set libraries phone-list <phone-list-name> <parameter>

Параметры, доступные для обновления, представлены в таблице выше.

Команды для удаления списка или номеров телефонов из него:

Admin@nodename# delete libraries phone-list <phone-list-name>
Admin@nodename# delete libraries phone-list <phone-list-name> phones [ <phone> ... ]

Команды для просмотра информации о всех созданных списках:

Admin@nodename# show libraries phone-list

Команда для просмотра информации об определенных списках телефонных номеров:

Admin@nodename# show libraries phone-list <phone-list-name>

Команда для просмотра номеров, содержащихся в списке:

Admin@nodename# show libraries phone-list <phone-list-name> phones

Настройка профилей оповещений

Профили оповещений SMTP (по email) и SMPP (по SMS) настраиваются на уровне libraries notification-profiles.

Для добавления нового профиля оповещения SMTP используется команда:

Admin@nodename# create libraries notification-profiles smtp <parameter>

Параметры профиля оповещения SMTP.

Параметр	Описание
`name`	Название профиля
`description`	Описание профиля
`host`	IP-адрес или FQDN сервера SMTP, который будет использоваться для отсылки почтовых сообщений
`port`	Порт TCP, используемый сервером SMTP. Обычно для протокола SMTP используется порт 25, для SMTP с использованием SSL — 465. Уточните данное значение у администратора почтового сервера
`connection-security`	Варианты безопасности отправки почты; возможны варианты: `none`; `starttls`; `ssl`
`authentication`	Включение/отключение авторизации при подключении к серверу SMTP: `on`; `off`
`login`	Имя учетной записи для подключения к SMTP-серверу
`password`	Пароль учетной записи для подключения к SMTP-серверу

Для создания профиля оповещения по SMS (SMPP) используется команда:

Admin@nodename# create libraries notification-profiles smpp <parameter>

Параметры профиля оповещения SMPP.

Параметр	Описание
`name`	Название профиля
`description`	Описание профиля
`host`	IP-адрес или FQDN сервера SMPP, который будет использоваться для отсылки SMS
`port`	Порт TCP, который используется для подключения к серверу SMPP. Обычно для протокола SMPP используется порт 2775; при использовании SSL — 3550
`ssl`	Включение или отключение шифрования SSL: `on`; off
`login`	Имя учетной записи для подключения к SMPP-серверу
`password`	Пароль учетной записи для подключения к SMPP-серверу
`phone-translation-rules`	Правила трансляции телефонных номеров. Правила используются для соответствия требованиям провайдера. Например, если необходимо заменить все номера, начинающиеся на +7, на 8: `Admin@nodename# set libraries notification-profiles smpp <profile-name> phone-translation-rules + [ +7¦8 ]`
`source-ton`	Тип номера (Type of Number) для источника сообщения: `0` — Unknown (Неизвестный); `1` — International (Международный); `2` — National (Государственный); `3` — Network Specific (Сетевой Специальный); `4` — Subscriber Number (Номер абонента); `5` — Alphanumeric (Алфавитно-цифровой); `6` — Abbreviated (Сокращенный)
`dest-ton`	Тип номера (Type of Number) для адресата: `0` — Unknown (Неизвестный); `1` — International (Международный); `2` — National (Государственный); `3` — Network Specific (Сетевой Специальный); `4` — Subscriber Number (Номер абонента); `5` — Alphanumeric (Алфавитно-цифровой); `6` — Abbreviated (Сокращенный)
`source-npi`	Индикатор схемы присвоения номеров (Numbering Plan Indicator) для источника: `0` — Unknown; `1` — ISDN/telephone numbering plan (E.163/E.164); `3` — Data numbering plan (X.121); `4` — Telex numbering plan (F.69); `6` — Land Mobile (E.212); `8` — National numbering plan; `9` — Private numbering plan; `10` — ERMES numbering plan (ETSI DE/PS 3 01-3); `13` — Internet (IP); `18` — WAP Client Id (to be defined by WAP Forum)
`dest-npi`	Индикатор схемы присвоения номеров (Numbering Plan Indicator) для адресата: `0` — Unknown; `1` — ISDN/telephone numbering plan (E.163/E.164); `3` — Data numbering plan (X.121); `4` — Telex numbering plan (F.69); `6` — Land Mobile (E.212); `8` — National numbering plan; `9` — Private numbering plan; `10` — ERMES numbering plan (ETSI DE/PS 3 01-3); `13` — Internet (IP); `18` — WAP Client Id (to be defined by WAP Forum)

Команда для редактирования профиля оповещения:

Admin@nodename# set libraries notification-profiles <smtp | smpp> <profile-name> <parameter>

Параметры профилей SMTP и SMPP, доступные для изменения, представлены в соответствующих таблицах выше.

Команда для удаления профиля:

Admin@nodename# delete libraries notification-profiles <smtp | smpp> <profile-name>

Команда для удаления правил трансляции номеров в профиле SMPP:

Admin@nodename# delete libraries notification-profiles smpp <profile-name> phone-translation-rules [ phone1¦phone2 ]

Команда для отображения информации обо всех имеющихся профилях оповещений:

Admin@nodename# show libraries notification-profiles

Команда для отображения информации обо всех профилях одного типа:

Admin@nodename# show libraries notification-profiles <smtp | smpp>

Команда для отображения информации об определенном профиле оповещения:

Admin@nodename# show libraries notification-profiles <smtp | smpp> <profile-name>

Настройка профилей LLDP

Профили LLDP (Link Layer Discovery Protocol) настраиваются на уровне libraries lldp-profiles.

Для создания профиля LLDP используется команда:

Admin@nodename# create libraries lldp-profiles <parameter>

Параметры профиля LLDP.

Параметр

Описание

name

Название профиля LLDP

description

Описание профиля

port-status

Режимы:

rx — только прием данных LLDP. UserGate SWG не будет отправлять информацию LLDP, но будет анализировать информацию LLDP от соседей.
tx — только передача данных LLDP. UserGate SWG будет отправлять информацию LLDP, но будет отбрасывать информацию LLDP, полученную от соседей.
rx-tx — прием и передача данных LLDP. UserGate SWG будет отправлять информацию LLDP и будет анализировать информацию LLDP, полученную от соседей.

Команда для редактирования информации о профиле:

Admin@nodename# set libraries lldp-profiles <profile-name> <parameter>

Параметры, доступные для обновления, аналогичны параметрам, указываемым при создании профиля.

Команда для удаления профиля LLDP:

Admin@nodename# delete libraries lldp-profiles <profile-name>

Команды для отображения информации о профилях:

Admin@nodename# show libraries lldp-profiles
Admin@nodename# show libraries lldp-profiles <profile-name>

Настройка профилей SSL

Профили SSL настраиваются на уровне libraries ssl-profiles.

Для создания профиля SSL используется команда:

Admin@nodename# create libraries ssl-profiles <parameter>

Параметры профиля SSL.

Параметр	Описание
`name`	Название профиля SSL
`description`	Описание профиля
`min-tls-version`	Минимальная версия TLS, которая может быть использована в профиле: `tls1`; `tls1.1`; `tls1.2`
`max-tls-version`	Максимальная версия TLS, которая может быть использована в профиле: `tls1`; `tls1.1`; `tls1.2`; `tls1.3`
`ssl-ciphers`	Выбор необходимых алгоритмов шифрования и цифровой подписи
`ssl-ciphers-suite`	Установка алгоритмов шифрования для стандартных протоколов. Параметр предназначен для облегчения выбора необходимых алгоритмов шифрования и подписи для стандартных протоколов TLS; необходимо указать версию: `tls1`; `tls1.1`; `tls1.2`; `tls1.3`

Команда для редактирования информации о профиле:

Admin@nodename# set libraries ssl-profiles <profile-name> <parameter>

Параметры, доступные для обновления, аналогичны параметрам, указываемым при создании профиля.

Команды для удаления профиля SSL полностью или для удаления отдельных алгоритмов шифрования и цифровой подписи:

Admin@nodename# delete libraries ssl-profiles <profile-name>
Admin@nodename# delete libraries ssl-profiles <profile-name> ssl-ciphers [ cipher ... ]

Команда для отображения информации о профилях SSL:

Admin@nodename# show libraries ssl-profiles
Admin@nodename# show libraries ssl-profiles <profile-name>

Настройка профилей пересылки SSL

Профили пересылки SSL настраиваются на уровне libraries ssl-forwarding-profiles.

Для создания профиля пересылки используется команда:

Admin@nodename# create libraries ssl-forwarding-profiles <parameter>

Параметры профилей пересылки SSL.

Параметр	Описание
`name`	Название профиля пересылки SSL
`description`	Описание профиля пересылки
`type`	Тип пересылки: `l2` — при настройке необходимо указать MAC-адрес устройства и название интерфейса, на который необходимо переслать копию трафика. `l3` — копия расшифрованного трафика передается по GRE-туннелю. При настройке необходимо указать GRE IP-адресы источника и назначения
`mac`	MAC-адрес назначения (указывается при использовании типа пересылки L2)
`iface`	Интерфейс устройства UserGate, с которого будет производиться пересылка (указывается при использовании типа пересылки L2)
`source-ip`	GRE IP-адрес источника (указывается при использовании типа пересылки L3)
`dest-ip`	GRE IP-адрес назначения (указывается при использовании типа пересылки L3)

Команда для редактирования параметров профилей пересылки:

Admin@nodename# set libraries ssl-forwarding-profiles <profile-name> <parameter>

Команда для удаления профиля:

Admin@nodename# delete libraries ssl-forwarding-profiles <profile-name>

Команды для отображения информации о всех имеющихся профилях или об определенном профиле пересылки:

Admin@nodename# show libraries ssl-forwarding-profiles
Admin@nodename# show libraries ssl-forwarding-profiles <profile-name>

Настройка профилей BFD

Профили BFD настраиваются на уровне libraries bfd-profile.

Для создания профиля BFD используется команда:

Admin@nodename# create libraries bfd-profile

Параметры профиля BFD.

Параметр	Описание
`name`	Название профиля BFD
`description`	Описание профиля
`detect-multiplier`	Множитель времени обнаружения; влияет на время обнаружения неисправностей соединения
`receive-interval`	Интервал приема управляющих пакетов BFD (минимальное время, которое требуется между пакетами); указывается в миллисекундах
`transmit-interval`	Интервал передачи управляющих пакетов BFD; интервал должен быть согласован между узлами; указывается в миллисекундах
`echo-receive-interval`	Минимальный интервал, через который данная система способна принимать echo-пакеты; указывается в миллисекундах
`echo-transmit-interval`	Минимальный интервал, через который система будет способна отправлять echo-пакетов BFD; указывается в миллисекундах
`echo-mode`	Включить или выключить режим передачи `Echo mode`
`pessive-mode`	Включить или выключить режим `Passive`
`ttl`	Минимальное ожидаемое TTL для входящего управляющего пакета BFD. Может принимать значения от 1 до 254

Команда для обновления параметров профиля BFD:

Admin@nodename# set libraries bfd-profile <profile-name> <parameter>

Команда для удаления профиля:

Admin@nodename# delete libraries bfd-profile <profile-name>

Команды для отображения информации обо всех имеющихся профилях или об определенном профиле BFD:

Admin@nodename# show libraries bfd-profile
Admin@nodename# show libraries bfd-profile <profile-name>

Настройка Syslog-фильтров UserID-агента

Syslog-фильтры UserID-агента настраиваются на уровне libraries syslog-filters.

Для создания syslog-фильтра используется команда:

Admin@nodename# create libraries syslog-filters <parameters>

Параметры syslog-фильтра.

Параметр	Описание
`name`	Название фильтра
`description`	Описание фильтра
`login-address`	Строка для поиска IP-адреса пользователя в syslog-сообщении
`login-event`	Строка для поиска события входа пользователя в syslog-сообщении
`login-username`	Строка для поиска имени пользователя в syslog-сообщении
`logout-address`	Строка для поиска IP-адреса пользователя в syslog-сообщении
`logout-event`	Строка для поиска события выхода пользователя в syslog-сообщении
`logout-username`	Строка для поиска имени пользователя в syslog-сообщении

Команда для редактирования информации о syslog-фильтре:

Admin@nodename# set libraries syslog-filters <filter-name> <parameters>

Параметры, доступные для обновления, аналогичны параметрам, указываемым при создании фильтра.

Команда для отображения информации о syslog-фильтрах:

Admin@nodename# show libraries syslog-filters <filter-name>

Команда для удаления syslog-фильтра:

Admin@nodename# delete libraries syslog-filters <filter-name>

Настройка сценариев

Сценарии настраиваются на уровне libraries scenarios с использованием синтаксиса UPL. Подробнее о написании правил с помощью UserGate Policy Language — в разделе «Типы правил»).

Для задания условий сценариев и их объединения используются определения (definitions). Каждому определению присваивается уникальное пользовательское имя, по которому к нему можно будет обратиться. Условия сценария могут быть написаны в одной строке или разбиты с помощью обратного слеша (как при использовании многострочного ввода).

Для создания или изменения условий сценариев используется функция def scenario_cond, которая в общем виде имеет следующую структуру:

def scenario_cond <scenario_condition_name>
<scenario_conditions>
end

После указания условий указываются общие свойства сценария.

Наименование	Описание
`OK`	Действие для создания сценария
`scenario_cond`	Пользовательское имя определения, содержащего список условий сценария: `scenario_cond = condition_example`
`enabled`	Включение или отключение использования сценария: `enabled(true)`; `enabled(false)`
`name`	Имя сценария: `name("Example scenario name")`
`desc`	Описание сценария: `desc("Description for scenario created as an example")`
`trigger`	Применение: `trigger(one_user)` — при срабатывании сценария, правило, в котором используется сценарий, будет применено только к тому пользователю, для которого сработал сценарий; `trigger(all_users)` — при срабатывании сценария, правило в котором используется сценарий, будет применено ко всем пользователям, указанным в свойствах правила
`duration`	Задать период активности сценария; указывается в минутах
`operation_mode`	Задать режим активации сценария: `operation_mode(all)` — сценарий сработает, если выполнятся все условия; `operation_mode(any)` — сценарий сработает, если выполнится хотя бы одно из условий

ПримечаниеПри обновлении сценария необходимо указывать все условия: текущие условия сценария будут заменены на условия, указанные при изменении.

В качестве примера приведена настройка сценария с условием «Объем трафика». Сценарий будет применен ко всем пользователям в течение минуты; ограничение объема трафика: 1 ГБ/день:

Admin@nodename# create libraries scenarios 1 upl-rule \
... def scenario_cond scenario_cond_test
... traffic_limit(1GB) \
... period(day) \
... scond_type(traffic)
... end
... OK \
... scenario_cond = scenario_cond_test
... name(test) \
... trigger(all_users) \
... duration (1)
...

Для изменения, например, объема трафика:

Admin@nodename# set libraries scenarios 3 upl-rule \
...def scenario_cond scenario_cond_test
...traffic_limit(2GB) \
...period(day) \
...scond_type(traffic)
...end
...OK \
...scenario_cond = scenario_cond_test

Типы условий, используемых при создании сценариев

Условие типа «Категория URL»

Параметры для создания или обновления условия типа «Категория URL».

Наименование	Описание
`scond_type`	Тип условия: `scond_type(url_category)`
`category`	Категории или группы категорий сайтов: `category = (lib.category(URL_CATEGORY_GROUP), URL_CATEGORY_NAME)`
`count_interval`	Интервал времени, за которое должно произойти заданное число срабатываний (указывается в минутах): `count_interval()`
`max_event_count`	Количество срабатываний: `max_event_count()`

Условие типа «Обнаружен вирус»

При настройке условия типа «Обнаружен вирус» укажите:

scond_type — Тип условия: scond_type(virus_detection).

Условие типа «Приложение»

Параметры для создания или редактирования условия типа «Приложение».

Наименование	Описание
`scond_type`	Тип условия: `scond_type(app)`
`application`	Категории приложений или группы приложений: `application = lib.applicationgroup(APP_GROUP)` или `application = lib.applicationgroup(all)`; `application = lib.category(APPS_CATEGORY_NAME)`
`count_interval`	Интервал времени, за которое должно произойти заданное число срабатываний (указывается в минутах): `count_interval()`
`max_event_count`	Количество срабатываний: `max_event_count()`

Условие типа «СОВ»

Параметры условия типа «СОВ».

Наименование

Описание

scond_type

Тип условия: scond_type(ips)

ips_tl

Уровень угрозы:

ips_tl(very_low) – очень низкий;
ips_tl(low) – низкий;
ips_tl(medium) – средний;
ips_tl(high) – высокий;
ips_tl(very_high) – очень высокий

Условие типа «Типы контента»

Параметры для условия «Типы контента».

Наименование	Описание
`scond_type`	Тип условия: `scond_type(mime_type)`
`response.header.Content-Type`	Тип контента: `response.header.Content-Type = lib.mime(MIME_CATEGORIES_LIST)`
`count_interval`	Интервал времени, за которое должно произойти заданное число срабатываний (указывается в минутах): `count_interval()`
`max_event_count`	Количество срабатываний: `max_event_count()`

Условие типа «Объем трафика»

Параметры для условия «Объем трафика».

Наименование

Описание

scond_type

Тип условия: scond_type(traffic)

traffic_limit

Ограничение объема трафика:

traffic_limit(1) – 1 байт трафика;
traffic_limit(1KB) – 1 Кбайт трафика;
traffic_limit(1MB) – 1 Мбайт трафика;
traffic_limit(1GB) – 1 Гбайт трафика

period

Период времени:

period(minute) – минута;
period(hour) – час;
period(day) – день;
period(week) – неделя;
period(month) – месяц

Условие типа «Проверка состояния»

Параметры условия «Проверка состояния».

Наименование	Описание
`scond_type`	Тип условия: `scond_type(health_check)`
`health_check_method`	Метод проверки: `health_check_method(ping)` – ping; `health_check_method(dns)` – DNS-запрос; `health_check_method(get)` – HTTP-метод GET
`url.address`	Адрес, на который будут выполняться ping и DNS-запрос: `url.address = "1.1.1.1"`
`url.domain`	FQDN для проверки состояния путем выполнения DNS-запроса или URL для метода HTTP GET: `url.domain = "example.ru"`
`gateway`	Название используемого шлюза: `gateway()`. Важно! Шлюз должен быть предварительно создан
`health_result`	Результат выполнения проверки: `health_result(positive)` – положительный; `health_result(negative)` – отрицательный
`health_request_timeout`	Тайм-аут подключения (в секундах): `health_request_timeout()`
`health_answer_timeout`	Время ожидания ответа на запрос HTTP GET (в секундах): `health_answer_timeout()`
`health_type_request`	Тип DNS-запроса: `health_type_request(a)`; `health_type_request(aaaa)`; `health_type_request(cname)`; `health_type_request(ns)`; `health_type_request(ptr)`
`count_interval`	Интервал времени, за которое должно произойти заданное число срабатываний (указывается в минутах): `count_interval()`
`max_event_count`	Количество срабатываний: `max_event_count()`

Настройка тегов

Теги настраиваются на уровне libraries tags.

Для создания тегов сипользуется команда:

Admin@nodename# create libraries tags <parameters>

Параметры тегов.

Параметр

Описание

name

Название тега

description

Описание тега

color

Выбор цветовой маркировки тега для отображения в веб-интерфейсе:

no-color (Значение по умолчанию);
red;
orange;
yellow;
green;
aqua;
blue;
violet;
pink;
purple;
light-gray;
light-green;
light-blue;
black;
rose;
magenta;
wood

Команда для редактирования информации о теге:

Admin@nodename# set libraries tags <tag-name> <parameters>

Параметры, доступные для обновления, аналогичны параметрам, указываемым при создании тега.

Команда для отображения информации о тэгах:

Admin@nodename# show libraries tags <tag-name>

Команда для удаления тега:

Admin@nodename# delete libraries tags <tag-name>

Примеры работы с тэгами в библиотеке:

Admin@nodename# create libraries tags name "Test tag 6" description "Tag made with CLI" color magenta
Admin@nodename# show libraries tags

Test tag 6
    name           : Test tag 6
    description    : Tag made with CLI
    color          : magenta
 
Tag 5
    name           : Tag 5
    description    : Test tag #5
    color          : green
 
Tag 1
    name           : Tag 1
    description    : Test tag #1
    color          : no-color
 
Admin@nodename# show libraries tags "Test tag 6"

name           : Test tag 6
description    : Tag made with CLI
color          : magenta
 
Admin@nodename# set libraries tags "Test tag 6" description "Update tag from cli"
Admin@nodename# show libraries tags "Test tag 6"

name           : Test tag 6
description    : Update tag from cli
color          : magenta

Admin@nodename# delete libraries tags "Test tag 6"

Настройка морфологии

Настройка IP-адресов

Настройка User agent браузеров

Настройка списков URL

Настройка календарей

Настройка полос пропускания

Настройка шаблонов страниц

Настройка категорий URL

Настройка измененных категорий URL

Настройка почтовых адресов

Настройка номеров телефонов

Настройка профилей оповещений

Настройка профилей LLDP

Настройка профилей SSL

Настройка профилей пересылки SSL

Настройка профилей BFD

Настройка Syslog-фильтров UserID-агента

Настройка сценариев

Типы условий, используемых при создании сценариев

Условие типа «Категория URL»

Условие типа «Обнаружен вирус»

Условие типа «СОВ»

Условие типа «Типы контента»

Условие типа «Объем трафика»

Условие типа «Проверка состояния»

Настройка тегов