faz_cli_system_sql – SQL settings.

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_system_sql - SQL settings. type: dict
• background_rebuild - Disable/Enable rebuild SQL database in the background. type: str choices: [disable, enable] default: enable more...

  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

• custom_index - No description for the parameter type: array more...

  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

  • case_sensitive - Disable/Enable case sensitive index. type: str choices: [disable, enable] default: disable more...

    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

  • device_type - Device type. type: str choices: [FortiGate, FortiMail, FortiWeb, FortiManager, FortiClient, FortiCache, FortiSandbox, FortiDDoS, FortiAuthenticator, FortiProxy] default: FortiGate more...

    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

  • id - Add or Edit log index fields. type: int default: 0 more...

    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

  • index_field - Log field name to be indexed. type: str more...

    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

  • log_type - Log type. type: str choices: [app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, none, siem, ztna, security] default: app-ctrl more...

    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

• custom_skipidx - No description for the parameter type: array more...

  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	False	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

  • device_type - Device type. type: str choices: [FortiGate, FortiManager, FortiClient, FortiMail, FortiWeb, FortiSandbox, FortiProxy] default: FortiGate more...

    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	False	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

  • id - Add or Edit log index fields. type: int default: 0 more...

    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	False	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

  • index_field - Field to be added to skip index. type: str more...

    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	False	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

  • log_type - Log type. type: str choices: [app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem, ztna, security] default: app-ctrl more...

    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	False	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

• database_name - Database name. type: str more...

  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

• database_type - Database type. type: str choices: [mysql, postgres] default: postgres more...

  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

• device_count_high - Must set to enable if the count of registered devices is greater than 8000. type: str choices: [disable, enable] default: disable more...

  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

• event_table_partition_time - Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs. type: int default: 0 more...

  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

• fct_table_partition_time - Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs. type: int default: 240 more...

  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

• logtype - No description for the parameter type: array choices: [none, app-ctrl, attack, content, dlp, emailfilter, event, generic, history, traffic, virus, voip, webfilter, netscan, fct-event, fct-traffic, fct-netscan, waf, gtp, dns, ssh, ssl, file-filter, asset, protocol, siem, ztna, security] more...

  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

• password - No description for the parameter type: str more...

  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

• prompt_sql_upgrade - Prompt to convert log database into SQL database at start time on GUI. type: str choices: [disable, enable] default: enable more...

  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

• rebuild_event - Disable/Enable rebuild event during SQL database rebuilding. type: str choices: [disable, enable] default: enable more...

  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	False	False

• rebuild_event_start_time - No description for the parameter type: str more...

  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	False	False

• server - Database IP or hostname. type: str more...

  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

• start_time - No description for the parameter type: str more...

  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

• status - SQL database status. type: str choices: [disable, local] default: local more...

  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

• text_search_index - Disable/Enable text search index. type: str choices: [disable, enable] default: disable more...

  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

• traffic_table_partition_time - Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs. type: int default: 0 more...

  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

• ts_index_field - No description for the parameter type: array more...

  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

  • category - Category of text search index fields. type: str more...

    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

  • value - Fields of text search index. type: str more...

    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

• username - User name for login remote database. type: str more...

  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

• utm_table_partition_time - Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs. type: int default: 0 more...

  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

• compress_table_min_age - Minimum age in days for SQL tables to be compressed. type: int default: 7 more...

  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	False	False	False	None	False	False	False	False	False	False	False	False
  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	False	False	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

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: SQL settings.
      fortinet.fortianalyzer.faz_cli_system_sql:
        cli_system_sql:
          background_rebuild: disable
          # database_name: <value of string>
          # database_type: mysql
          # device_count_high: disable
          # password: foopass
          # prompt_sql_upgrade: disable
          # rebuild_event: disable
          # rebuild_event_start_time: <value of string>
          # server: foo.bar.baz
          # start_time: <value of string>
          # status: disable
          # text_search_index: disable
          # traffic_table_partition_time: <value of integer>
          # ts_index_field:
          #   - category: <value of string>
          #     value: <value of string>
          # username: fooadmin
          # utm_table_partition_time: <value of integer>
  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.