Config Point API and New Release

CHANGELOG.rst

@@ -5,6 +5,53 @@ Check_Point.gaia Release Notes
 .. contents:: Topics
 
 
+v7.1.0
+======
+
+Release Summary
+---------------
+
+This is release 7.1.0 of ``check_point.gaia``, released on 2026-11-02.
+
+Major Changes
+-------------
+
+- Check mode (``--check``) is now supported by all modules. Before this release, running a playbook with ``--check`` applied real changes on the machine. Modules now report the change that would be made without making it; read-only operations (``show-`` APIs and ``cp_gaia_simulate_packet``) still run. A diff is also reported outside check mode, so ``--diff`` works on real runs.
+
+Breaking Changes / Porting Guide
+--------------------------------
+
+- httpapi - Management Proxy mode is no longer detected by loading ``/etc/ansible/hosts`` (``mgmt_proxy`` host with ``enabled: true``). Set the new inventory variable ``ansible_checkpoint_mgmt_proxy_enabled: true`` instead.
+
+Minor Changes
+-------------
+
+- cp_gaia_initial_setup - add the ``grub_password`` parameter.
+- cp_gaia_ntp - add the ``preferred`` parameter and the ``server`` and ``pool`` server types (Gaia API v1.8 and above).
+- cp_gaia_snmp_pre_defined_traps - add the missing ``lowDiskSpace`` trap parameter.
+- cp_gaia_ssh_server_settings - add the ``enabled_public_key_algorithms``, ``password_authentication``, ``permit_root_login``, ``use_dns``, ``client_alive_interval`` and ``login_grace_time`` parameters (Gaia API v1.9 and above).
+- cp_gaia_banner - document the API limits of the banner message (80 characters per line, 20 lines).
+- galaxy.yml - add ``ansible.netcommon`` as a dependency of the collection.
+- Add the GPL-3.0 ``LICENSE`` file, matching the module headers and ``galaxy.yml``.
+
+New Modules
+-----------
+
+- check_point.gaia.cp_gaia_param – set Config Point parameters over Web Services API.
+- check_point.gaia.cp_gaia_param_facts – get Config Point parameters over Web Services API.
+
+Bugfixes
+--------
+
+- httpapi - fix the connection failing on Python 3.12 and newer ansible-core, and in AAP/AWX, because the plugin loaded the local inventory file.
+- module_utils - fix task error reporting: read the correct ``error`` field of a failed task, fail when a succeeded task returns a non-zero ``return-value``, and show a readable message instead of a raw response (with a version hint for 404 errors).
+- module_utils - show the error message returned in the ``errors`` field of a failed task instead of a generic message.
+- module_utils - fix the idempotency check of lists (order-independent) and of values returned with a different type (for example ``4`` and ``"4"``).
+- cp_gaia_run_script - fail and report the script's error when the script returns a non-zero exit code, instead of reporting success.
+- cp_gaia_ntp - fix idempotency always reporting ``changed=true``, including on Gaia API versions below v1.8.
+- cp_gaia_snmp - fix idempotency of ``contact`` and ``location`` when they contain characters the API returns escaped (``:`` and ``\``).
+
+
 v7.0.0
 ======
 

README.md

@@ -156,6 +156,8 @@ Modules
 * `cp_gaia_maestro_security_groups_facts` - get information about Maestro Security Groups over Web Services API.
 * `cp_gaia_maestro_sites` - add description to Maestro Sites over Web Services API.
 * `cp_gaia_maestro_sites_facts` - get information about Maestro Sites over Web Services API.
+* `cp_gaia_param` – set Config Point parameters of a Check Point machine over Web Services API.
+* `cp_gaia_param_facts` – get Config Point parameters of a Check Point machine over Web Services API.
 
 ### Code of Conduct
 This collection follows the Ansible project's

docs/cp_gaia_param.rst

