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 地址搜索，而不涉及文本搜索。<br><br>IP 搜索用例<br>     <ul><li>完全匹配 IPv4 地址，针对<br>         - 主机、具有精确 IPv4 匹配或其接口子网包含搜索地址的 Check Point 主机和网关<br>         - 包含搜索地址的 IPv4 网络和 IPv4 地址范围</li> <br>     <li>部分匹配 IPv4 地址，针对<br>         - IPv4 地址以搜索地址开头的主机、网络、Check Point 主机和网关<br>         - 其接口子网地址以搜索地址开头的主机、Check Point 主机和网关<br>         - 首地址或末地址以搜索地址开头的 IPv4 地址范围<br>         - 包含从搜索地址导出的网络并补充缺失八位字节（全部为零）的 IPv4 网络和 IPv4 地址范围<br>         - 其接口子网包含从搜索地址导出的网络并补充缺失八位字节（全部为零）的主机、Check Point 主机和网关</li><br>     <li>IPv6 地址，<br>         - 不支持</li></ul><br><br> * Check Point Host 是一种网络策略管理、日志记录和状态、SmartEvent 等类型的服务器。<br> * 当检查一个 IP 地址是否从另一个（部分）IP 地址开始时，仅考虑完整的八位字节 <br> * 有关 IP 搜索示例，请参阅“示例”部分。选项 `false` `true`
limit 整数	返回结果的最大数量。此参数仅与获取特定对象相关。
offset 整数	最初跳过的结果数。此参数仅与获取特定对象相关。
order 列表 / 元素=字典	按搜索条件对结果进行排序。默认按名称以升序对结果进行排序。此参数仅与获取特定对象相关。
ASC 字符串	按给定字段以升序对结果进行排序。选项 `"name"`
DESC 字符串	按给定字段以降序对结果进行排序。选项 `"name"`
show_membership 布尔值	指示是否计算并显示回复中每个对象的“groups”字段。选项 `false` `true`
type 字符串	对象的类型，例如，主机、service-tcp、网络、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)

check_point.mgmt.cp_mgmt_objects_facts 模块 – 通过 Web Services API 获取 Checkpoint 上的对象信息

概要

参数

示例

作者

集合链接

概要 

参数 

示例 