check_point.mgmt.cp_mgmt_add_rules_batch module – Creates new rules in batch. Use this API to achieve optimum performance when adding more than one rule.

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

New in check_point.mgmt 3.0.0

Synopsis

  • Creates new rules in batch. Use this API to achieve optimum performance when adding more than one rule.

  • Add multiple rules to a layer in a specific position, incrementing position by one for each rule.

  • Errors and warnings are ignored when using this API, operation will apply changes while ignoring errors. It is not possible to publish changes that contain validations errors. You must use the “show-validations” API to see any validation errors and warnings caused by the batch creation. Supported rules types are access-rule, nat-rule, https-rule and threat-exception.

  • This module is not idempotent.

  • 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

objects

list / elements=dictionary

Batch of rules separated by types.

first_position

string

First rule position.

layer

string

Layer name or uid.

list

list / elements=dictionary

List of rules from the same type to be created on the same layer. <br>Use the “add” API reference documentation for a single rule command to find the expected fields for the request. <br>For example, to add access-rules, use the “add-access-rule” command found in the API reference documentation (under Access Control & NAT). <br>Note, “set-if-exists”, “ignore-errors”, “ignore-warnings” and “details-level” options are not supported when adding a batch of rules.

type

string

Type of rules to be created. <br>Only types from above are supported.

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: add-rules-batch
  cp_mgmt_add_rules_batch:
    objects:
    - first_position: top
      layer: Network
      list:
      - action: accept
        name: access rule 1
      - action: accept
        name: access rule 2
      type: access-rule
    - first_position: top
      layer: Standard
      list:
      - name: nat rule 1
      - name: nat rule 2
      type: nat-rule
    - first_position: top
      layer: Default Layer
      list:
      - name: https rule 1
      - name: https rule 2
      type: https-rule

Return Values

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

Key

Description

cp_mgmt_add_rules_batch

dictionary

The checkpoint add-rules-batch output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)