fortinet.fortios.fortios_ips_global module – Configure IPS global parameter in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.6).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_ips_global.
New in fortinet.fortios 2.0.0
Synopsis
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
The below requirements are needed on the host that executes this module.
ansible>=2.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure IPS global parameter. |
|
Global blocking mode for rate-based anomalies. Choices:
|
|
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. |
|
IPS Pattern matching acceleration/offloading to CPx processors. Choices:
|
|
Regular or extended IPS database. Regular protects against the latest common and in-the-wild attacks. Extended includes protection from legacy attacks. Choices:
|
|
Limit on number of entries in deep application inspection database (1 - 2147483647, use recommended setting = 0). |
|
Timeout for Deep application inspection (1 - 2147483647 sec., 0 = use recommended setting). |
|
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. |
|
Excluded signatures. Choices:
|
|
Enable to allow traffic if the IPS buffer is full. Default is disable and IPS traffic is blocked when the IPS buffer is full. Choices:
|
|
Enable/disable IPS adaptive scanning (intelligent mode). Intelligent mode optimizes the scanning method for the type of traffic. Choices:
|
|
Enable/disable IPS daemon”s use of CPUs other than CPU 0. Choices:
|
|
NGFW policy-mode app detection threshold. |
|
Acceleration mode for IPS processing by NPx processors. Choices:
|
|
Packet/pcap log queue depth per IPS engine. |
|
Method of counting concurrent sessions used by session limit anomalies. Choose between greater accuracy (accurate) or improved performance (heuristics). Choices:
|
|
Public IP addresses of your network that receive Skype sessions. Helps identify Skype sessions. Separate IP addresses with commas. |
|
IPS socket buffer size. Max and default value depend on available memory. Can be changed to tune performance. |
|
Enable/disable use of kernel session TTL for IPS sessions. Choices:
|
|
TLS active probe configuration. |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Source IP address used for TLS active probe. |
|
Source IPv6 address used for TLS active probe. |
|
Virtual domain name for TLS active probe. Source system.vdom.name. |
|
Enable/disable submitting attack data found by this FortiGate to FortiGuard. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |