check_point.mgmt.checkpoint_object_facts – Get object 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.checkpoint_object_facts.

Synopsis

  • Get object facts on Check Point devices. All operations are performed over Web Services API.

Parameters

Parameter Choices/Defaults Comments
ip_only
boolean
    Choices:
  • no ←
  • yes
Filter only by IP address.
object_filter
string
Filter expression for search. It accepts AND/OR logical operators and performs a textual and IP address search. To search only by IP address, set ip_only argument to True. which can be filtered with the filter argument.
object_type
string
Type of the object to search. Must be a valid API resource name
uid
string
UID of the object. If UID is not provided, it will do a full search which can be filtered with the filter argument.

Examples

- name: Get object facts
  checkpoint_object_facts:
    object_filter: 192.168.30.30
    ip_only: yes

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
ansible_hosts
list / elements=string
always.
The checkpoint object facts.


Authors

  • Ansible by Red Hat (@rcarrillocruz)

© 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/checkpoint_object_facts_module.html