Merge pull request #343 from nautobot/develop

Develop to main for release

.github/workflows/tests.yml

@@ -54,7 +54,9 @@ jobs:
         python-version:
           - "3.9"
         nautobot-version:
-          - "2.0"
+          - "2.1"
+          # TODO: Change to 2.2 once it's released
+          # - "2.2"
         ansible-version:
           - "2.14"
           - "2.15"
@@ -76,6 +78,9 @@ jobs:
           - "3.11"
         nautobot-version:
           - "2.0"
+          - "2.1"
+          # TODO: Enable 2.2 once it's released
+          # - "2.2"
         ansible-version:
           - "2.14"
           - "2.15"

.github/workflows/trigger_release.yml

@@ -45,6 +45,9 @@ jobs:
           - "3.11"
         nautobot-version:
           - "2.0"
+          - "2.1"
+          # TODO: Enable 2.2 once it's released
+          # - "2.2"
         ansible-version:
           - "2.14"
           - "2.15"

CHANGELOG.rst

@@ -5,6 +5,20 @@ networktocode.nautobot Release Notes
 .. contents:: Topics
 
 
+v5.2.0
+======
+
+Minor Changes
+-------------
+- (#310) Fixed `parent` for location_type to convert to UUID for idempotency
+- (#319) Added `custom_fields` to `tag`, `vlan_group` and `role` modules
+- (#321) Updated documentation and examples for the `lookup` plugin
+- (#323) Added constructed features and inventory cache to the `gql_inventory` plugin
+- (#335) Fixed custom field idempotency for various modules
+- (#336) Added `custom_fields` to the `inventory_item` module
+- (#338) Added `num_retries` to the `lookup` plugin
+- (#340) Added `label` and `description` to the `device_interface_template` module
+
 v5.1.1
 ======
 

changelogs/changelog.yaml

@@ -433,3 +433,14 @@ releases:
       - (#298) Removes `status` option from being required unless creating a new object for various modules
       - (#299) Added example for using the `depth` option in the `lookup` module
       - (#304) Fixed the ability to look up `parent_location` by name instead of UUID in the `location` module
+  5.2.0:
+    changes:
+      minor_changes:
+      - (#310) Fixed `parent` for location_type to convert to UUID for idempotency
+      - (#319) Added `custom_fields` to `tag`, `vlan_group` and `role` modules
+      - (#321) Updated documentation and examples for the `lookup` plugin
+      - (#323) Added constructed features and inventory cache to the `gql_inventory` plugin
+      - (#335) Fixed custom field idempotency for various modules
+      - (#336) Added `custom_fields` to the `inventory_item` module
+      - (#338) Added `num_retries` to the `lookup` plugin
+      - (#340) Added `label` and `description` to the `device_interface_template` module

development/nautobot_config.py

@@ -1,4 +1,5 @@
 """Nautobot development configuration file."""
+
 # pylint: disable=invalid-envvar-default
 import os
 import sys
@@ -73,3 +74,6 @@
 
 # Enable installed plugins. Add the name of each plugin to the list.
 PLUGINS = ["nautobot_bgp_models"]
+
+# Disable metrics for tests
+INSTALLATION_METRICS_ENABLED = False

docker-compose.yml

@@ -34,10 +34,3 @@ services:
     build:
       <<: *build
       target: integration
-    networks:
-      - integration_network
-
-# Attach these services to the Nautobot network that gets spun up from invoke start
-networks:
-  integration_network:
-    name: nautobot_ansible_default

docs/plugins/cable_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.cable module -- Create, update or delete cables within Na
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/circuit_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.circuit module -- Create, update or delete circuits withi
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/circuit_termination_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.circuit_termination module -- Create, update or delete ci
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/circuit_type_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.circuit_type module -- Create, update or delete circuit t
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/cluster_group_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.cluster_group module -- Create, update or delete cluster
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/cluster_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.cluster module -- Create, update or delete clusters withi
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/cluster_type_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.cluster_type module -- Create, update or delete cluster t
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/console_port_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.console_port module -- Create, update or delete console p
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/console_port_template_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.console_port_template module -- Create, update or delete
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/console_server_port_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.console_server_port module -- Create, update or delete co
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/console_server_port_template_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.console_server_port_template module -- Create, update or
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/custom_field_choice_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.custom_field_choice module -- Creates or removes custom f
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/custom_field_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.custom_field module -- Creates or removes custom fields f
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/device_bay_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.device_bay module -- Create, update or delete device bays
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/device_bay_template_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.device_bay_template module -- Create, update or delete de
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/device_interface_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.device_interface module -- Creates or removes interfaces
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/device_interface_template_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.device_interface_template module -- Creates or removes in
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,
@@ -137,6 +137,43 @@ Parameters
       API Version Nautobot REST API
 
 
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-description"></div>
+
+      .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-description:
+
+      .. rst-class:: ansible-option-title
+
+      **description**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-description" title="Permalink to this option"></a>
+
+      .. rst-class:: ansible-option-type-line
+
+      :ansible-option-type:`string`
+
+      :ansible-option-versionadded:`added in networktocode.nautobot 5.2.0`
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      Description of the interface
+
+
       .. raw:: html
 
         </div>
@@ -174,6 +211,43 @@ Parameters
       Name of the device the interface template will be associated with (case-sensitive)
 
 
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-label"></div>
+
+      .. _ansible_collections.networktocode.nautobot.device_interface_template_module__parameter-label:
+
+      .. rst-class:: ansible-option-title
+
+      **label**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-label" title="Permalink to this option"></a>
+
+      .. rst-class:: ansible-option-type-line
+
+      :ansible-option-type:`string`
+
+      :ansible-option-versionadded:`added in networktocode.nautobot 5.2.0`
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      Label of the interface template to be created
+
+
       .. raw:: html
 
         </div>

docs/plugins/device_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.device module -- Create, update or delete devices within
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/device_redundancy_group_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.device_redundancy_group module -- Creates or removes devi
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/device_type_module.rst

@@ -42,7 +42,7 @@ networktocode.nautobot.device_type module -- Create, update or delete device typ
 .. Collection note
 
 .. note::
-    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.1.1).
+    This module is part of the `networktocode.nautobot collection <https://galaxy.ansible.com/networktocode/nautobot>`_ (version 5.2.0).
 
     To install it, use: :code:`ansible-galaxy collection install networktocode.nautobot`.
     You need further requirements to be able to use this module,

docs/plugins/environment_variables.rst

@@ -0,0 +1,36 @@
+
+:orphan:
+
+.. _list_of_collection_env_vars:
+
+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 configuration are documented in :ref:`ansible_configuration_settings`.
+
+.. envvar:: ANSIBLE_INVENTORY_USE_EXTRA_VARS
+
+    Merge extra vars into the available variables for composition (highest precedence).
+
+    *Used by:*
+    :ref:`networktocode.nautobot.gql\_inventory inventory plugin <ansible_collections.networktocode.nautobot.gql_inventory_inventory>`,
+    :ref:`networktocode.nautobot.inventory inventory plugin <ansible_collections.networktocode.nautobot.inventory_inventory>`
+.. envvar:: NAUTOBOT_TOKEN
+
+    See the documentations for the options where this environment variable is used.
+
+    *Used by:*
+    :ref:`networktocode.nautobot.gql\_inventory inventory plugin <ansible_collections.networktocode.nautobot.gql_inventory_inventory>`,
+    :ref:`networktocode.nautobot.inventory inventory plugin <ansible_collections.networktocode.nautobot.inventory_inventory>`,
+    :ref:`networktocode.nautobot.lookup lookup plugin <ansible_collections.networktocode.nautobot.lookup_lookup>`,
+    :ref:`networktocode.nautobot.lookup\_graphql lookup plugin <ansible_collections.networktocode.nautobot.lookup_graphql_lookup>`
+.. envvar:: NAUTOBOT_URL
+
+    See the documentations for the options where this environment variable is used.
+
+    *Used by:*
+    :ref:`networktocode.nautobot.gql\_inventory inventory plugin <ansible_collections.networktocode.nautobot.gql_inventory_inventory>`,
+    :ref:`networktocode.nautobot.inventory inventory plugin <ansible_collections.networktocode.nautobot.inventory_inventory>`,
+    :ref:`networktocode.nautobot.lookup lookup plugin <ansible_collections.networktocode.nautobot.lookup_lookup>`,
+    :ref:`networktocode.nautobot.lookup\_graphql lookup plugin <ansible_collections.networktocode.nautobot.lookup_graphql_lookup>`