Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting – Настройка параметров запуска FortiGuard.

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting.

Введено в версии 2.10: модуля fortinet.fortimanager

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Этот модуль может настроить устройство FortiManager.
  • Примеры включают все параметры и значения, которые необходимо настроить из источников данных перед использованием.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
bypass_validation
boolean
    Варианты:
  • нет ←
  • да
устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
fmupdate_webspam_fgdsetting
словарь
параметры верхнего уровня
as-cache
целое число
Значение по умолчанию:
300
Максимальное использование памяти службой антиспама в мегабайтах (Максимум = физическая память - 1024, 0: без ограничения, по умолчанию = 300).
as-log
строка
    Варианты:
  • отключено
  • без спама ←
  • все
Настройка логирования антиспама (по умолчанию = без спама).
отключено - Отключить логирование спама.
без спама - Логировать события, не связанные со спамом.
все - Логировать все запросы по спаму.
as-preload
строка
    Варианты:
  • отключено ←
  • включено
Включить/отключить предварительную загрузку базы данных антиспама в память (по умолчанию = отключено).
отключено - Отключить предварительную загрузку базы данных антиспама.
включено - Включить предварительную загрузку базы данных антиспама.
av-cache
целое число
Значение по умолчанию:
300
Максимальное использование памяти службой антивируса в мегабайтах (100 - 500, по умолчанию = 300).
av-log
строка
    Варианты:
  • отключено
  • без вирусов ←
  • все
Настройка логирования антивируса (по умолчанию = без вирусов).
отключено - Отключить логирование вирусов.
без вирусов - Логировать события, не связанные с вирусами.
все - Логировать все запросы по вирусам.
av-preload
строка
    Варианты:
  • отключено ←
  • включено
Включить/отключить предварительную загрузку базы данных антивируса в память (по умолчанию = отключено).
отключено - Отключить предварительную загрузку базы данных антивируса.
включено - Включить предварительную загрузку базы данных антивируса.
av2-cache
целое число
Значение по умолчанию:
800
Максимальное использование памяти службой антиспама в мегабайтах (Максимум = физическая память - 1024, 0: без ограничения, по умолчанию = 800).
av2-log
строка
    Варианты:
  • отключено
  • без av2 ←
  • все
Настройка логирования предотвращения вспышек (по умолчанию = без av2).
отключено - Отключить логирование av2.
без av2 - Логировать события, не связанные с av2.
все - Логировать все запросы по av2.
av2-preload
строка
    Варианты:
  • отключено ←
  • включено
Включить/отключить предварительную загрузку базы данных предотвращения вспышек в память (по умолчанию = отключено).
отключено - Отключить предварительную загрузку базы данных предотвращения вспышек.
включено - Включить предварительную загрузку базы данных предотвращения вспышек.
eventlog-query
строка
    Варианты:
  • отключено ←
  • включено
Включить/отключить запрос записей в журнал событий помимо fgd-журнала (по умолчанию = отключено).
отключено - Запрос к журналу событий помимо fgd-журнала.
включено - Не регистрировать в журнале событий.
fgd-pull-interval
целое число
Значение по умолчанию:
10
Настройка интервала извлечения данных Fgd в минутах (1 - 1440, по умолчанию = 10).
fq-cache
целое число
Значение по умолчанию:
300
Максимальное использование памяти службой запросов файлов в мегабайтах (100 - 500, по умолчанию = 300).
fq-log
строка
    Варианты:
  • отключено
  • без запросов к файлам ←
  • все
Настройка логирования запросов файлов (по умолчанию = без запросов к файлам).
отключено - Отключить логирование запросов файлов.
без запросов к файлам - Логировать события, не связанные с запросами к файлам.
все - Логировать все события запросов к файлам.
fq-preload
строка
    Варианты:
  • отключено ←
  • включено
