check_point.mgmt.cp_mgmt_exception_group module – Manages exception-group objects on Check Point over Web Services API
Note
This module is part of the check_point.mgmt collection (version 4.0.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_exception_group
.
New in check_point.mgmt 1.0.0
Synopsis
Manages exception-group objects on Check Point devices including creating, updating and removing objects.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
The threat profile to apply this group to in the case of apply-on threat-rules-with-specific-profile. |
|
The threat rules to apply this group on in the case of apply-on manually-select-threat-rules. |
|
Adds to collection of values |
|
The layer of the threat rule to which the group is to be attached. |
|
The name of the threat rule to which the group is to be attached. |
|
Position in the rulebase. |
|
The rule-number of the threat rule to which the group is to be attached. |
|
An exception group can be set to apply on all threat rules, all threat rules which have a specific profile, or those rules manually chosen by the user. Choices:
|
|
Publish the current session if changes have been performed after task completes. Choices:
|
|
Color of the object. Should be one of existing colors. Choices:
|
|
Comments string. |
|
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:
|
|
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:
|
|
Object name. |
|
State of the access rule (present or absent). Defaults to present. Choices:
|
|
Collection of tag identifiers. |
|
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: |
Examples
- name: add-exception-group
cp_mgmt_exception_group:
applied_threat_rules.0.layer: MyLayer
applied_threat_rules.0.name: MyThreatRule
apply_on: manually-select-threat-rules
name: exception_group_2
state: present
- name: set-exception-group
cp_mgmt_exception_group:
apply_on: all-threat-rules
name: exception_group_2
state: present
tags: tag3
- name: delete-exception-group
cp_mgmt_exception_group:
name: exception_group_2
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. |