check_point.mgmt.cp_mgmt_show_layer_structure module – Shows the entire layer structure.

Note

This module is part of the check_point.mgmt collection (version 5.2.2).

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

New in check_point.mgmt 5.0.0

Synopsis

  • Shows the entire layer structure. The layer structure is divided into sections and each section has its own entities.

  • Supported layer types include Access Control, NAT, Custom Threat Prevention, Threat Exception and HTTPS Inspection.

  • 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

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"

limit

integer

The maximal number of returned results.

name

string / required

Object name. Must be unique in the domain.

offset

integer

Number of the results to initially skip.

package

string

Name of the package. Must be set when want to receive the resolved rule instead of the place holder in global domain layer.

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: show-layer-structure
  cp_mgmt_show_layer_structure:
    details_level: standard
    limit: 20
    name: Network
    offset: 0

Return Values

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

Key

Description

cp_mgmt_show_layer_structure

dictionary

The checkpoint show-layer-structure output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)