Spec-Zone.ru › Ansible 2.11

community.fortios.fmgr_secprof_spam – профиль фильтра спама для FMG

Примечание

Этот плагин входит в коллекцию community.fortios (версия 1.0.0).

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

Чтобы использовать его в плейбуке, укажите: community.fortios.fmgr_secprof_spam.

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

Обзор

  • Управление профилями безопасности фильтра спама в FortiManager через API

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adom
строка
Значение по умолчанию:
"root"
ADOM, к которому должна принадлежать конфигурация.
comment
строка
Комментарий.
external
строка
    Варианты:
  • disable
  • enable
Включить/выключить внешнюю проверку почты.
flow_based
строка
    Варианты:
  • disable
  • enable
Включить/выключить фильтрацию спама на основе потоков.
gmail
строка
ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! ТРЕБУЮТСЯ ЗНАНИЯ API JSON FMGR!
Список нескольких дочерних объектов для добавления. Ожидается список словарей.
Словари должны использовать параметры API FortiManager, а не ansible, указанные ниже.
При отправке все другие префиксные подпараметры ИГНОРИРУЮТСЯ.
Этот объект ВЗАИМНО ИСКЛЮЧАЮЩИЙ со своими опциями.
Ожидается, что вы знаете, что делаете с этими параметрами списков, и используете руководство по API JSON.
В СЛУЧАЕ СОМНЕНИЙ, ИСПОЛЬЗУЙТЕ НИЖЕУКАЗАННЫЕ ПОДВАРИАНТЫ, ЧТОБЫ СОЗДАВАТЬ ОБЪЕКТЫ С НЕСКОЛЬКИМИ ЗАДАЧАМИ
gmail_log
строка
    Варианты:
  • disable
  • enable
Включить/выключить ведение журнала.
imap
строка
ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! ТРЕБУЮТСЯ ЗНАНИЯ API JSON FMGR!
Список нескольких дочерних объектов для добавления. Ожидается список словарей.
Словари должны использовать параметры API FortiManager, а не ansible, указанные ниже.
При отправке все другие префиксные подпараметры ИГНОРИРУЮТСЯ.
Этот объект ВЗАИМНО ИСКЛЮЧАЮЩИЙ со своими опциями.
Ожидается, что вы знаете, что делаете с этими параметрами списков, и используете руководство по API JSON.
В СЛУЧАЕ СОМНЕНИЙ, ИСПОЛЬЗУЙТЕ НИЖЕУКАЗАННЫЕ ПОДВАРИАНТЫ, ЧТОБЫ СОЗДАВАТЬ ОБЪЕКТЫ С НЕСКОЛЬКИМИ ЗАДАЧАМИ
imap_action
строка
    Варианты:
  • pass
  • tag
Действие для спам-письма.
imap_log
строка
    Варианты:
  • disable
  • enable
Включить/выключить ведение журнала.
imap_tag_msg
строка
Текст темы или заголовка, добавляемый к спам-письму.
imap_tag_type
строка
    Варианты:
  • subject
  • header
  • spaminfo
Разметка темы или заголовка для спам-письма.
Параметры на основе флагов. Укажите несколько значений в виде списка.
mapi
строка
ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! ТРЕБУЮТСЯ ЗНАНИЯ API JSON FMGR!
Список нескольких дочерних объектов для добавления. Ожидается список словарей.
Словари должны использовать параметры API FortiManager, а не ansible, указанные ниже.
При отправке все другие префиксные подпараметры ИГНОРИРУЮТСЯ.
Этот объект ВЗАИМНО ИСКЛЮЧАЮЩИЙ со своими опциями.
Ожидается, что вы знаете, что делаете с этими параметрами списков, и используете руководство по API JSON.
В СЛУЧАЕ СОМНЕНИЙ, ИСПОЛЬЗУЙТЕ НИЖЕУКАЗАННЫЕ ПОДВАРИАНТЫ, ЧТОБЫ СОЗДАВАТЬ ОБЪЕКТЫ С НЕСКОЛЬКИМИ ЗАДАЧАМИ
mapi_action
строка
    Варианты:
  • pass
  • discard
Действие для спам-письма.
mapi_log
строка
    Варианты:
  • disable
  • enable
