fortinet.fortios.fortios_firewall_on_demand_sniffer 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置按需数据包嗅探器。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要其他要求才能使用此模块,请参阅 要求 了解更多详情。

要在 playbook 中使用它,请指定:fortinet.fortios.fortios_firewall_on_demand_sniffer

fortinet.fortios 2.0.0 中的新增功能

概要

  • 此模块能够配置 FortiGate 或 FortiOS (FOS) 设备,允许用户设置和修改防火墙功能和 on_demand_sniffer 类别。示例包括所有参数,在使用前需要将值调整到数据源。已在 FOS v6.0.0 版本上进行测试。

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

基于令牌的身份验证。从 FortiGate 的 GUI 生成。

enable_log

布尔值

启用/禁用任务日志记录。

选项

  • false ← (默认)

  • true

firewall_on_demand_sniffer

字典

配置按需数据包嗅探器。

advanced_filter

字符串

高级自由格式过滤器,如果设置,将用于覆盖现有过滤器设置。只有超级管理员才能使用。

hosts

列表 / 元素=字典

在此流量嗅探器中过滤的 IPv4 或 IPv6 主机。

host

字符串 / 必需

IPv4 或 IPv6 主机。

interface

字符串

将进行按需数据包嗅探器的接口名称。源系统.interface.name。

max_packet_count

整数

每个按需数据包嗅探器捕获的最大数据包数。

name

字符串 / 必需

按需数据包嗅探器名称。

non_ip_packet

字符串

包含非 IP 数据包。

选项

  • "enable"

  • "disable"

ports

列表 / 元素=字典

在此流量嗅探器中过滤的端口。

port

整数 / 必需

在此流量嗅探器中过滤的端口。参见 注释

protocols

列表 / 元素=字典

在此流量嗅探器中过滤的协议。

protocol

整数 / 必需

IANA 定义的协议类型整数值 (0 - 255)。参见 注释

member_path

字符串

要操作的成员属性路径。

如果有多个属性,则用斜杠字符分隔。

标有 member_path 的参数对于执行成员操作是合法的。

member_state

字符串

在指定的属性路径下添加或删除成员。

指定 member_state 时,将忽略 state 选项。

选项

  • "present"

  • "absent"

state

字符串 / 必需

指示是创建还是删除对象。

选项

  • "present"

  • "absent"

vdom

字符串

虚拟域,在先前定义的虚拟域中。vdom 是 FortiGate 的虚拟实例,可以将其配置并用作不同的单元。

默认: "root"

注释

注意

  • 旧版 fortiosapi 已弃用,httpapi 是运行 playbook 的首选方法。

示例

- name: Configure on-demand packet sniffer.
  fortinet.fortios.fortios_firewall_on_demand_sniffer:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_on_demand_sniffer:
          advanced_filter: "<your_own_value>"
          hosts:
              -
                  host: "myhostname"
          interface: "<your_own_value> (source system.interface.name)"
          max_packet_count: "0"
          name: "default_name_8"
          non_ip_packet: "enable"
          ports:
              -
                  port: "<you_own_value>"
          protocols:
              -
                  protocol: "<you_own_value>"

返回值

此处记录了常见的返回值 此处,以下是此模块独有的字段。

描述

build

字符串

FortiGate 镜像的版本号

返回: 始终

示例: "1547"

http_method

字符串

上次用于将内容置备到 FortiGate 的方法

返回: 始终

示例: "PUT"

http_status

字符串

FortiGate 在上次应用的操作中给出的最后结果

返回: 始终

示例: "200"

mkey

字符串

上次调用 FortiGate 时使用的主密钥 (ID)

返回: 成功

示例: "id"

name

字符串

Name of the table used to fulfill the request

返回: 始终

示例: "urlfilter"

path

字符串

用于满足请求的表的路径

返回: 始终

示例: "webfilter"

revision

字符串

内部修订号

返回: 始终

示例: "17.0.2.10658"

serial

字符串

设备的序列号

返回: 始终

示例: "FGVMEVYYQT3AB5352"

status

字符串

操作结果的指示

返回: 始终

示例: "success"

vdom

字符串

Virtual domain used

返回: 始终

示例: "root"

version

字符串

FortiGate 的版本

返回: 始终

示例: "v5.6.3"

作者

  • 郑林 (@chillancezen)

  • 薛杰 (@JieX19)

  • 卢洪滨 (@fgtdev-hblu)

  • 沈方 (@frankshen01)

  • 米格尔·安吉尔·穆诺兹 (@mamunozgonzalez)

  • 尼古拉斯·托马斯 (@thomnico)