check_point.mgmt.cp_mgmt_export_access_rulebase module – Retrieve the entire content of an Access Rules layer.

Note

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

New in check_point.mgmt 6.9.0

Synopsis

  • Retrieve the entire content of an Access Rules layer. The reply features a list of objects; Each object in the reply may be a section of the layer, with all its rules in, or a rule itself, for the case of rules which are under the global section. In case a rule has an Access Layer applied on it, the entire content of the inline layer will be included in the reply as well.

  • All operations are performed over Web Services API.

  • Available from R82.20 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

dereference_group_members

boolean

Indicates whether to dereference “members” field by details level for every object in reply.

Choices:

  • false

  • true

hits_settings

dictionary

Hitcount settings, define the range if hits to show.

from_date

string

Format, YYYY-MM-DD, YYYY-mm-ddThh,mm,ss.

target

string

Target gateway name or UID.

to_date

string

Format, YYYY-MM-DD, YYYY-mm-ddThh,mm,ss.

name

string

Object name. Must be unique in the domain.

package

string

Name of the package.

show_expiration_settings

boolean

Indicates whether to calculate and show “expiration date settings” field in reply.

Choices:

  • false

  • true

show_hits

boolean

Show hitcount data.

Choices:

  • false

  • true

show_membership

boolean

Indicates whether to calculate and show “groups” field for every object in reply.

Choices:

  • false

  • true

use_object_dictionary

boolean

N/A

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: export-access-rulebase
  cp_mgmt_export_access_rulebase:
    name: Corp-Access

Return Values

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

Key

Description

cp_mgmt_export_access_rulebase

dictionary

The checkpoint export-access-rulebase output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)