faz_cli_fmupdate_webspam_fgdsetting – Configure the FortiGuard run parameters.

New in version 1.0.0.

Warning

Starting in version 2.0.0, all variables will be named in the underscore naming convention.

  • Possible variable names before 2.0.0: variable-name, variable name, variable.name

  • Corresponding variable names since 2.0.0: variable_name

FortiAnalyzer Ansible v1.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 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.15.0

FortiAnalyzer Version Compatibility


6.2.0 6.2.1 6.2.2 6.2.3 6.2.4 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11 6.2.12
None True True True None True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12 6.4.13 6.4.14
None True True True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8 7.0.9 7.0.10 7.0.11
True True True True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3 7.2.4
True True True True True
7.4.0 7.4.1 7.4.2
True True True

Parameters

  • access_token -The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str required: false
  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud analyzer API users. type: str required: false
  • log_path - The path to save log. Used if enable_log is true. Please use absolute path instead of relative path. If the log_path setting is incorrect, the log will be saved in /tmp/fortianalyzer.ansible.logtype: str required: false default: "/tmp/fortianalyzer.ansible.log"
  • 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...
    • as_log - Antispam log setting (default = nospam). type: str choices: [disable, nospam, all] default: nospam more...
    • as_preload - Enable/disable preloading antispam database to memory (default = disable). type: str choices: [disable, enable] default: disable more...
    • av_cache - Antivirus service maximum memory usage, in megabytes (100 - 500, default = 300). type: int default: 300 more...
    • av_log - Antivirus log setting (default = novirus). type: str choices: [disable, novirus, all] default: novirus more...
    • av_preload - Enable/disable preloading antivirus database to memory (default = disable). type: str choices: [disable, enable] default: disable more...
    • av2_cache - Antispam service maximum memory usage in megabytes (Maximum = Physical memory-1024, 0: no limit, default = 800). type: int default: 800 more...
    • av2_log - Outbreak prevention log setting (default = noav2). type: str choices: [disable, noav2, all] default: noav2 more...
    • av2_preload - Enable/disable preloading outbreak prevention database to memory (default = disable). type: str choices: [disable, enable] default: disable more...
    • eventlog_query - Enable/disable record query to event-log besides fgd-log (default = disable). type: str choices: [disable, enable] default: disable more...
    • fgd_pull_interval - Fgd pull interval setting, in minutes (1 - 1440, default = 10). type: int default: 10 more...
    • fq_cache - File query service maximum memory usage, in megabytes (100 - 500, default = 300). type: int default: 300 more...
    • fq_log - File query log setting (default = nofilequery). type: str choices: [disable, nofilequery, all] default: nofilequery more...
    • fq_preload - Enable/disable preloading file query database to memory (default = disable). type: str choices: [disable, enable] default: disable more...
    • linkd_log - Linkd log setting (default = debug). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: debug more...
    • max_client_worker - max worker for tcp client connection (0~16: 0 means use cpu number up to 4). type: int default: 0 more...
    • max_log_quota - Maximum log quota setting, in megabytes (100 - 20480, default = 6144). type: int default: 6144 more...
    • max_unrated_site - Maximum number of unrated site in memory, in kilobytes(10 - 5120, default = 500). type: int default: 500 more...
    • restrict_as1_dbver - Restrict system update to indicated antispam(1) database version (character limit = 127). type: str more...
    • restrict_as2_dbver - Restrict system update to indicated antispam(2) database version (character limit = 127). type: str more...
    • restrict_as4_dbver - Restrict system update to indicated antispam(4) database version (character limit = 127). type: str more...
    • restrict_av_dbver - Restrict system update to indicated antivirus database version (character limit = 127). type: str more...
    • restrict_av2_dbver - Restrict system update to indicated outbreak prevention database version (character limit = 127). type: str more...
    • restrict_fq_dbver - Restrict system update to indicated file query database version (character limit = 127). type: str more...
    • restrict_wf_dbver - Restrict system update to indicated web filter database version (character limit = 127). type: str more...
    • server_override type: dict
      • servlist - No description for the parameter type: array more...
        • id - Override server ID (1 - 10). type: int default: 0 more...
        • ip - IPv4 address of the override server. type: str default: 0.0.0.0 more...
        • ip6 - IPv6 address of the override server. type: str default: :: more...
        • port - Port number to use when contacting FortiGuard (1 - 65535, default = 443). type: int default: 443 more...
        • service_type - Override service type. type: str choices: [fgd, fgc, fsa, fgfq, geoip, iot-collect] more...
      • status - Override status. type: str choices: [disable, enable] default: disable more...
    • stat_log_interval - Statistic log interval setting, in minutes (1 - 1440, default = 60). type: int default: 60 more...
    • stat_sync_interval - Synchronization interval for statistic of unrated site in minutes (1 - 60, default = 60). type: int default: 60 more...
    • update_interval - FortiGuard database update wait time if not enough delta files, in hours (2 - 24, default = 6). type: int default: 6 more...
    • update_log - Enable/disable update log setting (default = enable). type: str choices: [disable, enable] default: enable more...
    • wf_cache - Web filter service maximum memory usage, in megabytes (maximum = Physical memory-1024, 0 = no limit, default = 600). type: int default: 0 more...
    • wf_dn_cache_expire_time - Web filter DN cache expire time, in minutes (1 - 1440, 0 = never, default = 30). type: int default: 30 more...
    • wf_dn_cache_max_number - Maximum number of Web filter DN cache (0 = disable, default = 10000). type: int default: 10000 more...
    • wf_log - Web filter log setting (default = nour1) type: str choices: [disable, nourl, all] default: nourl more...
    • wf_preload - Enable/disable preloading the web filter database into memory (default = disable). type: str choices: [disable, enable] default: enable more...
    • iot_cache - IoT service maximum memory usage, in megabytes (100 - 500, default = 300). type: int default: 300 more...
    • iot_log - IoT log setting (default = nofilequery). type: str choices: [disable, nofilequery, all] default: nofilequery more...
    • iot_preload - Enable/disable preloading IoT database to memory (default = disable). type: str choices: [disable, enable] default: disable more...
    • restrict_iots_dbver - Restrict system update to indicated file query database version (character limit = 127). type: str more...
    • stat_log - stat log setting (default = disable). type: str choices: [emergency, alert, critical, error, warn, notice, info, debug, disable] default: disable more...
    • iotv_preload - Enable/disable preloading IoT-Vulnerability database to memory (default = disable). type: str choices: [disable, enable] default: disable more...

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

- name: Example playbook
  connection: httpapi
  hosts: fortianalyzers
  tasks:
    - name: Configure the FortiGuard run parameters.
      fortinet.fortianalyzer.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
  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:

  • 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 fortianalyzer version. returned: if params are not supported in the current version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • 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.