fortinet.fortios.fortios_ips_custom 模块 – 在 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_custom

fortinet.fortios 2.0.0 中的新增功能

概要

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

要求

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

  • ansible>=2.15

参数

参数

注释

access_token

字符串

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

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

ips_custom

字典

配置 IPS 自定义签名。

action

字符串

此签名的默认操作(允许或阻止)。

选项

  • "pass"

  • "block"

application

列表 / 元素=字符串

要保护的应用程序。留空表示所有应用程序。

comment

字符串

注释。

location

列表 / 元素=字符串

保护客户端或服务器流量。

log

字符串

启用/禁用日志记录。

选项

  • "disable"

  • "enable"

log_packet

字符串

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

选项

  • "disable"

  • "enable"

os

列表 / 元素=字符串

签名保护的操作系统。留空表示所有操作系统。

protocol

字符串

签名扫描的协议。留空表示所有协议。

rule_id

整数

签名 ID。

severity

字符串

签名的相对严重性,从信息到严重。签名生成的日志消息包含严重性。

sig_name

字符串

签名名称。

signature

字符串

用单引号括起来的自定义签名。

status

字符串

启用/禁用此签名。

选项

  • "disable"

  • "enable"

tag

字符串 / 必需

签名标签。

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 custom signature.
  fortinet.fortios.fortios_ips_custom:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      ips_custom:
          action: "pass"
          application: "<your_own_value>"
          comment: "Comment."
          location: "<your_own_value>"
          log: "disable"
          log_packet: "disable"
          os: "<your_own_value>"
          protocol: "<your_own_value>"
          rule_id: "0"
          severity: "<your_own_value>"
          sig_name: "<your_own_value>"
          signature: "<your_own_value>"
          status: "disable"
          tag: "<your_own_value>"

返回值

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

描述

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"

作者

  • 郑凌 (@chillancezen)

  • 薛杰 (@JieX19)

  • 陆宏斌 (@fgtdev-hblu)

  • 沈芳 (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)