Release 3.4.0 (#643)

* Increase galaxy version and generate docs * Generate changelog
netbox-community · Nov 28, 2021 · 8381c5a · 8381c5a
1 parent 213f8a2
commit 8381c5a
Show file tree

Hide file tree

Showing 68 changed files with 1,186 additions and 517 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,34 @@ NetBox.NetBox Release Notes
 .. contents:: Topics
 
 
+v3.4.0
+======
+
+Minor Changes
+-------------
+
+- nb_inventory - Add documentation for use of inventory plugin in Tower/AWX [#648](https://github.com/netbox-community/ansible_modules/pull/648)
+- nb_inventory - Cache OpenAPI locally to speed up inventory [#617](https://github.com/netbox-community/ansible_modules/pull/617)
+- nb_lookup - Add missing endpoints to nb_lookup [#655](https://github.com/netbox-community/ansible_modules/pull/655)
+- netbox_cable - Improve lookup speed on NetBox versions earlier than 3.0.6 [#645](https://github.com/netbox-community/ansible_modules/pull/645)
+- netbox_inventory_item - Add label and custom fields to module [#632](https://github.com/netbox-community/ansible_modules/pull/632)
+- netbox_provider_network - Add module for handling provider networks [#653](https://github.com/netbox-community/ansible_modules/pull/653)
+- netbox_virtual_chassis - Add custom_fields to netbox_virtual_chassis [#657](https://github.com/netbox-community/ansible_modules/pull/657)
+- netbox_vm_interface - Add custom fields to module [#637](https://github.com/netbox-community/ansible_modules/pull/637)
+
+Bugfixes
+--------
+
+- nb_lookup - Fix documentation of validate_cert [#629](https://github.com/netbox-community/ansible_modules/pull/629)
+- netbox_site - Ensure idempotency between NetBox version 2.11 and 3.00 [#631](https://github.com/netbox-community/ansible_modules/pull/631)
+- netbox_virtual_chassis - Fix issue with virtual chassis creation [#657](https://github.com/netbox-community/ansible_modules/pull/657)
+- netbox_virtual_machine - Ensure idempotency between NetBox version 2.11 and 3.00 [#633](https://github.com/netbox-community/ansible_modules/pull/633)
+
+New Modules
+-----------
+
+- netbox.netbox.netbox_provider_network - Create, update or delete Provider Network in NetBox
+
 v3.3.0
 ======
 

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -583,3 +583,24 @@ releases:
       name: netbox_config_context
       namespace: ''
     release_date: '2021-10-25' 
+  3.4.0:
+    changes:
+      minor_changes:
+        - netbox_inventory_item - Add label and custom fields to module [#632](https://github.com/netbox-community/ansible_modules/pull/632)
+        - nb_inventory - Cache OpenAPI locally to speed up inventory [#617](https://github.com/netbox-community/ansible_modules/pull/617)
+        - netbox_vm_interface - Add custom fields to module [#637](https://github.com/netbox-community/ansible_modules/pull/637)
+        - netbox_provider_network - Add module for handling provider networks [#653](https://github.com/netbox-community/ansible_modules/pull/653)
+        - nb_lookup - Add missing endpoints to nb_lookup [#655](https://github.com/netbox-community/ansible_modules/pull/655)
+        - netbox_virtual_chassis - Add custom_fields to netbox_virtual_chassis [#657](https://github.com/netbox-community/ansible_modules/pull/657)
+        - nb_inventory - Add documentation for use of inventory plugin in Tower/AWX [#648](https://github.com/netbox-community/ansible_modules/pull/648)
+        - netbox_cable - Improve lookup speed on NetBox versions earlier than 3.0.6 [#645](https://github.com/netbox-community/ansible_modules/pull/645)
+      bugfixes:
+        - netbox_site - Ensure idempotency between NetBox version 2.11 and 3.00 [#631](https://github.com/netbox-community/ansible_modules/pull/631)
+        - netbox_virtual_machine - Ensure idempotency between NetBox version 2.11 and 3.00 [#633](https://github.com/netbox-community/ansible_modules/pull/633)
+        - nb_lookup - Fix documentation of validate_cert [#629](https://github.com/netbox-community/ansible_modules/pull/629)
+        - netbox_virtual_chassis - Fix issue with virtual chassis creation [#657](https://github.com/netbox-community/ansible_modules/pull/657)
+    modules:
+      - description: Create, update or delete Provider Network in NetBox
+        name: netbox_provider_network
+        namespace: ''
+    release_date: '2021-11-28'
diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst
@@ -2,10 +2,10 @@
 
 .. _plugins_in_netbox.netbox:
 
-NetBox.NetBox
+Netbox.Netbox
 =============
 
-Collection version 3.3.0
+Collection version 3.4.0
 
 .. toctree::
     :maxdepth: 1
@@ -65,6 +65,7 @@ Modules
 * :ref:`netbox_power_port_template <ansible_collections.netbox.netbox.netbox_power_port_template_module>` -- Create, update or delete power port templates within NetBox
 * :ref:`netbox_prefix <ansible_collections.netbox.netbox.netbox_prefix_module>` -- Creates or removes prefixes from NetBox
 * :ref:`netbox_provider <ansible_collections.netbox.netbox.netbox_provider_module>` -- Create, update or delete providers within NetBox
+* :ref:`netbox_provider_network <ansible_collections.netbox.netbox.netbox_provider_network_module>` -- Create, update or delete provider networks within NetBox
 * :ref:`netbox_rack <ansible_collections.netbox.netbox.netbox_rack_module>` -- Create, update or delete racks within NetBox
 * :ref:`netbox_rack_group <ansible_collections.netbox.netbox.netbox_rack_group_module>` -- Create, update or delete racks groups within NetBox
 * :ref:`netbox_rack_role <ansible_collections.netbox.netbox.netbox_rack_role_module>` -- Create, update or delete racks roles within NetBox

diff --git a/docs/plugins/nb_inventory_inventory.rst b/docs/plugins/nb_inventory_inventory.rst
@@ -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.3.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.4.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 
@@ -1016,6 +1016,28 @@ Examples
       - prefix: status
         key: status.value
 
+    # For use in Ansible Tower (AWX), please see this blog from RedHat: https://www.ansible.com/blog/using-an-inventory-plugin-from-a-collection-in-ansible-tower
+    # The credential for NetBox will need to expose NETBOX_API and NETBOX_TOKEN as environment variables.
+    # Example Ansible Tower credential Input Configuration:
+
+    fields:
+      - id: NETBOX_API
+        type: string
+        label: NetBox Host URL
+      - id: NETBOX_TOKEN
+        type: string
+        label: NetBox API Token
+        secret: true
+    required:
+      - NETBOX_API
+      - NETBOX_TOKEN
+
+    # Example Ansible Tower credential Injector Configuration:
+
+    env:
+      NETBOX_API: '{{ NETBOX_API }}'
+      NETBOX_TOKEN: '{{ NETBOX_TOKEN }}'
+
 
 
 

diff --git a/docs/plugins/nb_lookup_lookup.rst b/docs/plugins/nb_lookup_lookup.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.3.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.4.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 
@@ -235,7 +235,7 @@ Parameters
                                                                     </div>
                                                         </td>
                                 <td>
-                                                                                                                                                                                                                <b>Default:</b><br/><div style="color: blue">True</div>
+                                                                                                                                                                                                                <b>Default:</b><br/><div style="color: blue">"yes"</div>
                                     </td>
                                                     <td>
                                                                                             </td>

diff --git a/docs/plugins/netbox_aggregate_module.rst b/docs/plugins/netbox_aggregate_module.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.3.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.4.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 
@@ -209,7 +209,7 @@ Parameters
                                 <td>
                                                                                                                                                             </td>
                                                                 <td>
-                                            <div>The token created within NetBox to authorize API access</div>
+                                            <div>The NetBox API token.</div>
                                                         </td>
             </tr>
                                 <tr>
@@ -224,7 +224,8 @@ Parameters
                                 <td>
                                                                                                                                                             </td>
                                                                 <td>
-                                            <div>URL of the NetBox instance resolvable by Ansible control host</div>
+                                            <div>The URL of the NetBox instance.</div>
+                                            <div>Must be accessible by the Ansible control host.</div>
                                                         </td>
             </tr>
                                 <tr>
@@ -239,7 +240,7 @@ Parameters
                                 <td>
                                                                                                                                                             </td>
                                                                 <td>
-                                            <div>This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined</div>
+                                            <div>This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined</div>
                                             <div>in plugins/module_utils/netbox_utils.py and provides control to users on what may make</div>
                                             <div>an object unique in their environment.</div>
                                                         </td>
@@ -260,7 +261,7 @@ Parameters
                                                                                     </ul>
                                                                             </td>
                                                                 <td>
-                                            <div>The state of the aggregate</div>
+                                            <div>The state of the object.</div>
                                                         </td>
             </tr>
                                 <tr>
@@ -276,7 +277,8 @@ Parameters
                                                                                                                                                                                                                 <b>Default:</b><br/><div style="color: blue">"yes"</div>
                                     </td>
                                                                 <td>
-                                            <div>If <code>no</code>, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.</div>
+                                            <div>If <code>no</code>, SSL certificates will not be validated.</div>
+                                            <div>This should only be used on personally controlled sites using a self-signed certificates.</div>
                                                         </td>
             </tr>
                         </table>

diff --git a/docs/plugins/netbox_cable_module.rst b/docs/plugins/netbox_cable_module.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.3.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.4.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 
@@ -344,7 +344,7 @@ Parameters
                                 <td>
                                                                                                                                                             </td>
                                                                 <td>
-                                            <div>The token created within NetBox to authorize API access</div>
+                                            <div>The NetBox API token.</div>
                                                         </td>
             </tr>
                                 <tr>
@@ -359,7 +359,8 @@ Parameters
                                 <td>
                                                                                                                                                             </td>
                                                                 <td>
-                                            <div>URL of the NetBox instance resolvable by Ansible control host</div>
+                                            <div>The URL of the NetBox instance.</div>
+                                            <div>Must be accessible by the Ansible control host.</div>
                                                         </td>
             </tr>
                                 <tr>
@@ -374,7 +375,7 @@ Parameters
                                 <td>
                                                                                                                                                             </td>
                                                                 <td>
-                                            <div>This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined</div>
+                                            <div>This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined</div>
                                             <div>in plugins/module_utils/netbox_utils.py and provides control to users on what may make</div>
                                             <div>an object unique in their environment.</div>
                                                         </td>
@@ -390,12 +391,12 @@ Parameters
                                                         </td>
                                 <td>
                                                                                                                             <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                                                                                                                                                <li>absent</li>
-                                                                                                                                                                                                <li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li>
+                                                                                                                                                                <li><div style="color: blue"><b>present</b>&nbsp;&larr;</div></li>
+                                                                                                                                                                                                <li>absent</li>
                                                                                     </ul>
                                                                             </td>
                                                                 <td>
-                                            <div>Use <code>present</code> or <code>absent</code> for adding or removing.</div>
+                                            <div>The state of the object.</div>
                                                         </td>
             </tr>
                                 <tr>
@@ -411,7 +412,8 @@ Parameters
                                                                                                                                                                                                                 <b>Default:</b><br/><div style="color: blue">"yes"</div>
                                     </td>
                                                                 <td>
-                                            <div>If <code>no</code>, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.</div>
+                                            <div>If <code>no</code>, SSL certificates will not be validated.</div>
+                                            <div>This should only be used on personally controlled sites using a self-signed certificates.</div>
                                                         </td>
             </tr>
                         </table>