cp_mgmt_access_layer
Manages access-layer objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_access_layer
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages access-layer objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| add_default_rule | bool | Indicates whether to include a cleanup rule in the new layer. Available from R80.10 management version. | ||
| applications_and_url_filtering | bool | Whether to enable Applications & URL Filtering blade on the layer. | ||
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| color | str | Color of the object. Should be one of existing colors. | ||
| comments | str | Comments string. | ||
| content_awareness | bool | Whether to enable Content Awareness blade on the layer. Available from R80.10 management version. | ||
| details_level | str | 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 | bool | Whether to use X-Forward-For HTTP header, which is added by the proxy server to keep track of the original source IP. | ||
| firewall | bool | Whether to enable Firewall blade on the layer. | ||
| ignore_errors | bool | 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 | bool | Apply changes ignoring warnings. | ||
| implicit_cleanup_action | str | The default “catch-all” action for traffic that does not match any explicit or implied rules in the layer. Available from R80.20 management version. | ||
| mobile_access | bool | Whether to enable Mobile Access blade on the layer. | ||
| name | str | yes | Object name. | |
| shared | bool | Whether this layer is shared. Available from R80.10 management version. | ||
| state | str | present | Desired object presence. | |
| tags | list | Collection of tag identifiers. | ||
| version | str | Management API version path; omitted uses the default API version. | ||
| wait_for_task | bool | true | Wait for returned asynchronous task identifiers; default true. | |
| wait_for_task_timeout | int | 30 | Polling deadline in minutes; default 30, negative values use 30, maximum 1440. |
Example
yaml
- name: add-access-layer
check_point.mgmt.cp_mgmt_access_layer:
name: New Layer 1
state: present
- name: set-access-layer
check_point.mgmt.cp_mgmt_access_layer:
applications_and_url_filtering: false
content_awareness: true
name: New Layer 1
state: present
- name: delete-access-layer
check_point.mgmt.cp_mgmt_access_layer:
name: New Layer 2
state: absent