fortinet.fortimanager.fmgr_system_sql – SQL settings.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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 version 2.10: of fortinet.fortimanager

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

bypass_validation

boolean

only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

rc_failed

list / elements=string

the rc codes list with which the conditions to fail will be overriden

rc_succeeded

list / elements=string

the rc codes list with which the conditions to succeed will be overriden

state

string / required

the directive to create, update or delete an object

Choices:

  • present

  • absent

system_sql

dictionary

the top level parameters set

background-rebuild

string

Disable/Enable rebuild SQL database in the background.

disable - Rebuild SQL database not in the background.

enable - Rebuild SQL database in the background.

Choices:

  • disable

  • enable ← (default)

compress-table-min-age

integer

Minimum age in days for SQL tables to be compressed.

Default: 7

custom-index

list / elements=string

Custom-Index.

case-sensitive

string

Disable/Enable case sensitive index.

disable - Build a case insensitive index.

enable - Build a case sensitive index.

Choices:

  • disable ← (default)

  • enable

device-type

string

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:

  • FortiGate ← (default)

  • FortiManager

  • FortiClient

  • FortiMail

  • FortiWeb

  • FortiCache

  • FortiSandbox

  • FortiDDoS

  • FortiAuthenticator

  • FortiProxy

id

integer

Add or Edit log index fields.

Default: 0

index-field

string

Log field name to be indexed.

log-type

string

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:

  • none

  • app-ctrl

  • attack

  • content

  • dlp

  • emailfilter

  • event

  • generic

  • history

  • traffic ← (default)

  • virus

  • voip

  • webfilter

  • netscan

  • fct-event

  • fct-traffic

  • fct-netscan

  • waf

  • gtp

  • dns

  • ssh

  • ssl

  • file-filter

  • asset

  • protocol

  • siem

custom-skipidx

list / elements=string

Custom-Skipidx.

device-type

string

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:

  • FortiGate ← (default)

  • FortiManager

  • FortiClient

  • FortiMail

  • FortiWeb

  • FortiSandbox

  • FortiProxy

id

integer

Add or Edit log index fields.

Default: 0

index-field

string

Field to be added to skip index.

log-type

string

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:

  • app-ctrl ← (default)

  • 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

database-name

string

Database name.

database-type

string

Database type.

mysql - MySQL database.

postgres - PostgreSQL local database.

Choices:

  • mysql

  • postgres ← (default)

device-count-high

string

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:

  • disable ← (default)

  • enable

event-table-partition-time

integer

Maximum SQL database table partitioning time range in minute (0 for unlimited) for event logs.

Default: 0

fct-table-partition-time

integer

Maximum SQL database table partitioning time range in minute (0 for unlimited) for FortiClient logs.

Default: 240

logtype

list / elements=string

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

password

string

Password for login remote database.

prompt-sql-upgrade

string

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:

  • disable

  • enable ← (default)

rebuild-event

string

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:

  • disable

  • enable ← (default)

rebuild-event-start-time

string

Rebuild event starting date and time <hh:mm yyyy/mm/dd>.

server

string

Database IP or hostname.

start-time

string

Start date and time <hh:mm yyyy/mm/dd>.

status

string

SQL database status.

disable - Disable SQL database.

local - Enable local database.

Choices:

  • disable

  • local ← (default)

text-search-index

string

Disable/Enable text search index.

disable - Do not create text search index.

enable - Create text search index.

Choices:

  • disable ← (default)

  • enable

traffic-table-partition-time

integer

Maximum SQL database table partitioning time range in minute (0 for unlimited) for traffic logs.

Default: 0

ts-index-field

list / elements=string

Ts-Index-Field.

category

string

Category of text search index fields.

value

string

Fields of text search index.

username

string

User name for login remote database.

utm-table-partition-time

integer

Maximum SQL database table partitioning time range in minute (0 for unlimited) for UTM logs.

Default: 0

workspace_locking_adom

string

the adom to lock for FortiManager running in workspace mode, the value can be global and others including root

workspace_locking_timeout

integer

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: SQL settings.
     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: <value of integer>
                 index-field: <value of string>
                 log-type: <value in [none, app-ctrl, attack, ...]>
           database-name: <value of string>
           database-type: <value in [mysql, postgres]>
           device-count-high: <value in [disable, enable]>
           event-table-partition-time: <value of integer>
           fct-table-partition-time: <value of 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
           password: <value of string>
           prompt-sql-upgrade: <value in [disable, enable]>
           rebuild-event: <value in [disable, enable]>
           rebuild-event-start-time: <value of string>
           server: <value of string>
           start-time: <value of string>
           status: <value in [disable, local]>
           text-search-index: <value in [disable, enable]>
           traffic-table-partition-time: <value of integer>
           ts-index-field:
             -
                 category: <value of string>
                 value: <value of string>
           username: <value of string>
           utm-table-partition-time: <value of integer>
           custom-skipidx:
             -
                 device-type: <value in [FortiGate, FortiManager, FortiClient, ...]>
                 id: <value of integer>
                 index-field: <value of string>
                 log-type: <value in [app-ctrl, attack, content, ...]>
           compress-table-min-age: <value of integer>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)