cp_mgmt_access_rule_facts

Get access-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_access_rule_facts

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

Synopsis

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

Parameters

Name	Type	Default	Description
async_response	bool	`false`	Run command in asynchronous mode and return task UID. Use show-task command to check the progress of the task. Available with customized HF.
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.
hits_settings	dict		N/A
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. Valid values are between 1 and 500.
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_as_ranges	bool		When true, the source, destination and services & applications parameters are displayed as ranges of IP addresses and port numbers rather than network objects. Objects that are not represented using IP addresses or port numbers are presented as objects. In addition, the response of each rule does not contain the parameters, source, source-negate, destination, destination-negate, service and service-negate, but instead it contains the parameters, source-ranges, destination-ranges and service-ranges. Note, Requesting to show rules as ranges is limited up to 20 rules per request, otherwise an error is returned. If you wish to request more rules, use the offset and limit parameters to limit your request. Available from R80.20 management version.
show_hits	bool		N/A
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.
wait_for_task	bool	`true`	Wait for the task to end. Such as publish task.
wait_for_task_timeout	int	`30`	How many minutes to wait until throwing a timeout error.

Example

yaml

- name: show-access-rule
  check_point.mgmt.cp_mgmt_access_rule_facts:
    layer: Network
    name: Rule 1

- name: show-access-rulebase
  check_point.mgmt.cp_mgmt_access_rule_facts:
    details_level: standard
    limit: 20
    name: Network
    offset: 0
    use_object_dictionary: true