New modules: netbox_cable, netbox_device_bay_template and netbox_virtual_chassis management (#251)

Author: toerb

README.md

@@ -19,6 +19,7 @@ To keep the code simple, we only officially support the two latest releases of N
 ## Existing Modules
 
 - netbox_aggregate
+- netbox_cable
 - netbox_circuit
 - netbox_circuit_termination
 - netbox_circuit_type
@@ -30,6 +31,7 @@ To keep the code simple, we only officially support the two latest releases of N
 - netbox_console_server_port
 - netbox_console_server_port_template
 - netbox_device_bay
+- netbox_device_bay_template
 - netbox_device_interface
 - netbox_device_role
 - netbox_device_type
@@ -60,6 +62,7 @@ To keep the code simple, we only officially support the two latest releases of N
 - netbox_service
 - netbox_tenant_group
 - netbox_tenant
+- netbox_virtual_chassis
 - netbox_virtual_machine
 - netbox_vm_interface
 - netbox_vlan_group

plugins/module_utils/netbox_dcim.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 # Copyright: (c) 2018, Mikhail Yohman (@fragmentedpacket) <mikhail.yohman@gmail.com>
+# Copyright: (c) 2020, Nokia, Tobias Groß (@toerb) <tobias.gross@nokia.com>
 # 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
 
@@ -16,11 +17,13 @@
 )
 
 
+NB_CABLES = "cables"
 NB_CONSOLE_PORTS = "console_ports"
 NB_CONSOLE_PORT_TEMPLATES = "console_port_templates"
 NB_CONSOLE_SERVER_PORTS = "console_server_ports"
 NB_CONSOLE_SERVER_PORT_TEMPLATES = "console_server_port_templates"
 NB_DEVICE_BAYS = "device_bays"
+NB_DEVICE_BAY_TEMPLATES = "device_bay_templates"
 NB_DEVICES = "devices"
 NB_DEVICE_ROLES = "device_roles"
 NB_DEVICE_TYPES = "device_types"
@@ -43,6 +46,7 @@
 NB_REAR_PORT_TEMPLATES = "rear_port_templates"
 NB_REGIONS = "regions"
 NB_SITES = "sites"
+NB_VIRTUAL_CHASSIS = "virtual_chassis"
 
 
 class NetboxDcimModule(NetboxModule):
@@ -54,11 +58,13 @@ def run(self):
         This function should have all necessary code for endpoints within the application
         to create/update/delete the endpoint objects
         Supported endpoints:
+        - cables
         - console_ports
         - console_port_templates
         - console_server_ports
         - console_server_port_templates
         - device_bays
+        - device_bay_templates
         - devices
         - device_roles
         - device_types
@@ -81,6 +87,7 @@ def run(self):
         - rear_ports
         - rear_port_templates
         - regions
