check_point.mgmt.cp_mgmt_data_type_weighted_keywords module – Manages data-type-weighted-keywords objects on Checkpoint over Web Services API

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

New in check_point.mgmt 6.0.0

Synopsis

  • Manages data-type-weighted-keywords objects on Checkpoint devices including creating, updating and removing objects.

  • 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

color

string

Color of the object. Should be one of existing colors.

Choices:

  • "aquamarine"

  • "black"

  • "blue"

  • "crete blue"

  • "burlywood"

  • "cyan"

  • "dark green"

  • "khaki"

  • "orchid"

  • "dark orange"

  • "dark sea green"

  • "pink"

  • "turquoise"

  • "dark blue"

  • "firebrick"

  • "brown"

  • "forest green"

  • "gold"

  • "dark gold"

  • "gray"

  • "dark gray"

  • "light green"

  • "lemon chiffon"

  • "coral"

  • "sea green"

  • "sky blue"

  • "magenta"

  • "purple"

  • "slate blue"

  • "violet red"

  • "navy blue"

  • "olive"

  • "orange"

  • "red"

  • "sienna"

  • "yellow"

comments

string

Comments string.

description

string

For built-in data types, the description explains the purpose of this type of data representation. For custom-made data types, you can use this field to provide more details.

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"

ignore_errors

boolean

Apply changes ignoring errors. You won’t be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored.

Choices:

  • false

  • true

ignore_warnings

boolean

Apply changes ignoring warnings.

Choices:

  • false

  • true

name

string / required

Object name.

state

string

State of the access rule (present or absent).

Choices:

  • "present" ← (default)

  • "absent"

sum_of_weights_threshold

integer

Define the number of appearances, by weight, of all the keywords that, beyond this threshold, the data containing this list of words or phrases will be recognized as data to be protected.

tags

list / elements=string

Collection of tag identifiers.

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

weighted_keywords

list / elements=dictionary

List of keywords or phrases.

keyword

string

keyword or regular expression to be weighted.

max_weight

integer

Max weight of the expression.

regex

boolean

Determine whether to consider the expression as a regular expression.

Choices:

  • false

  • true

weight

integer

Weight of the expression.

Examples

- name: add-data-type-weighted-keywords
  cp_mgmt_data_type_weighted_keywords:
    name: weighted-words-obj
    state: present
    sum_of_weights_threshold: 10
    weighted_keywords:
    - keyword: word1
      max_weight: 4
      regex: true
      weight: 3

- name: set-data-type-weighted-keywords
  cp_mgmt_data_type_weighted_keywords:
    name: weighted-words-obj
    state: present
    sum_of_weights_threshold: 15
    weighted_keywords:
    - keyword: word1
      max_weight: 4
      regex: true
      weight: 3
    - keyword: word2
      max_weight: 5
      regex: false
      weight: 2

- name: delete-data-type-weighted-keywords
  cp_mgmt_data_type_weighted_keywords:
    name: weighted-words-obj
    state: absent

Return Values

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

Key

Description

cp_mgmt_data_type_weighted_keywords

dictionary

The checkpoint object created or updated.

Returned: always, except when deleting the object.

Authors

  • Eden Brillant (@chkp-edenbr)