feat: begin work on support for tunnel terminations

Author: richbibby

plugins/module_utils/netbox_utils.py

@@ -134,6 +134,7 @@
         "tunnels": {"introduced": "3.7"},
         "tunnel_groups": {"introduced": "3.7"},
         "ipsec_profiles": {"introduced": "3.7"},
+        "tunnel_terminations": {"introduced": "3.7"},
     },
 )
 
@@ -318,6 +319,7 @@
     "tenant_groups": "tenant_groups",
     "termination_a": "interfaces",
     "termination_b": "interfaces",
+    "tunnel": "tunnels",
     "tunnel_group": "tunnel_groups",
     "untagged_vlan": "vlans",
     "virtual_chassis": "virtual_chassis",
@@ -407,6 +409,7 @@
     "tenant_groups": "tenant_group",
     "tunnels": "tunnel",
     "tunnel_groups": "tunnel_group",
+    "tunnel_terminations": "tunnel_termination",
     "virtual_chassis": "virtual_chassis",
     "virtual_machines": "virtual_machine",
     "virtual_disks": "virtual_disk",
@@ -547,6 +550,7 @@
     "termination_b": set(["name", "device", "virtual_machine"]),
     "tunnel": set(["name"]),
     "tunnel_group": set(["slug"]),
+    "tunnel_termination": set([name]),
     "untagged_vlan": set(["group", "name", "site", "vid", "vlan_group", "tenant"]),
     "virtual_chassis": set(["name", "master"]),
     "virtual_machine": set(["name", "cluster"]),

plugins/module_utils/netbox_vpn.py

@@ -19,6 +19,7 @@
 NB_L2VPN_TERMINATIONS = "l2vpn_terminations"
 NB_TUNNELS = "tunnels"
 NB_TUNNEL_GROUPS = "tunnel_groups"
+NB_TUNNEL_TERMINATIONS = "tunnel_terminations"
 
 
 class NetboxVpnModule(NetboxModule):
@@ -34,6 +35,7 @@ def run(self):
         - l2vpn_terminations
         - tunnels
         - tunnel_groups
+        - tunnel_terminations
         """
         # Used to dynamically set key when returning results
         endpoint_name = ENDPOINT_NAME_MAPPING[self.endpoint]

plugins/modules/netbox_tunnel_termination.py

@@ -0,0 +1,170 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2024, Rich Bibby, NetBox Labs (@richbibby)
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+DOCUMENTATION = r"""
+---
+module: netbox_tunnel_termination
+short_description: Create, update or delete Tunnel terminations within NetBox
+description:
+  - Creates, updates or removes tunnel terminations from NetBox
+notes:
+  - Tags should be defined as a YAML list
+  - This should be ran with connection C(local) and hosts C(localhost)
+author:
+  - Rich Bibby, NetBox Labs (@richbibby)
+requirements:
+  - pynetbox
+seealso:
+  - name: Tunnel Termination reference
+    description: NetBox Documentation for Tunnel Termination model.
+    link: https://netboxlabs.com/docs/netbox/en/stable/models/vpn/tunneltermination/
+version_added: '3.20.0'
+extends_documentation_fragment:
+  - netbox.netbox.common
+options:
+  data:
+    type: dict
+    description:
+      - Defines the L2VPN termination configuration
+    suboptions:
+      l2vpn:
+        description:
+          - L2vpn object id
+        required: true
+        type: int
+      assigned_object_type:
+        description:
+          - Assigned object type
+        required: true
+        choices:
+          - dcim.interface
+          - ipam.vlan
+          - virtualization.vminterface
+        type: str
+      assigned_object_id:
+        description:
+          - Assigned object id
+        required: true
+        type: int
+      tags:
+        description:
+          - Any tags that the L2VPN termination may need to be associated with
+        required: false
+        type: list
+        elements: raw
+      custom_fields:
+        description:
+          - Must exist in NetBox
+        required: false
+        type: dict
+    required: true
+"""
+
+EXAMPLES = r"""
+- name: "Test NetBox Tunnel Termination module"
+  connection: local
+  hosts: localhost
+  gather_facts: false
+
+  tasks:
+    - name: Create tunnel termination within NetBox with only required information
+      netbox.netbox.netbox_tunnel_termination:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+        state: present
+
+    - name: Delete tunnel termination within NetBox
+      netbox.netbox.netbox_tunnel_termination:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+        state: absent
+
+    - name: Create tunnel termination with all information
+      netbox.netbox.netbox_tunnel_termination:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+        state: present
+"""
+
+RETURN = r"""
+tunnel termination:
+  description: Serialized object as created or already existent within NetBox
+  returned: success (when I(state=present))
+  type: dict
+msg:
+  description: Message indicating failure or info about what has been achieved
+  returned: always
+  type: str
+"""
+
+from ansible_collections.netbox.netbox.plugins.module_utils.netbox_utils import (
+    NetboxAnsibleModule,
+    NETBOX_ARG_SPEC,
+)
+from ansible_collections.netbox.netbox.plugins.module_utils.netbox_vpn import (
+    NetboxVpnModule,
+    NB_TUNNEL_TERMINATIONS,
+)
+from copy import deepcopy
+
+
+def main():
+    """
+    Main entry point for module execution
+    """
+    argument_spec = deepcopy(NETBOX_ARG_SPEC)
+    argument_spec.update(
+        dict(
+            data=dict(
+                type="dict",
+                required=True,
+                options=dict(
+                    tunnel=dict(required=True, type="str"),
+                    # status=dict(required=False, type="raw"),
+                    # tunnel_group=dict(required=False, type="raw"),
+                    # encapsulation=dict(
+                    #     required=True,
+                    #     type="str",
+                    #     choices=[
+                    #         "ipsec-transport",
+                    #         "ipsec-tunnel",
+                    #         "ip-ip",
+                    #         "gre",
+                    #     ],
+                    # ),
+                    # 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"),
+                ),
+            ),
+        )
+    )
+
+    required_if = [
+        ("state", "present", ["name"]),
+        ("state", "absent", ["name"]),
+    ]
+
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
+
+    netbox_tunnel_termination = NetboxVpnModule(module, NB_TUNNEL_TERMINATIONS)
+    netbox_tunnel_termination.run()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()