Docs4dev
Docs
ansible / latest / collections / check_point / mgmt / cp_mgmt_simple_gateway_facts_module.html

check_point.mgmt.cp_mgmt_simple_gateway_facts – Get simple-gateway objects facts on Check Point over Web Services API

Note

This plugin is part of the check_point.mgmt collection (version 2.1.1).

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_simple_gateway_facts.

New in version 2.9: of check_point.mgmt

Synopsis

  • Get simple-gateway 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 Choices/Defaults Comments
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 / 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
    Choices:
  • name
Sorts results by the given field in ascending order.
DESC
string
    Choices:
  • name
Sorts results by the given field in descending order.
show_membership
boolean
    Choices:
  • no
  • yes
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.

Examples

- name: show-simple-gateway
  cp_mgmt_simple_gateway_facts:
    name: gw1

- name: show-simple-gateways
  cp_mgmt_simple_gateway_facts:
    details_level: standard
    limit: 50
    offset: 0

Authors

  • Or Soffer (@chkp-orso)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_simple_gateway_facts_module.html