New module: netbox_interface_template (#259)

Author: toerb

README.md

@@ -33,6 +33,7 @@ To keep the code simple, we only officially support the two latest releases of N
 - netbox_device_bay
 - netbox_device_bay_template
 - netbox_device_interface
+- netbox_device_interface_template
 - netbox_device_role
 - netbox_device_type
 - netbox_device

plugins/module_utils/netbox_dcim.py

@@ -30,6 +30,7 @@
 NB_FRONT_PORTS = "front_ports"
 NB_FRONT_PORT_TEMPLATES = "front_port_templates"
 NB_INTERFACES = "interfaces"
+NB_INTERFACE_TEMPLATES = "interface_templates"
 NB_INVENTORY_ITEMS = "inventory_items"
 NB_MANUFACTURERS = "manufacturers"
 NB_PLATFORMS = "platforms"
@@ -71,6 +72,7 @@ def run(self):
         - front_ports
         - front_port_templates
         - interfaces
+        - interface_templates
         - inventory_items
         - manufacturers
         - platforms

plugins/module_utils/netbox_utils.py

@@ -49,6 +49,7 @@
         "front_ports",
         "front_port_templates",
         "interfaces",
+        "interface_templates",
         "inventory_items",
         "manufacturers",
         "platforms",
@@ -150,6 +151,7 @@
     "group": "tenant_groups",
     "installed_device": "devices",
     "interface": "interfaces",
+    "interface_template": "interface_templates",
     "ip_addresses": "ip_addresses",
     "ipaddresses": "ip_addresses",
     "lag": "interfaces",
@@ -210,6 +212,7 @@
     "front_ports": "front_port",
     "front_port_templates": "front_port_template",
     "interfaces": "interface",
+    "interface_templates": "interface_template",
     "inventory_items": "inventory_item",
     "ip_addresses": "ip_address",
     "manufacturers": "manufacturer",
@@ -271,6 +274,7 @@
     "front_port_template": set(["name", "device_type", "rear_port"]),
     "installed_device": set(["name"]),
     "interface": set(["name", "device", "virtual_machine"]),
+    "interface_template": set(["name", "device_type"]),
     "inventory_item": set(["name", "device"]),
     "ip_address": set(["address", "vrf", "interface"]),
     "ip_addresses": set(["address", "vrf", "device", "interface"]),
@@ -342,6 +346,7 @@
     "front_ports": set(["type"]),
     "front_port_templates": set(["type"]),
     "interfaces": set(["form_factor", "mode", "type"]),
+    "interface_templates": set(["type"]),
     "ip_addresses": set(["status", "role"]),
     "prefixes": set(["status"]),
     "power_feeds": set(["status", "type", "supply", "phase"]),

plugins/modules/netbox_device_interface_template.py

@@ -0,0 +1,175 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# © 2020 Nokia
+# Licensed under the GNU General Public License v3.0 only
+# SPDX-License-Identifier: GPL-3.0-only
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+ANSIBLE_METADATA = {
+    "metadata_version": "1.1",
+    "status": ["preview"],
+    "supported_by": "community",
+}
+
+DOCUMENTATION = r"""
+---
+module: netbox_device_interface_template
+short_description: Creates or removes interfaces on devices from Netbox
+description:
+  - Creates or removes interfaces from Netbox
+notes:
+  - Tags should be defined as a YAML list
+  - This should be ran with connection C(local) and hosts C(localhost)
+author:
+  - Tobias Groß (@toerb)
+requirements:
+  - pynetbox
+version_added: "0.2.4"
+options:
+  netbox_url:
+    description:
+      - URL of the Netbox instance resolvable by Ansible control host
+    required: true
+    type: str
+  netbox_token:
+    description:
+      - The token created within Netbox to authorize API access
+    required: true
+    type: str
+  data:
+    description:
+      - Defines the prefix configuration
+    suboptions:
+      device_type:
+        description:
+          - Name of the device the interface template will be associated with (case-sensitive)
+        required: true
+        type: raw
+      name:
+        description:
+          - Name of the interface template to be created
+        required: true
+        type: str
+      type:
+        description:
+          - |
+            Form factor of the interface:
+            ex. 1000Base-T (1GE), Virtual, 10GBASE-T (10GE)
+            This has to be specified exactly as what is found within UI
+        required: true
+        type: str
+      mgmt_only:
+        description:
+          - This interface template is used only for out-of-band management
+        required: false
+        type: bool
+    required: true
+    type: dict
+  state:
+    description:
+      - Use C(present) or C(absent) for adding or removing.
+    choices: [ absent, present ]
+    default: present
+    type: str
+  query_params:
+    description:
+      - This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined
+      - in plugins/module_utils/netbox_utils.py and provides control to users on what may make
+      - an object unique in their environment.
+    required: false
+    type: list
+  validate_certs:
+    description:
+      - |
+        If C(no), SSL certificates will not be validated.
+        This should only be used on personally controlled sites using self-signed certificates.
+    default: true
+    type: raw
+"""
+
+EXAMPLES = r"""
+- name: "Test Netbox interface template module"
+  connection: local
+  hosts: localhost
+  gather_facts: False
+  tasks:
+    - name: Create interface template within Netbox with only required information
+      netbox_device_interface_template:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          device_type: Arista Test
+          name: 10GBASE-T (10GE)
+          type: 10gbase-t
+        state: present
+    - name: Delete interface template within netbox
+      netbox_device_interface_template:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          device_type: Arista Test
+          name: 10GBASE-T (10GE)
+          type: 10gbase-t
+        state: absent
+"""
+
+RETURN = r"""
+interface_template:
+  description: Serialized object as created or already existent within Netbox
+  returned: on creation
+  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_dcim import (
+    NetboxDcimModule,
+    NB_INTERFACE_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(
+                    device_type=dict(required=True, type="raw"),
+                    name=dict(required=True, type="str"),
+                    type=dict(required=True, type="str",),
+                    mgmt_only=dict(required=False, type="bool"),
+                ),
+            ),
+        )
+    )
+
+    required_if = [
+        ("state", "present", ["device_type", "name", "type"]),
+        ("state", "absent", ["device_type", "name", "type"]),
+    ]
+
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
+
+    netbox_device_interface_template = NetboxDcimModule(module, NB_INTERFACE_TEMPLATES)
+    netbox_device_interface_template.run()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

tests/integration/targets/latest/tasks/main.yml

@@ -5,6 +5,9 @@
 - name: "NETBOX_DEVICE_INTERFACE TESTS"
   include_tasks: "netbox_device_interface.yml"
 
+- name: "NETBOX_DEVICE_INTERFACE_TEMPLATE TESTS"
+  include_tasks: "netbox_device_interface_template.yml"
+
 - name: "NETBOX_IP_ADDRESS TESTS"
   include_tasks: "netbox_ip_address.yml"
 

tests/integration/targets/latest/tasks/netbox_device_interface_template.yml

@@ -0,0 +1,109 @@
+---
+##
+##
+### NETBOX_DEVICE_INTERFACE_TEMPLATE
+##
+##
+- name: "1 - Interface with required information"
+  netbox.netbox.netbox_device_interface_template:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      device_type: Arista Test
+      name: 10GBASE-T (10GE)
+      type: 10gbase-t
+  register: test_one
+
+- name: "1 - ASSERT"
+  assert:
+    that:
+      - test_one is changed
+      - test_one['msg'] == "interface_template 10GBASE-T (10GE) created"
+      - test_one['diff']['before']['state'] == 'absent'
+      - test_one['diff']['after']['state'] == 'present'
+      - test_one['interface_template']['name'] == "10GBASE-T (10GE)"
+      - test_one['interface_template']['device_type'] == 2
+      - test_one['interface_template']['type'] == '10gbase-t'
+
+- name: "2 - Update 10GBASE-T (10GE)"
+  netbox.netbox.netbox_device_interface_template:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      device_type: Arista Test
+      name: 10GBASE-T (10GE)
+      type: 10gbase-t
+      mgmt_only: true
+  register: test_two
+
+- name: "2 - ASSERT"
+  assert:
+    that:
+      - test_two is changed
+      - test_two['msg'] == "interface_template 10GBASE-T (10GE) updated"
+      - test_two['diff']['after']['mgmt_only'] == true
+      - test_two['interface_template']['name'] == "10GBASE-T (10GE)"
+      - test_two['interface_template']['device_type'] == 2
+      - test_two['interface_template']['mgmt_only'] == true
+
+- name: "3 - Delete interface template 10GBASE-T (10GE)"
+  netbox.netbox.netbox_device_interface_template:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      device_type: Arista Test
+      name: 10GBASE-T (10GE)
+      type: 10gbase-t
+    state: absent
+  register: test_three
+
+- name: "3 - ASSERT"
+  assert:
+    that:
+      - test_three is changed
+      - test_three['msg'] == "interface_template 10GBASE-T (10GE) deleted"
+      - test_three['diff']['before']['state'] == "present"
+      - test_three['diff']['after']['state'] == "absent"
+
+- name: "4 - Create LAG with several specified options"
+  netbox.netbox.netbox_device_interface_template:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      device_type: Arista Test
+      name: port channel template
+      type: lag
+      mgmt_only: false
+    state: present
+  register: test_four
+
+- name: "4 - ASSERT"
+  assert:
+    that:
+      - test_four is changed
+      - test_four['msg'] == "interface_template port channel template created"
+      - test_four['diff']['before']['state'] == 'absent'
+      - test_four['diff']['after']['state'] == 'present'
+      - test_four['interface_template']['name'] == "port channel template"
+      - test_four['interface_template']['device_type'] == 2
+      - test_four['interface_template']['type'] == "lag"
+      - test_four['interface_template']['mgmt_only'] == false
+
+- name: "5 - Duplicate Interface Template port channel template"
+  netbox.netbox.netbox_device_interface_template:
+    netbox_url: "http://localhost:32768"
+    netbox_token: "0123456789abcdef0123456789abcdef01234567"
+    data:
+      device_type: Arista Test
+      name: port channel template
+      type: lag
+  register: test_five
+
+- name: "5 - ASSERT"
+  assert:
+    that:
+      - not test_five['changed']
+      - test_five['msg'] == "interface_template port channel template already exists"
+      - test_five['interface_template']['name'] == "port channel template"
+      - test_five['interface_template']['device_type'] == 2
+      - test_five['interface_template']['type'] == "lag"