netbox-blade-chassis 0.1.2__tar.gz

netbox_blade_chassis-0.1.2/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 NetBox Blade Chassis contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

netbox_blade_chassis-0.1.2/MANIFEST.in

@@ -0,0 +1,2 @@
+recursive-include netbox_blade_chassis/templates *.html
+recursive-include netbox_blade_chassis/migrations *.py

netbox_blade_chassis-0.1.2/PKG-INFO

@@ -0,0 +1,96 @@
+Metadata-Version: 2.4
+Name: netbox-blade-chassis
+Version: 0.1.2
+Summary: NetBox plugin for blade chassis visualization in rack elevations.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/aredoff/netbox-blade-chassis/
+Project-URL: Bug Tracker, https://github.com/aredoff/netbox-blade-chassis/issues/
+Keywords: netbox,netbox-plugin,blade-chassis
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# NetBox Blade Chassis Plugin
+
+NetBox plugin that renders blade server bays inside chassis devices in rack SVG elevations.
+
+## Features
+
+- Configure bay grid coordinates (`position_x`, `position_y`) on **Device Bay Template** forms or the **Blade Layout** tab on Device Type
+- Empty coordinates: bay is not shown in rack elevation
+- Filled coordinates: bay is rendered as a blade cell with child device hostname
+- Symmetric grid validation on bulk save (Blade Layout tab)
+- Inline rack elevation via plugin SVG endpoint
+- Clickable blade cells linking to child devices
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|----------------|----------------|
+| 4.6            | 0.1.x          |
+
+## Installing
+
+Review [official NetBox plugin documentation](https://docs.netbox.dev/en/stable/plugins/#installing-plugins) for installation instructions.
+
+Install from PyPI. Activate NetBox's virtual environment first:
+
+```bash
+source /opt/netbox/venv/bin/activate
+pip install netbox-blade-chassis
+```
+
+For NetBox Docker, see [using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
+
+Install a development version directly from GitHub:
+
+```bash
+pip install https://github.com/aredoff/netbox-blade-chassis/archive/main.tar.gz
+```
+
+Or add to `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):
+
+```
+https://github.com/aredoff/netbox-blade-chassis/archive/main.tar.gz
+```
+
+Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`, or in netbox-docker `/configuration/plugins.py`:
+
+```python
+PLUGINS = [
+    'netbox_blade_chassis',
+]
+
+PLUGINS_CONFIG = {
+    'netbox_blade_chassis': {},
+}
+```
+
+Apply database migrations and update the search index:
+
+```bash
+cd /opt/netbox/netbox/
+python3 manage.py migrate
+python3 manage.py reindex --lazy
+```
+
+If you use netbox-docker, migrations and index updates are applied automatically when containers start.
+
+### Settings
+
+| Setting | Default | Description |
+|---------|---------|-------------|
+| `enable_inline_elevation` | `True` | Inject inline rack elevation SVG via plugin endpoint |
+
+Example:
+
+```python
+PLUGINS_CONFIG = {
+    'netbox_blade_chassis': {
+        'enable_inline_elevation': True,
+    },
+}
+```

netbox_blade_chassis-0.1.2/README.md

@@ -0,0 +1,81 @@
+# NetBox Blade Chassis Plugin
+
+NetBox plugin that renders blade server bays inside chassis devices in rack SVG elevations.
+
+## Features
+
+- Configure bay grid coordinates (`position_x`, `position_y`) on **Device Bay Template** forms or the **Blade Layout** tab on Device Type
+- Empty coordinates: bay is not shown in rack elevation
+- Filled coordinates: bay is rendered as a blade cell with child device hostname
+- Symmetric grid validation on bulk save (Blade Layout tab)
+- Inline rack elevation via plugin SVG endpoint
+- Clickable blade cells linking to child devices
+
+## Compatibility
+
+| NetBox Version | Plugin Version |
+|----------------|----------------|
+| 4.6            | 0.1.x          |
+
+## Installing
+
+Review [official NetBox plugin documentation](https://docs.netbox.dev/en/stable/plugins/#installing-plugins) for installation instructions.
+
+Install from PyPI. Activate NetBox's virtual environment first:
+
+```bash
+source /opt/netbox/venv/bin/activate
+pip install netbox-blade-chassis
+```
+
+For NetBox Docker, see [using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).
+
+Install a development version directly from GitHub:
+
+```bash
+pip install https://github.com/aredoff/netbox-blade-chassis/archive/main.tar.gz
+```
+
+Or add to `local_requirements.txt` or `plugin_requirements.txt` (netbox-docker):
+
+```
+https://github.com/aredoff/netbox-blade-chassis/archive/main.tar.gz
+```
+
+Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`, or in netbox-docker `/configuration/plugins.py`:
+
+```python
+PLUGINS = [
+    'netbox_blade_chassis',
+]
+
+PLUGINS_CONFIG = {
+    'netbox_blade_chassis': {},
+}
+```
+
+Apply database migrations and update the search index:
+
+```bash
+cd /opt/netbox/netbox/
+python3 manage.py migrate
+python3 manage.py reindex --lazy
+```
+
+If you use netbox-docker, migrations and index updates are applied automatically when containers start.
+
+### Settings
+
+| Setting | Default | Description |
+|---------|---------|-------------|
+| `enable_inline_elevation` | `True` | Inject inline rack elevation SVG via plugin endpoint |
+
+Example:
+
+```python
+PLUGINS_CONFIG = {
+    'netbox_blade_chassis': {
+        'enable_inline_elevation': True,
+    },
+}
+```

netbox_blade_chassis-0.1.2/netbox_blade_chassis/__init__.py

@@ -0,0 +1,24 @@
+from netbox.plugins import PluginConfig
+
+from .version import __version__
+
+
+class NetboxBladeChassisConfig(PluginConfig):
+    name = 'netbox_blade_chassis'
+    verbose_name = 'NetBox Blade Chassis'
+    description = 'Visualize blade server bays inside chassis devices in rack elevations.'
+    version = __version__
+    base_url = 'blade-chassis'
+    min_version = '4.6.0'
+    max_version = '4.7.99'
+
+    default_settings = {
+        'enable_inline_elevation': True,
+    }
+
+    def ready(self):
+        super().ready()
+        from . import views  # noqa: F401 — registers plugin views via decorators
+
+
+config = NetboxBladeChassisConfig

netbox_blade_chassis-0.1.2/netbox_blade_chassis/api/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+
+from netbox_blade_chassis.api import views
+
+app_name = 'netbox_blade_chassis-api'
+
+urlpatterns = [
+    path('racks/<int:pk>/elevation/', views.RackElevationAPIView.as_view(), name='rack-elevation'),
+]

netbox_blade_chassis-0.1.2/netbox_blade_chassis/api/views.py

@@ -0,0 +1,60 @@
+from django.http import HttpResponse
+from django.shortcuts import get_object_or_404
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from dcim.api.serializers_.racks import RackElevationDetailFilterSerializer
+from dcim.api.serializers_.rackunits import RackUnitSerializer
+from dcim.models import Rack
+
+from netbox_blade_chassis.svg.racks import BladeChassisRackElevationSVG
+
+
+class RackElevationAPIView(APIView):
+    queryset = Rack.objects.all()
+
+    def get(self, request, pk):
+        rack = get_object_or_404(Rack.objects.restrict(request.user, 'view'), pk=pk)
+        serializer = RackElevationDetailFilterSerializer(data=request.GET)
+        if not serializer.is_valid():
+            return Response(serializer.errors, 400)
+
+        data = serializer.validated_data
+
+        if data['render'] == 'svg':
+            highlight_params = []
+            for param in request.GET.getlist('highlight'):
+                try:
+                    highlight_params.append(param.split(':', 1))
+                except ValueError:
+                    pass
+
+            drawing = BladeChassisRackElevationSVG(
+                rack,
+                user=request.user,
+                unit_width=data['unit_width'],
+                unit_height=data['unit_height'],
+                legend_width=data['legend_width'],
+                margin_width=data['margin_width'],
+                include_images=data['include_images'],
+                base_url=request.build_absolute_uri('/'),
+                highlight_params=highlight_params,
+            )
+            return HttpResponse(drawing.render(data['face']).tostring(), content_type='image/svg+xml')
+
+        elevation = rack.get_rack_units(
+            face=data['face'],
+            user=request.user,
+            exclude=data['exclude'],
+            expand_devices=data['expand_devices'],
+        )
+
+        if q := data['q']:
+            q = q.lower()
+            elevation = [
+                unit for unit in elevation
+                if q in str(unit['id']) or q in str(unit['name']).lower()
+            ]
+
+        rack_units = RackUnitSerializer(elevation, many=True, context={'request': request})
+        return Response(rack_units.data)

netbox_blade_chassis-0.1.2/netbox_blade_chassis/forms.py

@@ -0,0 +1,111 @@
+from django import forms
+from django.utils.translation import gettext_lazy as _
+
+from dcim.forms.model_forms import DeviceBayTemplateForm as BaseDeviceBayTemplateForm
+from dcim.forms.object_create import ComponentCreateForm
+from utilities.forms.fields import ExpandableNameField
+from utilities.forms.rendering import FieldSet
+
+from netbox_blade_chassis.models import DeviceBayTemplateLayout
+
+
+def _parse_position(value):
+    if value in (None, ''):
+        return None
+    return int(value)
+
+
+def _layout_requested(position_x, position_y):
+    return position_x is not None and position_y is not None
+
+
+class DeviceBayTemplateLayoutBulkForm(forms.ModelForm):
+    position_x = forms.IntegerField(
+        required=False,
+        min_value=0,
+        widget=forms.NumberInput(attrs={'class': 'form-control form-control-sm', 'min': 0}),
+    )
+    position_y = forms.IntegerField(
+        required=False,
+        min_value=0,
+        widget=forms.NumberInput(attrs={'class': 'form-control form-control-sm', 'min': 0}),
+    )
+
+    class Meta:
+        model = DeviceBayTemplateLayout
+        fields = ('position_x', 'position_y')
+
+
+class DeviceBayTemplateForm(BaseDeviceBayTemplateForm):
+    class Meta(BaseDeviceBayTemplateForm.Meta):
+        fields = BaseDeviceBayTemplateForm.Meta.fields
+
+    position_x = forms.IntegerField(
+        label=_('Position X'),
+        min_value=0,
+        required=False,
+        help_text=_(
+            'Horizontal slot index within the row (0-based). Both Position X and Y are required for elevation display.'
+        ),
+    )
+    position_y = forms.IntegerField(
+        label=_('Position Y'),
+        min_value=0,
+        required=False,
+        help_text=_(
+            'Row index within the blade grid (0-based). Both Position X and Y are required for elevation display.'
+        ),
+    )
+
+    fieldsets = (
+        FieldSet('device_type', 'name', 'label', 'enabled', 'description', name=_('Template')),
+        FieldSet('position_x', 'position_y', name=_('Blade Layout')),
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.instance.pk:
+            layout = DeviceBayTemplateLayout.objects.filter(device_bay_template=self.instance).first()
+            if layout:
+                self.fields['position_x'].initial = layout.position_x
+                self.fields['position_y'].initial = layout.position_y
+
+    def save(self, commit=True):
+        instance = super().save(commit)
+        position_x = _parse_position(self.cleaned_data.get('position_x'))
+        position_y = _parse_position(self.cleaned_data.get('position_y'))
+
+        if not _layout_requested(position_x, position_y):
+            DeviceBayTemplateLayout.objects.filter(device_bay_template=instance).delete()
+            return instance
+
+        DeviceBayTemplateLayout.objects.update_or_create(
+            device_bay_template=instance,
+            defaults={
+                'position_x': position_x,
+                'position_y': position_y,
+            },
+        )
+        return instance
+
+
+class DeviceBayTemplateCreateForm(ComponentCreateForm, DeviceBayTemplateForm):
+    position_x = ExpandableNameField(
+        label=_('Position X'),
+        required=False,
+        help_text=_('Alphanumeric ranges are supported. (Must match the number of names being created.)'),
+    )
+    position_y = ExpandableNameField(
+        label=_('Position Y'),
+        required=False,
+        help_text=_('Alphanumeric ranges are supported. (Must match the number of names being created.)'),
+    )
+    replication_fields = ('name', 'label', 'position_x', 'position_y')
+
+    fieldsets = (
+        FieldSet('device_type', 'name', 'label', 'enabled', 'description', name=_('Template')),
+        FieldSet('position_x', 'position_y', name=_('Blade Layout')),
+    )
+
+    class Meta(DeviceBayTemplateForm.Meta):
+        exclude = ('name', 'label', 'position_x', 'position_y')

netbox_blade_chassis-0.1.2/netbox_blade_chassis/layout.py

@@ -0,0 +1,79 @@
+from collections import defaultdict
+from typing import NamedTuple
+
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+
+from dcim.models import Device, DeviceType
+
+from netbox_blade_chassis.models import DeviceBayTemplateLayout
+
+
+class LayoutEntry(NamedTuple):
+    position_x: int
+    position_y: int
+
+
+def get_layout_map(device_type: DeviceType) -> dict[str, LayoutEntry]:
+    layouts = DeviceBayTemplateLayout.objects.filter(
+        device_bay_template__device_type=device_type,
+    ).select_related('device_bay_template')
+
+    return {
+        layout.device_bay_template.name: LayoutEntry(
+            layout.position_x,
+            layout.position_y,
+        )
+        for layout in layouts
+    }
+
+
+def device_has_blade_layout(device_type: DeviceType) -> bool:
+    return DeviceBayTemplateLayout.objects.filter(
+        device_bay_template__device_type=device_type,
+    ).exists()
+
+
+def group_layout_by_row(
+    layout_map: dict[str, LayoutEntry],
+) -> dict[int, list[tuple[int, str]]]:
+    rows: dict[int, list[tuple[int, str]]] = defaultdict(list)
+    for name, entry in layout_map.items():
+        rows[entry.position_y].append((entry.position_x, name))
+    for row in rows.values():
+        row.sort(key=lambda item: item[0])
+    return dict(rows)
+
+
+def get_symmetric_column_count(layout_map: dict[int, list[tuple[int, str]]]) -> int:
+    if not layout_map:
+        return 0
+    return max(max(position_x for position_x, _ in cells) + 1 for cells in layout_map.values())
+
+
+def mirror_column_index(position_x: int, column_count: int) -> int:
+    return column_count - 1 - position_x
+
+
+def validate_grid_symmetry(layout_map: dict[str, LayoutEntry]) -> None:
+    rows: dict[int, set[int]] = defaultdict(set)
+    for entry in layout_map.values():
+        rows[entry.position_y].add(entry.position_x)
+
+    if not rows:
+        return
+
+    row_column_counts = [max(columns) + 1 for columns in rows.values()]
+    if len(set(row_column_counts)) > 1:
+        raise ValidationError(_('All blade rows must have the same number of columns.'))
+
+
+def get_chassis_title(device: Device) -> str:
+    return device.name or device.device_type.model
+
+
+def get_blade_label(device: Device) -> str:
+    name = device.name or str(device.device_type)
+    if '#' in name:
+        return name.split('#', 1)[0]
+    return name