check_point.mgmt.cp_mgmt_objects_facts 模块 – 通过 Web Services API 获取 Checkpoint 对象事实

注意

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

check_point.mgmt 3.0.0 中的新增功能

概要

  • 获取 Checkpoint 设备上的对象事实。

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

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

参数

参数

注释

dereference_group_members

布尔值

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

选项

  • false

  • true

details_level

字符串

响应中某些字段的详细级别可以变化，从仅显示对象的 UID 值到对象的完整详细表示。

选项

  • "uid"

  • "standard"

  • "full"

domains_to_process

列表 / 元素=字符串

指示在哪些域上处理命令。它不能与 details-level full 一起使用，必须仅从系统域运行，并且 ignore-warnings 为 true。有效值为 CURRENT_DOMAIN、ALL_DOMAINS_ON_THIS_SERVER。

filter

字符串

用于按条件过滤对象的搜索表达式。提供的文本应与在 Smart Console 中提供的文本完全相同。表达式中的逻辑运算符（'AND'、'OR'）应大写。默认情况下，搜索同时涉及文本搜索和 IP 搜索。要仅使用 IP 搜索，请将“ip-only”参数设置为 true。

ip_only

布尔值

如果使用“filter”，请使用此字段仅按对象的 IP 地址进行搜索，不涉及文本搜索。

IP 搜索用例
     

  • 完全 IPv4 地址匹配，
                 - 主机、Check Point 主机和网关，具有完全 IPv4 匹配或其子网包含搜索地址的接口
                 - 包含搜索地址的 IPv4 网络和 IPv4 地址范围

    •      
  • 部分 IPv4 地址匹配，
                 - 主机、网络、Check Point 主机和网关，其 IPv4 地址从搜索地址开始
                 - 主机、Check Point 主机和网关，其子网地址从搜索地址开始的接口
                 - 第一个地址或最后一个地址从搜索地址开始的 IPv4 地址范围
                 - 包含从搜索地址派生的网络（补充缺少的八位字节（全为零））的 IPv4 网络和 IPv4 地址范围
                 - 主机、Check Point 主机和网关，其子网包含从搜索地址派生的网络（补充缺少的八位字节（全为零））的接口

    •      
  • IPv6 地址，
                 - 不支持


* Check Point 主机是网络策略管理、日志记录和状态、SmartEvent 等类型的服务器。
* 当检查一个 IP 地址是否从另一个（部分）IP 地址开始时 - 仅考虑完整的八位字节
* 请参阅示例部分以了解 IP 搜索示例。

选项

  • false

  • true

limit

整数

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

offset

整数

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

order

列表 / 元素=字典

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

ASC

字符串

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

选项

  • "name"

DESC

字符串

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

选项

  • "name"

show_membership

布尔值

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

选项

  • false

  • true

type

字符串

对象的类型，例如，host、service-tcp、network、address-range…

uid

字符串

对象的唯一标识符。

uids

列表 / 元素=字符串

要检索的对象的 UID 列表。

version

字符串

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

示例

- name: show-objects
  cp_mgmt_objects_facts:
    limit: 50
    offset: 0
    order:
    - ASC: name
    type: group

- name: show-object
  cp_mgmt_objects_facts:
    uid: ef82887c-d08f-49a3-a18f-a376be633848

作者

  • Eden Brillant (@chkp-edenbr)