check_point.mgmt.cp_mgmt_test_ai_agent_security_api_key module – Test the validity of an AI Agent Security API key.

Note

This module is part of the check_point.mgmt collection (version 7.0.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_test_ai_agent_security_api_key.

New in check_point.mgmt 7.0.0

Synopsis

  • Test the validity of an AI Agent Security API key. Optionally validates that a project ID belongs to the key. The management server sends a test request to AI Agent Security and returns whether the key (and project) is valid.

  • All operations are performed over Web Services API.

  • Available from R82.20 management version.

Parameters

Parameter

Comments

auto_publish_session

boolean

Publish the current session if changes have been performed after task completes.

Choices:

  • false ← (default)

  • true

project_id

string

Optional AI Agent Security project ID to validate. If provided, also verifies the project belongs to the API key.

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:

  • false

  • true ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: test-ai-agent-security-api-key
  cp_mgmt_test_ai_agent_security_api_key:
    project_id: 550e8400-e29b-41d4-a716-446655440000

Return Values

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

Key

Description

cp_mgmt_test_ai_agent_security_api_key

dictionary

The checkpoint test-ai-agent-security-api-key output.

Returned: always.

Authors

  • Dor Berenstein (@chkp-dorbe)