/ home / chillancezen / chillancezen.fortimanager / 2.1.6 / module / fmgr_system_sql

chillancezen.fortimanager.fmgr_system_sql (2.1.6) — module

no description

| "added in version" 1.0.0 of chillancezen.fortimanager"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)

preview | supported by community

Install collection

Install with ansible-galaxy collection install chillancezen.fortimanager:==2.1.6

Add to requirements.yml

  collections:
    - name: chillancezen.fortimanager
      version: 2.1.6

Description

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.

Usage examples

Scanned by Steampunk Spotter

 - 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: no description
      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
              - ztna
            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>

Outputs

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_message:
  description: The descriptive message of the api response
  returned: always
  sample: OK.
  type: str