forms.py 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874
  1. from __future__ import unicode_literals
  2. from django import forms
  3. from django.db.models import Count
  4. from dcim.models import Site, Rack, Device, Interface
  5. from extras.forms import CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFilterForm
  6. from tenancy.forms import TenancyForm
  7. from tenancy.models import Tenant
  8. from utilities.forms import (
  9. APISelect, BootstrapMixin, BulkEditNullBooleanSelect, ChainedModelChoiceField, CSVChoiceField,
  10. ExpandableIPAddressField, FilterChoiceField, FlexibleModelChoiceField, Livesearch, ReturnURLForm, SlugField,
  11. add_blank_choice,
  12. )
  13. from .models import (
  14. Aggregate, IPAddress, IPADDRESS_STATUS_CHOICES, Prefix, PREFIX_STATUS_CHOICES, RIR, Role, Service, VLAN,
  15. VLANGroup, VLAN_STATUS_CHOICES, VRF,
  16. )
  17. IP_FAMILY_CHOICES = [
  18. ('', 'All'),
  19. (4, 'IPv4'),
  20. (6, 'IPv6'),
  21. ]
  22. PREFIX_MASK_LENGTH_CHOICES = [
  23. ('', '---------'),
  24. ] + [(i, i) for i in range(1, 128)]
  25. IPADDRESS_MASK_LENGTH_CHOICES = PREFIX_MASK_LENGTH_CHOICES + [(128, 128)]
  26. #
  27. # VRFs
  28. #
  29. class VRFForm(BootstrapMixin, TenancyForm, CustomFieldForm):
  30. class Meta:
  31. model = VRF
  32. fields = ['name', 'rd', 'enforce_unique', 'description', 'tenant_group', 'tenant']
  33. labels = {
  34. 'rd': "RD",
  35. }
  36. help_texts = {
  37. 'rd': "Route distinguisher in any format",
  38. }
  39. class VRFCSVForm(forms.ModelForm):
  40. tenant = forms.ModelChoiceField(
  41. queryset=Tenant.objects.all(),
  42. required=False,
  43. to_field_name='name',
  44. help_text='Name of assigned tenant',
  45. error_messages={
  46. 'invalid_choice': 'Tenant not found.',
  47. }
  48. )
  49. class Meta:
  50. model = VRF
  51. fields = ['name', 'rd', 'tenant', 'enforce_unique', 'description']
  52. help_texts = {
  53. 'name': 'VRF name',
  54. }
  55. class VRFBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  56. pk = forms.ModelMultipleChoiceField(queryset=VRF.objects.all(), widget=forms.MultipleHiddenInput)
  57. tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
  58. enforce_unique = forms.NullBooleanField(
  59. required=False, widget=BulkEditNullBooleanSelect, label='Enforce unique space'
  60. )
  61. description = forms.CharField(max_length=100, required=False)
  62. class Meta:
  63. nullable_fields = ['tenant', 'description']
  64. class VRFFilterForm(BootstrapMixin, CustomFieldFilterForm):
  65. model = VRF
  66. q = forms.CharField(required=False, label='Search')
  67. tenant = FilterChoiceField(queryset=Tenant.objects.annotate(filter_count=Count('vrfs')), to_field_name='slug',
  68. null_option=(0, None))
  69. #
  70. # RIRs
  71. #
  72. class RIRForm(BootstrapMixin, forms.ModelForm):
  73. slug = SlugField()
  74. class Meta:
  75. model = RIR
  76. fields = ['name', 'slug', 'is_private']
  77. class RIRFilterForm(BootstrapMixin, forms.Form):
  78. is_private = forms.NullBooleanField(required=False, label='Private', widget=forms.Select(choices=[
  79. ('', '---------'),
  80. ('True', 'Yes'),
  81. ('False', 'No'),
  82. ]))
  83. #
  84. # Aggregates
  85. #
  86. class AggregateForm(BootstrapMixin, CustomFieldForm):
  87. class Meta:
  88. model = Aggregate
  89. fields = ['prefix', 'rir', 'date_added', 'description']
  90. help_texts = {
  91. 'prefix': "IPv4 or IPv6 network",
  92. 'rir': "Regional Internet Registry responsible for this prefix",
  93. 'date_added': "Format: YYYY-MM-DD",
  94. }
  95. class AggregateCSVForm(forms.ModelForm):
  96. rir = forms.ModelChoiceField(
  97. queryset=RIR.objects.all(),
  98. to_field_name='name',
  99. help_text='Name of parent RIR',
  100. error_messages={
  101. 'invalid_choice': 'RIR not found.',
  102. }
  103. )
  104. class Meta:
  105. model = Aggregate
  106. fields = ['prefix', 'rir', 'date_added', 'description']
  107. class AggregateBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  108. pk = forms.ModelMultipleChoiceField(queryset=Aggregate.objects.all(), widget=forms.MultipleHiddenInput)
  109. rir = forms.ModelChoiceField(queryset=RIR.objects.all(), required=False, label='RIR')
  110. date_added = forms.DateField(required=False)
  111. description = forms.CharField(max_length=100, required=False)
  112. class Meta:
  113. nullable_fields = ['date_added', 'description']
  114. class AggregateFilterForm(BootstrapMixin, CustomFieldFilterForm):
  115. model = Aggregate
  116. q = forms.CharField(required=False, label='Search')
  117. family = forms.ChoiceField(required=False, choices=IP_FAMILY_CHOICES, label='Address Family')
  118. rir = FilterChoiceField(
  119. queryset=RIR.objects.annotate(filter_count=Count('aggregates')),
  120. to_field_name='slug',
  121. label='RIR'
  122. )
  123. #
  124. # Roles
  125. #
  126. class RoleForm(BootstrapMixin, forms.ModelForm):
  127. slug = SlugField()
  128. class Meta:
  129. model = Role
  130. fields = ['name', 'slug']
  131. #
  132. # Prefixes
  133. #
  134. class PrefixForm(BootstrapMixin, TenancyForm, CustomFieldForm):
  135. site = forms.ModelChoiceField(
  136. queryset=Site.objects.all(),
  137. required=False,
  138. label='Site',
  139. widget=forms.Select(
  140. attrs={'filter-for': 'vlan_group', 'nullable': 'true'}
  141. )
  142. )
  143. vlan_group = ChainedModelChoiceField(
  144. queryset=VLANGroup.objects.all(),
  145. chains=(
  146. ('site', 'site'),
  147. ),
  148. required=False,
  149. label='VLAN group',
  150. widget=APISelect(
  151. api_url='/api/ipam/vlan-groups/?site_id={{site}}',
  152. attrs={'filter-for': 'vlan', 'nullable': 'true'}
  153. )
  154. )
  155. vlan = ChainedModelChoiceField(
  156. queryset=VLAN.objects.all(),
  157. chains=(
  158. ('site', 'site'),
  159. ('group', 'vlan_group'),
  160. ),
  161. required=False,
  162. label='VLAN',
  163. widget=APISelect(
  164. api_url='/api/ipam/vlans/?site_id={{site}}&group_id={{vlan_group}}', display_field='display_name'
  165. )
  166. )
  167. class Meta:
  168. model = Prefix
  169. fields = ['prefix', 'vrf', 'site', 'vlan', 'status', 'role', 'is_pool', 'description', 'tenant_group', 'tenant']
  170. def __init__(self, *args, **kwargs):
  171. # Initialize helper selectors
  172. instance = kwargs.get('instance')
  173. initial = kwargs.get('initial', {})
  174. if instance and instance.vlan is not None:
  175. initial['vlan_group'] = instance.vlan.group
  176. kwargs['initial'] = initial
  177. super(PrefixForm, self).__init__(*args, **kwargs)
  178. self.fields['vrf'].empty_label = 'Global'
  179. class PrefixCSVForm(forms.ModelForm):
  180. vrf = forms.ModelChoiceField(
  181. queryset=VRF.objects.all(),
  182. required=False,
  183. to_field_name='rd',
  184. help_text='Route distinguisher of parent VRF',
  185. error_messages={
  186. 'invalid_choice': 'VRF not found.',
  187. }
  188. )
  189. tenant = forms.ModelChoiceField(
  190. queryset=Tenant.objects.all(),
  191. required=False,
  192. to_field_name='name',
  193. help_text='Name of assigned tenant',
  194. error_messages={
  195. 'invalid_choice': 'Tenant not found.',
  196. }
  197. )
  198. site = forms.ModelChoiceField(
  199. queryset=Site.objects.all(),
  200. required=False,
  201. to_field_name='name',
  202. help_text='Name of parent site',
  203. error_messages={
  204. 'invalid_choice': 'Site not found.',
  205. }
  206. )
  207. vlan_group = forms.CharField(
  208. help_text='Group name of assigned VLAN',
  209. required=False
  210. )
  211. vlan_vid = forms.IntegerField(
  212. help_text='Numeric ID of assigned VLAN',
  213. required=False
  214. )
  215. status = CSVChoiceField(
  216. choices=IPADDRESS_STATUS_CHOICES,
  217. help_text='Operational status'
  218. )
  219. role = forms.ModelChoiceField(
  220. queryset=Role.objects.all(),
  221. required=False,
  222. to_field_name='name',
  223. help_text='Functional role',
  224. error_messages={
  225. 'invalid_choice': 'Invalid role.',
  226. }
  227. )
  228. class Meta:
  229. model = Prefix
  230. fields = [
  231. 'prefix', 'vrf', 'tenant', 'site', 'vlan_group', 'vlan_vid', 'status', 'role', 'is_pool', 'description',
  232. ]
  233. def clean(self):
  234. super(PrefixCSVForm, self).clean()
  235. site = self.cleaned_data.get('site')
  236. vlan_group = self.cleaned_data.get('vlan_group')
  237. vlan_vid = self.cleaned_data.get('vlan_vid')
  238. # Validate VLAN
  239. if vlan_group and vlan_vid:
  240. try:
  241. self.instance.vlan = VLAN.objects.get(site=site, group__name=vlan_group, vid=vlan_vid)
  242. except VLAN.DoesNotExist:
  243. if site:
  244. raise forms.ValidationError("VLAN {} not found in site {} group {}".format(
  245. vlan_vid, site, vlan_group
  246. ))
  247. else:
  248. raise forms.ValidationError("Global VLAN {} not found in group {}".format(vlan_vid, vlan_group))
  249. elif vlan_vid:
  250. try:
  251. self.instance.vlan = VLAN.objects.get(site=site, group__isnull=True, vid=vlan_vid)
  252. except VLAN.DoesNotExist:
  253. if site:
  254. raise forms.ValidationError("VLAN {} not found in site {}".format(vlan_vid, site))
  255. else:
  256. raise forms.ValidationError("Global VLAN {} not found".format(vlan_vid))
  257. class PrefixBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  258. pk = forms.ModelMultipleChoiceField(queryset=Prefix.objects.all(), widget=forms.MultipleHiddenInput)
  259. site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False)
  260. vrf = forms.ModelChoiceField(queryset=VRF.objects.all(), required=False, label='VRF')
  261. tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
  262. status = forms.ChoiceField(choices=add_blank_choice(PREFIX_STATUS_CHOICES), required=False)
  263. role = forms.ModelChoiceField(queryset=Role.objects.all(), required=False)
  264. is_pool = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Is a pool')
  265. description = forms.CharField(max_length=100, required=False)
  266. class Meta:
  267. nullable_fields = ['site', 'vrf', 'tenant', 'role', 'description']
  268. def prefix_status_choices():
  269. status_counts = {}
  270. for status in Prefix.objects.values('status').annotate(count=Count('status')).order_by('status'):
  271. status_counts[status['status']] = status['count']
  272. return [(s[0], '{} ({})'.format(s[1], status_counts.get(s[0], 0))) for s in PREFIX_STATUS_CHOICES]
  273. class PrefixFilterForm(BootstrapMixin, CustomFieldFilterForm):
  274. model = Prefix
  275. q = forms.CharField(required=False, label='Search')
  276. parent = forms.CharField(required=False, label='Parent prefix', widget=forms.TextInput(attrs={
  277. 'placeholder': 'Prefix',
  278. }))
  279. family = forms.ChoiceField(required=False, choices=IP_FAMILY_CHOICES, label='Address family')
  280. mask_length = forms.ChoiceField(required=False, choices=PREFIX_MASK_LENGTH_CHOICES, label='Mask length')
  281. vrf = FilterChoiceField(
  282. queryset=VRF.objects.annotate(filter_count=Count('prefixes')),
  283. to_field_name='rd',
  284. label='VRF',
  285. null_option=(0, 'Global')
  286. )
  287. tenant = FilterChoiceField(
  288. queryset=Tenant.objects.annotate(filter_count=Count('prefixes')),
  289. to_field_name='slug',
  290. null_option=(0, 'None')
  291. )
  292. status = forms.MultipleChoiceField(choices=prefix_status_choices, required=False)
  293. site = FilterChoiceField(
  294. queryset=Site.objects.annotate(filter_count=Count('prefixes')),
  295. to_field_name='slug',
  296. null_option=(0, 'None')
  297. )
  298. role = FilterChoiceField(
  299. queryset=Role.objects.annotate(filter_count=Count('prefixes')),
  300. to_field_name='slug',
  301. null_option=(0, 'None')
  302. )
  303. expand = forms.BooleanField(required=False, label='Expand prefix hierarchy')
  304. #
  305. # IP addresses
  306. #
  307. class IPAddressForm(BootstrapMixin, TenancyForm, ReturnURLForm, CustomFieldForm):
  308. interface_site = forms.ModelChoiceField(
  309. queryset=Site.objects.all(),
  310. required=False,
  311. label='Site',
  312. widget=forms.Select(
  313. attrs={'filter-for': 'interface_rack'}
  314. )
  315. )
  316. interface_rack = ChainedModelChoiceField(
  317. queryset=Rack.objects.all(),
  318. chains=(
  319. ('site', 'interface_site'),
  320. ),
  321. required=False,
  322. label='Rack',
  323. widget=APISelect(
  324. api_url='/api/dcim/racks/?site_id={{interface_site}}',
  325. display_field='display_name',
  326. attrs={'filter-for': 'interface_device', 'nullable': 'true'}
  327. )
  328. )
  329. interface_device = ChainedModelChoiceField(
  330. queryset=Device.objects.all(),
  331. chains=(
  332. ('site', 'interface_site'),
  333. ('rack', 'interface_rack'),
  334. ),
  335. required=False,
  336. label='Device',
  337. widget=APISelect(
  338. api_url='/api/dcim/devices/?site_id={{interface_site}}&rack_id={{interface_rack}}',
  339. display_field='display_name',
  340. attrs={'filter-for': 'interface'}
  341. )
  342. )
  343. interface = ChainedModelChoiceField(
  344. queryset=Interface.objects.all(),
  345. chains=(
  346. ('device', 'interface_device'),
  347. ),
  348. required=False,
  349. widget=APISelect(
  350. api_url='/api/dcim/interfaces/?device_id={{interface_device}}'
  351. )
  352. )
  353. nat_site = forms.ModelChoiceField(
  354. queryset=Site.objects.all(),
  355. required=False,
  356. label='Site',
  357. widget=forms.Select(
  358. attrs={'filter-for': 'nat_rack'}
  359. )
  360. )
  361. nat_rack = ChainedModelChoiceField(
  362. queryset=Rack.objects.all(),
  363. chains=(
  364. ('site', 'nat_site'),
  365. ),
  366. required=False,
  367. label='Rack',
  368. widget=APISelect(
  369. api_url='/api/dcim/racks/?site_id={{nat_site}}',
  370. display_field='display_name',
  371. attrs={'filter-for': 'nat_device', 'nullable': 'true'}
  372. )
  373. )
  374. nat_device = ChainedModelChoiceField(
  375. queryset=Device.objects.all(),
  376. chains=(
  377. ('site', 'nat_site'),
  378. ('rack', 'nat_rack'),
  379. ),
  380. required=False,
  381. label='Device',
  382. widget=APISelect(
  383. api_url='/api/dcim/devices/?site_id={{nat_site}}&rack_id={{nat_rack}}',
  384. display_field='display_name',
  385. attrs={'filter-for': 'nat_inside'}
  386. )
  387. )
  388. nat_inside = ChainedModelChoiceField(
  389. queryset=IPAddress.objects.all(),
  390. chains=(
  391. ('interface__device', 'nat_device'),
  392. ),
  393. required=False,
  394. label='IP Address',
  395. widget=APISelect(
  396. api_url='/api/ipam/ip-addresses/?device_id={{nat_device}}',
  397. display_field='address'
  398. )
  399. )
  400. livesearch = forms.CharField(
  401. required=False,
  402. label='Search',
  403. widget=Livesearch(
  404. query_key='q',
  405. query_url='ipam-api:ipaddress-list',
  406. field_to_update='nat_inside',
  407. obj_label='address'
  408. )
  409. )
  410. primary_for_device = forms.BooleanField(required=False, label='Make this the primary IP for the device')
  411. class Meta:
  412. model = IPAddress
  413. fields = [
  414. 'address', 'vrf', 'status', 'description', 'interface', 'primary_for_device', 'nat_site', 'nat_rack',
  415. 'nat_inside', 'tenant_group', 'tenant',
  416. ]
  417. def __init__(self, *args, **kwargs):
  418. # Initialize helper selectors
  419. instance = kwargs.get('instance')
  420. initial = kwargs.get('initial', {})
  421. if instance and instance.interface is not None:
  422. initial['interface_site'] = instance.interface.device.site
  423. initial['interface_rack'] = instance.interface.device.rack
  424. initial['interface_device'] = instance.interface.device
  425. if instance and instance.nat_inside and instance.nat_inside.device is not None:
  426. initial['nat_site'] = instance.nat_inside.device.site
  427. initial['nat_rack'] = instance.nat_inside.device.rack
  428. initial['nat_device'] = instance.nat_inside.device
  429. kwargs['initial'] = initial
  430. super(IPAddressForm, self).__init__(*args, **kwargs)
  431. self.fields['vrf'].empty_label = 'Global'
  432. # Initialize primary_for_device if IP address is already assigned
  433. if self.instance.interface is not None:
  434. device = self.instance.interface.device
  435. if (
  436. self.instance.address.version == 4 and device.primary_ip4 == self.instance or
  437. self.instance.address.version == 6 and device.primary_ip6 == self.instance
  438. ):
  439. self.initial['primary_for_device'] = True
  440. def clean(self):
  441. super(IPAddressForm, self).clean()
  442. # Primary IP assignment is only available if an interface has been assigned.
  443. if self.cleaned_data.get('primary_for_device') and not self.cleaned_data.get('interface'):
  444. self.add_error(
  445. 'primary_for_device', "Only IP addresses assigned to an interface can be designated as primary IPs."
  446. )
  447. def save(self, *args, **kwargs):
  448. ipaddress = super(IPAddressForm, self).save(*args, **kwargs)
  449. # Assign this IPAddress as the primary for the associated Device.
  450. if self.cleaned_data['primary_for_device']:
  451. device = self.cleaned_data['interface'].device
  452. if ipaddress.address.version == 4:
  453. device.primary_ip4 = ipaddress
  454. else:
  455. device.primary_ip6 = ipaddress
  456. device.save()
  457. # Clear assignment as primary for device if set.
  458. else:
  459. try:
  460. if ipaddress.address.version == 4:
  461. device = ipaddress.primary_ip4_for
  462. device.primary_ip4 = None
  463. else:
  464. device = ipaddress.primary_ip6_for
  465. device.primary_ip6 = None
  466. device.save()
  467. except Device.DoesNotExist:
  468. pass
  469. return ipaddress
  470. class IPAddressPatternForm(BootstrapMixin, forms.Form):
  471. pattern = ExpandableIPAddressField(label='Address pattern')
  472. class IPAddressBulkAddForm(BootstrapMixin, TenancyForm, CustomFieldForm):
  473. class Meta:
  474. model = IPAddress
  475. fields = ['address', 'status', 'vrf', 'description', 'tenant_group', 'tenant']
  476. def __init__(self, *args, **kwargs):
  477. super(IPAddressBulkAddForm, self).__init__(*args, **kwargs)
  478. self.fields['vrf'].empty_label = 'Global'
  479. class IPAddressCSVForm(forms.ModelForm):
  480. vrf = forms.ModelChoiceField(
  481. queryset=VRF.objects.all(),
  482. required=False,
  483. to_field_name='rd',
  484. help_text='Route distinguisher of the assigned VRF',
  485. error_messages={
  486. 'invalid_choice': 'VRF not found.',
  487. }
  488. )
  489. tenant = forms.ModelChoiceField(
  490. queryset=Tenant.objects.all(),
  491. to_field_name='name',
  492. required=False,
  493. help_text='Name of the assigned tenant',
  494. error_messages={
  495. 'invalid_choice': 'Tenant not found.',
  496. }
  497. )
  498. status = CSVChoiceField(
  499. choices=PREFIX_STATUS_CHOICES,
  500. help_text='Operational status'
  501. )
  502. device = FlexibleModelChoiceField(
  503. queryset=Device.objects.all(),
  504. required=False,
  505. to_field_name='name',
  506. help_text='Name or ID of assigned device',
  507. error_messages={
  508. 'invalid_choice': 'Device not found.',
  509. }
  510. )
  511. interface_name = forms.CharField(
  512. help_text='Name of assigned interface',
  513. required=False
  514. )
  515. is_primary = forms.BooleanField(
  516. help_text='Make this the primary IP for the assigned device',
  517. required=False
  518. )
  519. class Meta:
  520. model = IPAddress
  521. fields = ['address', 'vrf', 'tenant', 'status', 'device', 'interface_name', 'is_primary', 'description']
  522. def clean(self):
  523. super(IPAddressCSVForm, self).clean()
  524. device = self.cleaned_data.get('device')
  525. interface_name = self.cleaned_data.get('interface_name')
  526. is_primary = self.cleaned_data.get('is_primary')
  527. # Validate interface
  528. if device and interface_name:
  529. try:
  530. self.instance.interface = Interface.objects.get(device=device, name=interface_name)
  531. except Interface.DoesNotExist:
  532. raise forms.ValidationError("Invalid interface {} for device {}".format(interface_name, device))
  533. elif device and not interface_name:
  534. raise forms.ValidationError("Device set ({}) but interface missing".format(device))
  535. elif interface_name and not device:
  536. raise forms.ValidationError("Interface set ({}) but device missing or invalid".format(interface_name))
  537. # Validate is_primary
  538. if is_primary and not device:
  539. raise forms.ValidationError("No device specified; cannot set as primary IP")
  540. def save(self, *args, **kwargs):
  541. # Set interface
  542. if self.cleaned_data['device'] and self.cleaned_data['interface_name']:
  543. self.instance.interface = Interface.objects.get(device=self.cleaned_data['device'],
  544. name=self.cleaned_data['interface_name'])
  545. # Set as primary for device
  546. if self.cleaned_data['is_primary']:
  547. if self.instance.address.version == 4:
  548. self.instance.primary_ip4_for = self.cleaned_data['device']
  549. elif self.instance.address.version == 6:
  550. self.instance.primary_ip6_for = self.cleaned_data['device']
  551. return super(IPAddressCSVForm, self).save(*args, **kwargs)
  552. class IPAddressBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  553. pk = forms.ModelMultipleChoiceField(queryset=IPAddress.objects.all(), widget=forms.MultipleHiddenInput)
  554. vrf = forms.ModelChoiceField(queryset=VRF.objects.all(), required=False, label='VRF')
  555. tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
  556. status = forms.ChoiceField(choices=add_blank_choice(IPADDRESS_STATUS_CHOICES), required=False)
  557. description = forms.CharField(max_length=100, required=False)
  558. class Meta:
  559. nullable_fields = ['vrf', 'tenant', 'description']
  560. def ipaddress_status_choices():
  561. status_counts = {}
  562. for status in IPAddress.objects.values('status').annotate(count=Count('status')).order_by('status'):
  563. status_counts[status['status']] = status['count']
  564. return [(s[0], '{} ({})'.format(s[1], status_counts.get(s[0], 0))) for s in IPADDRESS_STATUS_CHOICES]
  565. class IPAddressFilterForm(BootstrapMixin, CustomFieldFilterForm):
  566. model = IPAddress
  567. q = forms.CharField(required=False, label='Search')
  568. parent = forms.CharField(required=False, label='Parent Prefix', widget=forms.TextInput(attrs={
  569. 'placeholder': 'Prefix',
  570. }))
  571. family = forms.ChoiceField(required=False, choices=IP_FAMILY_CHOICES, label='Address family')
  572. mask_length = forms.ChoiceField(required=False, choices=IPADDRESS_MASK_LENGTH_CHOICES, label='Mask length')
  573. vrf = FilterChoiceField(
  574. queryset=VRF.objects.annotate(filter_count=Count('ip_addresses')),
  575. to_field_name='rd',
  576. label='VRF',
  577. null_option=(0, 'Global')
  578. )
  579. tenant = FilterChoiceField(
  580. queryset=Tenant.objects.annotate(filter_count=Count('ip_addresses')),
  581. to_field_name='slug',
  582. null_option=(0, 'None')
  583. )
  584. status = forms.MultipleChoiceField(choices=ipaddress_status_choices, required=False)
  585. #
  586. # VLAN groups
  587. #
  588. class VLANGroupForm(BootstrapMixin, forms.ModelForm):
  589. slug = SlugField()
  590. class Meta:
  591. model = VLANGroup
  592. fields = ['site', 'name', 'slug']
  593. class VLANGroupFilterForm(BootstrapMixin, forms.Form):
  594. site = FilterChoiceField(
  595. queryset=Site.objects.annotate(filter_count=Count('vlan_groups')),
  596. to_field_name='slug',
  597. null_option=(0, 'Global')
  598. )
  599. #
  600. # VLANs
  601. #
  602. class VLANForm(BootstrapMixin, TenancyForm, CustomFieldForm):
  603. site = forms.ModelChoiceField(
  604. queryset=Site.objects.all(),
  605. required=False,
  606. widget=forms.Select(
  607. attrs={'filter-for': 'group', 'nullable': 'true'}
  608. )
  609. )
  610. group = ChainedModelChoiceField(
  611. queryset=VLANGroup.objects.all(),
  612. chains=(
  613. ('site', 'site'),
  614. ),
  615. required=False,
  616. label='Group',
  617. widget=APISelect(
  618. api_url='/api/ipam/vlan-groups/?site_id={{site}}',
  619. )
  620. )
  621. class Meta:
  622. model = VLAN
  623. fields = ['site', 'group', 'vid', 'name', 'status', 'role', 'description', 'tenant_group', 'tenant']
  624. help_texts = {
  625. 'site': "Leave blank if this VLAN spans multiple sites",
  626. 'group': "VLAN group (optional)",
  627. 'vid': "Configured VLAN ID",
  628. 'name': "Configured VLAN name",
  629. 'status': "Operational status of this VLAN",
  630. 'role': "The primary function of this VLAN",
  631. }
  632. class VLANCSVForm(forms.ModelForm):
  633. site = forms.ModelChoiceField(
  634. queryset=Site.objects.all(),
  635. required=False,
  636. to_field_name='name',
  637. help_text='Name of parent site',
  638. error_messages={
  639. 'invalid_choice': 'Site not found.',
  640. }
  641. )
  642. group_name = forms.CharField(
  643. help_text='Name of VLAN group',
  644. required=False
  645. )
  646. tenant = forms.ModelChoiceField(
  647. queryset=Tenant.objects.all(),
  648. to_field_name='name',
  649. required=False,
  650. help_text='Name of assigned tenant',
  651. error_messages={
  652. 'invalid_choice': 'Tenant not found.',
  653. }
  654. )
  655. status = CSVChoiceField(
  656. choices=VLAN_STATUS_CHOICES,
  657. help_text='Operational status'
  658. )
  659. role = forms.ModelChoiceField(
  660. queryset=Role.objects.all(),
  661. required=False,
  662. to_field_name='name',
  663. help_text='Functional role',
  664. error_messages={
  665. 'invalid_choice': 'Invalid role.',
  666. }
  667. )
  668. class Meta:
  669. model = VLAN
  670. fields = ['site', 'group_name', 'vid', 'name', 'tenant', 'status', 'role', 'description']
  671. help_texts = {
  672. 'vid': 'Numeric VLAN ID (1-4095)',
  673. 'name': 'VLAN name',
  674. }
  675. def clean(self):
  676. super(VLANCSVForm, self).clean()
  677. site = self.cleaned_data.get('site')
  678. group_name = self.cleaned_data.get('group_name')
  679. # Validate VLAN group
  680. if group_name:
  681. try:
  682. self.instance.group = VLANGroup.objects.get(site=site, name=group_name)
  683. except VLANGroup.DoesNotExist:
  684. if site:
  685. raise forms.ValidationError("VLAN group {} not found for site {}".format(group_name, site))
  686. else:
  687. raise forms.ValidationError("Global VLAN group {} not found".format(group_name))
  688. class VLANBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
  689. pk = forms.ModelMultipleChoiceField(queryset=VLAN.objects.all(), widget=forms.MultipleHiddenInput)
  690. site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False)
  691. group = forms.ModelChoiceField(queryset=VLANGroup.objects.all(), required=False)
  692. tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
  693. status = forms.ChoiceField(choices=add_blank_choice(VLAN_STATUS_CHOICES), required=False)
  694. role = forms.ModelChoiceField(queryset=Role.objects.all(), required=False)
  695. description = forms.CharField(max_length=100, required=False)
  696. class Meta:
  697. nullable_fields = ['site', 'group', 'tenant', 'role', 'description']
  698. def vlan_status_choices():
  699. status_counts = {}
  700. for status in VLAN.objects.values('status').annotate(count=Count('status')).order_by('status'):
  701. status_counts[status['status']] = status['count']
  702. return [(s[0], '{} ({})'.format(s[1], status_counts.get(s[0], 0))) for s in VLAN_STATUS_CHOICES]
  703. class VLANFilterForm(BootstrapMixin, CustomFieldFilterForm):
  704. model = VLAN
  705. q = forms.CharField(required=False, label='Search')
  706. site = FilterChoiceField(
  707. queryset=Site.objects.annotate(filter_count=Count('vlans')),
  708. to_field_name='slug',
  709. null_option=(0, 'Global')
  710. )
  711. group_id = FilterChoiceField(
  712. queryset=VLANGroup.objects.annotate(filter_count=Count('vlans')),
  713. label='VLAN group',
  714. null_option=(0, 'None')
  715. )
  716. tenant = FilterChoiceField(
  717. queryset=Tenant.objects.annotate(filter_count=Count('vlans')),
  718. to_field_name='slug',
  719. null_option=(0, 'None')
  720. )
  721. status = forms.MultipleChoiceField(choices=vlan_status_choices, required=False)
  722. role = FilterChoiceField(
  723. queryset=Role.objects.annotate(filter_count=Count('vlans')),
  724. to_field_name='slug',
  725. null_option=(0, 'None')
  726. )
  727. #
  728. # Services
  729. #
  730. class ServiceForm(BootstrapMixin, forms.ModelForm):
  731. class Meta:
  732. model = Service
  733. fields = ['name', 'protocol', 'port', 'ipaddresses', 'description']
  734. help_texts = {
  735. 'ipaddresses': "IP address assignment is optional. If no IPs are selected, the service is assumed to be "
  736. "reachable via all IPs assigned to the device.",
  737. }
  738. def __init__(self, *args, **kwargs):
  739. super(ServiceForm, self).__init__(*args, **kwargs)
  740. # Limit IP address choices to those assigned to interfaces of the parent device
  741. self.fields['ipaddresses'].queryset = IPAddress.objects.filter(interface__device=self.instance.device)