serializers.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730
  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', '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, required=False, allow_null=True)
  98. width = ChoiceField(choices=RackWidthChoices, required=False)
  99. outer_unit = ChoiceField(choices=RackDimensionUnitChoices, 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. face = serializers.ChoiceField(choices=DeviceFaceChoices, default=DeviceFaceChoices.FACE_FRONT)
  141. render_format = serializers.ChoiceField(
  142. choices=RackElecationDetailRenderFormatChoices,
  143. default=RackElecationDetailRenderFormatChoices.RENDER_FORMAT_SVG
  144. )
  145. unit_width = serializers.IntegerField(default=RACK_ELEVATION_UNIT_WIDTH_DEFAULT)
  146. unit_height = serializers.IntegerField(default=RACK_ELEVATION_UNIT_HEIGHT_DEFAULT)
  147. exclude = serializers.IntegerField(required=False, default=None)
  148. expand_devices = serializers.BooleanField(required=False, default=True)
  149. #
  150. # Device types
  151. #
  152. class ManufacturerSerializer(ValidatedModelSerializer):
  153. devicetype_count = serializers.IntegerField(read_only=True)
  154. inventoryitem_count = serializers.IntegerField(read_only=True)
  155. platform_count = serializers.IntegerField(read_only=True)
  156. class Meta:
  157. model = Manufacturer
  158. fields = ['id', 'name', 'slug', 'devicetype_count', 'inventoryitem_count', 'platform_count']
  159. class DeviceTypeSerializer(TaggitSerializer, CustomFieldModelSerializer):
  160. manufacturer = NestedManufacturerSerializer()
  161. subdevice_role = ChoiceField(choices=SubdeviceRoleChoices, required=False, allow_null=True)
  162. tags = TagListSerializerField(required=False)
  163. device_count = serializers.IntegerField(read_only=True)
  164. class Meta:
  165. model = DeviceType
  166. fields = [
  167. 'id', 'manufacturer', 'model', 'slug', 'display_name', 'part_number', 'u_height', 'is_full_depth',
  168. 'subdevice_role', 'comments', 'tags', 'custom_fields', 'created', 'last_updated', 'device_count',
  169. ]
  170. class ConsolePortTemplateSerializer(ValidatedModelSerializer):
  171. device_type = NestedDeviceTypeSerializer()
  172. type = ChoiceField(
  173. choices=ConsolePortTypeChoices,
  174. required=False
  175. )
  176. class Meta:
  177. model = ConsolePortTemplate
  178. fields = ['id', 'device_type', 'name', 'type']
  179. class ConsoleServerPortTemplateSerializer(ValidatedModelSerializer):
  180. device_type = NestedDeviceTypeSerializer()
  181. type = ChoiceField(
  182. choices=ConsolePortTypeChoices,
  183. required=False
  184. )
  185. class Meta:
  186. model = ConsoleServerPortTemplate
  187. fields = ['id', 'device_type', 'name', 'type']
  188. class PowerPortTemplateSerializer(ValidatedModelSerializer):
  189. device_type = NestedDeviceTypeSerializer()
  190. type = ChoiceField(
  191. choices=PowerPortTypeChoices,
  192. required=False
  193. )
  194. class Meta:
  195. model = PowerPortTemplate
  196. fields = ['id', 'device_type', 'name', 'type', 'maximum_draw', 'allocated_draw']
  197. class PowerOutletTemplateSerializer(ValidatedModelSerializer):
  198. device_type = NestedDeviceTypeSerializer()
  199. type = ChoiceField(
  200. choices=PowerOutletTypeChoices,
  201. required=False
  202. )
  203. power_port = PowerPortTemplateSerializer(
  204. required=False
  205. )
  206. feed_leg = ChoiceField(
  207. choices=PowerOutletFeedLegChoices,
  208. required=False,
  209. allow_null=True
  210. )
  211. class Meta:
  212. model = PowerOutletTemplate
  213. fields = ['id', 'device_type', 'name', 'type', 'power_port', 'feed_leg']
  214. class InterfaceTemplateSerializer(ValidatedModelSerializer):
  215. device_type = NestedDeviceTypeSerializer()
  216. type = ChoiceField(choices=InterfaceTypeChoices, required=False)
  217. class Meta:
  218. model = InterfaceTemplate
  219. fields = ['id', 'device_type', 'name', 'type', 'mgmt_only']
  220. class RearPortTemplateSerializer(ValidatedModelSerializer):
  221. device_type = NestedDeviceTypeSerializer()
  222. type = ChoiceField(choices=PortTypeChoices)
  223. class Meta:
  224. model = RearPortTemplate
  225. fields = ['id', 'device_type', 'name', 'type', 'positions']
  226. class FrontPortTemplateSerializer(ValidatedModelSerializer):
  227. device_type = NestedDeviceTypeSerializer()
  228. type = ChoiceField(choices=PortTypeChoices)
  229. rear_port = NestedRearPortTemplateSerializer()
  230. class Meta:
  231. model = FrontPortTemplate
  232. fields = ['id', 'device_type', 'name', 'type', 'rear_port', 'rear_port_position']
  233. class DeviceBayTemplateSerializer(ValidatedModelSerializer):
  234. device_type = NestedDeviceTypeSerializer()
  235. class Meta:
  236. model = DeviceBayTemplate
  237. fields = ['id', 'device_type', 'name']
  238. #
  239. # Devices
  240. #
  241. class DeviceRoleSerializer(ValidatedModelSerializer):
  242. device_count = serializers.IntegerField(read_only=True)
  243. virtualmachine_count = serializers.IntegerField(read_only=True)
  244. class Meta:
  245. model = DeviceRole
  246. fields = ['id', 'name', 'slug', 'color', 'vm_role', 'device_count', 'virtualmachine_count']
  247. class PlatformSerializer(ValidatedModelSerializer):
  248. manufacturer = NestedManufacturerSerializer(required=False, allow_null=True)
  249. device_count = serializers.IntegerField(read_only=True)
  250. virtualmachine_count = serializers.IntegerField(read_only=True)
  251. class Meta:
  252. model = Platform
  253. fields = [
  254. 'id', 'name', 'slug', 'manufacturer', 'napalm_driver', 'napalm_args', 'device_count',
  255. 'virtualmachine_count',
  256. ]
  257. class DeviceSerializer(TaggitSerializer, CustomFieldModelSerializer):
  258. device_type = NestedDeviceTypeSerializer()
  259. device_role = NestedDeviceRoleSerializer()
  260. tenant = NestedTenantSerializer(required=False, allow_null=True)
  261. platform = NestedPlatformSerializer(required=False, allow_null=True)
  262. site = NestedSiteSerializer()
  263. rack = NestedRackSerializer(required=False, allow_null=True)
  264. face = ChoiceField(choices=DeviceFaceChoices, required=False, allow_null=True)
  265. status = ChoiceField(choices=DeviceStatusChoices, required=False)
  266. primary_ip = NestedIPAddressSerializer(read_only=True)
  267. primary_ip4 = NestedIPAddressSerializer(required=False, allow_null=True)
  268. primary_ip6 = NestedIPAddressSerializer(required=False, allow_null=True)
  269. parent_device = serializers.SerializerMethodField()
  270. cluster = NestedClusterSerializer(required=False, allow_null=True)
  271. virtual_chassis = NestedVirtualChassisSerializer(required=False, allow_null=True)
  272. tags = TagListSerializerField(required=False)
  273. class Meta:
  274. model = Device
  275. fields = [
  276. 'id', 'name', 'display_name', 'device_type', 'device_role', 'tenant', 'platform', 'serial', 'asset_tag',
  277. 'site', 'rack', 'position', 'face', 'parent_device', 'status', 'primary_ip', 'primary_ip4', 'primary_ip6',
  278. 'cluster', 'virtual_chassis', 'vc_position', 'vc_priority', 'comments', 'local_context_data', 'tags',
  279. 'custom_fields', 'created', 'last_updated',
  280. ]
  281. validators = []
  282. def validate(self, data):
  283. # Validate uniqueness of (rack, position, face) since we omitted the automatically-created validator from Meta.
  284. if data.get('rack') and data.get('position') and data.get('face'):
  285. validator = UniqueTogetherValidator(queryset=Device.objects.all(), fields=('rack', 'position', 'face'))
  286. validator.set_context(self)
  287. validator(data)
  288. # Enforce model validation
  289. super().validate(data)
  290. return data
  291. @swagger_serializer_method(serializer_or_field=NestedDeviceSerializer)
  292. def get_parent_device(self, obj):
  293. try:
  294. device_bay = obj.parent_bay
  295. except DeviceBay.DoesNotExist:
  296. return None
  297. context = {'request': self.context['request']}
  298. data = NestedDeviceSerializer(instance=device_bay.device, context=context).data
  299. data['device_bay'] = NestedDeviceBaySerializer(instance=device_bay, context=context).data
  300. return data
  301. class DeviceWithConfigContextSerializer(DeviceSerializer):
  302. config_context = serializers.SerializerMethodField()
  303. class Meta(DeviceSerializer.Meta):
  304. fields = [
  305. 'id', 'name', 'display_name', 'device_type', 'device_role', 'tenant', 'platform', 'serial', 'asset_tag',
  306. 'site', 'rack', 'position', 'face', 'parent_device', 'status', 'primary_ip', 'primary_ip4', 'primary_ip6',
  307. 'cluster', 'virtual_chassis', 'vc_position', 'vc_priority', 'comments', 'local_context_data', 'tags',
  308. 'custom_fields', 'config_context', 'created', 'last_updated',
  309. ]
  310. @swagger_serializer_method(serializer_or_field=serializers.DictField)
  311. def get_config_context(self, obj):
  312. return obj.get_config_context()
  313. class ConsoleServerPortSerializer(TaggitSerializer, ConnectedEndpointSerializer):
  314. device = NestedDeviceSerializer()
  315. type = ChoiceField(
  316. choices=ConsolePortTypeChoices,
  317. required=False
  318. )
  319. cable = NestedCableSerializer(read_only=True)
  320. tags = TagListSerializerField(required=False)
  321. class Meta:
  322. model = ConsoleServerPort
  323. fields = [
  324. 'id', 'device', 'name', 'type', 'description', 'connected_endpoint_type', 'connected_endpoint',
  325. 'connection_status', 'cable', 'tags',
  326. ]
  327. class ConsolePortSerializer(TaggitSerializer, ConnectedEndpointSerializer):
  328. device = NestedDeviceSerializer()
  329. type = ChoiceField(
  330. choices=ConsolePortTypeChoices,
  331. required=False
  332. )
  333. cable = NestedCableSerializer(read_only=True)
  334. tags = TagListSerializerField(required=False)
  335. class Meta:
  336. model = ConsolePort
  337. fields = [
  338. 'id', 'device', 'name', 'type', 'description', 'connected_endpoint_type', 'connected_endpoint',
  339. 'connection_status', 'cable', 'tags',
  340. ]
  341. class PowerOutletSerializer(TaggitSerializer, ConnectedEndpointSerializer):
  342. device = NestedDeviceSerializer()
  343. type = ChoiceField(
  344. choices=PowerOutletTypeChoices,
  345. required=False
  346. )
  347. power_port = NestedPowerPortSerializer(
  348. required=False
  349. )
  350. feed_leg = ChoiceField(
  351. choices=PowerOutletFeedLegChoices,
  352. required=False,
  353. allow_null=True
  354. )
  355. cable = NestedCableSerializer(
  356. read_only=True
  357. )
  358. tags = TagListSerializerField(
  359. required=False
  360. )
  361. class Meta:
  362. model = PowerOutlet
  363. fields = [
  364. 'id', 'device', 'name', 'type', 'power_port', 'feed_leg', 'description', 'connected_endpoint_type',
  365. 'connected_endpoint', 'connection_status', 'cable', 'tags',
  366. ]
  367. class PowerPortSerializer(TaggitSerializer, ConnectedEndpointSerializer):
  368. device = NestedDeviceSerializer()
  369. type = ChoiceField(
  370. choices=PowerPortTypeChoices,
  371. required=False
  372. )
  373. cable = NestedCableSerializer(read_only=True)
  374. tags = TagListSerializerField(required=False)
  375. class Meta:
  376. model = PowerPort
  377. fields = [
  378. 'id', 'device', 'name', 'type', 'maximum_draw', 'allocated_draw', 'description', 'connected_endpoint_type',
  379. 'connected_endpoint', 'connection_status', 'cable', 'tags',
  380. ]
  381. class InterfaceSerializer(TaggitSerializer, ConnectedEndpointSerializer):
  382. device = NestedDeviceSerializer()
  383. type = ChoiceField(choices=InterfaceTypeChoices, required=False)
  384. lag = NestedInterfaceSerializer(required=False, allow_null=True)
  385. mode = ChoiceField(choices=InterfaceModeChoices, required=False, allow_null=True)
  386. untagged_vlan = NestedVLANSerializer(required=False, allow_null=True)
  387. tagged_vlans = SerializedPKRelatedField(
  388. queryset=VLAN.objects.all(),
  389. serializer=NestedVLANSerializer,
  390. required=False,
  391. many=True
  392. )
  393. cable = NestedCableSerializer(read_only=True)
  394. tags = TagListSerializerField(required=False)
  395. class Meta:
  396. model = Interface
  397. fields = [
  398. 'id', 'device', 'name', 'type', 'enabled', 'lag', 'mtu', 'mac_address', 'mgmt_only', 'description',
  399. 'connected_endpoint_type', 'connected_endpoint', 'connection_status', 'cable', 'mode', 'untagged_vlan',
  400. 'tagged_vlans', 'tags', 'count_ipaddresses',
  401. ]
  402. # TODO: This validation should be handled by Interface.clean()
  403. def validate(self, data):
  404. # All associated VLANs be global or assigned to the parent device's site.
  405. device = self.instance.device if self.instance else data.get('device')
  406. untagged_vlan = data.get('untagged_vlan')
  407. if untagged_vlan and untagged_vlan.site not in [device.site, None]:
  408. raise serializers.ValidationError({
  409. 'untagged_vlan': "VLAN {} must belong to the same site as the interface's parent device, or it must be "
  410. "global.".format(untagged_vlan)
  411. })
  412. for vlan in data.get('tagged_vlans', []):
  413. if vlan.site not in [device.site, None]:
  414. raise serializers.ValidationError({
  415. 'tagged_vlans': "VLAN {} must belong to the same site as the interface's parent device, or it must "
  416. "be global.".format(vlan)
  417. })
  418. return super().validate(data)
  419. class RearPortSerializer(TaggitSerializer, ValidatedModelSerializer):
  420. device = NestedDeviceSerializer()
  421. type = ChoiceField(choices=PortTypeChoices)
  422. cable = NestedCableSerializer(read_only=True)
  423. tags = TagListSerializerField(required=False)
  424. class Meta:
  425. model = RearPort
  426. fields = ['id', 'device', 'name', 'type', 'positions', 'description', 'cable', 'tags']
  427. class FrontPortRearPortSerializer(WritableNestedSerializer):
  428. """
  429. NestedRearPortSerializer but with parent device omitted (since front and rear ports must belong to same device)
  430. """
  431. url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rearport-detail')
  432. class Meta:
  433. model = RearPort
  434. fields = ['id', 'url', 'name']
  435. class FrontPortSerializer(TaggitSerializer, ValidatedModelSerializer):
  436. device = NestedDeviceSerializer()
  437. type = ChoiceField(choices=PortTypeChoices)
  438. rear_port = FrontPortRearPortSerializer()
  439. cable = NestedCableSerializer(read_only=True)
  440. tags = TagListSerializerField(required=False)
  441. class Meta:
  442. model = FrontPort
  443. fields = ['id', 'device', 'name', 'type', 'rear_port', 'rear_port_position', 'description', 'cable', 'tags']
  444. class DeviceBaySerializer(TaggitSerializer, ValidatedModelSerializer):
  445. device = NestedDeviceSerializer()
  446. installed_device = NestedDeviceSerializer(required=False, allow_null=True)
  447. tags = TagListSerializerField(required=False)
  448. class Meta:
  449. model = DeviceBay
  450. fields = ['id', 'device', 'name', 'description', 'installed_device', 'tags']
  451. #
  452. # Inventory items
  453. #
  454. class InventoryItemSerializer(TaggitSerializer, ValidatedModelSerializer):
  455. device = NestedDeviceSerializer()
  456. # Provide a default value to satisfy UniqueTogetherValidator
  457. parent = serializers.PrimaryKeyRelatedField(queryset=InventoryItem.objects.all(), allow_null=True, default=None)
  458. manufacturer = NestedManufacturerSerializer(required=False, allow_null=True, default=None)
  459. tags = TagListSerializerField(required=False)
  460. class Meta:
  461. model = InventoryItem
  462. fields = [
  463. 'id', 'device', 'parent', 'name', 'manufacturer', 'part_id', 'serial', 'asset_tag', 'discovered',
  464. 'description', 'tags',
  465. ]
  466. #
  467. # Cables
  468. #
  469. class CableSerializer(ValidatedModelSerializer):
  470. termination_a_type = ContentTypeField(
  471. queryset=ContentType.objects.filter(model__in=CABLE_TERMINATION_TYPES)
  472. )
  473. termination_b_type = ContentTypeField(
  474. queryset=ContentType.objects.filter(model__in=CABLE_TERMINATION_TYPES)
  475. )
  476. termination_a = serializers.SerializerMethodField(read_only=True)
  477. termination_b = serializers.SerializerMethodField(read_only=True)
  478. status = ChoiceField(choices=CONNECTION_STATUS_CHOICES, required=False)
  479. length_unit = ChoiceField(choices=CableLengthUnitChoices, required=False, allow_null=True)
  480. class Meta:
  481. model = Cable
  482. fields = [
  483. 'id', 'termination_a_type', 'termination_a_id', 'termination_a', 'termination_b_type', 'termination_b_id',
  484. 'termination_b', 'type', 'status', 'label', 'color', 'length', 'length_unit',
  485. ]
  486. def _get_termination(self, obj, side):
  487. """
  488. Serialize a nested representation of a termination.
  489. """
  490. if side.lower() not in ['a', 'b']:
  491. raise ValueError("Termination side must be either A or B.")
  492. termination = getattr(obj, 'termination_{}'.format(side.lower()))
  493. if termination is None:
  494. return None
  495. serializer = get_serializer_for_model(termination, prefix='Nested')
  496. context = {'request': self.context['request']}
  497. data = serializer(termination, context=context).data
  498. return data
  499. @swagger_serializer_method(serializer_or_field=serializers.DictField)
  500. def get_termination_a(self, obj):
  501. return self._get_termination(obj, 'a')
  502. @swagger_serializer_method(serializer_or_field=serializers.DictField)
  503. def get_termination_b(self, obj):
  504. return self._get_termination(obj, 'b')
  505. class TracedCableSerializer(serializers.ModelSerializer):
  506. """
  507. Used only while tracing a cable path.
  508. """
  509. url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cable-detail')
  510. class Meta:
  511. model = Cable
  512. fields = [
  513. 'id', 'url', 'type', 'status', 'label', 'color', 'length', 'length_unit',
  514. ]
  515. #
  516. # Interface connections
  517. #
  518. class InterfaceConnectionSerializer(ValidatedModelSerializer):
  519. interface_a = serializers.SerializerMethodField()
  520. interface_b = NestedInterfaceSerializer(source='connected_endpoint')
  521. connection_status = ChoiceField(choices=CONNECTION_STATUS_CHOICES, required=False)
  522. class Meta:
  523. model = Interface
  524. fields = ['interface_a', 'interface_b', 'connection_status']
  525. @swagger_serializer_method(serializer_or_field=NestedInterfaceSerializer)
  526. def get_interface_a(self, obj):
  527. context = {'request': self.context['request']}
  528. return NestedInterfaceSerializer(instance=obj, context=context).data
  529. #
  530. # Virtual chassis
  531. #
  532. class VirtualChassisSerializer(TaggitSerializer, ValidatedModelSerializer):
  533. master = NestedDeviceSerializer()
  534. tags = TagListSerializerField(required=False)
  535. member_count = serializers.IntegerField(read_only=True)
  536. class Meta:
  537. model = VirtualChassis
  538. fields = ['id', 'master', 'domain', 'tags', 'member_count']
  539. #
  540. # Power panels
  541. #
  542. class PowerPanelSerializer(ValidatedModelSerializer):
  543. site = NestedSiteSerializer()
  544. rack_group = NestedRackGroupSerializer(
  545. required=False,
  546. allow_null=True,
  547. default=None
  548. )
  549. powerfeed_count = serializers.IntegerField(read_only=True)
  550. class Meta:
  551. model = PowerPanel
  552. fields = ['id', 'site', 'rack_group', 'name', 'powerfeed_count']
  553. class PowerFeedSerializer(TaggitSerializer, CustomFieldModelSerializer):
  554. power_panel = NestedPowerPanelSerializer()
  555. rack = NestedRackSerializer(
  556. required=False,
  557. allow_null=True,
  558. default=None
  559. )
  560. type = ChoiceField(
  561. choices=PowerFeedTypeChoices,
  562. default=PowerFeedTypeChoices.TYPE_PRIMARY
  563. )
  564. status = ChoiceField(
  565. choices=PowerFeedStatusChoices,
  566. default=PowerFeedStatusChoices.STATUS_ACTIVE
  567. )
  568. supply = ChoiceField(
  569. choices=PowerFeedSupplyChoices,
  570. default=PowerFeedSupplyChoices.SUPPLY_AC
  571. )
  572. phase = ChoiceField(
  573. choices=PowerFeedPhaseChoices,
  574. default=PowerFeedPhaseChoices.PHASE_SINGLE
  575. )
  576. tags = TagListSerializerField(
  577. required=False
  578. )
  579. class Meta:
  580. model = PowerFeed
  581. fields = [
  582. 'id', 'power_panel', 'rack', 'name', 'status', 'type', 'supply', 'phase', 'voltage', 'amperage',
  583. 'max_utilization', 'comments', 'tags', 'custom_fields', 'created', 'last_updated',
  584. ]