Merge pull request #910 from netbox-community/devel

Release 3.10.0

Author: rodvand

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -25,7 +25,7 @@ body:
     attributes:
       label: Ansible NetBox Collection version
       description: What version of the Ansible NetBox Collection are you currently running?
-      placeholder: v3.5.1
+      placeholder: v3.10.0
     validations:
       required: true
   - type: textarea
@@ -46,7 +46,7 @@ body:
     attributes:
       label: NetBox version
       description: What version of NetBox are you currently running?
-      placeholder: v3.1.6
+      placeholder: v3.4.0
     validations:
       required: true
   - type: dropdown
@@ -57,6 +57,7 @@ body:
         - "3.8"
         - "3.9"
         - "3.10"
+        - "3.11"
     validations:
       required: true
   - type: textarea

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -15,7 +15,7 @@ body:
     attributes:
       label: NetBox version
       description: What version of NetBox are you currently running?
-      placeholder: v3.1.6
+      placeholder: v3.4.0
     validations:
       required: true
   - type: dropdown

.github/workflows/main.yml

@@ -44,83 +44,83 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        include:
-          - python-version: 3.8
-            VERSION: "v3.1"
-            INTEGRATION_TESTS: "v3.1"
+        include:          
           - python-version: 3.8
             VERSION: "v3.2"
             INTEGRATION_TESTS: "v3.2"
           - python-version: 3.8
             VERSION: "v3.3"
             INTEGRATION_TESTS: "v3.3"
+          - python-version: 3.8
+            VERSION: "v3.4"
+            INTEGRATION_TESTS: "v3.4"
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v2
         with:
-          python-version: ${{ matrix.python-version }}
-      - name: Clone & Start netbox-docker containers - 3.1
+          python-version: ${{ matrix.python-version }}    
+      - name: Clone & Start netbox-docker containers - 3.2
         env:
           VERSION: ${{ matrix.VERSION }}
         run: |
           cd ..
           git clone https://github.com/netbox-community/netbox-docker.git
           cd netbox-docker
-          git checkout 1.4.1
+          git checkout 1.6.1
           tee docker-compose.override.yml <<EOF
           version: '3.4'
           services:
             netbox:
-              image: netboxcommunity/netbox:v3.1
+              image: netboxcommunity/netbox:v3.2
               ports:
                 - 32768:8080
           EOF
           docker-compose up -d --quiet-pull
           docker container ls
           cd ..
-        if: matrix.VERSION == 'v3.1'
-      - name: Clone & Start netbox-docker containers - 3.2
+        if: matrix.VERSION == 'v3.2'
+      - name: Clone & Start netbox-docker containers - 3.3
         env:
           VERSION: ${{ matrix.VERSION }}
         run: |
           cd ..
           git clone https://github.com/netbox-community/netbox-docker.git
           cd netbox-docker
-          git checkout 1.6.1
+          git checkout 2.2.0
           tee docker-compose.override.yml <<EOF
           version: '3.4'
           services:
             netbox:
-              image: netboxcommunity/netbox:v3.2
+              image: netboxcommunity/netbox:v3.3
               ports:
                 - 32768:8080
           EOF
           docker-compose up -d --quiet-pull
           docker container ls
           cd ..
-        if: matrix.VERSION == 'v3.2'
-      - name: Clone & Start netbox-docker containers - 3.3
+        if: matrix.VERSION == 'v3.3'
+      - name: Clone & Start netbox-docker containers - 3.4
         env:
           VERSION: ${{ matrix.VERSION }}
         run: |
           cd ..
           git clone https://github.com/netbox-community/netbox-docker.git
           cd netbox-docker
-          git checkout 2.2.0
+          git checkout 2.3.0
           tee docker-compose.override.yml <<EOF
           version: '3.4'
           services:
             netbox:
-              image: netboxcommunity/netbox:v3.3
+              image: netboxcommunity/netbox:v3.4
               ports:
                 - 32768:8080
           EOF
           docker-compose up -d --quiet-pull
           docker container ls
           cd ..
-        if: matrix.VERSION == 'v3.3'
+        if: matrix.VERSION == 'v3.4'
       - name: Install and configure Poetry
         uses: snok/install-poetry@v1.1.1
         with:

CHANGELOG.rst

@@ -5,6 +5,31 @@ NetBox.NetBox Release Notes
 .. contents:: Topics
 
 
