source:	fortios_spamfilter_profile.py
orphan:

fortios_spamfilter_profile -- Configure AntiSpam profiles in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis
Requirements
Tips
FortiOS Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_spamfilter_profile	`v6.0.0 -> v6.0.11`

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
spamfilter_profile - Configure AntiSpam profiles. type: dict more...

Supported Version Ranges

spamfilter_profile v6.0.0 -> v6.0.11

comment - Comment. type: str more...

Supported Version Ranges

comment v6.0.0 -> v6.0.11
external - Enable/disable external Email inspection. type: str choices: enable, disable more...

Supported Version Ranges

external v6.0.0 -> v6.0.11

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
flow_based - Enable/disable flow-based spam filtering. type: str choices: enable, disable more...

Supported Version Ranges

flow_based v6.0.0 -> v6.0.11

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
gmail - Gmail. type: dict more...

Supported Version Ranges

gmail v6.0.0 -> v6.0.11

log - Enable/disable logging. type: str choices: enable, disable more...

Supported Version Ranges

log v6.0.0 -> v6.0.11

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest

imap - IMAP. type: dict more...

Supported Version Ranges

imap v6.0.0 -> v6.0.11

action - Action for spam email. type: str choices: pass, tag more...

Supported Version Ranges

action v6.0.0 -> v6.0.11

[pass] v6.0.0 -> latest
[tag] v6.0.0 -> latest
log - Enable/disable logging. type: str choices: enable, disable more...

Supported Version Ranges

log v6.0.0 -> v6.0.11

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
tag_msg - Subject text or header added to spam email. type: str more...

Supported Version Ranges

tag_msg v6.0.0 -> v6.0.11
tag_type - Tag subject or header for spam email. type: list choices: subject, header, spaminfo more...

Supported Version Ranges

tag_type v6.0.0 -> v6.0.11

[subject] v6.0.0 -> latest
[header] v6.0.0 -> latest
[spaminfo] v6.0.0 -> latest

mapi - MAPI. type: dict more...

Supported Version Ranges

mapi v6.0.0 -> v6.0.11

action - Action for spam email. type: str choices: pass, discard more...

Supported Version Ranges

action v6.0.0 -> v6.0.11

[pass] v6.0.0 -> latest
[discard] v6.0.0 -> latest
log - Enable/disable logging. type: str choices: enable, disable more...

Supported Version Ranges

log v6.0.0 -> v6.0.11

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest

msn_hotmail - MSN Hotmail. type: dict more...

Supported Version Ranges

msn_hotmail v6.0.0 -> v6.0.11

log - Enable/disable logging. type: str choices: enable, disable more...

Supported Version Ranges

log v6.0.0 -> v6.0.11

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest

name - Profile name. type: str required: true more...

Supported Version Ranges

name v6.0.0 -> v6.0.11

options - Options. type: list choices: bannedword, spambwl, spamfsip, spamfssubmit, spamfschksum, spamfsurl, spamhelodns, spamraddrdns, spamrbl, spamhdrcheck, spamfsphish more...

	Supported Version Ranges
options	`v6.0.0 -> v6.0.11`
[bannedword]	`v6.0.0 -> latest`
[spambwl]	`v6.0.0 -> latest`
[spamfsip]	`v6.0.0 -> latest`
[spamfssubmit]	`v6.0.0 -> latest`
[spamfschksum]	`v6.0.0 -> latest`
[spamfsurl]	`v6.0.0 -> latest`
[spamhelodns]	`v6.0.0 -> latest`
[spamraddrdns]	`v6.0.0 -> latest`
[spamrbl]	`v6.0.0 -> latest`
[spamhdrcheck]	`v6.0.0 -> latest`
[spamfsphish]	`v6.0.0 -> latest`

pop3 - POP3. type: dict more...

Supported Version Ranges

pop3 v6.0.0 -> v6.0.11

action - Action for spam email. type: str choices: pass, tag more...

Supported Version Ranges

action v6.0.0 -> v6.0.11

[pass] v6.0.0 -> latest
[tag] v6.0.0 -> latest
log - Enable/disable logging. type: str choices: enable, disable more...

Supported Version Ranges

log v6.0.0 -> v6.0.11

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
tag_msg - Subject text or header added to spam email. type: str more...

Supported Version Ranges

tag_msg v6.0.0 -> v6.0.11
tag_type - Tag subject or header for spam email. type: list choices: subject, header, spaminfo more...

Supported Version Ranges

tag_type v6.0.0 -> v6.0.11

[subject] v6.0.0 -> latest
[header] v6.0.0 -> latest
[spaminfo] v6.0.0 -> latest

replacemsg_group - Replacement message group. Source system.replacemsg-group.name. type: str more...

Supported Version Ranges

replacemsg_group v6.0.0 -> v6.0.11
smtp - SMTP. type: dict more...

Supported Version Ranges

smtp v6.0.0 -> v6.0.11

action - Action for spam email. type: str choices: pass, tag, discard more...

Supported Version Ranges

action v6.0.0 -> v6.0.11

[pass] v6.0.0 -> latest
[tag] v6.0.0 -> latest
[discard] v6.0.0 -> latest
hdrip - Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl filters. type: str choices: disable, enable more...

