check_point.mgmt.cp_mgmt_abort_get_interfaces module – Attempt to abort an on-going “get-interfaces” operation.
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_abort_get_interfaces
.
New in check_point.mgmt 5.0.0
Synopsis
Attempt to abort an on-going “get-interfaces” operation. This API might fail if the “get-interfaces” operation is in its final stage.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Forcefully abort the “get-interfaces” task. Choices:
|
|
get-interfaces task UID. |
|
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: abort-get-interfaces
cp_mgmt_abort_get_interfaces:
task_id: 45b185e7-9ccd-4971-b74b-d212282f8f96
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint abort-get-interfaces output. Returned: always. |