Spec-Zone.ru › Ansible

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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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.15

Параметры

Параметр

Комментарии

access_token

строка

Аутентификация на основе токена. Сгенерирована из интерфейса Fortigate.

enable_log

логический

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

Варианты:

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

member_path

строка

Путь к атрибуту члена для обработки.

Разделяется слешем, если атрибутов несколько.

Параметр, помеченный member_path, подходит для выполнения операций с членами.

member_state

строка

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

Когда задан member_state, опция state игнорируется.

Варианты:

  • "present"
  • "absent"

system_fortiguard

словарь

Настройка сервисов FortiGuard.

antispam_cache

строка

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

Варианты:

  • "enable"
  • "disable"

antispam_cache_mpercent

целое число

Максимальный процент памяти FortiGate, который может использовать кэш antispam (1 - 15).

antispam_cache_mpermille

целое число

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

antispam_cache_ttl

целое число

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

antispam_expiration

целое число

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

antispam_force_off

строка

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

Варианты:

  • "enable"
  • "disable"

antispam_license

целое число

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

antispam_timeout

целое число

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

anycast_sdns_server_ip

строка

IP-адрес сервера рейтингов FortiGuard anycast DNS.

anycast_sdns_server_port

целое число

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

auto_firmware_upgrade

строка

Включить/выключить автоматическое обновление прошивки с уровня патчей из FortiGuard. Устройство FortiGate ищет новые патчи только в той же версии major и minor.

Варианты:

  • "enable"
  • "disable"

auto_firmware_upgrade_day

список / элементы=строка

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

Варианты:

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

auto_firmware_upgrade_delay

целое число

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

auto_firmware_upgrade_end_hour

целое число

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

auto_firmware_upgrade_start_hour

integer

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

auto_join_forticloud

string

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

Choices:

  • "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.

Choices:

  • "enable"
  • "disable"

fortiguard_anycast_source

string

Настроить, какой из серверов Fortinet будет предоставлять услуги FortiGuard в сети Anycast FortiGuard. По умолчанию используется Fortinet.

Choices:

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

interface

string

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

interface_select_method

string

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

Choices:

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

load_balance_servers

integer

Количество серверов, между которыми нужно чередоваться в качестве первого варианта FortiGuard.

outbreak_prevention_cache

string

Включить/отключить кэш предотвращения вирусных вспышек FortiGuard.

Choices:

  • "enable"
  • "disable"

outbreak_prevention_cache_mpercent

integer

Максимальный процент памяти, который может использовать кэш предотвращения вирусных вспышек FortiGuard (1 - 15%).

outbreak_prevention_cache_mpermille

integer

Максимальное количество промилле памяти, которое может использовать кэш предотвращения вирусных вспышек FortiGuard (1 - 150 промилле).

outbreak_prevention_cache_ttl

integer

Время жизни для записей кэша предотвращения вирусных вспышек FortiGuard (300 - 86400 сек).

outbreak_prevention_expiration

integer

Дата истечения срока действия контракта на предотвращение вирусных вспышек FortiGuard.

outbreak_prevention_force_off

string

Выключить службу предотвращения вирусных вспышек FortiGuard.

Choices:

  • "enable"
  • "disable"

outbreak_prevention_license

integer

Интервал времени между проверками лицензий для контракта на предотвращение вирусных вспышек FortiGuard.

outbreak_prevention_timeout

integer

Время ожидания предотвращения вирусных вспышек FortiGuard (1 - 30 сек).

persistent_connection

string

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

Choices:

  • "enable"
  • "disable"

port

string

Порт, используемый для связи с серверами FortiGuard.

Choices:

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

protocol

string

Протокол, используемый для связи с серверами FortiGuard.

Choices:

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

proxy_password

string

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

proxy_server_ip

string

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

proxy_server_port

integer

Порт, используемый для связи с прокси-сервером.

proxy_username

string

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

sandbox_inline_scan

string

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

Choices:

  • "enable"
  • "disable"

sandbox_region

string

Регион FortiCloud Sandbox.

sdns_options

list / elements=string

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

Choices:

  • "include-question-section"

sdns_server_ip

list / elements=string

IP-адрес сервера рейтингования FortiGuard DNS.

sdns_server_port

integer

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

service_account_id

string

Идентификатор учетной записи службы.

source_ip

string

Исходный IPv4-адрес, используемый для связи с FortiGuard.

source_ip6

string

Исходный IPv6-адрес, используемый для связи с FortiGuard.

update_build_proxy

string

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

Choices:

  • "enable"
  • "disable"

update_dldb

string

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

Choices:

  • "enable"
  • "disable"

update_extdb

string

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

Choices:

  • "enable"
  • "disable"

update_ffdb

string

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

Choices:

  • "enable"
  • "disable"

update_server_location

string

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

Choices:

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

update_uwdb

string

Включить/выключить обновление белого списка.

Choices:

  • "enable"
  • "disable"

vdom

string

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

videofilter_expiration

integer

Срок действия контракта на видеофильтр FortiGuard.

videofilter_license

integer

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

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 для выполнения playbook'ов.

Примеры

- 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>"
          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"
          webfilter_cache: "enable"
          webfilter_cache_ttl: "3600"
          webfilter_expiration: "0"
          webfilter_force_off: "enable"
          webfilter_license: "4294967295"
          webfilter_timeout: "15"

Значения возврата

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

Ключ

Описание

build

строка

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

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

Пример: "1547"

http_method

строка

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

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

Пример: "PUT"

http_status

строка

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

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

Пример: "200"

mkey

строка

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

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

Пример: "id"

name

строка

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

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

Пример: "urlfilter"

path

строка

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

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

Пример: "webfilter"

revision

строка

Внутренний номер ревизии

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

Пример: "17.0.2.10658"

serial

строка

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

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

Пример: "FGVMEVYYQT3AB5352"

status

строка

Указание результата операции

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

Пример: "success"

vdom

строка

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

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

Пример: "root"

version

строка

Версия 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_fortiguard_module.html

Spec-Zone.ru

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