faz_cli_fmupdate_webspam_fgdsetting – Configure the FortiGuard run parameters.¶

New in version 2.10.

Synopsis
Requirements
FortiAnalyzer Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis ¶

This module is able to configure a FortiAnalyzer device.
Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

FortiAnalyzer Version Compatibility ¶

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

cli_fmupdate_webspam_fgdsetting yes yes yes yes yes yes yes yes yes yes yes yes

Parameters ¶

enable_log - Enable/Disable logging for task type: bool required: false default: False
proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
bypass_validation - Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool required: false default: False
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
cli_fmupdate_webspam_fgdsetting - Configure the FortiGuard run parameters. type: dict

as-cache - Antispam service maximum memory usage in megabytes (Maximum = Physical memory-1024, 0: no limit, default = 300). type: int default: 300 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

as-cache True True True True True True True True True True True True
as-log - Antispam log setting (default = nospam). type: str choices: [disable, nospam, all] default: nospam more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

as-log True True True True True True True True True True True True
as-preload - Enable/disable preloading antispam database to memory (default = disable). type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

as-preload True True True True True True True True True True True True
av-cache - Antivirus service maximum memory usage, in megabytes (100 - 500, default = 300). type: int default: 300 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

av-cache True True True True True True True True True True True True
av-log - Antivirus log setting (default = novirus). type: str choices: [disable, novirus, all] default: novirus more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

av-log True True True True True True True True True True True True
av-preload - Enable/disable preloading antivirus database to memory (default = disable). type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

av-preload True True True True True True True True True True True True
av2-cache - Antispam service maximum memory usage in megabytes (Maximum = Physical memory-1024, 0: no limit, default = 800). type: int default: 800 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

av2-cache True True True True True True True True True True True True
av2-log - Outbreak prevention log setting (default = noav2). type: str choices: [disable, noav2, all] default: noav2 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

av2-log True True True True True True True True True True True True
av2-preload - Enable/disable preloading outbreak prevention database to memory (default = disable). type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

av2-preload True True True True True True True True True True True True
eventlog-query - Enable/disable record query to event-log besides fgd-log (default = disable). type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

eventlog-query True True True True True True True True True True True True
fgd-pull-interval - Fgd pull interval setting, in minutes (1 - 1440, default = 10). type: int default: 10 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fgd-pull-interval True True True True True True True True True True True True
fq-cache - File query service maximum memory usage, in megabytes (100 - 500, default = 300). type: int default: 300 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fq-cache True True True True True True True True True True True True
fq-log - File query log setting (default = nofilequery). type: str choices: [disable, nofilequery, all] default: nofilequery more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fq-log True True True True True True True True True True True True
fq-preload - Enable/disable preloading file query database to memory (default = disable). type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

fq-preload True True True True True True True True True True True True
linkd-log - Linkd log setting (default = debug). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: debug more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

linkd-log True True True True True True True True True True True True
max-client-worker - max worker for tcp client connection (0~16: 0 means use cpu number up to 4). type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

max-client-worker True True True True True True True True True True True True
max-log-quota - Maximum log quota setting, in megabytes (100 - 20480, default = 6144). type: int default: 6144 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

max-log-quota True True True True True True True True True True True True
max-unrated-site - Maximum number of unrated site in memory, in kilobytes(10 - 5120, default = 500). type: int default: 500 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

max-unrated-site True True True True True True True True True True True True
restrict-as1-dbver - Restrict system update to indicated antispam(1) database version (character limit = 127). type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

restrict-as1-dbver True True True True True True True True True True True True
restrict-as2-dbver - Restrict system update to indicated antispam(2) database version (character limit = 127). type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

restrict-as2-dbver True True True True True True True True True True True True
restrict-as4-dbver - Restrict system update to indicated antispam(4) database version (character limit = 127). type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

restrict-as4-dbver True True True True True True True True True True True True
restrict-av-dbver - Restrict system update to indicated antivirus database version (character limit = 127). type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

