From c859be095ec0621dfdfbac9129ea6061c4abe5c9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christian=20Mei=C3=9Fner?= Date: Mon, 7 Mar 2022 17:57:25 +0100 Subject: [PATCH] prepare release 1.5.0 (#75) --- .bumpversion.cfg | 2 +- CHANGELOG.rst | 15 + changelogs/changelog.yaml | 17 +- .../add_automatic_testing_facility.yml | 2 - .../provide_local_phpiapm_environment.yml | 2 - .../support_command_line_parameters.yml | 2 - docs/plugins/address_module.rst | 2 +- docs/plugins/device_module.rst | 2 +- docs/plugins/device_type_module.rst | 2 +- docs/plugins/domain_module.rst | 2 +- docs/plugins/index.rst | 8 +- docs/plugins/location_module.rst | 2 +- docs/plugins/nameserver_module.rst | 2 +- docs/plugins/section_module.rst | 2 +- docs/plugins/subnet_lookup.rst | 285 ++++++++++++++++++ docs/plugins/subnet_module.rst | 2 +- docs/plugins/tag_module.rst | 2 +- docs/plugins/vlan_module.rst | 2 +- docs/plugins/vrf_module.rst | 2 +- galaxy.yml | 2 +- 20 files changed, 336 insertions(+), 21 deletions(-) delete mode 100644 changelogs/fragments/add_automatic_testing_facility.yml delete mode 100644 changelogs/fragments/provide_local_phpiapm_environment.yml delete mode 100644 changelogs/fragments/support_command_line_parameters.yml create mode 100644 docs/plugins/subnet_lookup.rst diff --git a/.bumpversion.cfg b/.bumpversion.cfg index db91b40..618ac52 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,6 +1,6 @@ [bumpversion] commit = False tag = False -current_version = 1.4.0 +current_version = 1.5.0 [bumpversion:file:galaxy.yml] diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 3b9462c..107c6d8 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,21 @@ codeaffen.phpipam Release Notes .. contents:: Topics +v1.5.0 +====== + +Bugfixes +-------- + +- fix `ModuleNotFoundError` while using the collection with ansible >= version 5 + +Minor Changes +------------- + +- fix \#68 - add automatic testing facility for all modules +- fix \#69 - add facility to setup local phpipam environment +- fix \#70 - provide environment variable support for connection data + v1.4.0 ====== diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index 08db006..da5e36d 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -85,7 +85,9 @@ releases: bugfixes: - fix \#57 - tag lookups failed when specified in an `address` task - fix \#61 - Device type examples - - with [AHH538](https://issues.redhat.com/browse/AAH-538) `requires_ansible` is mandatory in `meta/runtime.yml`. So we add the minimum version for our collection here. + - with [AHH538](https://issues.redhat.com/browse/AAH-538) `requires_ansible` + is mandatory in `meta/runtime.yml`. So we add the minimum version for our + collection here. minor_changes: - Minor formatting and spelling fixes. - Switch sphinx from recommonmark to myst_parser. @@ -105,3 +107,16 @@ releases: name: tag namespace: '' release_date: '2021-12-16' + 1.5.0: + changes: + bugfixes: + - fix `ModuleNotFoundError` while using the collection with ansible >= version 5 + minor_changes: + - fix \#68 - add automatic testing facility for all modules + - fix \#69 - add facility to setup local phpipam environment + - fix \#70 - provide environment variable support for connection data + fragments: + - add_automatic_testing_facility.yml + - provide_local_phpiapm_environment.yml + - support_command_line_parameters.yml + release_date: '2022-03-07' diff --git a/changelogs/fragments/add_automatic_testing_facility.yml b/changelogs/fragments/add_automatic_testing_facility.yml deleted file mode 100644 index ff2cf22..0000000 --- a/changelogs/fragments/add_automatic_testing_facility.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - fix \#68 - add automatic testing facility for all modules diff --git a/changelogs/fragments/provide_local_phpiapm_environment.yml b/changelogs/fragments/provide_local_phpiapm_environment.yml deleted file mode 100644 index 449f3c6..0000000 --- a/changelogs/fragments/provide_local_phpiapm_environment.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - fix \#69 - add facility to setup local phpipam environment diff --git a/changelogs/fragments/support_command_line_parameters.yml b/changelogs/fragments/support_command_line_parameters.yml deleted file mode 100644 index 1b9d1a2..0000000 --- a/changelogs/fragments/support_command_line_parameters.yml +++ /dev/null @@ -1,2 +0,0 @@ -minor_changes: - - fix \#70 - provide environment variable support for connection data diff --git a/docs/plugins/address_module.rst b/docs/plugins/address_module.rst index ba9b397..ba5d04b 100644 --- a/docs/plugins/address_module.rst +++ b/docs/plugins/address_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.address -- Manage addresses .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/docs/plugins/device_module.rst b/docs/plugins/device_module.rst index 72cca6c..95c933a 100644 --- a/docs/plugins/device_module.rst +++ b/docs/plugins/device_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.device -- Manage devices .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/docs/plugins/device_type_module.rst b/docs/plugins/device_type_module.rst index 12fd625..d04bc66 100644 --- a/docs/plugins/device_type_module.rst +++ b/docs/plugins/device_type_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.device_type -- Manage device types .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/docs/plugins/domain_module.rst b/docs/plugins/domain_module.rst index 16239ce..029ebf2 100644 --- a/docs/plugins/domain_module.rst +++ b/docs/plugins/domain_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.domain -- Manage L2 routing domains .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst index bd88cf3..a30b94e 100644 --- a/docs/plugins/index.rst +++ b/docs/plugins/index.rst @@ -4,7 +4,7 @@ Codeaffen.Phpipam ================= -Collection version 1.4.0 +Collection version 1.5.0 .. toctree:: :maxdepth: 1 @@ -16,6 +16,11 @@ Plugin Index These are the plugins in the codeaffen.phpipam collection +Lookup Plugins +~~~~~~~~~~~~~~ + +* :ref:`subnet ` -- lookup for subnet information + Modules ~~~~~~~ @@ -41,6 +46,7 @@ Modules :maxdepth: 1 :hidden: + subnet_lookup address_module device_module device_type_module diff --git a/docs/plugins/location_module.rst b/docs/plugins/location_module.rst index 023c4a7..10cfe77 100644 --- a/docs/plugins/location_module.rst +++ b/docs/plugins/location_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.location -- Manage locations .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/docs/plugins/nameserver_module.rst b/docs/plugins/nameserver_module.rst index fcd4e51..6ea8e31 100644 --- a/docs/plugins/nameserver_module.rst +++ b/docs/plugins/nameserver_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.nameserver -- Manage nameservers .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/docs/plugins/section_module.rst b/docs/plugins/section_module.rst index 9837095..3090526 100644 --- a/docs/plugins/section_module.rst +++ b/docs/plugins/section_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.section -- Manage sections .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/docs/plugins/subnet_lookup.rst b/docs/plugins/subnet_lookup.rst new file mode 100644 index 0000000..b9c2690 --- /dev/null +++ b/docs/plugins/subnet_lookup.rst @@ -0,0 +1,285 @@ +.. Document meta + +:orphan: + +.. |antsibull-internal-nbsp| unicode:: 0xA0 + :trim: + +.. role:: ansible-attribute-support-label +.. role:: ansible-attribute-support-property +.. role:: ansible-attribute-support-full +.. role:: ansible-attribute-support-partial +.. role:: ansible-attribute-support-none +.. role:: ansible-attribute-support-na + +.. Anchors + +.. _ansible_collections.codeaffen.phpipam.subnet_lookup: + +.. Anchors: short name for ansible.builtin + +.. Anchors: aliases + + + +.. Title + +codeaffen.phpipam.subnet -- lookup for subnet information ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ + +.. Collection note + +.. note:: + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). + + 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 :code:`ansible-galaxy collection list`. + + To install it, use: :code:`ansible-galaxy collection install codeaffen.phpipam`. + + To use it in a playbook, specify: :code:`codeaffen.phpipam.subnet`. + +.. version_added + +.. versionadded:: 1.5.0 of codeaffen.phpipam + +.. contents:: + :local: + :depth: 1 + +.. Deprecated + + +Synopsis +-------- + +.. Description + +- This lookup returns information about a subnet. + + +.. Aliases + + +.. Requirements + + +.. Options + +Parameters +---------- + +.. raw:: html + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ParameterChoices/DefaultsConfigurationComments
+
+ _terms + +
+ string + / required
+ + 		+ + +
Subnet in CIDR notation
+
+
+ app_id + +
+ string +
+ + 		+ +
ini entries: +

+ [phpipam]
app_id = None + +

+
+
+ env:PHPIPAM_APPID + +
+ 		+
Application ID
+
+
+ password + +
+ string +
+ + 		+ +
ini entries: +

+ [phpipam]
password = None + +

+
+
+ env:PHPIPAM_PASSWORD + +
+ 		+
Password to authenticate with the server
+
+
+ url + +
+ string +
+ + 		+ +
ini entries: +

+ [phpipam]
url = None + +

+
+
+ env:PHPIPAM_URL + +
+ 		+
URL of the server to query
+
+
+ username + +
+ string +
+ + 		+ +
ini entries: +

+ [phpipam]
username = None + +

+
+
+ env:PHPIPAM_USERNAME + +
+ 		+
Username to authenticate with the server
+
+
+ verify_ssl + +
+ boolean +
+ + 		+
    Choices: +
  • no
    • +
  • yes ←
    • +
+ 		+
ini entries: +

+ [phpipam]
verify_ssl = yes + +

+
+
+ env:PHPIPAM_VERIFY_SSL + +
+ 		+
Whether to verify SSL certificates
+
+
+ +.. Attributes + + +.. Notes + +Notes +----- + +.. note:: + - This lookup requires the ipaddress module. + - This lookup returns a list of ip addresses. + +.. Seealso + + +.. Examples + + + +.. Facts + + +.. Return values + + +.. Status (Presently only deprecated) + + +.. Authors + +Authors +~~~~~~~ + +- Christian Meißner (@cmeissner) + + + +.. Parsing errors + diff --git a/docs/plugins/subnet_module.rst b/docs/plugins/subnet_module.rst index 86d0a7f..07a6e29 100644 --- a/docs/plugins/subnet_module.rst +++ b/docs/plugins/subnet_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.subnet -- Manage subnets .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/docs/plugins/tag_module.rst b/docs/plugins/tag_module.rst index efd07c3..063d5bb 100644 --- a/docs/plugins/tag_module.rst +++ b/docs/plugins/tag_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.tag -- Manage tags .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/docs/plugins/vlan_module.rst b/docs/plugins/vlan_module.rst index 001fec9..28cba96 100644 --- a/docs/plugins/vlan_module.rst +++ b/docs/plugins/vlan_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.vlan -- Manage vlans .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/docs/plugins/vrf_module.rst b/docs/plugins/vrf_module.rst index 3a172b9..7a69646 100644 --- a/docs/plugins/vrf_module.rst +++ b/docs/plugins/vrf_module.rst @@ -30,7 +30,7 @@ codeaffen.phpipam.vrf -- Manage virtual routers and forwarders .. Collection note .. note:: - This plugin is part of the `codeaffen.phpipam collection `_ (version 1.4.0). + This plugin is part of the `codeaffen.phpipam collection `_ (version 1.5.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. diff --git a/galaxy.yml b/galaxy.yml index 3a28189..91a23fa 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -9,7 +9,7 @@ authors: - "Mario Fritschen " - "Scott Arthur " - "lush " -version: "1.4.0" +version: "1.5.0" license: - "GPL-3.0-or-later" tags: