check_point.mgmt.cp_mgmt_add_api_key – Add API key for administrator, to enable login with it. For the key to be valid publish is needed.
Note
This plugin is part of the check_point.mgmt collection (version 2.1.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_add_api_key.
New in version 2.9: of check_point.mgmt
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 | Choices/Defaults | Comments |
|---|---|---|
| admin_name
string
|
Administrator name to generate API key for.
|
|
| admin_uid
string
|
Administrator uid to generate API key for.
|
|
| version
string
|
Version of checkpoint. If not given one, the latest version taken.
|
|
| wait_for_task
boolean
|
|
Wait for the task to end. Such as publish task.
|
| wait_for_task_timeout
integer
|
Default:
30
|
How many minutes to wait until throwing a timeout error.
|
Examples
- name: add-api-key
cp_mgmt_add_api_key:
admin_name: admin
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| cp_mgmt_add_api_key
dictionary
|
always. |
The checkpoint add-api-key output.
|
Authors
- Or Soffer (@chkp-orso)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_add_api_key_module.html