Add bridge as an option to netbox_device_interface and netbox_vm_interface (#713)

Author: rodvand

plugins/module_utils/netbox_utils.py

@@ -15,7 +15,6 @@
 from itertools import chain
 
 from ansible.module_utils.common.text.converters import to_text
-
 from ansible.module_utils._text import to_native
 from ansible.module_utils.common.collections import is_iterable
 from ansible.module_utils.basic import AnsibleModule, missing_required_lib, _load_params
@@ -90,7 +89,12 @@
     ],
     secrets=[],
     tenancy=["tenants", "tenant_groups", "contacts", "contact_groups", "contact_roles"],
-    virtualization=["cluster_groups", "cluster_types", "clusters", "virtual_machines"],
+    virtualization=[
+        "cluster_groups",
+        "cluster_types",
+        "clusters",
+        "virtual_machines",
+    ],
     wireless=["wireless_lans", "wireless_lan_groups", "wireless_links"],
 )
 
@@ -160,6 +164,7 @@
 # Specifies keys within data that need to be converted to ID and the endpoint to be used when queried
 CONVERT_TO_ID = {
     "assigned_object": "assigned_object",
+    "bridge": "interfaces",
     "circuit": "circuits",
     "circuit_type": "circuit_types",
     "circuit_termination": "circuit_terminations",
@@ -246,6 +251,7 @@
     "virtual_chassis": "virtual_chassis",
     "virtual_machine": "virtual_machines",
     "virtual_machine_role": "device_roles",
+    "vm_bridge": "interfaces",
     "vlan": "vlans",
     "vlan_group": "vlan_groups",
     "vlan_role": "roles",
@@ -323,6 +329,7 @@
 ALLOWED_QUERY_PARAMS = {
     "aggregate": set(["prefix", "rir"]),
     "assigned_object": set(["name", "device", "virtual_machine"]),
+    "bridge": set(["name", "device"]),
     "circuit": set(["cid"]),
     "circuit_type": set(["slug"]),
     "circuit_termination": set(["circuit", "term_side"]),
@@ -422,6 +429,7 @@
     "untagged_vlan": set(["group", "name", "site", "vid", "vlan_group", "tenant"]),
     "virtual_chassis": set(["name", "master"]),
     "virtual_machine": set(["name", "cluster"]),
+    "vm_bridge": set(["name"]),
     "vlan": set(["group", "name", "site", "tenant", "vid", "vlan_group"]),
     "vlan_group": set(["slug", "site", "scope"]),
     "vrf": set(["name", "tenant"]),
@@ -507,6 +515,7 @@
     "virtual_machine_role": "role",
     "vlan_role": "role",
     "vlan_group": "group",
+    "vm_bridge": "bridge",
     "wireless_lan_group": "group",
 }
 
@@ -851,6 +860,11 @@ def _build_query_params(
             if not child:
                 query_dict["name"] = module_data["parent_vm_interface"]
 
+        elif parent == "vm_bridge" and module_data.get("virtual_machine"):
+            if not child:
+                query_dict["name"] = module_data["vm_bridge"]
+                query_dict["virtual_machine_id"] = module_data["virtual_machine"]
+
         elif parent == "lag":
             if not child:
                 query_dict["name"] = module_data["lag"]
@@ -1090,6 +1104,12 @@ def _find_ids(self, data, user_query_params):
                         query_params = self._build_query_params(
                             k, data, user_query_params
                         )
+                    elif k == "vm_bridge":
+                        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

@@ -8,12 +8,6 @@
 
 __metaclass__ = type
 
-ANSIBLE_METADATA = {
-    "metadata_version": "1.1",
-    "status": ["preview"],
-    "supported_by": "community",
-}
-
 DOCUMENTATION = r"""
 ---
 module: netbox_device_interface
@@ -76,6 +70,12 @@
           - Parent LAG interface will be a member of
         required: false
         type: raw
+      bridge:
+        description:
+          - Bridge the interface will connected to
+        required: false
+        type: raw
+        version_added: "3.6.0" 
       mtu:
         description:
           - The MTU of the interface
@@ -280,6 +280,7 @@ def main():
                     type=dict(required=False, type="str"),
                     enabled=dict(required=False, type="bool"),
                     lag=dict(required=False, type="raw"),
+                    bridge=dict(required=False, type="raw"),
                     mtu=dict(required=False, type="int"),
                     mac_address=dict(required=False, type="str"),
                     mgmt_only=dict(required=False, type="bool"),

plugins/modules/netbox_vm_interface.py

@@ -7,12 +7,6 @@
 
 __metaclass__ = type
 
-ANSIBLE_METADATA = {
-    "metadata_version": "1.1",
-    "status": ["preview"],
-    "supported_by": "community",
-}
-
 DOCUMENTATION = r"""
 ---
 module: netbox_vm_interface
@@ -69,6 +63,12 @@
           - The mode of the interface
         required: false
         type: raw
+      vm_bridge:
+        description:
+          - The bridge the interface is connected to
+        required: false
+        type: raw
+        version_added: "3.6.0"
       parent_vm_interface:
         description:
           - The virtual machine interface's parent interface.
@@ -144,6 +144,25 @@
           mtu: 1600
           mode: Tagged
         state: present
+        
+    - name: Create bridge interface within NetBox
+      netbox_vm_interface:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          virtual_machine: test100
+          name: br1000
+        state: present
+        
+    - name: Connect bridge interface within NetBox
+      netbox_vm_interface:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          virtual_machine: test100
+          name: br1001
+          vm_bridge: br1000                        
+        state: present
 """
 
 RETURN = r"""
@@ -186,6 +205,7 @@ def main():
                     mac_address=dict(required=False, type="str"),
                     description=dict(required=False, type="str"),
                     mode=dict(required=False, type="raw"),
+                    vm_bridge=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"),