feat: Add netbox_tunnel_group code

Author: richbibby

meta/runtime.yml

@@ -79,6 +79,7 @@ action_groups:
     - netbox_tenant
     - netbox_tenant_group
     - netbox_tunnel
+    - netbox_tunnel_group
     - netbox_virtual_chassis
     - netbox_virtual_machine
     - netbox_vlan

plugins/module_utils/netbox_utils.py

@@ -406,6 +406,7 @@
     "tenants": "tenant",
     "tenant_groups": "tenant_group",
     "tunnels": "tunnel",
+    "tunnel_groups": "tunnel_group",
     "virtual_chassis": "virtual_chassis",
     "virtual_machines": "virtual_machine",
     "virtual_disks": "virtual_disk",
@@ -545,6 +546,7 @@
     "termination_a": set(["name", "device", "virtual_machine"]),
     "termination_b": set(["name", "device", "virtual_machine"]),
     "tunnel": set(["name"]),
+    "tunnel_group": set(["slug"]),
     "untagged_vlan": set(["group", "name", "site", "vid", "vlan_group", "tenant"]),
     "virtual_chassis": set(["name", "master"]),
     "virtual_machine": set(["name", "cluster"]),
@@ -669,6 +671,7 @@
     "tags",
     "tenants",
     "tenant_groups",
+    "tunnel_groups",
     "manufacturers",
     "platforms",
     "providers",

plugins/module_utils/netbox_vpn.py

@@ -18,6 +18,7 @@
 NB_L2VPNS = "l2vpns"
 NB_L2VPN_TERMINATIONS = "l2vpn_terminations"
 NB_TUNNELS = "tunnels"
+NB_TUNNEL_GROUPS = "tunnel_groups"
 
 
 class NetboxVpnModule(NetboxModule):
@@ -32,6 +33,7 @@ def run(self):
         - l2vpns
         - l2vpn_terminations
         - tunnels
