:source: fmgd_emailfilter_profile.py
:orphan:
.. _fmgd_emailfilter_profile:
fmgd_emailfilter_profile -- Configure Email Filter profiles.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.1.0
.. contents::
:local:
:depth: 1
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
----------------------------------
.. raw:: html
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
Parameters
----------
.. raw:: html
access_token -The token to access FortiManager without using username and password. type: strrequired: false
bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: boolrequired: 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: strrequired: false
proposed_method - The overridden method for the underlying Json RPC request. type: strrequired: false choices: set, update, add
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: listrequired: false
rc_failed - The rc codes list with which the conditions to fail will be overriden. type: listrequired: false
state - The directive to create, update or delete an object type: strrequired: true choices: present, absent
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: strrequired: 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: integerrequired: falsedefault: 300
device - The parameter in requested url type: strrequired: true
vdom - The parameter in requested url type: strrequired: true
status Enable/disable file filter. type: strchoices: [disable, enable] more...
Supported Version Ranges: v7.4.8 -> v7.4.10
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
--------
.. code-block:: yaml+jinja
- 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:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
vdom:
state: present #
emailfilter_profile:
name: "your value" # Required variable, string
# comment:
# external:
# gmail:
# log_all:
# log:
# imap:
# action:
# log_all:
# tag_msg:
# tag_type:
# - "subject"
# - "header"
# - "spaminfo"
# log:
# mapi:
# action:
# log_all:
# log:
# msn_hotmail:
# log_all:
# log:
# options:
# - "bannedword"
# - "spamfsip"
# - "spamfssubmit"
# - "spamfschksum"
# - "spamfsurl"
# - "spamhelodns"
# - "spamraddrdns"
# - "spamrbl"
# - "spamhdrcheck"
# - "spamfsphish"
# - "spambal"
# - "spamfgchksum"
# - "spamfgurl"
# - "spamfgip"
# - "spamfgsubmit"
# - "spamfgphish"
# - "spambwl"
# pop3:
# action:
# log_all:
# tag_msg:
# tag_type:
# - "subject"
# - "header"
# - "spaminfo"
# log:
# replacemsg_group:
# smtp:
# action:
# hdrip:
# local_override:
# log_all:
# tag_msg:
# tag_type:
# - "subject"
# - "header"
# - "spaminfo"
# log:
# spam_bal_table:
# spam_bword_table:
# spam_bword_threshold:
# spam_filtering:
# spam_iptrust_table:
# spam_log:
# spam_log_fortiguard_response:
# spam_mheader_table:
# spam_rbl_table:
# feature_set:
# other_webmails:
# log_all:
# spam_bwl_table:
# file_filter:
# entries:
# - action:
# comment:
# file_type:
# filter:
# password_protected:
# protocol:
# - "smtp"
# - "imap"
# - "pop3"
# log:
# scan_archive_contents:
# status:
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:
.. raw:: html
meta - The result of the request.returned: alwaystype: dict
request_url - The full url requested. returned: alwaystype: strsample: /sys/login/user
response_code - The status of api request. returned: alwaystype: intsample: 0
response_data - The data body of the api response. returned: optionaltype: list or dict
response_message - The descriptive message of the api response. returned: alwaystype: strsample: OK
system_information - The information of the target system. returned: alwaystype: dict
rc - The status the request. returned: alwaystype: intsample: 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 versiontype: 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)