fmgd_emailfilter_profile – Configure Email Filter profiles.

Added in version 1.1.0.

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.

  • Tested with FortiManager v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • emailfilter_profile - Configure Email Filter profiles. type: dict
    • comment Comment. type: str more...
    • external Enable/disable external email inspection. type: str choices: [disable, enable] more...
    • gmail Gmail. type: dict more...
      • log_all (Alias name: log-all) Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
      • log Enable/disable logging. type: str choices: [disable, enable] more...
    • imap Imap. type: dict more...
      • action Action for spam email. type: str choices: [pass, tag] more...
      • log_all (Alias name: log-all) Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
      • tag_msg (Alias name: tag-msg) Subject text or header added to spam email. type: str more...
      • tag_type (Alias name: tag-type) Tag subject or header for spam email. type: list choices: [subject, header, spaminfo] more...
      • log Enable/disable logging. type: str choices: [disable, enable] more...
    • mapi Mapi. type: dict more...
      • action Action for spam email. type: str choices: [pass, discard] more...
      • log_all (Alias name: log-all) Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
      • log Enable/disable logging. type: str choices: [disable, enable] more...
    • msn_hotmail (Alias name: msn-hotmail) Msn hotmail. type: dict more...
      • log_all (Alias name: log-all) Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
      • log Enable/disable logging. type: str choices: [disable, enable] more...
    • name Profile name. type: str more...
    • options Options. type: list choices: [bannedword, spamfsip, spamfssubmit, spamfschksum, spamfsurl, spamhelodns, spamraddrdns, spamrbl, spamhdrcheck, spamfsphish, spambal, spamfgchksum, spamfgurl, spamfgip, spamfgsubmit, spamfgphish, spambwl] more...
    • pop3 Pop3. type: dict more...
      • action Action for spam email. type: str choices: [pass, tag] more...
      • log_all (Alias name: log-all) Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
      • tag_msg (Alias name: tag-msg) Subject text or header added to spam email. type: str more...
      • tag_type (Alias name: tag-type) Tag subject or header for spam email. type: list choices: [subject, header, spaminfo] more...
      • log Enable/disable logging. type: str choices: [disable, enable] more...
    • replacemsg_group (Alias name: replacemsg-group) Replacement message group. type: list more...
    • smtp Smtp. type: dict more...
      • action Action for spam email. type: str choices: [pass, tag, discard] more...
      • hdrip Enable/disable smtp email header ip checks for spamfsip, spamrbl, and spambal filters. type: str choices: [disable, enable] more...
      • local_override (Alias name: local-override) Enable/disable local filter to override smtp remote check result. type: str choices: [disable, enable] more...
      • log_all (Alias name: log-all) Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
      • tag_msg (Alias name: tag-msg) Subject text or header added to spam email. type: str more...
      • tag_type (Alias name: tag-type) Tag subject or header for spam email. type: list choices: [subject, header, spaminfo] more...
      • log Enable/disable logging. type: str choices: [disable, enable] more...
    • spam_bal_table (Alias name: spam-bal-table) Anti-spam block/allow list table id. type: list more...
    • spam_bword_table (Alias name: spam-bword-table) Anti-spam banned word table id. type: list more...
    • spam_bword_threshold (Alias name: spam-bword-threshold) Spam banned word threshold. type: int more...
    • spam_filtering (Alias name: spam-filtering) Enable/disable spam filtering. type: str choices: [disable, enable] more...
    • spam_iptrust_table (Alias name: spam-iptrust-table) Anti-spam ip trust table id. type: list more...
    • spam_log (Alias name: spam-log) Enable/disable spam logging for email filtering. type: str choices: [disable, enable] more...
    • spam_log_fortiguard_response (Alias name: spam-log-fortiguard-response) Enable/disable logging fortiguard spam response. type: str choices: [disable, enable] more...
    • spam_mheader_table (Alias name: spam-mheader-table) Anti-spam mime header table id. type: list more...
    • spam_rbl_table (Alias name: spam-rbl-table) Anti-spam dnsbl table id. type: list more...
    • feature_set (Alias name: feature-set) Flow/proxy feature set. type: str choices: [proxy, flow] more...
    • other_webmails (Alias name: other-webmails) Other webmails. type: dict more...
      • log_all (Alias name: log-all) Enable/disable logging of all email traffic. type: str choices: [disable, enable] more...
    • spam_bwl_table (Alias name: spam-bwl-table) Anti-spam black/white list table id. type: list more...
    • file_filter (Alias name: file-filter) File filter. type: dict more...
      • entries Entries. type: list more...
        • action Action taken for matched file. type: str choices: [log, block] more...
        • comment Comment. type: str more...
        • file_type (Alias name: file-type) Select file type. type: list more...
        • filter Add a file filter. type: str more...
        • password_protected (Alias name: password-protected) Match password-protected files. type: str choices: [any, yes] more...
        • protocol Protocols to apply with. type: list choices: [smtp, imap, pop3] more...
      • log Enable/disable file filter logging. type: str choices: [disable, enable] more...
      • scan_archive_contents (Alias name: scan-archive-contents) Enable/disable file filter archive contents scan. type: str choices: [disable, enable] more...
      • status Enable/disable file filter. type: str choices: [disable, enable] 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

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure Email Filter profiles.
      fortinet.fmgdevice.fmgd_emailfilter_profile:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        emailfilter_profile:
          name: "your value" # Required variable, string
          # comment: <string>
          # external: <value in [disable, enable]>
          # gmail:
          #   log_all: <value in [disable, enable]>
          #   log: <value in [disable, enable]>
          # imap:
          #   action: <value in [pass, tag]>
          #   log_all: <value in [disable, enable]>
          #   tag_msg: <string>
          #   tag_type:
          #     - "subject"
          #     - "header"
          #     - "spaminfo"
          #   log: <value in [disable, enable]>
          # mapi:
          #   action: <value in [pass, discard]>
          #   log_all: <value in [disable, enable]>
          #   log: <value in [disable, enable]>
          # msn_hotmail:
          #   log_all: <value in [disable, enable]>
          #   log: <value in [disable, enable]>
          # options:
          #   - "bannedword"
          #   - "spamfsip"
          #   - "spamfssubmit"
          #   - "spamfschksum"
          #   - "spamfsurl"
          #   - "spamhelodns"
          #   - "spamraddrdns"
          #   - "spamrbl"
          #   - "spamhdrcheck"
          #   - "spamfsphish"
          #   - "spambal"
          #   - "spamfgchksum"
          #   - "spamfgurl"
          #   - "spamfgip"
          #   - "spamfgsubmit"
          #   - "spamfgphish"
          #   - "spambwl"
          # pop3:
          #   action: <value in [pass, tag]>
          #   log_all: <value in [disable, enable]>
          #   tag_msg: <string>
          #   tag_type:
          #     - "subject"
          #     - "header"
          #     - "spaminfo"
          #   log: <value in [disable, enable]>
          # replacemsg_group: <list or string>
          # smtp:
          #   action: <value in [pass, tag, discard]>
          #   hdrip: <value in [disable, enable]>
          #   local_override: <value in [disable, enable]>
          #   log_all: <value in [disable, enable]>
          #   tag_msg: <string>
          #   tag_type:
          #     - "subject"
          #     - "header"
          #     - "spaminfo"
          #   log: <value in [disable, enable]>
          # spam_bal_table: <list or string>
          # spam_bword_table: <list or string>
          # spam_bword_threshold: <integer>
          # spam_filtering: <value in [disable, enable]>
          # spam_iptrust_table: <list or string>
          # spam_log: <value in [disable, enable]>
          # spam_log_fortiguard_response: <value in [disable, enable]>
          # spam_mheader_table: <list or string>
          # spam_rbl_table: <list or string>
          # feature_set: <value in [proxy, flow]>
          # other_webmails:
          #   log_all: <value in [disable, enable]>
          # spam_bwl_table: <list or string>
          # file_filter:
          #   entries:
          #     - action: <value in [log, block]>
          #       comment: <string>
          #       file_type: <list or string>
          #       filter: <string>
          #       password_protected: <value in [any, yes]>
          #       protocol:
          #         - "smtp"
          #         - "imap"
          #         - "pop3"
          #   log: <value in [disable, enable]>
          #   scan_archive_contents: <value in [disable, enable]>
          #   status: <value in [disable, 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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)