check_point.mgmt.cp_mgmt_set_gateway_global_use module – Enable or disable global usage on a specific target.

Note

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

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

New in check_point.mgmt 6.0.0

Synopsis

  • Enable or disable global usage on a specific target.

  • This command is available only after logging in to the System Data domain

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

enabled

boolean / required

Indicates whether global use is enabled on the target.

Choices:

  • false

  • true

target

string / required

On what target to execute this command. Target may be identified by its object name, or object unique identifier.

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-gateway-global-use
  cp_mgmt_set_gateway_global_use:
    enabled: true
    target: vpn_gw

Return Values

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

Key

Description

cp_mgmt_set_gateway_global_use

dictionary

The checkpoint set-gateway-global-use output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)