fortinet.fortimanager.fmgr_ips_custom 模块 – 配置 IPS 自定义签名。

注意

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

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

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

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

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_custom

字典

设置的顶层参数。

action

字符串

默认操作

选择

  • "block"

  • "pass"

application

任意

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

comment

字符串

注释。

location

任意

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

log

字符串

启用/禁用日志记录。

选择

  • "disable"

  • "enable"

log_packet

别名：log-packet

字符串

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

选择

  • "disable"

  • "enable"

os

任意

(列表) 操作系统

protocol

字符串

协议

rule_id

别名：rule-id

整数

规则 ID。

severity

字符串

签名的相对严重性，从 info 到 critical。

sig_name

别名：sig-name

字符串

签名名称。

signature

字符串

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

status

字符串

启用/禁用此签名。

选择

  • "disable"

  • "enable"

tag

字符串 / 必需

签名标签。

proposed_method

字符串

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

选择

  • "update"

  • "set"

  • "add"

rc_failed

列表 / elements=integer

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

rc_succeeded

列表 / elements=integer

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

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 可帮助完成工作。

  • 要创建或更新对象，请使用状态 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: Configure IPS custom signature.
      fortinet.fortimanager.fmgr_ips_custom:
        bypass_validation: true
        adom: ansible
        state: present
        ips_custom:
          rule-id: 1 # Required, no less than 1000;
          signature: "F-SBID(--name: [string]; --service: [string]; --flow: [string])" # Required; Need follow signature syntax,
          # check 'https://docs.fortinet.com/document/ipsengine/3.6.0/custom-ips-and-application-control-signature-syntax-guide/
          # 274110/creating-ips-and-application-control-signatures' for more information;
          tag: ansible-ipscustom #  Required

- 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 IPS custom signatures
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "ips_custom"
          params:
            adom: "ansible"
            custom: "your_value"

返回值

通用返回值记录在 此处，以下是此模块独有的字段

键

描述

meta

字典

请求的结果。

已返回： 总是

request_url

字符串

请求的完整 URL。

已返回： 总是

示例： "/sys/login/user"

response_code

整数

API 请求的状态。

已返回： 总是

示例： 0

response_data

列表 / elements=string

API 响应。

已返回： 总是

response_message

字符串

API 响应的描述性消息。

已返回： 总是

示例： "OK."

system_information

字典

目标系统的信息。

已返回： 总是

rc

整数

请求的状态。

已返回： 总是

示例： 0

version_check_warning

列表 / elements=string

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

已返回： 复杂

作者

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)