fortinet.fortios.fortios_ips_global (1.1.7) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==1.1.7

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 1.1.7

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify ips feature and global category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.0

Requirements

• ansible>=2.9.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure IPS global parameter.
    fortios_ips_global:
      vdom:  "{{ vdom }}"
      ips_global:
        anomaly_mode: "periodical"
        database: "regular"
        deep_app_insp_db_limit: "5"
        deep_app_insp_timeout: "6"
        engine_count: "7"
        exclude_signatures: "none"
        fail_open: "enable"
        intelligent_mode: "enable"
        packet_log_queue_depth: "11"
        session_limit_mode: "accurate"
        socket_size: "13"
        sync_session_ttl: "enable"
        traffic_submit: "enable"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

ips_global:
    default: null
    description:
    - Configure IPS global parameter.
    suboptions:
      anomaly_mode:
        choices:
        - periodical
        - continuous
        description:
        - Global blocking mode for rate-based anomalies.
        type: str
      database:
        choices:
        - regular
        - extended
        description:
        - Regular or extended IPS database. Regular protects against the latest common
          and in-the-wild attacks. Extended includes protection from legacy attacks.
        type: str
      deep_app_insp_db_limit:
        description:
        - Limit on number of entries in deep application inspection database (1 - 2147483647,
          0 = use recommended setting)
        type: int
      deep_app_insp_timeout:
        description:
        - Timeout for Deep application inspection (1 - 2147483647 sec., 0 = use recommended
          setting).
        type: int
      engine_count:
        description:
        - Number of IPS engines running. If set to the default value of 0, FortiOS sets
          the number to optimize performance depending on the number of CPU cores.
        type: int
      exclude_signatures:
        choices:
        - none
        - industrial
        description:
        - Excluded signatures.
        type: str
      fail_open:
        choices:
        - enable
        - disable
        description:
        - Enable to allow traffic if the IPS process crashes. Default is disable and IPS
          traffic is blocked when the IPS process crashes.
        type: str
      intelligent_mode:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IPS adaptive scanning (intelligent mode). Intelligent mode optimizes
          the scanning method for the type of traffic.
        type: str
      packet_log_queue_depth:
        description:
        - Packet/pcap log queue depth per IPS engine.
        type: int
      session_limit_mode:
        choices:
        - accurate
        - heuristic
        description:
        - Method of counting concurrent sessions used by session limit anomalies. Choose
          between greater accuracy (accurate) or improved performance (heuristics).
        type: str
      socket_size:
        description:
        - IPS socket buffer size. Max and default value depend on available memory. Can
          be changed to tune performance.
        type: int
      sync_session_ttl:
        choices:
        - enable
        - disable
        description:
        - Enable/disable use of kernel session TTL for IPS sessions.
        type: str
      traffic_submit:
        choices:
        - enable
        - disable
        description:
        - Enable/disable submitting attack data found by this FortiGate to FortiGuard.
        type: str
    type: dict

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str