check_point.mgmt.cp_mgmt_show_layer_structure (5.2.3) — module

Shows the entire layer structure.

| "added in version" 5.0.0 of check_point.mgmt"

Authors: Eden Brillant (@chkp-edenbr)

preview | supported by community

Install collection

Install with ansible-galaxy collection install check_point.mgmt:==5.2.3


Add to requirements.yml

  collections:
    - name: check_point.mgmt
      version: 5.2.3

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: show-layer-structure
  cp_mgmt_show_layer_structure:
    details_level: standard
    limit: 20
    name: Network
    offset: 0

Inputs

    
name:
    description:
    - Object name. Must be unique in the domain.
    required: true
    type: str

limit:
    description:
    - The maximal number of returned results.
    type: int

offset:
    description:
    - Number of the results to initially skip.
    type: int

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

version:
    description:
    - Version of checkpoint. If not given one, the latest version taken.
    type: str

details_level:
    choices:
    - uid
    - standard
    description:
    - 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.
    type: str

wait_for_task:
    default: true
    description:
    - Wait for the task to end. Such as publish task.
    type: bool

auto_publish_session:
    default: false
    description:
    - Publish the current session if changes have been performed after task completes.
    type: bool

wait_for_task_timeout:
    default: 30
    description:
    - How many minutes to wait until throwing a timeout error.
    type: int

Outputs

cp_mgmt_show_layer_structure:
  description: The checkpoint show-layer-structure output.
  returned: always.
  type: dict