Release 3.18 (#1221)

Author: rodvand

CHANGELOG.rst

@@ -5,6 +5,28 @@ NetBox.NetBox Release Notes
 .. contents:: Topics
 
 
+v3.18.0
+=======
+
+Minor Changes
+-------------
+
+- nb_inventory - Add Virtual Disks to inventory [#1188](https://github.com/netbox-community/ansible_modules/pull/1188)
+- nb_inventory - Don't extract null values from custom fields [#1184](https://github.com/netbox-community/ansible_modules/pull/1184)
+- nb_inventory - Improve documentation for oob_ip_as_primary_ip [#1218](https://github.com/netbox-community/ansible_modules/pull/1218)
+- nb_inventory - Make oob_ip available regardless of oob_ip_as_primary_ip option [#1211](https://github.com/netbox-community/ansible_modules/pull/1211)
+- nb_lookup - Add custom field choice set [#1186](https://github.com/netbox-community/ansible_modules/pull/1186)
+- nb_lookup - Add endpoint for Virtual Disks [#1177](https://github.com/netbox-community/ansible_modules/pull/1177)
+- netbox_device_type and netbox_rack - Change u_height to float [#1200](https://github.com/netbox-community/ansible_modules/pull/1200)
+- netbox_export_templates - Update documentation [#1214](https://github.com/netbox-community/ansible_modules/pull/1214)
+- netbox_power_port - Add label [#1202](https://github.com/netbox-community/ansible_modules/pull/1202)
+
+New Modules
+-----------
+
+- netbox.netbox.netbox_custom_field_choice_set - Create, updates, or removes Custom Field Choice sets
+- netbox.netbox.netbox_module_bay - Create, updates, or removes Module Bay
+
 v3.17.0
 =======
 

changelogs/changelog.yaml

@@ -858,3 +858,25 @@ releases:
         name: netbox_virtual_disk
         namespace: ''
     release_date: '2024-02-14'
+  3.18.0:
+    changes:
+      minor_changes:
+        - nb_lookup - Add endpoint for Virtual Disks [#1177](https://github.com/netbox-community/ansible_modules/pull/1177)
+        - nb_lookup - Add custom field choice set [#1186](https://github.com/netbox-community/ansible_modules/pull/1186)
+        - nb_inventory - Don't extract null values from custom fields [#1184](https://github.com/netbox-community/ansible_modules/pull/1184)
+        - nb_inventory - Add Virtual Disks to inventory [#1188](https://github.com/netbox-community/ansible_modules/pull/1188)
+        - netbox_device_type and netbox_rack - Change u_height to float [#1200](https://github.com/netbox-community/ansible_modules/pull/1200)
+        - netbox_power_port - Add label [#1202](https://github.com/netbox-community/ansible_modules/pull/1202)
+        - nb_inventory - Make oob_ip available regardless of oob_ip_as_primary_ip option [#1211](https://github.com/netbox-community/ansible_modules/pull/1211)
+        - netbox_export_templates - Update documentation [#1214](https://github.com/netbox-community/ansible_modules/pull/1214)
+        - nb_inventory - Improve documentation for oob_ip_as_primary_ip [#1218](https://github.com/netbox-community/ansible_modules/pull/1218)
+    modules:
+      - description: Create, updates, or removes Custom Field Choice sets
+        name: netbox_custom_field_choice_set
+        namespace: ''
+      - description: Create, updates, or removes Module Bay
+        name: netbox_module_bay
+        namespace: ''
+      - description: Create, updates, or removes Module
+        namespace: ''
+    release_date: '2024-05-05'

docs/conf.py

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

docs/plugins/index.rst

@@ -9,7 +9,7 @@
 Netbox.Netbox
 =============
 
-Collection version 3.17.0
+Collection version 3.18.0
 
 .. contents::
    :local:
@@ -73,6 +73,7 @@ Modules
 * :ansplugin:`netbox_contact_group module <netbox.netbox.netbox_contact_group#module>` -- Creates or removes contact groups from NetBox
 * :ansplugin:`netbox_contact_role module <netbox.netbox.netbox_contact_role#module>` -- Creates or removes contact roles from NetBox
 * :ansplugin:`netbox_custom_field module <netbox.netbox.netbox_custom_field#module>` -- Creates, updates or deletes custom fields within NetBox
+* :ansplugin:`netbox_custom_field_choice_set module <netbox.netbox.netbox_custom_field_choice_set#module>` -- Creates, updates or deletes custom field choice sets within Netbox
 * :ansplugin:`netbox_custom_link module <netbox.netbox.netbox_custom_link#module>` -- Creates, updates or deletes custom links within NetBox
 * :ansplugin:`netbox_device module <netbox.netbox.netbox_device#module>` -- Create, update or delete devices within NetBox
 * :ansplugin:`netbox_device_bay module <netbox.netbox.netbox_device_bay#module>` -- Create, update or delete device bays within NetBox
@@ -95,6 +96,8 @@ Modules
 * :ansplugin:`netbox_l2vpn_termination module <netbox.netbox.netbox_l2vpn_termination#module>` -- Create, update or delete L2VPNs terminations within NetBox
 * :ansplugin:`netbox_location module <netbox.netbox.netbox_location#module>` -- Create, update or delete locations within NetBox
 * :ansplugin:`netbox_manufacturer module <netbox.netbox.netbox_manufacturer#module>` -- Create or delete manufacturers within NetBox
+* :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_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
@@ -156,6 +159,7 @@ Modules
     netbox_contact_group_module
     netbox_contact_role_module
     netbox_custom_field_module
+    netbox_custom_field_choice_set_module
     netbox_custom_link_module
     netbox_device_module
     netbox_device_bay_module
@@ -178,6 +182,8 @@ Modules
     netbox_l2vpn_termination_module
     netbox_location_module
     netbox_manufacturer_module
+    netbox_module_module
+    netbox_module_bay_module
     netbox_module_type_module
     netbox_platform_module
     netbox_power_feed_module

docs/plugins/nb_inventory_inventory.rst

@@ -23,7 +23,7 @@ netbox.netbox.nb_inventory inventory -- NetBox inventory source
 .. Collection note
 
 .. note::
-    This inventory plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This inventory plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.
@@ -1296,7 +1296,7 @@ Parameters
       .. raw:: html
 
         </div>
-
+    
   * - .. raw:: html
 
         <div class="ansible-option-indent"></div><div class="ansible-option-cell">
@@ -1701,23 +1701,25 @@ Parameters
   * - .. raw:: html
 
         <div class="ansible-option-cell">
-        <div class="ansibleOptionAnchor" id="parameter-plurals"></div>
+        <div class="ansibleOptionAnchor" id="parameter-oob_ip_as_primary_ip"></div>
 
-      .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-plurals:
+      .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-oob_ip_as_primary_ip:
 
       .. rst-class:: ansible-option-title
 
       **oob_ip_as_primary_ip**
 
       .. raw:: html
 
-        <a class="ansibleOptionLink" href="#parameter-plurals" title="Permalink to this option"></a>
+        <a class="ansibleOptionLink" href="#parameter-oob_ip_as_primary_ip" title="Permalink to this option"></a>
 
       .. ansible-option-type-line::
 
         :ansible-option-type:`boolean`
 
 
+
+
       .. raw:: html
 
         </div>
@@ -1726,19 +1728,21 @@ Parameters
 
         <div class="ansible-option-cell">
 
-      If True, `ansible_host` will be set to the out of band ip address if defined, else it will use the `primary_ip`.
+      Use out of band IP as \`ansible host\`
+
 
       .. rst-class:: ansible-option-line
 
       :ansible-option-choices:`Choices:`
 
-      - :ansible-option-choices-entry:`false` :ansible-option-choices-default-mark:`← (default)`
-      - :ansible-option-choices-entry-default:`true`
+      - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+      - :ansible-option-choices-entry:`true`
 
 
       .. raw:: html
 
         </div>
+
   * - .. raw:: html
 
         <div class="ansible-option-cell">
@@ -2365,6 +2369,54 @@ Parameters
       - :ansible-option-choices-entry:`true`
 
 
+      .. raw:: html
+
+        </div>
+
+  * - .. raw:: html
+
+        <div class="ansible-option-cell">
+        <div class="ansibleOptionAnchor" id="parameter-virtual_disks"></div>
+
+      .. _ansible_collections.netbox.netbox.nb_inventory_inventory__parameter-virtual_disks:
+
+      .. rst-class:: ansible-option-title
+
+      **virtual_disks**
+
+      .. raw:: html
+
+        <a class="ansibleOptionLink" href="#parameter-virtual_disks" title="Permalink to this option"></a>
+
+      .. ansible-option-type-line::
+
+        :ansible-option-type:`boolean`
+
+      :ansible-option-versionadded:`added in netbox.netbox 3.18.0`
+
+
+
+
+
+      .. raw:: html
+
+        </div>
+
+    - .. raw:: html
+
+        <div class="ansible-option-cell">
+
+      If True, it adds the virtual disks information in host vars.
+
+
+      .. rst-class:: ansible-option-line
+
+      :ansible-option-choices:`Choices:`
+
+      - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
+      - :ansible-option-choices-entry:`true`
+
+
       .. raw:: html
 
         </div>
@@ -2429,7 +2481,7 @@ Examples
 
 .. code-block:: yaml+jinja
 
-
+    
     # netbox_inventory.yml file in YAML format
     # Example command line: ansible-inventory -v --list -i netbox_inventory.yml
 
@@ -2559,6 +2611,7 @@ Authors
 - Nikhil Singh Baliyan (@nikkytub)
 - Sander Steffann (@steffann)
 - Douglas Heriot (@DouglasHeriot)
+- Thore Knickrehm (@tkn2023)
 
 
 .. hint::

docs/plugins/nb_lookup_lookup.rst

@@ -23,7 +23,7 @@ netbox.netbox.nb_lookup lookup -- Queries and returns elements from NetBox
 .. Collection note
 
 .. note::
-    This lookup plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This lookup plugin is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_aggregate_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_aggregate module -- Creates or removes aggregates from NetB
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_asn_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_asn module -- Create, update or delete ASNs within NetBox
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_cable_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_cable module -- Create, update or delete cables within NetB
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_circuit_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_circuit module -- Create, update or delete circuits within
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_circuit_termination_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_circuit_termination module -- Create, update or delete circ
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_circuit_type_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_circuit_type module -- Create, update or delete circuit typ
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_cluster_group_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_cluster_group module -- Create, update or delete cluster gr
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_cluster_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_cluster module -- Create, update or delete clusters within
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_cluster_type_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_cluster_type module -- Create, update or delete cluster typ
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_config_context_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_config_context module -- Creates, updates or deletes config
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_config_template_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_config_template module -- Creates or removes config templat
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_console_port_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_console_port module -- Create, update or delete console por
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_console_port_template_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_console_port_template module -- Create, update or delete co
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_console_server_port_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_console_server_port module -- Create, update or delete cons
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.

docs/plugins/netbox_console_server_port_template_module.rst

@@ -23,7 +23,7 @@ netbox.netbox.netbox_console_server_port_template module -- Create, update or de
 .. Collection note
 
 .. note::
-    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.17.0).
+    This module is part of the `netbox.netbox collection <https://galaxy.ansible.com/ui/repo/published/netbox/netbox/>`_ (version 3.18.0).
 
     It is not included in ``ansible-core``.
     To check whether it is installed, run :code:`ansible-galaxy collection list`.