fmgr_emailfilter_profile – Configure Email Filter profiles.

New in version 2.10.

Synopsis

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

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
emailfilter_profile yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • emailfilter_profile - no description type: dict
    • comment - Comment. type: str more...
    • external - Enable/disable external Email inspection. type: str choices: [disable, enable] more...
    • name - Profile name. type: str more...
    • options - Options. type: array choices: [bannedword, spambwl, spamfsip, spamfssubmit, spamfschksum, spamfsurl, spamhelodns, spamraddrdns, spamrbl, spamhdrcheck, spamfsphish, spambal, spamfgip, spamfgsubmit, spamfgchksum, spamfgurl, spamfgphish] more...
    • replacemsg-group - Replacement message group. type: str more...
    • spam-bwl-table - Anti-spam black/white list table ID. type: str more...
    • spam-bword-table - Anti-spam banned word table ID. type: str more...
    • spam-bword-threshold - Spam banned word threshold. type: int more...
    • spam-filtering - Enable/disable spam filtering. type: str choices: [disable, enable] more...
    • spam-iptrust-table - Anti-spam IP trust table ID. type: str more...
    • spam-log - Enable/disable spam logging for email filtering. type: str choices: [disable, enable] more...
    • spam-log-fortiguard-response - Enable/disable logging FortiGuard spam response. type: str choices: [disable, enable] more...
    • spam-mheader-table - Anti-spam MIME header table ID. type: str more...
    • spam-rbl-table - Anti-spam DNSBL table ID. type: str more...
    • feature-set - Flow/proxy feature set. type: str choices: [proxy, flow] more...
    • gmail type: dict
      • log - Log. type: str choices: [disable, enable] more...
      • log-all - Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
    • imap type: dict
      • action - Action for spam email. type: str choices: [pass, tag] more...
      • log - Log. type: str choices: [disable, enable] more...
      • log-all - Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
      • tag-msg - Subject text or header added to spam email. type: str more...
      • tag-type - Tag subject or header for spam email. type: array choices: [subject, header, spaminfo] more...
    • mapi type: dict
      • action - Action for spam email. type: str choices: [pass, discard] more...
      • log - Log. type: str choices: [disable, enable] more...
      • log-all - Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
    • msn-hotmail type: dict
      • log - Log. type: str choices: [disable, enable] more...
      • log-all - Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
    • other-webmails type: dict
      • log-all - Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
    • pop3 type: dict
      • action - Action for spam email. type: str choices: [pass, tag] more...
      • log - Log. type: str choices: [disable, enable] more...
      • log-all - Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
      • tag-msg - Subject text or header added to spam email. type: str more...
      • tag-type - Tag subject or header for spam email. type: array choices: [subject, header, spaminfo] more...
    • smtp type: dict
      • action - Action for spam email. type: str choices: [pass, tag, discard] more...
      • hdrip - Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl filters. type: str choices: [disable, enable] more...
      • local-override - Enable/disable local filter to override SMTP remote check result. type: str choices: [disable, enable] more...
      • log - Log. type: str choices: [disable, enable] more...
      • log-all - Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
      • tag-msg - Subject text or header added to spam email. type: str more...
      • tag-type - Tag subject or header for spam email. type: array choices: [subject, header, spaminfo] more...
    • spam-bal-table - Anti-spam block/allow list table ID. type: str more...

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: no description
     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
             - spamfgip
             - spamfgsubmit
             - spamfgchksum
             - spamfgurl
             - spamfgphish
           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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

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

Hint

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