check_point.mgmt.cp_mgmt_task_facts 模块 – 通过 Web 服务 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_task_facts。

check_point.mgmt 5.0.0 版本新增

概要

  • 获取 Checkpoint 设备上的任务对象信息。

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

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

参数

参数

注释

details_level

字符串

响应中某些字段的详细程度可能会有所不同，从仅显示对象的 UID 值到对象的完整详细表示。

选项

  • "uid"

  • "standard"

  • "full"

from_date

字符串

根据任务的最后更新日期，从中开始跟踪任务的日期。ISO 8601。如果输入中未指定时区，则使用管理服务器的时区。

initiator

字符串

发起人的姓名。如果未指定姓名，将显示所有发起人的任务。

limit

整数

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

offset

整数

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

order

列表 / 元素=字典

按给定字段对结果进行排序。默认情况下，结果按任务最后更新日期的降序排序。此参数仅与获取少量对象有关。

ASC

字符串

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

选项

  • "name"

DESC

字符串

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

选项

  • "name"

status

字符串

状态。

选项

  • "successful"

  • "failed"

  • "in-progress"

  • "all"

task_id

列表 / 元素=字符串

一个或多个任务的唯一标识符。

to_date

字符串

根据任务的最后更新日期，跟踪任务要执行到的日期。ISO 8601。如果输入中未指定时区，则使用管理服务器的时区。

version

字符串

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

示例

- name: show-task
  cp_mgmt_task_facts:
    task_id: 2eec70e5-78a8-4bdb-9a76-cfb5601d0bcb

- name: show-tasks
  cp_mgmt_task_facts:
    from_date: '2018-05-23T08:00:00'
    initiator: admin1
    status: successful

作者

  • Eden Brillant (@chkp-edenbr)