check_point.mgmt.cp_mgmt_https_rule_facts 模块 – 通过 Web Services API 获取 Checkpoint 上 https-rule 对象信息

注意

此模块是 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_https_rule_facts。

check_point.mgmt 6.0.0 中的新增功能

概要

  • 获取 Checkpoint 设备上的 https-rule 对象信息。

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

  • 此模块处理两种操作：获取特定对象和获取多个对象。要获取特定对象，请使用参数“name”。

  • 仅适用于 R82 及更高版本的管理机器

参数

参数

注释

dereference_group_members

布尔值

指示是否取消引用每个回复中对象的详细信息级别的“成员”字段。

选项

  • false

  • true

details_level

字符串

响应中某些字段的详细程度可以从仅显示对象的 UID 值到对象的完整详细表示形式不等。

选项

  • "uid"

  • "standard"

  • "full"

filter

字符串

用于过滤规则库的搜索表达式。提供的文本应与在 Smart Console 中提供的文本完全相同。表达式中的逻辑运算符（‘AND’，‘OR’）应大写。如果未使用运算符，则应用默认的 OR 运算符。

filter_settings

字典

设置过滤器首选项。

packet_search_settings

字典

当“search-mode”设置为“packet”时，此对象允许设置数据包搜索首选项。

expand_group_members

布尔值

如果为真，则如果搜索表达式包含组对象的 UID 或名称，结果将包含与该组的至少一个成员匹配的规则。

选项

  • false

  • true

expand_group_with_exclusion_members

布尔值

如果为真，则如果搜索表达式包含带排除项的组对象的 UID 或名称，结果将包含与“include”部分的至少一个成员匹配且不是“except”部分成员的规则。

选项

  • false

  • true

match_on_any

布尔值

是否匹配“Any”对象。

选项

  • false

  • true

match_on_group_with_exclusion

布尔值

是否匹配带排除项的组。

选项

  • false

  • true

match_on_negate

布尔值

是否匹配否定的单元格。

选项

  • false

  • true

search_mode

字符串

设置为“general”时，全文搜索和数据包搜索均启用。在此模式下，数据包搜索将不匹配“Any”对象、否定的单元格或带排除项的组。当 search-mode 设置为“packet”时，默认情况下，启用对“Any”对象、否定的单元格或带排除项的组的匹配。可以提供 packet-search-settings 来更改默认行为。

选项

  • "general"

  • "packet"

layer

字符串

保存对象的层。由名称或 UID 标识。

limit

整数

返回结果的最大数量。此参数仅与获取少量对象相关。

name

字符串

对象名称。在域中必须唯一。此参数仅与获取少量对象相关。

offset

整数

最初跳过的结果数量。此参数仅与获取少量对象相关。

order

列表 / 元素=字典

按搜索条件对结果进行排序。自动按名称升序排序结果。此参数仅与获取少量对象相关。

ASC

字符串

按给定字段升序排序结果。

选项

  • "name"

DESC

字符串

按给定字段降序排序结果。

选项

  • "name"

package

字符串

包的名称。

show_membership

布尔值

指示是否计算并显示每个回复中对象的“组”字段。

选项

  • false

  • true

use_object_dictionary

布尔值

接收对象 ID 和整个对象之间的映射。

选项

  • false

  • true

version

字符串

Checkpoint 的版本。如果没有给出版本，则采用最新版本。

示例

- name: show-https-rule
  cp_mgmt_https_rule_facts:
    name: FirstRule
    layer: Default Outbound Layer

- name: show-https-rulebase
  cp_mgmt_https_rule_facts:
    details_level: standard
    limit: 20
    name: Default Outbound Layer
    offset: 0
    use_object_dictionary: false

作者

  • Eden Brillant (@chkp-edenbr)