cp_mgmt_objects_facts

Get objects 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_objects_facts

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

Synopsis

Get objects 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. 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.
domains_to_process	list	Indicates which domains to process the commands on. It cannot be used with the details-level full, must be run from the System Domain only and with ignore-warnings true. Valid values are, CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER. Available from R81 management version.
filter	str	Search expression to filter objects by. 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. By default, the search involves both a textual search and a IP search. To use IP search only, set the “ip-only” parameter to true. Available from R80.10 management version.
ip_only	bool	If using “filter”, use this field to search objects by their IP address only, without involving the textual search. IP search use cases Full IPv4 address matches for, - Hosts, Check Point Hosts and Gateways with exact IPv4 match or with interfaces which subnet contains the search address - IPv4 Networks and IPv4 Address Ranges that contain the search address Partial IPv4 address matches for, - Hosts, Networks, Check Point Hosts and Gateways with IPv4 address that starts from the search address - Hosts, Check Point Hosts and Gateways with interfaces which subnet address starts from the search address - IPv4 Address Ranges with first address or last address that starts from the search address - IPv4 Networks and IPv4 Address Ranges that contain the network derived from the search address supplemented with missing octets (all zeroes) - Hosts, Check Point Hosts and Gateways with interfaces which subnet contains the network derived from the search address supplemented with missing octets (all zeroes) IPv6 address, - Not supported * Check Point Host is a server of type Network Policy Management, Logging & Status, SmartEvent, etc. * When one IP address is checked to start from another (partial) IP address - only full octets are considered * Check Examples part for IP search examples. Available from R80.10 management version.
limit	int	The maximal number of returned results. This parameter is relevant only for getting a specific object.
offset	int	Number of the results to initially skip. This parameter is relevant only for getting a specific object.
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 a specific object.
show_membership	bool	Indicates whether to calculate and show “groups” field for every object in reply. Available from R80.10 management version.
type	str	The objects’ type, e.g., host, service-tcp, network, address-range…
uid	str	Object unique identifier.
uids	list	List of UIDs of the objects to retrieve. Available from R81.10 JHF management version.
version	str	Management API version path; omitted uses the default API version.

Example

yaml

- name: show-objects
  check_point.mgmt.cp_mgmt_objects_facts:
    limit: 50
    offset: 0
    order:
      - ASC: name
    type: group

- name: show-object
  check_point.mgmt.cp_mgmt_objects_facts:
    uid: ef82887c-d08f-49a3-a18f-a376be633848