check_point.mgmt.cp_mgmt_add_rules_batch 模块 – 批量创建新规则。当添加多个规则时,使用此 API 可实现最佳性能。

注意

此模块是 check_point.mgmt 集合(版本 6.2.1)的一部分。

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

要安装它,请使用:ansible-galaxy collection install check_point.mgmt

要在 playbook 中使用它,请指定:check_point.mgmt.cp_mgmt_add_rules_batch

check_point.mgmt 3.0.0 中的新功能

概要

  • 批量创建新规则。当添加多个规则时,使用此 API 可实现最佳性能。

  • 在特定位置向层添加多个规则,每个规则的位置递增一。

  • 使用此 API 时,会忽略错误和警告,操作将在忽略错误的同时应用更改。无法发布包含验证错误的更改。您必须使用“show-validations”API 来查看批处理创建导致的任何验证错误和警告。支持的规则类型包括 access-rule、nat-rule、https-rule 和 threat-exception。

  • 此模块不是幂等的。

  • 所有操作都通过 Web Services API 执行。

参数

参数

注释

auto_publish_session

布尔值

如果任务完成后执行了更改,则发布当前会话。

选择

  • false ←(默认)

  • true

objects

列表 / 元素=字典

按类型分隔的规则批次。

first_position

字符串

第一个规则位置。

layer

字符串

层名称或 uid。

list

列表 / 元素=字典

要在同一层上创建的相同类型的规则列表。
使用单个规则命令的“add”API 参考文档来查找请求的预期字段。
例如,要添加 access-rules,请使用 API 参考文档(在“访问控制和 NAT”下)中找到的“add-access-rule”命令。
请注意,添加一批规则时,不支持“set-if-exists”、“ignore-errors”、“ignore-warnings”和“details-level”选项。

type

字符串

要创建的规则类型。
仅支持上述类型。

version

字符串

检查点版本。如果未给出,则采用最新版本。

wait_for_task

布尔值

等待任务结束。例如发布任务。

选择

  • false

  • true ←(默认)

wait_for_task_timeout

整数

等待多少分钟后抛出超时错误。

默认值: 30

示例

- name: add-rules-batch
  cp_mgmt_add_rules_batch:
    objects:
    - first_position: top
      layer: Network
      list:
      - action: accept
        name: access rule 1
      - action: accept
        name: access rule 2
      type: access-rule
    - first_position: top
      layer: Standard
      list:
      - name: nat rule 1
      - name: nat rule 2
      type: nat-rule
    - first_position: top
      layer: Default Layer
      list:
      - name: https rule 1
      - name: https rule 2
      type: https-rule

返回值

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

描述

cp_mgmt_add_rules_batch

字典

检查点 add-rules-batch 输出。

已返回:始终。

作者

  • Eden Brillant (@chkp-edenbr)