You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortios.fortios_emailfilter_profile module – Configure Email Filter profiles in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.1.6).

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 fortinet.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_emailfilter_profile.

New in version 2.0.0: of fortinet.fortios

Synopsis

• This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify emailfilter feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

• ansible>=2.9.0

Parameters

Parameter	Comments
access_token string	Token-based authentication. Generated from GUI of Fortigate.
emailfilter_profile dictionary	Configure Email Filter profiles.
comment string	Comment.
external string	Enable/disable external Email inspection. Choices: enable disable
feature_set string	Flow/proxy feature set. Choices: flow proxy
file_filter dictionary	File filter.
entries list / elements=dictionary	File filter entries.
action string	Action taken for matched file. Choices: log block
comment string	Comment.
file_type list / elements=dictionary	Select file type.
name string / required	File type name. Source antivirus.filetype.name.
filter string / required	Add a file filter.
password_protected string	Match password-protected files. Choices: True any
protocol string	Protocols to apply with. Choices: smtp imap pop3
log string	Enable/disable file filter logging. Choices: enable disable
scan_archive_contents string	Enable/disable file filter archive contents scan. Choices: enable disable
status string	Enable/disable file filter. Choices: enable disable
gmail dictionary	Gmail.
log string	Enable/disable logging. Choices: enable disable
log_all string	Enable/disable logging of all email traffic. Choices: disable enable
imap dictionary	IMAP.
action string	Action for spam email. Choices: pass tag
log string	Enable/disable logging. Choices: enable disable
log_all string	Enable/disable logging of all email traffic. Choices: disable enable
tag_msg string	Subject text or header added to spam email.
tag_type list / elements=string	Tag subject or header for spam email. Choices: subject header spaminfo
mapi dictionary	MAPI.
action string	Action for spam email. Choices: pass discard
log string	Enable/disable logging. Choices: enable disable
log_all string	Enable/disable logging of all email traffic. Choices: disable enable
msn_hotmail dictionary	MSN Hotmail.
log string	Enable/disable logging. Choices: enable disable
log_all string	Enable/disable logging of all email traffic. Choices: disable enable
name string / required	Profile name.
options list / elements=string	Options. Choices: bannedword spambal spamfsip spamfssubmit spamfschksum spamfsurl spamhelodns spamraddrdns spamrbl spamhdrcheck spamfsphish spambwl
other_webmails dictionary	Other supported webmails.
log_all string	Enable/disable logging of all email traffic. Choices: disable enable
pop3 dictionary	POP3.
action string	Action for spam email. Choices: pass tag
log string	Enable/disable logging. Choices: enable disable
log_all string	Enable/disable logging of all email traffic. Choices: disable enable
tag_msg string	Subject text or header added to spam email.
tag_type list / elements=string	Tag subject or header for spam email. Choices: subject header spaminfo
replacemsg_group string	Replacement message group. Source system.replacemsg-group.name.
smtp dictionary	SMTP.
action string	Action for spam email. Choices: pass tag discard
hdrip string	Enable/disable SMTP email header IP checks for spamfsip, spamrbl, and spambal filters. Choices: disable enable
local_override string	Enable/disable local filter to override SMTP remote check result. Choices: disable enable
log string	Enable/disable logging. Choices: enable disable
log_all string	Enable/disable logging of all email traffic. Choices: disable enable
tag_msg string	Subject text or header added to spam email.
tag_type list / elements=string	Tag subject or header for spam email. Choices: subject header spaminfo
spam_bal_table integer	Anti-spam block/allow list table ID. Source emailfilter.block-allow-list.id.
spam_bwl_table integer	Anti-spam black/white list table ID. Source emailfilter.bwl.id.
spam_bword_table integer	Anti-spam banned word table ID. Source emailfilter.bword.id.
spam_bword_threshold integer	Spam banned word threshold.
spam_filtering string	Enable/disable spam filtering. Choices: enable disable
spam_iptrust_table integer	Anti-spam IP trust table ID. Source emailfilter.iptrust.id.
spam_log string	Enable/disable spam logging for email filtering. Choices: disable enable
spam_log_fortiguard_response string	Enable/disable logging FortiGuard spam response. Choices: disable enable
spam_mheader_table integer	Anti-spam MIME header table ID. Source emailfilter.mheader.id.
spam_rbl_table integer	Anti-spam DNSBL table ID. Source emailfilter.dnsbl.id.
yahoo_mail dictionary	Yahoo! Mail.
log string	Enable/disable logging. Choices: enable disable
log_all string	Enable/disable logging of all email traffic. Choices: disable enable
enable_log boolean	Enable/Disable logging for task. Choices: no ← (default) yes
member_path string	Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation.
member_state string	Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices: present absent
state string / required	Indicates whether to create or remove the object. Choices: present absent
vdom string	Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. Default: “root”

