check_point.mgmt.cp_mgmt_show_tasks – Retrieve all tasks and show their progress and details.

From Get docs
Ansible/docs/2.10/collections/check point/mgmt/cp mgmt show tasks module


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 1.0.6).

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

  • 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

  • name

Sorts results by the given field in ascending order.

DESC

string

  • name

Sorts results by the given field in descending order.

status

string

  • 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

  • no
  • yes

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



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)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/check_point/mgmt/cp_mgmt_show_tasks_module.html