W3cubDocs

/Ansible

check_point.mgmt.cp_mgmt_data_center_object_facts – Get data-center-object objects facts on Checkpoint 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_data_center_object_facts.

New in version 2.9: of check_point.mgmt

Synopsis

  • Get data-center-object objects facts on Checkpoint 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
The maximal number of returned results. 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
Number of the results to initially skip. This parameter is relevant only for getting few objects.
order
list / elements=string
Sorts the results by search criteria. Automatically sorts the results by Name, in the ascending order. 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-data-center-object
  cp_mgmt_data_center_object_facts:
    name: VM1 mgmt name

- name: show-data-center-objects
  cp_mgmt_data_center_object_facts:

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_data_center_object_facts_module.html