PARALLAX

cp_mgmt_threat_exception_facts

Get threat-exception objects facts 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_exception_facts

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

Synopsis

Get threat-exception objects facts on Check Point over Web Services API through native controller HTTPAPI with owned sessions

Parameters

NameTypeRequiredDefaultDescription
dereference_group_membersboolIndicates whether to dereference “members” field by details level for every object in reply. Available from R80.10 management version.
details_levelstrThe 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.
exception_group_namestrThe name of the exception-group.
exception_group_uidstrThe UID of the exception-group.
filterstrSearch expression to filter the rulebase. The provided text should be exactly the same as it would be given in Smart Console. The logical operators in the expression (‘AND’, ‘OR’) should be provided in capital letters. If an operator is not used, the default OR operator applies. Available from R80.10 management version.
filter_settingsdictSets filter preferences.
layerstrLayer that the rule belongs to identified by the name or UID.
limitintNo more than that many results will be returned. This parameter is relevant only for getting few objects.
namestrThe name of the layer containing the parent threat rule. This parameter is relevant only for getting few objects.
offsetintSkip that many results before beginning to return them. This parameter is relevant only for getting few objects.
orderlistSorts results by the given field. By default the results are sorted in the ascending order by name. This parameter is relevant only for getting few objects.
packagestrName of the package.
rule_namestrThe name of the parent rule.
show_membershipboolIndicates whether to calculate and show “groups” field for every object in reply. Available from R80.10 management version.
use_object_dictionaryboolN/A
versionstrManagement API version path; omitted uses the default API version.

Example

yaml
- name: show-threat-exception
  check_point.mgmt.cp_mgmt_threat_exception_facts:
    name: Exception Rule
    layer: New Layer 1
    rule_name: Threat Rule 1

- name: show-threat-rule-exception-rulebase
  check_point.mgmt.cp_mgmt_threat_exception_facts:
    name: Standard Threat Prevention
    rule_name: Threat Rule 1
Search
    ↑ ↓ move↵ openesc close