+        - tunnel_groups
         """
         # Used to dynamically set key when returning results
         endpoint_name = ENDPOINT_NAME_MAPPING[self.endpoint]

plugins/modules/netbox_tunnel_group.py

@@ -0,0 +1,133 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2024, Rich Bibby (@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_group
+short_description: Create, update or delete tunnel groups within NetBox
+description:
+  - Creates, updates or deletes tunnel groups 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 (@richbibby)
+requirements:
+  - pynetbox
+version_added: '3.20.0'
+extends_documentation_fragment:
+  - netbox.netbox.common
+options:
+  data:
+    required: true
+    type: dict
+    description:
+      - Defines the tunnel group configuration
+    suboptions:
+      name:
+        description:
+          - The name of the tunnel group
+        required: true
+        type: str
+      description:
+        description:
+          - The description of the tunnel group
+        required: false
+        type: str
+      tags:
+        description:
+          - The tags to add/update
+        required: false
+        type: list
+        elements: raw
+      custom_fields:
+        description:
+          - Must exist in NetBox
+        required: false
+        type: dict
+"""
+
+EXAMPLES = r"""
+- name: "Test NetBox Tunnel Group module"
+  connection: local
+  hosts: localhost
+  gather_facts: false
+
+  tasks:
+    - name: Create tunnel group within NetBox with only required information
+      netbox.netbox.netbox_tunnel_group:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: Test Cluster Group
+        state: present
+
+    - name: Delete tunnel group within netbox
+      netbox.netbox.netbox_tunnel_group:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: Test Cluster Group
+        state: absent
+"""
+
+RETURN = r"""
+tunnel_group:
+  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_GROUPS,
+)
+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(
+                    name=dict(required=True, type="str"),
+                    description=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_group = NetboxVpnModule(module, NB_TUNNEL_GROUPS)
+    netbox_tunnel_group.run()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

tests/integration/targets/v3.7/tasks/main.yml

@@ -325,3 +325,12 @@
         - netbox_tunnel
   tags:
     - netbox_tunnel
+
+- name: NETBOX_TUNNEL GROUP TESTS
+  ansible.builtin.include_tasks:
+    file: netbox_tunnel_group.yml
+    apply:
+      tags:
+        - netbox_tunnel_group
+  tags:
+    - netbox_tunnel_group

tests/integration/targets/v3.7/tasks/netbox_tunnel_group.yml

@@ -0,0 +1,81 @@
+---
+##
+##
+### NETBOX_TUNNEL GROUP
+##
+##
+- name: "TUNNEL_GROUP 1: Necessary info creation"
+  netbox.netbox.netbox_tunnel_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    data:
+      name: Test Tunnel Group
+    state: present
+  register: test_one
+
+- name: "TUNNEL_GROUP 1: ASSERT - Necessary info creation"
+  ansible.builtin.assert:
+    that:
+      - test_one is changed
+      - test_one['diff']['before']['state'] == "absent"
+      - test_one['diff']['after']['state'] == "present"
+      - test_one['tunnel_group']['name'] == "Test Tunnel Group"
+      - test_one['tunnel_group']['slug'] == "test-tunnel-group"
+      - test_one['msg'] == "tunnel_group Test Tunnel Group created"
+
+- name: "TUNNEL_GROUP 2: Create duplicate"
+  netbox.netbox.netbox_tunnel_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    data:
+      name: Test Tunnel Group
+    state: present
+  register: test_two
+
+- name: "TUNNEL_GROUP 2: ASSERT - Create duplicate"
+  ansible.builtin.assert:
+    that:
+      - not test_two['changed']
+      - test_two['tunnel_group']['name'] == "Test Tunnel Group"
+      - test_two['tunnel_group']['slug'] == "test-tunnel-group"
+      - test_two['msg'] == "tunnel_group Test Tunnel Group already exists"
+
+- name: "TUNNEL_GROUP 3: Update Existing"
+  netbox.netbox.netbox_tunnel_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    data:
+      name: Test Tunnel Group
+      description: Test Description
+      tags:
+        - Schnozzberry
+    state: present
+  register: test_three
+
+- name: "TUNNEL_GROUP 3: ASSERT - Updated"
+  ansible.builtin.assert:
+    that:
+      - test_three is changed
+      - test_three['diff']['after']['description'] == "Test Description"
+      - test_three['diff']['after']['tags'][0] == 4
+      - test_three['tunnel_group']['name'] == "Test Tunnel Group"
+      - test_three['tunnel_group']['description'] == "Test Description"
+      - test_three['tunnel_group']['tags'][0] == 4
+      - test_three['msg'] == "tunnel_group Test Tunnel Group updated"
+
+- name: "TUNNEL_GROUP 4: Delete"
+  netbox.netbox.netbox_tunnel_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    data:
+      name: Test Tunnel Group
+    state: absent
+  register: test_four
+
+- name: "TUNNEL_GROUP 4: ASSERT - Delete"
+  ansible.builtin.assert:
+    that:
+      - test_four is changed
+      - test_four['diff']['before']['state'] == "present"
+      - test_four['diff']['after']['state'] == "absent"
+      - test_four['msg'] == "tunnel_group Test Tunnel Group deleted"

tests/integration/targets/v4.0/tasks/main.yml

@@ -337,3 +337,12 @@
         - netbox_tunnel
   tags:
     - netbox_tunnel
+
+- name: NETBOX_TUNNEL GROUP TESTS
+  ansible.builtin.include_tasks:
+    file: netbox_tunnel_group.yml
+    apply:
+      tags:
+        - netbox_tunnel_group
+  tags:
+    - netbox_tunnel_group

tests/integration/targets/v4.0/tasks/netbox_tunnel_group.yml

@@ -0,0 +1,81 @@
+---
+##
+##
+### NETBOX_TUNNEL GROUP
+##
+##
+- name: "TUNNEL_GROUP 1: Necessary info creation"
+  netbox.netbox.netbox_tunnel_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    data:
+      name: Test Tunnel Group
+    state: present
+  register: test_one
+
+- name: "TUNNEL_GROUP 1: ASSERT - Necessary info creation"
+  ansible.builtin.assert:
+    that:
+      - test_one is changed
+      - test_one['diff']['before']['state'] == "absent"
+      - test_one['diff']['after']['state'] == "present"
+      - test_one['tunnel_group']['name'] == "Test Tunnel Group"
+      - test_one['tunnel_group']['slug'] == "test-tunnel-group"
+      - test_one['msg'] == "tunnel_group Test Tunnel Group created"
+
+- name: "TUNNEL_GROUP 2: Create duplicate"
+  netbox.netbox.netbox_tunnel_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    data:
+      name: Test Tunnel Group
+    state: present
+  register: test_two
+
+- name: "TUNNEL_GROUP 2: ASSERT - Create duplicate"
+  ansible.builtin.assert:
+    that:
+      - not test_two['changed']
+      - test_two['tunnel_group']['name'] == "Test Tunnel Group"
+      - test_two['tunnel_group']['slug'] == "test-tunnel-group"
+      - test_two['msg'] == "tunnel_group Test Tunnel Group already exists"
+
+- name: "TUNNEL_GROUP 3: Update Existing"
+  netbox.netbox.netbox_tunnel_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    data:
+      name: Test Tunnel Group
+      description: Test Description
+      tags:
+        - Schnozzberry
+    state: present
+  register: test_three
+
+- name: "TUNNEL_GROUP 3: ASSERT - Updated"
+  ansible.builtin.assert:
+    that:
+      - test_three is changed
+      - test_three['diff']['after']['description'] == "Test Description"
+      - test_three['diff']['after']['tags'][0] == 4
+      - test_three['tunnel_group']['name'] == "Test Tunnel Group"
+      - test_three['tunnel_group']['description'] == "Test Description"
+      - test_three['tunnel_group']['tags'][0] == 4
+      - test_three['msg'] == "tunnel_group Test Tunnel Group updated"
+
+- name: "TUNNEL_GROUP 4: Delete"
+  netbox.netbox.netbox_tunnel_group:
+    netbox_url: http://localhost:32768
+    netbox_token: "6bd1da4f7657a0748667f64b5786710383627d9a"
+    data:
+      name: Test Tunnel Group
+    state: absent
+  register: test_four
+
+- name: "TUNNEL_GROUP 4: ASSERT - Delete"
+  ansible.builtin.assert:
+    that:
+      - test_four is changed
+      - test_four['diff']['before']['state'] == "present"
+      - test_four['diff']['after']['state'] == "absent"
+      - test_four['msg'] == "tunnel_group Test Tunnel Group deleted"