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

注意

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

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

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

要在剧本中使用它，请指定：fortinet.fortimanager.fmgr_ips_sensor_entries。

fortinet.fortimanager 2.0.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_sensor_entries

字典

顶层参数集。

action

字符串

检测到签名时对流量采取的操作。

选项

  • "pass"

  • "block"

  • "reset"

  • "default"

application

any

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

cve

any

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

default_action

别名: default-action

字符串

签名默认操作过滤器。

选项

  • "block"

  • "pass"

  • "all"

  • "drop"

default_status

别名: default-status

字符串

签名默认状态过滤器。

选项

  • "disable"

  • "enable"

  • "all"

exempt_ip

别名: exempt-ip

列表 / 元素=字典

豁免 IP。

dst_ip

别名: dst-ip

字符串

目标 IP 地址和网络掩码。

id

整数

豁免 IP ID。

src_ip

别名: src-ip

字符串

源 IP 地址和网络掩码。

id

整数 / 必需

IPS 数据库中的规则 ID

last_modified

别名: last-modified

any

(列表或字符串) 按签名上次修改日期筛选。

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

any

(列表或字符串) 标识要添加到传感器的预定义或自定义 IPS 签名。

severity

any

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

status

字符串

筛选器中包含的签名的状态。

选项

  • "disable"

  • "enable"

  • "default"

tags

字符串

为 IPS 传感器分配自定义标签筛选器。

vuln_type

别名: vuln-type

any

(列表) 要按其筛选的签名漏洞类型列表。

proposed_method

字符串

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

选项

  • "update"

  • "set"

  • "add"

rc_failed

列表 / 元素=整数

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

rc_succeeded

列表 / 元素=整数

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

sensor

字符串 / 必需

请求 URL 中的参数（传感器）。

state

字符串 / 必需

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

选项

  • "present"

  • "absent"

workspace_locking_adom

字符串

在工作区模式下运行的 FortiManager 要锁定的 ADOM，该值可以是 global 和其他包括 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 帮助完成工作。

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

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

  • 通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 覆盖失败或成功的条件

示例

- name: Example playbook
  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_sensor_entries:
        bypass_validation: false
        adom: ansible
        sensor: "ansible-test-ipssensor" # name
        state: present
        ips_sensor_entries:
          action: block # <value in [pass, block, reset, ...]>
          id: 1

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the filters of IPS sensor
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "ips_sensor_entries"
          params:
            adom: "ansible"
            sensor: "ansible-test-ipssensor" # name
            entries: "your_value"

返回值

常见的返回值记录在这里，以下是此模块独有的字段

键

描述

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

列表 / 元素=字符串

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

返回: 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)