check_point.mgmt.cp_mgmt_set_cloud_license_pool module – Edit existing pool using name.

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

New in check_point.mgmt 7.0.0

Synopsis

  • Edit existing pool using name.

  • All operations are performed over Web Services API.

  • Available from R82.20 management version.

Parameters

Parameter

Comments

assigned_gateways

list / elements=dictionary

Attach security gateways to the pool. The attached gateways will use licenses from this pool.

domain

string

Domain name or uid. Required when running from MDS context.

gateway

string

Gateway name or uid.

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

ck

string

Contract Key. Required to identify a specific pool when multiple pools share the same name.

default_pool

boolean

Set pool to default. This value can only be changed from false to true. To disable the current default pool, you must set a different pool as the default.

Choices:

  • false

  • true

migrate_gateways

boolean

Move gateways from current default pool to the new default pool. Required when default-pool parameter is set to true.

Choices:

  • false

  • true

pool

string / required

Pool name.

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-pool
  cp_mgmt_set_cloud_license_pool:
    assigned_gateways:
    - gateway: GW_A
    - gateway: GW_B
    pool: VE-NGTX

Return Values

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

Key

Description

cp_mgmt_set_cloud_license_pool

dictionary

The checkpoint set-cloud-license-pool output.

Returned: always.

Authors

  • Dor Berenstein (@chkp-dorbe)