Включить/отключить предварительную загрузку базы данных запросов файлов в память (по умолчанию = отключено).
отключено - Отключить предварительную загрузку БД запросов файлов.
включено - Включить предварительную загрузку БД запросов файлов.
linkd-log
строка
    Варианты:
  • критический
  • сигнализация
  • критическое состояние
  • ошибка
  • предупреждение
  • замечание
  • информация
  • отладка ←
  • отключено
Настройка логирования Linkd (по умолчанию = отладка).
критический - Устройство непригодно для использования.
сигнализация - Требуются немедленные действия
критическое состояние - Функциональность затронута.
ошибка - Функциональность, вероятно, затронута.
предупреждение - Функциональность, возможно, затронута.
замечание - Информация о нормальных событиях.
информация - Общая информация.
отладка - Информация об отладке.
отключено - Логирование Linkd отключено.
max-client-worker
целое число
Значение по умолчанию:
0
максимальное количество потоков для подключения tcp-клиента (0~16: 0 означает использование количества ядер до 4).
max-log-quota
целое число
Значение по умолчанию:
6144
Максимальный лимит журнала в мегабайтах (100 - 20480, по умолчанию = 6144).
max-unrated-site
целое число
Значение по умолчанию:
500
Максимальное количество нерейтинговых сайтов в памяти в килобайтах (10 - 5120, по умолчанию = 500).
restrict-as1-dbver
строка
Ограничить обновление системы до указанной версии базы данных антиспама (1) (лимит символов = 127).
restrict-as2-dbver
строка
Ограничить обновление системы до указанной версии базы данных антиспама (2) (лимит символов = 127).
restrict-as4-dbver
строка
Ограничить обновление системы до указанной версии базы данных антиспама (4) (лимит символов = 127).
restrict-av-dbver
строка
Ограничить обновление системы до указанной версии базы данных антивируса (лимит символов = 127).
restrict-av2-dbver
строка
Ограничить обновление системы до указанной версии базы данных предотвращения вспышек (лимит символов = 127).
restrict-fq-dbver
строка
Ограничить обновление системы до указанной версии базы данных запросов файлов (лимит символов = 127).
restrict-wf-dbver
строка
Ограничить обновление системы до указанной версии базы данных веб-фильтра (лимит символов = 127).
server-override
словарь
нет описания
servlist
список / элементы=строка
нет описания
id
целое число
Значение по умолчанию:
0
Переопределить идентификатор сервера (1 - 10).
ip
строка
Значение по умолчанию:
"0.0.0.0"
IPv4-адрес сервера переопределения.
ip6
строка
Значение по умолчанию:
"::"
IPv6-адрес сервера переопределения.
port
целое число
Значение по умолчанию:
443
Порт для связи с FortiGuard (1 - 65535, по умолчанию = 443).
service-type
список / элементы=строка
    Варианты:
  • fgd
  • fgc
  • fsa
нет описания
status
строка
    Варианты:
  • отключено ←
  • включено
Переопределенный статус.
отключено - Отключить настройку.
включено - Включить настройку.
stat-log-interval
целое число
Значение по умолчанию:
60
Настройка интервала логирования статистики в минутах (1 - 1440, по умолчанию = 60).
stat-sync-interval
integer
Значение по умолчанию:
60
Интервал синхронизации статистики для сайта без рейтинга в минутах (1–60, по умолчанию 60).
update-interval
integer
Значение по умолчанию:
6
Время ожидания обновления базы данных FortiGuard в часах, если недостаточно файлов delta (2–24, по умолчанию 6).
update-log
string
    Варианты:
  • disable
  • enable ←
Включение/выключение ведения журнала обновлений (по умолчанию включено).
disable - Выключить журнал обновлений.
enable - Включить журнал обновлений.
wf-cache
integer
Значение по умолчанию:
0
Максимальное использование памяти службой веб-фильтра в мегабайтах (максимум = Объем физической памяти - 1024, 0 = без ограничений, по умолчанию 600).
wf-dn-cache-expire-time
integer
Значение по умолчанию:
30
Время истечения кэша DN веб-фильтра в минутах (1–1440, 0 = никогда, по умолчанию 30).
wf-dn-cache-max-number
integer
Значение по умолчанию:
10000
Максимальное количество кэша DN веб-фильтра (0 = выключить, по умолчанию 10000).
wf-log
string
    Варианты:
  • disable
  • nourl ←
  • all
