netbox-map 0.1.0__py3-none-any.whl

netbox_map/__init__.py

@@ -0,0 +1,23 @@
+from netbox.plugins import PluginConfig
+
+
+class MapConfig(PluginConfig):
+    name = 'netbox_map'
+    verbose_name = 'NetBox Map'
+    author = 'Christian Rose'
+    description = 'Interactive floor plan visualization for NetBox sites'
+    version = '0.1.0'
+    base_url = 'map'
+    min_version = '4.5.0'
+    default_settings = {
+        'default_grid_width': 20,
+        'default_grid_height': 20,
+        'default_tile_size': 60,
+    }
+
+    def ready(self):
+        super().ready()
+        from . import signals  # noqa: F401
+
+
+config = MapConfig

netbox_map/api/serializers.py

@@ -0,0 +1,115 @@
+from django.contrib.contenttypes.models import ContentType
+from rest_framework import serializers
+
+from dcim.api.serializers_.sites import SiteSerializer
+from dcim.api.serializers import LocationSerializer
+from netbox.api.fields import ContentTypeField
+from netbox.api.serializers import NetBoxModelSerializer
+from utilities.api import get_serializer_for_model
+from ..models import FloorPlan, FloorPlanTile, LocationCoordinates, MapMarker
+
+
+class FloorPlanSerializer(NetBoxModelSerializer):
+    site = SiteSerializer(nested=True)
+    location = LocationSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+        default=None
+    )
+
+    class Meta:
+        model = FloorPlan
+        fields = [
+            'id', 'url', 'display_url', 'display', 'site', 'location',
+            'name', 'grid_width', 'grid_height', 'tile_size',
+            'background_image', 'description', 'comments',
+            'tags', 'custom_fields', 'created', 'last_updated',
+        ]
+        brief_fields = ('id', 'url', 'display', 'name', 'site')
+
+
+class FloorPlanTileSerializer(NetBoxModelSerializer):
+    floorplan = FloorPlanSerializer(nested=True)
+    assigned_object_type = ContentTypeField(
+        queryset=ContentType.objects.filter(
+            app_label='dcim',
+            model__in=['device', 'rack', 'powerpanel', 'powerfeed'],
+        ),
+        required=False,
+        allow_null=True,
+    )
+    assigned_object = serializers.SerializerMethodField(read_only=True)
+    utilization = serializers.SerializerMethodField(read_only=True)
+
+    class Meta:
+        model = FloorPlanTile
+        fields = [
+            'id', 'url', 'display_url', 'display', 'floorplan',
+            'x_position', 'y_position', 'width', 'height',
+            'assigned_object_type', 'assigned_object_id', 'assigned_object',
+            'label', 'tile_type', 'status', 'orientation',
+            'fov_direction', 'fov_angle', 'fov_distance',
+            'latitude', 'longitude',
+            'utilization',
+            'tags', 'custom_fields', 'created', 'last_updated',
+        ]
+        brief_fields = (
+            'id', 'url', 'display', 'x_position', 'y_position',
+            'label', 'tile_type',
+        )
+
+    def get_assigned_object(self, obj):
+        if obj.assigned_object is not None:
+            serializer = get_serializer_for_model(obj.assigned_object)
+            return serializer(obj.assigned_object, nested=True, context=self.context).data
+        return None
+
+    def get_utilization(self, obj):
+        if obj.assigned_object_type and obj.assigned_object_type.model == 'rack' and obj.assigned_object:
+            return round(obj.assigned_object.get_utilization(), 1)
+        return None
+
+
+class LocationCoordinatesSerializer(NetBoxModelSerializer):
+    location = LocationSerializer(nested=True)
+
+    class Meta:
+        model = LocationCoordinates
+        fields = [
+            'id', 'url', 'display_url', 'display', 'location',
+            'latitude', 'longitude',
+            'tags', 'custom_fields', 'created', 'last_updated',
+        ]
+        brief_fields = ('id', 'url', 'display', 'location', 'latitude', 'longitude')
+
+
+class MapMarkerSerializer(NetBoxModelSerializer):
+    site = SiteSerializer(nested=True, required=False, allow_null=True, default=None)
+    assigned_object_type = ContentTypeField(
+        queryset=ContentType.objects.filter(
+            app_label='dcim',
+            model__in=['device', 'rack', 'powerpanel', 'powerfeed'],
+        ),
+        required=False,
+        allow_null=True,
+    )
+    assigned_object = serializers.SerializerMethodField(read_only=True)
+
+    class Meta:
+        model = MapMarker
+        fields = [
+            'id', 'url', 'display_url', 'display',
+            'latitude', 'longitude', 'label', 'marker_type', 'status',
+            'site', 'fov_direction', 'fov_angle', 'fov_distance',
+            'assigned_object_type', 'assigned_object_id', 'assigned_object',
+            'description',
+            'tags', 'custom_fields', 'created', 'last_updated',
+        ]
+        brief_fields = ('id', 'url', 'display', 'label', 'marker_type', 'latitude', 'longitude')
+
+    def get_assigned_object(self, obj):
+        if obj.assigned_object is not None:
+            serializer = get_serializer_for_model(obj.assigned_object)
+            return serializer(obj.assigned_object, nested=True, context=self.context).data
+        return None

