Try SpotterSQL settings.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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>
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
system_sql:
description: The top level parameters set.
required: false
suboptions:
background-rebuild:
choices:
- disable
- enable
description:
- 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.
type: str
compress-table-min-age:
description: Deprecated, please rename it to compress_table_min_age. Minimum age
in days for SQL tables to be compressed.
type: int
custom-index:
description: Deprecated, please rename it to custom_index. Custom-Index.
elements: dict
suboptions:
case-sensitive:
choices:
- disable
- enable
description:
- Deprecated, please rename it to case_sensitive.
- Disable/Enable case sensitive index.
- disable - Build a case insensitive index.
- enable - Build a case sensitive index.
type: str
device-type:
choices:
- FortiGate
- FortiManager
- FortiClient
- FortiMail
- FortiWeb
- FortiCache
- FortiSandbox
- FortiDDoS
- FortiAuthenticator
- FortiProxy
description:
- 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
type: str
id:
description: Add or Edit log index fields.
type: int
index-field:
description: Deprecated, please rename it to index_field. Log field name to
be indexed.
type: str
log-type:
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
description:
- 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
type: str
type: list
custom-skipidx:
description: Deprecated, please rename it to custom_skipidx. Custom-Skipidx.
elements: dict
suboptions:
device-type:
choices:
- FortiGate
- FortiManager
- FortiClient
- FortiMail
- FortiWeb
- FortiSandbox
- FortiProxy
description:
- 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
type: str
id:
description: Add or Edit log index fields.
type: int
index-field:
description: Deprecated, please rename it to index_field. Field to be added
to skip index.
type: str
log-type:
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
description:
- 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
type: str
type: list
database-name:
description: Deprecated, please rename it to database_name. Database name.
type: str
database-type:
choices:
- mysql
- postgres
description:
- Deprecated, please rename it to database_type.
- Database type.
- mysql - MySQL database.
- postgres - PostgreSQL local database.
type: str
device-count-high:
choices:
- disable
- enable
description:
- 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.
type: str
event-table-partition-time:
description: Deprecated, please rename it to event_table_partition_time. Maximum
SQL database table partitioning time range in minute
type: int
fct-table-partition-time:
description: Deprecated, please rename it to fct_table_partition_time. Maximum
SQL database table partitioning time range in minute
type: int
logtype:
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
description:
- 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
- file-filter
- asset
- protocol
- siem
elements: str
type: list
password:
description: (list) Password for login remote database.
type: raw
prompt-sql-upgrade:
choices:
- disable
- enable
description:
- 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.
type: str
rebuild-event:
choices:
- disable
- enable
description:
- 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.
type: str
rebuild-event-start-time:
description: (list) Deprecated, please rename it to rebuild_event_start_time.
Rebuild event starting date and time
type: raw
server:
description: Database IP or hostname.
type: str
start-time:
description: (list) Deprecated, please rename it to start_time. Start date and
time
type: raw
status:
choices:
- disable
- local
description:
- SQL database status.
- disable - Disable SQL database.
- local - Enable local database.
type: str
text-search-index:
choices:
- disable
- enable
description:
- 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.
type: str
traffic-table-partition-time:
description: Deprecated, please rename it to traffic_table_partition_time. Maximum
SQL database table partitioning time range in minute
type: int
ts-index-field:
description: Deprecated, please rename it to ts_index_field. Ts-Index-Field.
elements: dict
suboptions:
category:
description: Category of text search index fields.
type: str
value:
description: Fields of text search index.
type: str
type: list
username:
description: User name for login remote database.
type: str
utm-table-partition-time:
description: Deprecated, please rename it to utm_table_partition_time. Maximum
SQL database table partitioning time range in minute
type: int
type: dict
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list