fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting module – Configure the FortiGuard run parameters.
Note
This module is part of the fortinet.fortimanager collection (version 2.4.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting.
New in fortinet.fortimanager 2.0.0
Synopsis
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.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Deprecated, please rename it to as_cache. Antispam service maximum memory usage in megabytes |
|
Deprecated, please rename it to as_log. Antispam log setting disable - Disable spam log. nospam - Log non-spam events. all - Log all spam lookups. Choices:
|
|
Deprecated, please rename it to as_preload. Enable/disable preloading antispam database to memory disable - Disable antispam database preload. enable - Enable antispam database preload. Choices:
|
|
Deprecated, please rename it to av_cache. Antivirus service maximum memory usage, in megabytes |
|
Deprecated, please rename it to av_log. Antivirus log setting disable - Disable virus log. novirus - Log non-virus events. all - Log all virus lookups. Choices:
|
|
Deprecated, please rename it to av_preload. Enable/disable preloading antivirus database to memory disable - Disable antivirus database preload. enable - Enable antivirus database preload. Choices:
|
|
Deprecated, please rename it to av2_cache. Antispam service maximum memory usage in megabytes |
|
Deprecated, please rename it to av2_log. Outbreak prevention log setting disable - Disable av2 log. noav2 - Log non-av2 events. all - Log all av2 lookups. Choices:
|
|
Deprecated, please rename it to av2_preload. Enable/disable preloading outbreak prevention database to memory disable - Disable outbreak prevention database preload. enable - Enable outbreak prevention database preload. Choices:
|
|
Deprecated, please rename it to eventlog_query. Enable/disable record query to event-log besides fgd-log disable - Record query to event-log besides fgd-log. enable - Do not log to event-log. Choices:
|
|
Deprecated, please rename it to fgd_pull_interval. Fgd pull interval setting, in minutes |
|
Deprecated, please rename it to fq_cache. File query service maximum memory usage, in megabytes |
|
Deprecated, please rename it to fq_log. File query log setting disable - Disable file query log. nofilequery - Log non-file query events. all - Log all file query events. Choices:
|
|
Deprecated, please rename it to fq_preload. Enable/disable preloading file query database to memory disable - Disable file query db preload. enable - Enable file query db preload. Choices:
|
|
Deprecated, please rename it to iot_cache. IoT service maximum memory usage, in megabytes |
|
Deprecated, please rename it to iot_log. IoT log setting disable - Disable IoT log. nofilequery - Log non-IoT events. all - Log all IoT events. Choices:
|
|
Deprecated, please rename it to iot_preload. Enable/disable preloading IoT database to memory disable - Disable IoT db preload. enable - Enable IoT db preload. Choices:
|
|
Deprecated, please rename it to iotv_preload. Enable/disable preloading IoT-Vulnerability database to memory disable - Disable IoT-Vulnerability db preload. enable - Enable IoT-Vulnerability db preload. Choices:
|
|
Deprecated, please rename it to linkd_log. Linkd log setting emergency - The unit is unusable. alert - Immediate action is required critical - Functionality is affected. error - Functionality is probably affected. warn - Functionality might be affected. notice - Information about normal events. info - General information. debug - Debug information. disable - Linkd logging is disabled. Choices:
|
|
Deprecated, please rename it to max_client_worker. Max worker for tcp client connection |
|
Deprecated, please rename it to max_log_quota. Maximum log quota setting, in megabytes |
|
Deprecated, please rename it to max_unrated_site. Maximum number of unrated site in memory, in kilobytes |
|
Deprecated, please rename it to restrict_as1_dbver. Restrict system update to indicated antispam |
|
Deprecated, please rename it to restrict_as2_dbver. Restrict system update to indicated antispam |
|
Deprecated, please rename it to restrict_as4_dbver. Restrict system update to indicated antispam |
|
Deprecated, please rename it to restrict_av_dbver. Restrict system update to indicated antivirus database version |
|
Deprecated, please rename it to restrict_av2_dbver. Restrict system update to indicated outbreak prevention database version |
|
Deprecated, please rename it to restrict_fq_dbver. Restrict system update to indicated file query database version |
|
Deprecated, please rename it to restrict_iots_dbver. Restrict system update to indicated file query database version |
|
Deprecated, please rename it to restrict_wf_dbver. Restrict system update to indicated web filter database version |
|
Deprecated, please rename it to server_override. |
|
Servlist. |
|
Override server ID |
|
IPv4 address of the override server. |
|
IPv6 address of the override server. |
|
Port number to use when contacting FortiGuard |
|
(list or str) Deprecated, please rename it to service_type. Override service type. fgd - Server override config for fgd fgc - Server override config for fgc fsa - Server override config for fsa Choices:
|
|
Override status. disable - Disable setting. enable - Enable setting. Choices:
|
|
Deprecated, please rename it to stat_log. stat log setting emergency - The unit is unusable alert - Immediate action is required critical - Functionality is affected error - Functionality is probably affected warn - Functionality might be affected notice - Information about normal events info - General information debug - Debug information disable - Linkd logging is disabled. Choices:
|
|
Deprecated, please rename it to stat_log_interval. Statistic log interval setting, in minutes |
|
Deprecated, please rename it to stat_sync_interval. Synchronization interval for statistic of unrated site in minutes |
|
Deprecated, please rename it to update_interval. FortiGuard database update wait time if not enough delta files, in hours |
|
Deprecated, please rename it to update_log. Enable/disable update log setting disable - Disable update log. enable - Enable update log. Choices:
|
|
Deprecated, please rename it to wf_cache. Web filter service maximum memory usage, in megabytes |
|
Deprecated, please rename it to wf_dn_cache_expire_time. Web filter DN cache expire time, in minutes |
|
Deprecated, please rename it to wf_dn_cache_max_number. Maximum number of Web filter DN cache |
|
Deprecated, please rename it to wf_log. Web filter log setting disable - Disable URL log. nourl - Log non-URL events. all - Log all URL lookups. Choices:
|
|
Deprecated, please rename it to wf_preload. Enable/disable preloading the web filter database into memory disable - Disable web filter database preload. enable - Enable web filter database preload. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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 the FortiGuard run parameters.
fortinet.fortimanager.fmgr_fmupdate_webspam_fgdsetting:
# 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, ...]
fmupdate_webspam_fgdsetting:
as_cache: <integer>
as_log: <value in [disable, nospam, all]>
as_preload: <value in [disable, enable]>
av_cache: <integer>
av_log: <value in [disable, novirus, all]>
av_preload: <value in [disable, enable]>
av2_cache: <integer>
av2_log: <value in [disable, noav2, all]>
av2_preload: <value in [disable, enable]>
eventlog_query: <value in [disable, enable]>
fgd_pull_interval: <integer>
fq_cache: <integer>
fq_log: <value in [disable, nofilequery, all]>
fq_preload: <value in [disable, enable]>
linkd_log: <value in [emergency, alert, critical, ...]>
max_client_worker: <integer>
max_log_quota: <integer>
max_unrated_site: <integer>
restrict_as1_dbver: <string>
restrict_as2_dbver: <string>
restrict_as4_dbver: <string>
restrict_av_dbver: <string>
restrict_av2_dbver: <string>
restrict_fq_dbver: <string>
restrict_wf_dbver: <string>
server_override:
servlist:
-
id: <integer>
ip: <string>
ip6: <string>
port: <integer>
service_type: # <list or string>
- fgd
- fgc
- fsa
- fgfq
- geoip
- iot-collect
status: <value in [disable, enable]>
stat_log_interval: <integer>
stat_sync_interval: <integer>
update_interval: <integer>
update_log: <value in [disable, enable]>
wf_cache: <integer>
wf_dn_cache_expire_time: <integer>
wf_dn_cache_max_number: <integer>
wf_log: <value in [disable, nourl, all]>
wf_preload: <value in [disable, enable]>
iot_cache: <integer>
iot_log: <value in [disable, nofilequery, all]>
iot_preload: <value in [disable, enable]>
restrict_iots_dbver: <string>
stat_log: <value in [emergency, alert, critical, ...]>
iotv_preload: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |