fortios_emailfilter_profile – Configure Email Filter profiles in Fortinet’s FortiOS and FortiGate.
New in version 2.0.0.
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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.2.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- emailfilter_profile - Configure Email Filter profiles. type: dict more...
- comment - Comment. type: str more...
- external - Enable/disable external Email inspection. type: str choices: enable, disable more...
- feature_set - Flow/proxy feature set. type: str choices: flow, proxy more...
- file_filter - File filter. type: dict more...
- entries - File filter entries. type: list member_path: file_filter/entries:filter more...
- action - Action taken for matched file. type: str choices: log, block more...
- comment - Comment. type: str more...
- file_type - Select file type. type: list member_path: file_filter/entries:filter/file_type:name more...
- name - File type name. Source antivirus.filetype.name. type: str required: true more...
- filter - Add a file filter. type: str required: true more...
- password_protected - Match password-protected files. type: str choices: yes, any more...
- protocol - Protocols to apply with. type: list choices: smtp, imap, pop3 more...
- log - Enable/disable file filter logging. type: str choices: enable, disable more...
- scan_archive_contents - Enable/disable file filter archive contents scan. type: str choices: enable, disable more...
- status - Enable/disable file filter. type: str choices: enable, disable more...
- gmail - Gmail. type: dict more...
- log - Enable/disable logging. type: str choices: enable, disable more...
- log_all - Enable/disable logging of all email traffic. type: str choices: disable, enable more...
- imap - IMAP. type: dict more...
- action - Action for spam email. type: str choices: pass, tag more...
- log - Enable/disable logging. type: str choices: enable, disable more...
- log_all - Enable/disable logging of all email traffic. type: str choices: disable, enable more...
- tag_msg - Subject text or header added to spam email. type: str more...
- tag_type - Tag subject or header for spam email. type: list choices: subject, header, spaminfo more...
- mapi - MAPI. type: dict more...
- action - Action for spam email. type: str choices: pass, discard more...
- log - Enable/disable logging. type: str choices: enable, disable more...
- log_all - Enable/disable logging of all email traffic. type: str choices: disable, enable more...
- msn_hotmail - MSN Hotmail. type: dict more...
- log - Enable/disable logging. type: str choices: enable, disable more...
- log_all - Enable/disable logging of all email traffic. type: str choices: disable, enable more...
- name - Profile name. type: str required: true more...
- options - Options. type: list choices: bannedword, spambal, spamfsip, spamfssubmit, spamfschksum, spamfsurl, spamhelodns, spamraddrdns, spamrbl, spamhdrcheck, spamfsphish, spambwl more...
- other_webmails - Other supported webmails. type: dict more...
- log_all - Enable/disable logging of all email traffic. type: str choices: disable, enable more...
- pop3 - POP3. type: dict more...
- action - Action for spam email. type: str choices: pass, tag more...
- log - Enable/disable logging. type: str choices: enable, disable more...
- log_all - Enable/disable logging of all email traffic. type: str choices: disable, enable more...
- tag_msg - Subject text or header added to spam email. type: str more...
- tag_type - Tag subject or header for spam email. type: list choices: subject, header, spaminfo more...
- replacemsg_group - Replacement message group. Source system.replacemsg-group.name. type: str more...
- smtp - SMTP. type: dict more...
- action - Action for spam email. type: str choices: pass, tag, discard more...
- hdrip - Enable/disable SMTP email header IP checks for spamfsip, spamrbl, and spambal filters. type: str choices: disable, enable more...
- local_override - Enable/disable local filter to override SMTP remote check result. type: str choices: disable, enable more...
- log - Enable/disable logging. type: str choices: enable, disable more...
- log_all - Enable/disable logging of all email traffic. type: str choices: disable, enable more...
- tag_msg - Subject text or header added to spam email. type: str more...
- tag_type - Tag subject or header for spam email. type: list choices: subject, header, spaminfo more...
- spam_bal_table - Anti-spam block/allow list table ID. Source emailfilter.block-allow-list.id. type: int more...
- spam_bwl_table - Anti-spam black/white list table ID. Source emailfilter.bwl.id. type: int more...
- spam_bword_table - Anti-spam banned word table ID. Source emailfilter.bword.id. type: int more...
- spam_bword_threshold - Spam banned word threshold. type: int more...
- spam_filtering - Enable/disable spam filtering. type: str choices: enable, disable more...
- spam_iptrust_table - Anti-spam IP trust table ID. Source emailfilter.iptrust.id. type: int more...
- spam_log - Enable/disable spam logging for email filtering. type: str choices: disable, enable more...
- spam_log_fortiguard_response - Enable/disable logging FortiGuard spam response. type: str choices: disable, enable more...
- spam_mheader_table - Anti-spam MIME header table ID. Source emailfilter.mheader.id. type: int more...
- spam_rbl_table - Anti-spam DNSBL table ID. Source emailfilter.dnsbl.id. type: int more...
- yahoo_mail - Yahoo! Mail. type: dict more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure Email Filter profiles.
fortinet.fortios.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: "0"
spam_bwl_table: "2147483647"
spam_bword_table: "0"
spam_bword_threshold: "10"
spam_filtering: "enable"
spam_iptrust_table: "0"
spam_log: "disable"
spam_log_fortiguard_response: "disable"
spam_mheader_table: "0"
spam_rbl_table: "0"
yahoo_mail:
log: "enable"
log_all: "disable"
Return Values
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.