check_point.mgmt.cp_mgmt_guideline_cell_approvals module – Manages guideline-cell-approvals objects on Checkpoint over Web Services API

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

New in check_point.mgmt 7.0.0

Synopsis

  • Manages guideline-cell-approvals objects on Checkpoint devices including creating, updating and removing objects.

  • All operations are performed over Web Services API.

  • Available from R82.20 management version.

Parameters

Parameter

Comments

approvals

list / elements=dictionary

List of approved rules.

rules

list / elements=dictionary

The full paths (pairs of layer and rule) of the approved rules.

layer

string

The Layer identifier (name or UID).

rule

string

The rule identifier (name if unique, rule position number in rule-base or UID).

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

comment

string

New comment for the approvals. The same comment to all the requested approvals.

delete_scope

string

Indicates whether to delete all the approval scope, or only remove the requested cell from the scope. Relevant only for guideline approvals.

Choices:

  • "single cell"

  • "effected cells"

  • "guideline"

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"

from

string

a “from” segment (identified by UID or name), or ‘any’ to approved the rule across all cells (possible only if “to” is also ‘any’). This field is mandatory if “from-type” is ‘Network Group’.

from_type

string

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

Choices:

  • "network group"

  • "internet"

  • "other"

guideline

string

The guideline (identified by UID or name) in which we approve the violation.

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

policy_package

string

The policy package (identified by UID or name) in which we approve the violation. This field is mandatory only if the ordered-access-layer (first layer in path) is from a global domain with AGP.

state

string

State of the access rule (present or absent).

Choices:

  • "present" ← (default)

  • "absent"

to

string

a “to” segment (identified by UID or name), or ‘any’ to approved the rule across all cells (possible only if “from” is also ‘any’). This field is mandatory if “to-type” is ‘Network Group’.

to_type

string

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

Choices:

  • "network group"

  • "internet"

  • "other"

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-guideline-cell-approvals
  cp_mgmt_guideline_cell_approvals:
    comment: This is approved for all segments
    from: any
    guideline: Corporate policy
    state: present
    to: any

- name: set-guideline-cell-approvals
  cp_mgmt_guideline_cell_approvals:
    comment: This is approved for all segments, including future
    from: any
    guideline: Corporate policy
    state: present
    to: any

- name: delete-guideline-cell-approvals
  cp_mgmt_guideline_cell_approvals:
    from: any
    guideline: Corporate policy
    state: absent
    to: any

Return Values

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

Key

Description

cp_mgmt_guideline_cell_approvals

dictionary

The checkpoint object created or updated.

Returned: always, except when deleting the object.

Authors

  • Dor Berenstein (@chkp-dorbe)