Skip to content

Latest commit

 

History

History
160 lines (122 loc) · 8.46 KB

fortiswitch_system_flow_export.rst

File metadata and controls

160 lines (122 loc) · 8.46 KB
Raw
source:fortiswitch_system_flow_export.py
orphan:

fortiswitch_system_flow_export -- System Flow Export settings in Fortinet's FortiSwitch

.. versionadded:: 1.0.0

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify system feature and flow_export category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

FortiSW Version Compatibility


Supported Version Ranges
fortiswitch_system_flow_export v7.0.0 -> latest

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • 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
  • system_flow_export - System Flow Export settings. type: dict
    • aggregates - Aggregates. type: list
      • id - Aggregate id. type: int
      • ip - Aggregate"s IP and Mask. type: str
    • collectors - Collectors. type: list
      • ip - IP address. type: str
      • name - Collector name. type: str
      • port - Port number (0-65535). type: int
      • transport - Export transport (udp|tcp|sctp). type: str choices: udp, tcp, sctp
    • filter - Filter (BPF). type: str
    • format - Export Format (netflow1|netflow5|netflow9|ipfix). type: str choices: netflow1, netflow5, netflow9, ipfix
    • identity - Set identity of switch (0x00000000-0xFFFFFFFF ). type: int
    • level - Export Level (vlan|ip|port|protocol|mac). type: str choices: mac, ip, proto, port, vlan
    • max_export_pkt_size - Max Export Packet Size (512-9216). type: int
    • template_export_period - Template export period in minutes (1-60). type: int
    • timeout_general - Flow Session General Timeout (60-604800). type: int
    • timeout_icmp - Flow Session ICMP Timeout (60-604800). type: int
    • timeout_max - Flow Session MAX Timeout (60-604800). type: int
    • timeout_tcp - Flow Session TCP Timeout (60-604800). type: int
    • timeout_tcp_fin - Flow Session TCP Fin Timeout (60-604800). type: int
    • timeout_tcp_rst - Flow Session TCP Reset Timeout (60-604800). type: int
    • timeout_udp - Flow Session UDP Timeout (60-604800). type: int

Examples

- name: System Flow Export settings.
  fortinet.fortiswitch.fortiswitch_system_flow_export:
      system_flow_export:
          aggregates:
              -
                  id: "4"
                  ip: "<your_own_value>"
          collectors:
              -
                  ip: "<your_own_value>"
                  name: "default_name_8"
                  port: "9"
                  transport: "udp"
          filter: "<your_own_value>"
          format: "netflow1"
          identity: "13"
          level: "mac"
          max_export_pkt_size: "15"
          template_export_period: "16"
          timeout_general: "17"
          timeout_icmp: "18"
          timeout_max: "19"
          timeout_tcp: "20"
          timeout_tcp_fin: "21"
          timeout_tcp_rst: "22"
          timeout_udp: "23"

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 fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch 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
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

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)

Hint

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