Try SpotterConfigure Email Filter profiles.
| "added in version" 2.1.0 of fortinet.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 community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure Email Filter profiles.
fortinet.fortimanager.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: present # <value in [present, absent]>
emailfilter_profile:
comment: <string>
external: <value in [disable, enable]>
name: <string>
options:
- bannedword
- spambwl
- spamfsip
- spamfssubmit
- spamfschksum
- spamfsurl
- spamhelodns
- spamraddrdns
- spamrbl
- spamhdrcheck
- spamfsphish
- spambal
- spamfgip
- spamfgsubmit
- spamfgchksum
- spamfgurl
- spamfgphish
replacemsg_group: <string>
spam_bwl_table: <string>
spam_bword_table: <string>
spam_bword_threshold: <integer>
spam_filtering: <value in [disable, enable]>
spam_iptrust_table: <string>
spam_log: <value in [disable, enable]>
spam_log_fortiguard_response: <value in [disable, enable]>
spam_mheader_table: <string>
spam_rbl_table: <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: <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: <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: <string>
tag_type:
- subject
- header
- spaminfo
file_filter:
entries:
-
action: <value in [log, block]>
comment: <string>
encryption: <value in [any, yes]>
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]>
spam_bal_table: <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
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
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.
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: Deprecated, please rename it to feature_set. Flow/proxy feature set.
type: str
file-filter:
description: Deprecated, please rename it to file_filter.
suboptions:
entries:
description: No 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: (list) Deprecated, please rename it to file_type.
type: raw
filter:
description: Add a file filter.
type: str
password-protected:
choices:
- any
- 'yes'
description: Deprecated, please rename it to password_protected. Match
password-protected files.
type: str
protocol:
choices:
- smtp
- imap
- pop3
description: No 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: Deprecated, please rename it to scan_archive_contents. 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.
suboptions:
log:
choices:
- disable
- enable
description: Enable/disable logging.
type: str
log-all:
choices:
- disable
- enable
description: Deprecated, please rename it to log_all. Enable/disable logging
of all email traffic.
type: str
type: dict
imap:
description: No description.
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: Deprecated, please rename it to log_all. Enable/disable logging
of all email traffic.
type: str
tag-msg:
description: Deprecated, please rename it to tag_msg. Subject text or header
added to spam email.
type: str
tag-type:
choices:
- subject
- header
- spaminfo
description: Deprecated, please rename it to tag_type. Tag subject or header
for spam email.
elements: str
type: list
type: dict
mapi:
description: No description.
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: Deprecated, please rename it to log_all. Enable/disable logging
of all email traffic.
type: str
type: dict
msn-hotmail:
description: Deprecated, please rename it to msn_hotmail.
suboptions:
log:
choices:
- disable
- enable
description: Enable/disable logging.
type: str
log-all:
choices:
- disable
- enable
description: Deprecated, please rename it to log_all. Enable/disable logging
of all email traffic.
type: str
type: dict
name:
description: Profile name.
required: true
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: Deprecated, please rename it to other_webmails.
suboptions:
log-all:
choices:
- disable
- enable
description: Deprecated, please rename it to log_all. Enable/disable logging
of all email traffic.
type: str
type: dict
pop3:
description: No description.
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: Deprecated, please rename it to log_all. Enable/disable logging
of all email traffic.
type: str
tag-msg:
description: Deprecated, please rename it to tag_msg. Subject text or header
added to spam email.
type: str
tag-type:
choices:
- subject
- header
- spaminfo
description: Deprecated, please rename it to tag_type. Tag subject or header
for spam email.
elements: str
type: list
type: dict
replacemsg-group:
description: Deprecated, please rename it to replacemsg_group. Replacement message
group.
type: str
smtp:
description: No description.
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: Deprecated, please rename it to local_override. 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: Deprecated, please rename it to log_all. Enable/disable logging
of all email traffic.
type: str
tag-msg:
description: Deprecated, please rename it to tag_msg. Subject text or header
added to spam email.
type: str
tag-type:
choices:
- subject
- header
- spaminfo
description: Deprecated, please rename it to tag_type. Tag subject or header
for spam email.
elements: str
type: list
type: dict
spam-bal-table:
description: Deprecated, please rename it to spam_bal_table. Anti-spam block/allow
list table ID.
type: str
spam-bwl-table:
description: Deprecated, please rename it to spam_bwl_table. Anti-spam black/white
list table ID.
type: str
spam-bword-table:
description: Deprecated, please rename it to spam_bword_table. Anti-spam banned
word table ID.
type: str
spam-bword-threshold:
description: Deprecated, please rename it to spam_bword_threshold. Spam banned
word threshold.
type: int
spam-filtering:
choices:
- disable
- enable
description: Deprecated, please rename it to spam_filtering. Enable/disable spam
filtering.
type: str
spam-iptrust-table:
description: Deprecated, please rename it to spam_iptrust_table. Anti-spam IP
trust table ID.
type: str
spam-log:
choices:
- disable
- enable
description: Deprecated, please rename it to spam_log. Enable/disable spam logging
for email filtering.
type: str
spam-log-fortiguard-response:
choices:
- disable
- enable
description: Deprecated, please rename it to spam_log_fortiguard_response. Enable/disable
logging FortiGuard spam response.
type: str
spam-mheader-table:
description: Deprecated, please rename it to spam_mheader_table. Anti-spam MIME
header table ID.
type: str
spam-rbl-table:
description: Deprecated, please rename it to spam_rbl_table. 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.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
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