faz_cli_system_sql – SQL settings.
Added 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.nameCorresponding 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
Supported Version Ranges: v6.2.1 -> latest
Parameters
- access_token The token to access FortiAnalyzer without using ansible_username and ansible_password. type: str
- bypass_validation Only set to True when module schema diffs with FortiAnalyzer API structure, module continues to execute without validating parameters type: bool default: False
- enable_log Enable/Disable logging for task type: bool default: False
- forticloud_access_token Access token of forticloud analyzer API users. type: str
- 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 default: "/tmp/fortianalyzer.ansible.log"
- proposed_method The overridden method for the underlying Json RPC request type: str choices: set, update, add
- version_check If set to True, it will check whether the parameters used are supported by the corresponding version of FortiAnazlyer locally based on FNDN data. A warning will be returned in version_check_warning if there is a mismatch. This warning is only a suggestion and may not be accurate. type: bool default: False
- rc_succeeded The rc codes list with which the conditions to succeed will be overriden type: list
- rc_failed The rc codes list with which the conditions to fail will be overriden type: list
- 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...
- custom_index type: list of dict
more...
- case_sensitive Disable/Enable case sensitive index. type: str choices: [disable, enable] default: disable more...
- device_type Device type. type: str choices: [FortiGate, FortiMail, FortiWeb, FortiManager, FortiClient, FortiCache, FortiSandbox, FortiDDoS, FortiAuthenticator, FortiProxy] default: FortiGate more...
- id Add or Edit log index fields. type: int default: 0 more...
- index_field Log field name to be indexed. type: str more...
- 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...
- custom_skipidx type: list of dict
more...
- device_type Device type. type: str choices: [FortiGate, FortiManager, FortiClient, FortiMail, FortiWeb, FortiSandbox, FortiProxy] default: FortiGate more...
- id Add or Edit log index fields. type: int default: 0 more...
- index_field Field to be added to skip index. type: str more...
- 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...
- database_name Database name. type: str more...
- database_type Database type. type: str choices: [mysql, postgres] default: postgres more...
- 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...
- event_table_partition_time Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs. type: int default: 0 more...
- fct_table_partition_time Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs. type: int default: 240 more...
- logtype Log type. type: list elements: str 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...
- password Password for login remote database. type: str elements: str more...
- prompt_sql_upgrade Prompt to convert log database into SQL database at start time on GUI. type: str choices: [disable, enable] default: enable more...
- rebuild_event Disable/Enable rebuild event during SQL database rebuilding. type: str choices: [disable, enable] default: enable more...
- rebuild_event_start_time Rebuild event starting date and time <hh:mm yyyy/mm/dd>. type: str elements: str more...
- server Database IP or hostname. type: str more...
- start_time Start date and time <hh:mm yyyy/mm/dd>. type: str elements: str more...
- status SQL database status. type: str choices: [disable, local] default: local more...
- text_search_index Disable/Enable text search index. type: str choices: [disable, enable] default: disable more...
- traffic_table_partition_time Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs. type: int default: 0 more...
- ts_index_field type: list of dict more...
- username User name for login remote database. type: str more...
- utm_table_partition_time Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs. type: int default: 0 more...
- compress_table_min_age Minimum age in days for SQL tables to be compressed. type: int default: 7 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: 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_network_os: fortinet.fortianalyzer.fortianalyzer
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.