Merge pull request #1319 from netbox-community/devel

Release 3.20

Author: rodvand

.github/workflows/main.yml

@@ -62,17 +62,17 @@ jobs:
     runs-on: ubuntu-latest
     needs: unit_testing
     env:
-      python-version: "3.10"
+      python-version: "3.12"
     strategy:
       fail-fast: false
       matrix:
-        include:
-          - VERSION: "v3.6"
-            NETBOX_DOCKER_VERSION: 2.7.0
+        include:          
           - VERSION: "v3.7"
             NETBOX_DOCKER_VERSION: 2.7.0
           - VERSION: "v4.0"
             NETBOX_DOCKER_VERSION: 2.9.1
+          - VERSION: "v4.1"
+            NETBOX_DOCKER_VERSION: 3.0.1
 
     steps:
 
@@ -86,7 +86,7 @@ jobs:
           cd netbox-docker
           git checkout ${{ matrix.NETBOX_DOCKER_VERSION }}
           cp $GITHUB_WORKSPACE/tests/netbox-docker/${{ matrix.VERSION }}/docker-compose.override.yml docker-compose.override.yml
-          docker-compose up -d --quiet-pull netbox netbox-worker postgres redis redis-cache
+          docker compose up -d --quiet-pull netbox netbox-worker postgres redis redis-cache
           docker container ls
           cd ..
 
@@ -112,21 +112,28 @@ jobs:
       - name: Wait for NetBox to be available
         run: |
           docker container ls
-          docker logs netbox-docker_netbox_1
-          timeout 300 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:32768)" != "200" ]]; do echo "waiting for NetBox"; sleep 5; done' || false
-        working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
-        #if: matrix.VERSION == 'v3.3'
+          docker logs netbox-docker-netbox-1
+          timeout 300 bash -c 'while [[ "$(curl -s -o /dev/null -w ''%{http_code}'' localhost:32768/login/)" != "200" ]]; do echo "waiting for NetBox"; sleep 5; done' || false
+        working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox        
 
       - name: Pre-populate NetBox
         run: ./tests/integration/netbox-deploy.py
         working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
 
-      - name: Run integration tests
-        # Run regression and integration tests
-        # Run the inventory test first, in case any of the other tests modify the data.
+      - name: Run inventory tests
+        continue-on-error: true
         run: |
           ansible-test integration -v --color --coverage --python ${{ env.python-version }} inventory-${{ matrix.VERSION }}
-          ansible-test integration -v --color --coverage --python ${{ env.python-version }} regression-${{ matrix.VERSION }}
+        working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
+
+      - name: Run regression tests        
+        continue-on-error: true
+        run: |          
+          ansible-test integration -v --color --coverage --python ${{ env.python-version }} regression-${{ matrix.VERSION }}          
+        working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
+
+      - name: Run integration tests        
+        run: |
           ansible-test integration -v --color --coverage --python ${{ env.python-version }} ${{ matrix.VERSION }}
           ansible-test coverage report --all --omit "tests/*,hacking/*,docs/*" --show-missing
         working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox

CHANGELOG.rst

@@ -4,6 +4,40 @@ NetBox.NetBox Release Notes
 
 .. contents:: Topics
 
