Check Point Ansible Gaia Collection

This Ansible collection provides control over a Check Point machine using Check Point's web-services APIs.

This is the repository of the gaia collection which can be found here - https://galaxy.ansible.com/check_point/gaia

Installation instructions

Run ansible-galaxy collection install check_point.gaia

Requirements

• Ansible 2.9+ is required.
• The Check Point server should have Gaia API engine installed on. More information can be found at Gaia REST API SK.

Usage

1. Edit the hosts so that it will contain a section similar to this one:

[check_point]
%CHECK_POINT_MANAGEMENT_SERVER_IP%
[check_point:vars]
ansible_httpapi_use_ssl=True
ansible_httpapi_validate_certs=False
ansible_user=%CHECK_POINT_GAIA_USER%
ansible_password=%CHECK_POINT_GAIA_PASSWORD%
ansible_network_os=check_point.gaia.checkpoint

2. Run a playbook:

ansible-playbook your_ansible_playbook.yml

Example playbook:

---
- name: playbook name
  hosts: check_point
  connection: httpapi
  tasks:
    - name: task to have network
      check_point.gaia.cp_gaia_hostname:
        name: "newhost"

Modules

• cp_gaia_alias_interfaces_facts – Get the information about alias interfaces of a Check Point machine over Web Services API.
• cp_gaia_asset_facts – Get the assets of a Check Point machine over Web Services API.
• cp_gaia_bond_interfaces_facts – Get the information about bond interfaces of a Check Point machine over Web Services API.
• cp_gaia_bridge_interfaces_facts – Get the information about bridge interfaces of a Check Point machine over Web Services API.
• cp_gaia_cluster_state_facts – Get the cluster state of a Check Point machine over Web Services API.
• cp_gaia_hostname – Manage the hostname of a Check Point machine over Web Services API.
• cp_gaia_hostname_facts – Get the hostname of a Check Point machine over Web Services API.
• cp_gaia_physical_interface – Manage physical interface of a Check Point machine over Web Services API.
• cp_gaia_physical_interfaces_facts – Get information about physical interfaces of a Check Point machine over Web Services API.
• cp_gaia_put_file – Add a new file to a Check Point machine over Web Services API.
• cp_gaia_diagnostics_facts - Get diagnostics information of a Check Point machine over Web Services API.
• cp_gaia_dns - Manage the dns of a Check Point machine over Web Services API.
• cp_gaia_dns_facts - Get DNS configuration of a Check Point machine over Web Services API.
• cp_gaia_dhcp_server_facts - Get DHCP server information of a Check Point machine over Web Services API.
• cp_gaia_gre_interfaces_facts – Get information about GRE interfaces of a Check Point machine over Web Services API.
• cp_gaia_interfaces_facts – Get information about all interfaces of a Check Point machine over Web Services API.
• cp_gaia_ipv6 - Manage the ipv6 of a Check Point machine over Web Services API.
• cp_gaia_ipv6_facts - Get the ipv6 of a Check Point machine over Web Services API.
• cp_gaia_loopback_interfaces_facts – Get information about loopback interfaces of a Check Point machine over Web Services API.
• cp_gaia_ntp_facts - Get NTP configuration of a Check Point machine over Web Services API.
• cp_gaia_remote_syslog - Manage the remote syslog of a Check Point machine over Web Services API.
• cp_gaia_remote_syslog_facts - Get the remote syslog of a Check Point machine over Web Services API.
• cp_gaia_syslog - Manage the syslog of a Check Point machine over Web Services API.
• cp_gaia_syslog_facts - Get the syslog of a Check Point machine over Web Services API.
• cp_gaia_version_facts – Get software and product versions of a Check Point machine over Web Services API.
• cp_gaia_vlan_interfaces_facts – Get information about vlan interfaces of a Check Point machine over Web Services API.
• cp_gaia_vxlan_interfaces_facts – Get information about vxlan interfaces of a Check Point machine over Web Services API.