check_point.mgmt.checkpoint_host_facts – Get host 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.checkpoint_host_facts.
Synopsis
- Get host objects facts on Check Point devices. All operations are performed over Web Services API.
Parameters
| Parameter | Choices/Defaults | 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 | Returned | Description |
|---|---|---|
| ansible_hosts
list / elements=string
|
always. |
The checkpoint host 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_host_facts_module.html