Модуль fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting – Настройка параметров запуска FortiGuard.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 integer |
Устарело, переименуйте в as_cache. Максимальное использование памяти службой антиспама в мегабайтах |
|
as-log string |
Устарело, переименуйте в as_log. Настройка журнала антиспама disable - Отключить журнал спама. nospam - Записывать события, не относящиеся к спаму. all - Записывать все запросы спама. Варианты:
|
|
as-preload string |
Устарело, переименуйте в as_preload. Включить/отключить предварительную загрузку базы данных антиспама в память disable - Отключить предварительную загрузку базы данных антиспама. enable - Включить предварительную загрузку базы данных антиспама. Варианты:
|
|
av-cache integer |
Устарело, переименуйте в av_cache. Максимальное использование памяти службой антивируса в мегабайтах |
|
av-log string |
Устарело, переименуйте в av_log. Настройка журнала антивируса disable - Отключить журнал вирусов. novirus - Записывать события, не относящиеся к вирусам. all - Записывать все проверки вирусов. Варианты:
|
|
av-preload string |
Устарело, переименуйте в av_preload. Включить/отключить предварительную загрузку базы данных антивируса в память disable - Отключить предварительную загрузку базы данных антивируса. enable - Включить предварительную загрузку базы данных антивируса. Варианты:
|
|
av2-cache integer |
Устарело, переименуйте в av2_cache. Максимальное использование памяти службой антиспама в мегабайтах |
|
av2-log string |
Устарело, переименуйте в av2_log. Настройка журнала предотвращения вспышек disable - Отключить журнал av2. noav2 - Записывать события, не относящиеся к av2. all - Записывать все запросы av2. Варианты:
|
|
av2-preload string |
Устарело, переименуйте в av2_preload. Включить/отключить предварительную загрузку базы данных предотвращения вспышек в память disable - Отключить предварительную загрузку базы данных предотвращения вспышек. enable - Включить предварительную загрузку базы данных предотвращения вспышек. Варианты:
|
|
eventlog-query string |
Устарело, переименуйте в eventlog_query. Включить/отключить запрос записей в журнал событий помимо fgd-log disable - Запрос записей в журнал событий помимо fgd-log. enable - Не записывать в журнал событий. Варианты:
|
|
fgd-pull-interval integer |
Устарело, переименуйте в fgd_pull_interval. Настройка интервала извлечения Fgd в минутах |
|
fq-cache integer |
Устарело, переименуйте в fq_cache. Максимальное использование памяти службой файлового запроса в мегабайтах |
|
fq-log string |
Устарело, переименуйте в fq_log. Настройка журнала файловых запросов disable - Отключить журнал файловых запросов. nofilequery - Записывать события, не относящиеся к файловым запросам. all - Записывать все события файловых запросов. Варианты:
|
|
fq-preload string |
Устарело, переименуйте в fq_preload. Включить/отключить предварительную загрузку базы данных запросов файлов в память disable - Отключить предварительную загрузку базы данных запросов файлов. enable - Включить предварительную загрузку базы данных запросов файлов. Choices:
|
|
iot-cache integer |
Устарело, переименуйте в iot_cache. Максимальное использование памяти службой IoT, в мегабайтах |
|
iot-log string |
Устарело, переименуйте в iot_log. Настройка журнала IoT disable - Отключить журнал IoT. nofilequery - Записывать события, не относящиеся к IoT. all - Записывать все события IoT. Choices:
|
|
iot-preload string |
Устарело, переименуйте в iot_preload. Включить/отключить предварительную загрузку базы данных IoT в память disable - Отключить предварительную загрузку базы данных IoT. enable - Включить предварительную загрузку базы данных IoT. Choices:
|
|
iotv-preload string |
Устарело, переименуйте в iotv_preload. Включить/отключить предварительную загрузку базы данных уязвимостей IoT в память disable - Отключить предварительную загрузку базы данных уязвимостей IoT. enable - Включить предварительную загрузку базы данных уязвимостей IoT. Choices:
|
|
linkd-log string |
Устарело, переименуйте в linkd_log. Настройка журнала Linkd emergency - Устройство непригодно для использования. alert - Требуются немедленные действия critical - Функциональность нарушена. error - Функциональность, вероятно, нарушена. warn - Функциональность может быть нарушена. notice - Информация о нормальных событиях. info - Общая информация. debug - Отладочная информация. disable - Журналирование Linkd отключено. Choices:
|
|
max-client-worker integer |
Устарело, переименуйте в max_client_worker. Максимальное число рабочих процессов для TCP-соединений клиента |
|
max-log-quota integer |
Устарело, переименуйте в max_log_quota. Максимальный квота журнала, в мегабайтах |
|
max-unrated-site integer |
Устарело, переименуйте в max_unrated_site. Максимальное количество нерейтинговых сайтов в памяти, в килобайтах |
|
restrict-as1-dbver string |
Устарело, переименуйте в restrict_as1_dbver. Ограничить обновление системы указанной версией антиспама |
|
restrict-as2-dbver string |
Устарело, переименуйте в restrict_as2_dbver. Ограничить обновление системы указанной версией антиспама |
|
restrict-as4-dbver string |
Устарело, переименуйте в restrict_as4_dbver. Ограничить обновление системы указанной версией антиспама |
|
restrict-av-dbver string |
Устарело, переименуйте в restrict_av_dbver. Ограничить обновление системы указанной версией базы данных антивируса |
|
restrict-av2-dbver string |
Устарело, переименуйте в restrict_av2_dbver. Ограничить обновление системы указанной версией базы данных предотвращения вспышек |
|
restrict-fq-dbver string |
Устарело, переименуйте в restrict_fq_dbver. Ограничить обновление системы указанной версией базы данных запросов файлов |
|
restrict-iots-dbver string |
Устарело, переименуйте в restrict_iots_dbver. Ограничить обновление системы указанной версией базы данных запросов файлов |
|
restrict-wf-dbver string |
Устарело, переименуйте в restrict_wf_dbver. Ограничить обновление системы указанной версией базы данных веб-фильтра |
|
server-override dictionary |
Устарело, переименуйте в server_override. Переопределение сервера. |
|
servlist список / элементы=словарь |
Список серверов. |
|
id целое число |
Идентификатор сервера для переопределения. |
|
ip строка |
IP-адрес IPv4 сервера для переопределения. |
|
ip6 строка |
IP-адрес IPv6 сервера для переопределения. |
|
port целое число |
Номер порта для связи с FortiGuard. |
|
service-type любой |
(список или строка) Устаревшее, переименуйте на service_type. Тип службы для переопределения. fgd - Настройка конфигурации сервера для fgd fgc - Настройка конфигурации сервера для fgc fsa - Настройка конфигурации сервера для fsa Варианты:
|
|
status строка |
Статус переопределения. disable - Отключить настройку. enable - Включить настройку. Варианты:
|
|
stat-log строка |
Устаревшее, переименуйте на stat_log. Настройка журнала статистики emergency - Устройство непригодно для использования alert - Требуются немедленные действия critical - Функциональность затронута error - Функциональность, вероятно, затронута warn - Функциональность может быть затронута notice - Информация о нормальных событиях info - Общая информация debug - Отладочная информация disable - Веб-журнал отключен. Варианты:
|
|
stat-log-interval целое число |
Устаревшее, переименуйте на stat_log_interval. Интервал журнала статистики в минутах. |
|
stat-sync-interval целое число |
Устаревшее, переименуйте на stat_sync_interval. Интервал синхронизации статистики нерейтинговых сайтов в минутах. |
|
update-interval целое число |
Устаревшее, переименуйте на update_interval. Время ожидания обновления базы данных FortiGuard в часах, если недостаточно файлов delta. |
|
update-log строка |
Устаревшее, переименуйте на update_log. Включение/отключение записи журнала обновлений disable - Отключить журнал обновлений. enable - Включить журнал обновлений. Варианты:
|
|
wf-cache целое число |
Устаревшее, переименуйте на wf_cache. Максимальное использование памяти службой веб-фильтра в мегабайтах. |
|
wf-dn-cache-expire-time целое число |
Устаревшее, переименуйте на wf_dn_cache_expire_time. Время истечения кэша DN веб-фильтра в минутах. |
|
wf-dn-cache-max-number целое число |
Устаревшее, переименуйте на wf_dn_cache_max_number. Максимальное количество кэша DN веб-фильтра. |
|
wf-log строка |
Устаревшее, переименуйте на wf_log. Настройка журнала веб-фильтра disable - Отключить журнал URL. nourl - Записывать события, не связанные с URL. all - Записывать все запросы к URL. Варианты:
|
|
wf-preload строка |
Устаревшее, переименуйте на wf_preload. Включение/выключение предварительной загрузки базы данных веб-фильтра в память disable - Отключить предварительную загрузку базы данных веб-фильтра. enable - Включить предварительную загрузку базы данных веб-фильтра. Варианты:
|
forticloud_access_token строка | Авторизация клиента Ansible с помощью маркера доступа к API forticloud. |
proposed_method string | Переопределённый метод для базового запроса Json RPC. Варианты:
|
rc_failed список / элементы=целое число | Список кодов rc, при которых условия будут переопределены для отказа. |
rc_succeeded список / элементы=целое число | Список кодов rc, при которых условия будут переопределены для успеха. |
workspace_locking_adom строка | ADOM для блокировки FortiManager в режиме рабочего пространства; значение может быть глобальным и другими, включая корневой. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure the FortiGuard run parameters.
fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
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: # <list or string>
- 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 словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный запрашиваемый URL. Возвращается: всегда Пример: |
|
response_code целое число |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Описание результата ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в плейбуке, не поддерживаются текущей версией FortiManager. Возвращается: сложно |
Ссылки на коллекцию
© 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/fortimanager/fmgr_fmupdate_webspam_fgdsetting_module.html