check_point.mgmt.cp_mgmt_show_task module – Show task progress and details.
Note
This module is part of the check_point.mgmt collection (version 5.2.3).
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 check_point.mgmt 2.0.0
DEPRECATED
- Removed in:
major release after 2024-11-01
- Why:
Newer single facts module released.
- Alternative:
cp_mgmt_task_facts
Synopsis
Show task progress and details.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
Publish the current session if changes have been performed after task completes. Choices:
|
|
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:
|
|
Unique identifier of one or more tasks. |
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
How many minutes to wait until throwing a timeout error. Default: |
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 |
---|---|
The checkpoint show-task output. Returned: always. |
Status
This module will be removed in a major release after 2024-11-01. [deprecated]
For more information see DEPRECATED.