check_point.mgmt.cp_mgmt_access_rule_facts 模块 – 通过 Web Services API 获取 Check Point 上的访问规则对象信息

注意

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

check_point.mgmt 1.0.0 中新增

概要

  • 获取 Check Point 设备上的访问规则对象信息。

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

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

参数

参数

注释

dereference_group_members

布尔值

指示是否取消对回复中每个对象的“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

布尔值

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

选项

  • false

  • true

expand_group_with_exclusion_members

布尔值

如果为 true，则如果搜索表达式包含带排除项的组对象的 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"

hits_settings

字典

N/A

from_date

字符串

格式，“YYYY-MM-DD”、“YYYY-mm-ddThh:mm:ss”。

target

字符串

目标网关名称或 UID。

to_date

字符串

格式，“YYYY-MM-DD”、“YYYY-mm-ddThh:mm:ss”。

layer

字符串

规则所属的层，由名称或 UID 标识。

limit

整数

最多返回这么多结果。此参数仅与获取少量对象相关。

name

字符串

对象名称。在域中应唯一。

offset

整数

在开始返回结果之前跳过这么多结果。此参数仅与获取少量对象相关。

order

列表 / 元素=字典

按给定字段对结果进行排序。默认情况下，结果按名称升序排序。此参数仅与获取少量对象相关。

ASC

字符串

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

选项

  • "name"

DESC

字符串

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

选项

  • "name"

package

字符串

包的名称。

show_as_ranges

布尔值

如果为 true，则源、目标和服务与应用程序参数将显示为 IP 地址和端口号的范围，而不是网络对象。
不使用 IP 地址或端口号表示的对象将作为对象呈现。
此外，每个规则的响应不包含参数、源、源否定、目标、目标否定、服务和服务否定，而是包含参数、源范围、目标范围和服务范围。

注意，请求将规则显示为范围最多限于每个请求 20 条规则，否则将返回错误。如果您希望请求更多规则，请使用 offset 和 limit 参数来限制您的请求。

选项

  • false

  • true

show_hits

布尔值

N/A

选项

  • false

  • true

show_membership

布尔值

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

选项

  • false

  • true

use_object_dictionary

布尔值

N/A

选项

  • false

  • true

version

字符串

Checkpoint 的版本。如果未指定，则使用最新版本。

示例

- name: show-access-rule
  cp_mgmt_access_rule_facts:
    layer: Network
    name: Rule 1

- name: show-access-rulebase
  cp_mgmt_access_rule_facts:
    details_level: standard
    limit: 20
    name: Network
    offset: 0
    use_object_dictionary: true

作者

  • Or Soffer (@chkp-orso)