PARALLAX

cp_mgmt_threat_rule_facts

Get threat-rule 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_rule_facts

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

Synopsis

Get threat-rule 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.
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.
filter_settingsdictSets filter preferences. Available from R80.10 management version.
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.
namestrObject name. Should be unique in the domain.
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.
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-rule
  check_point.mgmt.cp_mgmt_threat_rule_facts:
    layer: New Layer 1
    name: Rule Name

- name: show-threat-rulebase
  check_point.mgmt.cp_mgmt_threat_rule_facts:
    details_level: standard
    filter: ''
    limit: 20
    name: Threat Prevention
    offset: 0
    use_object_dictionary: false
Search
    ↑ ↓ move↵ openesc close