Add module netbox_service_template (#908)

* Add module service template
* Add status to wireless LAN
* Add tests for netbox_service_template

Author: rodvand

meta/runtime.yml

@@ -65,6 +65,7 @@ action_groups:
     - netbox_rir
     - netbox_route_target
     - netbox_service
+    - netbox_service_template
     - netbox_site
     - netbox_site_group
     - netbox_tag

plugins/module_utils/netbox_ipam.py

@@ -28,6 +28,7 @@
 NB_VLAN_GROUPS = "vlan_groups"
 NB_VRFS = "vrfs"
 NB_SERVICES = "services"
+NB_SERVICE_TEMPLATES = "service_templates"
 NB_L2VPNS = "l2vpns"
 NB_L2VPN_TERMINATIONS = "l2vpn_terminations"
 

plugins/module_utils/netbox_utils.py

@@ -93,6 +93,7 @@
         "rirs",
         "roles",
         "route_targets",
+        "service_templates",
         "vlans",
         "vlan_groups",
         "vrfs",
@@ -161,6 +162,7 @@
     region="slug",
     rir="slug",
     route_targets="name",
+    service_templates="name",
     slug="slug",
     site="slug",
     site_group="slug",
@@ -256,6 +258,7 @@
     # Just a placeholder as scope can be several different types including sites.
     "scope": "sites",
     "services": "services",
+    "service_templates": "service_templates",
     "site": "sites",
     "site_groups": "site_groups",
     "site_group": "site_groups",
@@ -337,6 +340,7 @@
     "rirs": "rir",
     "roles": "role",
     "route_targets": "route_target",
+    "service_templates": "service_template",
     "services": "services",
     "sites": "site",
     "site_groups": "site_group",
@@ -456,6 +460,7 @@
     "role": set(["slug"]),
     "route_target": set(["name"]),
     "services": set(["device", "virtual_machine", "name", "port", "protocol"]),
+    "service_template": set(["name"]),
     "site": set(["slug", "name"]),
     "site_group": set(["slug"]),
     "tags": set(["slug"]),

plugins/modules/netbox_service_template.py

@@ -0,0 +1,182 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2022, Martin Rødvand (@rodvand)
+# 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_service_template
+short_description: Create, update or delete service templates within NetBox
+description:
+  - Creates, updates or removes service templates from NetBox
+notes:
+  - Tags should be defined as a YAML list
+  - This should be ran with connection C(local) and hosts C(localhost)
+author:
+  - Martin Rødvand (@rodvand)
+requirements:
+  - pynetbox
+version_added: '3.10.0'
+extends_documentation_fragment:
+  - netbox.netbox.common
+options:
+  data:
+    type: dict
+    required: true
+    description:
+      - Defines the service template configuration
+    suboptions:
+      name:
+        description:
+          - The name of the service template
+        required: true
+        type: str
+      ports:
+        description:
+          - The ports attached to the service template
+        required: false
+        type: list
+        elements: int
+      protocol:
+        description:
+          - The protocol
+        choices:
+          - tcp
+          - udp
+          - sctp          
+        required: false
+        type: str      
+      description:
+        description:
+          - Description of the service template
+        required: false
+        type: str        
+      comments:
+        description:
+          - Comments
+        required: false
+        type: str        
+      tags:
+        description:
+          - Any tags that the service template may need to be associated with
+        required: false
+        type: list
+        elements: raw
+      custom_fields:
+        description:
+          - Must exist in NetBox and in key/value format
+        required: false
+        type: dict
+"""
+
+EXAMPLES = r"""
+- name: "Test NetBox modules"
+  connection: local
+  hosts: localhost
+  gather_facts: False
+
+  tasks:
+    - name: Create service template within NetBox with only required information
+      netbox.netbox.netbox_service_template:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: SSH
+          ports:
+            - 22
+          protocol: tcp
+        state: present
+
+    - name: Update service template with other fields
+      netbox.netbox.netbox_service_template:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: SSH
+          ports:
+            - 22
+          protocol: tcp
+          description: SSH service template
+        state: present
+
+    - name: Delete service template within netbox
+      netbox.netbox.netbox_service_template:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          name: SSH          
+        state: absent
+"""
+
+RETURN = r"""
+service_template:
+  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_ipam import (
+    NetboxIpamModule,
+    NB_SERVICE_TEMPLATES,
+)
+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"),
+                    ports=dict(required=False, type="list", elements="int"),
+                    protocol=dict(
+                        required=False,
+                        choices=[
+                            "tcp",
+                            "udp",
+                            "sctp",
+                        ],
+                        type="str",
+                    ),
+                    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", "ports", "protocol"]),
+        ("state", "absent", ["name"]),
+    ]
+
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
+
+    netbox_service_template = NetboxIpamModule(module, NB_SERVICE_TEMPLATES)
+    netbox_service_template.run()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

plugins/modules/netbox_wireless_lan.py

