fortios_spamfilter_profile – Configure AntiSpam profiles in Fortinet’s FortiOS and FortiGate.¶
New in version 2.8.
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.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- state - Indicates whether to create or remove the object. This attribute was present already in previous version in a deeper level. It has been moved out to this outer level. type: str required: False choices: present, absent
- spamfilter_profile - Configure AntiSpam profiles. type: dict
- state - B(Deprecated) type: str required: False choices: present, absent
- comment - Comment. type: str
- external - Enable/disable external Email inspection. type: str choices: enable, disable
- flow_based - Enable/disable flow-based spam filtering. type: str choices: enable, disable
- gmail - Gmail. type: dict
- log - Enable/disable logging. type: str choices: enable, disable
- imap - IMAP. type: dict
- action - Action for spam email. type: str choices: pass, tag
- log - Enable/disable logging. type: str choices: enable, disable
- tag_msg - Subject text or header added to spam email. type: str
- tag_type - Tag subject or header for spam email. type: list choices: subject, header, spaminfo
- mapi - MAPI. type: dict
- action - Action for spam email. type: str choices: pass, discard
- log - Enable/disable logging. type: str choices: enable, disable
- msn_hotmail - MSN Hotmail. type: dict
- log - Enable/disable logging. type: str choices: enable, disable
- name - Profile name. type: str required: True
- options - Options. type: list choices: bannedword, spambwl, spamfsip, spamfssubmit, spamfschksum, spamfsurl, spamhelodns, spamraddrdns, spamrbl, spamhdrcheck, spamfsphish
- pop3 - POP3. type: dict
- action - Action for spam email. type: str choices: pass, tag
- log - Enable/disable logging. type: str choices: enable, disable
- tag_msg - Subject text or header added to spam email. type: str
- tag_type - Tag subject or header for spam email. type: list choices: subject, header, spaminfo
- replacemsg_group - Replacement message group. Source system.replacemsg-group.name. type: str
- smtp - SMTP. type: dict
- action - Action for spam email. type: str choices: pass, tag, discard
- hdrip - Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl filters. type: str choices: disable, enable
- local_override - Enable/disable local filter to override SMTP remote check result. type: str choices: disable, enable
- log - Enable/disable logging. type: str choices: enable, disable
- tag_msg - Subject text or header added to spam email. type: str
- tag_type - Tag subject or header for spam email. type: list choices: subject, header, spaminfo
- spam_bwl_table - Anti-spam black/white list table ID. Source spamfilter.bwl.id. type: int
- spam_bword_table - Anti-spam banned word table ID. Source spamfilter.bword.id. type: int
- spam_bword_threshold - Spam banned word threshold. type: int
- spam_filtering - Enable/disable spam filtering. type: str choices: enable, disable
- spam_iptrust_table - Anti-spam IP trust table ID. Source spamfilter.iptrust.id. type: int
- spam_log - Enable/disable spam logging for email filtering. type: str choices: disable, enable
- spam_log_fortiguard_response - Enable/disable logging FortiGuard spam response. type: str choices: disable, enable
- spam_mheader_table - Anti-spam MIME header table ID. Source spamfilter.mheader.id. type: int
- spam_rbl_table - Anti-spam DNSBL table ID. Source spamfilter.dnsbl.id. type: int
- yahoo_mail - Yahoo! Mail. type: dict
- log - Enable/disable logging. type: str choices: enable, disable
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 AntiSpam profiles.
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: "33 (source spamfilter.bwl.id)"
spam_bword_table: "34 (source spamfilter.bword.id)"
spam_bword_threshold: "35"
spam_filtering: "enable"
spam_iptrust_table: "37 (source spamfilter.iptrust.id)"
spam_log: "disable"
spam_log_fortiguard_response: "disable"
spam_mheader_table: "40 (source spamfilter.mheader.id)"
spam_rbl_table: "41 (source spamfilter.dnsbl.id)"
yahoo_mail:
log: "enable"
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