Allows the addition of a parent to an interface. (#604)

* This allows the addition of the parent to an interface.

Co-authored-by: Thomas Davis <tdavis@nersc.gov>

Author: ThomasADavis

plugins/module_utils/netbox_utils.py

@@ -177,6 +177,8 @@
     "nat_inside": "ip_addresses",
     "nat_outside": "ip_addresses",
     "platform": "platforms",
+    "parent_interface": "interfaces",
+    "parent_vm_interface": "interfaces",
     "parent_region": "regions",
     "parent_tenant_group": "tenant_groups",
     "power_panel": "power_panels",
@@ -314,6 +316,8 @@
     "manufacturer": set(["slug"]),
     "master": set(["name"]),
     "nat_inside": set(["vrf", "address"]),
+    "parent_interface": set(["name"]),
+    "parent_vm_interface": set(["name"]),
     "parent_region": set(["slug"]),
     "parent_tenant_group": set(["slug"]),
     "platform": set(["slug"]),
@@ -406,6 +410,8 @@
     "circuit_type": "type",
     "cluster_type": "type",
     "cluster_group": "group",
+    "parent_interface": "parent",
+    "parent_vm_interface": "parent",
     "parent_region": "parent",
     "parent_tenant_group": "parent",
     "power_port_template": "power_port",
@@ -733,6 +739,23 @@ def _build_query_params(
             # This is to skip any potential changes using module_data when the user
             # provides user_query_params
             pass
+
+        elif parent == "prefix" and module_data.get("parent"):
+            query_dict.update({"prefix": module_data["parent"]})
+
+        elif parent == "parent_interface" and module_data.get("device"):
+            if not child:
+                query_dict["name"] = module_data.get("parent_interface")
+
+            if isinstance(module_data.get("device"), int):
+                query_dict.update({"device_id": module_data.get("device")})
+            else:
+                query_dict.update({"device": module_data.get("device")})
+
+        elif parent == "parent_vm_interface" and module_data.get("virtual_machine"):
+            if not child:
+                query_dict["name"] = module_data["parent_vm_interface"]
+
         elif parent == "lag":
             if not child:
                 query_dict["name"] = module_data["lag"]
@@ -745,9 +768,6 @@ def _build_query_params(
             else:
                 query_dict.update({"device": module_data["device"]})
 
-        elif parent == "prefix" and module_data.get("parent"):
-            query_dict.update({"prefix": module_data["parent"]})
-
         elif parent == "ip_addresses":
             if isinstance(module_data["device"], int):
                 query_dict.update({"device_id": module_data["device"]})
@@ -937,6 +957,7 @@ def _find_ids(self, data, user_query_params):
                 else:
                     if k in [
                         "lag",
+                        "parent_interface",
                         "rear_port",
                         "rear_port_template",
                         "power_port",
@@ -951,6 +972,12 @@ def _find_ids(self, data, user_query_params):
                                 ENDPOINT_NAME_MAPPING[endpoint], "q"
                             ): search
                         }
+                    elif k == "parent_vm_interface":
+                        nb_app = getattr(self.nb, "virtualization")
+                        nb_endpoint = getattr(nb_app, endpoint)
+                        query_params = self._build_query_params(
+                            k, data, user_query_params
+                        )
                     else:
                         query_params = {QUERY_TYPES.get(k, "q"): search}
                     query_id = self._nb_endpoint_get(nb_endpoint, query_params, k)

plugins/modules/netbox_device_interface.py

@@ -114,6 +114,11 @@
           - The mode of the interface
         required: false
         type: raw
+      parent_interface:
+        description:
+          - the device's parent interface
+        required: false
+        type: raw
       untagged_vlan:
         description:
           - The untagged VLAN to be assigned to interface
@@ -313,6 +318,7 @@ def main():
                     mgmt_only=dict(required=False, type="bool"),
                     description=dict(required=False, type="str"),
                     mode=dict(required=False, type="raw"),
+                    parent_interface=dict(required=False, type="raw"),
                     untagged_vlan=dict(required=False, type="raw"),
                     tagged_vlans=dict(required=False, type="raw"),
                     tags=dict(required=False, type="list", elements="raw"),

plugins/modules/netbox_vm_interface.py

@@ -82,6 +82,11 @@
           - The mode of the interface
         required: false
         type: raw
+      parent_vm_interface:
+        description:
+          - the vm interface's parent interface.
+        required: false
+        type: raw
       untagged_vlan:
         description:
           - The untagged VLAN to be assigned to interface
@@ -208,6 +213,7 @@ def main():
                     mac_address=dict(required=False, type="str"),
                     description=dict(required=False, type="str"),
                     mode=dict(required=False, type="raw"),
+                    parent_vm_interface=dict(required=False, type="raw"),
                     untagged_vlan=dict(required=False, type="raw"),
                     tagged_vlans=dict(required=False, type="raw"),
                     tags=dict(required=False, type="list", elements="raw"),

tests/integration/targets/v2.11/tasks/netbox_device_interface.yml

@@ -311,3 +311,23 @@
       - test_twelve['interface']['name'] == "GigabitEthernet5"
       - test_twelve['interface']['device'] == 1
       - test_twelve['interface']['mark_connected'] == true
+
+- name: "13 - Create a child virtual device GigabitEthernet5."
+  netbox.netbox.netbox_device_interface:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      device: test100
+      name: Child1
+      type: virtual
+      parent_interface: GigabitEthernet5
+  register: test_thirteen
+
+- name: "13- ASSERT"
+  assert:
+    that:
+      - test_thirteen is changed
+      - test_thirteen['msg'] == "interface Child1 created"
+      - test_thirteen['diff']['before']['state'] == 'absent'
+      - test_thirteen['diff']['after']['state'] == 'present'
+      - test_thirteen['interface']['parent'] == test_twelve['interface']['id']

tests/integration/targets/v2.11/tasks/netbox_vm_interface.yml

@@ -157,3 +157,34 @@
       - test_five['interface']['tagged_vlans'] == [2, 3]
       - test_five['interface']['tags'][0] == 4
       - test_five['msg'] == "interface Eth0 updated"
+
+- name: "NETBOX_VM_INTERFACE 6: Create a parent interface"
+  netbox.netbox.netbox_vm_interface:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      virtual_machine: "test100-vm"
+      name: "Eth10"
+    state: present
+  register: test_parent
+
+- name: "NETBOX_VM_INTERFACE 6: Create a child virtual device Eth10."
+  netbox.netbox.netbox_vm_interface:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      virtual_machine: "test100-vm"
+      name: "Child1"
+      parent_vm_interface: "Eth10"
+    state: present
+  register: test_child
+
+- name: "NETBOX_VM_INTERFACE 6: ASSERT"
+  assert:
+    that:
+      - test_child is changed
+      - test_child['msg'] == "interface Child1 created"
+      - test_child['diff']['before']['state'] == 'absent'
+      - test_child['diff']['after']['state'] == 'present'
+      - test_child['interface']['parent'] == test_parent['interface']['id']
+