1
0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Files
netbox-community-netbox/netbox/dcim/api/views.py

777 lines
27 KiB
Python
Raw Normal View History

import socket
2017-07-14 16:07:28 -04:00
from collections import OrderedDict
2017-05-24 11:33:11 -04:00
from django.http import Http404, HttpResponse, HttpResponseForbidden
from django.shortcuts import get_object_or_404
from drf_yasg import openapi
from drf_yasg.openapi import Parameter
from drf_yasg.utils import swagger_auto_schema
from rest_framework.decorators import action
2016-03-01 11:23:03 -05:00
from rest_framework.response import Response
from rest_framework.routers import APIRootView
from rest_framework.viewsets import ViewSet
2016-03-01 11:23:03 -05:00
from circuits.models import Circuit
2021-04-29 16:38:56 -04:00
from dcim import filtersets
from dcim.models import *
from extras.api.views import ConfigContextQuerySetMixin
2021-12-21 11:53:31 -05:00
from ipam.models import Prefix, VLAN
from netbox.api.authentication import IsAuthenticatedOrLoginNotRequired
from netbox.api.exceptions import ServiceUnavailable
from netbox.api.metadata import ContentTypeMetadata
from netbox.api.pagination import StripCountAnnotationsPaginator
2022-03-09 11:09:06 -05:00
from netbox.api.viewsets import NetBoxModelViewSet
2021-10-26 13:41:56 -04:00
from netbox.config import get_config
from utilities.api import get_serializer_for_model
2021-12-21 11:53:31 -05:00
from utilities.utils import count_related
from virtualization.models import VirtualMachine
2016-08-22 13:20:30 -04:00
from . import serializers
from .exceptions import MissingFilterException
2016-03-01 11:23:03 -05:00
class DCIMRootView(APIRootView):
"""
DCIM API root view
"""
def get_view_name(self):
return 'DCIM'
# Mixins
2020-10-02 14:54:16 -04:00
class PathEndpointMixin(object):
@action(detail=True, url_path='trace')
def trace(self, request, pk):
"""
Trace a complete cable path and return each segment as a three-tuple of (termination, cable, termination).
"""
2020-06-29 14:41:43 -04:00
obj = get_object_or_404(self.queryset, pk=pk)
# Initialize the path array
path = []
if request.GET.get('render', None) == 'svg':
# Render SVG
try:
width = min(int(request.GET.get('width')), 1600)
except (ValueError, TypeError):
width = None
drawing = obj.get_trace_svg(
base_url=request.build_absolute_uri('/'),
width=width
)
return HttpResponse(drawing.tostring(), content_type='image/svg+xml')
2020-10-02 14:54:16 -04:00
for near_end, cable, far_end in obj.trace():
2020-10-08 14:01:47 -04:00
if near_end is None:
# Split paths
break
# Serialize each object
2022-05-13 16:23:44 -04:00
serializer_a = get_serializer_for_model(near_end[0], prefix='Nested')
x = serializer_a(near_end, many=True, context={'request': request}).data
if cable is not None:
2022-05-13 16:23:44 -04:00
y = serializers.TracedCableSerializer(cable[0], context={'request': request}).data
else:
y = None
if far_end is not None:
2022-05-13 16:23:44 -04:00
serializer_b = get_serializer_for_model(far_end[0], prefix='Nested')
z = serializer_b(far_end, many=True, context={'request': request}).data
else:
z = None
path.append((x, y, z))
return Response(path)
class PassThroughPortMixin(object):
@action(detail=True, url_path='paths')
def paths(self, request, pk):
"""
Return all CablePaths which traverse a given pass-through port.
"""
obj = get_object_or_404(self.queryset, pk=pk)
cablepaths = CablePath.objects.filter(_nodes__contains=obj)
serializer = serializers.CablePathSerializer(cablepaths, context={'request': request}, many=True)
return Response(serializer.data)
2017-02-28 16:10:53 -05:00
#
# Regions
#
class RegionViewSet(NetBoxModelViewSet):
queryset = Region.objects.add_related_count(
Region.objects.all(),
Site,
'region',
'site_count',
cumulative=True
).prefetch_related('tags')
2017-02-28 16:10:53 -05:00
serializer_class = serializers.RegionSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.RegionFilterSet
2017-02-28 16:10:53 -05:00
#
# Site groups
#
class SiteGroupViewSet(NetBoxModelViewSet):
queryset = SiteGroup.objects.add_related_count(
SiteGroup.objects.all(),
Site,
'group',
'site_count',
cumulative=True
).prefetch_related('tags')
serializer_class = serializers.SiteGroupSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.SiteGroupFilterSet
2016-03-01 11:23:03 -05:00
#
# Sites
#
class SiteViewSet(NetBoxModelViewSet):
queryset = Site.objects.prefetch_related(
'region', 'tenant', 'asns', 'tags'
).annotate(
device_count=count_related(Device, 'site'),
rack_count=count_related(Rack, 'site'),
prefix_count=count_related(Prefix, 'site'),
vlan_count=count_related(VLAN, 'site'),
circuit_count=count_related(Circuit, 'terminations__site'),
virtualmachine_count=count_related(VirtualMachine, 'cluster__site')
)
2016-05-18 16:02:53 -04:00
serializer_class = serializers.SiteSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.SiteFilterSet
2016-03-01 11:23:03 -05:00
#
# Locations
2016-03-01 11:23:03 -05:00
#
class LocationViewSet(NetBoxModelViewSet):
queryset = Location.objects.add_related_count(
2021-04-05 11:04:12 -04:00
Location.objects.add_related_count(
Location.objects.all(),
Device,
'location',
'device_count',
cumulative=True
),
Rack,
'location',
'rack_count',
cumulative=True
).prefetch_related('site', 'tags')
serializer_class = serializers.LocationSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.LocationFilterSet
2016-03-01 11:23:03 -05:00
2016-08-10 11:52:27 -04:00
#
# Rack roles
#
class RackRoleViewSet(NetBoxModelViewSet):
queryset = RackRole.objects.prefetch_related('tags').annotate(
rack_count=count_related(Rack, 'role')
)
2016-08-10 11:52:27 -04:00
serializer_class = serializers.RackRoleSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.RackRoleFilterSet
2016-08-10 11:52:27 -04:00
2016-03-01 11:23:03 -05:00
#
# Racks
#
class RackViewSet(NetBoxModelViewSet):
queryset = Rack.objects.prefetch_related(
2021-04-05 11:04:12 -04:00
'site', 'location', 'role', 'tenant', 'tags'
).annotate(
device_count=count_related(Device, 'rack'),
powerfeed_count=count_related(PowerFeed, 'rack')
)
serializer_class = serializers.RackSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.RackFilterSet
2016-03-01 11:23:03 -05:00
2019-12-11 09:45:08 -05:00
@swagger_auto_schema(
responses={200: serializers.RackUnitSerializer(many=True)},
query_serializer=serializers.RackElevationDetailFilterSerializer
)
2019-12-10 03:18:10 -05:00
@action(detail=True)
def elevation(self, request, pk=None):
"""
Rack elevation representing the list of rack units. Also supports rendering the elevation as an SVG.
"""
2020-06-29 14:41:43 -04:00
rack = get_object_or_404(self.queryset, pk=pk)
2019-12-11 09:45:08 -05:00
serializer = serializers.RackElevationDetailFilterSerializer(data=request.GET)
if not serializer.is_valid():
return Response(serializer.errors, 400)
data = serializer.validated_data
if data['render'] == 'svg':
# Determine attributes for highlighting devices (if any)
highlight_params = []
for param in request.GET.getlist('highlight'):
try:
highlight_params.append(param.split(':', 1))
except ValueError:
pass
2019-12-11 13:39:10 -05:00
# Render and return the elevation as an SVG drawing with the correct content type
drawing = rack.get_elevation_svg(
face=data['face'],
user=request.user,
unit_width=data['unit_width'],
unit_height=data['unit_height'],
legend_width=data['legend_width'],
include_images=data['include_images'],
base_url=request.build_absolute_uri('/'),
highlight_params=highlight_params
)
2019-12-10 03:18:10 -05:00
return HttpResponse(drawing.tostring(), content_type='image/svg+xml')
else:
2019-12-11 13:39:10 -05:00
# Return a JSON representation of the rack units in the elevation
2019-12-11 09:45:08 -05:00
elevation = rack.get_rack_units(
face=data['face'],
user=request.user,
2019-12-11 09:45:08 -05:00
exclude=data['exclude'],
expand_devices=data['expand_devices']
)
2019-11-20 18:27:04 +01:00
# Enable filtering rack units by ID
q = data['q']
if q:
elevation = [u for u in elevation if q in str(u['id']) or q in str(u['name'])]
2019-12-10 03:18:10 -05:00
page = self.paginate_queryset(elevation)
if page is not None:
rack_units = serializers.RackUnitSerializer(page, many=True, context={'request': request})
return self.get_paginated_response(rack_units.data)
#
# Rack reservations
#
2022-03-09 11:09:06 -05:00
class RackReservationViewSet(NetBoxModelViewSet):
queryset = RackReservation.objects.prefetch_related('rack', 'user', 'tenant')
serializer_class = serializers.RackReservationSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.RackReservationFilterSet
2016-03-01 11:23:03 -05:00
#
# Manufacturers
#
class ManufacturerViewSet(NetBoxModelViewSet):
queryset = Manufacturer.objects.prefetch_related('tags').annotate(
devicetype_count=count_related(DeviceType, 'manufacturer'),
inventoryitem_count=count_related(InventoryItem, 'manufacturer'),
platform_count=count_related(Platform, 'manufacturer')
)
2016-05-18 16:02:53 -04:00
serializer_class = serializers.ManufacturerSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.ManufacturerFilterSet
2016-03-01 11:23:03 -05:00
#
2021-12-17 12:18:37 -05:00
# Device/module types
2016-03-01 11:23:03 -05:00
#
class DeviceTypeViewSet(NetBoxModelViewSet):
queryset = DeviceType.objects.prefetch_related('manufacturer', 'tags').annotate(
device_count=count_related(Device, 'device_type')
)
serializer_class = serializers.DeviceTypeSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.DeviceTypeFilterSet
brief_prefetch_fields = ['manufacturer']
2016-03-01 11:23:03 -05:00
class ModuleTypeViewSet(NetBoxModelViewSet):
2021-12-17 12:18:37 -05:00
queryset = ModuleType.objects.prefetch_related('manufacturer', 'tags').annotate(
# module_count=count_related(Module, 'module_type')
)
serializer_class = serializers.ModuleTypeSerializer
filterset_class = filtersets.ModuleTypeFilterSet
brief_prefetch_fields = ['manufacturer']
2016-03-01 11:23:03 -05:00
#
# Device type components
#
2022-03-09 11:09:06 -05:00
class ConsolePortTemplateViewSet(NetBoxModelViewSet):
queryset = ConsolePortTemplate.objects.prefetch_related('device_type__manufacturer')
serializer_class = serializers.ConsolePortTemplateSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.ConsolePortTemplateFilterSet
2022-03-09 11:09:06 -05:00
class ConsoleServerPortTemplateViewSet(NetBoxModelViewSet):
queryset = ConsoleServerPortTemplate.objects.prefetch_related('device_type__manufacturer')
serializer_class = serializers.ConsoleServerPortTemplateSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.ConsoleServerPortTemplateFilterSet
2022-03-09 11:09:06 -05:00
class PowerPortTemplateViewSet(NetBoxModelViewSet):
queryset = PowerPortTemplate.objects.prefetch_related('device_type__manufacturer')
serializer_class = serializers.PowerPortTemplateSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.PowerPortTemplateFilterSet
2022-03-09 11:09:06 -05:00
class PowerOutletTemplateViewSet(NetBoxModelViewSet):
queryset = PowerOutletTemplate.objects.prefetch_related('device_type__manufacturer')
serializer_class = serializers.PowerOutletTemplateSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.PowerOutletTemplateFilterSet
2022-03-09 11:09:06 -05:00
class InterfaceTemplateViewSet(NetBoxModelViewSet):
queryset = InterfaceTemplate.objects.prefetch_related('device_type__manufacturer')
serializer_class = serializers.InterfaceTemplateSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.InterfaceTemplateFilterSet
2022-03-09 11:09:06 -05:00
class FrontPortTemplateViewSet(NetBoxModelViewSet):
queryset = FrontPortTemplate.objects.prefetch_related('device_type__manufacturer')
serializer_class = serializers.FrontPortTemplateSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.FrontPortTemplateFilterSet
2018-10-03 14:04:16 -04:00
2022-03-09 11:09:06 -05:00
class RearPortTemplateViewSet(NetBoxModelViewSet):
queryset = RearPortTemplate.objects.prefetch_related('device_type__manufacturer')
serializer_class = serializers.RearPortTemplateSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.RearPortTemplateFilterSet
2018-10-03 14:04:16 -04:00
2022-03-09 11:09:06 -05:00
class ModuleBayTemplateViewSet(NetBoxModelViewSet):
queryset = ModuleBayTemplate.objects.prefetch_related('device_type__manufacturer')
serializer_class = serializers.ModuleBayTemplateSerializer
filterset_class = filtersets.ModuleBayTemplateFilterSet
2022-03-09 11:09:06 -05:00
class DeviceBayTemplateViewSet(NetBoxModelViewSet):
queryset = DeviceBayTemplate.objects.prefetch_related('device_type__manufacturer')
serializer_class = serializers.DeviceBayTemplateSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.DeviceBayTemplateFilterSet
2022-03-09 11:09:06 -05:00
class InventoryItemTemplateViewSet(NetBoxModelViewSet):
2021-12-29 15:02:25 -05:00
queryset = InventoryItemTemplate.objects.prefetch_related('device_type__manufacturer', 'role')
serializer_class = serializers.InventoryItemTemplateSerializer
filterset_class = filtersets.InventoryItemTemplateFilterSet
#
# Device roles
2016-03-01 11:23:03 -05:00
#
class DeviceRoleViewSet(NetBoxModelViewSet):
queryset = DeviceRole.objects.prefetch_related('tags').annotate(
device_count=count_related(Device, 'device_role'),
virtualmachine_count=count_related(VirtualMachine, 'role')
)
2016-05-18 16:02:53 -04:00
serializer_class = serializers.DeviceRoleSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.DeviceRoleFilterSet
2016-03-01 11:23:03 -05:00
#
# Platforms
#
class PlatformViewSet(NetBoxModelViewSet):
queryset = Platform.objects.prefetch_related('tags').annotate(
device_count=count_related(Device, 'platform'),
virtualmachine_count=count_related(VirtualMachine, 'platform')
)
2016-05-18 16:02:53 -04:00
serializer_class = serializers.PlatformSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.PlatformFilterSet
2016-03-01 11:23:03 -05:00
#
2021-12-17 16:12:03 -05:00
# Devices/modules
2016-03-01 11:23:03 -05:00
#
class DeviceViewSet(ConfigContextQuerySetMixin, NetBoxModelViewSet):
queryset = Device.objects.prefetch_related(
'device_type__manufacturer', 'device_role', 'tenant', 'platform', 'site', 'location', 'rack', 'parent_bay',
'virtual_chassis__master', 'primary_ip4__nat_outside', 'primary_ip6__nat_outside', 'tags',
2017-01-24 17:12:16 -05:00
)
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.DeviceFilterSet
pagination_class = StripCountAnnotationsPaginator
2016-03-01 11:23:03 -05:00
def get_serializer_class(self):
"""
Select the specific serializer based on the request context.
If the `brief` query param equates to True, return the NestedDeviceSerializer
If the `exclude` query param includes `config_context` as a value, return the DeviceSerializer
Else, return the DeviceWithConfigContextSerializer
"""
2018-10-04 16:20:01 -04:00
request = self.get_serializer_context()['request']
if request.query_params.get('brief', False):
return serializers.NestedDeviceSerializer
elif 'config_context' in request.query_params.get('exclude', []):
return serializers.DeviceSerializer
return serializers.DeviceWithConfigContextSerializer
2018-06-27 16:02:34 -04:00
2020-01-09 16:39:13 +00:00
@swagger_auto_schema(
manual_parameters=[
Parameter(
name='method',
in_='query',
required=True,
type=openapi.TYPE_STRING
)
],
responses={'200': serializers.DeviceNAPALMSerializer}
)
@action(detail=True, url_path='napalm')
2017-07-14 16:07:28 -04:00
def napalm(self, request, pk):
2017-07-14 14:42:56 -04:00
"""
Execute a NAPALM method on a Device
"""
2020-06-29 14:41:43 -04:00
device = get_object_or_404(self.queryset, pk=pk)
2017-07-14 14:42:56 -04:00
if not device.primary_ip:
raise ServiceUnavailable("This device does not have a primary IP address configured.")
if device.platform is None:
raise ServiceUnavailable("No platform is configured for this device.")
if not device.platform.napalm_driver:
raise ServiceUnavailable(f"No NAPALM driver is configured for this device's platform: {device.platform}.")
2017-07-14 14:42:56 -04:00
# Check for primary IP address from NetBox object
if device.primary_ip:
host = str(device.primary_ip.address.ip)
else:
# Raise exception for no IP address and no Name if device.name does not exist
if not device.name:
raise ServiceUnavailable(
"This device does not have a primary IP address or device name to lookup configured."
)
try:
# Attempt to complete a DNS name resolution if no primary_ip is set
host = socket.gethostbyname(device.name)
except socket.gaierror:
# Name lookup failure
raise ServiceUnavailable(
f"Name lookup failure, unable to resolve IP address for {device.name}. Please set Primary IP or "
f"setup name resolution.")
2017-11-08 09:51:37 -05:00
# Check that NAPALM is installed
2017-07-14 14:42:56 -04:00
try:
import napalm
from napalm.base.exceptions import ModuleImportError
except ModuleNotFoundError as e:
if getattr(e, 'name') == 'napalm':
raise ServiceUnavailable("NAPALM is not installed. Please see the documentation for instructions.")
raise e
2017-11-08 09:51:37 -05:00
# Validate the configured driver
2017-07-14 14:42:56 -04:00
try:
driver = napalm.get_network_driver(device.platform.napalm_driver)
except ModuleImportError:
raise ServiceUnavailable("NAPALM driver for platform {} not found: {}.".format(
device.platform, device.platform.napalm_driver
))
# Verify user permission
if not request.user.has_perm('dcim.napalm_read_device'):
2017-07-14 14:42:56 -04:00
return HttpResponseForbidden()
2017-07-14 16:07:28 -04:00
napalm_methods = request.GET.getlist('method')
response = OrderedDict([(m, None) for m in napalm_methods])
2021-10-26 11:53:46 -04:00
2021-10-26 13:41:56 -04:00
config = get_config()
2021-10-26 11:53:46 -04:00
username = config.NAPALM_USERNAME
password = config.NAPALM_PASSWORD
timeout = config.NAPALM_TIMEOUT
optional_args = config.NAPALM_ARGS.copy()
if device.platform.napalm_args is not None:
optional_args.update(device.platform.napalm_args)
2020-01-08 16:01:18 +00:00
# Update NAPALM parameters according to the request headers
for header in request.headers:
if header[:9].lower() != 'x-napalm-':
continue
key = header[9:]
if key.lower() == 'username':
username = request.headers[header]
elif key.lower() == 'password':
password = request.headers[header]
elif key:
2020-01-08 16:01:18 +00:00
optional_args[key.lower()] = request.headers[header]
# Connect to the device
2017-07-14 14:42:56 -04:00
d = driver(
hostname=host,
username=username,
password=password,
2021-10-26 11:53:46 -04:00
timeout=timeout,
optional_args=optional_args
2017-07-14 14:42:56 -04:00
)
try:
d.open()
except Exception as e:
raise ServiceUnavailable("Error connecting to the device at {}: {}".format(host, e))
2017-07-14 14:42:56 -04:00
# Validate and execute each specified NAPALM method
for method in napalm_methods:
if not hasattr(driver, method):
response[method] = {'error': 'Unknown NAPALM method'}
continue
if not method.startswith('get_'):
response[method] = {'error': 'Only get_* NAPALM methods are supported'}
continue
try:
response[method] = getattr(d, method)()
except NotImplementedError:
response[method] = {'error': 'Method {} not implemented for NAPALM driver {}'.format(method, driver)}
except Exception as e:
response[method] = {'error': 'Method {} failed: {}'.format(method, e)}
2017-07-14 16:07:28 -04:00
d.close()
2017-07-14 14:42:56 -04:00
return Response(response)
class ModuleViewSet(NetBoxModelViewSet):
2021-12-17 16:12:03 -05:00
queryset = Module.objects.prefetch_related(
'device', 'module_bay', 'module_type__manufacturer', 'tags',
)
serializer_class = serializers.ModuleSerializer
filterset_class = filtersets.ModuleFilterSet
2016-03-01 11:23:03 -05:00
#
# Device components
2016-03-01 11:23:03 -05:00
#
2022-03-09 11:09:06 -05:00
class ConsolePortViewSet(PathEndpointMixin, NetBoxModelViewSet):
queryset = ConsolePort.objects.prefetch_related(
'device', 'module__module_bay', '_path', 'cable__terminations', 'tags'
)
serializer_class = serializers.ConsolePortSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.ConsolePortFilterSet
brief_prefetch_fields = ['device']
2022-03-09 11:09:06 -05:00
class ConsoleServerPortViewSet(PathEndpointMixin, NetBoxModelViewSet):
queryset = ConsoleServerPort.objects.prefetch_related(
'device', 'module__module_bay', '_path', 'cable__terminations', 'tags'
)
serializer_class = serializers.ConsoleServerPortSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.ConsoleServerPortFilterSet
brief_prefetch_fields = ['device']
2022-03-09 11:09:06 -05:00
class PowerPortViewSet(PathEndpointMixin, NetBoxModelViewSet):
queryset = PowerPort.objects.prefetch_related(
'device', 'module__module_bay', '_path', 'cable__terminations', 'tags'
)
serializer_class = serializers.PowerPortSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.PowerPortFilterSet
brief_prefetch_fields = ['device']
2022-03-09 11:09:06 -05:00
class PowerOutletViewSet(PathEndpointMixin, NetBoxModelViewSet):
queryset = PowerOutlet.objects.prefetch_related(
'device', 'module__module_bay', '_path', 'cable__terminations', 'tags'
)
serializer_class = serializers.PowerOutletSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.PowerOutletFilterSet
brief_prefetch_fields = ['device']
2022-03-09 11:09:06 -05:00
class InterfaceViewSet(PathEndpointMixin, NetBoxModelViewSet):
queryset = Interface.objects.prefetch_related(
'device', 'module__module_bay', 'parent', 'bridge', 'lag', '_path', 'cable__terminations', 'wireless_lans',
'untagged_vlan', 'tagged_vlans', 'vrf', 'ip_addresses', 'fhrp_group_assignments', 'tags'
)
serializer_class = serializers.InterfaceSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.InterfaceFilterSet
brief_prefetch_fields = ['device']
2022-03-09 11:09:06 -05:00
class FrontPortViewSet(PassThroughPortMixin, NetBoxModelViewSet):
queryset = FrontPort.objects.prefetch_related(
'device__device_type__manufacturer', 'module__module_bay', 'rear_port', 'cable__terminations', 'tags'
)
serializer_class = serializers.FrontPortSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.FrontPortFilterSet
brief_prefetch_fields = ['device']
2018-10-03 14:04:16 -04:00
2022-03-09 11:09:06 -05:00
class RearPortViewSet(PassThroughPortMixin, NetBoxModelViewSet):
queryset = RearPort.objects.prefetch_related(
'device__device_type__manufacturer', 'module__module_bay', 'cable__terminations', 'tags'
)
serializer_class = serializers.RearPortSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.RearPortFilterSet
brief_prefetch_fields = ['device']
2018-10-03 14:04:16 -04:00
2022-03-09 11:09:06 -05:00
class ModuleBayViewSet(NetBoxModelViewSet):
queryset = ModuleBay.objects.prefetch_related('tags')
serializer_class = serializers.ModuleBaySerializer
filterset_class = filtersets.ModuleBayFilterSet
brief_prefetch_fields = ['device']
2022-03-09 11:09:06 -05:00
class DeviceBayViewSet(NetBoxModelViewSet):
queryset = DeviceBay.objects.prefetch_related('installed_device', 'tags')
serializer_class = serializers.DeviceBaySerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.DeviceBayFilterSet
brief_prefetch_fields = ['device']
2022-03-09 11:09:06 -05:00
class InventoryItemViewSet(NetBoxModelViewSet):
queryset = InventoryItem.objects.prefetch_related('device', 'manufacturer', 'tags')
serializer_class = serializers.InventoryItemSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.InventoryItemFilterSet
brief_prefetch_fields = ['device']
2017-01-31 12:19:41 -05:00
2016-07-05 13:43:19 -04:00
2021-12-27 10:18:39 -05:00
#
# Device component roles
#
class InventoryItemRoleViewSet(NetBoxModelViewSet):
2021-12-27 10:18:39 -05:00
queryset = InventoryItemRole.objects.prefetch_related('tags').annotate(
inventoryitem_count=count_related(InventoryItem, 'role')
)
serializer_class = serializers.InventoryItemRoleSerializer
filterset_class = filtersets.InventoryItemRoleFilterSet
2018-10-26 12:25:11 -04:00
#
# Cables
#
2022-03-09 11:09:06 -05:00
class CableViewSet(NetBoxModelViewSet):
2022-05-16 15:33:57 -04:00
queryset = Cable.objects.prefetch_related('terminations__termination')
2018-10-26 12:25:11 -04:00
serializer_class = serializers.CableSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.CableFilterSet
2018-10-26 12:25:11 -04:00
class CableTerminationViewSet(NetBoxModelViewSet):
metadata_class = ContentTypeMetadata
queryset = CableTermination.objects.prefetch_related('cable', 'termination')
serializer_class = serializers.CableTerminationSerializer
filterset_class = filtersets.CableTerminationFilterSet
#
# Virtual chassis
#
2022-03-09 11:09:06 -05:00
class VirtualChassisViewSet(NetBoxModelViewSet):
queryset = VirtualChassis.objects.prefetch_related('tags').annotate(
member_count=count_related(Device, 'virtual_chassis')
)
serializer_class = serializers.VirtualChassisSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.VirtualChassisFilterSet
brief_prefetch_fields = ['master']
2019-03-12 11:36:29 -04:00
#
# Power panels
#
2022-03-09 11:09:06 -05:00
class PowerPanelViewSet(NetBoxModelViewSet):
queryset = PowerPanel.objects.prefetch_related(
'site', 'location'
).annotate(
powerfeed_count=count_related(PowerFeed, 'power_panel')
)
2019-03-12 11:36:29 -04:00
serializer_class = serializers.PowerPanelSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.PowerPanelFilterSet
2019-03-12 11:36:29 -04:00
#
# Power feeds
#
class PowerFeedViewSet(PathEndpointMixin, NetBoxModelViewSet):
queryset = PowerFeed.objects.prefetch_related(
'power_panel', 'rack', '_path', 'cable__terminations', 'tags'
)
2019-03-12 11:36:29 -04:00
serializer_class = serializers.PowerFeedSerializer
2021-04-29 16:38:56 -04:00
filterset_class = filtersets.PowerFeedFilterSet
2019-03-12 11:36:29 -04:00
2016-03-01 11:23:03 -05:00
#
# Miscellaneous
#
class ConnectedDeviceViewSet(ViewSet):
2016-03-01 11:23:03 -05:00
"""
This endpoint allows a user to determine what device (if any) is connected to a given peer device and peer
interface. This is useful in a situation where a device boots with no configuration, but can detect its neighbors
via a protocol such as LLDP. Two query parameters must be included in the request:
2017-01-24 17:12:16 -05:00
* `peer_device`: The name of the peer device
* `peer_interface`: The name of the peer interface
"""
permission_classes = [IsAuthenticatedOrLoginNotRequired]
_device_param = Parameter(
name='peer_device',
in_='query',
description='The name of the peer device',
required=True,
type=openapi.TYPE_STRING
)
_interface_param = Parameter(
name='peer_interface',
in_='query',
description='The name of the peer interface',
required=True,
type=openapi.TYPE_STRING
)
2017-01-24 17:12:16 -05:00
2017-03-20 21:54:01 -04:00
def get_view_name(self):
return "Connected Device Locator"
@swagger_auto_schema(
manual_parameters=[_device_param, _interface_param],
responses={'200': serializers.DeviceSerializer}
)
def list(self, request):
2016-08-22 17:15:20 -04:00
peer_device_name = request.query_params.get(self._device_param.name)
peer_interface_name = request.query_params.get(self._interface_param.name)
if not peer_device_name or not peer_interface_name:
raise MissingFilterException(detail='Request must include "peer_device" and "peer_interface" filters.')
2016-03-01 11:23:03 -05:00
# Determine local endpoint from peer interface's connection
peer_device = get_object_or_404(
Device.objects.restrict(request.user, 'view'),
name=peer_device_name
)
2020-06-29 14:41:43 -04:00
peer_interface = get_object_or_404(
Interface.objects.restrict(request.user, 'view'),
device=peer_device,
2020-06-29 14:41:43 -04:00
name=peer_interface_name
)
2022-05-13 16:23:44 -04:00
endpoints = peer_interface.connected_endpoints
2016-03-01 11:23:03 -05:00
# If an Interface, return the parent device
2022-05-13 16:23:44 -04:00
if endpoints and type(endpoints[0]) is Interface:
device = get_object_or_404(
Device.objects.restrict(request.user, 'view'),
2022-05-13 16:23:44 -04:00
pk=endpoints[0].device_id
)
return Response(serializers.DeviceSerializer(device, context={'request': request}).data)
2016-03-01 11:23:03 -05:00
# Connected endpoint is none or not an Interface
raise Http404