Merge pull request #692 from netbox-community/devel

Release 3.5.0

Author: rodvand

.github/workflows/main.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ["3.8", "3.9", "3.10"]
     steps:
       - name: Checkout repo
         uses: actions/checkout@v2
@@ -18,7 +18,7 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install and configure Poetry
-        uses: snok/install-poetry@v1.1.1
+        uses: snok/install-poetry@v1
         with:
           virtualenvs-create: false
       - name: Install Python packages
@@ -28,15 +28,15 @@ jobs:
           ansible-galaxy collection build .
           ansible-galaxy collection install netbox*.tar.gz -p /home/runner/.ansible/collections
       - name: Run Black
-        run: black . --check --diff
+        run: poetry run black . --check --diff
       - name: Run Ansible Sanity tests
-        run: ansible-test sanity -v --requirements --python ${{ matrix.python-version }} --skip-test pep8 plugins/
+        run: poetry run ansible-test sanity -v --requirements --python ${{ matrix.python-version }} --skip-test pep8 plugins/
         working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
       - name: Run Ansible Unit tests
-        run: ansible-test units -vvv --coverage --python ${{ matrix.python-version }}
+        run: poetry run ansible-test units -vvv --coverage --python ${{ matrix.python-version }}
         working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
       - name: Run Ansible Coverage
-        run: ansible-test coverage report --all --omit "tests/*,hacking/*,docs/*" --show-missing
+        run: poetry run ansible-test coverage report --all --omit "tests/*,hacking/*,docs/*" --show-missing
         working-directory: /home/runner/.ansible/collections/ansible_collections/netbox/netbox
   integration:
     runs-on: ubuntu-latest
@@ -45,82 +45,83 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - python-version: 3.8
-            VERSION: "v2.10"
-            INTEGRATION_TESTS: "v2.10"
           - 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"
     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 - 2.10
+        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.1.0
+          git checkout 1.2.0
           tee docker-compose.override.yml <<EOF
           version: '3.4'
           services:
             netbox:
-              image: netboxcommunity/netbox:v2.10
+              image: netboxcommunity/netbox:v2.11
               ports:
                 - 32768:8080
           EOF
           docker-compose up -d --quiet-pull
           docker container ls
           cd ..
-        if: matrix.VERSION == 'v2.10'
-      - name: Clone & Start netbox-docker containers - 2.11
+        if: matrix.VERSION == 'v2.11'
+      - name: Clone & Start netbox-docker containers - 3.0
         env:
           VERSION: ${{ matrix.VERSION }}
         run: |
           cd ..
           git clone https://github.com/netbox-community/netbox-docker.git
           cd netbox-docker
-          git checkout 1.2.0
+          git checkout 1.3.1
           tee docker-compose.override.yml <<EOF
           version: '3.4'
           services:
             netbox:
-              image: netboxcommunity/netbox:v2.11
+              image: netboxcommunity/netbox:v3.0
               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
+        if: matrix.VERSION == 'v3.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'
+        if: matrix.VERSION == 'v3.1'
       - name: Install and configure Poetry
         uses: snok/[email protected]
         with:

CHANGELOG.rst

@@ -5,6 +5,39 @@ NetBox.NetBox Release Notes
 .. contents:: Topics
 
 
