forms.py 56 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338
  1. import re
  2. from django import forms
  3. from django.core.exceptions import ValidationError
  4. from django.db.models import Count, Q
  5. from extras.forms import CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFilterForm
  6. from ipam.models import IPAddress
  7. from tenancy.models import Tenant
  8. from utilities.forms import (
  9. APISelect, add_blank_choice, BootstrapMixin, BulkEditForm, BulkImportForm, CommentField, CSVDataField,
  10. ExpandableNameField, FilterChoiceField, FlexibleModelChoiceField, Livesearch, SelectWithDisabled, SmallTextarea,
  11. SlugField,
  12. )
  13. from formfields import MACAddressFormField
  14. from .models import (
  15. DeviceBay, DeviceBayTemplate, CONNECTION_STATUS_CHOICES, CONNECTION_STATUS_PLANNED, CONNECTION_STATUS_CONNECTED,
  16. ConsolePort, ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate, Device, DeviceRole, DeviceType,
  17. Interface, IFACE_FF_CHOICES, IFACE_FF_VIRTUAL, InterfaceConnection, InterfaceTemplate, Manufacturer, Module,
  18. Platform, PowerOutlet, PowerOutletTemplate, PowerPort, PowerPortTemplate, RACK_TYPE_CHOICES, RACK_WIDTH_CHOICES,
  19. Rack, RackGroup, RackRole, Site, STATUS_CHOICES, SUBDEVICE_ROLE_CHILD
  20. )
  21. FORM_STATUS_CHOICES = [
  22. ['', '---------'],
  23. ]
  24. FORM_STATUS_CHOICES += STATUS_CHOICES
  25. DEVICE_BY_PK_RE = '{\d+\}'
  26. def get_device_by_name_or_pk(name):
  27. """
  28. Attempt to retrieve a device by either its name or primary key ('{pk}').
  29. """
  30. if re.match(DEVICE_BY_PK_RE, name):
  31. pk = name.strip('{}')
  32. device = Device.objects.get(pk=pk)
  33. else:
  34. device = Device.objects.get(name=name)
  35. return device
  36. def validate_connection_status(value):
  37. """
  38. Custom validator for connection statuses. value must be either "planned" or "connected" (case-insensitive).
  39. """
  40. if value.lower() not in ['planned', 'connected']:
  41. raise ValidationError('Invalid connection status ({}); must be either "planned" or "connected".'.format(value))
  42. #
  43. # Sites
  44. #
  45. class SiteForm(BootstrapMixin, CustomFieldForm):
  46. slug = SlugField()
  47. comments = CommentField()
  48. class Meta:
  49. model = Site
  50. fields = ['name', 'slug', 'tenant', 'facility', 'asn', 'physical_address', 'shipping_address', 'contact_name',
  51. 'contact_phone', 'contact_email', 'comments']
  52. widgets = {
  53. 'physical_address': SmallTextarea(attrs={'rows': 3}),
  54. 'shipping_address': SmallTextarea(attrs={'rows': 3}),
  55. }
  56. help_texts = {
  57. 'name': "Full name of the site",
  58. 'facility': "Data center provider and facility (e.g. Equinix NY7)",
  59. 'asn': "BGP autonomous system number",
  60. 'physical_address': "Physical location of the building (e.g. for GPS)",
  61. 'shipping_address': "If different from the physical address"
  62. }
  63. class SiteFromCSVForm(forms.ModelForm):
  64. tenant = forms.ModelChoiceField(Tenant.objects.all(), to_field_name='name', required=False,
  65. error_messages={'invalid_choice': 'Tenant not found.'})
  66. class Meta:
  67. model = Site
  68. fields = ['name', 'slug', 'tenant', 'facility', 'asn', 'contact_name', 'contact_phone', 'contact_email']
  69. class SiteImportForm(BootstrapMixin, BulkImportForm):
  70. csv = CSVDataField(csv_form=SiteFromCSVForm)
  71. class SiteBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  72. pk = forms.ModelMultipleChoiceField(queryset=Site.objects.all(), widget=forms.MultipleHiddenInput)
  73. tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
  74. asn = forms.IntegerField(min_value=1, max_value=4294967295, required=False, label='ASN')
  75. class Meta:
  76. nullable_fields = ['tenant', 'asn']
  77. class SiteFilterForm(BootstrapMixin, CustomFieldFilterForm):
  78. model = Site
  79. tenant = FilterChoiceField(queryset=Tenant.objects.annotate(filter_count=Count('sites')), to_field_name='slug',
  80. null_option=(0, 'None'))
  81. #
  82. # Rack groups
  83. #
  84. class RackGroupForm(BootstrapMixin, forms.ModelForm):
  85. slug = SlugField()
  86. class Meta:
  87. model = RackGroup
  88. fields = ['site', 'name', 'slug']
  89. class RackGroupFilterForm(BootstrapMixin, forms.Form):
  90. site = FilterChoiceField(queryset=Site.objects.annotate(filter_count=Count('rack_groups')), to_field_name='slug')
  91. #
  92. # Rack roles
  93. #
  94. class RackRoleForm(BootstrapMixin, forms.ModelForm):
  95. slug = SlugField()
  96. class Meta:
  97. model = RackRole
  98. fields = ['name', 'slug', 'color']
  99. #
  100. # Racks
  101. #
  102. class RackForm(BootstrapMixin, CustomFieldForm):
  103. group = forms.ModelChoiceField(queryset=RackGroup.objects.all(), required=False, label='Group', widget=APISelect(
  104. api_url='/api/dcim/rack-groups/?site_id={{site}}',
  105. ))
  106. comments = CommentField()
  107. class Meta:
  108. model = Rack
  109. fields = ['site', 'group', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height', 'desc_units',
  110. 'comments']
  111. help_texts = {
  112. 'site': "The site at which the rack exists",
  113. 'name': "Organizational rack name",
  114. 'facility_id': "The unique rack ID assigned by the facility",
  115. 'u_height': "Height in rack units",
  116. }
  117. widgets = {
  118. 'site': forms.Select(attrs={'filter-for': 'group'}),
  119. }
  120. def __init__(self, *args, **kwargs):
  121. super(RackForm, self).__init__(*args, **kwargs)
  122. # Limit rack group choices
  123. if self.is_bound and self.data.get('site'):
  124. self.fields['group'].queryset = RackGroup.objects.filter(site__pk=self.data['site'])
  125. elif self.initial.get('site'):
  126. self.fields['group'].queryset = RackGroup.objects.filter(site=self.initial['site'])
  127. else:
  128. self.fields['group'].choices = []
  129. class RackFromCSVForm(forms.ModelForm):
  130. site = forms.ModelChoiceField(queryset=Site.objects.all(), to_field_name='name',
  131. error_messages={'invalid_choice': 'Site not found.'})
  132. group_name = forms.CharField(required=False)
  133. tenant = forms.ModelChoiceField(Tenant.objects.all(), to_field_name='name', required=False,
  134. error_messages={'invalid_choice': 'Tenant not found.'})
  135. role = forms.ModelChoiceField(RackRole.objects.all(), to_field_name='name', required=False,
  136. error_messages={'invalid_choice': 'Role not found.'})
  137. type = forms.CharField(required=False)
  138. class Meta:
  139. model = Rack
  140. fields = ['site', 'group_name', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height',
  141. 'desc_units']
  142. def clean(self):
  143. site = self.cleaned_data.get('site')
  144. group = self.cleaned_data.get('group_name')
  145. # Validate rack group
  146. if site and group:
  147. try:
  148. self.instance.group = RackGroup.objects.get(site=site, name=group)
  149. except RackGroup.DoesNotExist:
  150. self.add_error('group_name', "Invalid rack group ({})".format(group))
  151. def clean_type(self):
  152. rack_type = self.cleaned_data['type']
  153. if not rack_type:
  154. return None
  155. try:
  156. choices = {v.lower(): k for k, v in RACK_TYPE_CHOICES}
  157. return choices[rack_type.lower()]
  158. except KeyError:
  159. raise forms.ValidationError('Invalid rack type ({}). Valid choices are: {}.'.format(
  160. rack_type,
  161. ', '.join({v: k for k, v in RACK_TYPE_CHOICES}),
  162. ))
  163. class RackImportForm(BootstrapMixin, BulkImportForm):
  164. csv = CSVDataField(csv_form=RackFromCSVForm)
  165. class RackBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  166. pk = forms.ModelMultipleChoiceField(queryset=Rack.objects.all(), widget=forms.MultipleHiddenInput)
  167. site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False, label='Site')
  168. group = forms.ModelChoiceField(queryset=RackGroup.objects.all(), required=False, label='Group')
  169. tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
  170. role = forms.ModelChoiceField(queryset=RackRole.objects.all(), required=False)
  171. type = forms.ChoiceField(choices=add_blank_choice(RACK_TYPE_CHOICES), required=False, label='Type')
  172. width = forms.ChoiceField(choices=add_blank_choice(RACK_WIDTH_CHOICES), required=False, label='Width')
  173. u_height = forms.IntegerField(required=False, label='Height (U)')
  174. comments = CommentField(widget=SmallTextarea)
  175. class Meta:
  176. nullable_fields = ['group', 'tenant', 'role', 'comments']
  177. class RackFilterForm(BootstrapMixin, CustomFieldFilterForm):
  178. model = Rack
  179. site = FilterChoiceField(queryset=Site.objects.annotate(filter_count=Count('racks')), to_field_name='slug')
  180. group_id = FilterChoiceField(queryset=RackGroup.objects.select_related('site')
  181. .annotate(filter_count=Count('racks')), label='Rack group', null_option=(0, 'None'))
  182. tenant = FilterChoiceField(queryset=Tenant.objects.annotate(filter_count=Count('racks')), to_field_name='slug',
  183. null_option=(0, 'None'))
  184. role = FilterChoiceField(queryset=RackRole.objects.annotate(filter_count=Count('racks')), to_field_name='slug',
  185. null_option=(0, 'None'))
  186. #
  187. # Manufacturers
  188. #
  189. class ManufacturerForm(BootstrapMixin, forms.ModelForm):
  190. slug = SlugField()
  191. class Meta:
  192. model = Manufacturer
  193. fields = ['name', 'slug']
  194. #
  195. # Device types
  196. #
  197. class DeviceTypeForm(BootstrapMixin, CustomFieldForm):
  198. slug = SlugField(slug_source='model')
  199. class Meta:
  200. model = DeviceType
  201. fields = ['manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth', 'is_console_server',
  202. 'is_pdu', 'is_network_device', 'subdevice_role', 'comments']
  203. class DeviceTypeBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  204. pk = forms.ModelMultipleChoiceField(queryset=DeviceType.objects.all(), widget=forms.MultipleHiddenInput)
  205. manufacturer = forms.ModelChoiceField(queryset=Manufacturer.objects.all(), required=False)
  206. u_height = forms.IntegerField(min_value=1, required=False)
  207. class Meta:
  208. nullable_fields = []
  209. class DeviceTypeFilterForm(BootstrapMixin, CustomFieldFilterForm):
  210. model = DeviceType
  211. manufacturer = FilterChoiceField(queryset=Manufacturer.objects.annotate(filter_count=Count('device_types')),
  212. to_field_name='slug')
  213. #
  214. # Device component templates
  215. #
  216. class ConsolePortTemplateForm(BootstrapMixin, forms.ModelForm):
  217. class Meta:
  218. model = ConsolePortTemplate
  219. fields = ['device_type', 'name']
  220. widgets = {
  221. 'device_type': forms.HiddenInput(),
  222. }
  223. class ConsolePortTemplateCreateForm(BootstrapMixin, forms.Form):
  224. name_pattern = ExpandableNameField(label='Name')
  225. class ConsoleServerPortTemplateForm(BootstrapMixin, forms.ModelForm):
  226. class Meta:
  227. model = ConsoleServerPortTemplate
  228. fields = ['device_type', 'name']
  229. widgets = {
  230. 'device_type': forms.HiddenInput(),
  231. }
  232. class ConsoleServerPortTemplateCreateForm(BootstrapMixin, forms.Form):
  233. name_pattern = ExpandableNameField(label='Name')
  234. class PowerPortTemplateForm(BootstrapMixin, forms.ModelForm):
  235. class Meta:
  236. model = PowerPortTemplate
  237. fields = ['device_type', 'name']
  238. widgets = {
  239. 'device_type': forms.HiddenInput(),
  240. }
  241. class PowerPortTemplateCreateForm(BootstrapMixin, forms.Form):
  242. name_pattern = ExpandableNameField(label='Name')
  243. class PowerOutletTemplateForm(BootstrapMixin, forms.ModelForm):
  244. class Meta:
  245. model = PowerOutletTemplate
  246. fields = ['device_type', 'name']
  247. widgets = {
  248. 'device_type': forms.HiddenInput(),
  249. }
  250. class PowerOutletTemplateCreateForm(BootstrapMixin, forms.Form):
  251. name_pattern = ExpandableNameField(label='Name')
  252. class InterfaceTemplateForm(BootstrapMixin, forms.ModelForm):
  253. class Meta:
  254. model = InterfaceTemplate
  255. fields = ['device_type', 'name', 'form_factor', 'mgmt_only']
  256. widgets = {
  257. 'device_type': forms.HiddenInput(),
  258. }
  259. class InterfaceTemplateCreateForm(BootstrapMixin, forms.Form):
  260. name_pattern = ExpandableNameField(label='Name')
  261. form_factor = forms.ChoiceField(choices=IFACE_FF_CHOICES)
  262. mgmt_only = forms.BooleanField(required=False, label='OOB Management')
  263. class InterfaceTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
  264. pk = forms.ModelMultipleChoiceField(queryset=InterfaceTemplate.objects.all(), widget=forms.MultipleHiddenInput)
  265. form_factor = forms.ChoiceField(choices=add_blank_choice(IFACE_FF_CHOICES), required=False)
  266. class Meta:
  267. nullable_fields = []
  268. class DeviceBayTemplateForm(BootstrapMixin, forms.ModelForm):
  269. class Meta:
  270. model = DeviceBayTemplate
  271. fields = ['device_type', 'name']
  272. widgets = {
  273. 'device_type': forms.HiddenInput(),
  274. }
  275. class DeviceBayTemplateCreateForm(BootstrapMixin, forms.Form):
  276. name_pattern = ExpandableNameField(label='Name')
  277. #
  278. # Device roles
  279. #
  280. class DeviceRoleForm(BootstrapMixin, forms.ModelForm):
  281. slug = SlugField()
  282. class Meta:
  283. model = DeviceRole
  284. fields = ['name', 'slug', 'color']
  285. #
  286. # Platforms
  287. #
  288. class PlatformForm(BootstrapMixin, forms.ModelForm):
  289. slug = SlugField()
  290. class Meta:
  291. model = Platform
  292. fields = ['name', 'slug']
  293. #
  294. # Devices
  295. #
  296. class DeviceForm(BootstrapMixin, CustomFieldForm):
  297. site = forms.ModelChoiceField(queryset=Site.objects.all(), widget=forms.Select(attrs={'filter-for': 'rack'}))
  298. rack = forms.ModelChoiceField(queryset=Rack.objects.all(), widget=APISelect(
  299. api_url='/api/dcim/racks/?site_id={{site}}',
  300. display_field='display_name',
  301. attrs={'filter-for': 'position'}
  302. ))
  303. position = forms.TypedChoiceField(required=False, empty_value=None,
  304. help_text="The lowest-numbered unit occupied by the device",
  305. widget=APISelect(api_url='/api/dcim/racks/{{rack}}/rack-units/?face={{face}}',
  306. disabled_indicator='device'))
  307. manufacturer = forms.ModelChoiceField(queryset=Manufacturer.objects.all(),
  308. widget=forms.Select(attrs={'filter-for': 'device_type'}))
  309. device_type = forms.ModelChoiceField(queryset=DeviceType.objects.all(), label='Device type', widget=APISelect(
  310. api_url='/api/dcim/device-types/?manufacturer_id={{manufacturer}}',
  311. display_field='model'
  312. ))
  313. comments = CommentField()
  314. class Meta:
  315. model = Device
  316. fields = ['name', 'device_role', 'tenant', 'device_type', 'serial', 'asset_tag', 'site', 'rack', 'position',
  317. 'face', 'status', 'platform', 'primary_ip4', 'primary_ip6', 'comments']
  318. help_texts = {
  319. 'device_role': "The function this device serves",
  320. 'serial': "Chassis serial number",
  321. }
  322. widgets = {
  323. 'face': forms.Select(attrs={'filter-for': 'position'}),
  324. 'manufacturer': forms.Select(attrs={'filter-for': 'device_type'}),
  325. }
  326. def __init__(self, *args, **kwargs):
  327. super(DeviceForm, self).__init__(*args, **kwargs)
  328. if self.instance.pk:
  329. # Initialize helper selections
  330. self.initial['site'] = self.instance.rack.site
  331. self.initial['manufacturer'] = self.instance.device_type.manufacturer
  332. # Compile list of choices for primary IPv4 and IPv6 addresses
  333. for family in [4, 6]:
  334. ip_choices = []
  335. interface_ips = IPAddress.objects.filter(family=family, interface__device=self.instance)
  336. ip_choices += [(ip.id, u'{} ({})'.format(ip.address, ip.interface)) for ip in interface_ips]
  337. nat_ips = IPAddress.objects.filter(family=family, nat_inside__interface__device=self.instance)\
  338. .select_related('nat_inside__interface')
  339. ip_choices += [(ip.id, u'{} ({} NAT)'.format(ip.address, ip.nat_inside.interface)) for ip in nat_ips]
  340. self.fields['primary_ip{}'.format(family)].choices = [(None, '---------')] + ip_choices
  341. # If editing an existing device, exclude it from the list of occupied rack units. This ensures that a device
  342. # can be flipped from one face to another.
  343. self.fields['position'].widget.attrs['api-url'] += '&exclude={}'.format(self.instance.pk)
  344. else:
  345. # An object that doesn't exist yet can't have any IPs assigned to it
  346. self.fields['primary_ip4'].choices = []
  347. self.fields['primary_ip4'].widget.attrs['readonly'] = True
  348. self.fields['primary_ip6'].choices = []
  349. self.fields['primary_ip6'].widget.attrs['readonly'] = True
  350. # Limit rack choices
  351. if self.is_bound and self.data.get('site'):
  352. self.fields['rack'].queryset = Rack.objects.filter(site__pk=self.data['site'])
  353. elif self.initial.get('site'):
  354. self.fields['rack'].queryset = Rack.objects.filter(site=self.initial['site'])
  355. else:
  356. self.fields['rack'].choices = []
  357. # Rack position
  358. pk = self.instance.pk if self.instance.pk else None
  359. try:
  360. if self.is_bound and self.data.get('rack') and str(self.data.get('face')):
  361. position_choices = Rack.objects.get(pk=self.data['rack'])\
  362. .get_rack_units(face=self.data.get('face'), exclude=pk)
  363. elif self.initial.get('rack') and str(self.initial.get('face')):
  364. position_choices = Rack.objects.get(pk=self.initial['rack'])\
  365. .get_rack_units(face=self.initial.get('face'), exclude=pk)
  366. else:
  367. position_choices = []
  368. except Rack.DoesNotExist:
  369. position_choices = []
  370. self.fields['position'].choices = [('', '---------')] + [
  371. (p['id'], {
  372. 'label': p['name'],
  373. 'disabled': bool(p['device'] and p['id'] != self.initial.get('position')),
  374. }) for p in position_choices
  375. ]
  376. # Limit device_type choices
  377. if self.is_bound:
  378. self.fields['device_type'].queryset = DeviceType.objects.filter(manufacturer__pk=self.data['manufacturer'])\
  379. .select_related('manufacturer')
  380. elif self.initial.get('manufacturer'):
  381. self.fields['device_type'].queryset = DeviceType.objects.filter(manufacturer=self.initial['manufacturer'])\
  382. .select_related('manufacturer')
  383. else:
  384. self.fields['device_type'].choices = []
  385. # Disable rack assignment if this is a child device installed in a parent device
  386. if pk and self.instance.device_type.is_child_device and hasattr(self.instance, 'parent_bay'):
  387. self.fields['site'].disabled = True
  388. self.fields['rack'].disabled = True
  389. self.initial['site'] = self.instance.parent_bay.device.rack.site_id
  390. self.initial['rack'] = self.instance.parent_bay.device.rack_id
  391. class BaseDeviceFromCSVForm(forms.ModelForm):
  392. device_role = forms.ModelChoiceField(queryset=DeviceRole.objects.all(), to_field_name='name',
  393. error_messages={'invalid_choice': 'Invalid device role.'})
  394. tenant = forms.ModelChoiceField(Tenant.objects.all(), to_field_name='name', required=False,
  395. error_messages={'invalid_choice': 'Tenant not found.'})
  396. manufacturer = forms.ModelChoiceField(queryset=Manufacturer.objects.all(), to_field_name='name',
  397. error_messages={'invalid_choice': 'Invalid manufacturer.'})
  398. model_name = forms.CharField()
  399. platform = forms.ModelChoiceField(queryset=Platform.objects.all(), required=False, to_field_name='name',
  400. error_messages={'invalid_choice': 'Invalid platform.'})
  401. class Meta:
  402. fields = []
  403. model = Device
  404. def clean(self):
  405. manufacturer = self.cleaned_data.get('manufacturer')
  406. model_name = self.cleaned_data.get('model_name')
  407. # Validate device type
  408. if manufacturer and model_name:
  409. try:
  410. self.instance.device_type = DeviceType.objects.get(manufacturer=manufacturer, model=model_name)
  411. except DeviceType.DoesNotExist:
  412. self.add_error('model_name', "Invalid device type ({} {})".format(manufacturer, model_name))
  413. class DeviceFromCSVForm(BaseDeviceFromCSVForm):
  414. site = forms.ModelChoiceField(queryset=Site.objects.all(), to_field_name='name', error_messages={
  415. 'invalid_choice': 'Invalid site name.',
  416. })
  417. rack_name = forms.CharField()
  418. face = forms.CharField(required=False)
  419. class Meta(BaseDeviceFromCSVForm.Meta):
  420. fields = ['name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag',
  421. 'site', 'rack_name', 'position', 'face']
  422. def clean(self):
  423. super(DeviceFromCSVForm, self).clean()
  424. site = self.cleaned_data.get('site')
  425. rack_name = self.cleaned_data.get('rack_name')
  426. # Validate rack
  427. if site and rack_name:
  428. try:
  429. self.instance.rack = Rack.objects.get(site=site, name=rack_name)
  430. except Rack.DoesNotExist:
  431. self.add_error('rack_name', "Invalid rack ({})".format(rack_name))
  432. def clean_face(self):
  433. face = self.cleaned_data['face']
  434. if not face:
  435. return None
  436. try:
  437. return {
  438. 'front': 0,
  439. 'rear': 1,
  440. }[face.lower()]
  441. except KeyError:
  442. raise forms.ValidationError('Invalid rack face ({}); must be "front" or "rear".'.format(face))
  443. class ChildDeviceFromCSVForm(BaseDeviceFromCSVForm):
  444. parent = FlexibleModelChoiceField(queryset=Device.objects.all(), to_field_name='name', required=False,
  445. error_messages={'invalid_choice': 'Parent device not found.'})
  446. device_bay_name = forms.CharField(required=False)
  447. class Meta(BaseDeviceFromCSVForm.Meta):
  448. fields = ['name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag',
  449. 'parent', 'device_bay_name']
  450. def clean(self):
  451. super(ChildDeviceFromCSVForm, self).clean()
  452. parent = self.cleaned_data.get('parent')
  453. device_bay_name = self.cleaned_data.get('device_bay_name')
  454. # Validate device bay
  455. if parent and device_bay_name:
  456. try:
  457. device_bay = DeviceBay.objects.get(device=parent, name=device_bay_name)
  458. if device_bay.installed_device:
  459. self.add_error('device_bay_name',
  460. "Device bay ({} {}) is already occupied".format(parent, device_bay_name))
  461. else:
  462. self.instance.parent_bay = device_bay
  463. except DeviceBay.DoesNotExist:
  464. self.add_error('device_bay_name', "Parent device/bay ({} {}) not found".format(parent, device_bay_name))
  465. class DeviceImportForm(BootstrapMixin, BulkImportForm):
  466. csv = CSVDataField(csv_form=DeviceFromCSVForm)
  467. class ChildDeviceImportForm(BootstrapMixin, BulkImportForm):
  468. csv = CSVDataField(csv_form=ChildDeviceFromCSVForm)
  469. class DeviceBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  470. pk = forms.ModelMultipleChoiceField(queryset=Device.objects.all(), widget=forms.MultipleHiddenInput)
  471. device_type = forms.ModelChoiceField(queryset=DeviceType.objects.all(), required=False, label='Type')
  472. device_role = forms.ModelChoiceField(queryset=DeviceRole.objects.all(), required=False, label='Role')
  473. tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
  474. platform = forms.ModelChoiceField(queryset=Platform.objects.all(), required=False)
  475. status = forms.ChoiceField(choices=FORM_STATUS_CHOICES, required=False, initial='', label='Status')
  476. serial = forms.CharField(max_length=50, required=False, label='Serial Number')
  477. class Meta:
  478. nullable_fields = ['tenant', 'platform']
  479. class DeviceFilterForm(BootstrapMixin, CustomFieldFilterForm):
  480. model = Device
  481. site = FilterChoiceField(queryset=Site.objects.annotate(filter_count=Count('racks__devices')), to_field_name='slug')
  482. rack_group_id = FilterChoiceField(queryset=RackGroup.objects.annotate(filter_count=Count('racks__devices')),
  483. label='Rack Group')
  484. role = FilterChoiceField(queryset=DeviceRole.objects.annotate(filter_count=Count('devices')), to_field_name='slug')
  485. tenant = FilterChoiceField(queryset=Tenant.objects.annotate(filter_count=Count('devices')), to_field_name='slug',
  486. null_option=(0, 'None'))
  487. device_type_id = FilterChoiceField(queryset=DeviceType.objects.select_related('manufacturer')
  488. .annotate(filter_count=Count('instances')), label='Type')
  489. platform = FilterChoiceField(queryset=Platform.objects.annotate(filter_count=Count('devices')),
  490. to_field_name='slug', null_option=(0, 'None'))
  491. status = forms.NullBooleanField(required=False, widget=forms.Select(choices=FORM_STATUS_CHOICES))
  492. mac_address = forms.CharField(required=False, label='MAC address')
  493. #
  494. # Bulk device component creation
  495. #
  496. class DeviceBulkAddComponentForm(BootstrapMixin, forms.Form):
  497. pk = forms.ModelMultipleChoiceField(queryset=Device.objects.all(), widget=forms.MultipleHiddenInput)
  498. name_pattern = ExpandableNameField(label='Name')
  499. class DeviceBulkAddInterfaceForm(forms.ModelForm, DeviceBulkAddComponentForm):
  500. class Meta:
  501. model = Interface
  502. fields = ['pk', 'name_pattern', 'form_factor', 'mgmt_only', 'description']
  503. #
  504. # Console ports
  505. #
  506. class ConsolePortForm(BootstrapMixin, forms.ModelForm):
  507. class Meta:
  508. model = ConsolePort
  509. fields = ['device', 'name']
  510. widgets = {
  511. 'device': forms.HiddenInput(),
  512. }
  513. class ConsolePortCreateForm(BootstrapMixin, forms.Form):
  514. name_pattern = ExpandableNameField(label='Name')
  515. class ConsoleConnectionCSVForm(forms.Form):
  516. console_server = FlexibleModelChoiceField(queryset=Device.objects.filter(device_type__is_console_server=True),
  517. to_field_name='name',
  518. error_messages={'invalid_choice': 'Console server not found'})
  519. cs_port = forms.CharField()
  520. device = FlexibleModelChoiceField(queryset=Device.objects.all(), to_field_name='name',
  521. error_messages={'invalid_choice': 'Device not found'})
  522. console_port = forms.CharField()
  523. status = forms.CharField(validators=[validate_connection_status])
  524. def clean(self):
  525. # Validate console server port
  526. if self.cleaned_data.get('console_server'):
  527. try:
  528. cs_port = ConsoleServerPort.objects.get(device=self.cleaned_data['console_server'],
  529. name=self.cleaned_data['cs_port'])
  530. if ConsolePort.objects.filter(cs_port=cs_port):
  531. raise forms.ValidationError("Console server port is already occupied (by {} {})"
  532. .format(cs_port.connected_console.device, cs_port.connected_console))
  533. except ConsoleServerPort.DoesNotExist:
  534. raise forms.ValidationError("Invalid console server port ({} {})"
  535. .format(self.cleaned_data['console_server'], self.cleaned_data['cs_port']))
  536. # Validate console port
  537. if self.cleaned_data.get('device'):
  538. try:
  539. console_port = ConsolePort.objects.get(device=self.cleaned_data['device'],
  540. name=self.cleaned_data['console_port'])
  541. if console_port.cs_port:
  542. raise forms.ValidationError("Console port is already connected (to {} {})"
  543. .format(console_port.cs_port.device, console_port.cs_port))
  544. except ConsolePort.DoesNotExist:
  545. raise forms.ValidationError("Invalid console port ({} {})"
  546. .format(self.cleaned_data['device'], self.cleaned_data['console_port']))
  547. class ConsoleConnectionImportForm(BootstrapMixin, BulkImportForm):
  548. csv = CSVDataField(csv_form=ConsoleConnectionCSVForm)
  549. def clean(self):
  550. records = self.cleaned_data.get('csv')
  551. if not records:
  552. return
  553. connection_list = []
  554. for i, record in enumerate(records, start=1):
  555. form = self.fields['csv'].csv_form(data=record)
  556. if form.is_valid():
  557. console_port = ConsolePort.objects.get(device=form.cleaned_data['device'],
  558. name=form.cleaned_data['console_port'])
  559. console_port.cs_port = ConsoleServerPort.objects.get(device=form.cleaned_data['console_server'],
  560. name=form.cleaned_data['cs_port'])
  561. if form.cleaned_data['status'] == 'planned':
  562. console_port.connection_status = CONNECTION_STATUS_PLANNED
  563. else:
  564. console_port.connection_status = CONNECTION_STATUS_CONNECTED
  565. connection_list.append(console_port)
  566. else:
  567. for field, errors in form.errors.items():
  568. for e in errors:
  569. self.add_error('csv', "Record {} {}: {}".format(i, field, e))
  570. self.cleaned_data['csv'] = connection_list
  571. class ConsolePortConnectionForm(BootstrapMixin, forms.ModelForm):
  572. rack = forms.ModelChoiceField(queryset=Rack.objects.all(), label='Rack', required=False,
  573. widget=forms.Select(attrs={'filter-for': 'console_server'}))
  574. console_server = forms.ModelChoiceField(queryset=Device.objects.all(), label='Console Server', required=False,
  575. widget=APISelect(api_url='/api/dcim/devices/?rack_id={{rack}}&is_console_server=True',
  576. display_field='display_name',
  577. attrs={'filter-for': 'cs_port'}))
  578. livesearch = forms.CharField(required=False, label='Console Server', widget=Livesearch(
  579. query_key='q', query_url='dcim-api:device_list', field_to_update='console_server')
  580. )
  581. cs_port = forms.ModelChoiceField(queryset=ConsoleServerPort.objects.all(), label='Port',
  582. widget=APISelect(api_url='/api/dcim/devices/{{console_server}}/console-server-ports/',
  583. disabled_indicator='connected_console'))
  584. class Meta:
  585. model = ConsolePort
  586. fields = ['rack', 'console_server', 'livesearch', 'cs_port', 'connection_status']
  587. labels = {
  588. 'cs_port': 'Port',
  589. 'connection_status': 'Status',
  590. }
  591. def __init__(self, *args, **kwargs):
  592. super(ConsolePortConnectionForm, self).__init__(*args, **kwargs)
  593. if not self.instance.pk:
  594. raise RuntimeError("ConsolePortConnectionForm must be initialized with an existing ConsolePort instance.")
  595. self.fields['rack'].queryset = Rack.objects.filter(site=self.instance.device.rack.site)
  596. self.fields['cs_port'].required = True
  597. self.fields['connection_status'].choices = CONNECTION_STATUS_CHOICES
  598. # Initialize console server choices
  599. if self.is_bound and self.data.get('rack'):
  600. self.fields['console_server'].queryset = Device.objects.filter(rack=self.data['rack'], device_type__is_console_server=True)
  601. elif self.initial.get('rack'):
  602. self.fields['console_server'].queryset = Device.objects.filter(rack=self.initial['rack'], device_type__is_console_server=True)
  603. else:
  604. self.fields['console_server'].choices = []
  605. # Initialize CS port choices
  606. if self.is_bound:
  607. self.fields['cs_port'].queryset = ConsoleServerPort.objects.filter(device__pk=self.data['console_server'])
  608. elif self.initial.get('console_server', None):
  609. self.fields['cs_port'].queryset = ConsoleServerPort.objects.filter(device__pk=self.initial['console_server'])
  610. else:
  611. self.fields['cs_port'].choices = []
  612. #
  613. # Console server ports
  614. #
  615. class ConsoleServerPortForm(BootstrapMixin, forms.ModelForm):
  616. class Meta:
  617. model = ConsoleServerPort
  618. fields = ['device', 'name']
  619. widgets = {
  620. 'device': forms.HiddenInput(),
  621. }
  622. class ConsoleServerPortCreateForm(BootstrapMixin, forms.Form):
  623. name_pattern = ExpandableNameField(label='Name')
  624. class ConsoleServerPortConnectionForm(BootstrapMixin, forms.Form):
  625. rack = forms.ModelChoiceField(queryset=Rack.objects.all(), label='Rack', required=False,
  626. widget=forms.Select(attrs={'filter-for': 'device'}))
  627. device = forms.ModelChoiceField(queryset=Device.objects.all(), label='Device', required=False,
  628. widget=APISelect(api_url='/api/dcim/devices/?rack_id={{rack}}',
  629. display_field='display_name', attrs={'filter-for': 'port'}))
  630. livesearch = forms.CharField(required=False, label='Device', widget=Livesearch(
  631. query_key='q', query_url='dcim-api:device_list', field_to_update='device')
  632. )
  633. port = forms.ModelChoiceField(queryset=ConsolePort.objects.all(), label='Port',
  634. widget=APISelect(api_url='/api/dcim/devices/{{device}}/console-ports/',
  635. disabled_indicator='cs_port'))
  636. connection_status = forms.BooleanField(required=False, initial=CONNECTION_STATUS_CONNECTED, label='Status',
  637. widget=forms.Select(choices=CONNECTION_STATUS_CHOICES))
  638. class Meta:
  639. fields = ['rack', 'device', 'livesearch', 'port', 'connection_status']
  640. labels = {
  641. 'connection_status': 'Status',
  642. }
  643. def __init__(self, consoleserverport, *args, **kwargs):
  644. super(ConsoleServerPortConnectionForm, self).__init__(*args, **kwargs)
  645. self.fields['rack'].queryset = Rack.objects.filter(site=consoleserverport.device.rack.site)
  646. # Initialize device choices
  647. if self.is_bound and self.data.get('rack'):
  648. self.fields['device'].queryset = Device.objects.filter(rack=self.data['rack'])
  649. elif self.initial.get('rack', None):
  650. self.fields['device'].queryset = Device.objects.filter(rack=self.initial['rack'])
  651. else:
  652. self.fields['device'].choices = []
  653. # Initialize port choices
  654. if self.is_bound:
  655. self.fields['port'].queryset = ConsolePort.objects.filter(device__pk=self.data['device'])
  656. elif self.initial.get('device', None):
  657. self.fields['port'].queryset = ConsolePort.objects.filter(device_pk=self.initial['device'])
  658. else:
  659. self.fields['port'].choices = []
  660. #
  661. # Power ports
  662. #
  663. class PowerPortForm(BootstrapMixin, forms.ModelForm):
  664. class Meta:
  665. model = PowerPort
  666. fields = ['device', 'name']
  667. widgets = {
  668. 'device': forms.HiddenInput(),
  669. }
  670. class PowerPortCreateForm(BootstrapMixin, forms.Form):
  671. name_pattern = ExpandableNameField(label='Name')
  672. class PowerConnectionCSVForm(forms.Form):
  673. pdu = FlexibleModelChoiceField(queryset=Device.objects.filter(device_type__is_pdu=True), to_field_name='name',
  674. error_messages={'invalid_choice': 'PDU not found.'})
  675. power_outlet = forms.CharField()
  676. device = FlexibleModelChoiceField(queryset=Device.objects.all(), to_field_name='name',
  677. error_messages={'invalid_choice': 'Device not found'})
  678. power_port = forms.CharField()
  679. status = forms.CharField(validators=[validate_connection_status])
  680. def clean(self):
  681. # Validate power outlet
  682. if self.cleaned_data.get('pdu'):
  683. try:
  684. power_outlet = PowerOutlet.objects.get(device=self.cleaned_data['pdu'],
  685. name=self.cleaned_data['power_outlet'])
  686. if PowerPort.objects.filter(power_outlet=power_outlet):
  687. raise forms.ValidationError("Power outlet is already occupied (by {} {})"
  688. .format(power_outlet.connected_port.device,
  689. power_outlet.connected_port))
  690. except PowerOutlet.DoesNotExist:
  691. raise forms.ValidationError("Invalid PDU port ({} {})"
  692. .format(self.cleaned_data['pdu'], self.cleaned_data['power_outlet']))
  693. # Validate power port
  694. if self.cleaned_data.get('device'):
  695. try:
  696. power_port = PowerPort.objects.get(device=self.cleaned_data['device'],
  697. name=self.cleaned_data['power_port'])
  698. if power_port.power_outlet:
  699. raise forms.ValidationError("Power port is already connected (to {} {})"
  700. .format(power_port.power_outlet.device, power_port.power_outlet))
  701. except PowerPort.DoesNotExist:
  702. raise forms.ValidationError("Invalid power port ({} {})"
  703. .format(self.cleaned_data['device'], self.cleaned_data['power_port']))
  704. class PowerConnectionImportForm(BootstrapMixin, BulkImportForm):
  705. csv = CSVDataField(csv_form=PowerConnectionCSVForm)
  706. def clean(self):
  707. records = self.cleaned_data.get('csv')
  708. if not records:
  709. return
  710. connection_list = []
  711. for i, record in enumerate(records, start=1):
  712. form = self.fields['csv'].csv_form(data=record)
  713. if form.is_valid():
  714. power_port = PowerPort.objects.get(device=form.cleaned_data['device'],
  715. name=form.cleaned_data['power_port'])
  716. power_port.power_outlet = PowerOutlet.objects.get(device=form.cleaned_data['pdu'],
  717. name=form.cleaned_data['power_outlet'])
  718. if form.cleaned_data['status'] == 'planned':
  719. power_port.connection_status = CONNECTION_STATUS_PLANNED
  720. else:
  721. power_port.connection_status = CONNECTION_STATUS_CONNECTED
  722. connection_list.append(power_port)
  723. else:
  724. for field, errors in form.errors.items():
  725. for e in errors:
  726. self.add_error('csv', "Record {} {}: {}".format(i, field, e))
  727. self.cleaned_data['csv'] = connection_list
  728. class PowerPortConnectionForm(BootstrapMixin, forms.ModelForm):
  729. rack = forms.ModelChoiceField(queryset=Rack.objects.all(), label='Rack', required=False,
  730. widget=forms.Select(attrs={'filter-for': 'pdu'}))
  731. pdu = forms.ModelChoiceField(queryset=Device.objects.all(), label='PDU', required=False,
  732. widget=APISelect(api_url='/api/dcim/devices/?rack_id={{rack}}&is_pdu=True',
  733. display_field='display_name', attrs={'filter-for': 'power_outlet'}))
  734. livesearch = forms.CharField(required=False, label='PDU', widget=Livesearch(
  735. query_key='q', query_url='dcim-api:device_list', field_to_update='pdu')
  736. )
  737. power_outlet = forms.ModelChoiceField(queryset=PowerOutlet.objects.all(), label='Outlet',
  738. widget=APISelect(api_url='/api/dcim/devices/{{pdu}}/power-outlets/',
  739. disabled_indicator='connected_port'))
  740. class Meta:
  741. model = PowerPort
  742. fields = ['rack', 'pdu', 'livesearch', 'power_outlet', 'connection_status']
  743. labels = {
  744. 'power_outlet': 'Outlet',
  745. 'connection_status': 'Status',
  746. }
  747. def __init__(self, *args, **kwargs):
  748. super(PowerPortConnectionForm, self).__init__(*args, **kwargs)
  749. if not self.instance.pk:
  750. raise RuntimeError("PowerPortConnectionForm must be initialized with an existing PowerPort instance.")
  751. self.fields['rack'].queryset = Rack.objects.filter(site=self.instance.device.rack.site)
  752. self.fields['power_outlet'].required = True
  753. self.fields['connection_status'].choices = CONNECTION_STATUS_CHOICES
  754. # Initialize PDU choices
  755. if self.is_bound and self.data.get('rack'):
  756. self.fields['pdu'].queryset = Device.objects.filter(rack=self.data['rack'], device_type__is_pdu=True)
  757. elif self.initial.get('rack', None):
  758. self.fields['pdu'].queryset = Device.objects.filter(rack=self.initial['rack'], device_type__is_pdu=True)
  759. else:
  760. self.fields['pdu'].choices = []
  761. # Initialize power outlet choices
  762. if self.is_bound:
  763. self.fields['power_outlet'].queryset = PowerOutlet.objects.filter(device__pk=self.data['pdu'])
  764. elif self.initial.get('pdu', None):
  765. self.fields['power_outlet'].queryset = PowerOutlet.objects.filter(device__pk=self.initial['pdu'])
  766. else:
  767. self.fields['power_outlet'].choices = []
  768. #
  769. # Power outlets
  770. #
  771. class PowerOutletForm(BootstrapMixin, forms.ModelForm):
  772. class Meta:
  773. model = PowerOutlet
  774. fields = ['device', 'name']
  775. widgets = {
  776. 'device': forms.HiddenInput(),
  777. }
  778. class PowerOutletCreateForm(BootstrapMixin, forms.Form):
  779. name_pattern = ExpandableNameField(label='Name')
  780. class PowerOutletConnectionForm(BootstrapMixin, forms.Form):
  781. rack = forms.ModelChoiceField(queryset=Rack.objects.all(), label='Rack', required=False,
  782. widget=forms.Select(attrs={'filter-for': 'device'}))
  783. device = forms.ModelChoiceField(queryset=Device.objects.all(), label='Device', required=False,
  784. widget=APISelect(api_url='/api/dcim/devices/?rack_id={{rack}}',
  785. display_field='display_name', attrs={'filter-for': 'port'}))
  786. livesearch = forms.CharField(required=False, label='Device', widget=Livesearch(
  787. query_key='q', query_url='dcim-api:device_list', field_to_update='device')
  788. )
  789. port = forms.ModelChoiceField(queryset=PowerPort.objects.all(), label='Port',
  790. widget=APISelect(api_url='/api/dcim/devices/{{device}}/power-ports/',
  791. disabled_indicator='power_outlet'))
  792. connection_status = forms.BooleanField(required=False, initial=CONNECTION_STATUS_CONNECTED, label='Status',
  793. widget=forms.Select(choices=CONNECTION_STATUS_CHOICES))
  794. class Meta:
  795. fields = ['rack', 'device', 'livesearch', 'port', 'connection_status']
  796. labels = {
  797. 'connection_status': 'Status',
  798. }
  799. def __init__(self, poweroutlet, *args, **kwargs):
  800. super(PowerOutletConnectionForm, self).__init__(*args, **kwargs)
  801. self.fields['rack'].queryset = Rack.objects.filter(site=poweroutlet.device.rack.site)
  802. # Initialize device choices
  803. if self.is_bound and self.data.get('rack'):
  804. self.fields['device'].queryset = Device.objects.filter(rack=self.data['rack'])
  805. elif self.initial.get('rack', None):
  806. self.fields['device'].queryset = Device.objects.filter(rack=self.initial['rack'])
  807. else:
  808. self.fields['device'].choices = []
  809. # Initialize port choices
  810. if self.is_bound:
  811. self.fields['port'].queryset = PowerPort.objects.filter(device__pk=self.data['device'])
  812. elif self.initial.get('device', None):
  813. self.fields['port'].queryset = PowerPort.objects.filter(device_pk=self.initial['device'])
  814. else:
  815. self.fields['port'].choices = []
  816. #
  817. # Interfaces
  818. #
  819. class InterfaceForm(BootstrapMixin, forms.ModelForm):
  820. class Meta:
  821. model = Interface
  822. fields = ['device', 'name', 'form_factor', 'mac_address', 'mgmt_only', 'description']
  823. widgets = {
  824. 'device': forms.HiddenInput(),
  825. }
  826. class InterfaceCreateForm(BootstrapMixin, forms.Form):
  827. name_pattern = ExpandableNameField(label='Name')
  828. form_factor = forms.ChoiceField(choices=IFACE_FF_CHOICES)
  829. mac_address = MACAddressFormField(required=False, label='MAC Address')
  830. mgmt_only = forms.BooleanField(required=False, label='OOB Management')
  831. description = forms.CharField(max_length=100, required=False)
  832. class InterfaceBulkEditForm(BootstrapMixin, BulkEditForm):
  833. pk = forms.ModelMultipleChoiceField(queryset=Interface.objects.all(), widget=forms.MultipleHiddenInput)
  834. form_factor = forms.ChoiceField(choices=add_blank_choice(IFACE_FF_CHOICES), required=False)
  835. description = forms.CharField(max_length=100, required=False)
  836. class Meta:
  837. nullable_fields = ['description']
  838. #
  839. # Interface connections
  840. #
  841. class InterfaceConnectionForm(BootstrapMixin, forms.ModelForm):
  842. interface_a = forms.ChoiceField(choices=[], widget=SelectWithDisabled, label='Interface')
  843. site_b = forms.ModelChoiceField(queryset=Site.objects.all(), label='Site', required=False,
  844. widget=forms.Select(attrs={'filter-for': 'rack_b'}))
  845. rack_b = forms.ModelChoiceField(queryset=Rack.objects.all(), label='Rack', required=False,
  846. widget=APISelect(api_url='/api/dcim/racks/?site_id={{site_b}}',
  847. attrs={'filter-for': 'device_b'}))
  848. device_b = forms.ModelChoiceField(queryset=Device.objects.all(), label='Device', required=False,
  849. widget=APISelect(api_url='/api/dcim/devices/?rack_id={{rack_b}}',
  850. display_field='display_name',
  851. attrs={'filter-for': 'interface_b'}))
  852. livesearch = forms.CharField(required=False, label='Device', widget=Livesearch(
  853. query_key='q', query_url='dcim-api:device_list', field_to_update='device_b')
  854. )
  855. interface_b = forms.ModelChoiceField(queryset=Interface.objects.all(), label='Interface',
  856. widget=APISelect(api_url='/api/dcim/devices/{{device_b}}/interfaces/?type=physical',
  857. disabled_indicator='is_connected'))
  858. class Meta:
  859. model = InterfaceConnection
  860. fields = ['interface_a', 'site_b', 'rack_b', 'device_b', 'interface_b', 'livesearch', 'connection_status']
  861. def __init__(self, device_a, *args, **kwargs):
  862. super(InterfaceConnectionForm, self).__init__(*args, **kwargs)
  863. # Initialize interface A choices
  864. device_a_interfaces = Interface.objects.filter(device=device_a).exclude(form_factor=IFACE_FF_VIRTUAL)\
  865. .select_related('circuit_termination', 'connected_as_a', 'connected_as_b')
  866. self.fields['interface_a'].choices = [
  867. (iface.id, {'label': iface.name, 'disabled': iface.is_connected}) for iface in device_a_interfaces
  868. ]
  869. # Initialize rack_b choices if site_b is set
  870. if self.is_bound and self.data.get('site_b'):
  871. self.fields['rack_b'].queryset = Rack.objects.filter(site__pk=self.data['site_b'])
  872. elif self.initial.get('site_b'):
  873. self.fields['rack_b'].queryset = Rack.objects.filter(site=self.initial['site_b'])
  874. else:
  875. self.fields['rack_b'].choices = []
  876. # Initialize device_b choices if rack_b is set
  877. if self.is_bound and self.data.get('rack_b'):
  878. self.fields['device_b'].queryset = Device.objects.filter(rack__pk=self.data['rack_b'])
  879. elif self.initial.get('rack_b'):
  880. self.fields['device_b'].queryset = Device.objects.filter(rack=self.initial['rack_b'])
  881. else:
  882. self.fields['device_b'].choices = []
  883. # Initialize interface_b choices if device_b is set
  884. if self.is_bound:
  885. device_b_interfaces = Interface.objects.filter(device=self.data['device_b'])\
  886. .exclude(form_factor=IFACE_FF_VIRTUAL)\
  887. .select_related('circuit_termination', 'connected_as_a', 'connected_as_b')
  888. elif self.initial.get('device_b'):
  889. device_b_interfaces = Interface.objects.filter(device=self.initial['device_b'])\
  890. .exclude(form_factor=IFACE_FF_VIRTUAL)\
  891. .select_related('circuit_termination', 'connected_as_a', 'connected_as_b')
  892. else:
  893. device_b_interfaces = []
  894. self.fields['interface_b'].choices = [
  895. (iface.id, {'label': iface.name, 'disabled': iface.is_connected}) for iface in device_b_interfaces
  896. ]
  897. class InterfaceConnectionCSVForm(forms.Form):
  898. device_a = FlexibleModelChoiceField(queryset=Device.objects.all(), to_field_name='name',
  899. error_messages={'invalid_choice': 'Device A not found.'})
  900. interface_a = forms.CharField()
  901. device_b = FlexibleModelChoiceField(queryset=Device.objects.all(), to_field_name='name',
  902. error_messages={'invalid_choice': 'Device B not found.'})
  903. interface_b = forms.CharField()
  904. status = forms.CharField(validators=[validate_connection_status])
  905. def clean(self):
  906. # Validate interface A
  907. if self.cleaned_data.get('device_a'):
  908. try:
  909. interface_a = Interface.objects.get(device=self.cleaned_data['device_a'],
  910. name=self.cleaned_data['interface_a'])
  911. except Interface.DoesNotExist:
  912. raise forms.ValidationError("Invalid interface ({} {})"
  913. .format(self.cleaned_data['device_a'], self.cleaned_data['interface_a']))
  914. try:
  915. InterfaceConnection.objects.get(Q(interface_a=interface_a) | Q(interface_b=interface_a))
  916. raise forms.ValidationError("{} {} is already connected"
  917. .format(self.cleaned_data['device_a'], self.cleaned_data['interface_a']))
  918. except InterfaceConnection.DoesNotExist:
  919. pass
  920. # Validate interface B
  921. if self.cleaned_data.get('device_b'):
  922. try:
  923. interface_b = Interface.objects.get(device=self.cleaned_data['device_b'],
  924. name=self.cleaned_data['interface_b'])
  925. except Interface.DoesNotExist:
  926. raise forms.ValidationError("Invalid interface ({} {})"
  927. .format(self.cleaned_data['device_b'], self.cleaned_data['interface_b']))
  928. try:
  929. InterfaceConnection.objects.get(Q(interface_a=interface_b) | Q(interface_b=interface_b))
  930. raise forms.ValidationError("{} {} is already connected"
  931. .format(self.cleaned_data['device_b'], self.cleaned_data['interface_b']))
  932. except InterfaceConnection.DoesNotExist:
  933. pass
  934. class InterfaceConnectionImportForm(BootstrapMixin, BulkImportForm):
  935. csv = CSVDataField(csv_form=InterfaceConnectionCSVForm)
  936. def clean(self):
  937. records = self.cleaned_data.get('csv')
  938. if not records:
  939. return
  940. connection_list = []
  941. occupied_interfaces = []
  942. for i, record in enumerate(records, start=1):
  943. form = self.fields['csv'].csv_form(data=record)
  944. if form.is_valid():
  945. interface_a = Interface.objects.get(device=form.cleaned_data['device_a'],
  946. name=form.cleaned_data['interface_a'])
  947. if interface_a in occupied_interfaces:
  948. raise forms.ValidationError("{} {} found in multiple connections"
  949. .format(interface_a.device.name, interface_a.name))
  950. interface_b = Interface.objects.get(device=form.cleaned_data['device_b'],
  951. name=form.cleaned_data['interface_b'])
  952. if interface_b in occupied_interfaces:
  953. raise forms.ValidationError("{} {} found in multiple connections"
  954. .format(interface_b.device.name, interface_b.name))
  955. connection = InterfaceConnection(interface_a=interface_a, interface_b=interface_b)
  956. if form.cleaned_data['status'] == 'planned':
  957. connection.connection_status = CONNECTION_STATUS_PLANNED
  958. else:
  959. connection.connection_status = CONNECTION_STATUS_CONNECTED
  960. connection_list.append(connection)
  961. occupied_interfaces.append(interface_a)
  962. occupied_interfaces.append(interface_b)
  963. else:
  964. for field, errors in form.errors.items():
  965. for e in errors:
  966. self.add_error('csv', "Record {} {}: {}".format(i, field, e))
  967. self.cleaned_data['csv'] = connection_list
  968. class InterfaceConnectionDeletionForm(BootstrapMixin, forms.Form):
  969. confirm = forms.BooleanField(required=True)
  970. # Used for HTTP redirect upon successful deletion
  971. device = forms.ModelChoiceField(queryset=Device.objects.all(), widget=forms.HiddenInput(), required=False)
  972. #
  973. # Device bays
  974. #
  975. class DeviceBayForm(BootstrapMixin, forms.ModelForm):
  976. class Meta:
  977. model = DeviceBay
  978. fields = ['device', 'name']
  979. widgets = {
  980. 'device': forms.HiddenInput(),
  981. }
  982. class DeviceBayCreateForm(BootstrapMixin, forms.Form):
  983. name_pattern = ExpandableNameField(label='Name')
  984. class PopulateDeviceBayForm(BootstrapMixin, forms.Form):
  985. installed_device = forms.ModelChoiceField(queryset=Device.objects.all(), label='Child Device',
  986. help_text="Child devices must first be created within the rack occupied "
  987. "by the parent device. Then they can be assigned to a bay.")
  988. def __init__(self, device_bay, *args, **kwargs):
  989. super(PopulateDeviceBayForm, self).__init__(*args, **kwargs)
  990. children_queryset = Device.objects.filter(rack=device_bay.device.rack,
  991. parent_bay__isnull=True,
  992. device_type__u_height=0,
  993. device_type__subdevice_role=SUBDEVICE_ROLE_CHILD)\
  994. .exclude(pk=device_bay.device.pk)
  995. self.fields['installed_device'].queryset = children_queryset
  996. #
  997. # Connections
  998. #
  999. class ConsoleConnectionFilterForm(BootstrapMixin, forms.Form):
  1000. site = forms.ModelChoiceField(required=False, queryset=Site.objects.all(), to_field_name='slug')
  1001. class PowerConnectionFilterForm(BootstrapMixin, forms.Form):
  1002. site = forms.ModelChoiceField(required=False, queryset=Site.objects.all(), to_field_name='slug')
  1003. class InterfaceConnectionFilterForm(BootstrapMixin, forms.Form):
  1004. site = forms.ModelChoiceField(required=False, queryset=Site.objects.all(), to_field_name='slug')
  1005. #
  1006. # IP addresses
  1007. #
  1008. class IPAddressForm(BootstrapMixin, CustomFieldForm):
  1009. set_as_primary = forms.BooleanField(label='Set as primary IP for device', required=False)
  1010. class Meta:
  1011. model = IPAddress
  1012. fields = ['address', 'vrf', 'tenant', 'status', 'interface', 'description']
  1013. def __init__(self, device, *args, **kwargs):
  1014. super(IPAddressForm, self).__init__(*args, **kwargs)
  1015. self.fields['vrf'].empty_label = 'Global'
  1016. interfaces = device.interfaces.all()
  1017. self.fields['interface'].queryset = interfaces
  1018. self.fields['interface'].required = True
  1019. # If this device has only one interface, select it by default.
  1020. if len(interfaces) == 1:
  1021. self.fields['interface'].initial = interfaces[0]
  1022. # If this device does not have any IP addresses assigned, default to setting the first IP as its primary.
  1023. if not IPAddress.objects.filter(interface__device=device).count():
  1024. self.fields['set_as_primary'].initial = True
  1025. #
  1026. # Modules
  1027. #
  1028. class ModuleForm(BootstrapMixin, forms.ModelForm):
  1029. class Meta:
  1030. model = Module
  1031. fields = ['name', 'manufacturer', 'part_id', 'serial']