+        - virtual_chassis
         """
         # Used to dynamically set key when returning results
         endpoint_name = ENDPOINT_NAME_MAPPING[self.endpoint]
@@ -99,8 +106,31 @@ def run(self):
             name = data["name"]
         elif data.get("model") and not data.get("slug"):
             name = data["model"]
+        elif data.get("master"):
+            name = self.module.params["data"]["master"]
         elif data.get("slug"):
             name = data["slug"]
+        elif endpoint_name == "cable":
+            if self.module.params["data"]["termination_a"].get("name"):
+                termination_a_name = self.module.params["data"]["termination_a"]["name"]
+            elif self.module.params["data"]["termination_a"].get("slug"):
+                termination_a_name = self.module.params["data"]["termination_a"]["slug"]
+            else:
+                termination_a_name = data.get("termination_a_id")
+
+            if self.module.params["data"]["termination_b"].get("name"):
+                termination_b_name = self.module.params["data"]["termination_b"]["name"]
+            elif self.module.params["data"]["termination_b"].get("slug"):
+                termination_b_name = self.module.params["data"]["termination_b"]["slug"]
+            else:
+                termination_b_name = data.get("termination_b_id")
+
+            name = "%s %s <> %s %s" % (
+                data.get("termination_a_type"),
+                termination_a_name,
+                data.get("termination_b_type"),
+                termination_b_name,
+            )
 
         if self.endpoint in SLUG_REQUIRED:
             if not data.get("slug"):
@@ -110,10 +140,28 @@ def run(self):
         if data.get("color"):
             data["color"] = data["color"].lower()
 
-        object_query_params = self._build_query_params(
-            endpoint_name, data, user_query_params
-        )
-        self.nb_object = self._nb_endpoint_get(nb_endpoint, object_query_params, name)
+        if self.endpoint == "cables":
+            cables = [
+                cable
+                for cable in nb_endpoint.all()
+                if cable.termination_a_type == data["termination_a_type"]
+                and cable.termination_a_id == data["termination_a_id"]
+                and cable.termination_b_type == data["termination_b_type"]
+                and cable.termination_b_id == data["termination_b_id"]
+            ]
+            if len(cables) == 0:
+                self.nb_object = None
+            elif len(cables) == 1:
+                self.nb_object = cables[0]
+            else:
+                self._handle_errors(msg="More than one result returned for %s" % (name))
+        else:
+            object_query_params = self._build_query_params(
+                endpoint_name, data, user_query_params
+            )
+            self.nb_object = self._nb_endpoint_get(
+                nb_endpoint, object_query_params, name
+            )
 
         # This is logic to handle interfaces on a VC
         if self.endpoint == "interfaces":

plugins/module_utils/netbox_utils.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 # Copyright: (c) 2018, Mikhail Yohman (@fragmentedpacket) <mikhail.yohman@gmail.com>
 # Copyright: (c) 2018, David Gomez (@amb1s1) <david.gomez@networktocode.com>
+# Copyright: (c) 2020, Nokia, Tobias Groß (@toerb) <tobias.gross@nokia.com>
 # 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
@@ -35,11 +36,13 @@
 API_APPS_ENDPOINTS = dict(
     circuits=["circuits", "circuit_types", "circuit_terminations", "providers"],
     dcim=[
+        "cables",
         "console_ports",
         "console_port_templates",
         "console_server_ports",
         "console_server_port_templates",
         "device_bays",
+        "device_bay_templates",
         "devices",
         "device_roles",
         "device_types",
@@ -62,6 +65,7 @@
         "rear_port_templates",
         "regions",
         "sites",
+        "virtual_chassis",
     ],
     extras=[],
     ipam=[
@@ -124,56 +128,70 @@
 )
 
 # Specifies keys within data that need to be converted to ID and the endpoint to be used when queried
-CONVERT_TO_ID = dict(
-    circuit="circuits",
-    circuit_type="circuit_types",
-    circuit_termination="circuit_terminations",
-    cluster="clusters",
-    cluster_group="cluster_groups",
-    cluster_type="cluster_types",
-    device="devices",
-    device_role="device_roles",
-    device_type="device_types",
-    group="tenant_groups",
-    installed_device="devices",
-    interface="interfaces",
-    ip_addresses="ip_addresses",
-    ipaddresses="ip_addresses",
-    lag="interfaces",
-    manufacturer="manufacturers",
-    nat_inside="ip_addresses",
-    nat_outside="ip_addresses",
-    platform="platforms",
-    parent_region="regions",
-    power_panel="power_panels",
-    power_port="power_ports",
-    prefix_role="roles",
-    primary_ip="ip_addresses",
-    primary_ip4="ip_addresses",
-    primary_ip6="ip_addresses",
-    provider="providers",
-    rack="racks",
-    rack_group="rack_groups",
-    rack_role="rack_roles",
-    region="regions",
-    rear_port="rear_ports",
-    rir="rirs",
-    services="services",
-    site="sites",
-    tagged_vlans="vlans",
-    tenant="tenants",
-    tenant_group="tenant_groups",
-    untagged_vlan="vlans",
-    virtual_machine="virtual_machines",
-    virtual_machine_role="device_roles",
-    vlan="vlans",
-    vlan_group="vlan_groups",
-    vlan_role="roles",
-    vrf="vrfs",
-)
+CONVERT_TO_ID = {
+    "circuit": "circuits",
+    "circuit_type": "circuit_types",
+    "circuit_termination": "circuit_terminations",
+    "circuit.circuittermination": "circuit_terminations",
+    "cluster": "clusters",
+    "cluster_group": "cluster_groups",
+    "cluster_type": "cluster_types",
+    "dcim.consoleport": "console_ports",
+    "dcim.consoleserverport": "console_server_ports",
+    "dcim.frontport": "front_ports",
+    "dcim.interface": "interfaces",
+    "dcim.powerfeed": "power_feeds",
+    "dcim.poweroutlet": "power_outlet",
+    "dcim.powerport": "power_port",
+    "dcim.rearport": "rear_port",
+    "device": "devices",
+    "device_role": "device_roles",
+    "device_type": "device_types",
+    "group": "tenant_groups",
+    "installed_device": "devices",
+    "interface": "interfaces",
+    "ip_addresses": "ip_addresses",
+    "ipaddresses": "ip_addresses",
+    "lag": "interfaces",
+    "manufacturer": "manufacturers",
+    "master": "devices",
+    "nat_inside": "ip_addresses",
+    "nat_outside": "ip_addresses",
+    "platform": "platforms",
+    "parent_region": "regions",
+    "power_panel": "power_panels",
+    "power_port": "power_ports",
+    "prefix_role": "roles",
+    "primary_ip": "ip_addresses",
+    "primary_ip4": "ip_addresses",
+    "primary_ip6": "ip_addresses",
+    "provider": "providers",
+    "rack": "racks",
+    "rack_group": "rack_groups",
+    "rack_role": "rack_roles",
+    "region": "regions",
+    "rear_port": "rear_ports",
+    "rir": "rirs",
+    "services": "services",
+    "site": "sites",
+    "tagged_vlans": "vlans",
+    "tenant": "tenants",
+    "tenant_group": "tenant_groups",
+    "termination_a": "interfaces",
+    "termination_b": "interfaces",
+    "untagged_vlan": "vlans",
+    "virtual_chassis": "virtual_chassis",
+    "virtual_machine": "virtual_machines",
+    "virtual_machine_role": "device_roles",
+    "vlan": "vlans",
+    "vlan_group": "vlan_groups",
+    "vlan_role": "roles",
+    "vrf": "vrfs",
+}
 
 ENDPOINT_NAME_MAPPING = {
     "aggregates": "aggregate",
+    "cables": "cable",
     "circuit_terminations": "circuit_termination",
     "circuit_types": "circuit_type",
     "circuits": "circuit",
@@ -185,6 +203,7 @@
     "console_server_ports": "console_server_port",
     "console_server_port_templates": "console_server_port_template",
     "device_bays": "device_bay",
+    "device_bay_templates": "device_bay_template",
     "devices": "device",
     "device_roles": "device_role",
     "device_types": "device_type",
@@ -215,6 +234,7 @@
     "sites": "site",
     "tenants": "tenant",
     "tenant_groups": "tenant_group",
+    "virtual_chassis": "virtual_chassis",
     "virtual_machines": "virtual_machine",
     "vlans": "vlan",
     "vlan_groups": "vlan_group",
@@ -226,14 +246,24 @@
     "circuit": set(["cid"]),
     "circuit_type": set(["slug"]),
     "circuit_termination": set(["circuit", "term_side"]),
+    "circuit.circuittermination": set(["circuit", "term_side"]),
     "cluster": set(["name", "type"]),
     "cluster_group": set(["slug"]),
     "cluster_type": set(["slug"]),
     "console_port": set(["name", "device"]),
     "console_port_template": set(["name", "device_type"]),
     "console_server_port": set(["name", "device"]),
     "console_server_port_template": set(["name", "device_type"]),
+    "dcim.consoleport": set(["name", "device"]),
+    "dcim.consoleserverport": set(["name", "device"]),
+    "dcim.frontport": set(["name", "device", "rear_port"]),
+    "dcim.interface": set(["name", "device", "virtual_machine"]),
+    "dcim.powerfeed": set(["name", "power_panel"]),
+    "dcim.poweroutlet": set(["name", "device"]),
+    "dcim.powerport": set(["name", "device"]),
+    "dcim.rearport": set(["name", "device"]),
     "device_bay": set(["name", "device"]),
+    "device_bay_template": set(["name", "device_type"]),
     "device": set(["name"]),
     "device_role": set(["slug"]),
     "device_type": set(["slug"]),
@@ -247,6 +277,7 @@
     "ipaddresses": set(["address", "vrf", "device", "interface"]),
     "lag": set(["name"]),
     "manufacturer": set(["slug"]),
+    "master": set(["name"]),
     "nat_inside": set(["vrf", "address"]),
     "parent_region": set(["slug"]),
     "platform": set(["slug"]),
@@ -273,7 +304,10 @@
     "tagged_vlans": set(["name", "site", "vlan_group", "tenant"]),
     "tenant": set(["slug"]),
     "tenant_group": set(["slug"]),
+    "termination_a": set(["name", "device", "virtual_machine"]),
+    "termination_b": set(["name", "device", "virtual_machine"]),
     "untagged_vlan": set(["name", "site", "vlan_group", "tenant"]),
+    "virtual_chassis": set(["master"]),
     "virtual_machine": set(["name", "cluster"]),
     "vlan": set(["name", "site", "tenant", "vlan_group"]),
     "vlan_group": set(["slug", "site"]),
@@ -297,6 +331,7 @@
 )
 
 REQUIRED_ID_FIND = {
+    "cables": set(["status", "type", "length_unit"]),
     "circuits": set(["status"]),
     "console_ports": set(["type"]),
     "console_port_templates": set(["type"]),
@@ -333,6 +368,8 @@
     "rack_group": "group",
     "rack_role": "role",
     "tenant_group": "group",
+    "termination_a": "termination_a_id",
+    "termination_b": "termination_b_id",
     "virtual_machine_role": "role",
     "vlan_role": "role",
     "vlan_group": "group",
@@ -360,7 +397,6 @@
     "vlan_groups",
 }
 
-
 NETBOX_ARG_SPEC = dict(
     netbox_url=dict(type="str", required=True),
     netbox_token=dict(type="str", required=True, no_log=True),
@@ -605,6 +641,9 @@ def _build_query_params(
             else:
                 query_dict.update({"device": module_data["device"]})
 
+        elif parent == "virtual_chassis":
+            query_dict = {"q": self.module.params["data"].get("master")}
+
         query_dict = self._convert_identical_keys(query_dict)
         return query_dict
 
@@ -666,7 +705,12 @@ def _find_ids(self, data, user_query_params):
         """
         for k, v in data.items():
             if k in CONVERT_TO_ID:
-                endpoint = CONVERT_TO_ID[k]
+                if k == "termination_a":
+                    endpoint = CONVERT_TO_ID[data.get("termination_a_type")]
+                elif k == "termination_b":
+                    endpoint = CONVERT_TO_ID[data.get("termination_b_type")]
+                else:
+                    endpoint = CONVERT_TO_ID[k]
                 search = v
                 app = self._find_app(endpoint)
                 nb_app = getattr(self.nb, app)