Release 3.13 (#1000)

Author: rodvand

CHANGELOG.rst

@@ -5,6 +5,27 @@ NetBox.NetBox Release Notes
 .. contents:: Topics
 
 
+v3.13.0
+=======
+
+Minor Changes
+-------------
+
+- nb_inventory - Enable NetBox 3.5 support [#999](https://github.com/netbox-community/ansible_modules/pull/999)
+- netbox_fhrp_group_assignment - Add module [#974](https://github.com/netbox-community/ansible_modules/pull/974)
+- netbox_lsvpn_termination - Add module [#994](https://github.com/netbox-community/ansible_modules/pull/994)
+
+Bugfixes
+--------
+
+- netbox_cable - Fix idempotency [#990](https://github.com/netbox-community/ansible_modules/pull/990)
+
+New Modules
+-----------
+
+- netbox.netbox.netbox_fhrp_group_assignment - Creates, updates or removes FHRP group assignments from NetBox
+- netbox.netbox.netbox_lsvpn_termination - Creates, updates or removes L2VPNs terminations from NetBox
+
 v3.12.0
 =======
 

changelogs/changelog.yaml

@@ -789,3 +789,19 @@ releases:
         name: netbox_asn
         namespace: ''
     release_date: '2023-04-04'
+  3.13.0:
+    changes:
+      bugfixes:
+        - netbox_cable - Fix idempotency [#990](https://github.com/netbox-community/ansible_modules/pull/990)
+      minor_changes:
+        - netbox_fhrp_group_assignment - Add module [#974](https://github.com/netbox-community/ansible_modules/pull/974)
+        - netbox_lsvpn_termination - Add module [#994](https://github.com/netbox-community/ansible_modules/pull/994)
+        - nb_inventory - Enable NetBox 3.5 support [#999](https://github.com/netbox-community/ansible_modules/pull/999)
+    modules:
+      - description: Creates, updates or removes FHRP group assignments from NetBox
+        name: netbox_fhrp_group_assignment
+        namespace: ''
+      - description: Creates, updates or removes L2VPNs terminations from NetBox
+        name: netbox_lsvpn_termination
+        namespace: ''
+    release_date: '2023-05-11'

docs/conf.py

@@ -27,7 +27,7 @@
 author = "Mikhail Yohman <@FragmentedPacket>"
 
 # The full version, including alpha/beta/rc tags
-release = "3.12.0"
+release = "3.13.0"
 
 
 # -- General configuration ---------------------------------------------------

docs/plugins/environment_variables.rst

@@ -7,7 +7,7 @@ Index of all Collection Environment Variables
 =============================================
 
 The following index documents all environment variables declared by plugins in collections.
-Environment variables used by the ansible-core configuation are documented in :ref:`ansible_configuration_settings`.
+Environment variables used by the ansible-core configuration are documented in :ref:`ansible_configuration_settings`.
 
 .. envvar:: ANSIBLE_INVENTORY_USE_EXTRA_VARS
 

docs/plugins/index.rst

@@ -6,7 +6,7 @@
 Netbox.Netbox
 =============
 
-Collection version 3.12.0
+Collection version 3.13.0
 
 .. contents::
    :local:
@@ -76,6 +76,7 @@ Modules
 * :ref:`netbox_device_type module <ansible_collections.netbox.netbox.netbox_device_type_module>` -- Create, update or delete device types within NetBox
 * :ref:`netbox_export_template module <ansible_collections.netbox.netbox.netbox_export_template_module>` -- Creates, updates or deletes export templates within NetBox
 * :ref:`netbox_fhrp_group module <ansible_collections.netbox.netbox.netbox_fhrp_group_module>` -- Create, update or delete FHRP groups within NetBox
+* :ref:`netbox_fhrp_group_assignment module <ansible_collections.netbox.netbox.netbox_fhrp_group_assignment_module>` -- Create, update or delete FHRP group assignments within NetBox
 * :ref:`netbox_front_port module <ansible_collections.netbox.netbox.netbox_front_port_module>` -- Create, update or delete front ports within NetBox
 * :ref:`netbox_front_port_template module <ansible_collections.netbox.netbox.netbox_front_port_template_module>` -- Create, update or delete front port templates within NetBox
 * :ref:`netbox_inventory_item module <ansible_collections.netbox.netbox.netbox_inventory_item_module>` -- Creates or removes inventory items from NetBox
@@ -84,6 +85,7 @@ Modules
 * :ref:`netbox_ipam_role module <ansible_collections.netbox.netbox.netbox_ipam_role_module>` -- Creates or removes ipam roles from NetBox
 * :ref:`netbox_journal_entry module <ansible_collections.netbox.netbox.netbox_journal_entry_module>` -- Creates a journal entry
 * :ref:`netbox_l2vpn module <ansible_collections.netbox.netbox.netbox_l2vpn_module>` -- Create, update or delete L2VPNs within NetBox
+* :ref:`netbox_l2vpn_termination module <ansible_collections.netbox.netbox.netbox_l2vpn_termination_module>` -- Create, update or delete L2VPNs terminations within NetBox
 * :ref:`netbox_location module <ansible_collections.netbox.netbox.netbox_location_module>` -- Create, update or delete locations within NetBox
 * :ref:`netbox_manufacturer module <ansible_collections.netbox.netbox.netbox_manufacturer_module>` -- Create or delete manufacturers within NetBox
 * :ref:`netbox_module_type module <ansible_collections.netbox.netbox.netbox_module_type_module>` -- Create, update or delete module types within NetBox
@@ -123,26 +125,10 @@ Modules
 * :ref:`netbox_wireless_lan_group module <ansible_collections.netbox.netbox.netbox_wireless_lan_group_module>` -- Creates or removes Wireless LAN Groups from NetBox
 * :ref:`netbox_wireless_link module <ansible_collections.netbox.netbox.netbox_wireless_link_module>` -- Creates or removes Wireless links from NetBox
 
-
-Inventory Plugins
-~~~~~~~~~~~~~~~~~
-
-* :ref:`nb_inventory inventory <ansible_collections.netbox.netbox.nb_inventory_inventory>` -- NetBox inventory source
-
-
-Lookup Plugins
-~~~~~~~~~~~~~~
-
-* :ref:`nb_lookup lookup <ansible_collections.netbox.netbox.nb_lookup_lookup>` -- Queries and returns elements from NetBox
-
-
-
 .. toctree::
     :maxdepth: 1
     :hidden:
 
-    nb_inventory_inventory
-    nb_lookup_lookup
     netbox_aggregate_module
     netbox_asn_module
     netbox_cable_module
@@ -171,6 +157,7 @@ Lookup Plugins
     netbox_device_type_module
     netbox_export_template_module
     netbox_fhrp_group_module
+    netbox_fhrp_group_assignment_module
     netbox_front_port_module
     netbox_front_port_template_module
     netbox_inventory_item_module
@@ -179,6 +166,7 @@ Lookup Plugins
     netbox_ipam_role_module
     netbox_journal_entry_module
     netbox_l2vpn_module
+    netbox_l2vpn_termination_module
     netbox_location_module
     netbox_manufacturer_module
     netbox_module_type_module
@@ -217,3 +205,29 @@ Lookup Plugins
     netbox_wireless_lan_module
     netbox_wireless_lan_group_module
     netbox_wireless_link_module
+
+
+Inventory Plugins
+~~~~~~~~~~~~~~~~~
+
+* :ref:`nb_inventory inventory <ansible_collections.netbox.netbox.nb_inventory_inventory>` -- NetBox inventory source
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    nb_inventory_inventory
+
+
+Lookup Plugins
+~~~~~~~~~~~~~~
+
+* :ref:`nb_lookup lookup <ansible_collections.netbox.netbox.nb_lookup_lookup>` -- Queries and returns elements from NetBox
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    nb_lookup_lookup
+
+

docs/plugins/nb_inventory_inventory.rst

@@ -42,7 +42,7 @@ netbox.netbox.nb_inventory inventory -- NetBox inventory source
 .. Collection note
 
 .. note::
-    This inventory plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This inventory plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
 
@@ -81,7 +81,6 @@ Synopsis
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::

docs/plugins/nb_lookup_lookup.rst

@@ -42,7 +42,7 @@ netbox.netbox.nb_lookup lookup -- Queries and returns elements from NetBox
 .. Collection note
 
 .. note::
-    This lookup plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This lookup plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this lookup plugin,
@@ -145,9 +145,11 @@ Terms
 
 .. Options
 
-Parameters
-----------
+Keyword parameters
+------------------
 
+This describes keyword parameters of the lookup. These are the values ``key1=value1``, ``key2=value2`` and so on in the following
+examples: ``lookup('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)`` and ``query('netbox.netbox.nb_lookup', key1=value1, key2=value2, ...)``
 
 .. rst-class:: ansible-option-table
 
@@ -497,6 +499,12 @@ Parameters
 
 .. Notes
 
+Notes
+-----
+
+.. note::
+   - When keyword and positional parameters are used together, positional parameters must be listed before keyword parameters:
+     ``lookup('netbox.netbox.nb_lookup', term1, term2, key1=value1, key2=value2)`` and ``query('netbox.netbox.nb_lookup', term1, term2, key1=value1, key2=value2)``
 
 .. Seealso
 

docs/plugins/netbox_aggregate_module.rst

@@ -42,7 +42,7 @@ netbox.netbox.netbox_aggregate module -- Creates or removes aggregates from NetB
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,
@@ -94,7 +94,6 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::

docs/plugins/netbox_asn_module.rst

@@ -42,7 +42,7 @@ netbox.netbox.netbox_asn module -- Create, update or delete ASNs within NetBox
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,
@@ -94,7 +94,6 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::

docs/plugins/netbox_cable_module.rst

@@ -42,7 +42,7 @@ netbox.netbox.netbox_cable module -- Create, update or delete cables within NetB
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,
@@ -94,7 +94,6 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::

docs/plugins/netbox_circuit_module.rst

@@ -42,7 +42,7 @@ netbox.netbox.netbox_circuit module -- Create, update or delete circuits within
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,
@@ -94,7 +94,6 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::

docs/plugins/netbox_circuit_termination_module.rst

@@ -42,7 +42,7 @@ netbox.netbox.netbox_circuit_termination module -- Create, update or delete circ
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,
@@ -94,7 +94,6 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::

docs/plugins/netbox_circuit_type_module.rst

@@ -42,7 +42,7 @@ netbox.netbox.netbox_circuit_type module -- Create, update or delete circuit typ
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,
@@ -94,7 +94,6 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::

docs/plugins/netbox_cluster_group_module.rst

@@ -42,7 +42,7 @@ netbox.netbox.netbox_cluster_group module -- Create, update or delete cluster gr
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,
@@ -94,7 +94,6 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::

docs/plugins/netbox_cluster_module.rst

@@ -42,7 +42,7 @@ netbox.netbox.netbox_cluster module -- Create, update or delete clusters within
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,
@@ -94,7 +94,6 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::

docs/plugins/netbox_cluster_type_module.rst

@@ -42,7 +42,7 @@ netbox.netbox.netbox_cluster_type module -- Create, update or delete cluster typ
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,
@@ -94,7 +94,6 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::

docs/plugins/netbox_config_context_module.rst

@@ -42,7 +42,7 @@ netbox.netbox.netbox_config_context module -- Creates, updates or deletes config
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.12.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.13.0).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,
@@ -94,7 +94,6 @@ The below requirements are needed on the host that executes this module.
 Parameters
 ----------
 
-
 .. rst-class:: ansible-option-table
 
 .. list-table::