ansible.builtin.fortios_ips_global (v2.8.20) — module

Install Ansible via pip

Install with pip install ansible==2.8.20

Description

This module is able to configure a FortiGate or FortiOS by allowing the user to configure ips feature and global category. Examples includes all options and need to be adjusted to datasources before usage. Tested with FOS v6.0.2

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

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

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
  tasks:
  - name: Configure IPS global parameter.
    fortios_ips_global:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      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"
        session-limit-mode: "accurate"
        skype-client-public-ipaddr: "<your_own_value>"
        socket-size: "13"
        sync-session-ttl: "enable"
        traffic-submit: "enable"

Inputs

    
host:
    description:
    - FortiOS or FortiGate ip adress.
    required: true

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.

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol
    type: bool

password:
    default: ''
    description:
    - FortiOS or FortiGate password.

username:
    description:
    - FortiOS or FortiGate username.
    required: true

ips_global:
    default: null
    description:
    - Configure IPS global parameter.
    suboptions:
      anomaly-mode:
        choices:
        - periodical
        - continuous
        description:
        - Global blocking mode for rate-based anomalies.
      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.
      deep-app-insp-db-limit:
        description:
        - Limit on number of entries in deep application inspection database (1 - 2147483647,
          0 = use recommended setting)
      deep-app-insp-timeout:
        description:
        - Timeout for Deep application inspection (1 - 2147483647 sec., 0 = use recommended
          setting).
      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.
      exclude-signatures:
        choices:
        - none
        - industrial
        description:
        - Excluded signatures.
      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.
      intelligent-mode:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IPS adaptive scanning (intelligent mode). Intelligent mode optimizes
          the scanning method for the type of traffic.
      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).
      skype-client-public-ipaddr:
        description:
        - Public IP addresses of your network that receive Skype sessions. Helps identify
          Skype sessions. Separate IP addresses with commas.
      socket-size:
        description:
        - IPS socket buffer size (0 - 256 MB). Default depends on available memory. Can
          be changed to tune performance.
      sync-session-ttl:
        choices:
        - enable
        - disable
        description:
        - Enable/disable use of kernel session TTL for IPS sessions.
      traffic-submit:
        choices:
        - enable
        - disable
        description:
        - Enable/disable submitting attack data found by this FortiGate to FortiGuard.

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