community.fortios.fmgr_secprof_spam – spam filter profile for FMG

Note

This plugin is part of the community.fortios collection (version 1.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.fortios.

To use it in a playbook, specify: community.fortios.fmgr_secprof_spam.

Synopsis

  • Manage spam filter security profiles within FortiManager via API

Parameters

Parameter Choices/Defaults Comments
adom
string
Default:
"root"
The ADOM the configuration should belong to.
comment
string
Comment.
external
string
    Choices:
  • disable
  • enable
Enable/disable external Email inspection.
flow_based
string
    Choices:
  • disable
  • enable
Enable/disable flow-based spam filtering.
gmail
string
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED!
List of multiple child objects to be added. Expects a list of dictionaries.
Dictionaries must use FortiManager API parameters, not the ansible ones listed below.
If submitted, all other prefixed sub-parameters ARE IGNORED.
This object is MUTUALLY EXCLUSIVE with its options.
We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide.
WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS
gmail_log
string
    Choices:
  • disable
  • enable
Enable/disable logging.
imap
string
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED!
List of multiple child objects to be added. Expects a list of dictionaries.
Dictionaries must use FortiManager API parameters, not the ansible ones listed below.
If submitted, all other prefixed sub-parameters ARE IGNORED.
This object is MUTUALLY EXCLUSIVE with its options.
We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide.
WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS
imap_action
string
    Choices:
  • pass
  • tag
Action for spam email.
imap_log
string
    Choices:
  • disable
  • enable
Enable/disable logging.
imap_tag_msg
string
Subject text or header added to spam email.
imap_tag_type
string
    Choices:
  • subject
  • header
  • spaminfo
Tag subject or header for spam email.
FLAG Based Options. Specify multiple in list form.
mapi
string
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED!
List of multiple child objects to be added. Expects a list of dictionaries.
Dictionaries must use FortiManager API parameters, not the ansible ones listed below.
If submitted, all other prefixed sub-parameters ARE IGNORED.
This object is MUTUALLY EXCLUSIVE with its options.
We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide.
WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS
mapi_action
string
    Choices:
  • pass
  • discard
Action for spam email.
mapi_log
string
    Choices:
  • disable
  • enable
Enable/disable logging.
mode
string
    Choices:
  • add ←
  • set
  • delete
  • update
Sets one of three modes for managing the object.
Allows use of soft-adds instead of overwriting existing values
msn_hotmail
string
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED!
List of multiple child objects to be added. Expects a list of dictionaries.
Dictionaries must use FortiManager API parameters, not the ansible ones listed below.
If submitted, all other prefixed sub-parameters ARE IGNORED.
This object is MUTUALLY EXCLUSIVE with its options.
We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide.
WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS
msn_hotmail_log
string
    Choices:
  • disable
  • enable
Enable/disable logging.
name
string
Profile name.
options
string
    Choices:
  • bannedword
  • spamfsip
  • spamfssubmit
  • spamfschksum
  • spamfsurl
  • spamhelodns
  • spamraddrdns
  • spamrbl
  • spamhdrcheck
  • spamfsphish
  • spambwl
None
FLAG Based Options. Specify multiple in list form.
pop3
string
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED!
List of multiple child objects to be added. Expects a list of dictionaries.
Dictionaries must use FortiManager API parameters, not the ansible ones listed below.
If submitted, all other prefixed sub-parameters ARE IGNORED.
This object is MUTUALLY EXCLUSIVE with its options.
We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide.
WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS
pop3_action
string
    Choices:
  • pass
  • tag
Action for spam email.
pop3_log
string
    Choices:
  • disable
  • enable
Enable/disable logging.
pop3_tag_msg
string
Subject text or header added to spam email.
pop3_tag_type
string
    Choices:
  • subject
  • header
  • spaminfo
Tag subject or header for spam email.
FLAG Based Options. Specify multiple in list form.
replacemsg_group
string
Replacement message group.
smtp
string
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED!
List of multiple child objects to be added. Expects a list of dictionaries.
Dictionaries must use FortiManager API parameters, not the ansible ones listed below.
If submitted, all other prefixed sub-parameters ARE IGNORED.
This object is MUTUALLY EXCLUSIVE with its options.
We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide.
WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS
smtp_action
string
    Choices:
  • pass
  • tag
  • discard
Action for spam email.
smtp_hdrip
string
    Choices:
  • disable
  • enable
Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl filters.
smtp_local_override
string
    Choices:
  • disable
  • enable
Enable/disable local filter to override SMTP remote check result.
smtp_log
string
    Choices:
  • disable
  • enable
Enable/disable logging.
smtp_tag_msg
string
Subject text or header added to spam email.
smtp_tag_type
string
    Choices:
  • subject
  • header
  • spaminfo
Tag subject or header for spam email.
FLAG Based Options. Specify multiple in list form.
spam_bwl_table
string
Anti-spam black/white list table ID.
spam_bword_table
string
Anti-spam banned word table ID.
spam_bword_threshold
string
Spam banned word threshold.
spam_filtering
string
    Choices:
  • disable
  • enable
Enable/disable spam filtering.
spam_iptrust_table
string
Anti-spam IP trust table ID.
spam_log
string
    Choices:
  • disable
  • enable
Enable/disable spam logging for email filtering.
spam_log_fortiguard_response
string
    Choices:
  • disable
  • enable
Enable/disable logging FortiGuard spam response.
spam_mheader_table
string
Anti-spam MIME header table ID.
spam_rbl_table
string
Anti-spam DNSBL table ID.
yahoo_mail
string
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED!
List of multiple child objects to be added. Expects a list of dictionaries.
Dictionaries must use FortiManager API parameters, not the ansible ones listed below.
If submitted, all other prefixed sub-parameters ARE IGNORED.
This object is MUTUALLY EXCLUSIVE with its options.
We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide.
WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS
yahoo_mail_log
string
    Choices:
  • disable
  • enable
Enable/disable logging.

Notes

Note

Examples

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
api_result
string
always
full API response, includes status code and message


Authors

  • 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/latest/collections/community/fortios/fmgr_secprof_spam_module.html