Bugfix: Change search type for device_bay/interface_template to devicetype_id (#284)

Author: FragmentedPacket

plugins/module_utils/netbox_utils.py

@@ -665,6 +665,10 @@ def _build_query_params(
                 }
                 query_dict.update(rear_port)
 
+        elif parent == "interface_template" or parent == "device_bay_template":
+            if query_dict.get("device_type"):
+                query_dict["devicetype_id"] = query_dict.pop("device_type")
+
         elif parent == "rear_port_template" and self.endpoint == "front_port_templates":
             if isinstance(module_data.get("rear_port_template"), str):
                 rear_port_template = {

tests/integration/targets/latest/tasks/netbox_cable.yml

@@ -30,7 +30,7 @@
       - test_one['diff']['before']['state'] == "absent"
       - test_one['diff']['after']['state'] == "present"
       - test_one['cable']['termination_a_type'] == "dcim.interface"
-      - test_one['cable']['termination_a_id'] == 23
+      - test_one['cable']['termination_a_id'] == 25
       - test_one['cable']['termination_b_type'] == "dcim.interface"
       - test_one['cable']['termination_b_id'] == 2
       - test_one['msg'] == "cable dcim.interface Ethernet2/2 <> dcim.interface Ethernet2/1 created"
@@ -56,7 +56,7 @@
     that:
       - not test_two['changed']
       - test_two['cable']['termination_a_type'] == "dcim.interface"
-      - test_two['cable']['termination_a_id'] == 23
+      - test_two['cable']['termination_a_id'] == 25
       - test_two['cable']['termination_b_type'] == "dcim.interface"
       - test_two['cable']['termination_b_id'] == 2
       - test_two['msg'] == "cable dcim.interface Ethernet2/2 <> dcim.interface Ethernet2/1 already exists"
@@ -94,7 +94,7 @@
       - test_three['diff']['after']['length'] == 30
       - test_three['diff']['after']['length_unit'] == "m"
       - test_three['cable']['termination_a_type'] == "dcim.interface"
-      - test_three['cable']['termination_a_id'] == 23
+      - test_three['cable']['termination_a_id'] == 25
       - test_three['cable']['termination_b_type'] == "dcim.interface"
       - test_three['cable']['termination_b_id'] == 2
       - test_three['cable']['type'] == "mmf-om4"
@@ -155,4 +155,4 @@
       - test_five['cable']['termination_a_id'] == 1
       - test_five['cable']['termination_b_type'] == "dcim.consoleport"
       - test_five['cable']['termination_b_id'] == 1
-      - test_five['msg'] == "cable dcim.consoleserverport Console Server Port <> dcim.consoleport Console Port created"
+      - test_five['msg'] == "cable dcim.consoleserverport Console Server Port <> dcim.consoleport Console Port created"

tests/integration/targets/latest/tasks/netbox_device_interface.yml

@@ -123,7 +123,7 @@
       - test_five['interface']['enabled'] == false
       - test_five['interface']['type'] == "1000base-t"
       - test_five['interface']['mgmt_only'] == false
-      - test_five['interface']['lag'] == 18
+      - test_five['interface']['lag'] == 20
       - test_five['interface']['mode'] == "access"
       - test_five['interface']['mtu'] == 1600
 
@@ -221,7 +221,7 @@
       - test_eight['interface']['enabled'] == false
       - test_eight['interface']['type'] == "1000base-t"
       - test_eight['interface']['mgmt_only'] == false
-      - test_eight['interface']['lag'] == 18
+      - test_eight['interface']['lag'] == 20
       - test_eight['interface']['mode'] == "access"
       - test_eight['interface']['mtu'] == 1600
 

tests/integration/targets/regression/tasks/main.yml

@@ -103,3 +103,34 @@
           - test_five is changed
           - test_five["diff"]["after"]["tags"] is defined
           - test_five["device"]["tags"] is defined
+
+    - name: "6 - Loop through and add interface templates to different device interface templates - Fixes #282"
+      netbox.netbox.netbox_device_interface_template:
+        netbox_url: "http://localhost:32768"
+        netbox_token: "0123456789abcdef0123456789abcdef01234567"
+        data:
+          name: "SFP+ (10GE)"
+          type: "SFP+ (10GE)"
+          device_type: "{{ item }}"
+      register: test_six
+      loop:
+        - "Cisco Test"
+        - "Arista Test"
+        - "Nexus Child"
+        - "Nexus Parent"
+
+    - name: "6 - Assert device type is correct - Fixes #282"
+      assert:
+        that:
+          - test_six.results[0]["diff"]["before"]["state"] == "absent"
+          - test_six.results[0]["diff"]["after"]["state"] == "present"
+          - test_six.results[0]["interface_template"]["device_type"] == 1
+          - test_six.results[1]["diff"]["before"]["state"] == "absent"
+          - test_six.results[1]["diff"]["after"]["state"] == "present"
+          - test_six.results[1]["interface_template"]["device_type"] == 2
+          - test_six.results[2]["diff"]["before"]["state"] == "absent"
+          - test_six.results[2]["diff"]["after"]["state"] == "present"
+          - test_six.results[2]["interface_template"]["device_type"] == 4
+          - test_six.results[3]["diff"]["before"]["state"] == "absent"
+          - test_six.results[3]["diff"]["after"]["state"] == "present"
+          - test_six.results[3]["interface_template"]["device_type"] == 3

tests/unit/module_utils/test_data/build_query_params_no_child/data.json

@@ -307,6 +307,29 @@
             "slug": "test-tenant-group"
         }
     },
+    {
+        "parent": "interface_template",
+        "module_data": {
+            "device_type": 1,
+            "name": "SFP+ (10GBE)",
+            "type": "SFP+ (10GBE)"
+        },
+        "expected": {
+            "name": "SFP+ (10GBE)",
+            "devicetype_id": 1
+        }
+    },
+    {
+        "parent": "device_bay_template",
+        "module_data": {
+            "name": "Bay 1",
+            "device_type": 1
+        },
+        "expected": {
+            "name": "Bay 1",
+            "devicetype_id": 1
+        }
+    },
     {
         "parent": "virtual_machine",
         "module_data": {
@@ -318,4 +341,4 @@
             "cluster_id": 1
         }
     }
-]
+]