diff --git a/.bumpversion.cfg b/.bumpversion.cfg index e22f780..1a66e95 100644 --- a/.bumpversion.cfg +++ b/.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] diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 7607ee6..d15339f 100644 --- a/CHANGELOG.rst +++ b/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 ====== + diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 4d05ed0..d374bd9 100644 --- a/changelogs/changelog.yaml +++ b/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' diff --git a/docs/plugins/address_module.rst b/docs/plugins/address_module.rst index d10f9e4..4f0cc79 100644 --- a/docs/plugins/address_module.rst +++ b/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 `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (version 1.7.1). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -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 - diff --git a/docs/plugins/device_module.rst b/docs/plugins/device_module.rst index 14a6079..c1a15b5 100644 --- a/docs/plugins/device_module.rst +++ b/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 `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (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
- 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 - diff --git a/docs/plugins/device_type_module.rst b/docs/plugins/device_type_module.rst index a20ee45..f89c89b 100644 --- a/docs/plugins/device_type_module.rst +++ b/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 `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (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 - diff --git a/docs/plugins/domain_module.rst b/docs/plugins/domain_module.rst index f4a35fa..8bd9dfe 100644 --- a/docs/plugins/domain_module.rst +++ b/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 `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (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 - diff --git a/docs/plugins/environment_variables.rst b/docs/plugins/environment_variables.rst index 10ca0d8..071168a 100644 --- a/docs/plugins/environment_variables.rst +++ b/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: diff --git a/docs/plugins/folder_module.rst b/docs/plugins/folder_module.rst index 1e03fd9..8d7f01a 100644 --- a/docs/plugins/folder_module.rst +++ b/docs/plugins/folder_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.folder module -- Manage folders .. Collection note .. note:: - This module is part of the `codeaffen.phpipam collection `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (version 1.7.1). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -477,7 +476,6 @@ Examples .. code-block:: yaml+jinja - - name: "Create a folder" codeaffen.phpipam.folder: username: "admin" @@ -499,7 +497,6 @@ Examples - .. Facts @@ -559,7 +556,7 @@ Common return values are documented :ref:`here `, the foll
- + * - .. raw:: html
@@ -641,4 +638,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index cb3bb36..1b2dda7 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -1,7 +1,5 @@ - - .. meta:: - :antsibull-docs: 2.5.0 + :antsibull-docs: 2.16.3 .. _plugins_in_codeaffen.phpipam: @@ -9,7 +7,7 @@ Codeaffen.Phpipam ================= -Collection version 1.7.0 +Collection version 1.7.1 .. contents:: :local: @@ -52,7 +50,6 @@ Ansible Modules to manage phpIPAM installations .. toctree:: :maxdepth: 1 - Plugin Index ------------ @@ -103,5 +100,3 @@ Filter Plugins :hidden: is_subnet_filter - - diff --git a/docs/plugins/is_subnet_filter.rst b/docs/plugins/is_subnet_filter.rst index df9f7cf..a96a659 100644 --- a/docs/plugins/is_subnet_filter.rst +++ b/docs/plugins/is_subnet_filter.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.is_subnet filter -- Check if a subnet belongs to another .. Collection note .. note:: - This filter plugin is part of the `codeaffen.phpipam collection `_ (version 1.7.0). + This filter plugin is part of the `codeaffen.phpipam collection `_ (version 1.7.1). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -50,7 +49,7 @@ Synopsis .. Description -- First argument is a subnet second another. If the first subnet belongs to second +- First argument is a subnet second another. If the first subnet belongs to second .. Aliases @@ -197,9 +196,7 @@ Examples .. code-block:: yaml+jinja - - 192.0.2.0/25 | codeaffen.phpipam.is_subnet(192.0.2.0/24) - + 192.0.2.0/25 | codeaffen.phpipam.is_subnet(192.0.2.0/24) @@ -296,4 +293,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/location_module.rst b/docs/plugins/location_module.rst index b638346..6ffd36f 100644 --- a/docs/plugins/location_module.rst +++ b/docs/plugins/location_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.location module -- Manage locations .. Collection note .. note:: - This module is part of the `codeaffen.phpipam collection `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (version 1.7.1). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -121,7 +120,7 @@ Parameters Address of the given location - if \ :emphasis:`resolv\_location`\ is set to True, this address will be used to resolve the latitude and longitude + if :emphasis:`resolv\_location` is set to True, this address will be used to resolve the latitude and longitude Mutually exclusive with latitude and longitude @@ -231,11 +230,11 @@ Parameters Latitude of the given location - if \ :emphasis:`resolv\_location`\ is set to True, this latitude will be used to resolve the address + if :emphasis:`resolv\_location` is set to True, this latitude will be used to resolve the address This parameter is mutually exclusive with address - This parameter is required if \ :emphasis:`longitude`\ is given + This parameter is required if :emphasis:`longitude` is given .. raw:: html @@ -271,11 +270,11 @@ Parameters Longitude of the given location - if \ :emphasis:`resolv\_location`\ is set to True, this longitude will be used to resolve the address + if :emphasis:`resolv\_location` is set to True, this longitude will be used to resolve the address This parameter is mutually exclusive with address - This parameter is required if \ :emphasis:`latitude`\ is given + This parameter is required if :emphasis:`latitude` is given .. raw:: html @@ -565,7 +564,6 @@ Examples .. code-block:: yaml+jinja - - name: "Create with address" codeaffen.phpipam.location: username: "admin" @@ -597,7 +595,6 @@ Examples - .. Facts @@ -635,4 +632,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/nameserver_module.rst b/docs/plugins/nameserver_module.rst index 9ed6651..b339fe5 100644 --- a/docs/plugins/nameserver_module.rst +++ b/docs/plugins/nameserver_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.nameserver module -- Manage nameservers .. Collection note .. note:: - This module is part of the `codeaffen.phpipam collection `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (version 1.7.1). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -468,7 +467,6 @@ Examples .. code-block:: yaml+jinja - - name: "Create nameserver" codeaffen.phpipam.nameserver: username: "admin" @@ -491,7 +489,6 @@ Examples - .. Facts @@ -529,4 +526,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/section_module.rst b/docs/plugins/section_module.rst index 70d9b07..2a33a8d 100644 --- a/docs/plugins/section_module.rst +++ b/docs/plugins/section_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.section module -- Manage sections .. Collection note .. note:: - This module is part of the `codeaffen.phpipam collection `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (version 1.7.1). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -760,7 +759,6 @@ Examples .. code-block:: yaml+jinja - - name: "Create a section" codeaffen.phpipam.section: username: "admin" @@ -782,7 +780,6 @@ Examples - .. Facts @@ -820,4 +817,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/subnet_module.rst b/docs/plugins/subnet_module.rst index 332b957..beea088 100644 --- a/docs/plugins/subnet_module.rst +++ b/docs/plugins/subnet_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.subnet module -- Manage subnets .. Collection note .. note:: - This module is part of the `codeaffen.phpipam collection `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (version 1.7.1). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -200,7 +199,7 @@ Parameters Network in CIDR format. - Mutually exclusive with \ :emphasis:`subnet`\ and \ :emphasis:`mask`\ . + Mutually exclusive with :emphasis:`subnet` and :emphasis:`mask`. .. raw:: html @@ -540,9 +539,9 @@ Parameters Prefix length (bits) for ipv4 and ipv6 subnets. - Mutually exclusive with \ :emphasis:`cidr`\ . + Mutually exclusive with :emphasis:`cidr`. - If set. \ :emphasis:`subnet`\ is required. + If set. :emphasis:`subnet` is required. .. raw:: html @@ -767,7 +766,7 @@ Parameters Layer-2 routing domain the vlan belongs to - If you have \ :emphasis:`vlan`\ with same number in different routing domains it needs to be set on desired value + If you have :emphasis:`vlan` with same number in different routing domains it need to be set on desired value .. rst-class:: ansible-option-line @@ -993,9 +992,9 @@ Parameters Network address - Mutually exclusive with \ :emphasis:`cidr`\ . + Mutually exclusive with :emphasis:`cidr`. - If set, \ :emphasis:`mask`\ is required. + If set, :emphasis:`mask` is required. .. raw:: html @@ -1207,7 +1206,7 @@ Parameters
- VRF which the sunet should belongs to + VRF which the subnet should belongs to .. raw:: html @@ -1231,7 +1230,6 @@ Examples .. code-block:: yaml+jinja - - name: "Create a subnet" codeaffen.phpipam.subnet: username: "admin" @@ -1253,7 +1251,6 @@ Examples - .. Facts @@ -1313,7 +1310,7 @@ Common return values are documented :ref:`here `, the foll
- + * - .. raw:: html
@@ -1395,4 +1392,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/tag_module.rst b/docs/plugins/tag_module.rst index 92739eb..1713b94 100644 --- a/docs/plugins/tag_module.rst +++ b/docs/plugins/tag_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.tag module -- Manage tags .. Collection note .. note:: - This module is part of the `codeaffen.phpipam collection `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (version 1.7.1). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -611,7 +610,6 @@ Examples .. code-block:: yaml+jinja - - name: "Create tag" codeaffen.phpipam.tag: username: "admin" @@ -632,7 +630,6 @@ Examples - .. Facts @@ -670,4 +667,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/vlan_module.rst b/docs/plugins/vlan_module.rst index d9b5fa8..c174ce6 100644 --- a/docs/plugins/vlan_module.rst +++ b/docs/plugins/vlan_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.vlan module -- Manage vlans .. Collection note .. note:: - This module is part of the `codeaffen.phpipam collection `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (version 1.7.1). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -446,7 +445,7 @@ Parameters The VLAN-ID. Must be a number. - Due to implementation of api the value has to be \ :emphasis:`string`\ here but is \ :emphasis:`int`\ in phpIPAM + Due to implementation of api the value has to be :emphasis:`string` here but is :emphasis:`int` in phpIPAM .. raw:: html @@ -470,7 +469,6 @@ Examples .. code-block:: yaml+jinja - - name: "Create vlan" codeaffen.phpipam.vlan: username: "admin" @@ -490,7 +488,6 @@ Examples - .. Facts @@ -528,4 +525,3 @@ Collection links .. Parsing errors - diff --git a/docs/plugins/vrf_module.rst b/docs/plugins/vrf_module.rst index f1ab6c6..8cba3bc 100644 --- a/docs/plugins/vrf_module.rst +++ b/docs/plugins/vrf_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.vrf module -- Manage virtual routers and forwarders .. Collection note .. note:: - This module is part of the `codeaffen.phpipam collection `_ (version 1.7.0). + This module is part of the `codeaffen.phpipam collection `_ (version 1.7.1). It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. @@ -468,7 +467,6 @@ Examples .. code-block:: yaml+jinja - - name: "Create vrf" codeaffen.phpipam.vrf: username: "admin" @@ -490,7 +488,6 @@ Examples - .. Facts @@ -528,4 +525,3 @@ Collection links .. Parsing errors - diff --git a/galaxy.yml b/galaxy.yml index b5c0b0e..60c3a0b 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -9,7 +9,7 @@ authors: - "Mario Fritschen " - "Scott Arthur " - "lush " -version: "1.7.0" +version: "1.7.1" license: - "GPL-3.0-or-later" tags: