check_point.mgmt.checkpoint_host_facts module – Get host 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.checkpoint_host_facts.

Synopsis

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

Parameters

Parameter

Comments

name

string

Name of the host object. If name is not provided, UID is required.

uid

string

UID of the host object. If UID is not provided, name is required.

Examples

- name: Get host object facts
  checkpoint_host_facts:
    name: attacker

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 host object facts.

Returned: always.

Authors

  • Ansible by Red Hat (@rcarrillocruz)