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 2.3.0).

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 version 2.9: of check_point.mgmt

Synopsis

  • Delete the API key. For the key to be invalid publish is needed.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

admin_name

string

Administrator name to generate API key for.

admin_uid

string

Administrator uid to generate API key for.

api_key

string

API key to be deleted.

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.

Choices:

  • no

  • yes ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: delete-api-key
  cp_mgmt_delete_api_key:
    api_key: eea3be76f4a8eb740ee872bcedc692748ff256a2d21c9ffd2754facbde046d00
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

cp_mgmt_delete_api_key

dictionary

The checkpoint delete-api-key output.

Returned: always.

Authors

  • Or Soffer (@chkp-orso)