check_point.mgmt.cp_mgmt_threat_exception – Manages threat-exception objects on Check Point over Web Services API
Note
This plugin is part of the check_point.mgmt collection (version 2.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install check_point.mgmt
.
To use it in a playbook, specify: check_point.mgmt.cp_mgmt_threat_exception
.
New in version 2.9: of check_point.mgmt
Synopsis
Manages threat-exception objects on Check Point devices including creating, updating and removing objects.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
Action-the enforced profile. |
|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Comments string. |
|
Collection of Network objects identified by the name or UID. |
|
True if negate is set for destination. Choices:
|
|
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. Choices:
|
|
Enable/Disable the rule. Choices:
|
|
The name of the exception-group. |
|
The UID of the exception-group. |
|
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. Choices:
|
|
Apply changes ignoring warnings. Choices:
|
|
Which Gateways identified by the name or UID to install the policy on. |
|
Layer that the rule belongs to identified by the name or UID. |
|
The name of the exception. |
|
Position in the rulebase. |
|
Collection of objects defining Protected Scope identified by the name or UID. |
|
True if negate is set for Protected Scope. Choices:
|
|
Name of the protection or site. |
|
The name of the parent rule. |
|
Collection of Network objects identified by the name or UID. |
|
True if negate is set for Service. Choices:
|
|
Collection of Network objects identified by the name or UID. |
|
True if negate is set for source. Choices:
|
|
State of the access rule (present or absent). Defaults to present. Choices:
|
|
Packet tracking. |
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
How many minutes to wait until throwing a timeout error. Default: 30 |
Examples
- name: add-threat-exception
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
cp_mgmt_threat_exception:
layer: New Layer 1
name: Exception Rule
rule_name: Threat Rule 1
state: present
- name: delete-threat-exception
cp_mgmt_threat_exception:
name: Exception Rule
layer: New Layer 1
rule_name: Threat Rule 1
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint object created or updated. Returned: always, except when deleting the object. |
Authors
Or Soffer (@chkp-orso)