fortinet.fortios.fortios_spamfilter_profile module – Configure AntiSpam profiles in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_spamfilter_profile.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter 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
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Configure AntiSpam profiles. |
|
Comment. |
|
Enable/disable external Email inspection. Choices:
|
|
Enable/disable flow-based spam filtering. Choices:
|
|
Gmail. |
|
Enable/disable logging. Choices:
|
|
IMAP. |
|
Action for spam email. Choices:
|
|
Enable/disable logging. Choices:
|
|
Subject text or header added to spam email. |
|
Tag subject or header for spam email. Choices:
|
|
MAPI. |
|
Action for spam email. Choices:
|
|
Enable/disable logging. Choices:
|
|
MSN Hotmail. |
|
Enable/disable logging. Choices:
|
|
Profile name. |
|
Options. Choices:
|
|
POP3. |
|
Action for spam email. Choices:
|
|
Enable/disable logging. Choices:
|
|
Subject text or header added to spam email. |
|
Tag subject or header for spam email. Choices:
|
|
Replacement message group. Source system.replacemsg-group.name. |
|
SMTP. |
|
Action for spam email. Choices:
|
|
Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl filters. Choices:
|
|
Enable/disable local filter to override SMTP remote check result. Choices:
|
|
Enable/disable logging. Choices:
|
|
Subject text or header added to spam email. |
|
Tag subject or header for spam email. Choices:
|
|
Anti-spam black/white list table ID. Source spamfilter.bwl.id. |
|
Anti-spam banned word table ID. Source spamfilter.bword.id. |
|
Spam banned word threshold. |
|
Enable/disable spam filtering. Choices:
|
|
Anti-spam IP trust table ID. Source spamfilter.iptrust.id. |
|
Enable/disable spam logging for email filtering. Choices:
|
|
Enable/disable logging FortiGuard spam response. Choices:
|
|
Anti-spam MIME header table ID. Source spamfilter.mheader.id. |
|
Anti-spam DNSBL table ID. Source spamfilter.dnsbl.id. |
|
Yahoo! Mail. |
|
Enable/disable logging. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure AntiSpam profiles.
fortinet.fortios.fortios_spamfilter_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
spamfilter_profile:
comment: "Comment."
external: "enable"
flow_based: "enable"
gmail:
log: "enable"
imap:
action: "pass"
log: "enable"
tag_msg: "<your_own_value>"
tag_type: "subject"
mapi:
action: "pass"
log: "enable"
msn_hotmail:
log: "enable"
name: "default_name_18"
options: "bannedword"
pop3:
action: "pass"
log: "enable"
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"
tag_msg: "<your_own_value>"
tag_type: "subject"
spam_bwl_table: "2147483647"
spam_bword_table: "2147483647"
spam_bword_threshold: "1073741823"
spam_filtering: "enable"
spam_iptrust_table: "2147483647"
spam_log: "disable"
spam_log_fortiguard_response: "disable"
spam_mheader_table: "2147483647"
spam_rbl_table: "2147483647"
yahoo_mail:
log: "enable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |