serializers.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769
  1. from django.contrib.contenttypes.models import ContentType
  2. from drf_yasg.utils import swagger_serializer_method
  3. from rest_framework import serializers
  4. from rest_framework.validators import UniqueTogetherValidator
  5. from taggit_serializer.serializers import TaggitSerializer, TagListSerializerField
  6. from dcim.choices import *
  7. from dcim.constants import *
  8. from dcim.models import (
  9. Cable, ConsolePort, ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate, Device, DeviceBay,
  10. DeviceBayTemplate, DeviceType, DeviceRole, FrontPort, FrontPortTemplate, Interface, InterfaceTemplate,
  11. Manufacturer, InventoryItem, Platform, PowerFeed, PowerOutlet, PowerOutletTemplate, PowerPanel, PowerPort,
  12. PowerPortTemplate, Rack, RackGroup, RackReservation, RackRole, RearPort, RearPortTemplate, Region, Site,
  13. VirtualChassis,
  14. )
  15. from extras.api.customfields import CustomFieldModelSerializer
  16. from ipam.api.nested_serializers import NestedIPAddressSerializer, NestedVLANSerializer
  17. from ipam.models import VLAN
  18. from tenancy.api.nested_serializers import NestedTenantSerializer
  19. from users.api.nested_serializers import NestedUserSerializer
  20. from utilities.api import (
  21. ChoiceField, ContentTypeField, SerializedPKRelatedField, TimeZoneField, ValidatedModelSerializer,
  22. WritableNestedSerializer, get_serializer_for_model,
  23. )
  24. from virtualization.api.nested_serializers import NestedClusterSerializer
  25. from .nested_serializers import *
  26. class ConnectedEndpointSerializer(ValidatedModelSerializer):
  27. connected_endpoint_type = serializers.SerializerMethodField(read_only=True)
  28. connected_endpoint = serializers.SerializerMethodField(read_only=True)
  29. connection_status = ChoiceField(choices=CONNECTION_STATUS_CHOICES, read_only=True)
  30. def get_connected_endpoint_type(self, obj):
  31. if hasattr(obj, 'connected_endpoint') and obj.connected_endpoint is not None:
  32. return '{}.{}'.format(
  33. obj.connected_endpoint._meta.app_label,
  34. obj.connected_endpoint._meta.model_name
  35. )
  36. return None
  37. @swagger_serializer_method(serializer_or_field=serializers.DictField)
  38. def get_connected_endpoint(self, obj):
  39. """
  40. Return the appropriate serializer for the type of connected object.
  41. """
  42. if getattr(obj, 'connected_endpoint', None) is None:
  43. return None
  44. serializer = get_serializer_for_model(obj.connected_endpoint, prefix='Nested')
  45. context = {'request': self.context['request']}
  46. data = serializer(obj.connected_endpoint, context=context).data
  47. return data
  48. #
  49. # Regions/sites
  50. #
  51. class RegionSerializer(serializers.ModelSerializer):
  52. parent = NestedRegionSerializer(required=False, allow_null=True)
  53. site_count = serializers.IntegerField(read_only=True)
  54. class Meta:
  55. model = Region
  56. fields = ['id', 'name', 'slug', 'parent', 'site_count']
  57. class SiteSerializer(TaggitSerializer, CustomFieldModelSerializer):
  58. status = ChoiceField(choices=SiteStatusChoices, required=False)
  59. region = NestedRegionSerializer(required=False, allow_null=True)
  60. tenant = NestedTenantSerializer(required=False, allow_null=True)
  61. time_zone = TimeZoneField(required=False)
  62. tags = TagListSerializerField(required=False)
  63. circuit_count = serializers.IntegerField(read_only=True)
  64. device_count = serializers.IntegerField(read_only=True)
  65. prefix_count = serializers.IntegerField(read_only=True)
  66. rack_count = serializers.IntegerField(read_only=True)
  67. virtualmachine_count = serializers.IntegerField(read_only=True)
  68. vlan_count = serializers.IntegerField(read_only=True)
  69. class Meta:
  70. model = Site
  71. fields = [
  72. 'id', 'name', 'slug', 'status', 'region', 'tenant', 'facility', 'asn', 'time_zone', 'description',
  73. 'physical_address', 'shipping_address', 'latitude', 'longitude', 'contact_name', 'contact_phone',
  74. 'contact_email', 'comments', 'tags', 'custom_fields', 'created', 'last_updated', 'circuit_count',
  75. 'device_count', 'prefix_count', 'rack_count', 'virtualmachine_count', 'vlan_count',
  76. ]
  77. #
  78. # Racks
  79. #
  80. class RackGroupSerializer(ValidatedModelSerializer):
  81. site = NestedSiteSerializer()
  82. rack_count = serializers.IntegerField(read_only=True)
  83. class Meta:
  84. model = RackGroup
  85. fields = ['id', 'name', 'slug', 'site', 'rack_count']
  86. class RackRoleSerializer(ValidatedModelSerializer):
  87. rack_count = serializers.IntegerField(read_only=True)
  88. class Meta:
  89. model = RackRole
  90. fields = ['id', 'name', 'slug', 'color', 'description', 'rack_count']
  91. class RackSerializer(TaggitSerializer, CustomFieldModelSerializer):
  92. site = NestedSiteSerializer()
  93. group = NestedRackGroupSerializer(required=False, allow_null=True, default=None)
  94. tenant = NestedTenantSerializer(required=False, allow_null=True)
  95. status = ChoiceField(choices=RackStatusChoices, required=False)
  96. role = NestedRackRoleSerializer(required=False, allow_null=True)
  97. type = ChoiceField(choices=RackTypeChoices, allow_blank=True, required=False)
  98. width = ChoiceField(choices=RackWidthChoices, required=False)
  99. outer_unit = ChoiceField(choices=RackDimensionUnitChoices, allow_blank=True, required=False)
  100. tags = TagListSerializerField(required=False)
  101. device_count = serializers.IntegerField(read_only=True)
  102. powerfeed_count = serializers.IntegerField(read_only=True)
  103. class Meta:
  104. model = Rack
  105. fields = [
  106. 'id', 'name', 'facility_id', 'display_name', 'site', 'group', 'tenant', 'status', 'role', 'serial',
  107. 'asset_tag', 'type', 'width', 'u_height', 'desc_units', 'outer_width', 'outer_depth', 'outer_unit',
  108. 'comments', 'tags', 'custom_fields', 'created', 'last_updated', 'device_count', 'powerfeed_count',
  109. ]
  110. # Omit the UniqueTogetherValidator that would be automatically added to validate (group, facility_id). This
  111. # prevents facility_id from being interpreted as a required field.
  112. validators = [
  113. UniqueTogetherValidator(queryset=Rack.objects.all(), fields=('group', 'name'))
  114. ]
  115. def validate(self, data):
  116. # Validate uniqueness of (group, facility_id) since we omitted the automatically-created validator from Meta.
  117. if data.get('facility_id', None):
  118. validator = UniqueTogetherValidator(queryset=Rack.objects.all(), fields=('group', 'facility_id'))
  119. validator.set_context(self)
  120. validator(data)
  121. # Enforce model validation
  122. super().validate(data)
  123. return data
  124. class RackUnitSerializer(serializers.Serializer):
  125. """
  126. A rack unit is an abstraction formed by the set (rack, position, face); it does not exist as a row in the database.
  127. """
  128. id = serializers.IntegerField(read_only=True)
  129. name = serializers.CharField(read_only=True)
  130. face = ChoiceField(choices=DeviceFaceChoices, read_only=True)
  131. device = NestedDeviceSerializer(read_only=True)
  132. class RackReservationSerializer(ValidatedModelSerializer):
  133. rack = NestedRackSerializer()
  134. user = NestedUserSerializer()
  135. tenant = NestedTenantSerializer(required=False, allow_null=True)
  136. class Meta:
  137. model = RackReservation
  138. fields = ['id', 'rack', 'units', 'created', 'user', 'tenant', 'description']
  139. class RackElevationDetailFilterSerializer(serializers.Serializer):
  140. q = serializers.CharField(
  141. required=False,
  142. default=None
  143. )
  144. face = serializers.ChoiceField(
  145. choices=DeviceFaceChoices,
  146. default=DeviceFaceChoices.FACE_FRONT
  147. )
  148. render = serializers.ChoiceField(
  149. choices=RackElevationDetailRenderChoices,
  150. default=RackElevationDetailRenderChoices.RENDER_JSON
  151. )
  152. unit_width = serializers.IntegerField(
  153. default=RACK_ELEVATION_UNIT_WIDTH_DEFAULT
  154. )
  155. unit_height = serializers.IntegerField(
  156. default=RACK_ELEVATION_UNIT_HEIGHT_DEFAULT
  157. )
  158. legend_width = serializers.IntegerField(
  159. default=RACK_ELEVATION_LEGEND_WIDTH_DEFAULT
  160. )
  161. exclude = serializers.IntegerField(
  162. required=False,
  163. default=None
  164. )
  165. expand_devices = serializers.BooleanField(
  166. required=False,
  167. default=True
  168. )
  169. include_images = serializers.BooleanField(
  170. required=False,
  171. default=True
  172. )
  173. #
  174. # Device types
  175. #
  176. class ManufacturerSerializer(ValidatedModelSerializer):
  177. devicetype_count = serializers.IntegerField(read_only=True)
  178. inventoryitem_count = serializers.IntegerField(read_only=True)
  179. platform_count = serializers.IntegerField(read_only=True)
  180. class Meta:
  181. model = Manufacturer
  182. fields = ['id', 'name', 'slug', 'devicetype_count', 'inventoryitem_count', 'platform_count']
  183. class DeviceTypeSerializer(TaggitSerializer, CustomFieldModelSerializer):
  184. manufacturer = NestedManufacturerSerializer()
  185. subdevice_role = ChoiceField(choices=SubdeviceRoleChoices, allow_blank=True, required=False)
  186. tags = TagListSerializerField(required=False)
  187. device_count = serializers.IntegerField(read_only=True)
  188. class Meta:
  189. model = DeviceType
  190. fields = [
  191. 'id', 'manufacturer', 'model', 'slug', 'display_name', 'part_number', 'u_height', 'is_full_depth',
  192. 'subdevice_role', 'front_image', 'rear_image', 'comments', 'tags', 'custom_fields', 'created',
  193. 'last_updated', 'device_count',
  194. ]
  195. class ConsolePortTemplateSerializer(ValidatedModelSerializer):
  196. device_type = NestedDeviceTypeSerializer()
  197. type = ChoiceField(
  198. choices=ConsolePortTypeChoices,
  199. allow_blank=True,
  200. required=False
  201. )
  202. class Meta:
  203. model = ConsolePortTemplate
  204. fields = ['id', 'device_type', 'name', 'type']
  205. class ConsoleServerPortTemplateSerializer(ValidatedModelSerializer):
  206. device_type = NestedDeviceTypeSerializer()
  207. type = ChoiceField(
  208. choices=ConsolePortTypeChoices,
  209. allow_blank=True,
  210. required=False
  211. )
  212. class Meta:
  213. model = ConsoleServerPortTemplate
  214. fields = ['id', 'device_type', 'name', 'type']
  215. class PowerPortTemplateSerializer(ValidatedModelSerializer):
  216. device_type = NestedDeviceTypeSerializer()
  217. type = ChoiceField(
  218. choices=PowerPortTypeChoices,
  219. allow_blank=True,
  220. required=False
  221. )
  222. class Meta:
  223. model = PowerPortTemplate
  224. fields = ['id', 'device_type', 'name', 'type', 'maximum_draw', 'allocated_draw']
  225. class PowerOutletTemplateSerializer(ValidatedModelSerializer):
  226. device_type = NestedDeviceTypeSerializer()
  227. type = ChoiceField(
  228. choices=PowerOutletTypeChoices,
  229. allow_blank=True,
  230. required=False
  231. )
  232. power_port = NestedPowerPortTemplateSerializer(
  233. required=False
  234. )
  235. feed_leg = ChoiceField(
  236. choices=PowerOutletFeedLegChoices,
  237. allow_blank=True,
  238. required=False
  239. )
  240. class Meta:
  241. model = PowerOutletTemplate
  242. fields = ['id', 'device_type', 'name', 'type', 'power_port', 'feed_leg']
  243. class InterfaceTemplateSerializer(ValidatedModelSerializer):
  244. device_type = NestedDeviceTypeSerializer()
  245. type = ChoiceField(choices=InterfaceTypeChoices)
  246. class Meta:
  247. model = InterfaceTemplate
  248. fields = ['id', 'device_type', 'name', 'type', 'mgmt_only']
  249. class RearPortTemplateSerializer(ValidatedModelSerializer):
  250. device_type = NestedDeviceTypeSerializer()
  251. type = ChoiceField(choices=PortTypeChoices)
  252. class Meta:
  253. model = RearPortTemplate
  254. fields = ['id', 'device_type', 'name', 'type', 'positions']
  255. class FrontPortTemplateSerializer(ValidatedModelSerializer):
  256. device_type = NestedDeviceTypeSerializer()
  257. type = ChoiceField(choices=PortTypeChoices)
  258. rear_port = NestedRearPortTemplateSerializer()
  259. class Meta:
  260. model = FrontPortTemplate
  261. fields = ['id', 'device_type', 'name', 'type', 'rear_port', 'rear_port_position']
  262. class DeviceBayTemplateSerializer(ValidatedModelSerializer):
  263. device_type = NestedDeviceTypeSerializer()
  264. class Meta:
  265. model = DeviceBayTemplate
  266. fields = ['id', 'device_type', 'name']
  267. #
  268. # Devices
  269. #
  270. class DeviceRoleSerializer(ValidatedModelSerializer):
  271. device_count = serializers.IntegerField(read_only=True)
  272. virtualmachine_count = serializers.IntegerField(read_only=True)
  273. class Meta:
  274. model = DeviceRole
  275. fields = [
  276. 'id', 'name', 'slug', 'color', 'vm_role', 'description', 'device_count', 'virtualmachine_count',
  277. ]
  278. class PlatformSerializer(ValidatedModelSerializer):
  279. manufacturer = NestedManufacturerSerializer(required=False, allow_null=True)
  280. device_count = serializers.IntegerField(read_only=True)
  281. virtualmachine_count = serializers.IntegerField(read_only=True)
  282. class Meta:
  283. model = Platform
  284. fields = [
  285. 'id', 'name', 'slug', 'manufacturer', 'napalm_driver', 'napalm_args', 'device_count',
  286. 'virtualmachine_count',
  287. ]
  288. class DeviceSerializer(TaggitSerializer, CustomFieldModelSerializer):
  289. device_type = NestedDeviceTypeSerializer()
  290. device_role = NestedDeviceRoleSerializer()
  291. tenant = NestedTenantSerializer(required=False, allow_null=True)
  292. platform = NestedPlatformSerializer(required=False, allow_null=True)
  293. site = NestedSiteSerializer()
  294. rack = NestedRackSerializer(required=False, allow_null=True)
  295. face = ChoiceField(choices=DeviceFaceChoices, allow_blank=True, required=False)
  296. status = ChoiceField(choices=DeviceStatusChoices, required=False)
  297. primary_ip = NestedIPAddressSerializer(read_only=True)
  298. primary_ip4 = NestedIPAddressSerializer(required=False, allow_null=True)
  299. primary_ip6 = NestedIPAddressSerializer(required=False, allow_null=True)
  300. parent_device = serializers.SerializerMethodField()
  301. cluster = NestedClusterSerializer(required=False, allow_null=True)
  302. virtual_chassis = NestedVirtualChassisSerializer(required=False, allow_null=True)
  303. tags = TagListSerializerField(required=False)
  304. class Meta:
  305. model = Device
  306. fields = [
  307. 'id', 'name', 'display_name', 'device_type', 'device_role', 'tenant', 'platform', 'serial', 'asset_tag',
  308. 'site', 'rack', 'position', 'face', 'parent_device', 'status', 'primary_ip', 'primary_ip4', 'primary_ip6',
  309. 'cluster', 'virtual_chassis', 'vc_position', 'vc_priority', 'comments', 'local_context_data', 'tags',
  310. 'custom_fields', 'created', 'last_updated',
  311. ]
  312. validators = []
  313. def validate(self, data):
  314. # Validate uniqueness of (rack, position, face) since we omitted the automatically-created validator from Meta.
  315. if data.get('rack') and data.get('position') and data.get('face'):
  316. validator = UniqueTogetherValidator(queryset=Device.objects.all(), fields=('rack', 'position', 'face'))
  317. validator.set_context(self)
  318. validator(data)
  319. # Enforce model validation
  320. super().validate(data)
  321. return data
  322. @swagger_serializer_method(serializer_or_field=NestedDeviceSerializer)
  323. def get_parent_device(self, obj):
  324. try:
  325. device_bay = obj.parent_bay
  326. except DeviceBay.DoesNotExist:
  327. return None
  328. context = {'request': self.context['request']}
  329. data = NestedDeviceSerializer(instance=device_bay.device, context=context).data
  330. data['device_bay'] = NestedDeviceBaySerializer(instance=device_bay, context=context).data
  331. return data
  332. class DeviceWithConfigContextSerializer(DeviceSerializer):
  333. config_context = serializers.SerializerMethodField()
  334. class Meta(DeviceSerializer.Meta):
  335. fields = [
  336. 'id', 'name', 'display_name', 'device_type', 'device_role', 'tenant', 'platform', 'serial', 'asset_tag',
  337. 'site', 'rack', 'position', 'face', 'parent_device', 'status', 'primary_ip', 'primary_ip4', 'primary_ip6',
  338. 'cluster', 'virtual_chassis', 'vc_position', 'vc_priority', 'comments', 'local_context_data', 'tags',
  339. 'custom_fields', 'config_context', 'created', 'last_updated',
  340. ]
  341. @swagger_serializer_method(serializer_or_field=serializers.DictField)
  342. def get_config_context(self, obj):
  343. return obj.get_config_context()
  344. class DeviceNAPALMSerializer(serializers.Serializer):
  345. method = serializers.DictField()
  346. class ConsoleServerPortSerializer(TaggitSerializer, ConnectedEndpointSerializer):
  347. device = NestedDeviceSerializer()
  348. type = ChoiceField(
  349. choices=ConsolePortTypeChoices,
  350. allow_blank=True,
  351. required=False
  352. )
  353. cable = NestedCableSerializer(read_only=True)
  354. tags = TagListSerializerField(required=False)
  355. class Meta:
  356. model = ConsoleServerPort
  357. fields = [
  358. 'id', 'device', 'name', 'type', 'description', 'connected_endpoint_type', 'connected_endpoint',
  359. 'connection_status', 'cable', 'tags',
  360. ]
  361. class ConsolePortSerializer(TaggitSerializer, ConnectedEndpointSerializer):
  362. device = NestedDeviceSerializer()
  363. type = ChoiceField(
  364. choices=ConsolePortTypeChoices,
  365. allow_blank=True,
  366. required=False
  367. )
  368. cable = NestedCableSerializer(read_only=True)
  369. tags = TagListSerializerField(required=False)
  370. class Meta:
  371. model = ConsolePort
  372. fields = [
  373. 'id', 'device', 'name', 'type', 'description', 'connected_endpoint_type', 'connected_endpoint',
  374. 'connection_status', 'cable', 'tags',
  375. ]
  376. class PowerOutletSerializer(TaggitSerializer, ConnectedEndpointSerializer):
  377. device = NestedDeviceSerializer()
  378. type = ChoiceField(
  379. choices=PowerOutletTypeChoices,
  380. allow_blank=True,
  381. required=False
  382. )
  383. power_port = NestedPowerPortSerializer(
  384. required=False
  385. )
  386. feed_leg = ChoiceField(
  387. choices=PowerOutletFeedLegChoices,
  388. allow_blank=True,
  389. required=False
  390. )
  391. cable = NestedCableSerializer(
  392. read_only=True
  393. )
  394. tags = TagListSerializerField(
  395. required=False
  396. )
  397. class Meta:
  398. model = PowerOutlet
  399. fields = [
  400. 'id', 'device', 'name', 'type', 'power_port', 'feed_leg', 'description', 'connected_endpoint_type',
  401. 'connected_endpoint', 'connection_status', 'cable', 'tags',
  402. ]
  403. class PowerPortSerializer(TaggitSerializer, ConnectedEndpointSerializer):
  404. device = NestedDeviceSerializer()
  405. type = ChoiceField(
  406. choices=PowerPortTypeChoices,
  407. allow_blank=True,
  408. required=False
  409. )
  410. cable = NestedCableSerializer(read_only=True)
  411. tags = TagListSerializerField(required=False)
  412. class Meta:
  413. model = PowerPort
  414. fields = [
  415. 'id', 'device', 'name', 'type', 'maximum_draw', 'allocated_draw', 'description', 'connected_endpoint_type',
  416. 'connected_endpoint', 'connection_status', 'cable', 'tags',
  417. ]
  418. class InterfaceSerializer(TaggitSerializer, ConnectedEndpointSerializer):
  419. device = NestedDeviceSerializer()
  420. type = ChoiceField(choices=InterfaceTypeChoices)
  421. lag = NestedInterfaceSerializer(required=False, allow_null=True)
  422. mode = ChoiceField(choices=InterfaceModeChoices, allow_blank=True, required=False)
  423. untagged_vlan = NestedVLANSerializer(required=False, allow_null=True)
  424. tagged_vlans = SerializedPKRelatedField(
  425. queryset=VLAN.objects.all(),
  426. serializer=NestedVLANSerializer,
  427. required=False,
  428. many=True
  429. )
  430. cable = NestedCableSerializer(read_only=True)
  431. tags = TagListSerializerField(required=False)
  432. class Meta:
  433. model = Interface
  434. fields = [
  435. 'id', 'device', 'name', 'type', 'enabled', 'lag', 'mtu', 'mac_address', 'mgmt_only', 'description',
  436. 'connected_endpoint_type', 'connected_endpoint', 'connection_status', 'cable', 'mode', 'untagged_vlan',
  437. 'tagged_vlans', 'tags', 'count_ipaddresses',
  438. ]
  439. # TODO: This validation should be handled by Interface.clean()
  440. def validate(self, data):
  441. # All associated VLANs be global or assigned to the parent device's site.
  442. device = self.instance.device if self.instance else data.get('device')
  443. untagged_vlan = data.get('untagged_vlan')
  444. if untagged_vlan and untagged_vlan.site not in [device.site, None]:
  445. raise serializers.ValidationError({
  446. 'untagged_vlan': "VLAN {} must belong to the same site as the interface's parent device, or it must be "
  447. "global.".format(untagged_vlan)
  448. })
  449. for vlan in data.get('tagged_vlans', []):
  450. if vlan.site not in [device.site, None]:
  451. raise serializers.ValidationError({
  452. 'tagged_vlans': "VLAN {} must belong to the same site as the interface's parent device, or it must "
  453. "be global.".format(vlan)
  454. })
  455. return super().validate(data)
  456. class RearPortSerializer(TaggitSerializer, ValidatedModelSerializer):
  457. device = NestedDeviceSerializer()
  458. type = ChoiceField(choices=PortTypeChoices)
  459. cable = NestedCableSerializer(read_only=True)
  460. tags = TagListSerializerField(required=False)
  461. class Meta:
  462. model = RearPort
  463. fields = ['id', 'device', 'name', 'type', 'positions', 'description', 'cable', 'tags']
  464. class FrontPortRearPortSerializer(WritableNestedSerializer):
  465. """
  466. NestedRearPortSerializer but with parent device omitted (since front and rear ports must belong to same device)
  467. """
  468. url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rearport-detail')
  469. class Meta:
  470. model = RearPort
  471. fields = ['id', 'url', 'name']
  472. class FrontPortSerializer(TaggitSerializer, ValidatedModelSerializer):
  473. device = NestedDeviceSerializer()
  474. type = ChoiceField(choices=PortTypeChoices)
  475. rear_port = FrontPortRearPortSerializer()
  476. cable = NestedCableSerializer(read_only=True)
  477. tags = TagListSerializerField(required=False)
  478. class Meta:
  479. model = FrontPort
  480. fields = ['id', 'device', 'name', 'type', 'rear_port', 'rear_port_position', 'description', 'cable', 'tags']
  481. class DeviceBaySerializer(TaggitSerializer, ValidatedModelSerializer):
  482. device = NestedDeviceSerializer()
  483. installed_device = NestedDeviceSerializer(required=False, allow_null=True)
  484. tags = TagListSerializerField(required=False)
  485. class Meta:
  486. model = DeviceBay
  487. fields = ['id', 'device', 'name', 'description', 'installed_device', 'tags']
  488. #
  489. # Inventory items
  490. #
  491. class InventoryItemSerializer(TaggitSerializer, ValidatedModelSerializer):
  492. device = NestedDeviceSerializer()
  493. # Provide a default value to satisfy UniqueTogetherValidator
  494. parent = serializers.PrimaryKeyRelatedField(queryset=InventoryItem.objects.all(), allow_null=True, default=None)
  495. manufacturer = NestedManufacturerSerializer(required=False, allow_null=True, default=None)
  496. tags = TagListSerializerField(required=False)
  497. class Meta:
  498. model = InventoryItem
  499. fields = [
  500. 'id', 'device', 'parent', 'name', 'manufacturer', 'part_id', 'serial', 'asset_tag', 'discovered',
  501. 'description', 'tags',
  502. ]
  503. #
  504. # Cables
  505. #
  506. class CableSerializer(ValidatedModelSerializer):
  507. termination_a_type = ContentTypeField(
  508. queryset=ContentType.objects.filter(CABLE_TERMINATION_MODELS)
  509. )
  510. termination_b_type = ContentTypeField(
  511. queryset=ContentType.objects.filter(CABLE_TERMINATION_MODELS)
  512. )
  513. termination_a = serializers.SerializerMethodField(read_only=True)
  514. termination_b = serializers.SerializerMethodField(read_only=True)
  515. status = ChoiceField(choices=CableStatusChoices, required=False)
  516. length_unit = ChoiceField(choices=CableLengthUnitChoices, allow_blank=True, required=False)
  517. class Meta:
  518. model = Cable
  519. fields = [
  520. 'id', 'termination_a_type', 'termination_a_id', 'termination_a', 'termination_b_type', 'termination_b_id',
  521. 'termination_b', 'type', 'status', 'label', 'color', 'length', 'length_unit',
  522. ]
  523. def _get_termination(self, obj, side):
  524. """
  525. Serialize a nested representation of a termination.
  526. """
  527. if side.lower() not in ['a', 'b']:
  528. raise ValueError("Termination side must be either A or B.")
  529. termination = getattr(obj, 'termination_{}'.format(side.lower()))
  530. if termination is None:
  531. return None
  532. serializer = get_serializer_for_model(termination, prefix='Nested')
  533. context = {'request': self.context['request']}
  534. data = serializer(termination, context=context).data
  535. return data
  536. @swagger_serializer_method(serializer_or_field=serializers.DictField)
  537. def get_termination_a(self, obj):
  538. return self._get_termination(obj, 'a')
  539. @swagger_serializer_method(serializer_or_field=serializers.DictField)
  540. def get_termination_b(self, obj):
  541. return self._get_termination(obj, 'b')
  542. class TracedCableSerializer(serializers.ModelSerializer):
  543. """
  544. Used only while tracing a cable path.
  545. """
  546. url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cable-detail')
  547. class Meta:
  548. model = Cable
  549. fields = [
  550. 'id', 'url', 'type', 'status', 'label', 'color', 'length', 'length_unit',
  551. ]
  552. #
  553. # Interface connections
  554. #
  555. class InterfaceConnectionSerializer(ValidatedModelSerializer):
  556. interface_a = serializers.SerializerMethodField()
  557. interface_b = NestedInterfaceSerializer(source='connected_endpoint')
  558. connection_status = ChoiceField(choices=CONNECTION_STATUS_CHOICES, required=False)
  559. class Meta:
  560. model = Interface
  561. fields = ['interface_a', 'interface_b', 'connection_status']
  562. @swagger_serializer_method(serializer_or_field=NestedInterfaceSerializer)
  563. def get_interface_a(self, obj):
  564. context = {'request': self.context['request']}
  565. return NestedInterfaceSerializer(instance=obj, context=context).data
  566. #
  567. # Virtual chassis
  568. #
  569. class VirtualChassisSerializer(TaggitSerializer, ValidatedModelSerializer):
  570. master = NestedDeviceSerializer()
  571. tags = TagListSerializerField(required=False)
  572. member_count = serializers.IntegerField(read_only=True)
  573. class Meta:
  574. model = VirtualChassis
  575. fields = ['id', 'master', 'domain', 'tags', 'member_count']
  576. #
  577. # Power panels
  578. #
  579. class PowerPanelSerializer(ValidatedModelSerializer):
  580. site = NestedSiteSerializer()
  581. rack_group = NestedRackGroupSerializer(
  582. required=False,
  583. allow_null=True,
  584. default=None
  585. )
  586. powerfeed_count = serializers.IntegerField(read_only=True)
  587. class Meta:
  588. model = PowerPanel
  589. fields = ['id', 'site', 'rack_group', 'name', 'powerfeed_count']
  590. class PowerFeedSerializer(TaggitSerializer, CustomFieldModelSerializer):
  591. power_panel = NestedPowerPanelSerializer()
  592. rack = NestedRackSerializer(
  593. required=False,
  594. allow_null=True,
  595. default=None
  596. )
  597. type = ChoiceField(
  598. choices=PowerFeedTypeChoices,
  599. default=PowerFeedTypeChoices.TYPE_PRIMARY
  600. )
  601. status = ChoiceField(
  602. choices=PowerFeedStatusChoices,
  603. default=PowerFeedStatusChoices.STATUS_ACTIVE
  604. )
  605. supply = ChoiceField(
  606. choices=PowerFeedSupplyChoices,
  607. default=PowerFeedSupplyChoices.SUPPLY_AC
  608. )
  609. phase = ChoiceField(
  610. choices=PowerFeedPhaseChoices,
  611. default=PowerFeedPhaseChoices.PHASE_SINGLE
  612. )
  613. tags = TagListSerializerField(
  614. required=False
  615. )
  616. class Meta:
  617. model = PowerFeed
  618. fields = [
  619. 'id', 'power_panel', 'rack', 'name', 'status', 'type', 'supply', 'phase', 'voltage', 'amperage',
  620. 'max_utilization', 'comments', 'tags', 'custom_fields', 'created', 'last_updated',
  621. ]