serializers.py 27 KB

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