Merge pull request #843 from netbox-community/devel

Release 3.8.1

.github/workflows/main.yml

@@ -45,106 +45,82 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - python-version: 3.8
-            VERSION: "v2.11"
-            INTEGRATION_TESTS: "v2.11"
-          - python-version: 3.8
-            VERSION: "v3.0"
-            INTEGRATION_TESTS: "v3.0"
           - python-version: 3.8
             VERSION: "v3.1"
             INTEGRATION_TESTS: "v3.1"
           - python-version: 3.8
             VERSION: "v3.2"
             INTEGRATION_TESTS: "v3.2"
+          - python-version: 3.8
+            VERSION: "v3.3"
+            INTEGRATION_TESTS: "v3.3"
     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 }}
-        if: matrix.VERSION == 'v2.11'
-      - name: Clone & Start netbox-docker containers - 2.11
-        env:
-          VERSION: ${{ matrix.VERSION }}
-        run: |
-          cd ..
-          git clone https://github.com/netbox-community/netbox-docker.git
-          cd netbox-docker
-          git checkout 1.2.0
-          tee docker-compose.override.yml <<EOF
-          version: '3.4'
-          services:
-            netbox:
-              image: netboxcommunity/netbox:v2.11
-              ports:
-                - 32768:8080
-          EOF
-          docker-compose up -d --quiet-pull
-          docker container ls
-          cd ..
-        if: matrix.VERSION == 'v2.11'
-      - name: Clone & Start netbox-docker containers - 3.0
+      - name: Clone & Start netbox-docker containers - 3.1
         env:
           VERSION: ${{ matrix.VERSION }}
         run: |
           cd ..
           git clone https://github.com/netbox-community/netbox-docker.git
           cd netbox-docker
-          git checkout 1.3.1
+          git checkout 1.4.1
           tee docker-compose.override.yml <<EOF
           version: '3.4'
           services:
             netbox:
-              image: netboxcommunity/netbox:v3.0
+              image: netboxcommunity/netbox:v3.1
               ports:
                 - 32768:8080
           EOF
           docker-compose up -d --quiet-pull
           docker container ls
           cd ..
-        if: matrix.VERSION == 'v3.0'
-      - name: Clone & Start netbox-docker containers - 3.1
+        if: matrix.VERSION == 'v3.1'
+      - 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'
+        if: matrix.VERSION == 'v3.3'
       - name: Install and configure Poetry
         uses: snok/install-poetry@v1.1.1
         with:

.readthedocs.yml

@@ -3,6 +3,6 @@ version: 2
 #  configuration: docs/conf.py
 
 python:
-  version: 3.6
+  version: 3.8
   install:
     - requirements: docs/requirements.txt

CHANGELOG.rst

@@ -5,6 +5,19 @@ NetBox.NetBox Release Notes
 .. contents:: Topics
 
 
