fortinet.fortios.fortios_firewall_on_demand_sniffer module – Configure on-demand packet sniffer 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_firewall_on_demand_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 on_demand_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.15
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure on-demand packet sniffer. |
|
Advanced freeform filter that will be used over existing filter settings if set. Can only be used by super admin. |
|
IPv4 or IPv6 hosts to filter in this traffic sniffer. |
|
IPv4 or IPv6 host. |
|
Interface name that on-demand packet sniffer will take place. Source system.interface.name. |
|
Maximum number of packets to capture per on-demand packet sniffer. |
|
On-demand packet sniffer name. |
|
Include non-IP packets. Choices:
|
|
Ports to filter for in this traffic sniffer. |
|
Port to filter in this traffic sniffer. see <a href=’#notes’>Notes</a>. |
|
Protocols to filter in this traffic sniffer. |
|
Integer value for the protocol type as defined by IANA (0 - 255). see <a href=’#notes’>Notes</a>. |
|
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
Examples
- name: Configure on-demand packet sniffer.
fortinet.fortios.fortios_firewall_on_demand_sniffer:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
firewall_on_demand_sniffer:
advanced_filter: "<your_own_value>"
hosts:
-
host: "myhostname"
interface: "<your_own_value> (source system.interface.name)"
max_packet_count: "0"
name: "default_name_8"
non_ip_packet: "enable"
ports:
-
port: "<you_own_value>"
protocols:
-
protocol: "<you_own_value>"
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: |