fortinet.fortios.fortios_ips_global (2.3.6) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

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.0.0

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

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

- name: Configure IPS global parameter.
  fortinet.fortios.fortios_ips_global:
      vdom: "{{ vdom }}"
      ips_global:
          anomaly_mode: "periodical"
          av_mem_limit: "0"
          cp_accel_mode: "none"
          database: "regular"
          deep_app_insp_db_limit: "0"
          deep_app_insp_timeout: "0"
          engine_count: "0"
          exclude_signatures: "none"
          fail_open: "enable"
          intelligent_mode: "enable"
          ips_reserve_cpu: "disable"
          ngfw_max_scan_range: "4096"
          np_accel_mode: "none"
          packet_log_queue_depth: "128"
          session_limit_mode: "accurate"
          skype_client_public_ipaddr: "<your_own_value>"
          socket_size: "256"
          sync_session_ttl: "enable"
          tls_active_probe:
              interface: "<your_own_value> (source system.interface.name)"
              interface_select_method: "auto"
              source_ip: "84.230.14.43"
              source_ip6: "<your_own_value>"
              vdom: "<your_own_value> (source system.vdom.name)"
          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

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

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
      av_mem_limit:
        description:
        - Maximum percentage of system memory allowed for use on AV scanning (10 - 50).
          To disable set to zero. When disabled, there is no limit on the AV memory usage.
        type: int
      cp_accel_mode:
        choices:
        - none
        - basic
        - advanced
        description:
        - IPS Pattern matching acceleration/offloading to CPx processors.
        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,
          use recommended setting = 0).
        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
        - ot
        - industrial
        description:
        - Excluded signatures.
        type: str
      fail_open:
        choices:
        - enable
        - disable
        description:
        - Enable to allow traffic if the IPS buffer is full. Default is disable and IPS
          traffic is blocked when the IPS buffer is full.
        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
      ips_reserve_cpu:
        choices:
        - disable
        - enable
        description:
        - Enable/disable IPS daemon"s use of CPUs other than CPU 0.
        type: str
      ngfw_max_scan_range:
        description:
        - NGFW policy-mode app detection threshold.
        type: int
      np_accel_mode:
        choices:
        - none
        - basic
        description:
        - Acceleration mode for IPS processing by NPx processors.
        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
      skype_client_public_ipaddr:
        description:
        - Public IP addresses of your network that receive Skype sessions. Helps identify
          Skype sessions. Separate IP addresses with commas.
        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
      tls_active_probe:
        description:
        - TLS active probe configuration.
        suboptions:
          interface:
            description:
            - Specify outgoing interface to reach server. Source system.interface.name.
            type: str
          interface_select_method:
            choices:
            - auto
            - sdwan
            - specify
            description:
            - Specify how to select outgoing interface to reach server.
            type: str
          source_ip:
            description:
            - Source IP address used for TLS active probe.
            type: str
          source_ip6:
            description:
            - Source IPv6 address used for TLS active probe.
            type: str
          vdom:
            description:
            - Virtual domain name for TLS active probe. Source system.vdom.name.
            type: str
        type: dict
      traffic_submit:
        choices:
        - enable
        - disable
        description:
        - Enable/disable submitting attack data found by this FortiGate to FortiGuard.
        type: str
    type: dict

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

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

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    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