fmgr_spamfilter_profile – Configure AntiSpam profiles.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device by allowing the user to [add, get, set, update] the following FortiManager json-rpc urls.
- /pm/config/adom/{adom}/obj/spamfilter/profile
- /pm/config/global/obj/spamfilter/profile
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.10.0
Parameters¶
- loose_validation - Do parameter validation in a loose way type: bool required: false default: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom dom
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- url_params - parameters in url path type: dict required: true
- adom - the domain prefix type: str choices: none, global, custom dom
- parameters for method: [add, set, update] - Configure AntiSpam profiles.
- data - No description for the parameter type: array
- comment - Comment. type: str
- external - Enable/disable external Email inspection. type: str choices: [disable, enable]
- flow-based - Enable/disable flow-based spam filtering. type: str choices: [disable, enable]
- name - Profile name. type: str
- options - No description for the parameter type: array
- {no-name} - No description for the parameter type: str choices: [bannedword, spamemailbwl, spamfsip, spamfssubmit, spamfschksum, spamfsurl, spamhelodns, spamipbwl, spamraddrdns, spamrbl, spamhdrcheck, spamfsphish, spambwl]
- replacemsg-group - Replacement message group. type: str
- spam-bwl-table - Anti-spam black/white list table ID. type: str
- spam-bword-table - Anti-spam banned word table ID. type: str
- spam-bword-threshold - Spam banned word threshold. type: int
- spam-filtering - Enable/disable spam filtering. type: str choices: [disable, enable]
- spam-iptrust-table - Anti-spam IP trust table ID. type: str
- spam-log - Enable/disable spam logging for email filtering. type: str choices: [disable, enable]
- spam-log-fortiguard-response - Enable/disable logging FortiGuard spam response. type: str choices: [disable, enable]
- spam-mheader-table - Anti-spam MIME header table ID. type: str
- spam-rbl-table - Anti-spam DNSBL table ID. type: str
- parameters for method: [get] - Configure AntiSpam profiles.
- attr - The name of the attribute to retrieve its datasource. type: str
- fields - No description for the parameter type: array
- {no-name} - No description for the parameter type: array
- {no-name} - No description for the parameter type: str choices: [comment, external, flow-based, name, options, replacemsg-group, spam-bwl-table, spam-bword-table, spam-bword-threshold, spam-filtering, spam-iptrust-table, spam-log, spam-log-fortiguard-response, spam-mheader-table, spam-rbl-table]
- {no-name} - No description for the parameter type: array
- filter - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- get used - No description for the parameter type: int
- loadsub - Enable or disable the return of any sub-objects. type: int
- option - Set fetch option for the request. type: str choices: [count, object member, datasrc, get reserved, syntax]
- range - No description for the parameter type: array
- {no-name} - No description for the parameter type: int
- sortings - No description for the parameter type: array
- {attr_name} - No description for the parameter type: int choices: [1, -1]
Notes¶
Note
- The module may supports multiple method, every method has different parameters definition
- One method may also have more than one parameter definition collection, each collection is dedicated to one API endpoint
- The module may include domain dependent urls, the domain can be specified in url_params as adom
- To run in workspace mode, the paremeter workspace_locking_adom must be included in the task
Examples¶
- 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: REQUESTING /PM/CONFIG/OBJ/SPAMFILTER/PROFILE
fmgr_spamfilter_profile:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [add, set, update]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
data:
-
comment: <value of string>
external: <value in [disable, enable]>
flow-based: <value in [disable, enable]>
name: <value of string>
options:
- <value in [bannedword, spamemailbwl, spamfsip, ...]>
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>
- name: REQUESTING /PM/CONFIG/OBJ/SPAMFILTER/PROFILE
fmgr_spamfilter_profile:
loose_validation: False
workspace_locking_adom: <value in [global, custom adom]>
workspace_locking_timeout: 300
method: <value in [get]>
url_params:
adom: <value in [none, global, custom dom]>
params:
-
attr: <value of string>
fields:
-
- <value in [comment, external, flow-based, ...]>
filter:
- <value of string>
get used: <value of integer>
loadsub: <value of integer>
option: <value in [count, object member, datasrc, ...]>
range:
- <value of integer>
sortings:
-
varidic.attr_name: <value in [1, -1]>
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:
- return values for method: [add, set, update]
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/obj/spamfilter/profile
- return values for method: [get]
- data
- No description for the parameter type: array
- comment - Comment. type: str
- external - Enable/disable external Email inspection. type: str
- flow-based - Enable/disable flow-based spam filtering. type: str
- name - Profile name. type: str
- options - No description for the parameter type: array
- {no-name} - No description for the parameter type: str
- replacemsg-group - Replacement message group. type: str
- spam-bwl-table - Anti-spam black/white list table ID. type: str
- spam-bword-table - Anti-spam banned word table ID. type: str
- spam-bword-threshold - Spam banned word threshold. type: int
- spam-filtering - Enable/disable spam filtering. type: str
- spam-iptrust-table - Anti-spam IP trust table ID. type: str
- spam-log - Enable/disable spam logging for email filtering. type: str
- spam-log-fortiguard-response - Enable/disable logging FortiGuard spam response. type: str
- spam-mheader-table - Anti-spam MIME header table ID. type: str
- spam-rbl-table - Anti-spam DNSBL table ID. type: str
- status
- No description for the parameter type: dict
- code - No description for the parameter type: int
- message - No description for the parameter type: str
- url - No description for the parameter type: str example: /pm/config/adom/{adom}/obj/spamfilter/profile