Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_fortiguard — настройка служб FortiGuard в FortiOS и FortiGate компании Fortinet.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: fortinet.fortios.fortios_system_fortiguard.

Добавлено в fortinet.fortios 2.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя системные функции и категории FortiGuard. В примерах приведены все параметры и значения, которые перед использованием необходимо скорректировать в соответствии с источниками данных. Проверено на FOS v6.0.0

Требования

Следующие требования должны быть выполнены на узле, на котором выполняется этот модуль.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

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

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с пометкой member_path можно использовать для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если указан member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

system_fortiguard

dictionary

Настройка служб FortiGuard.

antispam_cache

string

Включить/отключить кэширование запросов FortiGuard Antispam. Для этого требуется немного памяти, но производительность повышается.

Варианты:

  • "enable"
  • "disable"

antispam_cache_mpercent

integer

Максимальная доля памяти FortiGate, которую может использовать кэш антиспама (1–15).

antispam_cache_mpermille

integer

Максимальная доля памяти FortiGate в промилле, которую может использовать кэш антиспама (1–150).

antispam_cache_ttl

integer

Время жизни записей кэша антиспама в секундах (300–86400). Меньшее значение сокращает размер кэша. Большее значение может повысить производительность, поскольку в кэше будет больше записей.

antispam_expiration

integer

Дата окончания срока действия контракта FortiGuard Antispam.

antispam_force_off

string

Включить/отключить принудительное выключение службы FortiGuard Antispam.

Варианты:

  • "enable"
  • "disable"

antispam_license

integer

Интервал между проверками лицензии на контракт FortiGuard Antispam.

antispam_timeout

integer

Тайм-аут запроса антиспама (1–30 с).

anycast_sdns_server_ip

string

IP-адрес сервера оценки DNS FortiGuard Anycast.

anycast_sdns_server_port

integer

Порт для подключения к серверу оценки DNS FortiGuard Anycast.

auto_firmware_upgrade

string

Включить/отключить автоматическое обновление встроенного ПО до следующего уровня исправлений из FortiGuard. Устройство FortiGate ищет новые исправления только в пределах той же основной и дополнительной версии.

Варианты:

  • "enable"
  • "disable"

auto_firmware_upgrade_day

list / elements=string

Дни недели, в которые разрешена автоматическая установка обновления встроенного ПО до следующего уровня исправлений из FortiGuard. Чтобы запретить установку в любой день недели, используйте параметр auto-firmware-upgrade-delay; он задает ожидание до указанных дней перед установкой автоматического обновления встроенного ПО до следующего уровня исправлений.

Варианты:

  • "sunday"
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"

auto_firmware_upgrade_delay

integer

Задержка в днях перед автоматической установкой обновления встроенного ПО до следующего уровня исправлений из FortiGuard в течение недели.

auto_firmware_upgrade_end_hour

integer

Время окончания заданного интервала для автоматического обновления встроенного ПО до следующего уровня исправлений из FortiGuard в 24-часовом формате (0–23). Если время окончания меньше времени начала, оно считается временем следующего дня. Фактическое время обновления выбирается случайным образом в пределах интервала.

auto_firmware_upgrade_start_hour

integer

Время начала заданного интервала для автоматического обновления встроенного ПО до следующего уровня исправлений из FortiGuard в 24-часовом формате (0–23). Фактическое время обновления выбирается случайным образом в пределах интервала.

auto_join_forticloud

string

Автоматически подключаться к FortiCloud и входить в систему.

Варианты:

  • "enable"
  • "disable"

ddns_server_ip

string

IP-адрес сервера FortiDDNS.

ddns_server_ip6

string

IPv6-адрес сервера FortiDDNS.

ddns_server_port

integer

Порт для обмена данными с серверами FortiDDNS.

FDS_license_expiring_days

integer

Пороговое количество дней до окончания срока действия лицензии FortiGuard, при достижении которого создается запись события об истечении срока действия лицензии (1–100 дней).

fortiguard_anycast

string

Включить/отключить использование сети Anycast FortiGuard.

Варианты:

  • "enable"
  • "disable"

fortiguard_anycast_source