+v3.10.0
+=======
+
+Minor Changes
+-------------
+
+- Add options for NetBox 3.4 [#905](https://github.com/netbox-community/ansible_modules/pull/905)
+- netbox_custom_field - Add group_name [#882](https://github.com/netbox-community/ansible_modules/pull/882)
+- netbox_device_type and netbox_device - Add airflow [#907](https://github.com/netbox-community/ansible_modules/pull/907)
+- netbox_invventory_item_role - Add module [#885](https://github.com/netbox-community/ansible_modules/pull/885)
+- netbox_module_type - Add module [#887](https://github.com/netbox-community/ansible_modules/pull/887)
+- netbox_service_template - Add module [#908](https://github.com/netbox-community/ansible_modules/pull/908)
+
+Bugfixes
+--------
+
+- nb_inventory - Raise exception on missing packaging [#900](https://github.com/netbox-community/ansible_modules/pull/900)
+
+New Modules
+-----------
+
+- netbox.netbox.netbox_inventory_item_role - Create, update or delete inventory item roles in NetBox
+- netbox.netbox.netbox_module_type - Create, update or delete module types in NetBox
+- netbox.netbox.netbox_service_template - Create, update or delete service templates in NetBox
+
 v3.9.0
 ======
 

changelogs/changelog.yaml

@@ -732,3 +732,28 @@ releases:
         name: netbox_l2vpn
         namespace: ''
     release_date: '2022-11-14'
+  3.10.0:
+      changes:
+        bugfixes:
+          - nb_inventory - Raise exception on missing packaging [#900](https://github.com/netbox-community/ansible_modules/pull/900)
+        minor_changes:
+          - netbox_service_template - Add module [#908](https://github.com/netbox-community/ansible_modules/pull/908)
+          - netbox_module_type - Add module [#887](https://github.com/netbox-community/ansible_modules/pull/887)
+          - netbox_invventory_item_role - Add module [#885](https://github.com/netbox-community/ansible_modules/pull/885)
+          - Add options for NetBox 3.4 [#905](https://github.com/netbox-community/ansible_modules/pull/905)
+          - netbox_custom_field - Add group_name [#882](https://github.com/netbox-community/ansible_modules/pull/882)
+          - netbox_device_type and netbox_device - Add airflow [#907](https://github.com/netbox-community/ansible_modules/pull/907)
+        trivial:
+          - Update CI for NetBox 3.4 [#906](https://github.com/netbox-community/ansible_modules/pull/906)
+          - Update documentation to use FQCN [#881](https://github.com/netbox-community/ansible_modules/pull/881)
+      modules:
+        - description: Create, update or delete service templates in NetBox 
+          name: netbox_service_template
+          namespace: ''
+        - description: Create, update or delete module types in NetBox 
+          name: netbox_module_type
+          namespace: ''
+        - description: Create, update or delete inventory item roles in NetBox 
+          name: netbox_inventory_item_role
+          namespace: ''
+      release_date: '2022-12-16'

docs/conf.py

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

docs/plugins/environment_variables.rst

@@ -0,0 +1,53 @@
+
+: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 configuation 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:`netbox.netbox.nb\_inventory inventory plugin <ansible_collections.netbox.netbox.nb_inventory_inventory>`
+.. envvar:: NETBOX_API
+
+    See the documentations for the options where this environment variable is used.
+
+    *Used by:*
+    :ref:`netbox.netbox.nb\_inventory inventory plugin <ansible_collections.netbox.netbox.nb_inventory_inventory>`,
+    :ref:`netbox.netbox.nb\_lookup lookup plugin <ansible_collections.netbox.netbox.nb_lookup_lookup>`
+.. envvar:: NETBOX_API_KEY
+
+    NetBox API token to be able to read against NetBox.
+
+    This may not be required depending on the NetBox setup.
+
+    *Used by:*
+    :ref:`netbox.netbox.nb\_inventory inventory plugin <ansible_collections.netbox.netbox.nb_inventory_inventory>`
+.. envvar:: NETBOX_API_TOKEN
+
+    The API token created through NetBox
+
+    This may not be required depending on the NetBox setup.
+
+    *Used by:*
+    :ref:`netbox.netbox.nb\_lookup lookup plugin <ansible_collections.netbox.netbox.nb_lookup_lookup>`
+.. envvar:: NETBOX_TOKEN
+
+    See the documentations for the options where this environment variable is used.
+
+    *Used by:*
+    :ref:`netbox.netbox.nb\_inventory inventory plugin <ansible_collections.netbox.netbox.nb_inventory_inventory>`,
+    :ref:`netbox.netbox.nb\_lookup lookup plugin <ansible_collections.netbox.netbox.nb_lookup_lookup>`
+.. envvar:: NETBOX_URL
+
+    The URL to the NetBox instance to query
+
+    *Used by:*
+    :ref:`netbox.netbox.nb\_lookup lookup plugin <ansible_collections.netbox.netbox.nb_lookup_lookup>`

docs/plugins/index.rst

@@ -6,7 +6,7 @@
 Netbox.Netbox
 =============
 
-Collection version 3.9.0
+Collection version 3.10.0
 
 .. contents::
    :local:
@@ -22,6 +22,10 @@ This is a collection of NetBox Ansible modules
 * Mikhail Yohman <mikhail.yohman@gmail.com>
 * Martin Rødvand <martin@rodvand.net>
 
+**Supported ansible-core versions:**
+
+* 2.9.10 or newer
+
 .. raw:: html
 
   <p class="ansible-links">
@@ -73,11 +77,13 @@ Modules
 * :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
+* :ref:`netbox_inventory_item_role module <ansible_collections.netbox.netbox.netbox_inventory_item_role_module>` -- Create, update or delete devices roles within NetBox
 * :ref:`netbox_ip_address module <ansible_collections.netbox.netbox.netbox_ip_address_module>` -- Creates or removes IP addresses from NetBox
 * :ref:`netbox_ipam_role module <ansible_collections.netbox.netbox.netbox_ipam_role_module>` -- Creates or removes ipam roles from NetBox
 * :ref:`netbox_l2vpn module <ansible_collections.netbox.netbox.netbox_l2vpn_module>` -- Create, update or delete L2VPNs 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
 * :ref:`netbox_platform module <ansible_collections.netbox.netbox.netbox_platform_module>` -- Create or delete platforms within NetBox
 * :ref:`netbox_power_feed module <ansible_collections.netbox.netbox.netbox_power_feed_module>` -- Create, update or delete power feeds within NetBox
 * :ref:`netbox_power_outlet module <ansible_collections.netbox.netbox.netbox_power_outlet_module>` -- Create, update or delete power outlets within NetBox
@@ -97,6 +103,7 @@ Modules
 * :ref:`netbox_rir module <ansible_collections.netbox.netbox.netbox_rir_module>` -- Create, update or delete RIRs within NetBox
 * :ref:`netbox_route_target module <ansible_collections.netbox.netbox.netbox_route_target_module>` -- Creates or removes route targets from NetBox
 * :ref:`netbox_service module <ansible_collections.netbox.netbox.netbox_service_module>` -- Creates or removes service from NetBox
+* :ref:`netbox_service_template module <ansible_collections.netbox.netbox.netbox_service_template_module>` -- Create, update or delete service templates within NetBox
 * :ref:`netbox_site module <ansible_collections.netbox.netbox.netbox_site_module>` -- Creates or removes sites from NetBox
 * :ref:`netbox_site_group module <ansible_collections.netbox.netbox.netbox_site_group_module>` -- Create, update, or delete site groups within NetBox
 * :ref:`netbox_tag module <ansible_collections.netbox.netbox.netbox_tag_module>` -- Creates or removes tags from NetBox
@@ -127,10 +134,6 @@ Lookup Plugins
 
 
 
-.. seealso::
-
-    List of :ref:`collections <list_of_collections>` with docs hosted here.
-
 .. toctree::
     :maxdepth: 1
     :hidden:
@@ -166,11 +169,13 @@ Lookup Plugins
     netbox_front_port_module
     netbox_front_port_template_module
     netbox_inventory_item_module
+    netbox_inventory_item_role_module
     netbox_ip_address_module
     netbox_ipam_role_module
     netbox_l2vpn_module
     netbox_location_module
     netbox_manufacturer_module
+    netbox_module_type_module
     netbox_platform_module
     netbox_power_feed_module
     netbox_power_outlet_module
@@ -190,6 +195,7 @@ Lookup Plugins
     netbox_rir_module
     netbox_route_target_module
     netbox_service_module
+    netbox_service_template_module
     netbox_site_module
     netbox_site_group_module
     netbox_tag_module