+v3.20.0
+=======
+
+Minor Changes
+-------------
+
+- Add ``facility`` to ``location`` (https://github.com/netbox-community/ansible_modules/issues/1280)
+- Add ``related_object_type`` to ``netbox_custom_filed`` (https://github.com/netbox-community/ansible_modules/issues/1268)
+- Add ``status`` to ``location`` (https://github.com/netbox-community/ansible_modules/issues/1279)
+- Add `description` to `netbox_cluster_group` module (https://github.com/netbox-community/ansible_modules/issues/1276)
+- Add `serial` to `netbox_virtual_machine` module (https://github.com/netbox-community/ansible_modules/issues/1309)
+- Add `status` to `netbox_cluster` (https://github.com/netbox-community/ansible_modules/issues/1275)
+- Add `vid_ranges` to `netbox_vlan_group` module (https://github.com/netbox-community/ansible_modules/issues/1307)
+- Add ability to rename variables set on the host by ``netbox.netbox.nb_inventory`` through configuration.
+- Added option `hostname_field` to ``nb_inventory`` to be able to set the inventory hostname from a field in custom_fields
+- Adjust tests for various modules
+- Fix the form_factor option on netbox_rack
+- Update CI for NetBox 4.1
+
+Bugfixes
+--------
+
+- If `fetch_all` is `false`, prefix lookup depends on site lookup, so move it to secondary lookup (https://github.com/netbox-community/ansible_modules/issues/733)
+
+New Modules
+-----------
+
+- netbox.netbox.netbox_permission - Creates or removes permissions from NetBox
+- netbox.netbox.netbox_token - Creates or removes tokens from NetBox
+- netbox.netbox.netbox_tunnel - Create, update or delete tunnels within NetBox
+- netbox.netbox.netbox_tunnel_group - Create, update or delete tunnel groups within NetBox
+- netbox.netbox.netbox_user - Creates or removes users from NetBox
+- netbox.netbox.netbox_user_group - Creates or removes user groups from NetBox
+
 v3.19.1
 =======
 

changelogs/changelog.yaml

@@ -763,6 +763,58 @@ releases:
       - netbox_virtual_machine - Change vCPU to float from int (to reflect NetBox
         3.0) [#605](https://github.com/netbox-community/ansible_modules/pull/605)
     release_date: '2021-10-18'
+  3.20.0:
+    changes:
+      bugfixes:
+      - If `fetch_all` is `false`, prefix lookup depends on site lookup, so move it
+        to secondary lookup (https://github.com/netbox-community/ansible_modules/issues/733)
+      minor_changes:
+      - Add ``facility`` to ``location`` (https://github.com/netbox-community/ansible_modules/issues/1280)
+      - Add ``related_object_type`` to ``netbox_custom_filed`` (https://github.com/netbox-community/ansible_modules/issues/1268)
+      - Add ``status`` to ``location`` (https://github.com/netbox-community/ansible_modules/issues/1279)
+      - Add `description` to `netbox_cluster_group` module (https://github.com/netbox-community/ansible_modules/issues/1276)
+      - Add `serial` to `netbox_virtual_machine` module (https://github.com/netbox-community/ansible_modules/issues/1309)
+      - Add `status` to `netbox_cluster` (https://github.com/netbox-community/ansible_modules/issues/1275)
+      - Add `vid_ranges` to `netbox_vlan_group` module (https://github.com/netbox-community/ansible_modules/issues/1307)
+      - Add ability to rename variables set on the host by ``netbox.netbox.nb_inventory``
+        through configuration.
+      - Added option `hostname_field` to ``nb_inventory`` to be able to set the inventory
+        hostname from a field in custom_fields
+      - Adjust tests for various modules
+      - Fix the form_factor option on netbox_rack
+      - Update CI for NetBox 4.1
+    fragments:
+    - 1273-ability-to-rename-host-inventory-vars.yml
+    - 1275-feature-netbox_cluster-adds-status-field.yml
+    - 1276-feature-netbox_cluster_group-adds-description-field.yml
+    - 1281_move_prefix_lookup_to_secondary.yml
+    - 1307-feature-netbox_vlan_group-add-vid_ranges.yml
+    - 1309-feature-add-serial-number-to-vm.yml
+    - 1312-add-hostname_field-option.yml
+    - 41_updates.yml
+    - ci_netbox41.yml
+    - fix_issue_1268.yml
+    - fix_issues_1279_1280.yml
+    modules:
+    - description: Creates or removes permissions from NetBox
+      name: netbox_permission
+      namespace: ''
+    - description: Creates or removes tokens from NetBox
+      name: netbox_token
+      namespace: ''
+    - description: Create, update or delete tunnels within NetBox
+      name: netbox_tunnel
+      namespace: ''
+    - description: Create, update or delete tunnel groups within NetBox
+      name: netbox_tunnel_group
+      namespace: ''
+    - description: Creates or removes users from NetBox
+      name: netbox_user
+      namespace: ''
+    - description: Creates or removes user groups from NetBox
+      name: netbox_user_group
+      namespace: ''
+    release_date: '2024-09-12'
   3.3.0:
     changes:
       minor_changes:

docs/conf.py

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

docs/plugins/environment_variables.rst

@@ -1,8 +1,7 @@
-
 :orphan:
 
 .. meta::
-  :antsibull-docs: 2.11.0
+  :antsibull-docs: 2.13.1
 
 .. _list_of_collection_env_vars:
 

docs/plugins/index.rst

@@ -1,15 +1,13 @@
-
-
 .. meta::
-  :antsibull-docs: 2.11.0
+  :antsibull-docs: 2.13.1
 
 
 .. _plugins_in_netbox.netbox:
 
 Netbox.Netbox
 =============
 
-Collection version 3.19.1
+Collection version 3.20.0
 
 .. contents::
    :local:
@@ -98,6 +96,7 @@ Modules
 * :ansplugin:`netbox_module module <netbox.netbox.netbox_module#module>` -- Create, update or delete module within NetBox
 * :ansplugin:`netbox_module_bay module <netbox.netbox.netbox_module_bay#module>` -- Create, update or delete module bay within NetBox
 * :ansplugin:`netbox_module_type module <netbox.netbox.netbox_module_type#module>` -- Create, update or delete module types within NetBox
+* :ansplugin:`netbox_permission module <netbox.netbox.netbox_permission#module>` -- Creates or removes permissions from NetBox
 * :ansplugin:`netbox_platform module <netbox.netbox.netbox_platform#module>` -- Create or delete platforms within NetBox
 * :ansplugin:`netbox_power_feed module <netbox.netbox.netbox_power_feed#module>` -- Create, update or delete power feeds within NetBox
 * :ansplugin:`netbox_power_outlet module <netbox.netbox.netbox_power_outlet#module>` -- Create, update or delete power outlets within NetBox
@@ -123,6 +122,11 @@ Modules
 * :ansplugin:`netbox_tag module <netbox.netbox.netbox_tag#module>` -- Creates or removes tags from NetBox
 * :ansplugin:`netbox_tenant module <netbox.netbox.netbox_tenant#module>` -- Creates or removes tenants from NetBox
 * :ansplugin:`netbox_tenant_group module <netbox.netbox.netbox_tenant_group#module>` -- Creates or removes tenant groups from NetBox
+* :ansplugin:`netbox_token module <netbox.netbox.netbox_token#module>` -- Creates or removes tokens from NetBox
+* :ansplugin:`netbox_tunnel module <netbox.netbox.netbox_tunnel#module>` -- Create, update or delete tunnels within NetBox
+* :ansplugin:`netbox_tunnel_group module <netbox.netbox.netbox_tunnel_group#module>` -- Create, update or delete tunnel groups within NetBox
+* :ansplugin:`netbox_user module <netbox.netbox.netbox_user#module>` -- Creates or removes users from NetBox
+* :ansplugin:`netbox_user_group module <netbox.netbox.netbox_user_group#module>` -- Creates or removes user groups from NetBox
 * :ansplugin:`netbox_virtual_chassis module <netbox.netbox.netbox_virtual_chassis#module>` -- Create, update or delete virtual chassis within NetBox
 * :ansplugin:`netbox_virtual_disk module <netbox.netbox.netbox_virtual_disk#module>` -- Creates or removes disks from virtual machines in NetBox
 * :ansplugin:`netbox_virtual_machine module <netbox.netbox.netbox_virtual_machine#module>` -- Create, update or delete virtual\_machines within NetBox
@@ -184,6 +188,7 @@ Modules
     netbox_module_module
     netbox_module_bay_module
     netbox_module_type_module
+    netbox_permission_module
     netbox_platform_module
     netbox_power_feed_module
     netbox_power_outlet_module
@@ -209,6 +214,11 @@ Modules
     netbox_tag_module
     netbox_tenant_module
     netbox_tenant_group_module
+    netbox_token_module
+    netbox_tunnel_module
+    netbox_tunnel_group_module
+    netbox_user_module
+    netbox_user_group_module
     netbox_virtual_chassis_module
     netbox_virtual_disk_module
     netbox_virtual_machine_module
@@ -244,5 +254,3 @@ Lookup Plugins
     :hidden:
 
     nb_lookup_lookup
-
-