Включить/выключить ведение журнала.
mode
строка
    Варианты:
  • add ←
  • set
  • delete
  • update
Устанавливает один из трёх режимов управления объектом.
Позволяет использовать мягкое добавление вместо перезаписи существующих значений
msn_hotmail
строка
ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! ТРЕБУЮТСЯ ЗНАНИЯ API JSON FMGR!
Список нескольких дочерних объектов для добавления. Ожидается список словарей.
Словари должны использовать параметры API FortiManager, а не ansible, указанные ниже.
При отправке все другие префиксные подпараметры ИГНОРИРУЮТСЯ.
Этот объект ВЗАИМНО ИСКЛЮЧАЮЩИЙ со своими опциями.
Ожидается, что вы знаете, что делаете с этими параметрами списков, и используете руководство по API JSON.
В СЛУЧАЕ СОМНЕНИЙ, ИСПОЛЬЗУЙТЕ НИЖЕУКАЗАННЫЕ ПОДВАРИАНТЫ, ЧТОБЫ СОЗДАВАТЬ ОБЪЕКТЫ С НЕСКОЛЬКИМИ ЗАДАЧАМИ
msn_hotmail_log
строка
    Варианты:
  • disable
  • enable
Включить/выключить ведение журнала.
name
строка
Имя профиля.
options
строка
    Варианты:
  • bannedword
  • spamfsip
  • spamfssubmit
  • spamfschksum
  • spamfsurl
  • spamhelodns
  • spamraddrdns
  • spamrbl
  • spamhdrcheck
  • spamfsphish
  • spambwl
Нет
Параметры на основе флагов. Укажите несколько значений в виде списка.
pop3
строка
ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! ТРЕБУЮТСЯ ЗНАНИЯ API JSON FMGR!
Список нескольких дочерних объектов для добавления. Ожидается список словарей.
Словари должны использовать параметры API FortiManager, а не ansible, указанные ниже.
При отправке все другие префиксные подпараметры ИГНОРИРУЮТСЯ.
Этот объект ВЗАИМНО ИСКЛЮЧАЮЩИЙ со своими опциями.
Ожидается, что вы знаете, что делаете с этими параметрами списков, и используете руководство по API JSON.
В СЛУЧАЕ СОМНЕНИЙ, ИСПОЛЬЗУЙТЕ НИЖЕУКАЗАННЫЕ ПОДВАРИАНТЫ, ЧТОБЫ СОЗДАВАТЬ ОБЪЕКТЫ С НЕСКОЛЬКИМИ ЗАДАЧАМИ
pop3_action
строка
    Варианты:
  • pass
  • tag
Действие для спам-письма.
pop3_log
строка
    Варианты:
  • disable
  • enable
Включить/выключить ведение журнала.
pop3_tag_msg
строка
Текст темы или заголовка, добавляемый к спам-письму.
pop3_tag_type
строка
    Варианты:
  • subject
  • header
  • spaminfo
Разметка темы или заголовка для спам-письма.
Параметры на основе флагов. Укажите несколько значений в виде списка.
replacemsg_group
строка
Группа заменяющих сообщений.
smtp
строка
ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! ТРЕБУЮТСЯ ЗНАНИЯ API JSON FMGR!
Список нескольких дочерних объектов для добавления. Ожидается список словарей.
Словари должны использовать параметры API FortiManager, а не ansible, указанные ниже.
При отправке все другие префиксные подпараметры ИГНОРИРУЮТСЯ.
Этот объект ВЗАИМНО ИСКЛЮЧАЮЩИЙ со своими опциями.
Ожидается, что вы знаете, что делаете с этими параметрами списков, и используете руководство по API JSON.
В СЛУЧАЕ СОМНЕНИЙ, ИСПОЛЬЗУЙТЕ НИЖЕУКАЗАННЫЕ ПОДВАРИАНТЫ, ЧТОБЫ СОЗДАВАТЬ ОБЪЕКТЫ С НЕСКОЛЬКИМИ ЗАДАЧАМИ
smtp_action
строка
    Варианты:
  • pass
  • tag
  • discard