+v3.5.0
+======
+
+Release Summary
+---------------
+
+First release with some NetBox 3.1 modules, and new wireless endpoint support. Remember to update your pynetbox to utilise the wireless endpoint support.
+
+Minor Changes
+-------------
+
+- nb_inventory - Pull extended inventory data for prefixes and site [#646](https://github.com/netbox-community/ansible_modules/pull/646)
+- nb_lookup - Add endpoints for wireless (new in NetBox 3.1) [#673](https://github.com/netbox-community/ansible_modules/pull/673)
+- netbox_circuit_termination - Add mark_connected field to module [#686](https://github.com/netbox-community/ansible_modules/pull/686)
+- netbox_contact, netbox_contact_group, netbox_contact_role - Add modules [#671](https://github.com/netbox-community/ansible_modules/pull/671)
+- netbox_inventory_item - Add parent field to module [#682](https://github.com/netbox-community/ansible_modules/pull/682)
+- netbox_region - Add description, tags, custom_fields to module [#689](https://github.com/netbox-community/ansible_modules/pull/689)
+- netbox_wireless_lan, netbox_wireless_lan_group, netbox_wireless_link - Add modules [#678](https://github.com/netbox-community/ansible_modules/pull/678)
+
+Bugfixes
+--------
+
+- Use individual list items when looking for objects  [#570](https://github.com/netbox-community/ansible_modules/pull/570)
+
+New Modules
+-----------
+
+- netbox.netbox.netbox_contact - Create, update or delete Contact objects in NetBox
+- netbox.netbox.netbox_contact_group - Create, update or delete Contact Group objects in NetBox
+- netbox.netbox.netbox_wireless_lan - Create, update or delete Wireless LAN objects in NetBox
+- netbox.netbox.netbox_wireless_lan_group - Create, update or delete Wireless LAN Group objects in NetBox
+- netbox.netbox.netbox_wireless_link - Create, update or delete Wireless Link objects in NetBox
+
 v3.4.0
 ======
 

README.md

@@ -3,12 +3,6 @@
 ![Release](https://img.shields.io/github/v/release/netbox-community/ansible_modules)
 [![Talk to us: Slack](https://img.shields.io/badge/Slack-blue.svg)](https://netdev-community.slack.com/join/shared_invite/zt-mtts8g0n-Sm6Wutn62q_M4OdsaIycrQ#/shared-invite/email)
 
-# Looking for New Maintainers
-
-We are in search of a few maintainers for this project.  Please see discussion [Looking for maintainers](https://github.com/netbox-community/ansible_modules/discussions/526).  Our previous single maintainer was unable to keep up with the project to the high bar set by @FragmentedPacket.  The reality is that this is not a project that should be held by a single maintainer.  Reach out in the discussion or on our slack if you are interested in helping out.
-
-While we look for maintainers who have shown a willingness to provide inputs/ides, contribute code, and review contributions, the netbox-community team will do its best to maintain this repo in the interim.  Prioritization will given to bug fixes, NetBox compatibility, and Ansible requirements/compatibility.  New features (associated to the project or NetBox core)will be developed as a best effort, but rest assured, no releases will be cut that are not stable and tested.
-
 # NetBox modules for Ansible using Ansible Collections
 
 We have moved this collection to a different namespace and collection name on Ansible Galaxy. The new versions will be at `netbox.netbox`.
@@ -17,12 +11,12 @@ To keep the code simple, we only officially support the two latest releases of N
 
 ## Requirements
 
-- NetBox 2.6+ or the two latest NetBox releases
-- Python 3.6+
+- NetBox 2.11+ or the two latest NetBox releases
+- Python 3.8+
 - Python modules:
-  - `pynetbox 5.0.4+`
+  - `pynetbox 5.0.4+`, `pynetbox 6.4.0` if using 3.1 features
   - `packages` if using Ansible < 2.10, as it's included in Ansible 2.10+
-- Ansible 2.9+
+- Ansible 2.10+
 - NetBox write-enabled token when using modules or read-only token for `nb_lookup/nb_inventory`
 
 ## Docs

changelogs/changelog.yaml

@@ -604,3 +604,39 @@ releases:
         name: netbox_provider_network
         namespace: ''
     release_date: '2021-11-28'
+  3.5.0:
+    changes:
+      release_summary:
+        First release with some NetBox 3.1 modules, and new wireless endpoint support. Remember to update your pynetbox
+        to utilise the wireless endpoint support.
+      minor_changes:
+        - netbox_contact, netbox_contact_group, netbox_contact_role - Add modules [#671](https://github.com/netbox-community/ansible_modules/pull/671)
+        - netbox_wireless_lan, netbox_wireless_lan_group, netbox_wireless_link - Add modules [#678](https://github.com/netbox-community/ansible_modules/pull/678)
+        - nb_inventory - Pull extended inventory data for prefixes and site [#646](https://github.com/netbox-community/ansible_modules/pull/646)
+        - nb_lookup - Add endpoints for wireless (new in NetBox 3.1) [#673](https://github.com/netbox-community/ansible_modules/pull/673)
+        - netbox_inventory_item - Add parent field to module [#682](https://github.com/netbox-community/ansible_modules/pull/682)
+        - netbox_circuit_termination - Add mark_connected field to module [#686](https://github.com/netbox-community/ansible_modules/pull/686)
+        - netbox_region - Add description, tags, custom_fields to module [#689](https://github.com/netbox-community/ansible_modules/pull/689)
+
+      bugfixes:
+        - Use individual list items when looking for objects  [#570](https://github.com/netbox-community/ansible_modules/pull/570)
+
+    modules:
+      - description: Create, update or delete Contact objects in NetBox 
+        name: netbox_contact
+        namespace: ''
+      - description: Create, update or delete Contact Group objects in NetBox 
+        name: netbox_contact_group
+        namespace: ''
+      - description: Create, update or delete Contact Role objects in NetBox 
+        name: netbox_contact_role
+      - description: Create, update or delete Wireless LAN objects in NetBox 
+        name: netbox_wireless_lan
+        namespace: ''
+      - description: Create, update or delete Wireless LAN Group objects in NetBox 
+        name: netbox_wireless_lan_group
+        namespace: ''
+      - description: Create, update or delete Wireless Link objects in NetBox 
+        name: netbox_wireless_link
+        namespace: ''
+    relese_data: '2022-01-11'

docs/_extensions/pygments_lexer.py

@@ -70,7 +70,9 @@ class AnsibleOutputPrimaryLexer(RegexLexer):
         # #########################################
         # # BEGIN: states from JSON lexer #########
         # #########################################
-        "whitespace": [(r"\s+", token.Text),],
+        "whitespace": [
+            (r"\s+", token.Text),
+        ],
         # represents a simple terminal value
         "simplevalue": [
             (r"(true|false|null)\b", token.Keyword.Constant),

docs/conf.py

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

docs/plugins/index.rst

@@ -1,15 +1,15 @@
-:orphan:
 
 .. _plugins_in_netbox.netbox:
 
 Netbox.Netbox
 =============
 
-Collection version 3.4.0
+Collection version 3.5.0
 
 .. toctree::
     :maxdepth: 1
 
+
 Plugin Index
 ------------
 
@@ -42,6 +42,9 @@ Modules
 * :ref:`netbox_console_port_template <ansible_collections.netbox.netbox.netbox_console_port_template_module>` -- Create, update or delete console port templates within NetBox
 * :ref:`netbox_console_server_port <ansible_collections.netbox.netbox.netbox_console_server_port_module>` -- Create, update or delete console server ports within NetBox
 * :ref:`netbox_console_server_port_template <ansible_collections.netbox.netbox.netbox_console_server_port_template_module>` -- Create, update or delete console server port templates within NetBox
+* :ref:`netbox_contact <ansible_collections.netbox.netbox.netbox_contact_module>` -- Creates or removes contacts from NetBox
+* :ref:`netbox_contact_group <ansible_collections.netbox.netbox.netbox_contact_group_module>` -- Creates or removes contact groups from NetBox
+* :ref:`netbox_contact_role <ansible_collections.netbox.netbox.netbox_contact_role_module>` -- Creates or removes contact roles from NetBox
 * :ref:`netbox_device <ansible_collections.netbox.netbox.netbox_device_module>` -- Create, update or delete devices within NetBox
 * :ref:`netbox_device_bay <ansible_collections.netbox.netbox.netbox_device_bay_module>` -- Create, update or delete device bays within NetBox
 * :ref:`netbox_device_bay_template <ansible_collections.netbox.netbox.netbox_device_bay_template_module>` -- Create, update or delete device bay templates within NetBox
@@ -86,8 +89,82 @@ Modules
 * :ref:`netbox_vlan_group <ansible_collections.netbox.netbox.netbox_vlan_group_module>` -- Create, update or delete vlans groups within NetBox
 * :ref:`netbox_vm_interface <ansible_collections.netbox.netbox.netbox_vm_interface_module>` -- Creates or removes interfaces from virtual machines in NetBox
 * :ref:`netbox_vrf <ansible_collections.netbox.netbox.netbox_vrf_module>` -- Create, update or delete vrfs within NetBox
+* :ref:`netbox_wireless_lan <ansible_collections.netbox.netbox.netbox_wireless_lan_module>` -- Creates or removes Wireless LANs from NetBox
+* :ref:`netbox_wireless_lan_group <ansible_collections.netbox.netbox.netbox_wireless_lan_group_module>` -- Creates or removes Wireless LAN Groups from NetBox
+* :ref:`netbox_wireless_link <ansible_collections.netbox.netbox.netbox_wireless_link_module>` -- Creates or removes Wireless links from NetBox
+
 
 
 .. seealso::
 
-    List of :ref:`collections <list_of_collections>` with docs hosted here.
+    List of :ref:`collections <list_of_collections>` with docs hosted here.
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    nb_inventory_inventory
+    nb_lookup_lookup
+    netbox_aggregate_module
+    netbox_cable_module
+    netbox_circuit_module
+    netbox_circuit_termination_module
+    netbox_circuit_type_module
+    netbox_cluster_module
+    netbox_cluster_group_module
+    netbox_cluster_type_module
+    netbox_config_context_module
+    netbox_console_port_module
+    netbox_console_port_template_module
+    netbox_console_server_port_module
+    netbox_console_server_port_template_module
+    netbox_contact_module
+    netbox_contact_group_module
+    netbox_contact_role_module
+    netbox_device_module
+    netbox_device_bay_module
+    netbox_device_bay_template_module
+    netbox_device_interface_module
+    netbox_device_interface_template_module
+    netbox_device_role_module
+    netbox_device_type_module
+    netbox_front_port_module
+    netbox_front_port_template_module
+    netbox_inventory_item_module
+    netbox_ip_address_module
+    netbox_ipam_role_module
+    netbox_location_module
+    netbox_manufacturer_module
+    netbox_platform_module
+    netbox_power_feed_module
+    netbox_power_outlet_module
+    netbox_power_outlet_template_module
+    netbox_power_panel_module
+    netbox_power_port_module
+    netbox_power_port_template_module
+    netbox_prefix_module
+    netbox_provider_module
+    netbox_provider_network_module
+    netbox_rack_module
+    netbox_rack_group_module
+    netbox_rack_role_module
+    netbox_rear_port_module
+    netbox_rear_port_template_module
+    netbox_region_module
+    netbox_rir_module
+    netbox_route_target_module
+    netbox_service_module
+    netbox_site_module
+    netbox_site_group_module
+    netbox_tag_module
+    netbox_tenant_module
+    netbox_tenant_group_module
+    netbox_virtual_chassis_module
+    netbox_virtual_machine_module
+    netbox_vlan_module
+    netbox_vlan_group_module
+    netbox_vm_interface_module
+    netbox_vrf_module
+    netbox_wireless_lan_module
+    netbox_wireless_lan_group_module
+    netbox_wireless_link_module