check_point.mgmt.cp_mgmt_set_api_settings module – Edit API settings, the changes will be applied after publish followed by running ‘api restart’ command.

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

New in check_point.mgmt 5.0.0

Synopsis

  • Edit API settings, the changes will be applied after publish followed by running ‘api restart’ command.

  • All operations are performed over Web Services API.

  • Available from R80 management version.

Parameters

Parameter

Comments

accepted_api_calls_from

string

Clients allowed to connect to the API Server.

Choices:

  • "management server only"

  • "all ip addresses that can be used for gui clients"

  • "all ip addresses"

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

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-api-settings
  cp_mgmt_set_api_settings:
    accepted_api_calls_from: 'all ip addresses'

Return Values

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

Key

Description

cp_mgmt_set_api_settings

dictionary

The checkpoint set-api-settings output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)