+v3.8.1
+======
+
+Minor Changes
+-------------
+
+- nb_inventory - Allow for jinja templating [#834](https://github.com/netbox-community/ansible_modules/pull/834)
+
+Bugfixes
+--------
+
+- Fix idempotency with custom_fields [#839](https://github.com/netbox-community/ansible_modules/pull/839)
+
 v3.8.0
 ======
 

README.md

@@ -14,6 +14,7 @@ To keep the code simple, we only officially support the two latest releases of N
 - NetBox 2.11+ or the two latest NetBox releases
 - Python 3.8+
 - Python modules:
+  - `pytz`
   - `pynetbox 5.0.4+`, `pynetbox 6.4.0+` if using 3.1 features
   - `packaging` if using Ansible < 2.10, as it's included in Ansible 2.10+
 - Ansible 2.10+

changelogs/changelog.yaml

@@ -706,3 +706,13 @@ releases:
         - netbox_cable - Change length to float from int [#828](https://github.com/netbox-community/ansible_modules/pull/828)
         - netbox_location - Add tenant to module [#829](https://github.com/netbox-community/ansible_modules/pull/829)      
     release_date: '2022-09-19'
+  3.8.1:
+    changes:
+      bugfixes:
+        - Fix idempotency with custom_fields [#839](https://github.com/netbox-community/ansible_modules/pull/839)
+      minor_changes:      
+        - nb_inventory - Allow for jinja templating [#834](https://github.com/netbox-community/ansible_modules/pull/834)
+      trivial:
+        - Update CI to include NetBox 3.3 [#841](https://github.com/netbox-community/ansible_modules/pull/841)
+        - Update documentation to show exclusion filter [#837](https://github.com/netbox-community/ansible_modules/pull/837)
+    release_date: '2022-10-17'

changelogs/fragments/allow-jinja2.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - nb_inventory - Allow Jinja2 template on filter

docs/conf.py

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

docs/plugins/index.rst

@@ -6,7 +6,7 @@
 Netbox.Netbox
 =============
 
-Collection version 3.8.0
+Collection version 3.8.1
 
 .. contents::
    :local:

docs/plugins/nb_inventory_inventory.rst

@@ -43,7 +43,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.8.0).
+    This inventory plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
 
@@ -710,7 +710,9 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      List of parameters passed to the query string for devices (Multiple values may be separated by commas)
+      List of parameters passed to the query string for devices (Multiple values may be separated by commas).
+
+      You can also use Jinja2 templates.
 
 
       .. rst-class:: ansible-option-line
@@ -1086,6 +1088,8 @@ Parameters
       - :ansible-option-choices-entry:`is\_virtual`
       - :ansible-option-choices-entry:`services`
       - :ansible-option-choices-entry:`status`
+      - :ansible-option-choices-entry:`time\_zone`
+      - :ansible-option-choices-entry:`utc\_offset`
 
       .. rst-class:: ansible-option-line
 
@@ -1836,7 +1840,9 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      List of parameters passed to the query string for both devices and VMs (Multiple values may be separated by commas)
+      List of parameters passed to the query string for both devices and VMs (Multiple values may be separated by commas).
+
+      You can also use Jinja2 templates.
 
 
       .. rst-class:: ansible-option-line
@@ -2307,7 +2313,9 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      List of parameters passed to the query string for VMs (Multiple values may be separated by commas)
+      List of parameters passed to the query string for VMs (Multiple values may be separated by commas).
+
+      You can also use Jinja2 templates.
 
 
       .. rst-class:: ansible-option-line
@@ -2349,8 +2357,11 @@ Examples
       - role: network-edge-router
     device_query_filters:
       - has_primary_ip: 'true'
+      - tenant__n: internal
 
     # has_primary_ip is a useful way to filter out patch panels and other passive devices
+    # Adding '__n' to a field searches for the negation of the value.
+    # The above searches for devices that are NOT "tenant = internal"
 
     # Query filters are passed directly as an argument to the fetching queries.
     # You can repeat tags in the query string.
@@ -2406,6 +2417,32 @@ Examples
       NETBOX_API: '{{ NETBOX_API }}'
       NETBOX_TOKEN: '{{ NETBOX_TOKEN }}'
 
+    # Example of time_zone and utc_offset usage
+
+    plugin: netbox.netbox.nb_inventory
+    api_endpoint: http://localhost:8000
+    token: <insert token>
+    validate_certs: True
+    config_context: True
+    group_by:
+      - site
+      - role
+      - time_zone
+      - utc_offset
+    device_query_filters:
+      - has_primary_ip: 'true'
+      - manufacturer_id: 1
+
+    # using group by time_zone, utc_offset it will group devices in ansible groups depending on time zone configured on site.
+    # time_zone gives grouping like:
+    # - "time_zone_Europe_Bucharest"
+    # - "time_zone_Europe_Copenhagen"
+    # - "time_zone_America_Denver"
+    # utc_offset gives grouping like:
+    # - "time_zone_utc_minus_7"
+    # - "time_zone_utc_plus_1"
+    # - "time_zone_utc_plus_10"
+
 
 
 

docs/plugins/nb_lookup_lookup.rst

@@ -43,7 +43,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.8.0).
+    This lookup plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this lookup plugin,

docs/plugins/netbox_aggregate_module.rst

@@ -43,7 +43,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.8.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,

docs/plugins/netbox_cable_module.rst

@@ -43,7 +43,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.8.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,

docs/plugins/netbox_circuit_module.rst

@@ -43,7 +43,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.8.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,

docs/plugins/netbox_circuit_termination_module.rst

@@ -43,7 +43,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.8.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,

docs/plugins/netbox_circuit_type_module.rst

@@ -43,7 +43,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.8.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,

docs/plugins/netbox_cluster_group_module.rst

@@ -43,7 +43,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.8.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,

docs/plugins/netbox_cluster_module.rst

@@ -43,7 +43,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.8.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,

docs/plugins/netbox_cluster_type_module.rst

@@ -43,7 +43,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.8.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,

docs/plugins/netbox_config_context_module.rst

@@ -43,7 +43,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.8.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,

docs/plugins/netbox_console_port_module.rst

@@ -43,7 +43,7 @@ netbox.netbox.netbox_console_port module -- Create, update or delete console por
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.8.1).
 
     To install it, use: :code:`ansible-galaxy collection install netbox.netbox`.
     You need further requirements to be able to use this module,

docs/plugins/netbox_console_port_template_module.rst

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