fortinet.fortimanager.fmgr_spamfilter_profile – Configure AntiSpam profiles.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_spamfilter_profile.

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
spamfilter_profile dictionary			the top level parameters set
	comment string		Comment.
	external string	disable enable	Enable/disable external Email inspection.
	flow-based string	disable enable	Enable/disable flow-based spam filtering.
	name string		Profile name.
	options list / elements=string	bannedword spamemailbwl spamfsip spamfssubmit spamfschksum spamfsurl spamhelodns spamipbwl spamraddrdns spamrbl spamhdrcheck spamfsphish spambwl	no description
	replacemsg-group string		Replacement message group.
	spam-bwl-table string		Anti-spam black/white list table ID.
	spam-bword-table string		Anti-spam banned word table ID.
	spam-bword-threshold integer		Spam banned word threshold.
	spam-filtering string	disable enable	Enable/disable spam filtering.
	spam-iptrust-table string		Anti-spam IP trust table 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 string		Anti-spam MIME header table ID.
	spam-rbl-table string		Anti-spam DNSBL table ID.
state string / required		present absent	the directive to create, update or delete an object
workspace_locking_adom string			the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
To create or update an object, use state present directive.
To delete an object, use state absent directive.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure AntiSpam profiles.
     fmgr_spamfilter_profile:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        spamfilter_profile:
           comment: <value of string>
           external: <value in [disable, enable]>
           flow-based: <value in [disable, enable]>
           name: <value of string>
           options:
             - bannedword
             - spamemailbwl
             - spamfsip
             - spamfssubmit
             - spamfschksum
             - spamfsurl
             - spamhelodns
             - spamipbwl
             - spamraddrdns
             - spamrbl
             - spamhdrcheck
             - spamfsphish
             - spambwl
           replacemsg-group: <value of string>
           spam-bwl-table: <value of string>
           spam-bword-table: <value of string>
           spam-bword-threshold: <value of integer>
           spam-filtering: <value in [disable, enable]>
           spam-iptrust-table: <value of string>
           spam-log: <value in [disable, enable]>
           spam-log-fortiguard-response: <value in [disable, enable]>
           spam-mheader-table: <value of string>
           spam-rbl-table: <value of string>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_spamfilter_profile_module.html