check_point.mgmt.cp_mgmt_set_cloud_services module – Set the connection settings between the Management Server and Check Point’s Infinity Portal.

Note

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

New in check_point.mgmt 5.0.0

Synopsis

  • Set the connection settings between the Management Server and Check Point’s Infinity Portal.

  • All operations are performed over Web Services API.

  • Available from R81.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

gateways_onboarding_settings

dictionary

Gateways on-boarding to Infinity Portal settings.

connection_method

string

Indicate whether Gateways will be connected to Infinity Portal automatically or only after policy installation.

Choices:

  • "automatically"

  • "after install policy"

details_level

string

The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.

Choices:

  • "uid"

  • "standard"

  • "full"

participant_gateways

string

Which Gateways will be connected to Infinity Portal.

Choices:

  • "all"

  • "specific"

specific_gateways

list / elements=string

Selection of targets identified by the name or UID which will be on-boarded to the cloud. Configuration will be applied only when “participant-gateways” field is set to “specific”.

status

string

Connection status.

Choices:

  • "connected"

  • "disabled"

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-services
  cp_mgmt_set_cloud_services:
    gateways_onboarding_settings:
      connection_method: after install policy
      participant_gateways: specific
      specific_gateways: gw1

Return Values

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

Key

Description

cp_mgmt_set_cloud_services

dictionary

The checkpoint set-cloud-services output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)