fortinet.fortios.fortios_ips_sensor module – Configure IPS sensor in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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_sensor
.
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 sensor 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 sensor. |
|
Enable/disable malicious URL blocking. Choices:
|
|
Comment. |
|
IPS sensor filter. |
|
Action taken with traffic in which signatures are detected. Choices:
|
|
Operating systems to be protected. Use all for every application and other for unlisted application. |
|
List of CVE IDs of the signatures to add to the sensor. |
|
CVE IDs or CVE wildcards. |
|
Signature default action filter. Choices:
|
|
Signature default status filter. Choices:
|
|
Traffic from selected source or destination IP addresses is exempt from this signature. |
|
Destination IP address and netmask (applies to packet matching the signature). |
|
Exempt IP ID. see <a href=’#notes’>Notes</a>. |
|
Source IP address and netmask (applies to packet matching the signature). |
|
Rule ID in IPS database (0 - 4294967295). see <a href=’#notes’>Notes</a>. |
|
Filter by signature last modified date. Formats: before <date>, after <date>, between <start-date> <end-date>. |
|
Protect client or server traffic. |
|
Enable/disable logging of signatures included in filter. Choices:
|
|
Enable/disable logging of attack context: URL buffer, header buffer, body buffer, packet buffer. Choices:
|
|
Enable/disable packet logging. Enable to save the packet that triggers the filter. You can download the packets in pcap format for diagnostic use. Choices:
|
|
Operating systems to be protected. Use all for every operating system and other for unlisted operating systems. |
|
Protocols to be examined. Use all for every protocol and other for unlisted protocols. |
|
Quarantine method. Choices:
|
|
Duration of quarantine. (Format |
|
Enable/disable quarantine logging. Choices:
|
|
Count of the rate. |
|
Duration (sec) of the rate. |
|
Rate limit mode. Choices:
|
|
Track the packet protocol field. Choices:
|
|
Identifies the predefined or custom IPS signatures to add to the sensor. |
|
Rule IPS. see <a href=’#notes’>Notes</a>. |
|
Relative severity of the signature, from info to critical. Log messages generated by the signature include the severity. |
|
Status of the signatures included in filter. Only those filters with a status to enable are used. Choices:
|
|
List of signature vulnerability types to filter by. |
|
Vulnerability type ID. see <a href=’#notes’>Notes</a>. |
|
Enable/disable extended logging. Choices:
|
|
IPS sensor filter. |
|
Action of selected rules. Choices:
|
|
Vulnerable application filter. |
|
Vulnerability location filter. |
|
Enable/disable logging of selected rules. Choices:
|
|
Enable/disable packet logging of selected rules. Choices:
|
|
Filter name. |
|
Vulnerable OS filter. |
|
Vulnerable protocol filter. |
|
Quarantine IP or interface. Choices:
|
|
Duration of quarantine in minute. |
|
Enable/disable logging of selected quarantine. Choices:
|
|
Vulnerability severity filter. |
|
Selected rules status. Choices:
|
|
Sensor name. |
|
IPS override rule. |
|
Action of override rule. Choices:
|
|
Exempted IP. |
|
Destination IP address and netmask. |
|
Exempt IP ID. see <a href=’#notes’>Notes</a>. |
|
Source IP address and netmask. |
|
Enable/disable logging. Choices:
|
|
Enable/disable packet logging. Choices:
|
|
Quarantine IP or interface. Choices:
|
|
Duration of quarantine in minute. |
|
Enable/disable logging of selected quarantine. Choices:
|
|
Override rule ID. see <a href=’#notes’>Notes</a>. |
|
Enable/disable status of override rule. Choices:
|
|
Replacement message group. Source system.replacemsg-group.name. |
|
Block or monitor connections to Botnet servers, or disable Botnet scanning. 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:
|
|
Indicates whether to create or remove the object. 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
The module supports check_mode.
Examples
- name: Configure IPS sensor.
fortinet.fortios.fortios_ips_sensor:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ips_sensor:
block_malicious_url: "disable"
comment: "Comment."
entries:
-
action: "pass"
application: "<your_own_value>"
cve:
-
cve_entry: "<your_own_value>"
default_action: "all"
default_status: "all"
exempt_ip:
-
dst_ip: "<your_own_value>"
id: "14"
src_ip: "<your_own_value>"
id: "16"
last_modified: "<your_own_value>"
location: "<your_own_value>"
log: "disable"
log_attack_context: "disable"
log_packet: "disable"
os: "<your_own_value>"
protocol: "<your_own_value>"
quarantine: "none"
quarantine_expiry: "<your_own_value>"
quarantine_log: "disable"
rate_count: "0"
rate_duration: "60"
rate_mode: "periodical"
rate_track: "none"
rule:
-
id: "32"
severity: "<your_own_value>"
status: "disable"
vuln_type:
-
id: "36"
extended_log: "enable"
filter:
-
action: "pass"
application: "<your_own_value>"
location: "<your_own_value>"
log: "disable"
log_packet: "disable"
name: "default_name_44"
os: "<your_own_value>"
protocol: "<your_own_value>"
quarantine: "none"
quarantine_expiry: "1073741823"
quarantine_log: "disable"
severity: "<your_own_value>"
status: "disable"
name: "default_name_52"
override:
-
action: "pass"
exempt_ip:
-
dst_ip: "<your_own_value>"
id: "57"
src_ip: "<your_own_value>"
log: "disable"
log_packet: "disable"
quarantine: "none"
quarantine_expiry: "1073741823"
quarantine_log: "disable"
rule_id: "<you_own_value>"
status: "disable"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
scan_botnet_connections: "disable"
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: |