fortinet.fortimanager.fmgr_emailfilter_profile module – Configure Email Filter profiles.

Note

This module is part of the fortinet.fortimanager collection (version 2.1.5).

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

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

New in version 2.10: of fortinet.fortimanager

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

Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

emailfilter_profile

dictionary

the top level parameters set

comment

string

Comment.

external

string

Enable/disable external Email inspection.

Choices:

  • disable

  • enable

feature-set

string

Flow/proxy feature set.

Choices:

  • proxy

  • flow

gmail

dictionary

no description

log

string

Log.

Choices:

  • disable

  • enable

log-all

string

Enable/disable logging of all email traffic.

Choices:

  • disable

  • enable

imap

dictionary

no description

action

string

Action for spam email.

Choices:

  • pass

  • tag

log

string

Log.

Choices:

  • disable

  • enable

log-all

string

Enable/disable logging of all email traffic.

Choices:

  • disable

  • enable

tag-msg

string

Subject text or header added to spam email.

tag-type

list / elements=string

Tag subject or header for spam email.

Choices:

  • subject

  • header

  • spaminfo

mapi

dictionary

no description

action

string

Action for spam email.

Choices:

  • pass

  • discard

log

string

Log.

Choices:

  • disable

  • enable

log-all

string

Enable/disable logging of all email traffic.

Choices:

  • disable

  • enable

msn-hotmail

dictionary

no description

log

string

Log.

Choices:

  • disable

  • enable

log-all

string

Enable/disable logging of all email traffic.

Choices:

  • disable

  • enable

name

string

Profile name.

options

list / elements=string

Options.

Choices:

  • bannedword

  • spambwl

  • spamfsip

  • spamfssubmit

  • spamfschksum

  • spamfsurl

  • spamhelodns

  • spamraddrdns

  • spamrbl

  • spamhdrcheck

  • spamfsphish

  • spambal

other-webmails

dictionary

no description

log-all

string

Enable/disable logging of all email traffic.

Choices:

  • disable

  • enable

pop3

dictionary

no description

action

string

Action for spam email.

Choices:

  • pass

  • tag

log

string

Log.

Choices:

  • disable

  • enable

log-all

string

Enable/disable logging of all email traffic.

Choices:

  • disable

  • enable

tag-msg

string

Subject text or header added to spam email.

tag-type

list / elements=string

Tag subject or header for spam email.

Choices:

  • subject

  • header

  • spaminfo

replacemsg-group

string

Replacement message group.

smtp

dictionary

no description

action

string

Action for spam email.

Choices:

  • pass

  • tag

  • discard

hdrip

string

Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl filters.

Choices:

  • disable

  • enable

local-override

string

Enable/disable local filter to override SMTP remote check result.

Choices:

  • disable

  • enable

log

string

Log.

Choices:

  • disable

  • enable

log-all

string

Enable/disable logging of all email traffic.

Choices:

  • disable

  • enable

tag-msg

string

Subject text or header added to spam email.

tag-type

list / elements=string

Tag subject or header for spam email.

Choices:

  • subject

  • header

  • spaminfo

spam-bal-table

string

Anti-spam block/allow list table ID.

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

Enable/disable spam filtering.

Choices:

  • disable

  • enable

spam-iptrust-table

string

Anti-spam IP trust table ID.

spam-log

string

Enable/disable spam logging for email filtering.

Choices:

  • disable

  • enable

spam-log-fortiguard-response

string

Enable/disable logging FortiGuard spam response.

Choices:

  • disable

  • enable

spam-mheader-table

string

Anti-spam MIME header table ID.

spam-rbl-table

string

Anti-spam DNSBL table ID.

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

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

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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 Email Filter profiles.
     fmgr_emailfilter_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]>
        emailfilter_profile:
           comment: <value of string>
           external: <value in [disable, enable]>
           name: <value of string>
           options:
             - bannedword
             - spambwl
             - spamfsip
             - spamfssubmit
             - spamfschksum
             - spamfsurl
             - spamhelodns
             - spamraddrdns
             - spamrbl
             - spamhdrcheck
             - spamfsphish
             - spambal
           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>
           feature-set: <value in [proxy, flow]>
           gmail:
              log: <value in [disable, enable]>
              log-all: <value in [disable, enable]>
           imap:
              action: <value in [pass, tag]>
              log: <value in [disable, enable]>
              log-all: <value in [disable, enable]>
              tag-msg: <value of string>
              tag-type:
                - subject
                - header
                - spaminfo
           mapi:
              action: <value in [pass, discard]>
              log: <value in [disable, enable]>
              log-all: <value in [disable, enable]>
           msn-hotmail:
              log: <value in [disable, enable]>
              log-all: <value in [disable, enable]>
           other-webmails:
              log-all: <value in [disable, enable]>
           pop3:
              action: <value in [pass, tag]>
              log: <value in [disable, enable]>
              log-all: <value in [disable, enable]>
              tag-msg: <value of string>
              tag-type:
                - subject
                - header
                - spaminfo
           smtp:
              action: <value in [pass, tag, discard]>
              hdrip: <value in [disable, enable]>
              local-override: <value in [disable, enable]>
              log: <value in [disable, enable]>
              log-all: <value in [disable, enable]>
              tag-msg: <value of string>
              tag-type:
                - subject
                - header
                - spaminfo
           spam-bal-table: <value of string>

Return Values

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

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)