forms.py 57 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751
  1. from __future__ import unicode_literals
  2. from mptt.forms import TreeNodeChoiceField
  3. import re
  4. from django import forms
  5. from django.contrib.postgres.forms.array import SimpleArrayField
  6. from django.db.models import Count, Q
  7. from extras.forms import CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFilterForm
  8. from ipam.models import IPAddress
  9. from tenancy.forms import TenancyForm
  10. from tenancy.models import Tenant
  11. from utilities.forms import (
  12. APISelect, add_blank_choice, ArrayFieldSelectMultiple, BootstrapMixin, BulkEditForm, BulkEditNullBooleanSelect,
  13. ChainedFieldsMixin, ChainedModelChoiceField, CommentField, CSVChoiceField, ExpandableNameField, FilterChoiceField,
  14. FlexibleModelChoiceField, Livesearch, SelectWithDisabled, SmallTextarea, SlugField,
  15. FilterTreeNodeMultipleChoiceField,
  16. )
  17. from .formfields import MACAddressFormField
  18. from .models import (
  19. DeviceBay, DeviceBayTemplate, CONNECTION_STATUS_CHOICES, CONNECTION_STATUS_CONNECTED, ConsolePort,
  20. ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate, Device, DeviceRole, DeviceType, Interface,
  21. IFACE_FF_CHOICES, IFACE_FF_LAG, IFACE_ORDERING_CHOICES, InterfaceConnection, InterfaceTemplate, Manufacturer,
  22. InventoryItem, Platform, PowerOutlet, PowerOutletTemplate, PowerPort, PowerPortTemplate, RACK_FACE_CHOICES,
  23. RACK_TYPE_CHOICES, RACK_WIDTH_CHOICES, Rack, RackGroup, RackReservation, RackRole, RACK_WIDTH_19IN, RACK_WIDTH_23IN,
  24. Region, Site, STATUS_CHOICES, SUBDEVICE_ROLE_CHILD, SUBDEVICE_ROLE_PARENT, VIRTUAL_IFACE_TYPES,
  25. )
  26. FORM_STATUS_CHOICES = [
  27. ['', '---------'],
  28. ]
  29. FORM_STATUS_CHOICES += STATUS_CHOICES
  30. DEVICE_BY_PK_RE = '{\d+\}'
  31. def get_device_by_name_or_pk(name):
  32. """
  33. Attempt to retrieve a device by either its name or primary key ('{pk}').
  34. """
  35. if re.match(DEVICE_BY_PK_RE, name):
  36. pk = name.strip('{}')
  37. device = Device.objects.get(pk=pk)
  38. else:
  39. device = Device.objects.get(name=name)
  40. return device
  41. class DeviceComponentForm(BootstrapMixin, forms.Form):
  42. """
  43. Allow inclusion of the parent device as context for limiting field choices.
  44. """
  45. def __init__(self, device, *args, **kwargs):
  46. self.device = device
  47. super(DeviceComponentForm, self).__init__(*args, **kwargs)
  48. #
  49. # Regions
  50. #
  51. class RegionForm(BootstrapMixin, forms.ModelForm):
  52. slug = SlugField()
  53. class Meta:
  54. model = Region
  55. fields = ['parent', 'name', 'slug']
  56. #
  57. # Sites
  58. #
  59. class SiteForm(BootstrapMixin, TenancyForm, CustomFieldForm):
  60. region = TreeNodeChoiceField(queryset=Region.objects.all(), required=False)
  61. slug = SlugField()
  62. comments = CommentField()
  63. class Meta:
  64. model = Site
  65. fields = [
  66. 'name', 'slug', 'region', 'tenant_group', 'tenant', 'facility', 'asn', 'physical_address',
  67. 'shipping_address', 'contact_name', 'contact_phone', 'contact_email', 'comments',
  68. ]
  69. widgets = {
  70. 'physical_address': SmallTextarea(attrs={'rows': 3}),
  71. 'shipping_address': SmallTextarea(attrs={'rows': 3}),
  72. }
  73. help_texts = {
  74. 'name': "Full name of the site",
  75. 'facility': "Data center provider and facility (e.g. Equinix NY7)",
  76. 'asn': "BGP autonomous system number",
  77. 'physical_address': "Physical location of the building (e.g. for GPS)",
  78. 'shipping_address': "If different from the physical address"
  79. }
  80. class SiteCSVForm(forms.ModelForm):
  81. region = forms.ModelChoiceField(
  82. queryset=Region.objects.all(),
  83. required=False,
  84. to_field_name='name',
  85. help_text='Name of assigned region',
  86. error_messages={
  87. 'invalid_choice': 'Region not found.',
  88. }
  89. )
  90. tenant = forms.ModelChoiceField(
  91. queryset=Tenant.objects.all(),
  92. required=False,
  93. to_field_name='name',
  94. help_text='Name of assigned tenant',
  95. error_messages={
  96. 'invalid_choice': 'Tenant not found.',
  97. }
  98. )
  99. class Meta:
  100. model = Site
  101. fields = [
  102. 'name', 'slug', 'region', 'tenant', 'facility', 'asn', 'physical_address', 'shipping_address',
  103. 'contact_name', 'contact_phone', 'contact_email', 'comments',
  104. ]
  105. help_texts = {
  106. 'slug': 'URL-friendly slug',
  107. 'asn': '32-bit autonomous system number',
  108. }
  109. class SiteBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  110. pk = forms.ModelMultipleChoiceField(queryset=Site.objects.all(), widget=forms.MultipleHiddenInput)
  111. region = TreeNodeChoiceField(queryset=Region.objects.all(), required=False)
  112. tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
  113. asn = forms.IntegerField(min_value=1, max_value=4294967295, required=False, label='ASN')
  114. class Meta:
  115. nullable_fields = ['region', 'tenant', 'asn']
  116. class SiteFilterForm(BootstrapMixin, CustomFieldFilterForm):
  117. model = Site
  118. q = forms.CharField(required=False, label='Search')
  119. region = FilterTreeNodeMultipleChoiceField(
  120. queryset=Region.objects.annotate(filter_count=Count('sites')),
  121. to_field_name='slug',
  122. required=False,
  123. )
  124. tenant = FilterChoiceField(
  125. queryset=Tenant.objects.annotate(filter_count=Count('sites')),
  126. to_field_name='slug',
  127. null_option=(0, 'None')
  128. )
  129. #
  130. # Rack groups
  131. #
  132. class RackGroupForm(BootstrapMixin, forms.ModelForm):
  133. slug = SlugField()
  134. class Meta:
  135. model = RackGroup
  136. fields = ['site', 'name', 'slug']
  137. class RackGroupFilterForm(BootstrapMixin, forms.Form):
  138. site = FilterChoiceField(queryset=Site.objects.annotate(filter_count=Count('rack_groups')), to_field_name='slug')
  139. #
  140. # Rack roles
  141. #
  142. class RackRoleForm(BootstrapMixin, forms.ModelForm):
  143. slug = SlugField()
  144. class Meta:
  145. model = RackRole
  146. fields = ['name', 'slug', 'color']
  147. #
  148. # Racks
  149. #
  150. class RackForm(BootstrapMixin, TenancyForm, CustomFieldForm):
  151. group = ChainedModelChoiceField(
  152. queryset=RackGroup.objects.all(),
  153. chains=(
  154. ('site', 'site'),
  155. ),
  156. required=False,
  157. widget=APISelect(
  158. api_url='/api/dcim/rack-groups/?site_id={{site}}',
  159. )
  160. )
  161. comments = CommentField()
  162. class Meta:
  163. model = Rack
  164. fields = [
  165. 'site', 'group', 'name', 'facility_id', 'tenant_group', 'tenant', 'role', 'type', 'width', 'u_height',
  166. 'desc_units', 'comments',
  167. ]
  168. help_texts = {
  169. 'site': "The site at which the rack exists",
  170. 'name': "Organizational rack name",
  171. 'facility_id': "The unique rack ID assigned by the facility",
  172. 'u_height': "Height in rack units",
  173. }
  174. widgets = {
  175. 'site': forms.Select(attrs={'filter-for': 'group'}),
  176. }
  177. class RackCSVForm(forms.ModelForm):
  178. site = forms.ModelChoiceField(
  179. queryset=Site.objects.all(),
  180. to_field_name='name',
  181. help_text='Name of parent site',
  182. error_messages={
  183. 'invalid_choice': 'Site not found.',
  184. }
  185. )
  186. group_name = forms.CharField(
  187. help_text='Name of rack group',
  188. required=False
  189. )
  190. tenant = forms.ModelChoiceField(
  191. queryset=Tenant.objects.all(),
  192. required=False,
  193. to_field_name='name',
  194. help_text='Name of assigned tenant',
  195. error_messages={
  196. 'invalid_choice': 'Tenant not found.',
  197. }
  198. )
  199. role = forms.ModelChoiceField(
  200. queryset=RackRole.objects.all(),
  201. required=False,
  202. to_field_name='name',
  203. help_text='Name of assigned role',
  204. error_messages={
  205. 'invalid_choice': 'Role not found.',
  206. }
  207. )
  208. type = CSVChoiceField(
  209. choices=RACK_TYPE_CHOICES,
  210. required=False,
  211. help_text='Rack type'
  212. )
  213. width = forms.ChoiceField(
  214. choices = (
  215. (RACK_WIDTH_19IN, '19'),
  216. (RACK_WIDTH_23IN, '23'),
  217. ),
  218. help_text='Rail-to-rail width (in inches)'
  219. )
  220. class Meta:
  221. model = Rack
  222. fields = [
  223. 'site', 'group_name', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height', 'desc_units',
  224. ]
  225. help_texts = {
  226. 'name': 'Rack name',
  227. 'u_height': 'Height in rack units',
  228. }
  229. def clean(self):
  230. super(RackCSVForm, self).clean()
  231. site = self.cleaned_data.get('site')
  232. group_name = self.cleaned_data.get('group_name')
  233. # Validate rack group
  234. if group_name:
  235. try:
  236. self.instance.group = RackGroup.objects.get(site=site, name=group_name)
  237. except RackGroup.DoesNotExist:
  238. raise forms.ValidationError("Rack group {} not found for site {}".format(group_name, site))
  239. class RackBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  240. pk = forms.ModelMultipleChoiceField(queryset=Rack.objects.all(), widget=forms.MultipleHiddenInput)
  241. site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False, label='Site')
  242. group = forms.ModelChoiceField(queryset=RackGroup.objects.all(), required=False, label='Group')
  243. tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
  244. role = forms.ModelChoiceField(queryset=RackRole.objects.all(), required=False)
  245. type = forms.ChoiceField(choices=add_blank_choice(RACK_TYPE_CHOICES), required=False, label='Type')
  246. width = forms.ChoiceField(choices=add_blank_choice(RACK_WIDTH_CHOICES), required=False, label='Width')
  247. u_height = forms.IntegerField(required=False, label='Height (U)')
  248. desc_units = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Descending units')
  249. comments = CommentField(widget=SmallTextarea)
  250. class Meta:
  251. nullable_fields = ['group', 'tenant', 'role', 'comments']
  252. class RackFilterForm(BootstrapMixin, CustomFieldFilterForm):
  253. model = Rack
  254. q = forms.CharField(required=False, label='Search')
  255. site = FilterChoiceField(
  256. queryset=Site.objects.annotate(filter_count=Count('racks')),
  257. to_field_name='slug'
  258. )
  259. group_id = FilterChoiceField(
  260. queryset=RackGroup.objects.select_related('site').annotate(filter_count=Count('racks')),
  261. label='Rack group',
  262. null_option=(0, 'None')
  263. )
  264. tenant = FilterChoiceField(
  265. queryset=Tenant.objects.annotate(filter_count=Count('racks')),
  266. to_field_name='slug',
  267. null_option=(0, 'None')
  268. )
  269. role = FilterChoiceField(
  270. queryset=RackRole.objects.annotate(filter_count=Count('racks')),
  271. to_field_name='slug',
  272. null_option=(0, 'None')
  273. )
  274. #
  275. # Rack reservations
  276. #
  277. class RackReservationForm(BootstrapMixin, forms.ModelForm):
  278. units = SimpleArrayField(forms.IntegerField(), widget=ArrayFieldSelectMultiple(attrs={'size': 10}))
  279. class Meta:
  280. model = RackReservation
  281. fields = ['units', 'description']
  282. def __init__(self, *args, **kwargs):
  283. super(RackReservationForm, self).__init__(*args, **kwargs)
  284. # Populate rack unit choices
  285. self.fields['units'].widget.choices = self._get_unit_choices()
  286. def _get_unit_choices(self):
  287. rack = self.instance.rack
  288. reserved_units = []
  289. for resv in rack.reservations.exclude(pk=self.instance.pk):
  290. for u in resv.units:
  291. reserved_units.append(u)
  292. unit_choices = [(u, {'label': str(u), 'disabled': u in reserved_units}) for u in rack.units]
  293. return unit_choices
  294. class RackReservationFilterForm(BootstrapMixin, forms.Form):
  295. q = forms.CharField(required=False, label='Search')
  296. site = FilterChoiceField(
  297. queryset=Site.objects.annotate(filter_count=Count('racks__reservations')),
  298. to_field_name='slug'
  299. )
  300. group_id = FilterChoiceField(
  301. queryset=RackGroup.objects.select_related('site').annotate(filter_count=Count('racks__reservations')),
  302. label='Rack group',
  303. null_option=(0, 'None')
  304. )
  305. #
  306. # Manufacturers
  307. #
  308. class ManufacturerForm(BootstrapMixin, forms.ModelForm):
  309. slug = SlugField()
  310. class Meta:
  311. model = Manufacturer
  312. fields = ['name', 'slug']
  313. #
  314. # Device types
  315. #
  316. class DeviceTypeForm(BootstrapMixin, CustomFieldForm):
  317. slug = SlugField(slug_source='model')
  318. class Meta:
  319. model = DeviceType
  320. fields = ['manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth', 'is_console_server',
  321. 'is_pdu', 'is_network_device', 'subdevice_role', 'interface_ordering', 'comments']
  322. labels = {
  323. 'interface_ordering': 'Order interfaces by',
  324. }
  325. class DeviceTypeBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  326. pk = forms.ModelMultipleChoiceField(queryset=DeviceType.objects.all(), widget=forms.MultipleHiddenInput)
  327. manufacturer = forms.ModelChoiceField(queryset=Manufacturer.objects.all(), required=False)
  328. u_height = forms.IntegerField(min_value=1, required=False)
  329. is_full_depth = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Is full depth')
  330. interface_ordering = forms.ChoiceField(choices=add_blank_choice(IFACE_ORDERING_CHOICES), required=False)
  331. is_console_server = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Is full depth')
  332. is_pdu = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Is a PDU')
  333. is_network_device = forms.NullBooleanField(
  334. required=False, widget=BulkEditNullBooleanSelect, label='Is a network device'
  335. )
  336. class Meta:
  337. nullable_fields = []
  338. class DeviceTypeFilterForm(BootstrapMixin, CustomFieldFilterForm):
  339. model = DeviceType
  340. q = forms.CharField(required=False, label='Search')
  341. manufacturer = FilterChoiceField(
  342. queryset=Manufacturer.objects.annotate(filter_count=Count('device_types')),
  343. to_field_name='slug'
  344. )
  345. is_console_server = forms.BooleanField(
  346. required=False, label='Is a console server', widget=forms.CheckboxInput(attrs={'value': 'True'}))
  347. is_pdu = forms.BooleanField(
  348. required=False, label='Is a PDU', widget=forms.CheckboxInput(attrs={'value': 'True'})
  349. )
  350. is_network_device = forms.BooleanField(
  351. required=False, label='Is a network device', widget=forms.CheckboxInput(attrs={'value': 'True'})
  352. )
  353. subdevice_role = forms.NullBooleanField(
  354. required=False, label='Subdevice role', widget=forms.Select(choices=(
  355. ('', '---------'),
  356. (SUBDEVICE_ROLE_PARENT, 'Parent'),
  357. (SUBDEVICE_ROLE_CHILD, 'Child'),
  358. ))
  359. )
  360. #
  361. # Device component templates
  362. #
  363. class ConsolePortTemplateForm(BootstrapMixin, forms.ModelForm):
  364. class Meta:
  365. model = ConsolePortTemplate
  366. fields = ['device_type', 'name']
  367. widgets = {
  368. 'device_type': forms.HiddenInput(),
  369. }
  370. class ConsolePortTemplateCreateForm(DeviceComponentForm):
  371. name_pattern = ExpandableNameField(label='Name')
  372. class ConsoleServerPortTemplateForm(BootstrapMixin, forms.ModelForm):
  373. class Meta:
  374. model = ConsoleServerPortTemplate
  375. fields = ['device_type', 'name']
  376. widgets = {
  377. 'device_type': forms.HiddenInput(),
  378. }
  379. class ConsoleServerPortTemplateCreateForm(DeviceComponentForm):
  380. name_pattern = ExpandableNameField(label='Name')
  381. class PowerPortTemplateForm(BootstrapMixin, forms.ModelForm):
  382. class Meta:
  383. model = PowerPortTemplate
  384. fields = ['device_type', 'name']
  385. widgets = {
  386. 'device_type': forms.HiddenInput(),
  387. }
  388. class PowerPortTemplateCreateForm(DeviceComponentForm):
  389. name_pattern = ExpandableNameField(label='Name')
  390. class PowerOutletTemplateForm(BootstrapMixin, forms.ModelForm):
  391. class Meta:
  392. model = PowerOutletTemplate
  393. fields = ['device_type', 'name']
  394. widgets = {
  395. 'device_type': forms.HiddenInput(),
  396. }
  397. class PowerOutletTemplateCreateForm(DeviceComponentForm):
  398. name_pattern = ExpandableNameField(label='Name')
  399. class InterfaceTemplateForm(BootstrapMixin, forms.ModelForm):
  400. class Meta:
  401. model = InterfaceTemplate
  402. fields = ['device_type', 'name', 'form_factor', 'mgmt_only']
  403. widgets = {
  404. 'device_type': forms.HiddenInput(),
  405. }
  406. class InterfaceTemplateCreateForm(DeviceComponentForm):
  407. name_pattern = ExpandableNameField(label='Name')
  408. form_factor = forms.ChoiceField(choices=IFACE_FF_CHOICES)
  409. mgmt_only = forms.BooleanField(required=False, label='OOB Management')
  410. class InterfaceTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
  411. pk = forms.ModelMultipleChoiceField(queryset=InterfaceTemplate.objects.all(), widget=forms.MultipleHiddenInput)
  412. form_factor = forms.ChoiceField(choices=add_blank_choice(IFACE_FF_CHOICES), required=False)
  413. mgmt_only = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Management only')
  414. class Meta:
  415. nullable_fields = []
  416. class DeviceBayTemplateForm(BootstrapMixin, forms.ModelForm):
  417. class Meta:
  418. model = DeviceBayTemplate
  419. fields = ['device_type', 'name']
  420. widgets = {
  421. 'device_type': forms.HiddenInput(),
  422. }
  423. class DeviceBayTemplateCreateForm(DeviceComponentForm):
  424. name_pattern = ExpandableNameField(label='Name')
  425. #
  426. # Device roles
  427. #
  428. class DeviceRoleForm(BootstrapMixin, forms.ModelForm):
  429. slug = SlugField()
  430. class Meta:
  431. model = DeviceRole
  432. fields = ['name', 'slug', 'color']
  433. #
  434. # Platforms
  435. #
  436. class PlatformForm(BootstrapMixin, forms.ModelForm):
  437. slug = SlugField()
  438. class Meta:
  439. model = Platform
  440. fields = ['name', 'slug', 'rpc_client']
  441. #
  442. # Devices
  443. #
  444. class DeviceForm(BootstrapMixin, TenancyForm, CustomFieldForm):
  445. site = forms.ModelChoiceField(
  446. queryset=Site.objects.all(),
  447. widget=forms.Select(
  448. attrs={'filter-for': 'rack'}
  449. )
  450. )
  451. rack = ChainedModelChoiceField(
  452. queryset=Rack.objects.all(),
  453. chains=(
  454. ('site', 'site'),
  455. ),
  456. required=False,
  457. widget=APISelect(
  458. api_url='/api/dcim/racks/?site_id={{site}}',
  459. display_field='display_name',
  460. attrs={'filter-for': 'position'}
  461. )
  462. )
  463. position = forms.TypedChoiceField(
  464. required=False,
  465. empty_value=None,
  466. help_text="The lowest-numbered unit occupied by the device",
  467. widget=APISelect(
  468. api_url='/api/dcim/racks/{{rack}}/units/?face={{face}}',
  469. disabled_indicator='device'
  470. )
  471. )
  472. manufacturer = forms.ModelChoiceField(
  473. queryset=Manufacturer.objects.all(),
  474. widget=forms.Select(
  475. attrs={'filter-for': 'device_type'}
  476. )
  477. )
  478. device_type = ChainedModelChoiceField(
  479. queryset=DeviceType.objects.all(),
  480. chains=(
  481. ('manufacturer', 'manufacturer'),
  482. ),
  483. label='Device type',
  484. widget=APISelect(
  485. api_url='/api/dcim/device-types/?manufacturer_id={{manufacturer}}',
  486. display_field='model'
  487. )
  488. )
  489. comments = CommentField()
  490. class Meta:
  491. model = Device
  492. fields = [
  493. 'name', 'device_role', 'device_type', 'serial', 'asset_tag', 'site', 'rack', 'position', 'face', 'status',
  494. 'platform', 'primary_ip4', 'primary_ip6', 'tenant_group', 'tenant', 'comments',
  495. ]
  496. help_texts = {
  497. 'device_role': "The function this device serves",
  498. 'serial': "Chassis serial number",
  499. }
  500. widgets = {
  501. 'face': forms.Select(attrs={'filter-for': 'position'}),
  502. }
  503. def __init__(self, *args, **kwargs):
  504. # Initialize helper selectors
  505. instance = kwargs.get('instance')
  506. # Using hasattr() instead of "is not None" to avoid RelatedObjectDoesNotExist on required field
  507. if instance and hasattr(instance, 'device_type'):
  508. initial = kwargs.get('initial', {})
  509. initial['manufacturer'] = instance.device_type.manufacturer
  510. kwargs['initial'] = initial
  511. super(DeviceForm, self).__init__(*args, **kwargs)
  512. if self.instance.pk:
  513. # Compile list of choices for primary IPv4 and IPv6 addresses
  514. for family in [4, 6]:
  515. ip_choices = []
  516. interface_ips = IPAddress.objects.filter(family=family, interface__device=self.instance)
  517. ip_choices += [(ip.id, '{} ({})'.format(ip.address, ip.interface)) for ip in interface_ips]
  518. nat_ips = IPAddress.objects.filter(family=family, nat_inside__interface__device=self.instance)\
  519. .select_related('nat_inside__interface')
  520. ip_choices += [(ip.id, '{} ({} NAT)'.format(ip.address, ip.nat_inside.interface)) for ip in nat_ips]
  521. self.fields['primary_ip{}'.format(family)].choices = [(None, '---------')] + ip_choices
  522. # If editing an existing device, exclude it from the list of occupied rack units. This ensures that a device
  523. # can be flipped from one face to another.
  524. self.fields['position'].widget.attrs['api-url'] += '&exclude={}'.format(self.instance.pk)
  525. else:
  526. # An object that doesn't exist yet can't have any IPs assigned to it
  527. self.fields['primary_ip4'].choices = []
  528. self.fields['primary_ip4'].widget.attrs['readonly'] = True
  529. self.fields['primary_ip6'].choices = []
  530. self.fields['primary_ip6'].widget.attrs['readonly'] = True
  531. # Rack position
  532. pk = self.instance.pk if self.instance.pk else None
  533. try:
  534. if self.is_bound and self.data.get('rack') and str(self.data.get('face')):
  535. position_choices = Rack.objects.get(pk=self.data['rack'])\
  536. .get_rack_units(face=self.data.get('face'), exclude=pk)
  537. elif self.initial.get('rack') and str(self.initial.get('face')):
  538. position_choices = Rack.objects.get(pk=self.initial['rack'])\
  539. .get_rack_units(face=self.initial.get('face'), exclude=pk)
  540. else:
  541. position_choices = []
  542. except Rack.DoesNotExist:
  543. position_choices = []
  544. self.fields['position'].choices = [('', '---------')] + [
  545. (p['id'], {
  546. 'label': p['name'],
  547. 'disabled': bool(p['device'] and p['id'] != self.initial.get('position')),
  548. }) for p in position_choices
  549. ]
  550. # Disable rack assignment if this is a child device installed in a parent device
  551. if pk and self.instance.device_type.is_child_device and hasattr(self.instance, 'parent_bay'):
  552. self.fields['site'].disabled = True
  553. self.fields['rack'].disabled = True
  554. self.initial['site'] = self.instance.parent_bay.device.site_id
  555. self.initial['rack'] = self.instance.parent_bay.device.rack_id
  556. class BaseDeviceCSVForm(forms.ModelForm):
  557. device_role = forms.ModelChoiceField(
  558. queryset=DeviceRole.objects.all(),
  559. to_field_name='name',
  560. help_text='Name of assigned role',
  561. error_messages={
  562. 'invalid_choice': 'Invalid device role.',
  563. }
  564. )
  565. tenant = forms.ModelChoiceField(
  566. queryset=Tenant.objects.all(),
  567. required=False,
  568. to_field_name='name',
  569. help_text='Name of assigned tenant',
  570. error_messages={
  571. 'invalid_choice': 'Tenant not found.',
  572. }
  573. )
  574. manufacturer = forms.ModelChoiceField(
  575. queryset=Manufacturer.objects.all(),
  576. to_field_name='name',
  577. help_text='Device type manufacturer',
  578. error_messages={
  579. 'invalid_choice': 'Invalid manufacturer.',
  580. }
  581. )
  582. model_name = forms.CharField(
  583. help_text='Device type model name'
  584. )
  585. platform = forms.ModelChoiceField(
  586. queryset=Platform.objects.all(),
  587. required=False,
  588. to_field_name='name',
  589. help_text='Name of assigned platform',
  590. error_messages={
  591. 'invalid_choice': 'Invalid platform.',
  592. }
  593. )
  594. status = CSVChoiceField(
  595. choices=STATUS_CHOICES,
  596. help_text='Operational status of device'
  597. )
  598. class Meta:
  599. fields = []
  600. model = Device
  601. def clean(self):
  602. super(BaseDeviceCSVForm, self).clean()
  603. manufacturer = self.cleaned_data.get('manufacturer')
  604. model_name = self.cleaned_data.get('model_name')
  605. # Validate device type
  606. if manufacturer and model_name:
  607. try:
  608. self.instance.device_type = DeviceType.objects.get(manufacturer=manufacturer, model=model_name)
  609. except DeviceType.DoesNotExist:
  610. raise forms.ValidationError("Device type {} {} not found".format(manufacturer, model_name))
  611. class DeviceCSVForm(BaseDeviceCSVForm):
  612. site = forms.ModelChoiceField(
  613. queryset=Site.objects.all(),
  614. to_field_name='name',
  615. help_text='Name of parent site',
  616. error_messages={
  617. 'invalid_choice': 'Invalid site name.',
  618. }
  619. )
  620. rack_group = forms.CharField(
  621. required=False,
  622. help_text='Parent rack\'s group (if any)'
  623. )
  624. rack_name = forms.CharField(
  625. required=False,
  626. help_text='Name of parent rack'
  627. )
  628. face = CSVChoiceField(
  629. choices=RACK_FACE_CHOICES,
  630. required=False,
  631. help_text='Mounted rack face'
  632. )
  633. class Meta(BaseDeviceCSVForm.Meta):
  634. fields = [
  635. 'name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag', 'status',
  636. 'site', 'rack_group', 'rack_name', 'position', 'face',
  637. ]
  638. help_texts = {
  639. 'name': 'Device name',
  640. }
  641. def clean(self):
  642. super(DeviceCSVForm, self).clean()
  643. site = self.cleaned_data.get('site')
  644. rack_group = self.cleaned_data.get('rack_group')
  645. rack_name = self.cleaned_data.get('rack_name')
  646. # Validate rack
  647. if site and rack_group and rack_name:
  648. try:
  649. self.instance.rack = Rack.objects.get(site=site, group__name=rack_group, name=rack_name)
  650. except Rack.DoesNotExist:
  651. raise forms.ValidationError("Rack {} not found in site {} group {}".format(rack_name, site, rack_group))
  652. elif site and rack_name:
  653. try:
  654. self.instance.rack = Rack.objects.get(site=site, group__isnull=True, name=rack_name)
  655. except Rack.DoesNotExist:
  656. raise forms.ValidationError("Rack {} not found in site {} (no group)".format(rack_name, site))
  657. class ChildDeviceCSVForm(BaseDeviceCSVForm):
  658. parent = FlexibleModelChoiceField(
  659. queryset=Device.objects.all(),
  660. to_field_name='name',
  661. help_text='Name of parent device',
  662. error_messages={
  663. 'invalid_choice': 'Parent device not found.',
  664. }
  665. )
  666. device_bay_name = forms.CharField(
  667. help_text='Name of device bay',
  668. )
  669. class Meta(BaseDeviceCSVForm.Meta):
  670. fields = [
  671. 'name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag', 'status',
  672. 'parent', 'device_bay_name',
  673. ]
  674. def clean(self):
  675. super(ChildDeviceCSVForm, self).clean()
  676. parent = self.cleaned_data.get('parent')
  677. device_bay_name = self.cleaned_data.get('device_bay_name')
  678. # Validate device bay
  679. if parent and device_bay_name:
  680. try:
  681. self.instance.parent_bay = DeviceBay.objects.get(device=parent, name=device_bay_name)
  682. # Inherit site and rack from parent device
  683. self.instance.site = parent.site
  684. self.instance.rack = parent.rack
  685. except DeviceBay.DoesNotExist:
  686. raise forms.ValidationError("Parent device/bay ({} {}) not found".format(parent, device_bay_name))
  687. class DeviceBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  688. pk = forms.ModelMultipleChoiceField(queryset=Device.objects.all(), widget=forms.MultipleHiddenInput)
  689. device_type = forms.ModelChoiceField(queryset=DeviceType.objects.all(), required=False, label='Type')
  690. device_role = forms.ModelChoiceField(queryset=DeviceRole.objects.all(), required=False, label='Role')
  691. tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
  692. platform = forms.ModelChoiceField(queryset=Platform.objects.all(), required=False)
  693. status = forms.ChoiceField(choices=FORM_STATUS_CHOICES, required=False, initial='', label='Status')
  694. serial = forms.CharField(max_length=50, required=False, label='Serial Number')
  695. class Meta:
  696. nullable_fields = ['tenant', 'platform']
  697. def device_status_choices():
  698. status_counts = {}
  699. for status in Device.objects.values('status').annotate(count=Count('status')).order_by('status'):
  700. status_counts[status['status']] = status['count']
  701. return [(s[0], '{} ({})'.format(s[1], status_counts.get(s[0], 0))) for s in STATUS_CHOICES]
  702. class DeviceFilterForm(BootstrapMixin, CustomFieldFilterForm):
  703. model = Device
  704. q = forms.CharField(required=False, label='Search')
  705. site = FilterChoiceField(
  706. queryset=Site.objects.annotate(filter_count=Count('devices')),
  707. to_field_name='slug',
  708. )
  709. rack_group_id = FilterChoiceField(
  710. queryset=RackGroup.objects.select_related('site').annotate(filter_count=Count('racks__devices')),
  711. label='Rack group',
  712. )
  713. rack_id = FilterChoiceField(
  714. queryset=Rack.objects.annotate(filter_count=Count('devices')),
  715. label='Rack',
  716. null_option=(0, 'None'),
  717. )
  718. role = FilterChoiceField(
  719. queryset=DeviceRole.objects.annotate(filter_count=Count('devices')),
  720. to_field_name='slug',
  721. )
  722. tenant = FilterChoiceField(
  723. queryset=Tenant.objects.annotate(filter_count=Count('devices')),
  724. to_field_name='slug',
  725. null_option=(0, 'None'),
  726. )
  727. manufacturer_id = FilterChoiceField(queryset=Manufacturer.objects.all(), label='Manufacturer')
  728. device_type_id = FilterChoiceField(
  729. queryset=DeviceType.objects.select_related('manufacturer').order_by('model').annotate(
  730. filter_count=Count('instances'),
  731. ),
  732. label='Model',
  733. )
  734. platform = FilterChoiceField(
  735. queryset=Platform.objects.annotate(filter_count=Count('devices')),
  736. to_field_name='slug',
  737. null_option=(0, 'None'),
  738. )
  739. status = forms.MultipleChoiceField(choices=device_status_choices, required=False)
  740. mac_address = forms.CharField(required=False, label='MAC address')
  741. #
  742. # Bulk device component creation
  743. #
  744. class DeviceBulkAddComponentForm(BootstrapMixin, forms.Form):
  745. pk = forms.ModelMultipleChoiceField(queryset=Device.objects.all(), widget=forms.MultipleHiddenInput)
  746. name_pattern = ExpandableNameField(label='Name')
  747. class DeviceBulkAddInterfaceForm(forms.ModelForm, DeviceBulkAddComponentForm):
  748. class Meta:
  749. model = Interface
  750. fields = ['pk', 'name_pattern', 'form_factor', 'mgmt_only', 'description']
  751. #
  752. # Console ports
  753. #
  754. class ConsolePortForm(BootstrapMixin, forms.ModelForm):
  755. class Meta:
  756. model = ConsolePort
  757. fields = ['device', 'name']
  758. widgets = {
  759. 'device': forms.HiddenInput(),
  760. }
  761. class ConsolePortCreateForm(DeviceComponentForm):
  762. name_pattern = ExpandableNameField(label='Name')
  763. class ConsoleConnectionCSVForm(forms.ModelForm):
  764. console_server = FlexibleModelChoiceField(
  765. queryset=Device.objects.filter(device_type__is_console_server=True),
  766. to_field_name='name',
  767. help_text='Console server name or PK',
  768. error_messages={
  769. 'invalid_choice': 'Console server not found',
  770. }
  771. )
  772. cs_port = forms.CharField(
  773. help_text='Console server port name'
  774. )
  775. device = FlexibleModelChoiceField(
  776. queryset=Device.objects.all(),
  777. to_field_name='name',
  778. help_text='Device name or PK',
  779. error_messages={
  780. 'invalid_choice': 'Device not found',
  781. }
  782. )
  783. console_port = forms.CharField(
  784. help_text='Console port name'
  785. )
  786. connection_status = CSVChoiceField(
  787. choices=CONNECTION_STATUS_CHOICES,
  788. help_text='Connection status'
  789. )
  790. class Meta:
  791. model = ConsolePort
  792. fields = ['console_server', 'cs_port', 'device', 'console_port', 'connection_status']
  793. def clean_console_port(self):
  794. console_port_name = self.cleaned_data.get('console_port')
  795. if not self.cleaned_data.get('device') or not console_port_name:
  796. return None
  797. try:
  798. # Retrieve console port by name
  799. consoleport = ConsolePort.objects.get(
  800. device=self.cleaned_data['device'], name=console_port_name
  801. )
  802. # Check if the console port is already connected
  803. if consoleport.cs_port is not None:
  804. raise forms.ValidationError("{} {} is already connected".format(
  805. self.cleaned_data['device'], console_port_name
  806. ))
  807. except ConsolePort.DoesNotExist:
  808. raise forms.ValidationError("Invalid console port ({} {})".format(
  809. self.cleaned_data['device'], console_port_name
  810. ))
  811. self.instance = consoleport
  812. return consoleport
  813. def clean_cs_port(self):
  814. cs_port_name = self.cleaned_data.get('cs_port')
  815. if not self.cleaned_data.get('console_server') or not cs_port_name:
  816. return None
  817. try:
  818. # Retrieve console server port by name
  819. cs_port = ConsoleServerPort.objects.get(
  820. device=self.cleaned_data['console_server'], name=cs_port_name
  821. )
  822. # Check if the console server port is already connected
  823. if ConsolePort.objects.filter(cs_port=cs_port).count():
  824. raise forms.ValidationError("{} {} is already connected".format(
  825. self.cleaned_data['console_server'], cs_port_name
  826. ))
  827. except ConsoleServerPort.DoesNotExist:
  828. raise forms.ValidationError("Invalid console server port ({} {})".format(
  829. self.cleaned_data['console_server'], cs_port_name
  830. ))
  831. return cs_port
  832. class ConsolePortConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.ModelForm):
  833. site = forms.ModelChoiceField(
  834. queryset=Site.objects.all(),
  835. required=False,
  836. widget=forms.Select(
  837. attrs={'filter-for': 'rack'}
  838. )
  839. )
  840. rack = ChainedModelChoiceField(
  841. queryset=Rack.objects.all(),
  842. chains=(
  843. ('site', 'site'),
  844. ),
  845. label='Rack',
  846. required=False,
  847. widget=APISelect(
  848. api_url='/api/dcim/racks/?site_id={{site}}',
  849. attrs={'filter-for': 'console_server', 'nullable': 'true'}
  850. )
  851. )
  852. console_server = ChainedModelChoiceField(
  853. queryset=Device.objects.filter(device_type__is_console_server=True),
  854. chains=(
  855. ('site', 'site'),
  856. ('rack', 'rack'),
  857. ),
  858. label='Console Server',
  859. required=False,
  860. widget=APISelect(
  861. api_url='/api/dcim/devices/?site_id={{site}}&rack_id={{rack}}&is_console_server=True',
  862. display_field='display_name',
  863. attrs={'filter-for': 'cs_port'}
  864. )
  865. )
  866. livesearch = forms.CharField(
  867. required=False,
  868. label='Console Server',
  869. widget=Livesearch(
  870. query_key='q',
  871. query_url='dcim-api:device-list',
  872. field_to_update='console_server',
  873. )
  874. )
  875. cs_port = ChainedModelChoiceField(
  876. queryset=ConsoleServerPort.objects.all(),
  877. chains=(
  878. ('device', 'console_server'),
  879. ),
  880. label='Port',
  881. widget=APISelect(
  882. api_url='/api/dcim/console-server-ports/?device_id={{console_server}}',
  883. disabled_indicator='connected_console',
  884. )
  885. )
  886. class Meta:
  887. model = ConsolePort
  888. fields = ['site', 'rack', 'console_server', 'livesearch', 'cs_port', 'connection_status']
  889. labels = {
  890. 'cs_port': 'Port',
  891. 'connection_status': 'Status',
  892. }
  893. def __init__(self, *args, **kwargs):
  894. super(ConsolePortConnectionForm, self).__init__(*args, **kwargs)
  895. if not self.instance.pk:
  896. raise RuntimeError("ConsolePortConnectionForm must be initialized with an existing ConsolePort instance.")
  897. #
  898. # Console server ports
  899. #
  900. class ConsoleServerPortForm(BootstrapMixin, forms.ModelForm):
  901. class Meta:
  902. model = ConsoleServerPort
  903. fields = ['device', 'name']
  904. widgets = {
  905. 'device': forms.HiddenInput(),
  906. }
  907. class ConsoleServerPortCreateForm(DeviceComponentForm):
  908. name_pattern = ExpandableNameField(label='Name')
  909. class ConsoleServerPortConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.Form):
  910. site = forms.ModelChoiceField(
  911. queryset=Site.objects.all(),
  912. required=False,
  913. widget=forms.Select(
  914. attrs={'filter-for': 'rack'}
  915. )
  916. )
  917. rack = ChainedModelChoiceField(
  918. queryset=Rack.objects.all(),
  919. chains=(
  920. ('site', 'site'),
  921. ),
  922. label='Rack',
  923. required=False,
  924. widget=APISelect(
  925. api_url='/api/dcim/racks/?site_id={{site}}',
  926. attrs={'filter-for': 'device', 'nullable': 'true'}
  927. )
  928. )
  929. device = ChainedModelChoiceField(
  930. queryset=Device.objects.all(),
  931. chains=(
  932. ('site', 'site'),
  933. ('rack', 'rack'),
  934. ),
  935. label='Device',
  936. required=False,
  937. widget=APISelect(
  938. api_url='/api/dcim/devices/?site_id={{site}}&rack_id={{rack}}',
  939. display_field='display_name',
  940. attrs={'filter-for': 'port'}
  941. )
  942. )
  943. livesearch = forms.CharField(
  944. required=False,
  945. label='Device',
  946. widget=Livesearch(
  947. query_key='q',
  948. query_url='dcim-api:device-list',
  949. field_to_update='device'
  950. )
  951. )
  952. port = ChainedModelChoiceField(
  953. queryset=ConsolePort.objects.all(),
  954. chains=(
  955. ('device', 'device'),
  956. ),
  957. label='Port',
  958. widget=APISelect(
  959. api_url='/api/dcim/console-ports/?device_id={{device}}',
  960. disabled_indicator='cs_port'
  961. )
  962. )
  963. connection_status = forms.BooleanField(
  964. required=False,
  965. initial=CONNECTION_STATUS_CONNECTED,
  966. label='Status',
  967. widget=forms.Select(
  968. choices=CONNECTION_STATUS_CHOICES
  969. )
  970. )
  971. class Meta:
  972. fields = ['site', 'rack', 'device', 'livesearch', 'port', 'connection_status']
  973. labels = {
  974. 'connection_status': 'Status',
  975. }
  976. #
  977. # Power ports
  978. #
  979. class PowerPortForm(BootstrapMixin, forms.ModelForm):
  980. class Meta:
  981. model = PowerPort
  982. fields = ['device', 'name']
  983. widgets = {
  984. 'device': forms.HiddenInput(),
  985. }
  986. class PowerPortCreateForm(DeviceComponentForm):
  987. name_pattern = ExpandableNameField(label='Name')
  988. class PowerConnectionCSVForm(forms.ModelForm):
  989. pdu = FlexibleModelChoiceField(
  990. queryset=Device.objects.filter(device_type__is_pdu=True),
  991. to_field_name='name',
  992. help_text='PDU name or PK',
  993. error_messages={
  994. 'invalid_choice': 'PDU not found.',
  995. }
  996. )
  997. power_outlet = forms.CharField(
  998. help_text='Power outlet name'
  999. )
  1000. device = FlexibleModelChoiceField(
  1001. queryset=Device.objects.all(),
  1002. to_field_name='name',
  1003. help_text='Device name or PK',
  1004. error_messages={
  1005. 'invalid_choice': 'Device not found',
  1006. }
  1007. )
  1008. power_port = forms.CharField(
  1009. help_text='Power port name'
  1010. )
  1011. connection_status = CSVChoiceField(
  1012. choices=CONNECTION_STATUS_CHOICES,
  1013. help_text='Connection status'
  1014. )
  1015. class Meta:
  1016. model = PowerPort
  1017. fields = ['pdu', 'power_outlet', 'device', 'power_port', 'connection_status']
  1018. def clean_power_port(self):
  1019. power_port_name = self.cleaned_data.get('power_port')
  1020. if not self.cleaned_data.get('device') or not power_port_name:
  1021. return None
  1022. try:
  1023. # Retrieve power port by name
  1024. powerport = PowerPort.objects.get(
  1025. device=self.cleaned_data['device'], name=power_port_name
  1026. )
  1027. # Check if the power port is already connected
  1028. if powerport.power_outlet is not None:
  1029. raise forms.ValidationError("{} {} is already connected".format(
  1030. self.cleaned_data['device'], power_port_name
  1031. ))
  1032. except PowerPort.DoesNotExist:
  1033. raise forms.ValidationError("Invalid power port ({} {})".format(
  1034. self.cleaned_data['device'], power_port_name
  1035. ))
  1036. self.instance = powerport
  1037. return powerport
  1038. def clean_power_outlet(self):
  1039. power_outlet_name = self.cleaned_data.get('power_outlet')
  1040. if not self.cleaned_data.get('pdu') or not power_outlet_name:
  1041. return None
  1042. try:
  1043. # Retrieve power outlet by name
  1044. power_outlet = PowerOutlet.objects.get(
  1045. device=self.cleaned_data['pdu'], name=power_outlet_name
  1046. )
  1047. # Check if the power outlet is already connected
  1048. if PowerPort.objects.filter(power_outlet=power_outlet).count():
  1049. raise forms.ValidationError("{} {} is already connected".format(
  1050. self.cleaned_data['pdu'], power_outlet_name
  1051. ))
  1052. except PowerOutlet.DoesNotExist:
  1053. raise forms.ValidationError("Invalid power outlet ({} {})".format(
  1054. self.cleaned_data['pdu'], power_outlet_name
  1055. ))
  1056. return power_outlet
  1057. class PowerPortConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.ModelForm):
  1058. site = forms.ModelChoiceField(
  1059. queryset=Site.objects.all(),
  1060. required=False,
  1061. widget=forms.Select(
  1062. attrs={'filter-for': 'rack'}
  1063. )
  1064. )
  1065. rack = ChainedModelChoiceField(
  1066. queryset=Rack.objects.all(),
  1067. chains=(
  1068. ('site', 'site'),
  1069. ),
  1070. label='Rack',
  1071. required=False,
  1072. widget=APISelect(
  1073. api_url='/api/dcim/racks/?site_id={{site}}',
  1074. attrs={'filter-for': 'pdu', 'nullable': 'true'}
  1075. )
  1076. )
  1077. pdu = ChainedModelChoiceField(
  1078. queryset=Device.objects.all(),
  1079. chains=(
  1080. ('site', 'site'),
  1081. ('rack', 'rack'),
  1082. ),
  1083. label='PDU',
  1084. required=False,
  1085. widget=APISelect(
  1086. api_url='/api/dcim/devices/?site_id={{site}}&rack_id={{rack}}&is_pdu=True',
  1087. display_field='display_name',
  1088. attrs={'filter-for': 'power_outlet'}
  1089. )
  1090. )
  1091. livesearch = forms.CharField(
  1092. required=False,
  1093. label='PDU',
  1094. widget=Livesearch(
  1095. query_key='q',
  1096. query_url='dcim-api:device-list',
  1097. field_to_update='pdu'
  1098. )
  1099. )
  1100. power_outlet = ChainedModelChoiceField(
  1101. queryset=PowerOutlet.objects.all(),
  1102. chains=(
  1103. ('device', 'pdu'),
  1104. ),
  1105. label='Outlet',
  1106. widget=APISelect(
  1107. api_url='/api/dcim/power-outlets/?device_id={{pdu}}',
  1108. disabled_indicator='connected_port'
  1109. )
  1110. )
  1111. class Meta:
  1112. model = PowerPort
  1113. fields = ['site', 'rack', 'pdu', 'livesearch', 'power_outlet', 'connection_status']
  1114. labels = {
  1115. 'power_outlet': 'Outlet',
  1116. 'connection_status': 'Status',
  1117. }
  1118. def __init__(self, *args, **kwargs):
  1119. super(PowerPortConnectionForm, self).__init__(*args, **kwargs)
  1120. if not self.instance.pk:
  1121. raise RuntimeError("PowerPortConnectionForm must be initialized with an existing PowerPort instance.")
  1122. #
  1123. # Power outlets
  1124. #
  1125. class PowerOutletForm(BootstrapMixin, forms.ModelForm):
  1126. class Meta:
  1127. model = PowerOutlet
  1128. fields = ['device', 'name']
  1129. widgets = {
  1130. 'device': forms.HiddenInput(),
  1131. }
  1132. class PowerOutletCreateForm(DeviceComponentForm):
  1133. name_pattern = ExpandableNameField(label='Name')
  1134. class PowerOutletConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.Form):
  1135. site = forms.ModelChoiceField(
  1136. queryset=Site.objects.all(),
  1137. required=False,
  1138. widget=forms.Select(
  1139. attrs={'filter-for': 'rack'}
  1140. )
  1141. )
  1142. rack = ChainedModelChoiceField(
  1143. queryset=Rack.objects.all(),
  1144. chains=(
  1145. ('site', 'site'),
  1146. ),
  1147. label='Rack',
  1148. required=False,
  1149. widget=APISelect(
  1150. api_url='/api/dcim/racks/?site_id={{site}}',
  1151. attrs={'filter-for': 'device', 'nullable': 'true'}
  1152. )
  1153. )
  1154. device = ChainedModelChoiceField(
  1155. queryset=Device.objects.all(),
  1156. chains=(
  1157. ('site', 'site'),
  1158. ('rack', 'rack'),
  1159. ),
  1160. label='Device',
  1161. required=False,
  1162. widget=APISelect(
  1163. api_url='/api/dcim/devices/?site_id={{site}}&rack_id={{rack}}',
  1164. display_field='display_name',
  1165. attrs={'filter-for': 'port'}
  1166. )
  1167. )
  1168. livesearch = forms.CharField(
  1169. required=False,
  1170. label='Device',
  1171. widget=Livesearch(
  1172. query_key='q',
  1173. query_url='dcim-api:device-list',
  1174. field_to_update='device'
  1175. )
  1176. )
  1177. port = ChainedModelChoiceField(
  1178. queryset=PowerPort.objects.all(),
  1179. chains=(
  1180. ('device', 'device'),
  1181. ),
  1182. label='Port',
  1183. widget=APISelect(
  1184. api_url='/api/dcim/power-ports/?device_id={{device}}',
  1185. disabled_indicator='power_outlet'
  1186. )
  1187. )
  1188. connection_status = forms.BooleanField(
  1189. required=False,
  1190. initial=CONNECTION_STATUS_CONNECTED,
  1191. label='Status',
  1192. widget=forms.Select(
  1193. choices=CONNECTION_STATUS_CHOICES
  1194. )
  1195. )
  1196. class Meta:
  1197. fields = ['site', 'rack', 'device', 'livesearch', 'port', 'connection_status']
  1198. labels = {
  1199. 'connection_status': 'Status',
  1200. }
  1201. #
  1202. # Interfaces
  1203. #
  1204. class InterfaceForm(BootstrapMixin, forms.ModelForm):
  1205. class Meta:
  1206. model = Interface
  1207. fields = ['device', 'name', 'form_factor', 'lag', 'mac_address', 'mgmt_only', 'description']
  1208. widgets = {
  1209. 'device': forms.HiddenInput(),
  1210. }
  1211. def __init__(self, *args, **kwargs):
  1212. super(InterfaceForm, self).__init__(*args, **kwargs)
  1213. # Limit LAG choices to interfaces belonging to this device
  1214. if self.is_bound:
  1215. self.fields['lag'].queryset = Interface.objects.order_naturally().filter(
  1216. device_id=self.data['device'], form_factor=IFACE_FF_LAG
  1217. )
  1218. else:
  1219. self.fields['lag'].queryset = Interface.objects.order_naturally().filter(
  1220. device=self.instance.device, form_factor=IFACE_FF_LAG
  1221. )
  1222. class InterfaceCreateForm(DeviceComponentForm):
  1223. name_pattern = ExpandableNameField(label='Name')
  1224. form_factor = forms.ChoiceField(choices=IFACE_FF_CHOICES)
  1225. lag = forms.ModelChoiceField(queryset=Interface.objects.all(), required=False, label='Parent LAG')
  1226. mac_address = MACAddressFormField(required=False, label='MAC Address')
  1227. mgmt_only = forms.BooleanField(required=False, label='OOB Management')
  1228. description = forms.CharField(max_length=100, required=False)
  1229. def __init__(self, *args, **kwargs):
  1230. super(InterfaceCreateForm, self).__init__(*args, **kwargs)
  1231. # Limit LAG choices to interfaces belonging to this device
  1232. if self.device is not None:
  1233. self.fields['lag'].queryset = Interface.objects.order_naturally().filter(
  1234. device=self.device, form_factor=IFACE_FF_LAG
  1235. )
  1236. else:
  1237. self.fields['lag'].queryset = Interface.objects.none()
  1238. class InterfaceBulkEditForm(BootstrapMixin, BulkEditForm):
  1239. pk = forms.ModelMultipleChoiceField(queryset=Interface.objects.all(), widget=forms.MultipleHiddenInput)
  1240. device = forms.ModelChoiceField(queryset=Device.objects.all(), widget=forms.HiddenInput)
  1241. lag = forms.ModelChoiceField(queryset=Interface.objects.all(), required=False, label='Parent LAG')
  1242. form_factor = forms.ChoiceField(choices=add_blank_choice(IFACE_FF_CHOICES), required=False)
  1243. mgmt_only = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Management only')
  1244. description = forms.CharField(max_length=100, required=False)
  1245. class Meta:
  1246. nullable_fields = ['lag', 'description']
  1247. def __init__(self, *args, **kwargs):
  1248. super(InterfaceBulkEditForm, self).__init__(*args, **kwargs)
  1249. # Limit LAG choices to interfaces which belong to the parent device.
  1250. device = None
  1251. if self.initial.get('device'):
  1252. try:
  1253. device = Device.objects.get(pk=self.initial.get('device'))
  1254. except Device.DoesNotExist:
  1255. pass
  1256. if device is not None:
  1257. interface_ordering = device.device_type.interface_ordering
  1258. self.fields['lag'].queryset = Interface.objects.order_naturally(method=interface_ordering).filter(
  1259. device=device, form_factor=IFACE_FF_LAG
  1260. )
  1261. else:
  1262. self.fields['lag'].choices = []
  1263. #
  1264. # Interface connections
  1265. #
  1266. class InterfaceConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.ModelForm):
  1267. interface_a = forms.ChoiceField(
  1268. choices=[],
  1269. widget=SelectWithDisabled,
  1270. label='Interface'
  1271. )
  1272. site_b = forms.ModelChoiceField(
  1273. queryset=Site.objects.all(),
  1274. label='Site',
  1275. required=False,
  1276. widget=forms.Select(
  1277. attrs={'filter-for': 'rack_b'}
  1278. )
  1279. )
  1280. rack_b = ChainedModelChoiceField(
  1281. queryset=Rack.objects.all(),
  1282. chains=(
  1283. ('site', 'site_b'),
  1284. ),
  1285. label='Rack',
  1286. required=False,
  1287. widget=APISelect(
  1288. api_url='/api/dcim/racks/?site_id={{site_b}}',
  1289. attrs={'filter-for': 'device_b', 'nullable': 'true'}
  1290. )
  1291. )
  1292. device_b = ChainedModelChoiceField(
  1293. queryset=Device.objects.all(),
  1294. chains=(
  1295. ('site', 'site_b'),
  1296. ('rack', 'rack_b'),
  1297. ),
  1298. label='Device',
  1299. required=False,
  1300. widget=APISelect(
  1301. api_url='/api/dcim/devices/?site_id={{site_b}}&rack_id={{rack_b}}',
  1302. display_field='display_name',
  1303. attrs={'filter-for': 'interface_b'}
  1304. )
  1305. )
  1306. livesearch = forms.CharField(
  1307. required=False,
  1308. label='Device',
  1309. widget=Livesearch(
  1310. query_key='q',
  1311. query_url='dcim-api:device-list',
  1312. field_to_update='device_b'
  1313. )
  1314. )
  1315. interface_b = ChainedModelChoiceField(
  1316. queryset=Interface.objects.exclude(form_factor__in=VIRTUAL_IFACE_TYPES).select_related(
  1317. 'circuit_termination', 'connected_as_a', 'connected_as_b'
  1318. ),
  1319. chains=(
  1320. ('device', 'device_b'),
  1321. ),
  1322. label='Interface',
  1323. widget=APISelect(
  1324. api_url='/api/dcim/interfaces/?device_id={{device_b}}&type=physical',
  1325. disabled_indicator='connection'
  1326. )
  1327. )
  1328. class Meta:
  1329. model = InterfaceConnection
  1330. fields = ['interface_a', 'site_b', 'rack_b', 'device_b', 'interface_b', 'livesearch', 'connection_status']
  1331. def __init__(self, device_a, *args, **kwargs):
  1332. super(InterfaceConnectionForm, self).__init__(*args, **kwargs)
  1333. # Initialize interface A choices
  1334. device_a_interfaces = Interface.objects.order_naturally().filter(device=device_a).exclude(
  1335. form_factor__in=VIRTUAL_IFACE_TYPES
  1336. ).select_related(
  1337. 'circuit_termination', 'connected_as_a', 'connected_as_b'
  1338. )
  1339. self.fields['interface_a'].choices = [
  1340. (iface.id, {'label': iface.name, 'disabled': iface.is_connected}) for iface in device_a_interfaces
  1341. ]
  1342. # Mark connected interfaces as disabled
  1343. self.fields['interface_b'].choices = [
  1344. (iface.id, {'label': iface.name, 'disabled': iface.is_connected}) for iface in self.fields['interface_b'].queryset
  1345. ]
  1346. class InterfaceConnectionCSVForm(forms.ModelForm):
  1347. device_a = FlexibleModelChoiceField(
  1348. queryset=Device.objects.all(),
  1349. to_field_name='name',
  1350. help_text='Device name or PK',
  1351. error_messages={'invalid_choice': 'Device A not found.'}
  1352. )
  1353. interface_a = forms.CharField(
  1354. help_text='Interface name'
  1355. )
  1356. device_b = FlexibleModelChoiceField(
  1357. queryset=Device.objects.all(),
  1358. to_field_name='name',
  1359. help_text='Device name or PK',
  1360. error_messages={'invalid_choice': 'Device B not found.'}
  1361. )
  1362. interface_b = forms.CharField(
  1363. help_text='Interface name'
  1364. )
  1365. connection_status = CSVChoiceField(
  1366. choices=CONNECTION_STATUS_CHOICES,
  1367. help_text='Connection status'
  1368. )
  1369. class Meta:
  1370. model = InterfaceConnection
  1371. fields = ['device_a', 'interface_a', 'device_b', 'interface_b', 'connection_status']
  1372. def clean_interface_a(self):
  1373. interface_name = self.cleaned_data.get('interface_a')
  1374. if not interface_name:
  1375. return None
  1376. try:
  1377. # Retrieve interface by name
  1378. interface = Interface.objects.get(
  1379. device=self.cleaned_data['device_a'], name=interface_name
  1380. )
  1381. # Check for an existing connection to this interface
  1382. if InterfaceConnection.objects.filter(Q(interface_a=interface) | Q(interface_b=interface)).count():
  1383. raise forms.ValidationError("{} {} is already connected".format(
  1384. self.cleaned_data['device_a'], interface_name
  1385. ))
  1386. except Interface.DoesNotExist:
  1387. raise forms.ValidationError("Invalid interface ({} {})".format(
  1388. self.cleaned_data['device_a'], interface_name
  1389. ))
  1390. return interface
  1391. def clean_interface_b(self):
  1392. interface_name = self.cleaned_data.get('interface_b')
  1393. if not interface_name:
  1394. return None
  1395. try:
  1396. # Retrieve interface by name
  1397. interface = Interface.objects.get(
  1398. device=self.cleaned_data['device_b'], name=interface_name
  1399. )
  1400. # Check for an existing connection to this interface
  1401. if InterfaceConnection.objects.filter(Q(interface_a=interface) | Q(interface_b=interface)).count():
  1402. raise forms.ValidationError("{} {} is already connected".format(
  1403. self.cleaned_data['device_b'], interface_name
  1404. ))
  1405. except Interface.DoesNotExist:
  1406. raise forms.ValidationError("Invalid interface ({} {})".format(
  1407. self.cleaned_data['device_b'], interface_name
  1408. ))
  1409. return interface
  1410. def clean_connection_status(self):
  1411. return True if self.cleaned_data['connection_status'] == 'connected' else False
  1412. class InterfaceConnectionDeletionForm(BootstrapMixin, forms.Form):
  1413. confirm = forms.BooleanField(required=True)
  1414. # Used for HTTP redirect upon successful deletion
  1415. device = forms.ModelChoiceField(queryset=Device.objects.all(), widget=forms.HiddenInput(), required=False)
  1416. #
  1417. # Device bays
  1418. #
  1419. class DeviceBayForm(BootstrapMixin, forms.ModelForm):
  1420. class Meta:
  1421. model = DeviceBay
  1422. fields = ['device', 'name']
  1423. widgets = {
  1424. 'device': forms.HiddenInput(),
  1425. }
  1426. class DeviceBayCreateForm(DeviceComponentForm):
  1427. name_pattern = ExpandableNameField(label='Name')
  1428. class PopulateDeviceBayForm(BootstrapMixin, forms.Form):
  1429. installed_device = forms.ModelChoiceField(
  1430. queryset=Device.objects.all(),
  1431. label='Child Device',
  1432. help_text="Child devices must first be created and assigned to the site/rack of the parent device."
  1433. )
  1434. def __init__(self, device_bay, *args, **kwargs):
  1435. super(PopulateDeviceBayForm, self).__init__(*args, **kwargs)
  1436. self.fields['installed_device'].queryset = Device.objects.filter(
  1437. site=device_bay.device.site,
  1438. rack=device_bay.device.rack,
  1439. parent_bay__isnull=True,
  1440. device_type__u_height=0,
  1441. device_type__subdevice_role=SUBDEVICE_ROLE_CHILD
  1442. ).exclude(pk=device_bay.device.pk)
  1443. #
  1444. # Connections
  1445. #
  1446. class ConsoleConnectionFilterForm(BootstrapMixin, forms.Form):
  1447. site = forms.ModelChoiceField(required=False, queryset=Site.objects.all(), to_field_name='slug')
  1448. device = forms.CharField(required=False, label='Device name')
  1449. class PowerConnectionFilterForm(BootstrapMixin, forms.Form):
  1450. site = forms.ModelChoiceField(required=False, queryset=Site.objects.all(), to_field_name='slug')
  1451. device = forms.CharField(required=False, label='Device name')
  1452. class InterfaceConnectionFilterForm(BootstrapMixin, forms.Form):
  1453. site = forms.ModelChoiceField(required=False, queryset=Site.objects.all(), to_field_name='slug')
  1454. device = forms.CharField(required=False, label='Device name')
  1455. #
  1456. # Inventory items
  1457. #
  1458. class InventoryItemForm(BootstrapMixin, forms.ModelForm):
  1459. class Meta:
  1460. model = InventoryItem
  1461. fields = ['name', 'manufacturer', 'part_id', 'serial']