fortinet.fortios.fortios_emailfilter_profile – Configure Email Filter profiles in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.10: 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 | Choices/Defaults | 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. | ||||
feature_set string |
| Flow/proxy feature set. | ||||
file_filter dictionary | File filter. | |||||
entries list / elements=string | File filter entries. | |||||
action string |
| Action taken for matched file. | ||||
comment string | Comment. | |||||
file_type list / elements=string | 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. | ||||
protocol string |
| Protocols to apply with. | ||||
log string |
| Enable/disable file filter logging. | ||||
scan_archive_contents string |
| Enable/disable file filter archive contents scan. | ||||
status string |
| Enable/disable file filter. | ||||
gmail dictionary | Gmail. | |||||
log string |
| Enable/disable logging. | ||||
log_all string |
| Enable/disable logging of all email traffic. | ||||
imap dictionary | IMAP. | |||||
action string |
| Action for spam email. | ||||
log string |
| Enable/disable logging. | ||||
log_all string |
| Enable/disable logging of all email traffic. | ||||
tag_msg string | Subject text or header added to spam email. | |||||
tag_type list / elements=string |
| Tag subject or header for spam email. | ||||
mapi dictionary | MAPI. | |||||
action string |
| Action for spam email. | ||||
log string |
| Enable/disable logging. | ||||
log_all string |
| Enable/disable logging of all email traffic. | ||||
msn_hotmail dictionary | MSN Hotmail. | |||||
log string |
| Enable/disable logging. | ||||
log_all string |
| Enable/disable logging of all email traffic. | ||||
name string / required | Profile name. | |||||
options list / elements=string |
| Options. | ||||
other_webmails dictionary | Other supported webmails. | |||||
log_all string |
| Enable/disable logging of all email traffic. | ||||
pop3 dictionary | POP3. | |||||
action string |
| Action for spam email. | ||||
log string |
| Enable/disable logging. | ||||
log_all string |
| Enable/disable logging of all email traffic. | ||||
tag_msg string | Subject text or header added to spam email. | |||||
tag_type list / elements=string |
| Tag subject or header for spam email. | ||||
replacemsg_group string | Replacement message group. Source system.replacemsg-group.name. | |||||
smtp dictionary | SMTP. | |||||
action string |
| Action for spam email. | ||||
hdrip string |
| Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl filters. | ||||
local_override string |
| Enable/disable local filter to override SMTP remote check result. | ||||
log string |
| Enable/disable logging. | ||||
log_all string |
| Enable/disable logging of all email traffic. | ||||
tag_msg string | Subject text or header added to spam email. | |||||
tag_type list / elements=string |
| Tag subject or header for spam email. | ||||
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. | ||||
spam_iptrust_table integer | Anti-spam IP trust table ID. Source emailfilter.iptrust.id. | |||||
spam_log string |
| Enable/disable spam logging for email filtering. | ||||
spam_log_fortiguard_response string |
| Enable/disable logging FortiGuard spam response. | ||||
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. | ||||
log_all string |
| Enable/disable logging of all email traffic. | ||||
enable_log boolean |
| Enable/Disable logging for task. | ||||
state string / required |
| Indicates whether to create or remove the object. | ||||
vdom string | Default: "root" | 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. |
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 | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate 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)
© 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/fortinet/fortios/fortios_emailfilter_profile_module.html