#769 : Add support for Module/Module Bay

meta/runtime.yml

@@ -50,6 +50,8 @@ action_groups:
     - netbox_l2vpn_termination
     - netbox_location
     - netbox_manufacturer
+    - netbox_module
+    - netbox_module_bay
     - netbox_module_type
     - netbox_platform
     - netbox_power_feed

plugins/module_utils/netbox_dcim.py

@@ -32,6 +32,8 @@
 NB_INVENTORY_ITEM_ROLES = "inventory_item_roles"
 NB_LOCATIONS = "locations"
 NB_MANUFACTURERS = "manufacturers"
+NB_MODULES = "modules"
+NB_MODULE_BAYS = "module_bays"
 NB_MODULE_TYPES = "module_types"
 NB_PLATFORMS = "platforms"
 NB_POWER_FEEDS = "power_feeds"
@@ -91,6 +93,9 @@ def run(self):
         - inventory_item_roles
         - locations
         - manufacturers
+        - modules
+        - module_bays
+        - module_types
         - platforms
         - power_feeds
         - power_outlets
@@ -150,6 +155,38 @@ def run(self):
                 data.get("termination_b_type"),
                 termination_b_name,
             )
+        elif endpoint_name == "module":
+            if isinstance(
+                self.module.params["data"]["device"], dict
+            ) and self.module.params["data"]["device"].get("name"):
+                device_name = self.module.params["data"]["device"]["name"]
+            elif isinstance(
+                self.module.params["data"]["device"], dict
+            ) and self.module.params["data"]["device"].get("slug"):
+                device_name = self.module.params["data"]["device"]["slug"]
+            else:
+                device_name = self.module.params["data"]["device"]
+            if isinstance(
+                self.module.params["data"]["module_bay"], dict
+            ) and self.module.params["data"]["module_bay"].get("name"):
+                module_bay = self.module.params["data"]["module_bay"]["name"]
+            elif isinstance(
+                self.module.params["data"]["module_bay"], dict
+            ) and self.module.params["data"]["module_bay"].get("slug"):
+                module_bay = self.module.params["data"]["module_bay"]["slug"]
+            else:
+                module_bay = self.module.params["data"]["module_bay"]
+            if isinstance(
+                self.module.params["data"]["module_type"], dict
+            ) and self.module.params["data"]["module_bay"].get("model"):
+                module_type = self.module.params["data"]["module_type"]["model"]
+            elif isinstance(
+                self.module.params["data"]["module_type"], dict
+            ) and self.module.params["data"]["module_bay"].get("part_number"):
+                module_type = self.module.params["data"]["module_type"]["part_number"]
+            else:
+                module_type = self.module.params["data"]["module_type"]
+            name = "%s: %s (%s)" % (device_name, module_bay, module_type)
 
         if self.endpoint in SLUG_REQUIRED:
             if not data.get("slug"):

plugins/module_utils/netbox_utils.py

@@ -58,6 +58,8 @@
         "inventory_item_roles": {},
         "locations": {},
         "manufacturers": {},
+        "modules": {},
+        "module_bays": {},
         "module_types": {},
         "platforms": {},
         "power_feeds": {},
@@ -161,6 +163,8 @@
     l2vpn_termination="id",
     location="slug",
     manufacturer="slug",
+    modules="id",
+    module_bays="name",
     module_type="model",
     nat_inside="address",
     nat_outside="address",
@@ -254,6 +258,8 @@
     "lag": "interfaces",
     "manufacturer": "manufacturers",
     "master": "devices",
+    "module": "modules",
+    "module_bay": "module_bays",
     "module_type": "module_types",
     "nat_inside": "ip_addresses",
     "nat_outside": "ip_addresses",
@@ -359,6 +365,8 @@
     "l2vpn_terminations": "l2vpn_termination",
     "locations": "location",
     "manufacturers": "manufacturer",
+    "modules": "module",
+    "module_bays": "module_bay",
     "module_types": "module_type",
     "platforms": "platform",
     "power_feeds": "power_feed",
@@ -477,6 +485,8 @@
     ),
     "lag": set(["name"]),
     "location": set(["name", "slug", "site"]),
+    "module": set(["device", "module_bay", "module_type"]),
+    "module_bay": set(["name"]),
     "module_type": set(["model"]),
     "manufacturer": set(["slug"]),
     "master": set(["name"]),
