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
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| dereference_group_members | bool | Indicates whether to dereference “members” field by details level for every object in reply. Available from R80.10 management version. | ||
| 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. | ||
| filter | str | Search 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_settings | dict | Sets filter preferences. Available from R80.10 management version. | ||
| layer | str | Layer that the rule belongs to identified by the name or UID. | ||
| limit | int | No more than that many results will be returned. This parameter is relevant only for getting few objects. | ||
| name | str | Object name. Should be unique in the domain. | ||
| offset | int | Skip that many results before beginning to return them. This parameter is relevant only for getting few objects. | ||
| order | list | Sorts 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. | ||
| package | str | Name of the package. | ||
| show_membership | bool | Indicates whether to calculate and show “groups” field for every object in reply. Available from R80.10 management version. | ||
| use_object_dictionary | bool | N/A | ||
| version | str | Management 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