Provide ability to define same vlan in different l2domains (#86)

* Provide ability to define same vlan in different l2domains

* Add option to fiter results of find_entity method
* Extend find_vlan to search l2domain it belongs to
* Add routing_domain as optional parameter
  * Default routing_domain to 'defautl'
  * Make routing_domain and vlan required_together
* Adapt test cases and variables for current development
* Add changelog entries
* Catch error if a entity can't be resolved
  As there are relations between entities and the API does not provide
  a way to check these relations we decided to fail if we can't resolve an
  entity. This will happen if a entity is referenced which does not yet
  exists. E.g. a vlan in subnet or a routing domain in a vlan.
* Fix output issues for included tasks in some tests

Author: cmeissner

changelogs/fragments/l2domain_parameter_in_subnet module.yml

@@ -0,0 +1,2 @@
+minor_changes:
+- fix \#85 - Add `routing_domain` parameter to subnet module to allow subnet with same vlan id in different l2domains

changelogs/fragments/same_vlan_in_different_l2domains.yml

@@ -0,0 +1,2 @@
+minor_changes:
+- Fix \#84 - Allow vlans with same vlan id in different l2 routing domains

docs/plugins/address_module.rst

@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -45,9 +44,11 @@ codeaffen.phpipam.address module -- Manage addresses
 .. note::
     This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_ (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`.
-    You need further requirements to be able to use this module,
-    see :ref:`Requirements <ansible_collections.codeaffen.phpipam.address_module_requirements>` for details.
 
     To use it in a playbook, specify: :code:`codeaffen.phpipam.address`.
 
@@ -75,15 +76,13 @@ Synopsis
 
 .. Requirements
 
-.. _ansible_collections.codeaffen.phpipam.address_module_requirements:
-
 Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam\>=1.0.0
+- phpypam>=1.0.0
 
 
 
@@ -246,8 +245,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-choices-entry:`false`
-      - :ansible-option-choices-entry:`true`
+      - :ansible-option-choices-entry:`no`
+      - :ansible-option-choices-entry:`yes`
 
       .. raw:: html
 
@@ -321,8 +320,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)`
-      - :ansible-option-choices-entry:`true`
+      - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)`
+      - :ansible-option-choices-entry:`yes`
 
       .. raw:: html
 
@@ -404,8 +403,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)`
-      - :ansible-option-choices-entry:`true`
+      - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)`
+      - :ansible-option-choices-entry:`yes`
 
       .. raw:: html
 
@@ -869,8 +868,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-choices-entry:`false`
-      - :ansible-option-default-bold:`true` :ansible-option-default:`← (default)`
+      - :ansible-option-choices-entry:`no`
+      - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)`
 
       .. raw:: html
 

docs/plugins/device_module.rst

