Release v3.0.0 (#463)

Author: FragmentedPacket

.github/workflows/main.yml

@@ -103,6 +103,7 @@ jobs:
         run: poetry install
       - name: Build and install collection
         run: |
+          ansible-galaxy collection install community.general -p /home/runner/.ansible/collections
           ansible-galaxy collection build .
           ansible-galaxy collection install netbox*.tar.gz -p /home/runner/.ansible/collections
       - name: Wait for NetBox to be available

CHANGELOG.rst

@@ -5,6 +5,25 @@ Netbox.Netbox Release Notes
 .. contents:: Topics
 
 
+v3.0.0
+======
+
+Minor Changes
+-------------
+
+- Allow rack to be in query_param_ids [#443](https://github.com/netbox-community/ansible_modules/pull/443)
+- netbox_cable -  Add tags option [#455](https://github.com/netbox-community/ansible_modules/pull/455)
+- netbox_cluster_type - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
+- netbox_ipam_role - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
+- netbox_manufacturer - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
+- netbox_rir - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
+- netbox_tenant_group - Add parent_tenant_group option [#460](https://github.com/netbox-community/ansible_modules/pull/460)
+
+Bugfixes
+--------
+
+- Remove ansible.netcommon and community.general dependencies from collection
+
 v2.1.0
 ======
 

changelogs/changelog.yaml

@@ -304,18 +304,17 @@ releases:
   0.3.0:
     changes:
       breaking_changes:
-      - "To pass in integers via Ansible Jinja filters for a key in ``data`` that\n\
-        requires querying an endpoint is now done by making it a dictionary with\n\
-        an ``id`` key. The previous behavior was to just pass in an integer and\n\
-        it was converted when normalizing the data, but some people may have names\n\
-        that are all integers and those were being converted erroneously so we made\n\
-        the decision to change the method to convert to an integer for the NetBox\n\
-        API.\n\n::\n\n  tasks:\n    - name: Create device within NetBox with only\
-        \ required information\n      netbox_device:\n        netbox_url: http://netbox-demo.org:32768\n\
-        \        netbox_token: 0123456789abcdef0123456789abcdef01234567\n        data:\n\
-        \          name: Test66\n          device_type:\n            id: \"{{ some_jinja_variable\
-        \ }}\"\n          device_role: Core Switch\n          site: Test Site\n  \
-        \        status: Staged\n        state: present\n"
+      - "To pass in integers via Ansible Jinja filters for a key in ``data`` that\nrequires
+        querying an endpoint is now done by making it a dictionary with\nan ``id``
+        key. The previous behavior was to just pass in an integer and\nit was converted
+        when normalizing the data, but some people may have names\nthat are all integers
+        and those were being converted erroneously so we made\nthe decision to change
+        the method to convert to an integer for the NetBox\nAPI.\n\n::\n\n  tasks:\n
+        \   - name: Create device within NetBox with only required information\n      netbox_device:\n
+        \       netbox_url: http://netbox-demo.org:32768\n        netbox_token: 0123456789abcdef0123456789abcdef01234567\n
+        \       data:\n          name: Test66\n          device_type:\n            id:
+        \"{{ some_jinja_variable }}\"\n          device_role: Core Switch\n          site:
+        Test Site\n          status: Staged\n        state: present\n"
       - '``pynetbox`` changed to using ``requests.Session()`` to manage the HTTP session
 
         which broke passing in ``ssl_verify`` when building the NetBox API client.
@@ -481,3 +480,18 @@ releases:
     fragments:
     - 2.1.0.yml
     release_date: '2021-02-15'
+  3.0.0:
+    changes:
+      bugfixes:
+      - Remove ansible.netcommon and community.general dependencies from collection
+      minor_changes:
+      - Allow rack to be in query_param_ids [#443](https://github.com/netbox-community/ansible_modules/pull/443)
+      - netbox_cable -  Add tags option [#455](https://github.com/netbox-community/ansible_modules/pull/455)
+      - netbox_cluster_type - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
+      - netbox_ipam_role - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
+      - netbox_manufacturer - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
+      - netbox_rir - Add description option [#451](https://github.com/netbox-community/ansible_modules/pull/451)
+      - netbox_tenant_group - Add parent_tenant_group option [#460](https://github.com/netbox-community/ansible_modules/pull/460)
+    fragments:
+    - release-3.0.0.yml
+    release_date: '2021-03-08'

docs/plugins/index.rst

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

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 2.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 
@@ -66,6 +66,27 @@ Parameters
         </tr>
                     <tr>
                                                                 <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-ansible_host_dns_name"></div>
+                    <b>ansible_host_dns_name</b>
+                    <a class="ansibleOptionLink" href="#parameter-ansible_host_dns_name" 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><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
+                                                                                                                                                                                                <li>yes</li>
+                                                                                    </ul>
+                                                                            </td>
+                                                    <td>
+                                                                                            </td>
+                                                <td>
+                                            <div>If True, sets DNS Name (fetched from primary_ip) to be used in ansible_host variable, instead of IP Address.</div>
+                                                        </td>
+            </tr>
+                                <tr>
+                                                                <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-api_endpoint"></div>
                     <b>api_endpoint</b>
                     <a class="ansibleOptionLink" href="#parameter-api_endpoint" title="Permalink to this option"></a>

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 2.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.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_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 2.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.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_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 2.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.
 
@@ -175,6 +175,22 @@ Parameters
                                                                 <td>
                                             <div>The status of the cable</div>
                                                         </td>
+            </tr>
+                                <tr>
+                                                    <td class="elbow-placeholder"></td>
+                                                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-data/tags"></div>
+                    <b>tags</b>
+                    <a class="ansibleOptionLink" href="#parameter-data/tags" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">list</span>
+                         / <span style="color: purple">elements=string</span>                                            </div>
+                                                        </td>
+                                <td>
+                                                                                                                                                            </td>
+                                                                <td>
+                                            <div>Any tags that the cable may need to be associated with</div>
+                                                        </td>
             </tr>
                                 <tr>
                                                     <td class="elbow-placeholder"></td>
@@ -446,6 +462,8 @@ Examples
               color: abcdef
               length: 30
               length_unit: m
+              tags:
+                - foo
             state: present
 
         - name: Delete cable within netbox

docs/plugins/netbox_circuit_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 2.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.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_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 2.0.0).
+    This plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/netbox/netbox>`_ (version 3.0.0).
 
     To install it use: :code:`ansible-galaxy collection install netbox.netbox`.