- Docs »
- cp_mgmt_group_facts – Get group objects facts on Check Point over Web Services API
-
cp_mgmt_group_facts – Get group objects facts on Check Point over Web Services API
Get group objects facts on Check Point devices.
All operations are performed over Web Services API.
This module handles both operations, get a specific object and get several objects, For getting a specific object use the parameter ‘name’.
Parameter |
Choices/Defaults |
Comments |
dereference_group_members
boolean
|
|
Indicates whether to dereference "members" field by details level for every object in reply.
|
details_level
string
|
Choices:
- uid
- standard
- full
|
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.
|
limit
integer
|
|
No more than that many results will be returned. This parameter is relevant only for getting few objects.
|
name
string
|
|
Object name. This parameter is relevant only for getting a specific object.
|
offset
integer
|
|
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.
|
|
ASC
string
|
|
Sorts results by the given field in ascending order.
|
|
DESC
string
|
|
Sorts results by the given field in descending order.
|
show_as_ranges
boolean
|
|
When true, the group's matched content is displayed as ranges of IP addresses rather than network objects.<br />Objects that are not represented using IP addresses are presented as objects.<br />The 'members' parameter is omitted from the response and instead the 'ranges' parameter is displayed.
|
show_membership
boolean
|
|
Indicates whether to calculate and show "groups" field for every object in reply.
|
version
string
|
|
Version of checkpoint. If not given one, the latest version taken.
|
- name: show-group
cp_mgmt_group_facts:
name: Demo_Group
- name: show-groups
cp_mgmt_group_facts:
details_level: standard
limit: 50
offset: 0
Authors
Hint
If you notice any issues in this documentation, you can edit this document to improve it.