check_point.mgmt.cp_mgmt_access_section module – Manages access-section objects on Checkpoint over Web Services API

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

New in check_point.mgmt 2.0.0

Synopsis

  • Manages access-section objects on Checkpoint devices including creating, updating and removing objects.

  • All operations are performed over Web Services API.

  • Available from R80 management version.

Parameters

Parameter

Comments

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

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

layer

string

Layer that the rule belongs to identified by the name or UID.

name

string / required

Object name.

position

string

Position in the rulebase.

relative_position

dictionary

added in check_point.mgmt 6.0.0

Position in the rulebase.

Use of this field is relevant only for “add” operation.

above

string

Add section above specific rule/section identified by name.

below

string

Add section below specific rule/section identified by name.

bottom

string

Add section to the bottom of a specific section identified by name.

top

string

Add section to the top of a specific section identified by name.

state

string

State of the access rule (present or absent).

Choices:

  • "present" ← (default)

  • "absent"

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-access-section
  cp_mgmt_access_section:
    layer: Network
    name: New Section 1
    position: 1
    state: present

- name: set-access-section
  cp_mgmt_access_section:
    layer: Network
    name: New Section 1
    state: present

- name: delete-access-section
  cp_mgmt_access_section:
    layer: Network
    name: New Section 2
    state: absent

Return Values

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

Key

Description

cp_mgmt_access_section

dictionary

The checkpoint object created or updated.

Returned: always, except when deleting the object.

Authors

  • Or Soffer (@chkp-orso)