fmgr_spamfilter_profile – Configure AntiSpam profiles.
Added in version 1.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
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 v6.x and v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> v7.2.1
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
- adom - The parameter in requested url type: str required: true
- spamfilter_profile - Configure AntiSpam profiles. type: dict
- comment Comment. type: str more...
- external Enable/disable external email inspection. type: str choices: [disable, enable] more...
- flow_based (Alias name: flow-based) Enable/disable flow-based spam filtering. type: str choices: [disable, enable] more...
- name Profile name. type: str more...
- options type: list choices: [bannedword, spamemailbwl, spamfsip, spamfssubmit, spamfschksum, spamfsurl, spamhelodns, spamipbwl, spamraddrdns, spamrbl, spamhdrcheck, spamfsphish, spambwl] more...
- replacemsg_group (Alias name: replacemsg-group) Replacement message group. type: str more...
- spam_bwl_table (Alias name: spam-bwl-table) Anti-spam black/white list table id. type: str more...
- spam_bword_table (Alias name: spam-bword-table) Anti-spam banned word table id. type: str 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: str 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: str more...
- spam_rbl_table (Alias name: spam-rbl-table) Anti-spam dnsbl table id. type: str more...
- gmail type: dict
- log Enable/disable logging. type: str choices: [disable, enable] more...
- imap type: dict
- action Action for spam email. type: str choices: [pass, tag] more...
- log Enable/disable logging. 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) type: list choices: [subject, header, spaminfo] more...
- mapi type: dict
- msn_hotmail (Alias name: msn-hotmail) type: dict
- log Enable/disable logging. type: str choices: [disable, enable] more...
- pop3 type: dict
- action Action for spam email. type: str choices: [pass, tag] more...
- log Enable/disable logging. 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) type: list 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 (Alias name: local-override) Enable/disable local filter to override smtp remote check result. type: str choices: [disable, enable] more...
- log Enable/disable logging. 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) type: list choices: [subject, header, spaminfo] more...
- yahoo_mail (Alias name: yahoo-mail) type: dict
- log Enable/disable logging. 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
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure AntiSpam profiles.
fortinet.fortimanager.fmgr_spamfilter_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]>
spamfilter_profile:
comment: <string>
external: <value in [disable, enable]>
flow_based: <value in [disable, enable]>
name: <string>
options:
- bannedword
- spamemailbwl
- spamfsip
- spamfssubmit
- spamfschksum
- spamfsurl
- spamhelodns
- spamipbwl
- spamraddrdns
- spamrbl
- spamhdrcheck
- spamfsphish
- spambwl
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>
gmail:
log: <value in [disable, enable]>
imap:
action: <value in [pass, tag]>
log: <value in [disable, enable]>
tag_msg: <string>
tag_type:
- subject
- header
- spaminfo
mapi:
action: <value in [pass, discard]>
log: <value in [disable, enable]>
msn_hotmail:
log: <value in [disable, enable]>
pop3:
action: <value in [pass, tag]>
log: <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]>
tag_msg: <string>
tag_type:
- subject
- header
- spaminfo
yahoo_mail:
log: <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.