restrict-av-dbver True True True True True True True True True True True True
restrict-av2-dbver - Restrict system update to indicated outbreak prevention database version (character limit = 127). type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

restrict-av2-dbver True True True True True True True True True True True True
restrict-fq-dbver - Restrict system update to indicated file query database version (character limit = 127). type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

restrict-fq-dbver True True True True True True True True True True True True
restrict-wf-dbver - Restrict system update to indicated web filter database version (character limit = 127). type: str more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

restrict-wf-dbver True True True True True True True True True True True True
server-override type: dict

servlist - No description for the parameter type: array more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

servlist True True True True True True True True True True True True
- id - Override server ID (1 - 10). type: int default: 0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True True True True
- ip - IPv4 address of the override server. type: str default: 0.0.0.0 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  ip True True True True True True True True True True True True
- ip6 - IPv6 address of the override server. type: str default: :: more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  ip6 True True True True True True True True True True True True
- port - Port number to use when contacting FortiGuard (1 - 65535, default = 443). type: int default: 443 more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  port True True True True True True True True True True True True
- service-type - Override service type. type: str choices: [fgd, fgc, fsa, fgfq, geoip] more...
  
  6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0
  
  service-type True True True True True True True True True True True True
status - Override status. type: str choices: [disable, enable] default: disable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

status True True True True True True True True True True True True

stat-log-interval - Statistic log interval setting, in minutes (1 - 1440, default = 60). type: int default: 60 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

stat-log-interval True True True True True True True True True True True True
stat-sync-interval - Synchronization interval for statistic of unrated site in minutes (1 - 60, default = 60). type: int default: 60 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

stat-sync-interval True True True True True True True True True True True True
update-interval - FortiGuard database update wait time if not enough delta files, in hours (2 - 24, default = 6). type: int default: 6 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

update-interval True True True True True True True True True True True True
update-log - Enable/disable update log setting (default = enable). type: str choices: [disable, enable] default: enable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

update-log True True True True True True True True True True True True
wf-cache - Web filter service maximum memory usage, in megabytes (maximum = Physical memory-1024, 0 = no limit, default = 600). type: int default: 0 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

wf-cache True True True True True True True True True True True True
wf-dn-cache-expire-time - Web filter DN cache expire time, in minutes (1 - 1440, 0 = never, default = 30). type: int default: 30 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

wf-dn-cache-expire-time True True True True True True True True True True True True
wf-dn-cache-max-number - Maximum number of Web filter DN cache (0 = disable, default = 10000). type: int default: 10000 more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

wf-dn-cache-max-number True True True True True True True True True True True True
wf-log - Web filter log setting (default = nour1) type: str choices: [disable, nourl, all] default: nourl more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

wf-log True True True True True True True True True True True True
wf-preload - Enable/disable preloading the web filter database into memory (default = disable). type: str choices: [disable, enable] default: enable more...

6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 7.0.0 7.2.0

wf-preload True True True True True True True True True True True True
iot-cache - IoT service maximum memory usage, in megabytes (100 - 500, default = 300). type: int default: 300 more...

7.2.0

iot-cache True
iot-log - IoT log setting (default = nofilequery). type: str choices: [disable, nofilequery, all] default: nofilequery more...

7.2.0

iot-log True
iot-preload - Enable/disable preloading IoT database to memory (default = disable). type: str choices: [disable, enable] default: disable more...

7.2.0

iot-preload True
restrict-iots-dbver - Restrict system update to indicated file query database version (character limit = 127). type: str more...

7.2.0

restrict-iots-dbver True

Notes ¶

Note

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 ¶

- collections:
  - fortinet.fortianalyzer
  connection: httpapi
  hosts: fortianalyzer-inventory
  tasks:
  - faz_cli_fmupdate_webspam_fgdsetting:
      cli_fmupdate_webspam_fgdsetting:
        as-preload: disable
        av-preload: disable
        av2-preload: disable
        eventlog-query: disable
        fq-preload: disable
        update-log: disable
        wf-preload: disable
    name: Configure the FortiGuard run parameters.
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false

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:

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_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.