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

From Get docs
Ansible/docs/2.9/modules/cp mgmt access layer module


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

New in version 2.9.


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 Choices/Defaults Comments

add_default_rule

boolean

  • no
  • yes

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

applications_and_url_filtering

boolean

  • no
  • yes

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

auto_publish_session

boolean

  • no
  • yes

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

color

string

  • 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

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

comments

string

Comments string.

content_awareness

boolean

  • no
  • yes

Whether to enable Content Awareness blade on the layer.

details_level

string

  • uid
  • standard
  • full

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.

detect_using_x_forward_for

boolean

  • no
  • yes

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

firewall

boolean

  • no
  • yes

Whether to enable Firewall blade on the layer.

ignore_errors

boolean

  • no
  • yes

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.

ignore_warnings

boolean

  • no
  • yes

Apply changes ignoring warnings.

implicit_cleanup_action

string

  • drop
  • accept

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

mobile_access

boolean

  • no
  • yes

Whether to enable Mobile Access blade on the layer.

name

string / required

Object name.

shared

boolean

  • no
  • yes

Whether this layer is shared.

state

string

  • present

  • absent

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

tags

list

Collection of tag identifiers.

version

string

Version of checkpoint. If not given one, the latest version taken.

wait_for_task

boolean

  • no
  • yes

Wait for the task to end. Such as publish task.



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 Returned Description

cp_mgmt_access_layer

dictionary

always, except when deleting the object.

The checkpoint object created or updated.





Status

Authors

  • Or Soffer (@chkp-orso)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/cp_mgmt_access_layer_module.html