@@ -1072,6 +1082,13 @@ def _build_query_params(
                     query_key: module_data.get("assigned_object_id"),
                 }
             )
+        elif parent == "module":
+            query_dict.update(
+                {
+                    "module_bay_id": query_dict.pop("module_bay"),
+                    "module_type_id": query_dict.pop("module_type"),
+                }
+            )
         elif "_template" in parent:
             if query_dict.get("device_type"):
                 query_dict["devicetype_id"] = query_dict.pop("device_type")

plugins/modules/netbox_module.py

@@ -0,0 +1,213 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+# Copyright: (c) 2022, Erwan TONNERRE (@etonnerre) <[email protected]>
+# 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_module
+short_description: Create, update or delete module within NetBox
+description:
+  - Creates, updates or removes module from NetBox
+notes:
+  - Tags should be defined as a YAML list
+  - This should be ran with connection C(local) and hosts C(localhost)
+author:
+  - Erwan TONNERRE (@etonnerre)
+requirements:
+  - pynetbox
+version_added: '3.17.0'
+extends_documentation_fragment:
+  - netbox.netbox.common
+options:
+  data:
+    description:
+      - Defines the device type configuration
+    suboptions:
+      device:
+        description:
+          - The device of the module
+        required: True
+        type: raw
+      module_bay:
+        description:
+          - The module bay of the module
+        required: true
+        type: raw
+      module_type:
+        description:
+          - The module type of the module
+        required: true
+        type: raw 
+      status:
+        description:
+          - The status of the module
+        choices:
+          - offline
+          - active
+          - planned
+          - staged
+          - side-to-rear
+          - failed
+          - decommissioning
+        required: false
+        type: str
+      serial:
+        description:
+          - The weight of the device type
+        required: false
+        type: str
+      description:
+        description:
+          - The description of the module
+        required: false
+        type: str  
+      asset_tag:
+        description:
+          - The asset tag of the modyle
+        required: false
+        type: str
+      comments:
+        description:
+          - Comments that may include additional information in regards to the module
+        required: false
+        type: str
+      tags:
+        description:
+          - Any tags that the module 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
+    type: dict
+"""
+
+EXAMPLES = r"""
+- name: "Test NetBox modules"
+  connection: local
+  hosts: localhost
+  gather_facts: False
+
+  tasks:
+    - name: Create module type within NetBox with only required information
+      netbox.netbox.netbox_module:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:          
+          device: C9300-DEMO
+          module_bay: Network Module
+          module_type: C9300-NM-8X
+        state: present
+
+    - name: Create module type within NetBox
+      netbox.netbox.netbox_module:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:          
+          device:
+            name: C9300-DEMO
+            site: EUPARIS
+          module_bay:
+            name: Network Module
+            position: 1
+          module_type:
+            manufacturer: Cisco
+            model: C9300-NM-8X
+        state: present
+
+    - name: Delete module type within netbox
+      netbox.netbox.netbox_module:
+        netbox_url: http://netbox.local
+        netbox_token: thisIsMyToken
+        data:
+          device: C9300-DEMO
+          module_bay: Network Module
+          module_type: C9300-NM-8X
+          asset_tag: 00001
+          serial: XXXNNNNXXXX
+        state: absent
+"""
+
+RETURN = r"""
+module:
+  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_dcim import (
+    NetboxDcimModule,
+    NB_MODULES,
+)
+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=dict(required=True, type="raw"),
+                    module_bay=dict(required=True, type="raw"),
+                    module_type=dict(required=True, type="raw"),
+                    status=dict(
+                        required=False,
+                        type="str",
+                        choices=[
+                            "offline",
+                            "active",
+                            "planned",
+                            "staged",
+                            "side-to-rear",
+                            "failed",
+                            "decommissioning",
+                        ],
+                    ),
+                    serial=dict(required=False, type="str"),
+                    description=dict(required=False, type="str"),
+                    asset_tag=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", ["device", "module_bay", "module_type", "status"]),
+        ("state", "absent", ["device", "module_bay", "module_type"]),
+    ]
+
+    module = NetboxAnsibleModule(
+        argument_spec=argument_spec, supports_check_mode=True, required_if=required_if
+    )
+
+    netbox_device_type = NetboxDcimModule(module, NB_MODULES)
+    netbox_device_type.run()
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()