Функция экспорта и импорта конфигурации

В версии 7.5.0 и выше UserGate NGFW поддерживает функцию экспорта и импорта конфигурации устройства в текстовом формате. С помощью этой функции вы можете:

• развертывать новые устройства посредством клонирования конфигураций;

• добавлять однотипные параметры на устройства;

• быстро восстанавливать устройства после сбоев;

• проводить анализ, аудит или документирование изменений параметров устройств.

Экспорт и импорт конфигурации выполняется с помощью утилиты scp (Secure Copy Protocol) в приложении терминала на компьютере пользователя.

Экспорт конфигурации

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

USER_KEY="<value>" scp -P 2200 -o 'SendEnv=USER_KEY' <user-name>@<IP-address>:sys_config <file-name>

Укажите имя пользователя, IP-адрес UserGate NGFW, название экспортируемого файла. Для шифрования чувствительных данных (паролей, ключей, сертификатов) при экспорте конфигурации задайте переменную окружения с собственной кодовой строкой (USER_KEY). Для импорта этого файла конфигурации необходимо будет использовать ту же кодовую строку.

Пример команды экспорта конфигурации:

USER_KEY="123123" scp -P 2200 -o 'SendEnv=USER_KEY' Admin@192.168.1.100:sys_config configfile1

Полученный файл содержит полную структурированную конфигурацию устройства в текстовом виде. В начале файла конфигурации находится блок метаданных:

-------------
# Comment
author: ''
product: NGFW
version: 7.X.X. YYYYY
created: August 12, 2025, 08:04
secret: bamy2jBfI6jcVTXWT6RkNbDlOAA=
factory-reset: off
-------------

Назначение параметров в блоке метаданных:

• author —  параметр, в котором вы можете указать имя автора подготовленной конфигурации.

• product — название продукта. Значение параметра устанавливается системой при экспорте данных.

• version — версия UGOS устройства. Значение параметра устанавливается системой при экспорте данных.

• created — время создания файла конфигурации. Значение параметра устанавливается системой при экспорте данных. Этот параметр не должен меняться пользователем.

• secret — ключ шифрования чувствительных данных. Значение параметра устанавливается системой при экспорте данных.

• factory-reset — параметр, определяющий порядок импорта данных из файла конфигурации:

  • off — параметры конфигурации из файла будут добавлены к существующей конфигурации на устройстве;

  • on — параметры конфигурации из файла заменят собой параметры существующей конфигурации.

• # — символ, с помощью которого вы можете добавлять произвольные комментарии в блоке метаданных. 

Импорт конфигурации

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

USER_KEY="<value>" scp -P 2200 -o 'SendEnv=USER_KEY' <file-name> <user-name>@<IP-address>:sys_config

Укажите имя пользователя, IP-адрес UserGate NGFW, название импортируемого файла, переменную окружения с той же кодовой строкой, которая была использована при экспорте конфигурации.

Пример команды импорта конфигурации:

USER_KEY="123123" scp -P 2200 -o 'SendEnv=USER_KEY' configfile1 Admin@192.168.1.100:sys_config

В зависимости от значения параметра factory-reset в блоке метаданных импортируемого файла параметры конфигурации будут добавлены к имеющейся конфигурации устройства или заменят ее.

Импортированные данные сразу же применяются на устройстве после импорта файла. Записи об изменениях параметров конфигурации отображаются в системном журнале событий (event log).

Просмотр журнала ошибок операций импорта и экспорта

Ошибки операций импорта и экспорта конфигурации можно просмотреть с помощью команды:

Admin@nodename> show logs transfer-logs <parameters>

Дополнительные параметры команды:

• direction —  порядок отображения записей:

  • new-first — сначала новые записи;

  • old-first — сначала старые записи.

• raw — отображение полного списка записей журнала.