fortinet.fortios.fortios_system_netflow module – Configure NetFlow 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_system_netflow.
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 system feature and netflow 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:
|
|
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:
|
|
Configure NetFlow. |
|
Timeout to report active flows (60 - 3600 sec). |
|
Collector IP. |
|
NetFlow collector port number. |
|
Netflow collectors. |
|
Collector IP. |
|
NetFlow collector port number. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Source IP address for communication with the NetFlow agent. |
|
Name of the interface used to determine the source IP for exporting packets. Source system.interface.name. |
|
Exclusion filters |
|
Session destination address. |
|
Session destination port number or range. |
|
Filter ID. see <a href=’#notes’>Notes</a>. |
|
Session IP protocol (0 - 255). |
|
Session source address. |
|
Session source port number or range. |
|
Timeout for periodic report of finished flows (10 - 600 sec). |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
Source IP address for communication with the NetFlow agent. |
|
Counter of flowset records before resending a template flowset record. |
|
Timeout for periodic template flowset transmission (60 - 86400 sec). |
|
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 NetFlow.
fortinet.fortios.fortios_system_netflow:
vdom: "{{ vdom }}"
system_netflow:
active_flow_timeout: "1800"
collector_ip: "<your_own_value>"
collector_port: "2055"
collectors:
-
collector_ip: "<your_own_value>"
collector_port: "2055"
id: "9"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
source_ip: "84.230.14.43"
source_ip_interface: "<your_own_value> (source system.interface.name)"
exclusion_filters:
-
destination_ip: "<your_own_value>"
destination_port: "<your_own_value>"
id: "17"
protocol: "255"
source_ip: "84.230.14.43"
source_port: "<your_own_value>"
inactive_flow_timeout: "15"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
source_ip: "84.230.14.43"
template_tx_counter: "20"
template_tx_timeout: "1800"
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: |