fortinet.fortios.fortios_system_netflow 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 NetFlow。

注意

此模块是 fortinet.fortios 集合（版本 2.3.8）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块，请参阅要求以获取详细信息。

要在 playbook 中使用它，请指定：fortinet.fortios.fortios_system_netflow。

fortinet.fortios 2.0.0 中的新功能

概要 

此模块能够通过允许用户设置和修改系统功能和 NetFlow 类别来配置 FortiGate 或 FortiOS (FOS) 设备。示例包括在使用前需要调整到数据源的所有参数和值。已使用 FOS v6.0.0 进行测试

要求 

在执行此模块的主机上需要以下要求。

ansible>=2.15

参数 

参数	注释
access_token 字符串	基于令牌的身份验证。从 FortiGate 的 GUI 生成。
enable_log 布尔值	启用/禁用任务的日志记录。选择 `false` ←（默认） `true`
member_path 字符串	要操作的成员属性路径。如果存在多个属性，则用斜杠字符分隔。用 member_path 标记的参数对于执行成员操作是合法的。
member_state 字符串	在指定的属性路径下添加或删除成员。当指定 member_state 时，将忽略 state 选项。选择 `"present"` `"absent"`
system_netflow 字典	配置 NetFlow。
active_flow_timeout 整数	报告活动流的超时时间（60 - 3600 秒）。
collector_ip 字符串	收集器 IP。
collector_port 整数	NetFlow 收集器端口号。
collectors 列表 / elements=字典	NetFlow 收集器。
collector_ip 字符串	收集器 IP。
collector_port 整数	NetFlow 收集器端口号。
id 整数 / 必需	ID。请参阅 <a href=’#notes’>注释</a>。
interface 字符串	指定用于到达服务器的出站接口。源 system.interface.name。
interface_select_method 字符串	指定如何选择用于到达服务器的出站接口。选择 `"auto"` `"sdwan"` `"specify"`
source_ip 字符串	与 NetFlow 代理通信的源 IP 地址。
source_ip_interface 字符串	用于确定导出数据包的源 IP 的接口名称。源 system.interface.name。
exclusion_filters 列表 / elements=字典	排除过滤器
destination_ip 字符串	会话目标地址。
destination_port 字符串	会话目标端口号或范围。
id 整数 / 必需	过滤器 ID。请参阅 <a href=’#notes’>注释</a>。
protocol 整数	会话 IP 协议 (0 - 255)。
source_ip 字符串	session source address.
source_port 字符串	会话源端口号或范围。
inactive_flow_timeout 整数	定期报告已完成流的超时时间（10 - 600 秒）。
interface 字符串	指定用于到达服务器的出站接口。源 system.interface.name。
interface_select_method 字符串	指定如何选择用于到达服务器的出站接口。选择 `"auto"` `"sdwan"` `"specify"`
source_ip 字符串	与 NetFlow 代理通信的源 IP 地址。
template_tx_counter 整数	在重新发送模板流集记录之前的流集记录计数器。
template_tx_timeout 整数	定期模板流集传输的超时时间（60 - 86400 秒）。
vdom 字符串	虚拟域，在之前定义的那些之中。vdom 是 FortiGate 的虚拟实例，可以配置并用作不同的单元。默认值： `"root"`

注释 

注意

旧版 fortiosapi 已被弃用，httpapi 是运行 playbook 的首选方式

示例 

- 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"

返回值 

此处记录了常见的返回值此处，以下是此模块特有的字段

键	描述
build 字符串	FortiGate 映像的构建号返回：总是示例： `"1547"`
http_method 字符串	用于将内容配置到 FortiGate 的最后方法返回：总是示例： `"PUT"`
http_status 字符串	FortiGate 在上次应用的操作中给出的最后结果返回：总是示例： `"200"`
mkey 字符串	上次调用 FortiGate 时使用的主键（id）返回：成功示例： `"id"`
name 字符串	用于满足请求的表的名称返回：总是示例： `"urlfilter"`
path 字符串	用于满足请求的表的路径返回：总是示例： `"webfilter"`
revision 字符串	内部修订号返回：总是示例： `"17.0.2.10658"`
serial 字符串	设备的序列号返回：总是示例： `"FGVMEVYYQT3AB5352"`
status 字符串	操作结果的指示返回：总是示例： `"success"`
vdom 字符串	使用的虚拟域返回：总是示例： `"root"`
version 字符串	FortiGate 的版本返回：总是示例： `"v5.6.3"`

作者

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