@@ -0,0 +1,143 @@
+.. _cp_gaia_param_module:
+
+
+cp_gaia_param -- Set Config Point parameters.
+=============================================
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+
+Set Config Point parameters.
+
+To see the parameters documentation go to https://\<IP\>/param\_docs/ on the Gaia machine.
+
+
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- supported starting from gaia\_api \>= 1.8
+- supported on Gaia versions R82 and above
+
+
+
+Parameters
+----------
+
+  version (False, str, None)
+    Gaia API version for example 1.8.
+
+
+  virtual_system_id (False, str, None)
+    VSX Virtual System ID which presents the context switch.
+
+
+  param_list (True, list, None)
+    List of parameters to be set.
+
+
+    param_path (True, str, None)
+      Parameter full path.
+
+
+    value (optional, raw, None)
+      Parameter value, can be a string, int, boolean, object or a list of them.
+
+      Can not be used together with :emphasis:`use\_default`.
+
+
+    comments (optional, str, None)
+      Comments to be added to the parameter, length is limited to 256 characters.
+
+
+    use_default (optional, bool, None)
+      Set the parameter back to its default value.
+
+      Can not be used together with :emphasis:`value`.
+
+
+    volatile (optional, bool, None)
+      Set the parameter with the value specified until the next reboot.
+
+
+    virtual_system_id (optional, str, None)
+      VSX Virtual System IDs to set the parameter in, can be :literal:`all` or specific IDs, for example :literal:`2,4,7\-10`.
+
+
+
+  dry_run (False, bool, False)
+    Run the request without saving to the database, return only the values that would change.
+
+
+  use_regex (False, bool, False)
+    Indicates that :emphasis:`param\_path` includes :literal:`\*`.
+
+
+  wait_for_task (False, bool, True)
+    Wait for task or return immediately.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+   - Supports :literal:`check\_mode`. In check mode the request is sent with :literal:`dry\_run`\ , so nothing is saved.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+    - name: Set a parameter value and return another one to its default
+      check_point.gaia.cp_gaia_param:
+        param_list:
+          - param_path: gaia.infra.httpd.cp_httpd_configuration.children_core_dumps
+            value: true
+            comments: enabled for debugging purpose
+          - param_path: gaia.infra.rest_api.gunicorn.timeout
+            use_default: true
+
+    - name: Check which parameters would change, without saving
+      check_point.gaia.cp_gaia_param:
+        param_list:
+          - param_path: gaia.infra.httpd.cp_httpd_configuration.children_core_dumps
+            value: true
+        dry_run: true
+
+
+
+Return Values
+-------------
+
+set_param (always., dict, )
+  The task result of the set\-param request, including the parameters that were set.
+
+
+
+
+
+Status
+------
+
+
+
+
+
+Authors
+~~~~~~~
+
+- Ameer Asli (@chkp-ameera)
+

docs/cp_gaia_param_facts.rst

@@ -0,0 +1,111 @@
+.. _cp_gaia_param_facts_module:
+
+
+cp_gaia_param_facts -- Show Config Point parameters.
+====================================================
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+
+Show Config Point parameters by full path or prefix.
+
+To see the parameters documentation go to https://\<IP\>/param\_docs/ on the Gaia machine.
+
+
+
+Requirements
+------------
+The below requirements are needed on the host that executes this module.
+
+- supported starting from gaia\_api \>= 1.8
+- supported on Gaia versions R82 and above
+
+
+
+Parameters
+----------
+
+  version (False, str, None)
+    Gaia API version for example 1.8.
+
+
+  virtual_system_id (False, str, None)
+    VSX Virtual System ID which presents the context switch.
+
+
+  param_path (True, str, None)
+    Parameter full path or prefix, for example :literal:`security\-gateway.DLP`.
+
+
+  filter_by (False, str, None)
+    Show only parameters matching the filter, in the format :literal:`\<filter\_type\>=true`.
+
+    The filter type can be one of :literal:`modified`\ , :literal:`with\-comments` or :literal:`not\-default`\ , for example :literal:`modified=true`.
+
+
+  member_id (False, int, None)
+    SMO member ID of the member to show the data from. Default is the ID of the current login member.
+
+
+  wait_for_task (False, bool, True)
+    Wait for task or return immediately.
+
+
+
+
+
+Notes
+-----
+
+.. note::
+   - Supports :literal:`check\_mode`.
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml+jinja
+
+
+    - name: Show all DLP parameters
+      check_point.gaia.cp_gaia_param_facts:
+        param_path: security-gateway.DLP
+
+    - name: Show only the DLP parameters that were modified
+      check_point.gaia.cp_gaia_param_facts:
+        param_path: security-gateway.DLP
+        filter_by: modified=true
+
+
+
+Return Values
+-------------
+
+show_param (always., dict, )
+  The task result of the show\-param request.
+
+  The matching parameters are in :literal:`tasks[0].task\-details[0].param\-list`\ , each with its name, current\-value, default\-value, description, comments, pending and last\-modified.
+
+
+
+
+
+Status
+------
+
+
+
+
+
+Authors
+~~~~~~~
+
+- Ameer Asli (@chkp-ameera)
+

galaxy.yml

@@ -1,7 +1,7 @@
 ---
 namespace: check_point
 name: gaia
-version: 7.0.0
+version: 7.1.0
 readme: README.md
 authors:
   - Majd Sharkia <majds@checkpoint.com>

plugins/module_utils/checkpoint.py

@@ -64,7 +64,7 @@ def parse_fail_message(code, response):
 def _task_error_detail(task):
     details = task.get('task-details') or []
     detail = details[0] if details else {}
-    return detail.get('error') or detail.get('output') or ''
+    return detail.get('error') or detail.get('errors') or detail.get('output') or ''
 
 
 def _fail_task(module, task, reason='failed', detail=''):