forms.py 57 KB

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