Модуль fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting — настройка параметров работы FortiGuard.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting.
Добавлено в fortinet.fortimanager 2.0.0
Описание
- Этот модуль позволяет настраивать устройство FortiManager.
- В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation boolean | Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
fmupdate_webspam_fgdsetting dictionary | Набор параметров верхнего уровня. |
|
as_cache aliases: as-cache integer |
Максимальный объем памяти, используемый службой защиты от спама, в мегабайтах |
|
as_log aliases: as-log string |
Настройка журнала защиты от спама disable — отключить журнал спама. nospam — записывать события, не связанные со спамом. all — записывать все проверки на спам. Варианты:
|
|
as_preload aliases: as-preload string |
Включить или отключить предварительную загрузку базы данных защиты от спама в память disable — отключить предварительную загрузку базы данных защиты от спама. enable — включить предварительную загрузку базы данных защиты от спама. Варианты:
|
|
av2_cache aliases: av2-cache integer |
Максимальный объем памяти, используемый службой защиты от спама, в мегабайтах |
|
av2_log aliases: av2-log string |
Настройка журнала предотвращения вспышек вредоносной активности disable — отключить журнал av2. noav2 — записывать события, не связанные с av2. all — записывать все проверки av2. Варианты:
|
|
av2_preload aliases: av2-preload string |
Включить или отключить предварительную загрузку базы данных предотвращения вспышек вредоносной активности в память disable — отключить предварительную загрузку базы данных предотвращения вспышек вредоносной активности. enable — включить предварительную загрузку базы данных предотвращения вспышек вредоносной активности. Варианты:
|
|
av_cache aliases: av-cache integer |
Максимальный объем памяти, используемый антивирусной службой, в мегабайтах |
|
av_log aliases: av-log string |
Настройка антивирусного журнала disable — отключить журнал вирусов. novirus — записывать события, не связанные с вирусами. all — записывать все проверки на вирусы. Варианты:
|
|
av_preload aliases: av-preload string |
Включить или отключить предварительную загрузку антивирусной базы данных в память disable — отключить предварительную загрузку антивирусной базы данных. enable — включить предварительную загрузку антивирусной базы данных. Варианты:
|
|
eventlog_query aliases: eventlog-query string |
Включить или отключить запись запросов в журнал событий помимо fgd-журнала disable — записывать запросы в журнал событий помимо fgd-журнала. enable — не записывать данные в журнал событий. Варианты:
|
|
fgd_pull_interval aliases: fgd-pull-interval integer |
Интервал получения обновлений FGD в минутах |
|
fq_cache aliases: fq-cache integer |
Максимальный объем памяти, используемый службой запросов файлов, в мегабайтах |
|
fq_log aliases: fq-log string |
Настройка журнала запросов файлов disable — отключить журнал запросов файлов. nofilequery — записывать события, не связанные с запросами файлов. all — записывать все события запросов файлов. Варианты:
|
|
fq_preload aliases: fq-preload string |
Включить или отключить предварительную загрузку базы данных запросов файлов в память disable — отключить предварительную загрузку базы данных запросов файлов. enable — включить предварительную загрузку базы данных запросов файлов. Варианты:
|
|
iot_cache aliases: iot-cache integer |
Максимальный объем памяти, используемый службой IoT, в мегабайтах |
|
iot_log aliases: iot-log string |
Настройка журнала IoT disable — отключить журнал IoT. nofilequery — записывать события, не связанные с IoT. all — записывать все события IoT. Варианты:
|
|
iot_preload aliases: iot-preload string |
Включить или отключить предварительную загрузку базы данных IoT в память disable — отключить предварительную загрузку базы данных IoT. enable — включить предварительную загрузку базы данных IoT. Варианты:
|
|
iotv_preload aliases: iotv-preload string |
Включить или отключить предварительную загрузку базы данных уязвимостей IoT в память disable — отключить предварительную загрузку базы данных уязвимостей IoT. enable — включить предварительную загрузку базы данных уязвимостей IoT. Варианты:
|
|
linkd_log aliases: linkd-log string |
Настройка журнала Linkd emergency — устройство непригодно к использованию. alert — требуется немедленное вмешательство. critical — функциональность нарушена. error — вероятно, функциональность нарушена. warn — функциональность может быть нарушена. notice — информация о штатных событиях. info — общая информация. debug — отладочная информация. disable — ведение журнала Linkd отключено. Варианты:
|
|
max_client_worker aliases: max-client-worker integer |
Максимальное количество рабочих процессов для TCP-подключений клиентов |
|
max_log_quota aliases: max-log-quota integer |
Максимальная квота журнала в мегабайтах |
|
max_unrated_site aliases: max-unrated-site integer |
Максимальное количество сайтов без рейтинга в памяти, в килобайтах |
|
restrict_as1_dbver aliases: restrict-as1-dbver string |
Ограничить обновление системы указанной версией базы данных защиты от спама |
|
restrict_as2_dbver aliases: restrict-as2-dbver string |
Ограничить обновление системы указанной версией базы данных защиты от спама |
|
restrict_as4_dbver aliases: restrict-as4-dbver string |
Ограничить обновление системы указанной версией базы данных защиты от спама |
|
restrict_av2_dbver aliases: restrict-av2-dbver string |
Ограничить обновление системы указанной версией базы данных предотвращения вспышек вредоносной активности |
|
restrict_av_dbver aliases: restrict-av-dbver string |
Ограничить обновление системы указанной версией антивирусной базы данных |
|
restrict_fq_dbver aliases: restrict-fq-dbver string |
Ограничить обновление системы указанной версией базы данных запросов файлов |
|
restrict_iots_dbver aliases: restrict-iots-dbver string |
Ограничить обновление системы указанной версией базы данных запросов файлов |
|
restrict_wf_dbver aliases: restrict-wf-dbver string |
Ограничить обновление системы указанной версией базы данных веб-фильтрации |
|
server_override aliases: server-override dictionary |
Переопределение сервера. |
|
servlist list / elements=dictionary |
Список серверов. |
|
id integer |
ID переопределяемого сервера |
|
ip string |
IPv4-адрес переопределяемого сервера. |
|
ip6 string |
IPv6-адрес переопределяемого сервера. |
|
port integer |
Номер порта для подключения к FortiGuard |
|
service_type aliases: service-type any |
(список или строка) Переопределение типа службы. fgd — конфигурация переопределения сервера для fgd fgc — конфигурация переопределения сервера для fgc fsa — конфигурация переопределения сервера для fsa Варианты:
|
|
status string |
Статус переопределения. disable — отключить настройку. enable — включить настройку. Варианты:
|
|
stat_log aliases: stat-log string |
Настройка журнала статистики emergency — устройство непригодно к использованию alert — требуется немедленное вмешательство critical — функциональность нарушена error — вероятно, функциональность нарушена warn — функциональность может быть нарушена notice — информация о штатных событиях info — общая информация debug — отладочная информация disable — ведение журнала Linkd отключено. Варианты:
|
|
stat_log_interval aliases: stat-log-interval integer |
Интервал записи статистики в журнал в минутах |
|
stat_sync_interval aliases: stat-sync-interval integer |
Интервал синхронизации статистики сайтов без рейтинга в минутах |
|
update_interval aliases: update-interval integer |
Время ожидания обновления базы данных FortiGuard при недостаточном количестве файлов delta, в часах |
|
update_log aliases: update-log string |
Включение/отключение ведения журнала обновлений disable — отключить журнал обновлений. enable — включить журнал обновлений. Варианты:
|
|
wf_cache aliases: wf-cache integer |
Максимальное использование памяти службой веб-фильтрации, в мегабайтах |
|
wf_dn_cache_expire_time aliases: wf-dn-cache-expire-time integer |
Время действия кэша DN веб-фильтра, в минутах |
|
wf_dn_cache_max_number aliases: wf-dn-cache-max-number integer |
Максимальное количество записей в кэше DN веб-фильтра |
|
wf_log aliases: wf-log string |
Настройка журнала веб-фильтра disable — не вести журнал URL-адресов. nourl — регистрировать события, не связанные с URL-адресами. all — регистрировать все запросы URL. Варианты:
|
|
wf_preload aliases: wf-preload string |
Включение/отключение предварительной загрузки базы данных веб-фильтра в память disable — отключить предварительную загрузку базы данных веб-фильтра. enable — включить предварительную загрузку базы данных веб-фильтра. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API forticloud. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, для которых условия сбоя будут переопределены. |
rc_succeeded list / elements=integer | Список кодов rc, для которых условия успешного выполнения будут переопределены. |
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочей области; в качестве значения можно указать global или другие ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, имена всех входных аргументов задаются в соответствии с соглашением об именовании через подчёркивание (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, однако будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
- Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout позволяют использовать эту возможность.
- Обычно выполнение модуля завершается с ошибкой, если возвращается ненулевой код rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure the FortiGuard run parameters.
fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting:
# workspace_locking_adom: <global or your adom name>
fmupdate_webspam_fgdsetting:
# as_cache: <integer>
# as_log: <value in [disable, nospam, all]>
# as_preload: <value in [disable, enable]>
# av_cache: <integer>
# av_log: <value in [disable, novirus, all]>
# av_preload: <value in [disable, enable]>
# av2_cache: <integer>
# av2_log: <value in [disable, noav2, all]>
# av2_preload: <value in [disable, enable]>
# eventlog_query: <value in [disable, enable]>
# fgd_pull_interval: <integer>
# fq_cache: <integer>
# fq_log: <value in [disable, nofilequery, all]>
# fq_preload: <value in [disable, enable]>
# linkd_log: <value in [emergency, alert, critical, ...]>
# max_client_worker: <integer>
# max_log_quota: <integer>
# max_unrated_site: <integer>
# restrict_as1_dbver: <string>
# restrict_as2_dbver: <string>
# restrict_as4_dbver: <string>
# restrict_av_dbver: <string>
# restrict_av2_dbver: <string>
# restrict_fq_dbver: <string>
# restrict_wf_dbver: <string>
# server_override:
# servlist:
# - id: <integer>
# ip: <string>
# ip6: <string>
# port: <integer>
# service_type: ["fgd", "fgc", "fsa", "fgfq", "geoip", "iot-collect"]
# status: <value in [disable, enable]>
# stat_log_interval: <integer>
# stat_sync_interval: <integer>
# update_interval: <integer>
# update_log: <value in [disable, enable]>
# wf_cache: <integer>
# wf_dn_cache_expire_time: <integer>
# wf_dn_cache_max_number: <integer>
# wf_log: <value in [disable, nourl, all]>
# wf_preload: <value in [disable, enable]>
# iot_cache: <integer>
# iot_log: <value in [disable, nofilequery, all, ...]>
# iot_preload: <value in [disable, enable]>
# restrict_iots_dbver: <string>
# stat_log: <value in [emergency, alert, critical, ...]>
# iotv_preload: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях |
Ссылки на коллекцию
© 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/fortimanager/fmgr_fmupdate_webspam_fgdsetting_module.html