fortinet.fortimanager.fmgr_system_sql_customindex – List of SQL index fields.

Note

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

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_sql_customindex.

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 Choices/Defaults Comments
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
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
    Choices:
  • present
  • absent
the directive to create, update or delete an object
system_sql_customindex
dictionary
the top level parameters set
case-sensitive
string
    Choices:
  • disable ←
  • enable
Disable/Enable case sensitive index.
disable - Build a case insensitive index.
enable - Build a case sensitive index.
device-type
string
    Choices:
  • FortiGate ←
  • FortiManager
  • FortiClient
  • FortiMail
  • FortiWeb
  • FortiCache
  • FortiSandbox
  • FortiDDoS
  • FortiAuthenticator
  • FortiProxy
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
id
integer
Default:
0
Add or Edit log index fields.
index-field
string
Log field name to be indexed.
log-type
string
    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
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
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

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: List of SQL index fields.
     fmgr_system_sql_customindex:
        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, ...]
        state: <value in [present, absent]>
        system_sql_customindex:
           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, ...]>

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)