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

Synopsis

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

Parameters

Parameter

Comments

ip_only

boolean

Filter only by IP address.

Choices:

  • no ← (default)

  • yes

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

Description

ansible_hosts

list / elements=string

The checkpoint object facts.

Returned: always.

Authors

  • Ansible by Red Hat (@rcarrillocruz)