Настройка ведения журнала веб-фильтра (по умолчанию nourl).
disable - Отключить журнал URL.
nourl - Записывать события, не относящиеся к URL.
all - Записывать все запросы URL.
wf-preload
string
    Варианты:
  • disable
  • enable ←
Включить/выключить предварительную загрузку базы данных веб-фильтра в память (по умолчанию выключено).
disable - Отключить предварительную загрузку базы данных веб-фильтра.
enable - Включить предварительную загрузку базы данных веб-фильтра.
rc_failed
list / elements=string
Список кодов rc, по которым условия будут считаться выполненными для отказа.
rc_succeeded
list / elements=string
Список кодов rc, по которым условия будут считаться выполненными для успеха.
state
string / required
    Варианты:
  • present
  • absent
Директива для создания, обновления или удаления объекта.
workspace_locking_adom
string
Область домена (adom) для блокировки при работе FortiManager в режиме рабочего пространства. Значение может быть глобальным или другим, включая корневой.
workspace_locking_timeout
integer
Значение по умолчанию:
300
Максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем.

Примечания

Примечание

  • Поддерживается режим блокировки рабочего пространства в этом модуле FortiManager. Параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение модуля может завершиться ошибкой, если возвращается ненулевой код rc. Также можно переопределить условия для отказа или успеха с помощью параметров rc_failed и rc_succeeded.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure the FortiGuard run parameters.
     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: <value of integer>
           as-log: <value in [disable, nospam, all]>
           as-preload: <value in [disable, enable]>
           av-cache: <value of integer>
           av-log: <value in [disable, novirus, all]>
           av-preload: <value in [disable, enable]>
           av2-cache: <value of integer>
           av2-log: <value in [disable, noav2, all]>
           av2-preload: <value in [disable, enable]>
           eventlog-query: <value in [disable, enable]>
           fgd-pull-interval: <value of integer>
           fq-cache: <value of integer>
           fq-log: <value in [disable, nofilequery, all]>
           fq-preload: <value in [disable, enable]>
           linkd-log: <value in [emergency, alert, critical, ...]>
           max-client-worker: <value of integer>
           max-log-quota: <value of integer>
           max-unrated-site: <value of integer>
           restrict-as1-dbver: <value of string>
           restrict-as2-dbver: <value of string>
           restrict-as4-dbver: <value of string>
           restrict-av-dbver: <value of string>
           restrict-av2-dbver: <value of string>
           restrict-fq-dbver: <value of string>
           restrict-wf-dbver: <value of string>
           server-override:
              servlist:
                -
                    id: <value of integer>
                    ip: <value of string>
                    ip6: <value of string>
                    port: <value of integer>
                    service-type:
                      - fgd
                      - fgc
                      - fsa
              status: <value in [disable, enable]>
           stat-log-interval: <value of integer>
           stat-sync-interval: <value of integer>
           update-interval: <value of integer>
           update-log: <value in [disable, enable]>
           wf-cache: <value of integer>
           wf-dn-cache-expire-time: <value of integer>
           wf-dn-cache-max-number: <value of integer>
           wf-log: <value in [disable, nourl, all]>
           wf-preload: <value in [disable, enable]>

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

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

Ключ Возвращаемое значение Описание
request_url
string
всегда
Полный запрашиваемый URL.

Пример:
/sys/login/user
response_code
integer
всегда
Статус запроса API.
response_message
string
всегда
Дескриптивное сообщение ответа API.

Пример:
OK.


Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_fmupdate_webspam_fgdsetting_module.html

Spec-Zone.ru

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