fortinet.fortios.fortios_ips_global – Configure IPS global parameter in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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.
To use it in a playbook, specify: fortinet.fortios.fortios_ips_global.
New in version 2.10: of fortinet.fortios
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.9.0
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
|||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
||
| ips_global
dictionary
|
Configure IPS global parameter.
|
|||
| anomaly_mode
string
|
|
Global blocking mode for rate-based anomalies.
|
||
| cp_accel_mode
string
|
|
IPS Pattern matching acceleration/offloading to CPx processors.
|
||
| database
string
|
|
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
integer
|
Limit on number of entries in deep application inspection database (1 - 2147483647, 0 = use recommended setting)
|
|||
| deep_app_insp_timeout
integer
|
Timeout for Deep application inspection (1 - 2147483647 sec., 0 = use recommended setting).
|
|||
| engine_count
integer
|
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
string
|
|
Excluded signatures.
|
||
| fail_open
string
|
|
Enable to allow traffic if the IPS process crashes. Default is disable and IPS traffic is blocked when the IPS process crashes.
|
||
| intelligent_mode
string
|
|
Enable/disable IPS adaptive scanning (intelligent mode). Intelligent mode optimizes the scanning method for the type of traffic.
|
||
| ips_reserve_cpu
string
|
|
Enable/disable IPS daemon"s use of CPUs other than CPU 0
|
||
| ngfw_max_scan_range
integer
|
NGFW policy-mode app detection threshold.
|
|||
| np_accel_mode
string
|
|
Acceleration mode for IPS processing by NPx processors.
|
||
| packet_log_queue_depth
integer
|
Packet/pcap log queue depth per IPS engine.
|
|||
| session_limit_mode
string
|
|
Method of counting concurrent sessions used by session limit anomalies. Choose between greater accuracy (accurate) or improved performance (heuristics).
|
||
| skype_client_public_ipaddr
string
|
Public IP addresses of your network that receive Skype sessions. Helps identify Skype sessions. Separate IP addresses with commas.
|
|||
| socket_size
integer
|
IPS socket buffer size. Max and default value depend on available memory. Can be changed to tune performance.
|
|||
| sync_session_ttl
string
|
|
Enable/disable use of kernel session TTL for IPS sessions.
|
||
| tls_active_probe
dictionary
|
TLS active probe configuration.
|
|||
| interface
string
|
Specify outgoing interface to reach server. Source system.interface.name.
|
|||
| interface_select_method
string
|
|
Specify how to select outgoing interface to reach server.
|
||
| source_ip
string
|
Source IP address used for TLS active probe.
|
|||
| source_ip6
string
|
Source IPv6 address used for TLS active probe.
|
|||
| vdom
string
|
Virtual domain name for TLS active probe. Source system.vdom.name.
|
|||
| traffic_submit
string
|
|
Enable/disable submitting attack data found by this FortiGate to FortiGuard.
|
||
| vdom
string
|
Default:
"root"
|
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.
|
||
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- 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"
cp_accel_mode: "none"
database: "regular"
deep_app_insp_db_limit: "6"
deep_app_insp_timeout: "7"
engine_count: "8"
exclude_signatures: "none"
fail_open: "enable"
intelligent_mode: "enable"
ips_reserve_cpu: "disable"
ngfw_max_scan_range: "13"
np_accel_mode: "none"
packet_log_queue_depth: "15"
session_limit_mode: "accurate"
skype_client_public_ipaddr: "<your_own_value>"
socket_size: "18"
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 | Returned | Description |
|---|---|---|
| build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
| http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
| http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
| mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
| name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
| path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
| revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
| serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
| status
string
|
always |
Indication of the operation's result
Sample:
success
|
| vdom
string
|
always |
Virtual domain used
Sample:
root
|
| version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_ips_global_module.html