string

Укажите, какие серверы Fortinet будут предоставлять службы FortiGuard в сети Anycast FortiGuard. По умолчанию — Fortinet.

Варианты:

  • "fortinet"
  • "aws"
  • "debug"

interface

string

Укажите исходящий интерфейс для подключения к серверу. Источник: system.interface.name.

interface_select_method

string

Укажите способ выбора исходящего интерфейса для подключения к серверу.

Варианты:

  • "auto"
  • "sdwan"
  • "specify"

load_balance_servers

integer

Количество серверов для чередования в качестве первого варианта FortiGuard.

outbreak_prevention_cache

string

Включить/отключить кэш службы FortiGuard Virus Outbreak Prevention.

Варианты:

  • "enable"
  • "disable"

outbreak_prevention_cache_mpercent

integer

Максимальная доля памяти, которую может использовать кэш FortiGuard Virus Outbreak Prevention (1–15%).

outbreak_prevention_cache_mpermille

integer

Максимальная доля памяти в промилле, которую может использовать кэш FortiGuard Virus Outbreak Prevention (1–150 промилле).

outbreak_prevention_cache_ttl

integer

Время жизни записей кэша FortiGuard Virus Outbreak Prevention (300–86400 с).

outbreak_prevention_expiration

integer

Дата окончания срока действия контракта FortiGuard Virus Outbreak Prevention.

outbreak_prevention_force_off

string

Выключить службу FortiGuard Virus Outbreak Prevention.

Варианты:

  • "enable"
  • "disable"

outbreak_prevention_license

integer

Интервал между проверками лицензии на контракт FortiGuard Virus Outbreak Prevention.

outbreak_prevention_timeout

integer

Тайм-аут FortiGuard Virus Outbreak Prevention (1–30 с).

persistent_connection

string

Включить/отключить использование постоянного соединения для получения уведомлений об обновлениях от FortiGuard.

Варианты:

  • "enable"
  • "disable"

port

string

Порт для обмена данными с серверами FortiGuard.

Варианты:

  • "8888"
  • "53"
  • "80"
  • "443"

protocol

string

Протокол для обмена данными с серверами FortiGuard.

Варианты:

  • "udp"
  • "http"
  • "https"

proxy_password

string

Пароль пользователя прокси-сервера.

proxy_server_ip

string

Имя хоста или IPv4-адрес прокси-сервера.

proxy_server_port

integer

Порт для обмена данными с прокси-сервером.

proxy_username

string

Имя пользователя прокси-сервера.

sandbox_inline_scan

string

Включить/отключить встроенное сканирование FortiCloud Sandbox.

Варианты:

  • "enable"
  • "disable"

sandbox_region

string

Регион FortiCloud Sandbox.

sdns_options

list / elements=string

Параметры настройки службы FortiGuard DNS.

Варианты:

  • "include-question-section"

sdns_server_ip

list / elements=string

IP-адрес сервера оценки DNS FortiGuard.

sdns_server_port

integer

Порт для подключения к серверу оценки DNS FortiGuard.

service_account_id

string

Идентификатор сервисной учетной записи.

source_ip

string

Исходный IPv4-адрес для обмена данными с FortiGuard.

source_ip6

string

Исходный IPv6-адрес для обмена данными с FortiGuard.

subscribe_update_notification

string

Включить/отключить подписку на получение уведомлений об обновлениях от FortiGuard.

Варианты:

  • "enable"
  • "disable"

update_build_proxy

string

Включить/отключить перестроение словаря прокси-сервера.

Варианты:

  • "enable"
  • "disable"

update_dldb

string

Включить/отключить обновление сигнатур DLP.

Варианты:

  • "enable"
  • "disable"

update_extdb

string

Включение/отключение обновления внешних ресурсов.

Варианты:

  • "enable"
  • "disable"

update_ffdb

string

Включение/отключение обновления базы данных интернет-сервисов.

Варианты:

  • "enable"
  • "disable"

update_server_location

string

Местоположение, из которого следует получать обновления FortiGuard.

Варианты:

  • "automatic"
  • "usa"
  • "eu"
  • "any"