Supported Version Ranges

hdrip v6.0.0 -> v6.0.11

[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
local_override - Enable/disable local filter to override SMTP remote check result. type: str choices: disable, enable more...

Supported Version Ranges

local_override v6.0.0 -> v6.0.11

[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
log - Enable/disable logging. type: str choices: enable, disable more...

Supported Version Ranges

log v6.0.0 -> v6.0.11

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
tag_msg - Subject text or header added to spam email. type: str more...

Supported Version Ranges

tag_msg v6.0.0 -> v6.0.11
tag_type - Tag subject or header for spam email. type: list choices: subject, header, spaminfo more...

Supported Version Ranges

tag_type v6.0.0 -> v6.0.11

[subject] v6.0.0 -> latest
[header] v6.0.0 -> latest
[spaminfo] v6.0.0 -> latest

spam_bwl_table - Anti-spam black/white list table ID. Source spamfilter.bwl.id. type: int more...

Supported Version Ranges

spam_bwl_table v6.0.0 -> v6.0.11
spam_bword_table - Anti-spam banned word table ID. Source spamfilter.bword.id. type: int more...

Supported Version Ranges

spam_bword_table v6.0.0 -> v6.0.11
spam_bword_threshold - Spam banned word threshold. type: int more...

Supported Version Ranges

spam_bword_threshold v6.0.0 -> v6.0.11
spam_filtering - Enable/disable spam filtering. type: str choices: enable, disable more...

Supported Version Ranges

spam_filtering v6.0.0 -> v6.0.11

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest
spam_iptrust_table - Anti-spam IP trust table ID. Source spamfilter.iptrust.id. type: int more...

Supported Version Ranges

spam_iptrust_table v6.0.0 -> v6.0.11
spam_log - Enable/disable spam logging for email filtering. type: str choices: disable, enable more...

Supported Version Ranges

spam_log v6.0.0 -> v6.0.11

[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
spam_log_fortiguard_response - Enable/disable logging FortiGuard spam response. type: str choices: disable, enable more...

Supported Version Ranges

spam_log_fortiguard_response v6.0.0 -> v6.0.11

[disable] v6.0.0 -> latest
[enable] v6.0.0 -> latest
spam_mheader_table - Anti-spam MIME header table ID. Source spamfilter.mheader.id. type: int more...

Supported Version Ranges

spam_mheader_table v6.0.0 -> v6.0.11
spam_rbl_table - Anti-spam DNSBL table ID. Source spamfilter.dnsbl.id. type: int more...

Supported Version Ranges

spam_rbl_table v6.0.0 -> v6.0.11
yahoo_mail - Yahoo! Mail. type: dict more...

Supported Version Ranges

yahoo_mail v6.0.0 -> v6.0.11

log - Enable/disable logging. type: str choices: enable, disable more...

Supported Version Ranges

log v6.0.0 -> v6.0.11

[enable] v6.0.0 -> latest
[disable] v6.0.0 -> latest

Notes

Note

Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

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

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Hongbin Lu (@fgtdev-hblu)
Frank Shen (@frankshen01)
Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fortios_spamfilter_profile.rst

fortios_spamfilter_profile.rst

fortios_spamfilter_profile -- Configure AntiSpam profiles in Fortinet's FortiOS and FortiGate.

Synopsis

Requirements

Tips

FortiOS Version Compatibility

Parameters

Notes

Examples

Return Values

Status

Authors

	Supported Version Ranges
spamfilter_profile	`v6.0.0 -> v6.0.11`

	Supported Version Ranges
external	`v6.0.0 -> v6.0.11`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
flow_based	`v6.0.0 -> v6.0.11`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
action	`v6.0.0 -> v6.0.11`
[pass]	`v6.0.0 -> latest`
[tag]	`v6.0.0 -> latest`

	Supported Version Ranges
tag_type	`v6.0.0 -> v6.0.11`
[subject]	`v6.0.0 -> latest`
[header]	`v6.0.0 -> latest`
[spaminfo]	`v6.0.0 -> latest`

	Supported Version Ranges
hdrip	`v6.0.0 -> v6.0.11`
[disable]	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`

	Supported Version Ranges
local_override	`v6.0.0 -> v6.0.11`
[disable]	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`

	Supported Version Ranges
spam_bword_threshold	`v6.0.0 -> v6.0.11`

	Supported Version Ranges
spam_filtering	`v6.0.0 -> v6.0.11`
[enable]	`v6.0.0 -> latest`
[disable]	`v6.0.0 -> latest`

	Supported Version Ranges
spam_iptrust_table	`v6.0.0 -> v6.0.11`

	Supported Version Ranges
spam_log	`v6.0.0 -> v6.0.11`
[disable]	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`

	Supported Version Ranges
spam_log_fortiguard_response	`v6.0.0 -> v6.0.11`
[disable]	`v6.0.0 -> latest`
[enable]	`v6.0.0 -> latest`

	Supported Version Ranges
spam_mheader_table	`v6.0.0 -> v6.0.11`

Files

fortios_spamfilter_profile.rst

Latest commit

History

fortios_spamfilter_profile.rst

File metadata and controls

fortios_spamfilter_profile -- Configure AntiSpam profiles in Fortinet's FortiOS and FortiGate.