forms.py 56 KB

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