check_point.mgmt.cp_mgmt_access_layer – Manages access-layer objects on Check Point over Web Services API

Note

This plugin is part of the check_point.mgmt collection (version 2.2.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_access_layer.

New in version 2.9: of check_point.mgmt

Synopsis

  • Manages access-layer objects on Check Point devices including creating, updating and removing objects.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

add_default_rule

boolean

Indicates whether to include a cleanup rule in the new layer.

Choices:

  • no

  • yes

applications_and_url_filtering

boolean

Whether to enable Applications & URL Filtering blade on the layer.

Choices:

  • no

  • yes

auto_publish_session

boolean

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

Choices:

  • no

  • yes

color

string

Color of the object. Should be one of existing colors.

Choices:

  • aquamarine

  • black

  • blue

  • crete blue

  • burlywood

  • cyan

  • dark green

  • khaki

  • orchid

  • dark orange

  • dark sea green

  • pink

  • turquoise

  • dark blue

  • firebrick

  • brown

  • forest green

  • gold

  • dark gold

  • gray

  • dark gray

  • light green

  • lemon chiffon

  • coral

  • sea green

  • sky blue

  • magenta

  • purple

  • slate blue

  • violet red

  • navy blue

  • olive

  • orange

  • red

  • sienna

  • yellow

comments

string

Comments string.

content_awareness

boolean

Whether to enable Content Awareness blade on the layer.

Choices:

  • no

  • yes

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

detect_using_x_forward_for

boolean

Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP.

Choices:

  • no

  • yes

firewall

boolean

Whether to enable Firewall blade on the layer.

Choices:

  • no

  • yes

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:

  • no

  • yes

ignore_warnings

boolean

Apply changes ignoring warnings.

Choices:

  • no

  • yes

implicit_cleanup_action

string

The default “catch-all” action for traffic that does not match any explicit or implied rules in the layer.

Choices:

  • drop

  • accept

mobile_access

boolean

Whether to enable Mobile Access blade on the layer.

Choices:

  • no

  • yes

name

string / required

Object name.

shared

boolean

Whether this layer is shared.

Choices:

  • no

  • yes

state

string

State of the access rule (present or absent). Defaults to present.

Choices:

  • present ← (default)

  • absent

tags

list / elements=string

Collection of tag identifiers.

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:

  • no

  • yes ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: add-access-layer
  cp_mgmt_access_layer:
    name: New Layer 1
    state: present

- name: set-access-layer
  cp_mgmt_access_layer:
    applications_and_url_filtering: false
    data_awareness: true
    name: New Layer 1
    state: present

- name: delete-access-layer
  cp_mgmt_access_layer:
    name: New Layer 2
    state: absent

Return Values

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

Key

Description

cp_mgmt_access_layer

dictionary

The checkpoint object created or updated.

Returned: always, except when deleting the object.

Authors

  • Or Soffer (@chkp-orso)