check_point.mgmt.cp_mgmt_set_threat_protection_category module – Edit existing object using object name or uid.

Note

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

New in check_point.mgmt 7.0.0

Synopsis

  • Edit existing object using object name or uid.

  • All operations are performed over Web Services API.

  • Available from R82.20 management version.

Parameters

Parameter

Comments

action

string

Action to apply to all profiles. Required when all-profiles is true.

Choices:

  • "ask"

  • "prevent"

  • "detect"

  • "inactive"

  • "restore"

all_profiles

boolean

Apply action to all profiles. Default, true.

Choices:

  • false

  • true

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

blade

string

The blade this category belongs to. Required when using ‘name’.

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"

name

string

The Category name.

overrides

list / elements=dictionary

Overrides per profile for this protection. Required when all-profiles is false.

action

string

Action to apply for the specified profile.

Choices:

  • "ask"

  • "prevent"

  • "detect"

  • "inactive"

  • "restore"

profile

string

Profile name or UID.

show_profiles

boolean

Indicates whether to calculate and show “profiles” field in reply.

Choices:

  • false

  • 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-threat-protection-category
  cp_mgmt_set_threat_protection_category:
    action: detect
    blade: anti-bot
    name: Reputation IPs

Return Values

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

Key

Description

cp_mgmt_set_threat_protection_category

dictionary

The checkpoint set-threat-protection-category output.

Returned: always.

Authors

  • Dor Berenstein (@chkp-dorbe)