check_point.mgmt.cp_mgmt_add_api_key module – Add API key for administrator, to enable login with it. For the key to be valid publish is needed.
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_add_api_key
.
New in check_point.mgmt 2.0.0
Synopsis
Add API key for administrator, to enable login with it. For the key to be valid publish is needed. <br>When using mgmt_cli tool, add -f json to get the key in the command’s output.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
Administrator name to generate API key for. |
|
Administrator uid to generate API key for. |
|
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: add-api-key
cp_mgmt_add_api_key:
admin_name: admin
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint add-api-key output. Returned: always. |