PARALLAX

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

NameTypeRequiredDefaultDescription
actionstrAction-the enforced profile.
auto_publish_sessionboolfalsePublish this owned session explicitly after the operation; default false.
commentsstrComments string.
destinationlistCollection of Network objects identified by the name or UID.
destination_negateboolTrue if negate is set for destination.
details_levelstrThe 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.
enabledboolEnable/Disable the rule.
exception_group_namestrThe name of the exception-group.
exception_group_uidstrThe UID of the exception-group.
ignore_errorsboolApply 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_warningsboolApply changes ignoring warnings.
install_onlistWhich Gateways identified by the name or UID to install the policy on.
layerstrLayer that the rule belongs to identified by the name or UID.
namestryesThe name of the exception.
positionstrPosition in the rulebase. The use of values “top” and “bottom” may not be idempotent.
protected_scopelistCollection of objects defining Protected Scope identified by the name or UID.
protected_scope_negateboolTrue if negate is set for Protected Scope.
protection_or_sitelistName of the protection or site.
rule_namestrThe name of the parent rule.
servicelistCollection of Network objects identified by the name or UID.
service_negateboolTrue if negate is set for Service.
sourcelistCollection of Network objects identified by the name or UID.
source_negateboolTrue if negate is set for source.
statestrpresentDesired object presence.
trackstrPacket tracking.
versionstrManagement API version path; omitted uses the default API version.
wait_for_taskbooltrueWait for returned asynchronous task identifiers; default true.
wait_for_task_timeoutint30Polling 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
Search
    ↑ ↓ move↵ openesc close