Update docs and changelog for 3.1.0 release (#512)

Author: FragmentedPacket

CHANGELOG.rst

@@ -5,6 +5,42 @@ Netbox.Netbox Release Notes
 .. contents:: Topics
 
 
+v3.1.0
+======
+
+Release Summary
+---------------
+
+This release should fix obvious broken changes between collection and Netbox 2.11, but there is most likely more. Please report as they're encountered.
+**packages** is now a required Python package and is already included in Ansible 2.10, but anyone using Ansible 2.9 or below must manually pip install the library.
+
+
+Major Changes
+-------------
+
+- packages is now a required Python package and gets installed via Ansible 2.10+.
+
+Minor Changes
+-------------
+
+- netbox_device_interface - Add label option.
+- netbox_device_interface - Add mark_connected option.
+- netbox_power_panel - Add location option.
+- netbox_rack - Add location option.
+- netbox_vlan_group - Add custom_fields option.
+- netbox_vlan_group - Add description option.
+- netbox_vlan_group - Add scope option.
+- netbox_vlan_group - Add scope_type option.
+
+Bugfixes
+--------
+
+- Allow ``virtual_chassis`` to be found via name [#402](https://github.com/netbox-community/ansible_modules/issues/402)
+- Fix mapping between power_outlet_template and power_port_template.
+- inventory - Fix rack-group -> location for NetBox 2.11 changes.
+- inventory - Properly handle interface tags.
+- netbox_tenant - Fix example to match argspec.
+
 v3.0.0
 ======
 

changelogs/changelog.yaml

@@ -495,3 +495,36 @@ releases:
     fragments:
     - release-3.0.0.yml
     release_date: '2021-03-08'
+  3.1.0:
+    changes:
+      bugfixes:
+      - Allow ``virtual_chassis`` to be found via name [#402](https://github.com/netbox-community/ansible_modules/issues/402)
+      - Fix mapping between power_outlet_template and power_port_template.
+      - inventory - Fix rack-group -> location for NetBox 2.11 changes.
+      - inventory - Properly handle interface tags.
+      - netbox_tenant - Fix example to match argspec.
+      major_changes:
+      - packages is now a required Python package and gets installed via Ansible 2.10+.
+      minor_changes:
+      - netbox_device_interface - Add label option.
+      - netbox_device_interface - Add mark_connected option.
+      - netbox_power_panel - Add location option.
+      - netbox_rack - Add location option.
+      - netbox_vlan_group - Add custom_fields option.
+      - netbox_vlan_group - Add description option.
+      - netbox_vlan_group - Add scope option.
+      - netbox_vlan_group - Add scope_type option.
+      release_summary: 'This release should fix obvious broken changes between collection
+        and Netbox 2.11, but there is most likely more. Please report as they''re
+        encountered.
+
+        **packages** is now a required Python package and is already included in Ansible
+        2.10, but anyone using Ansible 2.9 or below must manually pip install the
+        library.
+
+        '
+    fragments:
+    - 2.11-changes.yml
+    - issue-402.yml
+    - release-summary-3.1.0.yml
+    release_date: '2021-05-08'

changelogs/fragments/2.11-changes.yml

@@ -5,7 +5,7 @@
 Netbox.Netbox
 =============
 
-Collection version 3.0.0
+Collection version 3.1.0
 
 .. toctree::
     :maxdepth: 1

changelogs/fragments/issue-402.yml

@@ -20,7 +20,7 @@ netbox.netbox.nb_inventory -- NetBox inventory source
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/index.rst

@@ -20,7 +20,7 @@ netbox.netbox.nb_lookup -- Queries and returns elements from Netbox
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/nb_inventory_inventory.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_aggregate -- Creates or removes aggregates from Netbox
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/nb_lookup_lookup.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_cable -- Create, update or delete cables within Netbox
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_aggregate_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_circuit -- Create, update or delete circuits within Netbox
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_cable_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_circuit_termination -- Create, update or delete circuit ter
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_circuit_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_circuit_type -- Create, update or delete circuit types with
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_circuit_termination_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_cluster_group -- Create, update or delete cluster groups wi
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_circuit_type_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_cluster -- Create, update or delete clusters within Netbox
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_cluster_group_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_cluster_type -- Create, update or delete cluster types with
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_cluster_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_console_port -- Create, update or delete console ports with
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_cluster_type_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_console_port_template -- Create, update or delete console p
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_console_port_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_console_server_port -- Create, update or delete console ser
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_console_port_template_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_console_server_port_template -- Create, update or delete co
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_console_server_port_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_device_bay -- Create, update or delete device bays within N
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_console_server_port_template_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_device_bay_template -- Create, update or delete device bay
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_device_bay_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_device_interface -- Creates or removes interfaces on device
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 
@@ -154,6 +154,22 @@ Parameters
     ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE)
     This has to be specified exactly as what is found within UI</div>
                                                         </td>
+            </tr>
+                                <tr>
+                                                    <td class="elbow-placeholder"></td>
+                                                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-data/label"></div>
+                    <b>label</b>
+                    <a class="ansibleOptionLink" href="#parameter-data/label" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">string</span>
+                                                                    </div>
+                                                        </td>
+                                <td>
+                                                                                                                                                            </td>
+                                                                <td>
+                                            <div>Physical label of the interface</div>
+                                                        </td>
             </tr>
                                 <tr>
                                                     <td class="elbow-placeholder"></td>
@@ -186,6 +202,26 @@ Parameters
                                                                 <td>
                                             <div>The MAC address of the interface</div>
                                                         </td>
+            </tr>
+                                <tr>
+                                                    <td class="elbow-placeholder"></td>
+                                                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-data/mark_connected"></div>
+                    <b>mark_connected</b>
+                    <a class="ansibleOptionLink" href="#parameter-data/mark_connected" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">boolean</span>
+                                                                    </div>
+                                                        </td>
+                                <td>
+                                                                                                                                                                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
+                                                                                                                                                                <li>no</li>
+                                                                                                                                                                                                <li>yes</li>
+                                                                                    </ul>
+                                                                            </td>
+                                                                <td>
+                                            <div>Mark an interface as connected without a cable attached (netbox &gt;= 2.11 required)</div>
+                                                        </td>
             </tr>
                                 <tr>
                                                     <td class="elbow-placeholder"></td>
@@ -526,6 +562,15 @@ Examples
               name: GigabitEthernet2/0/1
               enabled: false
             update_vc_child: True
+        - name: Mark interface as connected without a cable (netbox >= 2.11 required)
+          netbox.netbox.netbox_device_interface:
+            netbox_url: http://netbox.local
+            netbox_token: thisIsMyToken
+            data:
+              device: test100
+              name: GigabitEthernet1
+              mark_connected: true
+            state: present
 
 
 

docs/plugins/netbox_device_bay_template_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_device_interface_template -- Creates or removes interfaces
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_device_interface_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_device -- Create, update or delete devices within Netbox
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_device_interface_template_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_device_role -- Create, update or delete devices roles withi
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_device_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_device_type -- Create, update or delete device types within
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_device_role_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_front_port -- Create, update or delete front ports within N
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_device_type_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_front_port_template -- Create, update or delete front port
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_front_port_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_inventory_item -- Creates or removes inventory items from N
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 

docs/plugins/netbox_front_port_template_module.rst

@@ -20,7 +20,7 @@ netbox.netbox.netbox_ip_address -- Creates or removes IP addresses from Netbox
 .. Collection note
 
 .. note::
-    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.1.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.