cp_mgmt_threat_exception
Manages threat-exception 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_threat_exception
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manages threat-exception objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| action | str | Action-the enforced profile. | ||
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| comments | str | Comments string. | ||
| destination | list | Collection of Network objects identified by the name or UID. | ||
| destination_negate | bool | True if negate is set for destination. | ||
| 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. | ||
| enabled | bool | Enable/Disable the rule. | ||
| exception_group_name | str | The name of the exception-group. | ||
| exception_group_uid | str | The UID of the exception-group. | ||
| 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. | ||
| install_on | list | Which Gateways identified by the name or UID to install the policy on. | ||
| layer | str | Layer that the rule belongs to identified by the name or UID. | ||
| name | str | yes | The name of the exception. | |
| position | str | Position in the rulebase. The use of values “top” and “bottom” may not be idempotent. | ||
| protected_scope | list | Collection of objects defining Protected Scope identified by the name or UID. | ||
| protected_scope_negate | bool | True if negate is set for Protected Scope. | ||
| protection_or_site | list | Name of the protection or site. | ||
| rule_name | str | The name of the parent rule. | ||
| service | list | Collection of Network objects identified by the name or UID. | ||
| service_negate | bool | True if negate is set for Service. | ||
| source | list | Collection of Network objects identified by the name or UID. | ||
| source_negate | bool | True if negate is set for source. | ||
| state | str | present | Desired object presence. | |
| track | str | Packet tracking. | ||
| 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-threat-exception
check_point.mgmt.cp_mgmt_threat_exception:
layer: New Layer 1
name: Exception Rule
position: 1
protected_scope: All_Internet
rule_name: Threat Rule 1
state: present
track: Log
- name: set-threat-exception
check_point.mgmt.cp_mgmt_threat_exception:
layer: New Layer 1
name: Exception Rule
rule_name: Threat Rule 1
state: present
- name: delete-threat-exception
check_point.mgmt.cp_mgmt_threat_exception:
name: Exception Rule
layer: New Layer 1
rule_name: Threat Rule 1
state: absent