update_uwdb

string

Включение/отключение обновления списка разрешений.

Варианты:

  • "enable"
  • "disable"

vdom

string

Имя виртуального домена службы FortiGuard. Источник: system.vdom.name.

videofilter_expiration

integer

Дата окончания срока действия контракта FortiGuard на фильтрацию видео.

videofilter_license

integer

Интервал между проверками лицензии для контракта FortiGuard на фильтрацию видео.

vrf_select

integer

Идентификатор VRF, используемый для подключения к серверу.

webfilter_cache

string

Включение/отключение кэширования веб-фильтра FortiGuard.

Варианты:

  • "enable"
  • "disable"

webfilter_cache_ttl

integer

Время жизни записей кэша веб-фильтра в секундах (300–86400).

webfilter_expiration

integer

Дата окончания срока действия контракта FortiGuard на веб-фильтрацию.

webfilter_force_off

string

Включение/отключение принудительного выключения службы веб-фильтрации FortiGuard.

Варианты:

  • "enable"
  • "disable"

webfilter_license

integer

Интервал между проверками лицензии для контракта FortiGuard на веб-фильтрацию.

webfilter_timeout

integer

Время ожидания ответа на запрос веб-фильтра (1–30 с).

vdom

string

Виртуальный домен из числа ранее определенных. vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi объявлен устаревшим; предпочтительный способ запуска плейбуков — httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure FortiGuard services.
  fortinet.fortios.fortios_system_fortiguard:
      vdom: "{{ vdom }}"
      system_fortiguard:
          antispam_cache: "enable"
          antispam_cache_mpercent: "2"
          antispam_cache_mpermille: "1"
          antispam_cache_ttl: "1800"
          antispam_expiration: "0"
          antispam_force_off: "enable"
          antispam_license: "4294967295"
          antispam_timeout: "7"
          anycast_sdns_server_ip: "<your_own_value>"
          anycast_sdns_server_port: "853"
          auto_firmware_upgrade: "enable"
          auto_firmware_upgrade_day: "sunday"
          auto_firmware_upgrade_delay: "3"
          auto_firmware_upgrade_end_hour: "4"
          auto_firmware_upgrade_start_hour: "1"
          auto_join_forticloud: "enable"
          ddns_server_ip: "<your_own_value>"
          ddns_server_ip6: "<your_own_value>"
          ddns_server_port: "443"
          FDS_license_expiring_days: "15"
          fortiguard_anycast: "enable"
          fortiguard_anycast_source: "fortinet"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          load_balance_servers: "1"
          outbreak_prevention_cache: "enable"
          outbreak_prevention_cache_mpercent: "2"
          outbreak_prevention_cache_mpermille: "1"
          outbreak_prevention_cache_ttl: "300"
          outbreak_prevention_expiration: "0"
          outbreak_prevention_force_off: "enable"
          outbreak_prevention_license: "4294967295"
          outbreak_prevention_timeout: "7"
          persistent_connection: "enable"
          port: "8888"
          protocol: "udp"
          proxy_password: "<your_own_value>"
          proxy_server_ip: "<your_own_value>"
          proxy_server_port: "0"
          proxy_username: "<your_own_value>"
          sandbox_inline_scan: "enable"
          sandbox_region: "<your_own_value>"
          sdns_options: "include-question-section"
          sdns_server_ip: "<your_own_value>"
          sdns_server_port: "53"
          service_account_id: "<your_own_value>"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          subscribe_update_notification: "enable"
          update_build_proxy: "enable"
          update_dldb: "enable"
          update_extdb: "enable"
          update_ffdb: "enable"
          update_server_location: "automatic"
          update_uwdb: "enable"
          vdom: "<your_own_value> (source system.vdom.name)"
          videofilter_expiration: "0"
          videofilter_license: "4294967295"
          vrf_select: "0"
          webfilter_cache: "enable"
          webfilter_cache_ttl: "3600"
          webfilter_expiration: "0"
          webfilter_force_off: "enable"
          webfilter_license: "4294967295"
          webfilter_timeout: "15"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращенный FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_system_fortiguard_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API