fortios_spamfilter_profile – Configure AntiSpam profiles in Fortinet’s FortiOS and FortiGate

fortios_spamfilter_profile – Configure AntiSpam profiles in Fortinet’s FortiOS and FortiGate

New in version 2.8.

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

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.5

Requirements

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

• fortiosapi>=0.9.8

Parameters

Parameter			Choices/Defaults	Comments
host string				FortiOS or FortiGate IP address.
https boolean			no yes ←	Indicates if the requests towards FortiGate must use HTTPS protocol.
password string			Default: ""	FortiOS or FortiGate password.
spamfilter_profile dictionary			Default: null	Configure AntiSpam profiles.
	comment string			Comment.
	external string		enable disable	Enable/disable external Email inspection.
	flow_based string		enable disable	Enable/disable flow-based spam filtering.
	gmail dictionary			Gmail.
		log string	enable disable	Enable/disable logging.
	imap dictionary			IMAP.
		action string	pass tag	Action for spam email.
		log string	enable disable	Enable/disable logging.
		tag_msg string		Subject text or header added to spam email.
		tag_type list	subject header spaminfo	Tag subject or header for spam email.
	mapi dictionary			MAPI.
		action string	pass discard	Action for spam email.
		log string	enable disable	Enable/disable logging.
	msn_hotmail dictionary			MSN Hotmail.
		log string	enable disable	Enable/disable logging.
	name string / required			Profile name.
	options list		bannedword spambwl spamfsip spamfssubmit spamfschksum spamfsurl spamhelodns spamraddrdns spamrbl spamhdrcheck spamfsphish	Options.
	pop3 dictionary			POP3.
		action string	pass tag	Action for spam email.
		log string	enable disable	Enable/disable logging.
		tag_msg string		Subject text or header added to spam email.
		tag_type list	subject header spaminfo	Tag subject or header for spam email.
	replacemsg_group string			Replacement message group. Source system.replacemsg-group.name.
	smtp dictionary			SMTP.
		action string	pass tag discard	Action for spam email.
		hdrip string	disable enable	Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl filters.
		local_override string	disable enable	Enable/disable local filter to override SMTP remote check result.
		log string	enable disable	Enable/disable logging.
		tag_msg string		Subject text or header added to spam email.
		tag_type list	subject header spaminfo	Tag subject or header for spam email.
	spam_bwl_table integer			Anti-spam black/white list table ID. Source spamfilter.bwl.id.
	spam_bword_table integer			Anti-spam banned word table ID. Source spamfilter.bword.id.
	spam_bword_threshold integer			Spam banned word threshold.
	spam_filtering string		enable disable	Enable/disable spam filtering.
	spam_iptrust_table integer			Anti-spam IP trust table ID. Source spamfilter.iptrust.id.
	spam_log string		disable enable	Enable/disable spam logging for email filtering.
	spam_log_fortiguard_response string		disable enable	Enable/disable logging FortiGuard spam response.
	spam_mheader_table integer			Anti-spam MIME header table ID. Source spamfilter.mheader.id.
	spam_rbl_table integer			Anti-spam DNSBL table ID. Source spamfilter.dnsbl.id.
	state string		present absent	Deprecated Starting with Ansible 2.9 we recommend using the top-level 'state' parameter. Indicates whether to create or remove the object.
	yahoo_mail dictionary			Yahoo! Mail.
		log string	enable disable	Enable/disable logging.
ssl_verify boolean added in 2.9			no yes ←	Ensures FortiGate certificate must be verified by a proper CA.
state string added in 2.9			present absent	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.
username string				FortiOS or FortiGate username.
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

• Requires fortiosapi library developed by Fortinet
• Run as a local_action in your playbook

Examples

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure AntiSpam profiles.
    fortios_spamfilter_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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 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

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Community. [community]

Authors

• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_spamfilter_profile_module.html