forms.py 60 KB

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