check_point.mgmt.cp_mgmt_user_group_facts 模块 – 通过 Web 服务 API 获取 Checkpoint 上的用户组对象信息

注意

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

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

要安装它，请使用：ansible-galaxy collection install check_point.mgmt。

要在剧本中使用它，请指定：check_point.mgmt.cp_mgmt_user_group_facts。

check_point.mgmt 5.0.0 中的新增功能

概要

  • 获取 Checkpoint 设备上的用户组对象信息。

  • 所有操作均通过 Web 服务 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

字符串

用于按条件筛选对象的搜索表达式。提供的文本应与 SmartConsole 对象资源管理器中提供的文本完全相同。表达式中的逻辑运算符（‘AND’、‘OR’）应大写。搜索同时包含 IP 搜索和名称、注释、标签等文本搜索。

limit

整数

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

name

字符串

对象名称。此参数仅与获取特定对象相关。

offset

整数

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

order

列表 / 元素=字典

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

ASC

字符串

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

选项

  • "name"

DESC

字符串

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

选项

  • "name"

show_membership

布尔值

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

选项

  • false

  • true

version

字符串

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

示例

- name: show-user-group
  cp_mgmt_user_group_facts:
    name: myusergroup

- name: show-user-groups
  cp_mgmt_user_group_facts:
    details_level: full

作者

  • Eden Brillant (@chkp-edenbr)