netbox_map/api/urls.py

@@ -0,0 +1,10 @@
+from netbox.api.routers import NetBoxRouter
+from . import views
+
+router = NetBoxRouter()
+router.register('floorplans', views.FloorPlanViewSet)
+router.register('floorplan-tiles', views.FloorPlanTileViewSet)
+router.register('location-coordinates', views.LocationCoordinatesViewSet)
+router.register('map-markers', views.MapMarkerViewSet)
+
+urlpatterns = router.urls

netbox_map/api/views.py

@@ -0,0 +1,30 @@
+from netbox.api.viewsets import NetBoxModelViewSet
+from .. import filtersets
+from ..models import FloorPlan, FloorPlanTile, LocationCoordinates, MapMarker
+from .serializers import (
+    FloorPlanSerializer, FloorPlanTileSerializer, LocationCoordinatesSerializer,
+    MapMarkerSerializer,
+)
+
+
+class FloorPlanViewSet(NetBoxModelViewSet):
+    queryset = FloorPlan.objects.all()
+    serializer_class = FloorPlanSerializer
+    filterset_class = filtersets.FloorPlanFilterSet
+
+
+class FloorPlanTileViewSet(NetBoxModelViewSet):
+    queryset = FloorPlanTile.objects.select_related('floorplan', 'assigned_object_type')
+    serializer_class = FloorPlanTileSerializer
+    filterset_class = filtersets.FloorPlanTileFilterSet
+
+
+class LocationCoordinatesViewSet(NetBoxModelViewSet):
+    queryset = LocationCoordinates.objects.select_related('location__site')
+    serializer_class = LocationCoordinatesSerializer
+
+
+class MapMarkerViewSet(NetBoxModelViewSet):
+    queryset = MapMarker.objects.select_related('site', 'assigned_object_type')
+    serializer_class = MapMarkerSerializer
+    filterset_class = filtersets.MapMarkerFilterSet

netbox_map/choices.py

@@ -0,0 +1,44 @@
+from netbox.choices import ChoiceSet
+from django.utils.translation import gettext_lazy as _
+
+
+class FloorPlanTileTypeChoices(ChoiceSet):
+    TYPE_RACK = 'rack'
+    TYPE_AISLE = 'aisle'
+    TYPE_WALL = 'wall'
+    TYPE_COLUMN = 'column'
+    TYPE_DOOR = 'door'
+    TYPE_COOLING = 'cooling'
+    TYPE_POWER = 'power'
+    TYPE_EMPTY = 'empty'
+    TYPE_RESERVED = 'reserved'
+    TYPE_AP = 'ap'
+    TYPE_CAMERA = 'camera'
+    TYPE_PRINTER = 'printer'
+
+    CHOICES = [
+        (TYPE_RACK, _('Rack'), 'blue'),
+        (TYPE_AISLE, _('Aisle'), 'gray'),
+        (TYPE_WALL, _('Wall'), 'dark'),
+        (TYPE_COLUMN, _('Column'), 'dark'),
+        (TYPE_DOOR, _('Door'), 'teal'),
+        (TYPE_COOLING, _('Cooling'), 'cyan'),
+        (TYPE_POWER, _('Power'), 'yellow'),
+        (TYPE_EMPTY, _('Empty'), 'white'),
+        (TYPE_RESERVED, _('Reserved'), 'orange'),
+        (TYPE_AP, _('Access Point'), 'purple'),
+        (TYPE_CAMERA, _('Camera'), 'red'),
+        (TYPE_PRINTER, _('Printer'), 'orange'),
+    ]
+
+
+class FloorPlanTileStatusChoices(ChoiceSet):
+    STATUS_ACTIVE = 'active'
+    STATUS_PLANNED = 'planned'
+    STATUS_DECOMMISSIONED = 'decommissioned'
+
+    CHOICES = [
+        (STATUS_ACTIVE, _('Active'), 'green'),
+        (STATUS_PLANNED, _('Planned'), 'cyan'),
+        (STATUS_DECOMMISSIONED, _('Decommissioned'), 'red'),
+    ]

