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.0.0).
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¶
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)