check_point.mgmt.cp_mgmt_show_unused_objects 模块 – 检索所有未使用的对象。

注意

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

check_point.mgmt 5.0.0 中的新增功能

概要

  • 检索所有未使用的对象。

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

参数

参数

注释

auto_publish_session

布尔值

如果任务完成后执行了更改,则发布当前会话。

选项

  • false ← (默认)

  • true

dereference_group_members

布尔值

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

选项

  • false

  • true

details_level

字符串

响应中某些字段的详细级别可能有所不同,从仅显示对象的 UID 值到对象的完整详细表示形式。

选项

  • "uid"

  • "standard"

  • "full"

domains_to_process

列表 / 元素=字符串

指示要在哪些域上处理命令。它不能与详细级别 full 一起使用,必须仅从系统域运行,并且忽略警告必须为 true。有效值为 CURRENT_DOMAIN、ALL_DOMAINS_ON_THIS_SERVER。

filter

字符串

用于筛选对象的搜索表达式。提供的文本应与 SmartConsole 对象资源管理器中提供的文本完全相同。表达式中的逻辑运算符(“AND”、“OR”)应以大写字母提供。搜索包括 IP 搜索和名称、注释、标签等中的文本搜索。

limit

整数

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

offset

整数

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

order

列表 / 元素=字典

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

ASC

字符串

按给定字段以升序对结果进行排序。

选项

  • "name"

DESC

字符串

按给定字段以降序对结果进行排序。

选项

  • "name"

show_membership

布尔值

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

选项

  • false

  • true

version

字符串

检查点的版本。如果未给出版本,则采用最新版本。

wait_for_task

布尔值

等待任务结束。例如发布任务。

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

等待多长时间(以分钟为单位)直到抛出超时错误。

默认值: 30

示例

- name: show-unused-objects
  cp_mgmt_show_unused_objects:
    details_level: standard
    limit: 50
    offset: 0

返回值

常见返回值记录在此处,以下是此模块独有的字段

描述

cp_mgmt_show_unused_objects

字典

检查点 show-unused-objects 的输出。

返回: 总是。

作者

  • Eden Brillant (@chkp-edenbr)