fortinet.fortios.fortios_switch_controller_flow_tracking – Configure FortiSwitch flow tracking and export via ipfix/netflow in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.2).
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
.
To use it in a playbook, specify: fortinet.fortios.fortios_switch_controller_flow_tracking
.
New in version 2.10: of fortinet.fortios
Synopsis
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify switch_controller feature and flow_tracking 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.9.0
Parameters
Parameter | Choices/Defaults | Comments | ||
---|---|---|---|---|
access_token string | Token-based authentication. Generated from GUI of Fortigate. | |||
enable_log boolean |
| Enable/Disable logging for task. | ||
switch_controller_flow_tracking dictionary | Configure FortiSwitch flow tracking and export via ipfix/netflow. | |||
aggregates list / elements=string | Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. | |||
id integer / required | Aggregate id. | |||
ip string | IP address to group all matching traffic sessions to a flow. | |||
collector_ip string | Configure collector ip address. | |||
collector_port integer | Configure collector port number(0-65535). | |||
format string |
| Configure flow tracking protocol. | ||
level string |
| Configure flow tracking level. | ||
max_export_pkt_size integer | Configure flow max export packet size (512-9216). | |||
sample_mode string |
| Configure sample mode for the flow tracking. | ||
sample_rate integer | Configure sample rate for the perimeter and device-ingress sampling(0 - 99999). | |||
timeout_general integer | Configure flow session general timeout (60-604800). | |||
timeout_icmp integer | Configure flow session ICMP timeout (60-604800). | |||
timeout_max integer | Configure flow session max timeout (60-604800). | |||
timeout_tcp integer | Configure flow session TCP timeout (60-604800). | |||
timeout_tcp_fin integer | Configure flow session TCP FIN timeout (60-604800). | |||
timeout_tcp_rst integer | Configure flow session TCP RST timeout (60-604800). | |||
timeout_udp integer | Configure flow session UDP timeout (60-604800). | |||
transport string |
| Configure L4 transport protocol for exporting packets. | ||
vdom string | Default: "root" | 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. |
Notes
Note
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- hosts: fortigates collections: - fortinet.fortios connection: httpapi vars: vdom: "root" ansible_httpapi_use_ssl: yes ansible_httpapi_validate_certs: no ansible_httpapi_port: 443 tasks: - name: Configure FortiSwitch flow tracking and export via ipfix/netflow. fortios_switch_controller_flow_tracking: vdom: "{{ vdom }}" switch_controller_flow_tracking: aggregates: - id: "4" ip: "<your_own_value>" collector_ip: "<your_own_value>" collector_port: "7" format: "netflow1" level: "vlan" max_export_pkt_size: "10" sample_mode: "local" sample_rate: "12" timeout_general: "13" timeout_icmp: "14" timeout_max: "15" timeout_tcp: "16" timeout_tcp_fin: "17" timeout_tcp_rst: "18" timeout_udp: "19" transport: "udp"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
build string | always | Build number of the fortigate image Sample: 1547 |
http_method string | always | Last method used to provision the content into FortiGate Sample: PUT |
http_status string | always | Last result given by FortiGate on last operation applied Sample: 200 |
mkey string | success | Master key (id) used in the last call to FortiGate Sample: id |
name string | always | Name of the table used to fulfill the request Sample: urlfilter |
path string | always | Path of the table used to fulfill the request Sample: webfilter |
revision string | always | Internal revision number Sample: 17.0.2.10658 |
serial string | always | Serial number of the unit Sample: FGVMEVYYQT3AB5352 |
status string | always | Indication of the operation's result Sample: success |
vdom string | always | Virtual domain used Sample: root |
version string | always | Version of the FortiGate Sample: v5.6.3 |
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_switch_controller_flow_tracking_module.html