forms.py 55 KB

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