Skip to content

Latest commit

 

History

History
1676 lines (1631 loc) · 57.4 KB

fortios_switch_controller_flow_tracking.rst

File metadata and controls

1676 lines (1631 loc) · 57.4 KB
Raw
source

fortios_switch_controller_flow_tracking.py

orphan

fortios_switch_controller_flow_tracking -- Configure FortiSwitch flow tracking and export via ipfix/netflow in Fortinet's FortiOS and FortiGate.

2.0.0

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

Tips

Using member operation to add an element to an existing object.

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 v7.0.1 v7.0.2 v7.0.3 v7.0.4 v7.0.5 v7.0.6 v7.0.7 v7.0.8 v7.2.0 v7.2.1 v7.2.2
fortios_switch_controller_flow_tracking yes yes yes yes yes yes yes yes yes yes yes 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
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • switch_controller_flow_tracking - Configure FortiSwitch flow tracking and export via ipfix/netflow. type: dict

    <a id='label0' href="javascript:ContentClick('label1', 'label0');" onmouseover="ContentPreview('label1');" onmouseout="ContentUnpreview('label1');" title="click to collapse or expand..."> more... </a> <div id="label1" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>switch_controller_flow_tracking</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">aggregates</span> - Configure aggregates in which all traffic sessions matching the IP Address will be grouped into the same flow. <span class="li-normal">type: list</span> <a id='label2' href="javascript:ContentClick('label3', 'label2');" onmouseover="ContentPreview('label3');" onmouseout="ContentUnpreview('label3');" title="click to collapse or expand..."> more... </a> <div id="label3" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>aggregates</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">id</span> - Aggregate id. <span class="li-normal">type: int</span> <a id='label4' href="javascript:ContentClick('label5', 'label4');" onmouseover="ContentPreview('label5');" onmouseout="ContentUnpreview('label5');" title="click to collapse or expand..."> more... </a> <div id="label5" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>id</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">ip</span> - IP address to group all matching traffic sessions to a flow. <span class="li-normal">type: str</span> <a id='label6' href="javascript:ContentClick('label7', 'label6');" onmouseover="ContentPreview('label7');" onmouseout="ContentUnpreview('label7');" title="click to collapse or expand..."> more... </a> <div id="label7" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ip</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">collector_ip</span> - Configure collector ip address. <span class="li-normal">type: str</span> <a id='label8' href="javascript:ContentClick('label9', 'label8');" onmouseover="ContentPreview('label9');" onmouseout="ContentUnpreview('label9');" title="click to collapse or expand..."> more... </a> <div id="label9" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> </tr> <tr> <td>collector_ip</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">collector_port</span> - Configure collector port number(0-65535). <span class="li-normal">type: int</span> <a id='label10' href="javascript:ContentClick('label11', 'label10');" onmouseover="ContentPreview('label11');" onmouseout="ContentUnpreview('label11');" title="click to collapse or expand..."> more... </a> <div id="label11" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> </tr> <tr> <td>collector_port</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">collectors</span> - Configure collectors for the flow. <span class="li-normal">type: list</span> <a id='label12' href="javascript:ContentClick('label13', 'label12');" onmouseover="ContentPreview('label13');" onmouseout="ContentUnpreview('label13');" title="click to collapse or expand..."> more... </a> <div id="label13" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>collectors</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <ul class="ul-self"> <li> <span class="li-head">ip</span> - Collector IP address. <span class="li-normal">type: str</span> <a id='label14' href="javascript:ContentClick('label15', 'label14');" onmouseover="ContentPreview('label15');" onmouseout="ContentUnpreview('label15');" title="click to collapse or expand..."> more... </a> <div id="label15" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>ip</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">name</span> - Collector name. <span class="li-normal">type: str</span> <a id='label16' href="javascript:ContentClick('label17', 'label16');" onmouseover="ContentPreview('label17');" onmouseout="ContentUnpreview('label17');" title="click to collapse or expand..."> more... </a> <div id="label17" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>name</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">port</span> - Collector port number(0-65535). <span class="li-normal">type: int</span> <a id='label18' href="javascript:ContentClick('label19', 'label18');" onmouseover="ContentPreview('label19');" onmouseout="ContentUnpreview('label19');" title="click to collapse or expand..."> more... </a> <div id="label19" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>port</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">transport</span> - Collector L4 transport protocol for exporting packets. <span class="li-normal">type: str</span> <span class="li-normal">choices: udp, tcp, sctp</span> <a id='label20' href="javascript:ContentClick('label21', 'label20');" onmouseover="ContentPreview('label21');" onmouseout="ContentUnpreview('label21');" title="click to collapse or expand..."> more... </a> <div id="label21" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>transport</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[udp]</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[tcp]</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[sctp]</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> <li> <span class="li-head">format</span> - Configure flow tracking protocol. <span class="li-normal">type: str</span> <span class="li-normal">choices: netflow1, netflow5, netflow9, ipfix</span> <a id='label22' href="javascript:ContentClick('label23', 'label22');" onmouseover="ContentPreview('label23');" onmouseout="ContentUnpreview('label23');" title="click to collapse or expand..."> more... </a> <div id="label23" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>format</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[netflow1]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[netflow5]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[netflow9]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[ipfix]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">level</span> - Configure flow tracking level. <span class="li-normal">type: str</span> <span class="li-normal">choices: vlan, ip, port, proto, mac</span> <a id='label24' href="javascript:ContentClick('label25', 'label24');" onmouseover="ContentPreview('label25');" onmouseout="ContentUnpreview('label25');" title="click to collapse or expand..."> more... </a> <div id="label25" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>level</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[vlan]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[ip]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[port]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[proto]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[mac]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">max_export_pkt_size</span> - Configure flow max export packet size (512-9216). <span class="li-normal">type: int</span> <a id='label26' href="javascript:ContentClick('label27', 'label26');" onmouseover="ContentPreview('label27');" onmouseout="ContentUnpreview('label27');" title="click to collapse or expand..."> more... </a> <div id="label27" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>max_export_pkt_size</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">sample_mode</span> - Configure sample mode for the flow tracking. <span class="li-normal">type: str</span> <span class="li-normal">choices: local, perimeter, device-ingress</span> <a id='label28' href="javascript:ContentClick('label29', 'label28');" onmouseover="ContentPreview('label29');" onmouseout="ContentUnpreview('label29');" title="click to collapse or expand..."> more... </a> <div id="label29" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>sample_mode</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[local]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[perimeter]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[device-ingress]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">sample_rate</span> - Configure sample rate for the perimeter and device-ingress sampling(0 - 99999). <span class="li-normal">type: int</span> <a id='label30' href="javascript:ContentClick('label31', 'label30');" onmouseover="ContentPreview('label31');" onmouseout="ContentUnpreview('label31');" title="click to collapse or expand..."> more... </a> <div id="label31" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>sample_rate</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">template_export_period</span> - Configure template export period (1-60). <span class="li-normal">type: int</span> <a id='label32' href="javascript:ContentClick('label33', 'label32');" onmouseover="ContentPreview('label33');" onmouseout="ContentUnpreview('label33');" title="click to collapse or expand..."> more... </a> <div id="label33" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>template_export_period</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>no</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">timeout_general</span> - Configure flow session general timeout (60-604800). <span class="li-normal">type: int</span> <a id='label34' href="javascript:ContentClick('label35', 'label34');" onmouseover="ContentPreview('label35');" onmouseout="ContentUnpreview('label35');" title="click to collapse or expand..."> more... </a> <div id="label35" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>timeout_general</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">timeout_icmp</span> - Configure flow session ICMP timeout (60-604800). <span class="li-normal">type: int</span> <a id='label36' href="javascript:ContentClick('label37', 'label36');" onmouseover="ContentPreview('label37');" onmouseout="ContentUnpreview('label37');" title="click to collapse or expand..."> more... </a> <div id="label37" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>timeout_icmp</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">timeout_max</span> - Configure flow session max timeout (60-604800). <span class="li-normal">type: int</span> <a id='label38' href="javascript:ContentClick('label39', 'label38');" onmouseover="ContentPreview('label39');" onmouseout="ContentUnpreview('label39');" title="click to collapse or expand..."> more... </a> <div id="label39" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>timeout_max</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">timeout_tcp</span> - Configure flow session TCP timeout (60-604800). <span class="li-normal">type: int</span> <a id='label40' href="javascript:ContentClick('label41', 'label40');" onmouseover="ContentPreview('label41');" onmouseout="ContentUnpreview('label41');" title="click to collapse or expand..."> more... </a> <div id="label41" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>timeout_tcp</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">timeout_tcp_fin</span> - Configure flow session TCP FIN timeout (60-604800). <span class="li-normal">type: int</span> <a id='label42' href="javascript:ContentClick('label43', 'label42');" onmouseover="ContentPreview('label43');" onmouseout="ContentUnpreview('label43');" title="click to collapse or expand..."> more... </a> <div id="label43" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>timeout_tcp_fin</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">timeout_tcp_rst</span> - Configure flow session TCP RST timeout (60-604800). <span class="li-normal">type: int</span> <a id='label44' href="javascript:ContentClick('label45', 'label44');" onmouseover="ContentPreview('label45');" onmouseout="ContentUnpreview('label45');" title="click to collapse or expand..."> more... </a> <div id="label45" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>timeout_tcp_rst</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">timeout_udp</span> - Configure flow session UDP timeout (60-604800). <span class="li-normal">type: int</span> <a id='label46' href="javascript:ContentClick('label47', 'label46');" onmouseover="ContentPreview('label47');" onmouseout="ContentUnpreview('label47');" title="click to collapse or expand..."> more... </a> <div id="label47" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> <td><code class="docutils literal notranslate">v7.2.0 </code></td> <td><code class="docutils literal notranslate">v7.2.1 </code></td> <td><code class="docutils literal notranslate">v7.2.2 </code></td> </tr> <tr> <td>timeout_udp</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> <li> <span class="li-head">transport</span> - Configure L4 transport protocol for exporting packets. <span class="li-normal">type: str</span> <span class="li-normal">choices: udp, tcp, sctp</span> <a id='label48' href="javascript:ContentClick('label49', 'label48');" onmouseover="ContentPreview('label49');" onmouseout="ContentUnpreview('label49');" title="click to collapse or expand..."> more... </a> <div id="label49" style="display:none"> <table border="1"> <tr> <td></td> <td><code class="docutils literal notranslate">v6.2.0 </code></td> <td><code class="docutils literal notranslate">v6.2.3 </code></td> <td><code class="docutils literal notranslate">v6.2.5 </code></td> <td><code class="docutils literal notranslate">v6.2.7 </code></td> <td><code class="docutils literal notranslate">v6.4.0 </code></td> <td><code class="docutils literal notranslate">v6.4.1 </code></td> <td><code class="docutils literal notranslate">v6.4.4 </code></td> <td><code class="docutils literal notranslate">v7.0.0 </code></td> <td><code class="docutils literal notranslate">v7.0.1 </code></td> <td><code class="docutils literal notranslate">v7.0.2 </code></td> <td><code class="docutils literal notranslate">v7.0.3 </code></td> <td><code class="docutils literal notranslate">v7.0.4 </code></td> <td><code class="docutils literal notranslate">v7.0.5 </code></td> <td><code class="docutils literal notranslate">v7.0.6 </code></td> <td><code class="docutils literal notranslate">v7.0.7 </code></td> <td><code class="docutils literal notranslate">v7.0.8 </code></td> </tr> <tr> <td>transport</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[udp]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[tcp]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> <tr> <td>[sctp]</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> <td>yes</td> </tr> </table> </div> </li> </ul> </ul>

    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: "0"
        collectors:
         -
            ip: "<your_own_value>"
            name: "default_name_10"
            port: "0"
            transport: "udp"
        format: "netflow1"
        level: "vlan"
        max_export_pkt_size: "512"
        sample_mode: "local"
        sample_rate: "512"
        template_export_period: "5"
        timeout_general: "3600"
        timeout_icmp: "300"
        timeout_max: "604800"
        timeout_tcp: "3600"
        timeout_tcp_fin: "300"
        timeout_tcp_rst: "120"
        timeout_udp: "300"
        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

    Status

    • This module is not guaranteed to have a backwards compatible interface.

    Authors

    • Link Zheng (@chillancezen)
    • Jie Xue (@JieX19)
    • Hongbin Lu (@fgtdev-hblu)
    • Frank Shen (@frankshen01)
    • Miguel Angel Munoz (@mamunozgonzalez)
    • Nicolas Thomas (@thomnico)

    Hint

    If you notice any issues in this documentation, you can create a pull request to improve it.