check_point.mgmt.cp_mgmt_service_group_facts module – Get service-group objects facts on Check Point over Web Services API

Note

This module is part of the check_point.mgmt collection (version 2.3.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_service_group_facts.

New in version 2.9: of check_point.mgmt

Synopsis

  • Get service-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’.

Parameters

Parameter

Comments

dereference_group_members

boolean

Indicates whether to dereference “members” field by details level for every object in reply.

Choices:

  • no

  • yes

details_level

string

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.

Choices:

  • uid

  • standard

  • full

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 / elements=string

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.

Choices:

  • name

DESC

string

Sorts results by the given field in descending order.

Choices:

  • name

show_as_ranges

boolean

When true, the service group’s matched content is displayed as ranges of port numbers rather than service objects.<br />Objects that are not represented using port numbers are presented as objects.<br />The ‘members’ parameter is omitted from the response and instead the ‘ranges’ parameter is displayed.

Choices:

  • no

  • yes

show_membership

boolean

Indicates whether to calculate and show “groups” field for every object in reply.

Choices:

  • no

  • yes

version

string

Version of checkpoint. If not given one, the latest version taken.

Examples

- name: show-service-group
  cp_mgmt_service_group_facts:
    name: New Service Group 1

- name: show-service-groups
  cp_mgmt_service_group_facts:
    details_level: standard
    limit: 50
    offset: 0

Authors

  • Or Soffer (@chkp-orso)