fortinet.fortios.fortios_firewall_sniffer module – Configure sniffer in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.5).
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_firewall_sniffer.
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 firewall feature and sniffer 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.14
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure sniffer. |
|
Configuration method to edit Denial of Service (DoS) anomaly settings. |
|
Action taken when the threshold is reached. Choices:
|
|
Enable/disable anomaly logging. Choices:
|
|
Anomaly name. |
|
Quarantine method. Choices:
|
|
Duration of quarantine. (Format |
|
Enable/disable quarantine logging. Choices:
|
|
Enable/disable this anomaly. Choices:
|
|
Anomaly threshold. Number of detected instances (packets per second or concurrent session number) that triggers the anomaly action. |
|
Number of detected instances per minute which triggers action (1 - 2147483647). Note that each anomaly has a different threshold value assigned to it. |
|
Name of an existing application list. Source application.list.name. |
|
Enable/disable application control profile. Choices:
|
|
Name of an existing antivirus profile. Source antivirus.profile.name. |
|
Enable/disable antivirus profile. Choices:
|
|
Name of an existing CASB profile. Source casb.profile.name. |
|
Enable/disable CASB profile. Choices:
|
|
Name of an existing DLP profile. Source dlp.profile.name. |
|
Enable/disable DLP profile. Choices:
|
|
Name of an existing DLP sensor. Source dlp.sensor.name. |
|
Enable/disable DLP sensor. Choices:
|
|
Enable/disable DSRI. Choices:
|
|
Name of an existing email filter profile. Source emailfilter.profile.name. |
|
Enable/disable emailfilter. Choices:
|
|
Name of an existing file-filter profile. Source file-filter.profile.name. |
|
Enable/disable file filter. Choices:
|
|
Hosts to filter for in sniffer traffic (Format examples: 1.1.1.1, 2.2.2.0/24, 3.3.3.3/255.255.255.0, 4.4.4.0-4.4.4.240). |
|
Sniffer ID (0 - 9999). see <a href=’#notes’>Notes</a>. |
|
Interface name that traffic sniffing will take place on. Source system.interface.name. |
|
Name of an existing IP threat feed. |
|
Threat feed name. Source system.external-resource.name. |
|
Enable/disable IP threat feed. Choices:
|
|
Enable/disable IPS DoS anomaly detection. Choices:
|
|
Name of an existing IPS sensor. Source ips.sensor.name. |
|
Enable/disable IPS sensor. Choices:
|
|
Enable/disable sniffing IPv6 packets. Choices:
|
|
Either log all sessions, only sessions that have a security profile applied, or disable all logging for this policy. Choices:
|
|
Maximum packet count (1 - 1000000). |
|
Enable/disable sniffing non-IP packets. Choices:
|
|
Ports to sniff (Format examples: 10, :20, 30:40, 50-, 100-200). |
|
Integer value for the protocol type as defined by IANA (0 - 255). |
|
Enable/disable scanning of connections to Botnet servers. Choices:
|
|
Name of an existing spam filter profile. Source spamfilter.profile.name. |
|
Enable/disable spam filter. Choices:
|
|
Enable/disable the active status of the sniffer. Choices:
|
|
List of VLANs to sniff. |
|
Name of an existing web filter profile. Source webfilter.profile.name. |
|
Enable/disable web filter profile. 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
We highly recommend using your own value as the id instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure sniffer.
fortinet.fortios.fortios_firewall_sniffer:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_sniffer:
anomaly:
-
action: "pass"
log: "enable"
name: "default_name_6"
quarantine: "none"
quarantine_expiry: "<your_own_value>"
quarantine_log: "disable"
status: "disable"
threshold: "0"
threshold_default: "0"
application_list: "<your_own_value> (source application.list.name)"
application_list_status: "enable"
av_profile: "<your_own_value> (source antivirus.profile.name)"
av_profile_status: "enable"
casb_profile: "<your_own_value> (source casb.profile.name)"
casb_profile_status: "enable"
dlp_profile: "<your_own_value> (source dlp.profile.name)"
dlp_profile_status: "enable"
dlp_sensor: "<your_own_value> (source dlp.sensor.name)"
dlp_sensor_status: "enable"
dsri: "enable"
emailfilter_profile: "<your_own_value> (source emailfilter.profile.name)"
emailfilter_profile_status: "enable"
file_filter_profile: "<your_own_value> (source file-filter.profile.name)"
file_filter_profile_status: "enable"
host: "myhostname"
id: "29"
interface: "<your_own_value> (source system.interface.name)"
ip_threatfeed:
-
name: "default_name_32 (source system.external-resource.name)"
ip_threatfeed_status: "enable"
ips_dos_status: "enable"
ips_sensor: "<your_own_value> (source ips.sensor.name)"
ips_sensor_status: "enable"
ipv6: "enable"
logtraffic: "all"
max_packet_count: "4000"
non_ip: "enable"
port: "<your_own_value>"
protocol: "<your_own_value>"
scan_botnet_connections: "disable"
spamfilter_profile: "<your_own_value> (source spamfilter.profile.name)"
spamfilter_profile_status: "enable"
status: "enable"
vlan: "<your_own_value>"
webfilter_profile: "<your_own_value> (source webfilter.profile.name)"
webfilter_profile_status: "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: |