fortinet.fortios.fortios_switch_controller_traffic_sniffer 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 FortiSwitch RSPAN/ERSPAN 流量嗅探参数。

注意

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

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

要安装它，请使用：ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块，请参阅要求了解详细信息。

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

fortinet.fortios 2.0.0 中的新功能

概要 

此模块能够通过允许用户设置和修改 switch_controller 功能和 traffic_sniffer 类别来配置 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"`
switch_controller_traffic_sniffer 字典	配置 FortiSwitch RSPAN/ERSPAN 流量嗅探参数。
erspan_ip 字符串	配置 ERSPAN 收集器 IP 地址。
mode 字符串	配置流量嗅探器模式。选择 `"erspan-auto"` `"rspan"` `"none"`
target_ip 列表 / 元素=字典	要筛选的嗅探器 IP。
description 字符串	嗅探器 IP 的描述。
dst_entry_id 整数	嗅探器 IP 的 FortiSwitch 目标条目 ID。
ip 字符串 / 必需	嗅探器 IP。
src_entry_id 整数	嗅探器 IP 的 FortiSwitch 源条目 ID。
target_mac 列表 / 元素=字典	要筛选的嗅探器 MAC。
description 字符串	嗅探器 MAC 的描述。
dst_entry_id 整数	嗅探器 MAC 的 FortiSwitch 目标条目 ID。
mac 字符串 / 必需	嗅探器 MAC。
src_entry_id 整数	嗅探器 MAC 的 FortiSwitch 源条目 ID。
target_port 列表 / 元素=字典	要筛选的嗅探器端口。
description 字符串	嗅探器端口条目的描述。
in_ports 列表 / 元素=字典	配置源入口端口接口。
name 字符串 / 必需	接口名称。
out_ports 列表 / 元素=字典	配置源出口端口接口。
name 字符串 / 必需	接口名称。
switch_id 字符串 / 必需	托管交换机 ID。源 switch-controller.managed-switch.switch-id。
vdom 字符串	虚拟域，在之前定义的那些域中。vdom 是 FortiGate 的虚拟实例，可以配置为不同的单元并使用。默认值： `"root"`

注释 

注意

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

示例 

- name: Configure FortiSwitch RSPAN/ERSPAN traffic sniffing parameters.
  fortinet.fortios.fortios_switch_controller_traffic_sniffer:
      vdom: "{{ vdom }}"
      switch_controller_traffic_sniffer:
          erspan_ip: "<your_own_value>"
          mode: "erspan-auto"
          target_ip:
              -
                  description: "<your_own_value>"
                  dst_entry_id: "2147483647"
                  ip: "<your_own_value>"
                  src_entry_id: "2147483647"
          target_mac:
              -
                  description: "<your_own_value>"
                  dst_entry_id: "2147483647"
                  mac: "<your_own_value>"
                  src_entry_id: "2147483647"
          target_port:
              -
                  description: "<your_own_value>"
                  in_ports:
                      -
                          name: "default_name_18"
                  out_ports:
                      -
                          name: "default_name_20"
                  switch_id: "<your_own_value> (source switch-controller.managed-switch.switch-id)"

返回值 

通用返回值记录在此处，以下是此模块独有的字段

键	描述
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)