fortios_ips_global – Configure IPS global parameter in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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 default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- ips_global - Configure IPS global parameter. type: dict more...
- anomaly_mode - Global blocking mode for rate-based anomalies. type: str choices: periodical, continuous more...
- av_mem_limit - 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 more...
- cp_accel_mode - IPS Pattern matching acceleration/offloading to CPx processors. type: str choices: none, basic, advanced more...
- database - Regular or extended IPS database. Regular protects against the latest common and in-the-wild attacks. Extended includes protection from legacy attacks. type: str choices: regular, extended more...
- deep_app_insp_db_limit - Limit on number of entries in deep application inspection database (1 - 2147483647, use recommended setting = 0). type: int more...
- deep_app_insp_timeout - Timeout for Deep application inspection (1 - 2147483647 sec., 0 = use recommended setting). type: int more...
- engine_count - 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 more...
- exclude_signatures - Excluded signatures. type: str choices: none, ot, industrial more...
- fail_open - 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 choices: enable, disable more...
- intelligent_mode - Enable/disable IPS adaptive scanning (intelligent mode). Intelligent mode optimizes the scanning method for the type of traffic. type: str choices: enable, disable more...
- ips_reserve_cpu - Enable/disable IPS daemon"s use of CPUs other than CPU 0. type: str choices: disable, enable more...
- ngfw_max_scan_range - NGFW policy-mode app detection threshold. type: int more...
- np_accel_mode - Acceleration mode for IPS processing by NPx processors. type: str choices: none, basic more...
- packet_log_queue_depth - Packet/pcap log queue depth per IPS engine. type: int more...
- session_limit_mode - Method of counting concurrent sessions used by session limit anomalies. Choose between greater accuracy (accurate) or improved performance (heuristics). type: str choices: accurate, heuristic more...
- skype_client_public_ipaddr - Public IP addresses of your network that receive Skype sessions. Helps identify Skype sessions. Separate IP addresses with commas. type: str more...
- socket_size - IPS socket buffer size. Max and default value depend on available memory. Can be changed to tune performance. type: int more...
- sync_session_ttl - Enable/disable use of kernel session TTL for IPS sessions. type: str choices: enable, disable more...
- tls_active_probe - TLS active probe configuration. type: dict more...
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str more...
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify more...
- source_ip - Source IP address used for TLS active probe. type: str more...
- source_ip6 - Source IPv6 address used for TLS active probe. type: str more...
- vdom - Virtual domain name for TLS active probe. Source system.vdom.name. type: str more...
- traffic_submit - Enable/disable submitting attack data found by this FortiGate to FortiGuard. type: str choices: enable, disable more...
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
This module is not guaranteed to have a backwards compatible interface.