cp_mgmt_add_api_key
Add API key for administrator, to enable login with it. For the key to be valid publish is needed through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_add_api_key
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Add API key for administrator, to enable login with it. For the key to be valid publish is needed through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| admin_name | str | Administrator name to generate API key for. | ||
| admin_uid | str | Administrator uid to generate API key for. | ||
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| version | str | Management API version path; omitted uses the default API version. | ||
| wait_for_task | bool | true | Wait for returned asynchronous task identifiers; default true. | |
| wait_for_task_timeout | int | 30 | Polling deadline in minutes; default 30, negative values use 30, maximum 1440. |
Example
yaml
- name: add-api-key
check_point.mgmt.cp_mgmt_add_api_key:
admin_name: admin