fortinet.fortimanager.fmgr_ips_baseline_sensor_entries 模块 – IPS 传感器过滤器。

注意

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

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

要安装它，请使用： ansible-galaxy collection install fortinet.fortimanager。

要在 playbook 中使用它，请指定： fortinet.fortimanager.fmgr_ips_baseline_sensor_entries。

fortinet.fortimanager 2.2.0 中的新增功能

概要

  • 此模块能够配置 FortiManager 设备。

  • 示例包括所有参数和值，在使用前需要根据数据源进行调整。

参数

参数

注释

access_token

字符串

无需用户名和密码即可访问 FortiManager 的令牌。

adom

字符串 / 必需

请求 URL 中的参数 (adom)。

bypass_validation

布尔值

仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。

选项

  • false ← (默认)

  • true

enable_log

布尔值

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

选项

  • false ← (默认)

  • true

forticloud_access_token

字符串

使用 FortiCloud API 访问令牌对 Ansible 客户端进行身份验证。

ips_baseline_sensor_entries

字典

设置的顶级参数。

action

字符串

对检测到签名的数据流采取的操作。

选项

  • "pass"

  • "block"

  • "reset"

  • "default"

application

any

(列表) 要保护的应用程序。

cve

any

(列表) 要添加到传感器的签名的 CVE ID 列表

exempt_ip

别名：exempt-ip

列表 / 元素=字典

豁免 IP。

dst_ip

别名：dst-ip

字符串

目标 IP 地址和网络掩码。

id

整数

豁免 IP ID。

src_ip

别名：src-ip

字符串

源 IP 地址和网络掩码。

id

整数 / 必需

IPS 数据库中的规则 ID

location

any

(列表) 保护客户端或服务器流量。

log

字符串

启用/禁用过滤器中包含的签名的日志记录。

选项

  • "disable"

  • "enable"

log_attack_context

别名：log-attack-context

字符串

启用/禁用攻击上下文的日志记录

选项

  • "disable"

  • "enable"

log_packet

别名：log-packet

字符串

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

选项

  • "disable"

  • "enable"

os

any

(列表) 要保护的操作系统。

protocol

any

(列表) 要检查的协议。

quarantine

字符串

隔离方法。

选项

  • "none"

  • "attacker"

  • "both"

  • "interface"

quarantine_expiry

别名：quarantine-expiry

字符串

隔离持续时间。

quarantine_log

别名：quarantine-log

字符串

启用/禁用隔离日志记录。

选项

  • "disable"

  • "enable"

rate_count

别名：rate-count

整数

速率计数。

rate_duration

别名：rate-duration

整数

持续时间

rate_mode

别名：rate-mode

字符串

速率限制模式。

选项

  • "periodical"

  • "continuous"

rate_track

别名：rate-track

字符串

跟踪数据包协议字段。

选项

  • "none"

  • "src-ip"

  • "dest-ip"

  • "dhcp-client-mac"

  • "dns-domain"

rule

字符串

标识要添加到传感器的预定义或自定义 IPS 签名。

severity

any

(列表) 签名的相对严重性，从信息到严重。

status

字符串

过滤器中包含的签名的状态。

选项

  • "disable"

  • "enable"

  • "default"

tags

字符串

标签。

proposed_method

字符串

底层 Json RPC 请求的覆盖方法。

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

将覆盖失败条件的 rc 代码列表。

rc_succeeded

列表 / 元素=整数

将覆盖成功条件的 rc 代码列表。

sensor

字符串 / 必需

请求 URL 中的参数 (sensor)。

state

字符串 / 必需

创建、更新或删除对象的指令。

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行 FortiManager 时要锁定的 adom，该值可以是全局的和其他值，包括 root。

workspace_locking_timeout

整数

等待其他用户释放工作区锁的最大时间（秒）。

默认值： 300

备注

注意

  • 从 2.4.0 版本开始，所有输入参数都使用下划线命名约定（snake_case）。请将诸如“var-name”之类的参数更改为“var_name”。旧的参数名称仍然可用，但您会收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。

  • 此 FortiManager 模块支持在工作区锁定模式下运行，顶级参数 workspace_locking_adom 和 workspace_locking_timeout 有助于完成这项工作。

  • 要创建或更新对象，请使用 state present 指令。

  • 要删除对象，请使用 state absent 指令。

  • 通常情况下，如果模块返回非零 rc 值，则运行该模块可能会失败。您也可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件。

示例

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: IPS sensor filter.
      fortinet.fortimanager.fmgr_ips_baseline_sensor_entries:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        sensor: <your own value>
        state: present # <value in [present, absent]>
        ips_baseline_sensor_entries:
          action: <value in [pass, block, reset, ...]>
          application: <list or string>
          cve: <list or string>
          exempt_ip:
            -
              dst_ip: <string>
              id: <integer>
              src_ip: <string>
          id: <integer>
          location: <list or string>
          log: <value in [disable, enable]>
          log_attack_context: <value in [disable, enable]>
          log_packet: <value in [disable, enable]>
          os: <list or string>
          protocol: <list or string>
          quarantine: <value in [none, attacker, both, ...]>
          quarantine_expiry: <string>
          quarantine_log: <value in [disable, enable]>
          rate_count: <integer>
          rate_duration: <integer>
          rate_mode: <value in [periodical, continuous]>
          rate_track: <value in [none, src-ip, dest-ip, ...]>
          rule: <string>
          severity: <list or string>
          status: <value in [disable, enable, default]>
          tags: <string>

返回值

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

键

描述

meta

字典

请求的结果。

返回值：始终返回

request_url

字符串

请求的完整 URL。

返回值：始终返回

示例："/sys/login/user"

response_code

整数

API 请求的状态。

返回值：始终返回

示例：0

response_data

列表 / 元素=字符串

API 响应。

返回值：始终返回

response_message

字符串

API 响应的描述性消息。

返回值：始终返回

示例："OK."

system_information

字典

目标系统的信息。

返回值：始终返回

rc

整数

请求的状态。

返回值：始终返回

示例：0

version_check_warning

列表 / 元素=字符串

如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。

返回值：复杂类型

作者

  • 杜欣伟 (@dux-fortinet)

  • 李星 (@lix-fortinet)

  • 薛杰 (@JieX19)

  • 郑琳 (@chillancezen)

  • 沈芳 (@fshen01)

  • 陆宏斌 (@fgtdev-hblu)