Merge branch 'develop' into feature/128

Author: cmeissner

.bumpversion.cfg

@@ -1,6 +1,6 @@
 [bumpversion]
 commit = False
 tag = False
-current_version = 1.7.0
+current_version = 1.7.1
 
 [bumpversion:file:galaxy.yml]

CHANGELOG.rst

@@ -4,6 +4,13 @@ codeaffen.phpipam Release Notes
 
 .. contents:: Topics
 
+v1.7.1
+======
+
+Bugfixes
+--------
+
+- Fix \#123 - `app_id` defaults to `ansible` if not defined
 
 v1.7.0
 ======
@@ -17,7 +24,7 @@ Enhancements
 ------------
 
 - Add `folder` module to manage folders and nested folders
-- Refactor `subnet` module to handle subnets in folders
+- Refactore `subnet` module to handle subnets in folders
 
 New Modules
 -----------
@@ -181,3 +188,4 @@ New Modules
 
 v0.1.0
 ======
+

Makefile

@@ -93,8 +93,7 @@ install-deps:
 
 setup-phpipam: test-setup
 	docker-compose -f tests/docker/docker-compose.yml up -d
-	sleep 30
-	sh tests/docker/setup_database.sh
+	sh tests/docker/setup_phpipam.sh
 
 FORCE:
 

README.md

@@ -51,6 +51,34 @@ The following dependencies have to be fulfiled by the Ansible controller.
 * ipaddress
 * phpypam>=1.0.0
 
+## Compatibility notice
+
+To ensure `phpipam-ansible-modules` work correctly with phpIPAM versions 1.7 and above, you need to modify the phpIPAM configuration to stringify API results. This is crucial because newer phpIPAM versions might return numerical values directly, which the Ansible modules might expect as strings.
+
+Here's how to implement the workaround:
+
+**1. Modify phpIPAM Configuration**
+
+You need to set the `api_stringify_results` variable to `true` in your phpIPAM configuration. This change should be made in the `config.php` file, which is typically located in the phpIPAM installation directory (e.g., `/var/www/html/phpipam/config.php` or `/var/www/phpipam/config.php`).
+
+Add or modify the following line in your `config.php` file:
+
+```
+<?php
+/*
+ * phpIPAM config.php
+ *
+ * ... existing configuration ...
+ */
+
+// Required for Ansible modules with phpIPAM v1.7 and above
+$api_stringify_results = true;
+
+/*
+ * ... rest of your configuration ...
+ */
+?>
+```
 ## Need help?
 
 If you’ve found any issues in this release please head over to github and open a bug so we can take a look.

changelogs/changelog.yaml

@@ -170,3 +170,10 @@ releases:
       name: folder
       namespace: ''
     release_date: '2023-09-01'
+  1.7.1:
+    changes:
+      bugfixes:
+      - Fix \#123 - `app_id` defaults to `ansible` is not defined
+    fragments:
+    - app_id_default.yaml
+    release_date: '2025-04-18'

docs/plugins/address_module.rst

@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -7,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.5.0
+  :antsibull-docs: 2.16.3
 
 .. Anchors
 
@@ -23,7 +22,7 @@ codeaffen.phpipam.address module -- Manage addresses
 .. Collection note
 
 .. note::
-    This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/ui/repo/published/codeaffen/phpipam/>`_ (version 1.7.0).
+    This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/ui/repo/published/codeaffen/phpipam/>`_ (version 1.7.1).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -348,7 +347,7 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      IP address to hanle
+      IP address to handle
 
 
       .. raw:: html
@@ -879,7 +878,6 @@ Examples
 
 .. code-block:: yaml+jinja
 
-    
     - name: "Reserve an IP address"
       codeaffen.phpipam.address:
         username: "admin"
@@ -904,7 +902,6 @@ Examples
 
 
 
-
 .. Facts
 
 
@@ -942,4 +939,3 @@ Collection links
 
 
 .. Parsing errors
-

docs/plugins/device_module.rst

@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -7,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.5.0
+  :antsibull-docs: 2.16.3
 
 .. Anchors
 
@@ -23,7 +22,7 @@ codeaffen.phpipam.device module -- Manage devices
 .. Collection note
 
 .. note::
-    This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/ui/repo/published/codeaffen/phpipam/>`_ (version 1.7.0).
+    This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/ui/repo/published/codeaffen/phpipam/>`_ (version 1.7.1).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -294,7 +293,7 @@ Parameters
 
       Rack where the device belongs to.
 
