cp_mgmt_group_facts
Get group 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_group_facts
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Get group objects facts on Check Point over Web Services API through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| async_response | bool | Run command in asynchronous mode and return task UID. Use show-task command to check the progress of the task. Available from R81.20 management version. | ||
| 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 SmartConsole Object Explorer. The logical operators in the expression (‘AND’, ‘OR’) should be provided in capital letters. The search involves both a IP search and a textual search in name, comment, tags etc. Available from R81 JHF management version. | ||
| limit | int | No more than that many results will be returned. This parameter is relevant only for getting few objects. | ||
| name | str | Object name. This parameter is relevant only for getting a specific object. | ||
| 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. | ||
| show_as_ranges | bool | When true, the group’s matched content is displayed as ranges of IP addresses rather than network objects. Objects that are not represented using IP addresses are presented as objects. The ‘members’ parameter is omitted from the response and instead the ‘ranges’ parameter is displayed. Available from R80.20 management version. | ||
| show_membership | bool | Indicates whether to calculate and show “groups” field for every object in reply. Available from R80.10 management version. | ||
| version | str | Management API version path; omitted uses the default API version. |
Example
yaml
- name: show-group
check_point.mgmt.cp_mgmt_group_facts:
name: Demo_Group
- name: show-groups
check_point.mgmt.cp_mgmt_group_facts:
details_level: standard
limit: 50
offset: 0