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

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.

When using mgmt_cli tool, add -f json to get the key in the command’s output.

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	no yes ←	Wait for the task to end. Such as publish task.

- name: add-api-key
  cp_mgmt_add_api_key:
    admin_name: admin
    state: present

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.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/check_point/mgmt/cp_mgmt_add_api_key_module.html