check_point.mgmt.cp_mgmt_add_api_key (5.2.3) — module

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3

Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

admin_uid:
    description:
    - Administrator uid to generate API key for.
    type: str

admin_name:
    description:
    - Administrator name to generate API key for.
    type: str

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_add_api_key:
  description: The checkpoint add-api-key output.
  returned: always.
  type: dict