check_point.mgmt.cp_mgmt_distribute_cloud_licenses module – Distribute licenses to target CloudGuard gateways.

Note

This module is part of the check_point.mgmt collection (version 5.2.3).

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_distribute_cloud_licenses.

New in check_point.mgmt 5.2.0

Synopsis

Parameters

Parameter

Comments

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

targets

list / elements=string

Targets are uid or name of the security gateway(s). In case no target specified, the license will be distributed to all CloudGuard security gateways.

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: distribute-cloud-licenses
  cp_mgmt_distribute_cloud_licenses:
    targets:
    - GW1
    - GW2

Return Values

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

Key

Description

cp_mgmt_distribute_cloud_licenses

dictionary

The checkpoint distribute-cloud-licenses output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)