fortios_switch_controller_flow_tracking – Configure FortiSwitch flow tracking and export via ipfix/netflow in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
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
FortiOS Version Compatibility¶
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
|
| fortios_switch_controller_flow_tracking | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- enable_log - Enable/Disable logging for task. type: bool required: False default: False
- vdom - 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. type: str default: root
- switch_controller_flow_tracking - Configure FortiSwitch flow tracking and export via ipfix/netflow. type: dict more...
- aggregates - Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. type: list more...
- id - Aggregate id. type: int required: True more...
- ip - IP address to group all matching traffic sessions to a flow. type: str more...
- collector_ip - Configure collector ip address. type: str more...
- collector_port - Configure collector port number(0-65535). type: int more...
- format - Configure flow tracking protocol. type: str choices: netflow1, netflow5, netflow9, ipfix more...
- level - Configure flow tracking level. type: str choices: vlan, ip, port, proto, mac more...
- max_export_pkt_size - Configure flow max export packet size (512-9216). type: int more...
- sample_mode - Configure sample mode for the flow tracking. type: str choices: local, perimeter, device-ingress more...
- sample_rate - Configure sample rate for the perimeter and device-ingress sampling(0 - 99999). type: int more...
- timeout_general - Configure flow session general timeout (60-604800). type: int more...
- timeout_icmp - Configure flow session ICMP timeout (60-604800). type: int more...
- timeout_max - Configure flow session max timeout (60-604800). type: int more...
- timeout_tcp - Configure flow session TCP timeout (60-604800). type: int more...
- timeout_tcp_fin - Configure flow session TCP FIN timeout (60-604800). type: int more...
- timeout_tcp_rst - Configure flow session TCP RST timeout (60-604800). type: int more...
- timeout_udp - Configure flow session UDP timeout (60-604800). type: int more...
- transport - Configure L4 transport protocol for exporting packets. type: str choices: udp, tcp, sctp more...
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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3