Действие для спам-письма.
smtp_hdrip
строка
    Варианты:
  • disable
  • enable
Включить/выключить проверку IP-адреса заголовка электронной почты SMTP для фильтров spamfsip, spamrbl и spambwl.
smtp_local_override
строка
    Варианты:
  • disable
  • enable
Включить/выключить локальный фильтр для переопределения результата проверки SMTP удаленного сервера.
smtp_log
строка
    Варианты:
  • disable
  • enable
Включить/выключить ведение журнала.
smtp_tag_msg
строка
Текст темы или заголовка, добавляемый к спам-письму.
smtp_tag_type
строка
    Варианты:
  • subject
  • header
  • spaminfo
Разметка темы или заголовка для спам-письма.
Параметры на основе флагов. Укажите несколько значений в виде списка.
spam_bwl_table
строка
Идентификатор таблицы черного/белого списка антиспама.
spam_bword_table
строка
Идентификатор таблицы запрещённых слов антиспама.
spam_bword_threshold
строка
Пороговое значение для запрещённых слов спама.
spam_filtering
строка
    Варианты:
  • disable
  • enable
Включить/выключить фильтрацию спама.
spam_iptrust_table
строка
Идентификатор таблицы доверия IP-адресов антиспама.
spam_log
строка
    Варианты:
  • disable
  • enable
Включить/выключить ведение журнала спама для фильтрации электронной почты.
spam_log_fortiguard_response
строка
    Варианты:
  • disable
  • enable
Включить/выключить ведение журнала ответа FortiGuard на спам.
spam_mheader_table
строка
Идентификатор таблицы MIME-заголовков антиспама.
spam_rbl_table
строка
Идентификатор таблицы DNSBL антиспама.
yahoo_mail
string
ТОЛЬКО ДЛЯ ЭКСПЕРТОВ! НЕОБХОДИМО ЗНАНИЕ API JSON FMGR!
Список нескольких дочерних объектов для добавления. Ожидается список словарей.
Словари должны использовать параметры API FortiManager, а не параметры ansible, перечисленные ниже.
Если предоставлено, все остальные префиксные подпараметры ИГНОРИРУЮТСЯ.
Этот объект ВЗАИМНО ИСКЛЮЧАЕТ свои параметры.
Ожидается, что вы знаете, что делаете с этими параметрами списка, и используете руководство по API JSON.
В СЛУЧАЕ СОМНЕНИЙ, ИСПОЛЬЗУЙТЕ НИЖЕУКАЗАННЫЕ ПОДПАРАМЕТРЫ, ЧТОБЫ СОЗДАВАТЬ ОБЪЕКТЫ С НЕСКОЛЬКИМИ ЗАДАЧАМИ
yahoo_mail_log
string
    Варианты:
  • disable
  • enable
Включить/выключить ведение журнала.

Примечания

Примечание

  • Полная документация по адресу https://ftnt-ansible-docs.readthedocs.io/en/latest/.

Примеры

- name: DELETE Profile
  community.fortios.fmgr_secprof_spam:
    name: "Ansible_Spam_Filter_Profile"
    mode: "delete"

- name: Create FMGR_SPAMFILTER_PROFILE
  community.fortios.fmgr_secprof_spam:
    host: "{{ inventory_hostname }}"
    username: "{{ username }}"
    password: "{{ password }}"
    mode: "set"
    adom: "root"
    spam_log_fortiguard_response: "enable"
    spam_iptrust_table:
    spam_filtering: "enable"
    spam_bword_threshold: 10
    options: ["bannedword", "spamfsip", "spamfsurl", "spamrbl", "spamfsphish", "spambwl"]
    name: "Ansible_Spam_Filter_Profile"
    flow_based: "enable"
    external: "enable"
    comment: "Created by Ansible"
    gmail_log: "enable"
    spam_log: "enable"

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

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

Ключ Возвращаемое значение Описание
api_result
string
всегда
полный ответ API, включает код состояния и сообщение


Авторы

  • Luke Weighall (@lweighall)
  • Andrew Welsh (@Ghilli3)
  • Jim Huber (@p4r4n0y1ng)

© 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/community/fortios/fmgr_secprof_spam_module.html

Spec-Zone.ru

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