feat: Add support for tunnel groups and IPsec profiles in netbox_utils.py

Author: richbibby

plugins/module_utils/netbox_utils.py

@@ -132,6 +132,8 @@
         "l2vpns": {"introduced": "3.7"},
         "l2vpn_terminations": {"introduced": "3.7"},
         "tunnels": {"introduced": "3.7"},
+        "tunnel_groups": {"introduced": "3.7"},
+        "ipsec_profiles": {"introduced": "3.7"},
     },
 )
 
@@ -258,6 +260,7 @@
     "inventory_item_role": "inventory_item_roles",
     "ip_addresses": "ip_addresses",
     "ipaddresses": "ip_addresses",
+    "ipsec_profile": "ipsec_profiles",
     "location": "locations",
     "lag": "interfaces",
     "manufacturer": "manufacturers",
@@ -314,6 +317,7 @@
     "tenant_groups": "tenant_groups",
     "termination_a": "interfaces",
     "termination_b": "interfaces",
+    "tunnel_group": "tunnel_groups",
     "untagged_vlan": "vlans",
     "virtual_chassis": "virtual_chassis",
     "virtual_machine": "virtual_machines",

plugins/modules/netbox_tunnel.py

@@ -39,53 +39,52 @@
           - Status of the tunnel
         required: false
         type: raw
-        version_added: "3.20.0"
-      slug:
+      tunnel_group:
         description:
-          - The slugified version of the name or custom slug.
-          - This is auto-generated following NetBox rules if not provided
+          - The VLAN group the VLAN will be associated to
         required: false
-        type: str
-      site:
+        type: raw
+      encapsulation:
         description:
-          - Required if I(state=present) and the tunnel does not exist yet
+          - The encapsulation protocol or technique employed to effect the tunnel
         required: false
         type: raw
-      parent_tunnel:
+      ipsec_profile:
         description:
-          - The parent tunnel the tunnel will be associated with
+          - The IPSec Profile employed to negotiate security associations
         required: false
         type: raw
       tenant:
         description:
           - The tenant that the tunnel will be associated with
         required: false
         type: raw
-        version_added: "3.8.0"
-      facility:
+      tunnel_id:
         description:
-          - Data center provider or facility, ex. Equinix NY7
+          - The ID of the tunnel
         required: false
-        type: str
-        version_added: "3.20.0"
+        type: int
       description:
         description:
           - The description of the tunnel
         required: false
         type: str
+      comments:
+        description:
+          - Comments that may include additional information in regards to the tunnel
+        required: false
+        type: str
       tags:
         description:
-          - The tags to add/update
+          - Any tags that the tunnel may need to be associated with
         required: false
         type: list
         elements: raw
-        version_added: "3.6.0"
       custom_fields:
         description:
           - Must exist in NetBox
         required: false
         type: dict
-        version_added: "3.6.0"
     required: true
 """
 
@@ -101,29 +100,35 @@
         netbox_url: http://netbox.local
         netbox_token: thisIsMyToken
         data:
-          name: Test tunnel
-          site: Test Site
+          name: Test Tunnel
+          status: active
+          encapsulation: ipsec-tunnel
         state: present
 
-    - name: Create tunnel within NetBox with a parent tunnel, status and facility
+    - name: Delete tunnel within NetBox
       netbox.netbox.netbox_tunnel:
         netbox_url: http://netbox.local
         netbox_token: thisIsMyToken
         data:
-          name: Child tunnel
-          site: Test Site
-          parent_tunnel: Test tunnel
-          status: planned
-          facility: Test Facility
-        state: present
+          name: Test Tunnel
+        state: absent
 
-    - name: Delete tunnel within NetBox
+    - name: Create tunnel with all information
       netbox.netbox.netbox_tunnel:
         netbox_url: http://netbox.local
         netbox_token: thisIsMyToken
         data:
-          name: Test tunnel
-        state: absent
+          name: Test Tunnel
+          status: planned
+          tunnel_group: Test Tunnel Group
+          encapsulation: ipsec-tunnel
+          ipsec_profile: ipsec-profile
+          description: Test Description
+          tenant: Test Tenant
+          tunnel_id: 200
+          tags:
+            - test
+        state: present
 """
 
 RETURN = r"""
@@ -161,9 +166,13 @@ def main():
                 options=dict(
                     name=dict(required=True, type="str"),
                     status=dict(required=False, type="raw"),
+                    tunnel_group=dict(required=False, type="raw"),
                     encapsulation=dict(required=False, type="raw"),
+                    ipsec_profile=dict(required=False, type="raw"),
                     tenant=dict(required=False, type="raw"),
+                    tunnel_id=dict(required=False, type="int"),
                     description=dict(required=False, type="str"),
+                    comments=dict(required=False, type="str"),
                     tags=dict(required=False, type="list", elements="raw"),
                     custom_fields=dict(required=False, type="dict"),
                 ),