fortinet.fortimanager.fmgr_system_sql module – SQL settings.
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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_system_sql
.
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:
|
|
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 top level parameters set. |
|
Deprecated, please rename it to background_rebuild. Disable/Enable rebuild SQL database in the background. disable - Rebuild SQL database not in the background. enable - Rebuild SQL database in the background. Choices:
|
|
Deprecated, please rename it to compress_table_min_age. Minimum age in days for SQL tables to be compressed. |
|
Deprecated, please rename it to custom_index. Custom index. |
|
Deprecated, please rename it to case_sensitive. Disable/Enable case sensitive index. disable - Build a case insensitive index. enable - Build a case sensitive index. Choices:
|
|
Deprecated, please rename it to device_type. Device type. FortiGate - Device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient FortiMail - Device type to FortiMail. FortiWeb - Device type to FortiWeb. FortiCache - Set device type to FortiCache FortiSandbox - Set device type to FortiSandbox FortiDDoS - Set device type to FortiDDoS FortiAuthenticator - Set device type to FortiAuthenticator FortiProxy - Set device type to FortiProxy Choices:
|
|
Add or Edit log index fields. |
|
Deprecated, please rename it to index_field. Log field name to be indexed. |
|
Deprecated, please rename it to log_type. Log type. none - 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 Choices:
|
|
Deprecated, please rename it to custom_skipidx. Custom skipidx. |
|
Deprecated, please rename it to device_type. Device type. FortiGate - Set device type to FortiGate. FortiManager - Set device type to FortiManager FortiClient - Set device type to FortiClient. FortiMail - Set device type to FortiMail. FortiWeb - Set device type to FortiWeb. FortiSandbox - Set device type to FortiSandbox FortiProxy - Set device type to FortiProxy Choices:
|
|
Add or Edit log index fields. |
|
Deprecated, please rename it to index_field. Field to be added to skip index. |
|
Deprecated, please rename it to log_type. Log type. 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 Choices:
|
|
Deprecated, please rename it to database_name. Database name. |
|
Deprecated, please rename it to database_type. Database type. mysql - MySQL database. postgres - PostgreSQL local database. Choices:
|
|
Deprecated, please rename it to device_count_high. Must set to enable if the count of registered devices is greater than 8000. disable - Set to disable if device count is less than 8000. enable - Set to enable if device count is equal to or greater than 8000. Choices:
|
|
Deprecated, please rename it to event_table_partition_time. Maximum SQL database table partitioning time range in minute |
|
Deprecated, please rename it to fct_table_partition_time. Maximum SQL database table partitioning time range in minute |
|
Log type. none - 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 Choices:
|
|
(list) Password for login remote database. |
|
Deprecated, please rename it to prompt_sql_upgrade. Prompt to convert log database into SQL database at start time on GUI. disable - Do not prompt to upgrade log database to SQL database at start time on GUI. enable - Prompt to upgrade log database to SQL database at start time on GUI. Choices:
|
|
Deprecated, please rename it to rebuild_event. Disable/Enable rebuild event during SQL database rebuilding. disable - Do not rebuild event during SQL database rebuilding. enable - Rebuild event during SQL database rebuilding. Choices:
|
|
(list) Deprecated, please rename it to rebuild_event_start_time. Rebuild event starting date and time |
|
Database IP or hostname. |
|
(list) Deprecated, please rename it to start_time. Start date and time |
|
SQL database status. disable - Disable SQL database. local - Enable local database. Choices:
|
|
Deprecated, please rename it to text_search_index. Disable/Enable text search index. disable - Do not create text search index. enable - Create text search index. Choices:
|
|
Deprecated, please rename it to traffic_table_partition_time. Maximum SQL database table partitioning time range in minute |
|
Deprecated, please rename it to ts_index_field. Ts index field. |
|
Category of text search index fields. |
|
Fields of text search index. |
|
User name for login remote database. |
|
Deprecated, please rename it to utm_table_partition_time. Maximum SQL database table partitioning time range in minute |
|
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: SQL settings.
fortinet.fortimanager.fmgr_system_sql:
# 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, ...]
system_sql:
background_rebuild: <value in [disable, enable]>
custom_index:
-
case_sensitive: <value in [disable, enable]>
device_type: <value in [FortiGate, FortiManager, FortiClient, ...]>
id: <integer>
index_field: <string>
log_type: <value in [none, app-ctrl, attack, ...]>
database_name: <string>
database_type: <value in [mysql, postgres]>
device_count_high: <value in [disable, enable]>
event_table_partition_time: <integer>
fct_table_partition_time: <integer>
logtype:
- 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
password: <list or string>
prompt_sql_upgrade: <value in [disable, enable]>
rebuild_event: <value in [disable, enable]>
rebuild_event_start_time: <list or string>
server: <string>
start_time: <list or string>
status: <value in [disable, local]>
text_search_index: <value in [disable, enable]>
traffic_table_partition_time: <integer>
ts_index_field:
-
category: <string>
value: <string>
username: <string>
utm_table_partition_time: <integer>
custom_skipidx:
-
device_type: <value in [FortiGate, FortiManager, FortiClient, ...]>
id: <integer>
index_field: <string>
log_type: <value in [app-ctrl, attack, content, ...]>
compress_table_min_age: <integer>
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 |