forms.py 58 KB

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