-      If set \ :emphasis:`starting\_rack\_unit`\  and \ :emphasis:`rack\_units`\  are also required.
+      If set :emphasis:`starting\_rack\_unit` and :emphasis:`rack\_units` are also required.
 
 
       .. raw:: html
@@ -328,9 +327,9 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      Size of device in \ :emphasis:`U`\ .
+      Size of device in :emphasis:`U`.
 
-      If set \ :emphasis:`rack`\  and \ :emphasis:`starting\_rack\_unit`\  are also required.
+      If set :emphasis:`rack` and :emphasis:`starting\_rack\_unit` are also required.
 
 
       .. raw:: html
@@ -844,7 +843,7 @@ Parameters
 
       Which is the starting rack unit where the device is mounted.
 
-      If set \ :emphasis:`rack`\  and \ :emphasis:`racK\_units`\  are also required.
+      If set :emphasis:`rack` and :emphasis:`racK\_units` are also required.
 
 
       .. raw:: html
@@ -924,9 +923,9 @@ Parameters
 
       The value has to reflect values from device types configured.
 
-      Default device types are \ :emphasis:`Switch`\ , \ :emphasis:`Router`\ , \ :emphasis:`Firewall`\ , \ :emphasis:`Hub`\ , \ :emphasis:`Wireless`\ , \ :emphasis:`Database`\ , \ :emphasis:`Workstation`\ , \ :emphasis:`Laptop`\  and \ :emphasis:`Other`\ .
+      Default device types are :emphasis:`Switch`\ , :emphasis:`Router`\ , :emphasis:`Firewall`\ , :emphasis:`Hub`\ , :emphasis:`Wireless`\ , :emphasis:`Database`\ , :emphasis:`Workstation`\ , :emphasis:`Laptop` and :emphasis:`Other`.
 
-      User defined types can be created either via UI, API (e.g. \ :emphasis:`device\_type`\  ansible module within this collection).
+      User defined types can be created either via UI, API (e.g. :emphasis:`device\_type` ansible module within this collection).
 
 
       .. raw:: html
@@ -1026,7 +1025,6 @@ Examples
 
 .. code-block:: yaml+jinja
 
-    
     - name: "Create device"
       codeaffen.phpipam.device:
         username: "admin"
@@ -1049,7 +1047,6 @@ Examples
 
 
 
-
 .. Facts
 
 
@@ -1087,4 +1084,3 @@ Collection links
 
 
 .. Parsing errors
-

docs/plugins/device_type_module.rst

@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -7,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.5.0
+  :antsibull-docs: 2.16.3
 
 .. Anchors
 
@@ -23,7 +22,7 @@ codeaffen.phpipam.device_type module -- Manage device types
 .. Collection note
 
 .. note::
-    This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/ui/repo/published/codeaffen/phpipam/>`_ (version 1.7.0).
+    This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/ui/repo/published/codeaffen/phpipam/>`_ (version 1.7.1).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -400,7 +399,6 @@ Examples
 
 .. code-block:: yaml+jinja
 
-    
     - name: "Create device type"
       codeaffen.phpipam.device_type:
         username: "admin"
@@ -421,7 +419,6 @@ Examples
 
 
 
-
 .. Facts
 
 
@@ -459,4 +456,3 @@ Collection links
 
 
 .. Parsing errors
-

docs/plugins/domain_module.rst

@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -7,7 +6,7 @@
     :trim:
 
 .. meta::
-  :antsibull-docs: 2.5.0
+  :antsibull-docs: 2.16.3
 
 .. Anchors
 
@@ -23,7 +22,7 @@ codeaffen.phpipam.domain module -- Manage L2 routing domains
 .. Collection note
 
 .. note::
-    This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/ui/repo/published/codeaffen/phpipam/>`_ (version 1.7.0).
+    This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/ui/repo/published/codeaffen/phpipam/>`_ (version 1.7.1).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -434,7 +433,6 @@ Examples
 
 .. code-block:: yaml+jinja
 
-    
     - name: "Create domain"
       codeaffen.phpipam.domain:
         username: "admin"
@@ -456,7 +454,6 @@ Examples
 
 
 
-
 .. Facts
 
 
@@ -494,4 +491,3 @@ Collection links
 
 
 .. Parsing errors
-

docs/plugins/environment_variables.rst

@@ -1,8 +1,7 @@
-
 :orphan:
 
 .. meta::
-  :antsibull-docs: 2.5.0
+  :antsibull-docs: 2.16.3
 
 .. _list_of_collection_env_vars: