fmgr_system_sql – SQL settings.
Added in version 2.0.0.
Warning
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
Argument name before 3.0.0:
var-name,var name,var.nameNew argument name starting in 3.0.0:
var_name
FortiManager Ansible v2.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 FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.
Tested with FortiManager v6.x and v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible>=2.15.0
FortiManager Version Compatibility
Supported Version Ranges: v6.0.0 -> latest
Parameters
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- system_sql - SQL settings. type: dict
- background_rebuild (Alias name: background-rebuild) Disable/enable rebuild sql database in the background. type: str choices: [disable, enable] default: enable more...
- custom_index (Alias name: custom-index) Custom-index. type: list
more...
- case_sensitive (Alias name: case-sensitive) Disable/enable case sensitive index. type: str choices: [disable, enable] default: disable more...
- device_type (Alias name: device-type) Device type. type: str choices: [FortiGate, FortiManager, FortiClient, FortiMail, FortiWeb, FortiCache, FortiSandbox, FortiDDoS, FortiAuthenticator, FortiProxy] default: FortiGate more...
- id Add or edit log index fields. type: int default: 0 more...
- index_field (Alias name: index-field) Log field name to be indexed. type: str more...
- log_type (Alias name: log-type) Log type. type: 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] default: traffic more...
- database_name (Alias name: database-name) Database name. type: str more...
- database_type (Alias name: database-type) Database type. type: str choices: [mysql, postgres] default: postgres more...
- device_count_high (Alias name: 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 (Alias name: 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 (Alias name: 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 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: list more...
- prompt_sql_upgrade (Alias name: 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 (Alias name: rebuild-event) Disable/enable rebuild event during sql database rebuilding. type: str choices: [disable, enable] default: enable more...
- rebuild_event_start_time (Alias name: rebuild-event-start-time) Rebuild event starting date and time
- server Database ip or hostname. type: str more...
- start_time (Alias name: start-time) Start date and time
- status Sql database status. type: str choices: [disable, local] default: local more...
- text_search_index (Alias name: text-search-index) Disable/enable text search index. type: str choices: [disable, enable] default: disable more...
- traffic_table_partition_time (Alias name: 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 (Alias name: ts-index-field) Ts-index-field. type: list more...
- username User name for login remote database. type: str more...
- utm_table_partition_time (Alias name: utm-table-partition-time) Maximum sql database table partitioning time range in minute (0 for unlimited) for utm logs. type: int default: 0 more...
- custom_skipidx (Alias name: custom-skipidx) Custom-skipidx. type: list
more...
- device_type (Alias name: 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 (Alias name: index-field) Field to be added to skip index. type: str more...
- log_type (Alias name: 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...
- compress_table_min_age (Alias name: compress-table-min-age) Minimum age in days for sql tables to be compressed. type: int default: 7 more...
Notes
Note
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.
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 (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: 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 FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.