fortinet.fortios.fortios_ips_rule 模块 – 在 Fortinet 的 FortiOS 和 FortiGate 中配置 IPS 规则。

注意

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

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

要安装它,请使用:ansible-galaxy collection install fortinet.fortios。您需要进一步的要求才能使用此模块,请参阅 要求 了解详细信息。

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

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选择

  • false ←(默认)

  • true

ips_rule

字典

配置 IPS 规则。

action

字符串

操作。

选择

  • "pass"

  • "block"

application

字符串

易受攻击的应用程序。

date

整数

日期。

group

字符串

组。

location

列表 / 元素=字符串

易受攻击的位置。

log

字符串

启用/禁用日志记录。

选择

  • "disable"

  • "enable"

log_packet

字符串

启用/禁用数据包日志记录。

选择

  • "disable"

  • "enable"

metadata

列表 / 元素=字典

元数据。

id

整数 / 必需

ID。请参阅 注释

metaid

整数

元 ID。

valueid

整数

值 ID。

name

字符串 / 必需

规则名称。

os

字符串

易受攻击的操作系统。

rev

整数

修订版本。

rule_id

整数

规则 ID。

service

字符串

易受攻击的服务。

severity

字符串

严重性。

status

字符串

启用/禁用状态。

选择

  • "disable"

  • "enable"

member_path

字符串

要操作的成员属性路径。

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

标记有 member_path 的参数可用于执行成员操作。

member_state

字符串

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

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

选择

  • "present"

  • "absent"

state

字符串 / 必需

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

选择

  • "present"

  • "absent"

vdom

字符串

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

默认值: "root"

注释

注意

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

  • 该模块支持 check_mode。

示例

- name: Configure IPS rules.
  fortinet.fortios.fortios_ips_rule:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      ips_rule:
          action: "pass"
          application: "<your_own_value>"
          date: "0"
          group: "<your_own_value>"
          location: "<your_own_value>"
          log: "disable"
          log_packet: "disable"
          metadata:
              -
                  id: "11"
                  metaid: "0"
                  valueid: "0"
          name: "default_name_14"
          os: "<your_own_value>"
          rev: "0"
          rule_id: "0"
          service: "<your_own_value>"
          severity: "<your_own_value>"
          status: "disable"

返回值

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

描述

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"

版本

字符串

FortiGate 的版本

返回: 始终

示例: "v5.6.3"

作者

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)