Notes

Note

• Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure Email Filter profiles.
    fortios_emailfilter_profile:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      emailfilter_profile:
        comment: "Comment."
        external: "enable"
        feature_set: "flow"
        file_filter:
            entries:
             -
                action: "log"
                comment: "Comment."
                file_type:
                 -
                    name: "default_name_11 (source antivirus.filetype.name)"
                filter: "<your_own_value>"
                password_protected: "yes"
                protocol: "smtp"
            log: "enable"
            scan_archive_contents: "enable"
            status: "enable"
        gmail:
            log: "enable"
            log_all: "disable"
        imap:
            action: "pass"
            log: "enable"
            log_all: "disable"
            tag_msg: "<your_own_value>"
            tag_type: "subject"
        mapi:
            action: "pass"
            log: "enable"
            log_all: "disable"
        msn_hotmail:
            log: "enable"
            log_all: "disable"
        name: "default_name_34"
        options: "bannedword"
        other_webmails:
            log_all: "disable"
        pop3:
            action: "pass"
            log: "enable"
            log_all: "disable"
            tag_msg: "<your_own_value>"
            tag_type: "subject"
        replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
        smtp:
            action: "pass"
            hdrip: "disable"
            local_override: "disable"
            log: "enable"
            log_all: "disable"
            tag_msg: "<your_own_value>"
            tag_type: "subject"
        spam_bal_table: "53 (source emailfilter.block-allow-list.id)"
        spam_bwl_table: "54 (source emailfilter.bwl.id)"
        spam_bword_table: "55 (source emailfilter.bword.id)"
        spam_bword_threshold: "56"
        spam_filtering: "enable"
        spam_iptrust_table: "58 (source emailfilter.iptrust.id)"
        spam_log: "disable"
        spam_log_fortiguard_response: "disable"
        spam_mheader_table: "61 (source emailfilter.mheader.id)"
        spam_rbl_table: "62 (source emailfilter.dnsbl.id)"
        yahoo_mail:
            log: "enable"
            log_all: "disable"

Return Values

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

Key	Description
build string	Build number of the fortigate image Returned: always Sample: “1547”
http_method string	Last method used to provision the content into FortiGate Returned: always Sample: “PUT”
http_status string	Last result given by FortiGate on last operation applied Returned: always Sample: “200”
mkey string	Master key (id) used in the last call to FortiGate Returned: success Sample: “id”
name string	Name of the table used to fulfill the request Returned: always Sample: “urlfilter”
path string	Path of the table used to fulfill the request Returned: always Sample: “webfilter”
revision string	Internal revision number Returned: always Sample: “17.0.2.10658”
serial string	Serial number of the unit Returned: always Sample: “FGVMEVYYQT3AB5352”
status string	Indication of the operation’s result Returned: always Sample: “success”
vdom string	Virtual domain used Returned: always Sample: “root”
version string	Version of the FortiGate Returned: always Sample: “v5.6.3”

Authors

• Link Zheng (@chillancezen)

• Jie Xue (@JieX19)

• Hongbin Lu (@fgtdev-hblu)

• Frank Shen (@frankshen01)

• Miguel Angel Munoz (@mamunozgonzalez)

• Nicolas Thomas (@thomnico)

Collection links

Issue Tracker Homepage Repository (Sources)