check_point.mgmt.cp_mgmt_set_cloud_license_gateway module – Edit existing gateway license using name or uid.

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

New in check_point.mgmt 7.0.0

Synopsis

  • Edit existing gateway license using name or uid.

  • 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

domain

string

Domain name or UID for the gateway. Required when running from MDS context.

enable_auto_distribution

boolean / required

Enable or disable auto distribution of cloud licenses for the specified gateway.

Choices:

  • false

  • true

gateway

string / required

Security gateway name or UID to set.

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: set-cloud-license-gateway
  cp_mgmt_set_cloud_license_gateway:
    enable_auto_distribution: true
    gateway: Gateway_0.0.0.0

Return Values

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

Key

Description

cp_mgmt_set_cloud_license_gateway

dictionary

The checkpoint set-cloud-license-gateway output.

Returned: always.

Authors

  • Dor Berenstein (@chkp-dorbe)