cp_mgmt_exception_group

Manages exception-group 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_exception_group

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

Synopsis

Manages exception-group objects on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
applied_profile	str			The threat profile to apply this group to in the case of apply-on threat-rules-with-specific-profile. Available from R80.10 management version.
applied_threat_rules	dict			The threat rules to apply this group on in the case of apply-on manually-select-threat-rules. Available from R80.10 management version.
apply_on	str			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. Available from R80.10 management version.
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
color	str			Color of the object. Should be one of existing colors.
comments	str			Comments string.
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.
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.
name	str	yes		Object name.
state	str		`present`	Desired object presence.
tags	list			Collection of tag identifiers.
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-exception-group
  check_point.mgmt.cp_mgmt_exception_group:
    applied_threat_rules:
      add:
        - layer: MyLayer
          name: MyThreatRule
    apply_on: manually-select-threat-rules
    name: exception_group_2
    state: present

- name: set-exception-group
  check_point.mgmt.cp_mgmt_exception_group:
    apply_on: all-threat-rules
    name: exception_group_2
    state: present
    tags: tag3

- name: delete-exception-group
  check_point.mgmt.cp_mgmt_exception_group:
    name: exception_group_2
    state: absent