@@ -43,6 +43,11 @@
           - The wireless LAN group
         required: false
         type: raw
+      status:
+        description:
+          - Status of the wireless LAN
+        required: false
+        type: raw
       vlan:
         description:
           - The VLAN of the Wireless LAN
@@ -167,6 +172,7 @@ def main():
                     ssid=dict(required=True, type="str"),
                     description=dict(required=False, type="str"),
                     wireless_lan_group=dict(required=False, type="raw"),
+                    status=dict(required=False, type="raw"),
                     vlan=dict(required=False, type="raw"),
                     auth_type=dict(
                         required=False,

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

@@ -263,4 +263,13 @@
       tags:
         - netbox_module_type
   tags:
-    - netbox_module_type
+    - netbox_module_type
+
+- name: "NETBOX_SERVICE_TEMPLATE TESTS"
+  include_tasks: 
+    file: "netbox_service_template.yml"
+    apply:
+      tags:
+        - netbox_service_template
+  tags:
+    - netbox_service_template

tests/integration/targets/v3.4/tasks/netbox_service_template.yml

@@ -0,0 +1,115 @@
+---
+##
+##
+### NETBOX_SERVICE_TEMPLATE
+##
+##
+- name: "SERVICE_TEMPLATE 1: Necessary info creation"
+  netbox.netbox.netbox_service_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Service Template for SSH
+      ports:
+        - 22
+      protocol: tcp        
+    state: present
+  register: test_one
+
+- name: "SERVICE_TEMPLATE 1: ASSERT - Necessary info creation"
+  assert:
+    that:
+      - test_one is changed
+      - test_one['diff']['before']['state'] == "absent"
+      - test_one['diff']['after']['state'] == "present"
+      - test_one['service_template']['name'] == "Service Template for SSH"      
+      - test_one['service_template']['ports'] == [22]
+      - test_one['service_template']['protocol'] == "tcp"
+      - test_one['msg'] == "service_template Service Template for SSH created"
+
+- name: "SERVICE_TEMPLATE 2: Create duplicate"
+  netbox.netbox.netbox_service_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Service Template for SSH
+      ports:
+        - 22
+      protocol: tcp
+    state: present
+  register: test_two
+
+- name: "SERVICE_TEMPLATE 2: ASSERT - Create duplicate"
+  assert:
+    that:
+      - not test_two['changed']
+      - test_two['service_template']['name'] == "Service Template for SSH"      
+      - test_two['service_template']['ports'] == [22]
+      - test_two['service_template']['protocol'] == "tcp"
+      - test_two['msg'] == "service_template Service Template for SSH already exists"
+
+- name: "SERVICE_TEMPLATE 3: Update Service Template with other fields"
+  netbox.netbox.netbox_service_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Service Template for SSH
+      ports:
+        - 22
+      protocol: tcp
+      comments: For SSH service
+    state: present
+  register: test_three
+
+- name: "SERVICE_TEMPLATE 3: ASSERT - Update Service Template with other fields"
+  assert:
+    that:
+      - test_three is changed
+      - test_three['diff']['after']['comments'] == "For SSH service"
+      - test_three['service_template']['name'] == "Service Template for SSH"
+      - test_three['service_template']['ports'] == [22]
+      - test_three['service_template']['protocol'] == "tcp"
+      - test_three['service_template']['comments'] == "For SSH service"
+      - test_three['msg'] == "service_template Service Template for SSH updated"
+
+- name: "SERVICE_TEMPLATE 4: Create Service Template for Delete Test"
+  netbox.netbox.netbox_service_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Service Template for DNS
+      ports:
+        - 53
+      protocol: udp
+      comments: Domain Name System
+    state: present
+  register: test_four
+
+- name: "SERVICE_TEMPLATE 4: ASSERT - Create Service Template for Delete Test"
+  assert:
+    that:
+      - test_four is changed
+      - test_four['diff']['before']['state'] == "absent"
+      - test_four['diff']['after']['state'] == "present"
+      - test_four['service_template']['name'] == "Service Template for DNS"
+      - test_four['service_template']['ports'] == [53]
+      - test_four['service_template']['protocol'] == "udp"
+      - test_four['service_template']['comments'] == "Domain Name System"
+      - test_four['msg'] == "service_template Service Template for DNS created"
+
+- name: "SERVICE_TEMPLATE 5: Delete Service Template"
+  netbox.netbox.netbox_service_template:
+    netbox_url: http://localhost:32768
+    netbox_token: 0123456789abcdef0123456789abcdef01234567
+    data:
+      name: Service Template for DNS      
+    state: absent
+  register: test_five
+
+- name: "SERVICE_TEMPLATE 5: ASSERT - Delete Service Template"
+  assert:
+    that:
+      - test_five is changed
+      - test_five['diff']['before']['state'] == "present"
+      - test_five['diff']['after']['state'] == "absent"
+      - test_five['msg'] == "service_template Service Template for DNS deleted"