drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_emailfilter_profile Configure Email Filter profiles. | "added in version" 2.1.0 of drmofu.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communitydrmofu.fortimanager.fmgr_emailfilter_profile (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- 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 - 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 file-filter: entries: - action: <value in [log, block]> comment: <value of string> encryption: <value in [any, yes]> file-type: <value of string> filter: <value of 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]> spam-bal-table: <value of string>
adom: description: the parameter (adom) in requested url required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. required: false type: bool emailfilter_profile: description: the top level parameters set required: false suboptions: comment: description: Comment. type: str external: choices: - disable - enable description: Enable/disable external Email inspection. type: str feature-set: choices: - proxy - flow description: Flow/proxy feature set. type: str file-filter: description: no description required: false suboptions: entries: description: description elements: dict suboptions: action: choices: - log - block description: Action taken for matched file. type: str comment: description: Comment. type: str encryption: choices: - any - 'yes' description: no description type: str file-type: description: description type: str filter: description: Add a file filter. type: str password-protected: choices: - any - 'yes' description: Match password-protected files. type: str protocol: choices: - smtp - imap - pop3 description: description elements: str type: list type: list log: choices: - disable - enable description: Enable/disable file filter logging. type: str scan-archive-contents: choices: - disable - enable description: Enable/disable file filter archive contents scan. type: str status: choices: - disable - enable description: Enable/disable file filter. type: str type: dict gmail: description: no description required: false suboptions: log: choices: - disable - enable description: Enable/disable logging. type: str log-all: choices: - disable - enable description: Enable/disable logging of all email traffic. type: str type: dict imap: description: no description required: false suboptions: action: choices: - pass - tag description: Action for spam email. type: str log: choices: - disable - enable description: Enable/disable logging. type: str log-all: choices: - disable - enable description: Enable/disable logging of all email traffic. type: str tag-msg: description: Subject text or header added to spam email. type: str tag-type: choices: - subject - header - spaminfo description: Tag subject or header for spam email. elements: str type: list type: dict mapi: description: no description required: false suboptions: action: choices: - pass - discard description: Action for spam email. type: str log: choices: - disable - enable description: Enable/disable logging. type: str log-all: choices: - disable - enable description: Enable/disable logging of all email traffic. type: str type: dict msn-hotmail: description: no description required: false suboptions: log: choices: - disable - enable description: Enable/disable logging. type: str log-all: choices: - disable - enable description: Enable/disable logging of all email traffic. type: str type: dict name: description: Profile name. type: str options: choices: - bannedword - spambwl - spamfsip - spamfssubmit - spamfschksum - spamfsurl - spamhelodns - spamraddrdns - spamrbl - spamhdrcheck - spamfsphish - spambal - spamfgip - spamfgsubmit - spamfgchksum - spamfgurl - spamfgphish description: Options. elements: str type: list other-webmails: description: no description required: false suboptions: log-all: choices: - disable - enable description: Enable/disable logging of all email traffic. type: str type: dict pop3: description: no description required: false suboptions: action: choices: - pass - tag description: Action for spam email. type: str log: choices: - disable - enable description: Enable/disable logging. type: str log-all: choices: - disable - enable description: Enable/disable logging of all email traffic. type: str tag-msg: description: Subject text or header added to spam email. type: str tag-type: choices: - subject - header - spaminfo description: Tag subject or header for spam email. elements: str type: list type: dict replacemsg-group: description: Replacement message group. type: str smtp: description: no description required: false suboptions: action: choices: - pass - tag - discard description: Action for spam email. type: str hdrip: choices: - disable - enable description: Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl filters. type: str local-override: choices: - disable - enable description: Enable/disable local filter to override SMTP remote check result. type: str log: choices: - disable - enable description: Enable/disable logging. type: str log-all: choices: - disable - enable description: Enable/disable logging of all email traffic. type: str tag-msg: description: Subject text or header added to spam email. type: str tag-type: choices: - subject - header - spaminfo description: Tag subject or header for spam email. elements: str type: list type: dict spam-bal-table: description: Anti-spam block/allow list table ID. type: str spam-bwl-table: description: Anti-spam black/white list table ID. type: str spam-bword-table: description: Anti-spam banned word table ID. type: str spam-bword-threshold: description: Spam banned word threshold. type: int spam-filtering: choices: - disable - enable description: Enable/disable spam filtering. type: str spam-iptrust-table: description: Anti-spam IP trust table ID. type: str spam-log: choices: - disable - enable description: Enable/disable spam logging for email filtering. type: str spam-log-fortiguard-response: choices: - disable - enable description: Enable/disable logging FortiGuard spam response. type: str spam-mheader-table: description: Anti-spam MIME header table ID. type: str spam-rbl-table: description: Anti-spam DNSBL table ID. type: str type: dict workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list