check_point.mgmt.checkpoint httpapi – HttpApi Plugin for Checkpoint devices

Note

This httpapi plugin is part of the check_point.mgmt collection (version 6.2.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.

New in check_point.mgmt 2.8.0

Synopsis

  • This HttpApi plugin provides methods to connect to Checkpoint devices over a HTTP(S)-based api.

Parameters

Parameter

Comments

api_key

string

Login with api-key instead of user & password

Configuration:

  • Variable: ansible_api_key

cloud_mgmt_id

string

The Cloud Management ID

Configuration:

  • Variable: ansible_cloud_mgmt_id

domain

string

Specifies the domain of the Check Point device

Configuration:

  • Variable: ansible_checkpoint_domain

target

string

target gateway

Configuration:

  • Variable: ansible_checkpoint_target

Authors

  • Ansible Networking Team (@rcarrillocruz)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.