netbox_map/filtersets.py

@@ -0,0 +1,90 @@
+import django_filters
+from django.contrib.contenttypes.models import ContentType
+from django.utils.translation import gettext_lazy as _
+
+from dcim.models import Site, Location
+from netbox.filtersets import NetBoxModelFilterSet
+from .models import FloorPlan, FloorPlanTile, MapMarker
+from .choices import FloorPlanTileTypeChoices, FloorPlanTileStatusChoices
+
+
+class FloorPlanFilterSet(NetBoxModelFilterSet):
+    site_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=Site.objects.all(),
+        label=_('Site (ID)'),
+    )
+    site = django_filters.ModelMultipleChoiceFilter(
+        field_name='site__slug',
+        queryset=Site.objects.all(),
+        to_field_name='slug',
+        label=_('Site (slug)'),
+    )
+    location_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=Location.objects.all(),
+        label=_('Location (ID)'),
+    )
+
+    class Meta:
+        model = FloorPlan
+        fields = ['id', 'name']
+
+    def search(self, queryset, name, value):
+        return queryset.filter(name__icontains=value)
+
+
+class FloorPlanTileFilterSet(NetBoxModelFilterSet):
+    floorplan_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=FloorPlan.objects.all(),
+        label=_('Floor Plan (ID)'),
+    )
+    assigned_object_type = django_filters.ModelChoiceFilter(
+        queryset=ContentType.objects.filter(
+            app_label='dcim',
+            model__in=['device', 'rack', 'powerpanel', 'powerfeed'],
+        ),
+        label=_('Object Type'),
+    )
+    tile_type = django_filters.MultipleChoiceFilter(
+        choices=FloorPlanTileTypeChoices,
+        label=_('Tile Type'),
+    )
+    status = django_filters.MultipleChoiceFilter(
+        choices=FloorPlanTileStatusChoices,
+        label=_('Status'),
+    )
+
+    class Meta:
+        model = FloorPlanTile
+        fields = ['id', 'floorplan_id', 'assigned_object_type', 'tile_type', 'status',
+                  'x_position', 'y_position']
+
+    def search(self, queryset, name, value):
+        return queryset.filter(label__icontains=value)
+
+
+class MapMarkerFilterSet(NetBoxModelFilterSet):
+    site_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=Site.objects.all(),
+        label=_('Site (ID)'),
+    )
+    site = django_filters.ModelMultipleChoiceFilter(
+        field_name='site__slug',
+        queryset=Site.objects.all(),
+        to_field_name='slug',
+        label=_('Site (slug)'),
+    )
+    marker_type = django_filters.MultipleChoiceFilter(
+        choices=FloorPlanTileTypeChoices,
+        label=_('Marker Type'),
+    )
+    status = django_filters.MultipleChoiceFilter(
+        choices=FloorPlanTileStatusChoices,
+        label=_('Status'),
+    )
+
+    class Meta:
+        model = MapMarker
+        fields = ['id', 'site_id', 'marker_type', 'status']
+
+    def search(self, queryset, name, value):
+        return queryset.filter(label__icontains=value)