cp_mgmt_threat_rule

Manages threat-rule 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_rule

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manages threat-rule 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.
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		Object name.
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.
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.
track_settings	dict			Threat rule track settings.
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-rule
  check_point.mgmt.cp_mgmt_threat_rule:
    comments: ''
    install_on: Policy Targets
    layer: New Layer 1
    name: First threat rule
    position: 1
    protected_scope: All_Internet
    state: present
    track: None

- name: set-threat-rule
  check_point.mgmt.cp_mgmt_threat_rule:
    action: New Profile 1
    comments: commnet for the first rule
    install_on: Policy Targets
    layer: New Layer 1
    name: Rule Name
    position: 1
    protected_scope: All_Internet
    state: present

- name: delete-threat-rule
  check_point.mgmt.cp_mgmt_threat_rule:
    layer: New Layer 1
    name: Rule Name
    state: absent