check_point.mgmt.cp_mgmt_show_guideline_cells module – Showing guideline-cells metrics according to the given filters.

Note

This module is part of the check_point.mgmt collection (version 7.0.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_show_guideline_cells.

New in check_point.mgmt 7.0.0

Synopsis

  • Showing guideline-cells metrics according to the given filters.

  • All operations are performed over Web Services API.

  • Available from R82.20 management version.

Parameters

Parameter

Comments

access_layer

dictionary / required

The access layer context for the guideline metrics display. The access-layer must be attached to the guideline.

access_layer

string

Access-layer attached to guideline identified by the name or UID.if Access-Layer is in the global domain due to Global Assignment Local domain Package is required.

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"

domains_to_process

list / elements=string

Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are, CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.

policy_package

string

Policy package context for the access-layer attached to guideline identified by the name or UID.Package will be ignored if the access-layer is local.

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"

filters

dictionary

The filters are used to filter the cells and services that will be returned in the response. ‘any’ value in both ‘from’ and ‘to’ filters will return the whole matrix.

from

string

The source segment of the cell (identified by name or UID). In case the value is ‘any’, entire row will be returned. Relevant only for ‘Network Group’ type.

from_type

string

The type of the segment in the ‘from’ axis.

Choices:

  • "network group"

  • "internet"

  • "other"

services

list / elements=string

The services that will be used while calculating the metrics (identified by name or UID).

to

string

The destination segment of the cell (identified by name or UID). In case the value is ‘any’, entire column will be returned. Relevant only for ‘Network Group’ type.

to_type

string

The type of the segment in the ‘to’ axis.

Choices:

  • "network group"

  • "internet"

  • "other"

guideline

string / required

The guideline the user wish to view (identified by name or UID).

show_count

list / elements=string

Set of metrics type. The rules categories to return in the response.

show_rules

boolean

This field is used to control whether to show the rules paths in the response. This field should be set to true only when the ‘from’ and ‘to’ filters fields are not ‘any’.

Choices:

  • false

  • true

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-guideline-cells
  cp_mgmt_show_guideline_cells:
    access_layer:
      access_layer: Network
    details_level: uid
    guideline: Corporate policy

Return Values

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

Key

Description

cp_mgmt_show_guideline_cells

dictionary

The checkpoint show-guideline-cells output.

Returned: always.

Authors

  • Dor Berenstein (@chkp-dorbe)