cp_mgmt_https_rule_facts

Get https-rule objects facts on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_https_rule_facts

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

Synopsis

Get https-rule objects facts on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Description
dereference_group_members	bool	Indicates whether to dereference “members” field by details level for every object in reply.
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.
layer	str	Layer that holds the Object. Identified by the Name or UID.
limit	int	The maximal number of returned results. This parameter is relevant only for getting few objects.
name	str	Object name. Must be unique in the domain. This parameter is relevant only for getting few objects.
offset	int	Number of the results to initially skip. This parameter is relevant only for getting few objects.
order	list	Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. 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.
use_object_dictionary	bool	Receiving the mapping between the objects id and the whole objects.
version	str	Management API version path; omitted uses the default API version.

Example

yaml

- name: show-https-rule
  check_point.mgmt.cp_mgmt_https_rule_facts:
    name: FirstRule
    layer: Default Outbound Layer

- name: show-https-rulebase
  check_point.mgmt.cp_mgmt_https_rule_facts:
    details_level: standard
    limit: 20
    name: Default Outbound Layer
    offset: 0
    use_object_dictionary: false