check_point.mgmt.cp_mgmt_show_task – Show task progress and details.

Note

This plugin is part of the check_point.mgmt collection (version 2.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_show_task.

New in version 2.9: of check_point.mgmt

Synopsis

  • Show task progress and details.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

details_level

string

The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.

Choices:

  • uid

  • standard

  • full

task_id

list / elements=string

Unique identifier of one or more tasks.

version

string

Version of checkpoint. If not given one, the latest version taken.

wait_for_task

boolean

Wait for the task to end. Such as publish task.

Choices:

  • no

  • yes ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

cp_mgmt_show_task

dictionary

The checkpoint show-task output.

Returned: always.

Authors

  • Or Soffer (@chkp-orso)