check_point.mgmt.cp_mgmt_exception_group – Manages exception-group objects on Check Point over Web Services API

Note

This plugin is part of the check_point.mgmt collection (version 2.0.0).

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 version 2.9: of check_point.mgmt

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			Choices/Defaults	Comments
applied_profile string				The threat profile to apply this group to in the case of apply-on threat-rules-with-specific-profile.
applied_threat_rules dictionary				The threat rules to apply this group on in the case of apply-on manually-select-threat-rules.
	add list / elements=string			Adds to collection of values
		layer string		The layer of the threat rule to which the group is to be attached.
		name string		The name of the threat rule to which the group is to be attached.
		position string		Position in the rulebase.
		rule_number string		The rule-number of the threat rule to which the group is to be attached.
apply_on string			Choices: all-threat-rules all-threat-rules-with-specific-profile manually-select-threat-rules	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.
auto_publish_session boolean			Choices: no yes	Publish the current session if changes have been performed after task completes.
color string			Choices: aquamarine black blue crete blue burlywood cyan dark green khaki orchid dark orange dark sea green pink turquoise dark blue firebrick brown forest green gold dark gold gray dark gray light green lemon chiffon coral sea green sky blue magenta purple slate blue violet red navy blue olive orange red sienna yellow	Color of the object. Should be one of existing colors.
comments string				Comments string.
details_level string			Choices: uid standard full	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.
ignore_errors boolean			Choices: no yes	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 boolean			Choices: no yes	Apply changes ignoring warnings.
name string / required				Object name.
state string			Choices: present ← absent	State of the access rule (present or absent). Defaults to present.
tags list / elements=string				Collection of tag identifiers.
version string				Version of checkpoint. If not given one, the latest version taken.
wait_for_task boolean			Choices: no yes ←	Wait for the task to end. Such as publish task.
wait_for_task_timeout integer			Default: 30	How many minutes to wait until throwing a timeout error.

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	Returned	Description
cp_mgmt_exception_group dictionary	always, except when deleting the object.	The checkpoint object created or updated.

Authors

• Or Soffer (@chkp-orso)