@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -45,9 +44,11 @@ codeaffen.phpipam.device module -- Manage devices
 .. note::
     This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_ (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`.
-    You need further requirements to be able to use this module,
-    see :ref:`Requirements <ansible_collections.codeaffen.phpipam.device_module_requirements>` for details.
 
     To use it in a playbook, specify: :code:`codeaffen.phpipam.device`.
 
@@ -75,15 +76,13 @@ Synopsis
 
 .. Requirements
 
-.. _ansible_collections.codeaffen.phpipam.device_module_requirements:
-
 Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam\>=1.0.0
+- phpypam>=1.0.0
 
 
 
@@ -486,7 +485,7 @@ Parameters
 
       .. rst-class:: ansible-option-line
 
-      :ansible-option-default-bold:`Default:` :ansible-option-default:`"161"`
+      :ansible-option-default-bold:`Default:` :ansible-option-default:`161`
 
       .. raw:: html
 
@@ -1015,8 +1014,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-choices-entry:`false`
-      - :ansible-option-default-bold:`true` :ansible-option-default:`← (default)`
+      - :ansible-option-choices-entry:`no`
+      - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)`
 
       .. raw:: html
 

docs/plugins/device_type_module.rst

@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -45,9 +44,11 @@ codeaffen.phpipam.device_type module -- Manage device types
 .. note::
     This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_ (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`.
-    You need further requirements to be able to use this module,
-    see :ref:`Requirements <ansible_collections.codeaffen.phpipam.device_type_module_requirements>` for details.
 
     To use it in a playbook, specify: :code:`codeaffen.phpipam.device_type`.
 
@@ -75,15 +76,13 @@ Synopsis
 
 .. Requirements
 
-.. _ansible_collections.codeaffen.phpipam.device_type_module_requirements:
-
 Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam\>=1.0.0
+- phpypam>=1.0.0
 
 
 
@@ -389,8 +388,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-choices-entry:`false`
-      - :ansible-option-default-bold:`true` :ansible-option-default:`← (default)`
+      - :ansible-option-choices-entry:`no`
+      - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)`
 
       .. raw:: html
 

docs/plugins/domain_module.rst

@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -45,9 +44,11 @@ codeaffen.phpipam.domain module -- Manage L2 routing domains
 .. note::
     This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_ (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`.
-    You need further requirements to be able to use this module,
-    see :ref:`Requirements <ansible_collections.codeaffen.phpipam.domain_module_requirements>` for details.
 
     To use it in a playbook, specify: :code:`codeaffen.phpipam.domain`.
 
@@ -75,15 +76,13 @@ Synopsis
 
 .. Requirements
 
-.. _ansible_collections.codeaffen.phpipam.domain_module_requirements:
-
 Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam\>=1.0.0
+- phpypam>=1.0.0
 
 
 
@@ -423,8 +422,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-choices-entry:`false`
-      - :ansible-option-default-bold:`true` :ansible-option-default:`← (default)`
+      - :ansible-option-choices-entry:`no`
+      - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)`
 
       .. raw:: html
 

docs/plugins/index.rst

@@ -1,6 +1,5 @@
 
 
-
 .. _plugins_in_codeaffen.phpipam:
 
 Codeaffen.Phpipam
@@ -57,7 +56,7 @@ Modules
 * :ref:`location module <ansible_collections.codeaffen.phpipam.location_module>` -- Manage locations
 * :ref:`nameserver module <ansible_collections.codeaffen.phpipam.nameserver_module>` -- Manage nameservers
 * :ref:`section module <ansible_collections.codeaffen.phpipam.section_module>` -- Manage sections
-* :ref:`subnet module <ansible_collections.codeaffen.phpipam.subnet_module>` -- Manage subnets
+* :ref:`subnet module <ansible_collections.codeaffen.phpipam.subnet_module>` -- 
 * :ref:`tag module <ansible_collections.codeaffen.phpipam.tag_module>` -- Manage tags
 * :ref:`vlan module <ansible_collections.codeaffen.phpipam.vlan_module>` -- Manage vlans
 * :ref:`vrf module <ansible_collections.codeaffen.phpipam.vrf_module>` -- Manage virtual routers and forwarders

docs/plugins/location_module.rst

@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -45,9 +44,11 @@ codeaffen.phpipam.location module -- Manage locations
 .. note::
     This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_ (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`.
-    You need further requirements to be able to use this module,
-    see :ref:`Requirements <ansible_collections.codeaffen.phpipam.location_module_requirements>` for details.
 
     To use it in a playbook, specify: :code:`codeaffen.phpipam.location`.
 
@@ -75,16 +76,14 @@ Synopsis
 
 .. Requirements
 
-.. _ansible_collections.codeaffen.phpipam.location_module_requirements:
-
 Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
 - geopy
 - inflection
 - ipaddress
-- phpypam\>=1.0.0
+- phpypam>=1.0.0
 
 
 
@@ -403,8 +402,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-default-bold:`false` :ansible-option-default:`← (default)`
-      - :ansible-option-choices-entry:`true`
+      - :ansible-option-default-bold:`no` :ansible-option-default:`← (default)`
+      - :ansible-option-choices-entry:`yes`
 
       .. raw:: html
 
@@ -553,8 +552,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-choices-entry:`false`
-      - :ansible-option-default-bold:`true` :ansible-option-default:`← (default)`
+      - :ansible-option-choices-entry:`no`
+      - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)`
 
       .. raw:: html
 

docs/plugins/nameserver_module.rst

@@ -1,4 +1,3 @@
-
 .. Document meta
 
 :orphan:
@@ -45,9 +44,11 @@ codeaffen.phpipam.nameserver module -- Manage nameservers
 .. note::
     This module is part of the `codeaffen.phpipam collection <https://galaxy.ansible.com/codeaffen/phpipam>`_ (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`.
-    You need further requirements to be able to use this module,
-    see :ref:`Requirements <ansible_collections.codeaffen.phpipam.nameserver_module_requirements>` for details.
 
     To use it in a playbook, specify: :code:`codeaffen.phpipam.nameserver`.
 
@@ -75,15 +76,13 @@ Synopsis
 
 .. Requirements
 
-.. _ansible_collections.codeaffen.phpipam.nameserver_module_requirements:
-
 Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
 - inflection
 - ipaddress
-- phpypam\>=1.0.0
+- phpypam>=1.0.0
 
 
 
@@ -457,8 +456,8 @@ Parameters
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-choices-entry:`false`
-      - :ansible-option-default-bold:`true` :ansible-option-default:`← (default)`
+      - :ansible-option-choices-entry:`no`
+      - :ansible-option-default-bold:`yes` :ansible-option-default:`← (default)`
 
       .. raw:: html