check_point.mgmt.cp_mgmt_delete_api_key module – Delete the API key. For the key to be invalid publish is needed.
Note
This module is part of the check_point.mgmt collection (version 6.4.1).
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_delete_api_key
.
New in check_point.mgmt 2.0.0
Synopsis
Delete the API key. For the key to be invalid publish is needed.
All operations are performed over Web Services API.
Available from R80.40 management version.
Parameters
Parameter |
Comments |
---|---|
Administrator name to generate API key for. |
|
Administrator uid to generate API key for. |
|
API key to be deleted. |
|
Publish the current session if changes have been performed after task completes. Choices:
|
|
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: delete-api-key
cp_mgmt_delete_api_key:
# sgignore next_line
api_key: eea3be76f4a8eb740ee872bcedc692748ff256a2d21c9ffd2754facbde046d00
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint delete-api-key output. Returned: always. |