check_point.mgmt.cp_mgmt_show_tasks – Retrieve all tasks and show their 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_tasks.

New in version 2.9: of check_point.mgmt

Synopsis

  • Retrieve all tasks and show their progress and details.

  • All operations are performed over Web Services API.

Parameters

Parameter Choices/Defaults Comments
details_level
string
    Choices:
  • uid
  • standard
  • full
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.
from_date
string
The date from which tracking tasks is to be performed, by the task's last update date. ISO 8601. If timezone isn't specified in the input, the Management server's timezone is used.
initiator
string
Initiator's name. If name isn't specified, tasks from all initiators will be shown.
limit
integer
The maximal number of returned results.
offset
integer
Number of the results to initially skip.
order
list / elements=string
Sorts results by the given field. By default the results are sorted in the descending order by the task's last update date.
ASC
string
    Choices:
  • name
Sorts results by the given field in ascending order.
DESC
string
    Choices:
  • name
Sorts results by the given field in descending order.
status
string
    Choices:
  • successful
  • failed
  • in-progress
  • all
Status.
to_date
string
The date until which tracking tasks is to be performed, by the task's last update date. ISO 8601. If timezone isn't specified in the input, the Management server's timezone is used.
version
string
Version of checkpoint. If not given one, the latest version taken.
wait_for_task
boolean
    Choices:
  • no
  • yes ←
Wait for the task to end. Such as publish task.
wait_for_task_timeout
integer
Default:
30
How many minutes to wait until throwing a timeout error.

Examples

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

Return Values

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

Key Returned Description
cp_mgmt_show_tasks
dictionary
always.
The checkpoint show-tasks output.



Authors

  • Or Soffer (@chkp-orso)