forms.py 130 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678
  1. import re
  2. from django import forms
  3. from django.contrib.auth.models import User
  4. from django.contrib.contenttypes.models import ContentType
  5. from django.contrib.postgres.forms.array import SimpleArrayField
  6. from django.core.exceptions import ObjectDoesNotExist
  7. from django.utils.safestring import mark_safe
  8. from mptt.forms import TreeNodeChoiceField
  9. from netaddr import EUI
  10. from netaddr.core import AddrFormatError
  11. from timezone_field import TimeZoneFormField
  12. from circuits.models import Circuit, Provider
  13. from extras.forms import (
  14. AddRemoveTagsForm, CustomFieldBulkEditForm, CustomFieldModelCSVForm, CustomFieldFilterForm, CustomFieldModelForm,
  15. LocalConfigContextFilterForm, TagField,
  16. )
  17. from ipam.constants import BGP_ASN_MAX, BGP_ASN_MIN
  18. from ipam.models import IPAddress, VLAN
  19. from tenancy.forms import TenancyFilterForm, TenancyForm
  20. from tenancy.models import Tenant, TenantGroup
  21. from utilities.forms import (
  22. APISelect, APISelectMultiple, add_blank_choice, BootstrapMixin, BulkEditForm, BulkEditNullBooleanSelect,
  23. ColorSelect, CommentField, ConfirmationForm, CSVChoiceField, CSVModelChoiceField, CSVModelForm,
  24. DynamicModelChoiceField, DynamicModelMultipleChoiceField, ExpandableNameField, form_from_model, JSONField,
  25. NumericArrayField, SelectWithPK, SmallTextarea, SlugField, StaticSelect2, StaticSelect2Multiple, TagFilterField,
  26. BOOLEAN_WITH_BLANK_CHOICES,
  27. )
  28. from virtualization.models import Cluster, ClusterGroup, VirtualMachine
  29. from .choices import *
  30. from .constants import *
  31. from .models import (
  32. Cable, DeviceBay, DeviceBayTemplate, ConsolePort, ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate,
  33. Device, DeviceRole, DeviceType, FrontPort, FrontPortTemplate, Interface, InterfaceTemplate, Manufacturer,
  34. InventoryItem, Platform, PowerFeed, PowerOutlet, PowerOutletTemplate, PowerPanel, PowerPort, PowerPortTemplate,
  35. Rack, RackGroup, RackReservation, RackRole, RearPort, RearPortTemplate, Region, Site, VirtualChassis,
  36. )
  37. DEVICE_BY_PK_RE = r'{\d+\}'
  38. INTERFACE_MODE_HELP_TEXT = """
  39. Access: One untagged VLAN<br />
  40. Tagged: One untagged VLAN and/or one or more tagged VLANs<br />
  41. Tagged (All): Implies all VLANs are available (w/optional untagged VLAN)
  42. """
  43. def get_device_by_name_or_pk(name):
  44. """
  45. Attempt to retrieve a device by either its name or primary key ('{pk}').
  46. """
  47. if re.match(DEVICE_BY_PK_RE, name):
  48. pk = name.strip('{}')
  49. device = Device.objects.get(pk=pk)
  50. else:
  51. device = Device.objects.get(name=name)
  52. return device
  53. class DeviceComponentFilterForm(BootstrapMixin, forms.Form):
  54. field_order = [
  55. 'q', 'region', 'site'
  56. ]
  57. q = forms.CharField(
  58. required=False,
  59. label='Search'
  60. )
  61. region = DynamicModelMultipleChoiceField(
  62. queryset=Region.objects.all(),
  63. to_field_name='slug',
  64. required=False,
  65. widget=APISelectMultiple(
  66. value_field='slug',
  67. filter_for={
  68. 'site': 'region'
  69. }
  70. )
  71. )
  72. site = DynamicModelMultipleChoiceField(
  73. queryset=Site.objects.all(),
  74. to_field_name='slug',
  75. required=False,
  76. widget=APISelectMultiple(
  77. value_field="slug",
  78. filter_for={
  79. 'device_id': 'site',
  80. }
  81. )
  82. )
  83. device_id = DynamicModelMultipleChoiceField(
  84. queryset=Device.objects.all(),
  85. required=False,
  86. label='Device'
  87. )
  88. class InterfaceCommonForm:
  89. def clean(self):
  90. super().clean()
  91. # Validate VLAN assignments
  92. tagged_vlans = self.cleaned_data['tagged_vlans']
  93. # Untagged interfaces cannot be assigned tagged VLANs
  94. if self.cleaned_data['mode'] == InterfaceModeChoices.MODE_ACCESS and tagged_vlans:
  95. raise forms.ValidationError({
  96. 'mode': "An access interface cannot have tagged VLANs assigned."
  97. })
  98. # Remove all tagged VLAN assignments from "tagged all" interfaces
  99. elif self.cleaned_data['mode'] == InterfaceModeChoices.MODE_TAGGED_ALL:
  100. self.cleaned_data['tagged_vlans'] = []
  101. # Validate tagged VLANs; must be a global VLAN or in the same site
  102. elif self.cleaned_data['mode'] == InterfaceModeChoices.MODE_TAGGED:
  103. valid_sites = [None, self.cleaned_data['device'].site]
  104. invalid_vlans = [str(v) for v in tagged_vlans if v.site not in valid_sites]
  105. if invalid_vlans:
  106. raise forms.ValidationError({
  107. 'tagged_vlans': "The tagged VLANs ({}) must belong to the same site as the interface's parent "
  108. "device/VM, or they must be global".format(', '.join(invalid_vlans))
  109. })
  110. class BulkRenameForm(forms.Form):
  111. """
  112. An extendable form to be used for renaming device components in bulk.
  113. """
  114. find = forms.CharField()
  115. replace = forms.CharField()
  116. use_regex = forms.BooleanField(
  117. required=False,
  118. initial=True,
  119. label='Use regular expressions'
  120. )
  121. def clean(self):
  122. # Validate regular expression in "find" field
  123. if self.cleaned_data['use_regex']:
  124. try:
  125. re.compile(self.cleaned_data['find'])
  126. except re.error:
  127. raise forms.ValidationError({
  128. 'find': "Invalid regular expression"
  129. })
  130. #
  131. # Fields
  132. #
  133. class MACAddressField(forms.Field):
  134. widget = forms.CharField
  135. default_error_messages = {
  136. 'invalid': 'MAC address must be in EUI-48 format',
  137. }
  138. def to_python(self, value):
  139. value = super().to_python(value)
  140. # Validate MAC address format
  141. try:
  142. value = EUI(value.strip())
  143. except AddrFormatError:
  144. raise forms.ValidationError(self.error_messages['invalid'], code='invalid')
  145. return value
  146. #
  147. # Regions
  148. #
  149. class RegionForm(BootstrapMixin, forms.ModelForm):
  150. parent = TreeNodeChoiceField(
  151. queryset=Region.objects.all(),
  152. required=False,
  153. widget=StaticSelect2()
  154. )
  155. slug = SlugField()
  156. class Meta:
  157. model = Region
  158. fields = (
  159. 'parent', 'name', 'slug', 'description',
  160. )
  161. class RegionCSVForm(CSVModelForm):
  162. parent = CSVModelChoiceField(
  163. queryset=Region.objects.all(),
  164. required=False,
  165. to_field_name='name',
  166. help_text='Name of parent region'
  167. )
  168. class Meta:
  169. model = Region
  170. fields = Region.csv_headers
  171. class RegionFilterForm(BootstrapMixin, forms.Form):
  172. model = Site
  173. q = forms.CharField(
  174. required=False,
  175. label='Search'
  176. )
  177. #
  178. # Sites
  179. #
  180. class SiteForm(BootstrapMixin, TenancyForm, CustomFieldModelForm):
  181. region = TreeNodeChoiceField(
  182. queryset=Region.objects.all(),
  183. required=False,
  184. widget=StaticSelect2()
  185. )
  186. slug = SlugField()
  187. comments = CommentField()
  188. tags = TagField(
  189. required=False
  190. )
  191. class Meta:
  192. model = Site
  193. fields = [
  194. 'name', 'slug', 'status', 'region', 'tenant_group', 'tenant', 'facility', 'asn', 'time_zone', 'description',
  195. 'physical_address', 'shipping_address', 'latitude', 'longitude', 'contact_name', 'contact_phone',
  196. 'contact_email', 'comments', 'tags',
  197. ]
  198. widgets = {
  199. 'physical_address': SmallTextarea(
  200. attrs={
  201. 'rows': 3,
  202. }
  203. ),
  204. 'shipping_address': SmallTextarea(
  205. attrs={
  206. 'rows': 3,
  207. }
  208. ),
  209. 'status': StaticSelect2(),
  210. 'time_zone': StaticSelect2(),
  211. }
  212. help_texts = {
  213. 'name': "Full name of the site",
  214. 'facility': "Data center provider and facility (e.g. Equinix NY7)",
  215. 'asn': "BGP autonomous system number",
  216. 'time_zone': "Local time zone",
  217. 'description': "Short description (will appear in sites list)",
  218. 'physical_address': "Physical location of the building (e.g. for GPS)",
  219. 'shipping_address': "If different from the physical address",
  220. 'latitude': "Latitude in decimal format (xx.yyyyyy)",
  221. 'longitude': "Longitude in decimal format (xx.yyyyyy)"
  222. }
  223. class SiteCSVForm(CustomFieldModelCSVForm):
  224. status = CSVChoiceField(
  225. choices=SiteStatusChoices,
  226. required=False,
  227. help_text='Operational status'
  228. )
  229. region = CSVModelChoiceField(
  230. queryset=Region.objects.all(),
  231. required=False,
  232. to_field_name='name',
  233. help_text='Assigned region'
  234. )
  235. tenant = CSVModelChoiceField(
  236. queryset=Tenant.objects.all(),
  237. required=False,
  238. to_field_name='name',
  239. help_text='Assigned tenant'
  240. )
  241. class Meta:
  242. model = Site
  243. fields = Site.csv_headers
  244. help_texts = {
  245. 'time_zone': mark_safe(
  246. 'Time zone (<a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones">available options</a>)'
  247. )
  248. }
  249. class SiteBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm):
  250. pk = forms.ModelMultipleChoiceField(
  251. queryset=Site.objects.all(),
  252. widget=forms.MultipleHiddenInput
  253. )
  254. status = forms.ChoiceField(
  255. choices=add_blank_choice(SiteStatusChoices),
  256. required=False,
  257. initial='',
  258. widget=StaticSelect2()
  259. )
  260. region = TreeNodeChoiceField(
  261. queryset=Region.objects.all(),
  262. required=False,
  263. widget=StaticSelect2()
  264. )
  265. tenant = DynamicModelChoiceField(
  266. queryset=Tenant.objects.all(),
  267. required=False
  268. )
  269. asn = forms.IntegerField(
  270. min_value=BGP_ASN_MIN,
  271. max_value=BGP_ASN_MAX,
  272. required=False,
  273. label='ASN'
  274. )
  275. description = forms.CharField(
  276. max_length=100,
  277. required=False
  278. )
  279. time_zone = TimeZoneFormField(
  280. choices=add_blank_choice(TimeZoneFormField().choices),
  281. required=False,
  282. widget=StaticSelect2()
  283. )
  284. class Meta:
  285. nullable_fields = [
  286. 'region', 'tenant', 'asn', 'description', 'time_zone',
  287. ]
  288. class SiteFilterForm(BootstrapMixin, TenancyFilterForm, CustomFieldFilterForm):
  289. model = Site
  290. field_order = ['q', 'status', 'region', 'tenant_group', 'tenant']
  291. q = forms.CharField(
  292. required=False,
  293. label='Search'
  294. )
  295. status = forms.MultipleChoiceField(
  296. choices=SiteStatusChoices,
  297. required=False,
  298. widget=StaticSelect2Multiple()
  299. )
  300. region = DynamicModelMultipleChoiceField(
  301. queryset=Region.objects.all(),
  302. to_field_name='slug',
  303. required=False,
  304. widget=APISelectMultiple(
  305. value_field="slug",
  306. )
  307. )
  308. tag = TagFilterField(model)
  309. #
  310. # Rack groups
  311. #
  312. class RackGroupForm(BootstrapMixin, forms.ModelForm):
  313. site = DynamicModelChoiceField(
  314. queryset=Site.objects.all(),
  315. widget=APISelect(
  316. filter_for={
  317. 'parent': 'site_id',
  318. }
  319. )
  320. )
  321. parent = DynamicModelChoiceField(
  322. queryset=RackGroup.objects.all(),
  323. required=False
  324. )
  325. slug = SlugField()
  326. class Meta:
  327. model = RackGroup
  328. fields = (
  329. 'site', 'parent', 'name', 'slug', 'description',
  330. )
  331. class RackGroupCSVForm(CSVModelForm):
  332. site = CSVModelChoiceField(
  333. queryset=Site.objects.all(),
  334. to_field_name='name',
  335. help_text='Assigned site'
  336. )
  337. parent = CSVModelChoiceField(
  338. queryset=RackGroup.objects.all(),
  339. required=False,
  340. to_field_name='name',
  341. help_text='Parent rack group',
  342. error_messages={
  343. 'invalid_choice': 'Rack group not found.',
  344. }
  345. )
  346. class Meta:
  347. model = RackGroup
  348. fields = RackGroup.csv_headers
  349. class RackGroupFilterForm(BootstrapMixin, forms.Form):
  350. region = DynamicModelMultipleChoiceField(
  351. queryset=Region.objects.all(),
  352. to_field_name='slug',
  353. required=False,
  354. widget=APISelectMultiple(
  355. value_field="slug",
  356. filter_for={
  357. 'site': 'region',
  358. 'parent': 'region',
  359. }
  360. )
  361. )
  362. site = DynamicModelMultipleChoiceField(
  363. queryset=Site.objects.all(),
  364. to_field_name='slug',
  365. required=False,
  366. widget=APISelectMultiple(
  367. value_field="slug",
  368. filter_for={
  369. 'parent': 'site',
  370. }
  371. )
  372. )
  373. parent = DynamicModelMultipleChoiceField(
  374. queryset=RackGroup.objects.all(),
  375. to_field_name='slug',
  376. required=False,
  377. widget=APISelectMultiple(
  378. api_url="/api/dcim/rack-groups/",
  379. value_field="slug",
  380. )
  381. )
  382. #
  383. # Rack roles
  384. #
  385. class RackRoleForm(BootstrapMixin, forms.ModelForm):
  386. slug = SlugField()
  387. class Meta:
  388. model = RackRole
  389. fields = [
  390. 'name', 'slug', 'color', 'description',
  391. ]
  392. class RackRoleCSVForm(CSVModelForm):
  393. slug = SlugField()
  394. class Meta:
  395. model = RackRole
  396. fields = RackRole.csv_headers
  397. help_texts = {
  398. 'color': mark_safe('RGB color in hexadecimal (e.g. <code>00ff00</code>)'),
  399. }
  400. #
  401. # Racks
  402. #
  403. class RackForm(BootstrapMixin, TenancyForm, CustomFieldModelForm):
  404. site = DynamicModelChoiceField(
  405. queryset=Site.objects.all(),
  406. widget=APISelect(
  407. filter_for={
  408. 'group': 'site_id',
  409. }
  410. )
  411. )
  412. group = DynamicModelChoiceField(
  413. queryset=RackGroup.objects.all(),
  414. required=False
  415. )
  416. role = DynamicModelChoiceField(
  417. queryset=RackRole.objects.all(),
  418. required=False
  419. )
  420. comments = CommentField()
  421. tags = TagField(
  422. required=False
  423. )
  424. class Meta:
  425. model = Rack
  426. fields = [
  427. 'site', 'group', 'name', 'facility_id', 'tenant_group', 'tenant', 'status', 'role', 'serial', 'asset_tag',
  428. 'type', 'width', 'u_height', 'desc_units', 'outer_width', 'outer_depth', 'outer_unit', 'comments', 'tags',
  429. ]
  430. help_texts = {
  431. 'site': "The site at which the rack exists",
  432. 'name': "Organizational rack name",
  433. 'facility_id': "The unique rack ID assigned by the facility",
  434. 'u_height': "Height in rack units",
  435. }
  436. widgets = {
  437. 'status': StaticSelect2(),
  438. 'type': StaticSelect2(),
  439. 'width': StaticSelect2(),
  440. 'outer_unit': StaticSelect2(),
  441. }
  442. class RackCSVForm(CustomFieldModelCSVForm):
  443. site = CSVModelChoiceField(
  444. queryset=Site.objects.all(),
  445. to_field_name='name'
  446. )
  447. group = CSVModelChoiceField(
  448. queryset=RackGroup.objects.all(),
  449. required=False,
  450. to_field_name='name'
  451. )
  452. tenant = CSVModelChoiceField(
  453. queryset=Tenant.objects.all(),
  454. required=False,
  455. to_field_name='name',
  456. help_text='Name of assigned tenant'
  457. )
  458. status = CSVChoiceField(
  459. choices=RackStatusChoices,
  460. required=False,
  461. help_text='Operational status'
  462. )
  463. role = CSVModelChoiceField(
  464. queryset=RackRole.objects.all(),
  465. required=False,
  466. to_field_name='name',
  467. help_text='Name of assigned role'
  468. )
  469. type = CSVChoiceField(
  470. choices=RackTypeChoices,
  471. required=False,
  472. help_text='Rack type'
  473. )
  474. width = forms.ChoiceField(
  475. choices=RackWidthChoices,
  476. help_text='Rail-to-rail width (in inches)'
  477. )
  478. outer_unit = CSVChoiceField(
  479. choices=RackDimensionUnitChoices,
  480. required=False,
  481. help_text='Unit for outer dimensions'
  482. )
  483. class Meta:
  484. model = Rack
  485. fields = Rack.csv_headers
  486. def __init__(self, data=None, *args, **kwargs):
  487. super().__init__(data, *args, **kwargs)
  488. if data:
  489. # Limit group queryset by assigned site
  490. params = {f"site__{self.fields['site'].to_field_name}": data.get('site')}
  491. self.fields['group'].queryset = self.fields['group'].queryset.filter(**params)
  492. class RackBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm):
  493. pk = forms.ModelMultipleChoiceField(
  494. queryset=Rack.objects.all(),
  495. widget=forms.MultipleHiddenInput
  496. )
  497. site = DynamicModelChoiceField(
  498. queryset=Site.objects.all(),
  499. required=False,
  500. widget=APISelect(
  501. filter_for={
  502. 'group': 'site_id',
  503. }
  504. )
  505. )
  506. group = DynamicModelChoiceField(
  507. queryset=RackGroup.objects.all(),
  508. required=False
  509. )
  510. tenant = DynamicModelChoiceField(
  511. queryset=Tenant.objects.all(),
  512. required=False
  513. )
  514. status = forms.ChoiceField(
  515. choices=add_blank_choice(RackStatusChoices),
  516. required=False,
  517. initial='',
  518. widget=StaticSelect2()
  519. )
  520. role = DynamicModelChoiceField(
  521. queryset=RackRole.objects.all(),
  522. required=False
  523. )
  524. serial = forms.CharField(
  525. max_length=50,
  526. required=False,
  527. label='Serial Number'
  528. )
  529. asset_tag = forms.CharField(
  530. max_length=50,
  531. required=False
  532. )
  533. type = forms.ChoiceField(
  534. choices=add_blank_choice(RackTypeChoices),
  535. required=False,
  536. widget=StaticSelect2()
  537. )
  538. width = forms.ChoiceField(
  539. choices=add_blank_choice(RackWidthChoices),
  540. required=False,
  541. widget=StaticSelect2()
  542. )
  543. u_height = forms.IntegerField(
  544. required=False,
  545. label='Height (U)'
  546. )
  547. desc_units = forms.NullBooleanField(
  548. required=False,
  549. widget=BulkEditNullBooleanSelect,
  550. label='Descending units'
  551. )
  552. outer_width = forms.IntegerField(
  553. required=False,
  554. min_value=1
  555. )
  556. outer_depth = forms.IntegerField(
  557. required=False,
  558. min_value=1
  559. )
  560. outer_unit = forms.ChoiceField(
  561. choices=add_blank_choice(RackDimensionUnitChoices),
  562. required=False,
  563. widget=StaticSelect2()
  564. )
  565. comments = CommentField(
  566. widget=SmallTextarea,
  567. label='Comments'
  568. )
  569. class Meta:
  570. nullable_fields = [
  571. 'group', 'tenant', 'role', 'serial', 'asset_tag', 'outer_width', 'outer_depth', 'outer_unit', 'comments',
  572. ]
  573. class RackFilterForm(BootstrapMixin, TenancyFilterForm, CustomFieldFilterForm):
  574. model = Rack
  575. field_order = ['q', 'region', 'site', 'group_id', 'status', 'role', 'tenant_group', 'tenant']
  576. q = forms.CharField(
  577. required=False,
  578. label='Search'
  579. )
  580. region = DynamicModelMultipleChoiceField(
  581. queryset=Region.objects.all(),
  582. to_field_name='slug',
  583. required=False,
  584. widget=APISelectMultiple(
  585. value_field="slug",
  586. filter_for={
  587. 'site': 'region'
  588. }
  589. )
  590. )
  591. site = DynamicModelMultipleChoiceField(
  592. queryset=Site.objects.all(),
  593. to_field_name='slug',
  594. required=False,
  595. widget=APISelectMultiple(
  596. value_field="slug",
  597. filter_for={
  598. 'group_id': 'site'
  599. }
  600. )
  601. )
  602. group_id = DynamicModelMultipleChoiceField(
  603. queryset=RackGroup.objects.prefetch_related(
  604. 'site'
  605. ),
  606. required=False,
  607. label='Rack group',
  608. widget=APISelectMultiple(
  609. null_option=True
  610. )
  611. )
  612. status = forms.MultipleChoiceField(
  613. choices=RackStatusChoices,
  614. required=False,
  615. widget=StaticSelect2Multiple()
  616. )
  617. role = DynamicModelMultipleChoiceField(
  618. queryset=RackRole.objects.all(),
  619. to_field_name='slug',
  620. required=False,
  621. widget=APISelectMultiple(
  622. value_field="slug",
  623. null_option=True,
  624. )
  625. )
  626. tag = TagFilterField(model)
  627. #
  628. # Rack elevations
  629. #
  630. class RackElevationFilterForm(RackFilterForm):
  631. field_order = ['q', 'region', 'site', 'group_id', 'id', 'status', 'role', 'tenant_group', 'tenant']
  632. id = DynamicModelMultipleChoiceField(
  633. queryset=Rack.objects.all(),
  634. label='Rack',
  635. required=False,
  636. widget=APISelectMultiple(
  637. display_field='display_name',
  638. )
  639. )
  640. def __init__(self, *args, **kwargs):
  641. super().__init__(*args, **kwargs)
  642. # Filter the rack field based on the site and group
  643. self.fields['site'].widget.add_filter_for('id', 'site')
  644. self.fields['group_id'].widget.add_filter_for('id', 'group_id')
  645. #
  646. # Rack reservations
  647. #
  648. class RackReservationForm(BootstrapMixin, TenancyForm, forms.ModelForm):
  649. site = DynamicModelChoiceField(
  650. queryset=Site.objects.all(),
  651. required=False,
  652. widget=APISelect(
  653. filter_for={
  654. 'rack_group': 'site_id',
  655. 'rack': 'site_id',
  656. }
  657. )
  658. )
  659. rack_group = DynamicModelChoiceField(
  660. queryset=RackGroup.objects.all(),
  661. required=False,
  662. widget=APISelect(
  663. filter_for={
  664. 'rack': 'group_id'
  665. }
  666. )
  667. )
  668. rack = DynamicModelChoiceField(
  669. queryset=Rack.objects.all()
  670. )
  671. units = NumericArrayField(
  672. base_field=forms.IntegerField(),
  673. help_text="Comma-separated list of numeric unit IDs. A range may be specified using a hyphen."
  674. )
  675. user = forms.ModelChoiceField(
  676. queryset=User.objects.order_by(
  677. 'username'
  678. ),
  679. widget=StaticSelect2()
  680. )
  681. class Meta:
  682. model = RackReservation
  683. fields = [
  684. 'rack', 'units', 'user', 'tenant_group', 'tenant', 'description',
  685. ]
  686. class RackReservationCSVForm(CSVModelForm):
  687. site = CSVModelChoiceField(
  688. queryset=Site.objects.all(),
  689. to_field_name='name',
  690. help_text='Parent site'
  691. )
  692. rack_group = CSVModelChoiceField(
  693. queryset=RackGroup.objects.all(),
  694. to_field_name='name',
  695. required=False,
  696. help_text="Rack's group (if any)"
  697. )
  698. rack = CSVModelChoiceField(
  699. queryset=Rack.objects.all(),
  700. to_field_name='name',
  701. help_text='Rack'
  702. )
  703. units = SimpleArrayField(
  704. base_field=forms.IntegerField(),
  705. required=True,
  706. help_text='Comma-separated list of individual unit numbers'
  707. )
  708. tenant = CSVModelChoiceField(
  709. queryset=Tenant.objects.all(),
  710. required=False,
  711. to_field_name='name',
  712. help_text='Assigned tenant'
  713. )
  714. class Meta:
  715. model = RackReservation
  716. fields = ('site', 'rack_group', 'rack', 'units', 'tenant', 'description')
  717. def __init__(self, data=None, *args, **kwargs):
  718. super().__init__(data, *args, **kwargs)
  719. if data:
  720. # Limit rack_group queryset by assigned site
  721. params = {f"site__{self.fields['site'].to_field_name}": data.get('site')}
  722. self.fields['rack_group'].queryset = self.fields['rack_group'].queryset.filter(**params)
  723. # Limit rack queryset by assigned site and group
  724. params = {
  725. f"site__{self.fields['site'].to_field_name}": data.get('site'),
  726. f"group__{self.fields['rack_group'].to_field_name}": data.get('rack_group'),
  727. }
  728. self.fields['rack'].queryset = self.fields['rack'].queryset.filter(**params)
  729. class RackReservationBulkEditForm(BootstrapMixin, BulkEditForm):
  730. pk = forms.ModelMultipleChoiceField(
  731. queryset=RackReservation.objects.all(),
  732. widget=forms.MultipleHiddenInput()
  733. )
  734. user = forms.ModelChoiceField(
  735. queryset=User.objects.order_by(
  736. 'username'
  737. ),
  738. required=False,
  739. widget=StaticSelect2()
  740. )
  741. tenant = DynamicModelChoiceField(
  742. queryset=Tenant.objects.all(),
  743. required=False
  744. )
  745. description = forms.CharField(
  746. max_length=100,
  747. required=False
  748. )
  749. class Meta:
  750. nullable_fields = []
  751. class RackReservationFilterForm(BootstrapMixin, TenancyFilterForm):
  752. field_order = ['q', 'site', 'group_id', 'tenant_group', 'tenant']
  753. q = forms.CharField(
  754. required=False,
  755. label='Search'
  756. )
  757. site = DynamicModelMultipleChoiceField(
  758. queryset=Site.objects.all(),
  759. to_field_name='slug',
  760. required=False,
  761. widget=APISelectMultiple(
  762. value_field="slug",
  763. )
  764. )
  765. group_id = DynamicModelMultipleChoiceField(
  766. queryset=RackGroup.objects.prefetch_related('site'),
  767. required=False,
  768. label='Rack group',
  769. widget=APISelectMultiple(
  770. null_option=True,
  771. )
  772. )
  773. #
  774. # Manufacturers
  775. #
  776. class ManufacturerForm(BootstrapMixin, forms.ModelForm):
  777. slug = SlugField()
  778. class Meta:
  779. model = Manufacturer
  780. fields = [
  781. 'name', 'slug', 'description',
  782. ]
  783. class ManufacturerCSVForm(CSVModelForm):
  784. class Meta:
  785. model = Manufacturer
  786. fields = Manufacturer.csv_headers
  787. #
  788. # Device types
  789. #
  790. class DeviceTypeForm(BootstrapMixin, CustomFieldModelForm):
  791. manufacturer = DynamicModelChoiceField(
  792. queryset=Manufacturer.objects.all()
  793. )
  794. slug = SlugField(
  795. slug_source='model'
  796. )
  797. comments = CommentField()
  798. tags = TagField(
  799. required=False
  800. )
  801. class Meta:
  802. model = DeviceType
  803. fields = [
  804. 'manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth', 'subdevice_role',
  805. 'front_image', 'rear_image', 'comments', 'tags',
  806. ]
  807. widgets = {
  808. 'subdevice_role': StaticSelect2()
  809. }
  810. class DeviceTypeImportForm(BootstrapMixin, forms.ModelForm):
  811. manufacturer = forms.ModelChoiceField(
  812. queryset=Manufacturer.objects.all(),
  813. to_field_name='name'
  814. )
  815. class Meta:
  816. model = DeviceType
  817. fields = [
  818. 'manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth', 'subdevice_role',
  819. 'comments',
  820. ]
  821. class DeviceTypeBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm):
  822. pk = forms.ModelMultipleChoiceField(
  823. queryset=DeviceType.objects.all(),
  824. widget=forms.MultipleHiddenInput()
  825. )
  826. manufacturer = DynamicModelChoiceField(
  827. queryset=Manufacturer.objects.all(),
  828. required=False
  829. )
  830. u_height = forms.IntegerField(
  831. min_value=1,
  832. required=False
  833. )
  834. is_full_depth = forms.NullBooleanField(
  835. required=False,
  836. widget=BulkEditNullBooleanSelect(),
  837. label='Is full depth'
  838. )
  839. class Meta:
  840. nullable_fields = []
  841. class DeviceTypeFilterForm(BootstrapMixin, CustomFieldFilterForm):
  842. model = DeviceType
  843. q = forms.CharField(
  844. required=False,
  845. label='Search'
  846. )
  847. manufacturer = DynamicModelMultipleChoiceField(
  848. queryset=Manufacturer.objects.all(),
  849. to_field_name='slug',
  850. required=False,
  851. widget=APISelectMultiple(
  852. value_field="slug",
  853. )
  854. )
  855. subdevice_role = forms.MultipleChoiceField(
  856. choices=add_blank_choice(SubdeviceRoleChoices),
  857. required=False,
  858. widget=StaticSelect2Multiple()
  859. )
  860. console_ports = forms.NullBooleanField(
  861. required=False,
  862. label='Has console ports',
  863. widget=StaticSelect2(
  864. choices=BOOLEAN_WITH_BLANK_CHOICES
  865. )
  866. )
  867. console_server_ports = forms.NullBooleanField(
  868. required=False,
  869. label='Has console server ports',
  870. widget=StaticSelect2(
  871. choices=BOOLEAN_WITH_BLANK_CHOICES
  872. )
  873. )
  874. power_ports = forms.NullBooleanField(
  875. required=False,
  876. label='Has power ports',
  877. widget=StaticSelect2(
  878. choices=BOOLEAN_WITH_BLANK_CHOICES
  879. )
  880. )
  881. power_outlets = forms.NullBooleanField(
  882. required=False,
  883. label='Has power outlets',
  884. widget=StaticSelect2(
  885. choices=BOOLEAN_WITH_BLANK_CHOICES
  886. )
  887. )
  888. interfaces = forms.NullBooleanField(
  889. required=False,
  890. label='Has interfaces',
  891. widget=StaticSelect2(
  892. choices=BOOLEAN_WITH_BLANK_CHOICES
  893. )
  894. )
  895. pass_through_ports = forms.NullBooleanField(
  896. required=False,
  897. label='Has pass-through ports',
  898. widget=StaticSelect2(
  899. choices=BOOLEAN_WITH_BLANK_CHOICES
  900. )
  901. )
  902. tag = TagFilterField(model)
  903. #
  904. # Device component templates
  905. #
  906. class ConsolePortTemplateForm(BootstrapMixin, forms.ModelForm):
  907. class Meta:
  908. model = ConsolePortTemplate
  909. fields = [
  910. 'device_type', 'name', 'type',
  911. ]
  912. widgets = {
  913. 'device_type': forms.HiddenInput(),
  914. }
  915. class ConsolePortTemplateCreateForm(BootstrapMixin, forms.Form):
  916. device_type = DynamicModelChoiceField(
  917. queryset=DeviceType.objects.all()
  918. )
  919. name_pattern = ExpandableNameField(
  920. label='Name'
  921. )
  922. type = forms.ChoiceField(
  923. choices=add_blank_choice(ConsolePortTypeChoices),
  924. widget=StaticSelect2()
  925. )
  926. class ConsolePortTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
  927. pk = forms.ModelMultipleChoiceField(
  928. queryset=ConsolePortTemplate.objects.all(),
  929. widget=forms.MultipleHiddenInput()
  930. )
  931. type = forms.ChoiceField(
  932. choices=add_blank_choice(ConsolePortTypeChoices),
  933. required=False,
  934. widget=StaticSelect2()
  935. )
  936. class Meta:
  937. nullable_fields = ('type',)
  938. class ConsoleServerPortTemplateForm(BootstrapMixin, forms.ModelForm):
  939. class Meta:
  940. model = ConsoleServerPortTemplate
  941. fields = [
  942. 'device_type', 'name', 'type',
  943. ]
  944. widgets = {
  945. 'device_type': forms.HiddenInput(),
  946. }
  947. class ConsoleServerPortTemplateCreateForm(BootstrapMixin, forms.Form):
  948. device_type = DynamicModelChoiceField(
  949. queryset=DeviceType.objects.all()
  950. )
  951. name_pattern = ExpandableNameField(
  952. label='Name'
  953. )
  954. type = forms.ChoiceField(
  955. choices=add_blank_choice(ConsolePortTypeChoices),
  956. widget=StaticSelect2()
  957. )
  958. class ConsoleServerPortTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
  959. pk = forms.ModelMultipleChoiceField(
  960. queryset=ConsoleServerPortTemplate.objects.all(),
  961. widget=forms.MultipleHiddenInput()
  962. )
  963. type = forms.ChoiceField(
  964. choices=add_blank_choice(ConsolePortTypeChoices),
  965. required=False,
  966. widget=StaticSelect2()
  967. )
  968. class Meta:
  969. nullable_fields = ('type',)
  970. class PowerPortTemplateForm(BootstrapMixin, forms.ModelForm):
  971. class Meta:
  972. model = PowerPortTemplate
  973. fields = [
  974. 'device_type', 'name', 'type', 'maximum_draw', 'allocated_draw',
  975. ]
  976. widgets = {
  977. 'device_type': forms.HiddenInput(),
  978. }
  979. class PowerPortTemplateCreateForm(BootstrapMixin, forms.Form):
  980. device_type = DynamicModelChoiceField(
  981. queryset=DeviceType.objects.all()
  982. )
  983. name_pattern = ExpandableNameField(
  984. label='Name'
  985. )
  986. type = forms.ChoiceField(
  987. choices=add_blank_choice(PowerPortTypeChoices),
  988. required=False
  989. )
  990. maximum_draw = forms.IntegerField(
  991. min_value=1,
  992. required=False,
  993. help_text="Maximum power draw (watts)"
  994. )
  995. allocated_draw = forms.IntegerField(
  996. min_value=1,
  997. required=False,
  998. help_text="Allocated power draw (watts)"
  999. )
  1000. class PowerPortTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
  1001. pk = forms.ModelMultipleChoiceField(
  1002. queryset=PowerPortTemplate.objects.all(),
  1003. widget=forms.MultipleHiddenInput()
  1004. )
  1005. type = forms.ChoiceField(
  1006. choices=add_blank_choice(PowerPortTypeChoices),
  1007. required=False,
  1008. widget=StaticSelect2()
  1009. )
  1010. maximum_draw = forms.IntegerField(
  1011. min_value=1,
  1012. required=False,
  1013. help_text="Maximum power draw (watts)"
  1014. )
  1015. allocated_draw = forms.IntegerField(
  1016. min_value=1,
  1017. required=False,
  1018. help_text="Allocated power draw (watts)"
  1019. )
  1020. class Meta:
  1021. nullable_fields = ('type', 'maximum_draw', 'allocated_draw')
  1022. class PowerOutletTemplateForm(BootstrapMixin, forms.ModelForm):
  1023. class Meta:
  1024. model = PowerOutletTemplate
  1025. fields = [
  1026. 'device_type', 'name', 'type', 'power_port', 'feed_leg',
  1027. ]
  1028. widgets = {
  1029. 'device_type': forms.HiddenInput(),
  1030. }
  1031. def __init__(self, *args, **kwargs):
  1032. super().__init__(*args, **kwargs)
  1033. # Limit power_port choices to current DeviceType
  1034. if hasattr(self.instance, 'device_type'):
  1035. self.fields['power_port'].queryset = PowerPortTemplate.objects.filter(
  1036. device_type=self.instance.device_type
  1037. )
  1038. class PowerOutletTemplateCreateForm(BootstrapMixin, forms.Form):
  1039. device_type = DynamicModelChoiceField(
  1040. queryset=DeviceType.objects.all()
  1041. )
  1042. name_pattern = ExpandableNameField(
  1043. label='Name'
  1044. )
  1045. type = forms.ChoiceField(
  1046. choices=add_blank_choice(PowerOutletTypeChoices),
  1047. required=False
  1048. )
  1049. power_port = forms.ModelChoiceField(
  1050. queryset=PowerPortTemplate.objects.all(),
  1051. required=False
  1052. )
  1053. feed_leg = forms.ChoiceField(
  1054. choices=add_blank_choice(PowerOutletFeedLegChoices),
  1055. required=False,
  1056. widget=StaticSelect2()
  1057. )
  1058. def __init__(self, *args, **kwargs):
  1059. super().__init__(*args, **kwargs)
  1060. # Limit power_port choices to current DeviceType
  1061. device_type = DeviceType.objects.get(
  1062. pk=self.initial.get('device_type') or self.data.get('device_type')
  1063. )
  1064. self.fields['power_port'].queryset = PowerPortTemplate.objects.filter(
  1065. device_type=device_type
  1066. )
  1067. class PowerOutletTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
  1068. pk = forms.ModelMultipleChoiceField(
  1069. queryset=PowerOutletTemplate.objects.all(),
  1070. widget=forms.MultipleHiddenInput()
  1071. )
  1072. type = forms.ChoiceField(
  1073. choices=add_blank_choice(PowerOutletTypeChoices),
  1074. required=False,
  1075. widget=StaticSelect2()
  1076. )
  1077. feed_leg = forms.ChoiceField(
  1078. choices=add_blank_choice(PowerOutletFeedLegChoices),
  1079. required=False,
  1080. widget=StaticSelect2()
  1081. )
  1082. class Meta:
  1083. nullable_fields = ('type', 'feed_leg')
  1084. class InterfaceTemplateForm(BootstrapMixin, forms.ModelForm):
  1085. class Meta:
  1086. model = InterfaceTemplate
  1087. fields = [
  1088. 'device_type', 'name', 'type', 'mgmt_only',
  1089. ]
  1090. widgets = {
  1091. 'device_type': forms.HiddenInput(),
  1092. 'type': StaticSelect2(),
  1093. }
  1094. class InterfaceTemplateCreateForm(BootstrapMixin, forms.Form):
  1095. device_type = DynamicModelChoiceField(
  1096. queryset=DeviceType.objects.all()
  1097. )
  1098. name_pattern = ExpandableNameField(
  1099. label='Name'
  1100. )
  1101. type = forms.ChoiceField(
  1102. choices=InterfaceTypeChoices,
  1103. widget=StaticSelect2()
  1104. )
  1105. mgmt_only = forms.BooleanField(
  1106. required=False,
  1107. label='Management only'
  1108. )
  1109. class InterfaceTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
  1110. pk = forms.ModelMultipleChoiceField(
  1111. queryset=InterfaceTemplate.objects.all(),
  1112. widget=forms.MultipleHiddenInput()
  1113. )
  1114. type = forms.ChoiceField(
  1115. choices=add_blank_choice(InterfaceTypeChoices),
  1116. required=False,
  1117. widget=StaticSelect2()
  1118. )
  1119. mgmt_only = forms.NullBooleanField(
  1120. required=False,
  1121. widget=BulkEditNullBooleanSelect,
  1122. label='Management only'
  1123. )
  1124. class Meta:
  1125. nullable_fields = []
  1126. class FrontPortTemplateForm(BootstrapMixin, forms.ModelForm):
  1127. class Meta:
  1128. model = FrontPortTemplate
  1129. fields = [
  1130. 'device_type', 'name', 'type', 'rear_port', 'rear_port_position',
  1131. ]
  1132. widgets = {
  1133. 'device_type': forms.HiddenInput(),
  1134. 'rear_port': StaticSelect2(),
  1135. }
  1136. def __init__(self, *args, **kwargs):
  1137. super().__init__(*args, **kwargs)
  1138. # Limit rear_port choices to current DeviceType
  1139. if hasattr(self.instance, 'device_type'):
  1140. self.fields['rear_port'].queryset = RearPortTemplate.objects.filter(
  1141. device_type=self.instance.device_type
  1142. )
  1143. class FrontPortTemplateCreateForm(BootstrapMixin, forms.Form):
  1144. device_type = DynamicModelChoiceField(
  1145. queryset=DeviceType.objects.all()
  1146. )
  1147. name_pattern = ExpandableNameField(
  1148. label='Name'
  1149. )
  1150. type = forms.ChoiceField(
  1151. choices=PortTypeChoices,
  1152. widget=StaticSelect2()
  1153. )
  1154. rear_port_set = forms.MultipleChoiceField(
  1155. choices=[],
  1156. label='Rear ports',
  1157. help_text='Select one rear port assignment for each front port being created.',
  1158. )
  1159. def __init__(self, *args, **kwargs):
  1160. super().__init__(*args, **kwargs)
  1161. device_type = DeviceType.objects.get(
  1162. pk=self.initial.get('device_type') or self.data.get('device_type')
  1163. )
  1164. # Determine which rear port positions are occupied. These will be excluded from the list of available mappings.
  1165. occupied_port_positions = [
  1166. (front_port.rear_port_id, front_port.rear_port_position)
  1167. for front_port in device_type.frontport_templates.all()
  1168. ]
  1169. # Populate rear port choices
  1170. choices = []
  1171. rear_ports = RearPortTemplate.objects.filter(device_type=device_type)
  1172. for rear_port in rear_ports:
  1173. for i in range(1, rear_port.positions + 1):
  1174. if (rear_port.pk, i) not in occupied_port_positions:
  1175. choices.append(
  1176. ('{}:{}'.format(rear_port.pk, i), '{}:{}'.format(rear_port.name, i))
  1177. )
  1178. self.fields['rear_port_set'].choices = choices
  1179. def clean(self):
  1180. # Validate that the number of ports being created equals the number of selected (rear port, position) tuples
  1181. front_port_count = len(self.cleaned_data['name_pattern'])
  1182. rear_port_count = len(self.cleaned_data['rear_port_set'])
  1183. if front_port_count != rear_port_count:
  1184. raise forms.ValidationError({
  1185. 'rear_port_set': 'The provided name pattern will create {} ports, however {} rear port assignments '
  1186. 'were selected. These counts must match.'.format(front_port_count, rear_port_count)
  1187. })
  1188. def get_iterative_data(self, iteration):
  1189. # Assign rear port and position from selected set
  1190. rear_port, position = self.cleaned_data['rear_port_set'][iteration].split(':')
  1191. return {
  1192. 'rear_port': int(rear_port),
  1193. 'rear_port_position': int(position),
  1194. }
  1195. class FrontPortTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
  1196. pk = forms.ModelMultipleChoiceField(
  1197. queryset=FrontPortTemplate.objects.all(),
  1198. widget=forms.MultipleHiddenInput()
  1199. )
  1200. type = forms.ChoiceField(
  1201. choices=add_blank_choice(PortTypeChoices),
  1202. required=False,
  1203. widget=StaticSelect2()
  1204. )
  1205. class Meta:
  1206. nullable_fields = ()
  1207. class RearPortTemplateForm(BootstrapMixin, forms.ModelForm):
  1208. class Meta:
  1209. model = RearPortTemplate
  1210. fields = [
  1211. 'device_type', 'name', 'type', 'positions',
  1212. ]
  1213. widgets = {
  1214. 'device_type': forms.HiddenInput(),
  1215. 'type': StaticSelect2(),
  1216. }
  1217. class RearPortTemplateCreateForm(BootstrapMixin, forms.Form):
  1218. device_type = DynamicModelChoiceField(
  1219. queryset=DeviceType.objects.all()
  1220. )
  1221. name_pattern = ExpandableNameField(
  1222. label='Name'
  1223. )
  1224. type = forms.ChoiceField(
  1225. choices=PortTypeChoices,
  1226. widget=StaticSelect2(),
  1227. )
  1228. positions = forms.IntegerField(
  1229. min_value=REARPORT_POSITIONS_MIN,
  1230. max_value=REARPORT_POSITIONS_MAX,
  1231. initial=1,
  1232. help_text='The number of front ports which may be mapped to each rear port'
  1233. )
  1234. class RearPortTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
  1235. pk = forms.ModelMultipleChoiceField(
  1236. queryset=RearPortTemplate.objects.all(),
  1237. widget=forms.MultipleHiddenInput()
  1238. )
  1239. type = forms.ChoiceField(
  1240. choices=add_blank_choice(PortTypeChoices),
  1241. required=False,
  1242. widget=StaticSelect2()
  1243. )
  1244. class Meta:
  1245. nullable_fields = ()
  1246. class DeviceBayTemplateForm(BootstrapMixin, forms.ModelForm):
  1247. class Meta:
  1248. model = DeviceBayTemplate
  1249. fields = [
  1250. 'device_type', 'name',
  1251. ]
  1252. widgets = {
  1253. 'device_type': forms.HiddenInput(),
  1254. }
  1255. class DeviceBayTemplateCreateForm(BootstrapMixin, forms.Form):
  1256. device_type = DynamicModelChoiceField(
  1257. queryset=DeviceType.objects.all()
  1258. )
  1259. name_pattern = ExpandableNameField(
  1260. label='Name'
  1261. )
  1262. # TODO: DeviceBayTemplate has no fields suitable for bulk-editing yet
  1263. # class DeviceBayTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
  1264. # pk = forms.ModelMultipleChoiceField(
  1265. # queryset=FrontPortTemplate.objects.all(),
  1266. # widget=forms.MultipleHiddenInput()
  1267. # )
  1268. #
  1269. # class Meta:
  1270. # nullable_fields = ()
  1271. #
  1272. # Component template import forms
  1273. #
  1274. class ComponentTemplateImportForm(BootstrapMixin, forms.ModelForm):
  1275. def __init__(self, device_type, data=None, *args, **kwargs):
  1276. # Must pass the parent DeviceType on form initialization
  1277. data.update({
  1278. 'device_type': device_type.pk,
  1279. })
  1280. super().__init__(data, *args, **kwargs)
  1281. def clean_device_type(self):
  1282. data = self.cleaned_data['device_type']
  1283. # Limit fields referencing other components to the parent DeviceType
  1284. for field_name, field in self.fields.items():
  1285. if isinstance(field, forms.ModelChoiceField) and field_name != 'device_type':
  1286. field.queryset = field.queryset.filter(device_type=data)
  1287. return data
  1288. class ConsolePortTemplateImportForm(ComponentTemplateImportForm):
  1289. class Meta:
  1290. model = ConsolePortTemplate
  1291. fields = [
  1292. 'device_type', 'name', 'type',
  1293. ]
  1294. class ConsoleServerPortTemplateImportForm(ComponentTemplateImportForm):
  1295. class Meta:
  1296. model = ConsoleServerPortTemplate
  1297. fields = [
  1298. 'device_type', 'name', 'type',
  1299. ]
  1300. class PowerPortTemplateImportForm(ComponentTemplateImportForm):
  1301. class Meta:
  1302. model = PowerPortTemplate
  1303. fields = [
  1304. 'device_type', 'name', 'type', 'maximum_draw', 'allocated_draw',
  1305. ]
  1306. class PowerOutletTemplateImportForm(ComponentTemplateImportForm):
  1307. power_port = forms.ModelChoiceField(
  1308. queryset=PowerPortTemplate.objects.all(),
  1309. to_field_name='name',
  1310. required=False
  1311. )
  1312. class Meta:
  1313. model = PowerOutletTemplate
  1314. fields = [
  1315. 'device_type', 'name', 'type', 'power_port', 'feed_leg',
  1316. ]
  1317. class InterfaceTemplateImportForm(ComponentTemplateImportForm):
  1318. type = forms.ChoiceField(
  1319. choices=InterfaceTypeChoices.CHOICES
  1320. )
  1321. class Meta:
  1322. model = InterfaceTemplate
  1323. fields = [
  1324. 'device_type', 'name', 'type', 'mgmt_only',
  1325. ]
  1326. class FrontPortTemplateImportForm(ComponentTemplateImportForm):
  1327. type = forms.ChoiceField(
  1328. choices=PortTypeChoices.CHOICES
  1329. )
  1330. rear_port = forms.ModelChoiceField(
  1331. queryset=RearPortTemplate.objects.all(),
  1332. to_field_name='name',
  1333. required=False
  1334. )
  1335. class Meta:
  1336. model = FrontPortTemplate
  1337. fields = [
  1338. 'device_type', 'name', 'type', 'rear_port', 'rear_port_position',
  1339. ]
  1340. class RearPortTemplateImportForm(ComponentTemplateImportForm):
  1341. type = forms.ChoiceField(
  1342. choices=PortTypeChoices.CHOICES
  1343. )
  1344. class Meta:
  1345. model = RearPortTemplate
  1346. fields = [
  1347. 'device_type', 'name', 'type', 'positions',
  1348. ]
  1349. class DeviceBayTemplateImportForm(ComponentTemplateImportForm):
  1350. class Meta:
  1351. model = DeviceBayTemplate
  1352. fields = [
  1353. 'device_type', 'name',
  1354. ]
  1355. #
  1356. # Device roles
  1357. #
  1358. class DeviceRoleForm(BootstrapMixin, forms.ModelForm):
  1359. slug = SlugField()
  1360. class Meta:
  1361. model = DeviceRole
  1362. fields = [
  1363. 'name', 'slug', 'color', 'vm_role', 'description',
  1364. ]
  1365. class DeviceRoleCSVForm(CSVModelForm):
  1366. slug = SlugField()
  1367. class Meta:
  1368. model = DeviceRole
  1369. fields = DeviceRole.csv_headers
  1370. help_texts = {
  1371. 'color': mark_safe('RGB color in hexadecimal (e.g. <code>00ff00</code>)'),
  1372. }
  1373. #
  1374. # Platforms
  1375. #
  1376. class PlatformForm(BootstrapMixin, forms.ModelForm):
  1377. manufacturer = DynamicModelChoiceField(
  1378. queryset=Manufacturer.objects.all(),
  1379. required=False
  1380. )
  1381. slug = SlugField(
  1382. max_length=64
  1383. )
  1384. class Meta:
  1385. model = Platform
  1386. fields = [
  1387. 'name', 'slug', 'manufacturer', 'napalm_driver', 'napalm_args', 'description',
  1388. ]
  1389. widgets = {
  1390. 'napalm_args': SmallTextarea(),
  1391. }
  1392. class PlatformCSVForm(CSVModelForm):
  1393. slug = SlugField()
  1394. manufacturer = CSVModelChoiceField(
  1395. queryset=Manufacturer.objects.all(),
  1396. required=False,
  1397. to_field_name='name',
  1398. help_text='Limit platform assignments to this manufacturer'
  1399. )
  1400. class Meta:
  1401. model = Platform
  1402. fields = Platform.csv_headers
  1403. #
  1404. # Devices
  1405. #
  1406. class DeviceForm(BootstrapMixin, TenancyForm, CustomFieldModelForm):
  1407. site = DynamicModelChoiceField(
  1408. queryset=Site.objects.all(),
  1409. widget=APISelect(
  1410. filter_for={
  1411. 'rack': 'site_id'
  1412. }
  1413. )
  1414. )
  1415. rack = DynamicModelChoiceField(
  1416. queryset=Rack.objects.all(),
  1417. required=False,
  1418. widget=APISelect(
  1419. display_field='display_name'
  1420. )
  1421. )
  1422. position = forms.TypedChoiceField(
  1423. required=False,
  1424. empty_value=None,
  1425. help_text="The lowest-numbered unit occupied by the device",
  1426. widget=APISelect(
  1427. api_url='/api/dcim/racks/{{rack}}/elevation/',
  1428. disabled_indicator='device'
  1429. )
  1430. )
  1431. manufacturer = DynamicModelChoiceField(
  1432. queryset=Manufacturer.objects.all(),
  1433. required=False,
  1434. widget=APISelect(
  1435. filter_for={
  1436. 'device_type': 'manufacturer_id',
  1437. 'platform': 'manufacturer_id'
  1438. }
  1439. )
  1440. )
  1441. device_type = DynamicModelChoiceField(
  1442. queryset=DeviceType.objects.all(),
  1443. widget=APISelect(
  1444. display_field='model'
  1445. )
  1446. )
  1447. device_role = DynamicModelChoiceField(
  1448. queryset=DeviceRole.objects.all()
  1449. )
  1450. platform = DynamicModelChoiceField(
  1451. queryset=Platform.objects.all(),
  1452. required=False,
  1453. widget=APISelect(
  1454. additional_query_params={
  1455. "manufacturer_id": "null"
  1456. }
  1457. )
  1458. )
  1459. cluster_group = DynamicModelChoiceField(
  1460. queryset=ClusterGroup.objects.all(),
  1461. required=False,
  1462. widget=APISelect(
  1463. filter_for={
  1464. 'cluster': 'group_id'
  1465. },
  1466. attrs={
  1467. 'nullable': 'true'
  1468. }
  1469. )
  1470. )
  1471. cluster = DynamicModelChoiceField(
  1472. queryset=Cluster.objects.all(),
  1473. required=False
  1474. )
  1475. comments = CommentField()
  1476. tags = TagField(required=False)
  1477. local_context_data = JSONField(
  1478. required=False,
  1479. label=''
  1480. )
  1481. class Meta:
  1482. model = Device
  1483. fields = [
  1484. 'name', 'device_role', 'device_type', 'serial', 'asset_tag', 'site', 'rack', 'position', 'face',
  1485. 'status', 'platform', 'primary_ip4', 'primary_ip6', 'cluster_group', 'cluster', 'tenant_group', 'tenant',
  1486. 'comments', 'tags', 'local_context_data'
  1487. ]
  1488. help_texts = {
  1489. 'device_role': "The function this device serves",
  1490. 'serial': "Chassis serial number",
  1491. 'local_context_data': "Local config context data overwrites all source contexts in the final rendered "
  1492. "config context",
  1493. }
  1494. widgets = {
  1495. 'face': StaticSelect2(
  1496. filter_for={
  1497. 'position': 'face'
  1498. }
  1499. ),
  1500. 'status': StaticSelect2(),
  1501. 'primary_ip4': StaticSelect2(),
  1502. 'primary_ip6': StaticSelect2(),
  1503. }
  1504. def __init__(self, *args, **kwargs):
  1505. # Initialize helper selectors
  1506. instance = kwargs.get('instance')
  1507. if 'initial' not in kwargs:
  1508. kwargs['initial'] = {}
  1509. # Using hasattr() instead of "is not None" to avoid RelatedObjectDoesNotExist on required field
  1510. if instance and hasattr(instance, 'device_type'):
  1511. kwargs['initial']['manufacturer'] = instance.device_type.manufacturer
  1512. if instance and instance.cluster is not None:
  1513. kwargs['initial']['cluster_group'] = instance.cluster.group
  1514. if 'device_type' in kwargs['initial'] and 'manufacturer' not in kwargs['initial']:
  1515. device_type_id = kwargs['initial']['device_type']
  1516. manufacturer_id = DeviceType.objects.filter(pk=device_type_id).values_list('manufacturer__pk', flat=True).first()
  1517. kwargs['initial']['manufacturer'] = manufacturer_id
  1518. if 'cluster' in kwargs['initial'] and 'cluster_group' not in kwargs['initial']:
  1519. cluster_id = kwargs['initial']['cluster']
  1520. cluster_group_id = Cluster.objects.filter(pk=cluster_id).values_list('group__pk', flat=True).first()
  1521. kwargs['initial']['cluster_group'] = cluster_group_id
  1522. super().__init__(*args, **kwargs)
  1523. if self.instance.pk:
  1524. # Compile list of choices for primary IPv4 and IPv6 addresses
  1525. for family in [4, 6]:
  1526. ip_choices = [(None, '---------')]
  1527. # Gather PKs of all interfaces belonging to this Device or a peer VirtualChassis member
  1528. interface_ids = self.instance.vc_interfaces.values('pk')
  1529. # Collect interface IPs
  1530. interface_ips = IPAddress.objects.prefetch_related('interface').filter(
  1531. address__family=family, interface_id__in=interface_ids
  1532. )
  1533. if interface_ips:
  1534. ip_list = [(ip.id, '{} ({})'.format(ip.address, ip.interface)) for ip in interface_ips]
  1535. ip_choices.append(('Interface IPs', ip_list))
  1536. # Collect NAT IPs
  1537. nat_ips = IPAddress.objects.prefetch_related('nat_inside').filter(
  1538. address__family=family, nat_inside__interface__in=interface_ids
  1539. )
  1540. if nat_ips:
  1541. ip_list = [(ip.id, '{} ({})'.format(ip.address, ip.nat_inside.address)) for ip in nat_ips]
  1542. ip_choices.append(('NAT IPs', ip_list))
  1543. self.fields['primary_ip{}'.format(family)].choices = ip_choices
  1544. # If editing an existing device, exclude it from the list of occupied rack units. This ensures that a device
  1545. # can be flipped from one face to another.
  1546. self.fields['position'].widget.add_additional_query_param('exclude', self.instance.pk)
  1547. # Limit platform by manufacturer
  1548. self.fields['platform'].queryset = Platform.objects.filter(
  1549. Q(manufacturer__isnull=True) | Q(manufacturer=self.instance.device_type.manufacturer)
  1550. )
  1551. else:
  1552. # An object that doesn't exist yet can't have any IPs assigned to it
  1553. self.fields['primary_ip4'].choices = []
  1554. self.fields['primary_ip4'].widget.attrs['readonly'] = True
  1555. self.fields['primary_ip6'].choices = []
  1556. self.fields['primary_ip6'].widget.attrs['readonly'] = True
  1557. # Rack position
  1558. pk = self.instance.pk if self.instance.pk else None
  1559. try:
  1560. if self.is_bound and self.data.get('rack') and str(self.data.get('face')):
  1561. position_choices = Rack.objects.get(pk=self.data['rack']) \
  1562. .get_rack_units(face=self.data.get('face'), exclude=pk)
  1563. elif self.initial.get('rack') and str(self.initial.get('face')):
  1564. position_choices = Rack.objects.get(pk=self.initial['rack']) \
  1565. .get_rack_units(face=self.initial.get('face'), exclude=pk)
  1566. else:
  1567. position_choices = []
  1568. except Rack.DoesNotExist:
  1569. position_choices = []
  1570. self.fields['position'].choices = [('', '---------')] + [
  1571. (p['id'], {
  1572. 'label': p['name'],
  1573. 'disabled': bool(p['device'] and p['id'] != self.initial.get('position')),
  1574. }) for p in position_choices
  1575. ]
  1576. # Disable rack assignment if this is a child device installed in a parent device
  1577. if pk and self.instance.device_type.is_child_device and hasattr(self.instance, 'parent_bay'):
  1578. self.fields['site'].disabled = True
  1579. self.fields['rack'].disabled = True
  1580. self.initial['site'] = self.instance.parent_bay.device.site_id
  1581. self.initial['rack'] = self.instance.parent_bay.device.rack_id
  1582. class BaseDeviceCSVForm(CustomFieldModelCSVForm):
  1583. device_role = CSVModelChoiceField(
  1584. queryset=DeviceRole.objects.all(),
  1585. to_field_name='name',
  1586. help_text='Assigned role'
  1587. )
  1588. tenant = CSVModelChoiceField(
  1589. queryset=Tenant.objects.all(),
  1590. required=False,
  1591. to_field_name='name',
  1592. help_text='Assigned tenant'
  1593. )
  1594. manufacturer = CSVModelChoiceField(
  1595. queryset=Manufacturer.objects.all(),
  1596. to_field_name='name',
  1597. help_text='Device type manufacturer'
  1598. )
  1599. device_type = CSVModelChoiceField(
  1600. queryset=DeviceType.objects.all(),
  1601. to_field_name='model',
  1602. help_text='Device type model'
  1603. )
  1604. platform = CSVModelChoiceField(
  1605. queryset=Platform.objects.all(),
  1606. required=False,
  1607. to_field_name='name',
  1608. help_text='Assigned platform'
  1609. )
  1610. status = CSVChoiceField(
  1611. choices=DeviceStatusChoices,
  1612. help_text='Operational status'
  1613. )
  1614. cluster = CSVModelChoiceField(
  1615. queryset=Cluster.objects.all(),
  1616. to_field_name='name',
  1617. required=False,
  1618. help_text='Virtualization cluster'
  1619. )
  1620. class Meta:
  1621. fields = []
  1622. model = Device
  1623. def __init__(self, data=None, *args, **kwargs):
  1624. super().__init__(data, *args, **kwargs)
  1625. if data:
  1626. # Limit device type queryset by manufacturer
  1627. params = {f"manufacturer__{self.fields['manufacturer'].to_field_name}": data.get('manufacturer')}
  1628. self.fields['device_type'].queryset = self.fields['device_type'].queryset.filter(**params)
  1629. class DeviceCSVForm(BaseDeviceCSVForm):
  1630. site = CSVModelChoiceField(
  1631. queryset=Site.objects.all(),
  1632. to_field_name='name',
  1633. help_text='Assigned site'
  1634. )
  1635. rack_group = CSVModelChoiceField(
  1636. queryset=RackGroup.objects.all(),
  1637. to_field_name='name',
  1638. required=False,
  1639. help_text="Rack's group (if any)"
  1640. )
  1641. rack = CSVModelChoiceField(
  1642. queryset=Rack.objects.all(),
  1643. to_field_name='name',
  1644. required=False,
  1645. help_text="Assigned rack"
  1646. )
  1647. face = CSVChoiceField(
  1648. choices=DeviceFaceChoices,
  1649. required=False,
  1650. help_text='Mounted rack face'
  1651. )
  1652. class Meta(BaseDeviceCSVForm.Meta):
  1653. fields = [
  1654. 'name', 'device_role', 'tenant', 'manufacturer', 'device_type', 'platform', 'serial', 'asset_tag', 'status',
  1655. 'site', 'rack_group', 'rack', 'position', 'face', 'cluster', 'comments',
  1656. ]
  1657. def __init__(self, data=None, *args, **kwargs):
  1658. super().__init__(data, *args, **kwargs)
  1659. if data:
  1660. # Limit rack_group queryset by assigned site
  1661. params = {f"site__{self.fields['site'].to_field_name}": data.get('site')}
  1662. self.fields['rack_group'].queryset = self.fields['rack_group'].queryset.filter(**params)
  1663. # Limit rack queryset by assigned site and group
  1664. params = {
  1665. f"site__{self.fields['site'].to_field_name}": data.get('site'),
  1666. f"group__{self.fields['rack_group'].to_field_name}": data.get('rack_group'),
  1667. }
  1668. self.fields['rack'].queryset = self.fields['rack'].queryset.filter(**params)
  1669. class ChildDeviceCSVForm(BaseDeviceCSVForm):
  1670. parent = CSVModelChoiceField(
  1671. queryset=Device.objects.all(),
  1672. to_field_name='name',
  1673. help_text='Parent device'
  1674. )
  1675. device_bay = CSVModelChoiceField(
  1676. queryset=DeviceBay.objects.all(),
  1677. to_field_name='name',
  1678. help_text='Device bay in which this device is installed'
  1679. )
  1680. class Meta(BaseDeviceCSVForm.Meta):
  1681. fields = [
  1682. 'name', 'device_role', 'tenant', 'manufacturer', 'device_type', 'platform', 'serial', 'asset_tag', 'status',
  1683. 'parent', 'device_bay', 'cluster', 'comments',
  1684. ]
  1685. def __init__(self, data=None, *args, **kwargs):
  1686. super().__init__(data, *args, **kwargs)
  1687. if data:
  1688. # Limit device bay queryset by parent device
  1689. params = {f"device__{self.fields['parent'].to_field_name}": data.get('parent')}
  1690. self.fields['device_bay'].queryset = self.fields['device_bay'].queryset.filter(**params)
  1691. def clean(self):
  1692. super().clean()
  1693. # Set parent_bay reverse relationship
  1694. device_bay = self.cleaned_data.get('device_bay')
  1695. if device_bay:
  1696. self.instance.parent_bay = device_bay
  1697. # Inherit site and rack from parent device
  1698. parent = self.cleaned_data.get('parent')
  1699. if parent:
  1700. self.instance.site = parent.site
  1701. self.instance.rack = parent.rack
  1702. class DeviceBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm):
  1703. pk = forms.ModelMultipleChoiceField(
  1704. queryset=Device.objects.all(),
  1705. widget=forms.MultipleHiddenInput()
  1706. )
  1707. device_type = DynamicModelChoiceField(
  1708. queryset=DeviceType.objects.all(),
  1709. required=False,
  1710. widget=APISelect(
  1711. display_field="model",
  1712. )
  1713. )
  1714. device_role = DynamicModelChoiceField(
  1715. queryset=DeviceRole.objects.all(),
  1716. required=False
  1717. )
  1718. tenant = DynamicModelChoiceField(
  1719. queryset=Tenant.objects.all(),
  1720. required=False
  1721. )
  1722. platform = DynamicModelChoiceField(
  1723. queryset=Platform.objects.all(),
  1724. required=False
  1725. )
  1726. status = forms.ChoiceField(
  1727. choices=add_blank_choice(DeviceStatusChoices),
  1728. required=False,
  1729. widget=StaticSelect2()
  1730. )
  1731. serial = forms.CharField(
  1732. max_length=50,
  1733. required=False,
  1734. label='Serial Number'
  1735. )
  1736. class Meta:
  1737. nullable_fields = [
  1738. 'tenant', 'platform', 'serial',
  1739. ]
  1740. class DeviceFilterForm(BootstrapMixin, LocalConfigContextFilterForm, TenancyFilterForm, CustomFieldFilterForm):
  1741. model = Device
  1742. field_order = [
  1743. 'q', 'region', 'site', 'rack_group_id', 'rack_id', 'status', 'role', 'tenant_group', 'tenant',
  1744. 'manufacturer_id', 'device_type_id', 'mac_address', 'has_primary_ip',
  1745. ]
  1746. q = forms.CharField(
  1747. required=False,
  1748. label='Search'
  1749. )
  1750. region = DynamicModelMultipleChoiceField(
  1751. queryset=Region.objects.all(),
  1752. to_field_name='slug',
  1753. required=False,
  1754. widget=APISelectMultiple(
  1755. value_field="slug",
  1756. filter_for={
  1757. 'site': 'region'
  1758. }
  1759. )
  1760. )
  1761. site = DynamicModelMultipleChoiceField(
  1762. queryset=Site.objects.all(),
  1763. to_field_name='slug',
  1764. required=False,
  1765. widget=APISelectMultiple(
  1766. value_field="slug",
  1767. filter_for={
  1768. 'rack_group_id': 'site',
  1769. 'rack_id': 'site',
  1770. }
  1771. )
  1772. )
  1773. rack_group_id = DynamicModelMultipleChoiceField(
  1774. queryset=RackGroup.objects.all(),
  1775. required=False,
  1776. label='Rack group',
  1777. widget=APISelectMultiple(
  1778. filter_for={
  1779. 'rack_id': 'group_id',
  1780. }
  1781. )
  1782. )
  1783. rack_id = DynamicModelMultipleChoiceField(
  1784. queryset=Rack.objects.all(),
  1785. required=False,
  1786. label='Rack',
  1787. widget=APISelectMultiple(
  1788. null_option=True,
  1789. )
  1790. )
  1791. role = DynamicModelMultipleChoiceField(
  1792. queryset=DeviceRole.objects.all(),
  1793. to_field_name='slug',
  1794. required=False,
  1795. widget=APISelectMultiple(
  1796. value_field="slug",
  1797. )
  1798. )
  1799. manufacturer_id = DynamicModelMultipleChoiceField(
  1800. queryset=Manufacturer.objects.all(),
  1801. required=False,
  1802. label='Manufacturer',
  1803. widget=APISelectMultiple(
  1804. filter_for={
  1805. 'device_type_id': 'manufacturer_id',
  1806. }
  1807. )
  1808. )
  1809. device_type_id = DynamicModelMultipleChoiceField(
  1810. queryset=DeviceType.objects.all(),
  1811. required=False,
  1812. label='Model',
  1813. widget=APISelectMultiple(
  1814. display_field="model",
  1815. )
  1816. )
  1817. platform = DynamicModelMultipleChoiceField(
  1818. queryset=Platform.objects.all(),
  1819. to_field_name='slug',
  1820. required=False,
  1821. widget=APISelectMultiple(
  1822. value_field="slug",
  1823. null_option=True,
  1824. )
  1825. )
  1826. status = forms.MultipleChoiceField(
  1827. choices=DeviceStatusChoices,
  1828. required=False,
  1829. widget=StaticSelect2Multiple()
  1830. )
  1831. mac_address = forms.CharField(
  1832. required=False,
  1833. label='MAC address'
  1834. )
  1835. has_primary_ip = forms.NullBooleanField(
  1836. required=False,
  1837. label='Has a primary IP',
  1838. widget=StaticSelect2(
  1839. choices=BOOLEAN_WITH_BLANK_CHOICES
  1840. )
  1841. )
  1842. virtual_chassis_member = forms.NullBooleanField(
  1843. required=False,
  1844. label='Virtual chassis member',
  1845. widget=StaticSelect2(
  1846. choices=BOOLEAN_WITH_BLANK_CHOICES
  1847. )
  1848. )
  1849. console_ports = forms.NullBooleanField(
  1850. required=False,
  1851. label='Has console ports',
  1852. widget=StaticSelect2(
  1853. choices=BOOLEAN_WITH_BLANK_CHOICES
  1854. )
  1855. )
  1856. console_server_ports = forms.NullBooleanField(
  1857. required=False,
  1858. label='Has console server ports',
  1859. widget=StaticSelect2(
  1860. choices=BOOLEAN_WITH_BLANK_CHOICES
  1861. )
  1862. )
  1863. power_ports = forms.NullBooleanField(
  1864. required=False,
  1865. label='Has power ports',
  1866. widget=StaticSelect2(
  1867. choices=BOOLEAN_WITH_BLANK_CHOICES
  1868. )
  1869. )
  1870. power_outlets = forms.NullBooleanField(
  1871. required=False,
  1872. label='Has power outlets',
  1873. widget=StaticSelect2(
  1874. choices=BOOLEAN_WITH_BLANK_CHOICES
  1875. )
  1876. )
  1877. interfaces = forms.NullBooleanField(
  1878. required=False,
  1879. label='Has interfaces',
  1880. widget=StaticSelect2(
  1881. choices=BOOLEAN_WITH_BLANK_CHOICES
  1882. )
  1883. )
  1884. pass_through_ports = forms.NullBooleanField(
  1885. required=False,
  1886. label='Has pass-through ports',
  1887. widget=StaticSelect2(
  1888. choices=BOOLEAN_WITH_BLANK_CHOICES
  1889. )
  1890. )
  1891. tag = TagFilterField(model)
  1892. #
  1893. # Bulk device component creation
  1894. #
  1895. class DeviceBulkAddComponentForm(BootstrapMixin, forms.Form):
  1896. pk = forms.ModelMultipleChoiceField(
  1897. queryset=Device.objects.all(),
  1898. widget=forms.MultipleHiddenInput()
  1899. )
  1900. name_pattern = ExpandableNameField(
  1901. label='Name'
  1902. )
  1903. def clean_tags(self):
  1904. # Because we're feeding TagField data (on the bulk edit form) to another TagField (on the model form), we
  1905. # must first convert the list of tags to a string.
  1906. return ','.join(self.cleaned_data.get('tags'))
  1907. #
  1908. # Console ports
  1909. #
  1910. class ConsolePortFilterForm(DeviceComponentFilterForm):
  1911. model = ConsolePort
  1912. type = forms.MultipleChoiceField(
  1913. choices=ConsolePortTypeChoices,
  1914. required=False,
  1915. widget=StaticSelect2Multiple()
  1916. )
  1917. tag = TagFilterField(model)
  1918. class ConsolePortForm(BootstrapMixin, forms.ModelForm):
  1919. tags = TagField(
  1920. required=False
  1921. )
  1922. class Meta:
  1923. model = ConsolePort
  1924. fields = [
  1925. 'device', 'name', 'type', 'description', 'tags',
  1926. ]
  1927. widgets = {
  1928. 'device': forms.HiddenInput(),
  1929. }
  1930. class ConsolePortCreateForm(BootstrapMixin, forms.Form):
  1931. device = DynamicModelChoiceField(
  1932. queryset=Device.objects.prefetch_related('device_type__manufacturer')
  1933. )
  1934. name_pattern = ExpandableNameField(
  1935. label='Name'
  1936. )
  1937. type = forms.ChoiceField(
  1938. choices=add_blank_choice(ConsolePortTypeChoices),
  1939. required=False,
  1940. widget=StaticSelect2()
  1941. )
  1942. description = forms.CharField(
  1943. max_length=100,
  1944. required=False
  1945. )
  1946. tags = TagField(
  1947. required=False
  1948. )
  1949. class ConsolePortBulkCreateForm(
  1950. form_from_model(ConsolePort, ['type', 'description', 'tags']),
  1951. DeviceBulkAddComponentForm
  1952. ):
  1953. pass
  1954. class ConsolePortBulkEditForm(
  1955. form_from_model(ConsolePort, ['type', 'description']),
  1956. BootstrapMixin,
  1957. AddRemoveTagsForm,
  1958. BulkEditForm
  1959. ):
  1960. pk = forms.ModelMultipleChoiceField(
  1961. queryset=ConsolePort.objects.all(),
  1962. widget=forms.MultipleHiddenInput()
  1963. )
  1964. class Meta:
  1965. nullable_fields = (
  1966. 'description',
  1967. )
  1968. class ConsolePortCSVForm(CSVModelForm):
  1969. device = CSVModelChoiceField(
  1970. queryset=Device.objects.all(),
  1971. to_field_name='name'
  1972. )
  1973. class Meta:
  1974. model = ConsolePort
  1975. fields = ConsolePort.csv_headers
  1976. #
  1977. # Console server ports
  1978. #
  1979. class ConsoleServerPortFilterForm(DeviceComponentFilterForm):
  1980. model = ConsoleServerPort
  1981. type = forms.MultipleChoiceField(
  1982. choices=ConsolePortTypeChoices,
  1983. required=False,
  1984. widget=StaticSelect2Multiple()
  1985. )
  1986. tag = TagFilterField(model)
  1987. class ConsoleServerPortForm(BootstrapMixin, forms.ModelForm):
  1988. tags = TagField(
  1989. required=False
  1990. )
  1991. class Meta:
  1992. model = ConsoleServerPort
  1993. fields = [
  1994. 'device', 'name', 'type', 'description', 'tags',
  1995. ]
  1996. widgets = {
  1997. 'device': forms.HiddenInput(),
  1998. }
  1999. class ConsoleServerPortCreateForm(BootstrapMixin, forms.Form):
  2000. device = DynamicModelChoiceField(
  2001. queryset=Device.objects.prefetch_related('device_type__manufacturer')
  2002. )
  2003. name_pattern = ExpandableNameField(
  2004. label='Name'
  2005. )
  2006. type = forms.ChoiceField(
  2007. choices=add_blank_choice(ConsolePortTypeChoices),
  2008. required=False,
  2009. widget=StaticSelect2()
  2010. )
  2011. description = forms.CharField(
  2012. max_length=100,
  2013. required=False
  2014. )
  2015. tags = TagField(
  2016. required=False
  2017. )
  2018. class ConsoleServerPortBulkCreateForm(
  2019. form_from_model(ConsoleServerPort, ['type', 'description', 'tags']),
  2020. DeviceBulkAddComponentForm
  2021. ):
  2022. pass
  2023. class ConsoleServerPortBulkEditForm(
  2024. form_from_model(ConsoleServerPort, ['type', 'description']),
  2025. BootstrapMixin,
  2026. AddRemoveTagsForm,
  2027. BulkEditForm
  2028. ):
  2029. pk = forms.ModelMultipleChoiceField(
  2030. queryset=ConsoleServerPort.objects.all(),
  2031. widget=forms.MultipleHiddenInput()
  2032. )
  2033. class Meta:
  2034. nullable_fields = [
  2035. 'description',
  2036. ]
  2037. class ConsoleServerPortBulkRenameForm(BulkRenameForm):
  2038. pk = forms.ModelMultipleChoiceField(
  2039. queryset=ConsoleServerPort.objects.all(),
  2040. widget=forms.MultipleHiddenInput()
  2041. )
  2042. class ConsoleServerPortBulkDisconnectForm(ConfirmationForm):
  2043. pk = forms.ModelMultipleChoiceField(
  2044. queryset=ConsoleServerPort.objects.all(),
  2045. widget=forms.MultipleHiddenInput()
  2046. )
  2047. class ConsoleServerPortCSVForm(CSVModelForm):
  2048. device = CSVModelChoiceField(
  2049. queryset=Device.objects.all(),
  2050. to_field_name='name'
  2051. )
  2052. class Meta:
  2053. model = ConsoleServerPort
  2054. fields = ConsoleServerPort.csv_headers
  2055. #
  2056. # Power ports
  2057. #
  2058. class PowerPortFilterForm(DeviceComponentFilterForm):
  2059. model = PowerPort
  2060. type = forms.MultipleChoiceField(
  2061. choices=PowerPortTypeChoices,
  2062. required=False,
  2063. widget=StaticSelect2Multiple()
  2064. )
  2065. tag = TagFilterField(model)
  2066. class PowerPortForm(BootstrapMixin, forms.ModelForm):
  2067. tags = TagField(
  2068. required=False
  2069. )
  2070. class Meta:
  2071. model = PowerPort
  2072. fields = [
  2073. 'device', 'name', 'type', 'maximum_draw', 'allocated_draw', 'description', 'tags',
  2074. ]
  2075. widgets = {
  2076. 'device': forms.HiddenInput(),
  2077. }
  2078. class PowerPortCreateForm(BootstrapMixin, forms.Form):
  2079. device = DynamicModelChoiceField(
  2080. queryset=Device.objects.prefetch_related('device_type__manufacturer')
  2081. )
  2082. name_pattern = ExpandableNameField(
  2083. label='Name'
  2084. )
  2085. type = forms.ChoiceField(
  2086. choices=add_blank_choice(PowerPortTypeChoices),
  2087. required=False,
  2088. widget=StaticSelect2()
  2089. )
  2090. maximum_draw = forms.IntegerField(
  2091. min_value=1,
  2092. required=False,
  2093. help_text="Maximum draw in watts"
  2094. )
  2095. allocated_draw = forms.IntegerField(
  2096. min_value=1,
  2097. required=False,
  2098. help_text="Allocated draw in watts"
  2099. )
  2100. description = forms.CharField(
  2101. max_length=100,
  2102. required=False
  2103. )
  2104. tags = TagField(
  2105. required=False
  2106. )
  2107. class PowerPortBulkCreateForm(
  2108. form_from_model(PowerPort, ['type', 'maximum_draw', 'allocated_draw', 'description', 'tags']),
  2109. DeviceBulkAddComponentForm
  2110. ):
  2111. pass
  2112. class PowerPortBulkEditForm(
  2113. form_from_model(PowerPort, ['type', 'maximum_draw', 'allocated_draw', 'description']),
  2114. BootstrapMixin,
  2115. AddRemoveTagsForm,
  2116. BulkEditForm
  2117. ):
  2118. pk = forms.ModelMultipleChoiceField(
  2119. queryset=PowerPort.objects.all(),
  2120. widget=forms.MultipleHiddenInput()
  2121. )
  2122. class Meta:
  2123. nullable_fields = (
  2124. 'description',
  2125. )
  2126. class PowerPortCSVForm(CSVModelForm):
  2127. device = CSVModelChoiceField(
  2128. queryset=Device.objects.all(),
  2129. to_field_name='name'
  2130. )
  2131. class Meta:
  2132. model = PowerPort
  2133. fields = PowerPort.csv_headers
  2134. #
  2135. # Power outlets
  2136. #
  2137. class PowerOutletFilterForm(DeviceComponentFilterForm):
  2138. model = PowerOutlet
  2139. type = forms.MultipleChoiceField(
  2140. choices=PowerOutletTypeChoices,
  2141. required=False,
  2142. widget=StaticSelect2Multiple()
  2143. )
  2144. tag = TagFilterField(model)
  2145. class PowerOutletForm(BootstrapMixin, forms.ModelForm):
  2146. power_port = forms.ModelChoiceField(
  2147. queryset=PowerPort.objects.all(),
  2148. required=False
  2149. )
  2150. tags = TagField(
  2151. required=False
  2152. )
  2153. class Meta:
  2154. model = PowerOutlet
  2155. fields = [
  2156. 'device', 'name', 'type', 'power_port', 'feed_leg', 'description', 'tags',
  2157. ]
  2158. widgets = {
  2159. 'device': forms.HiddenInput(),
  2160. }
  2161. def __init__(self, *args, **kwargs):
  2162. super().__init__(*args, **kwargs)
  2163. # Limit power_port choices to the local device
  2164. if hasattr(self.instance, 'device'):
  2165. self.fields['power_port'].queryset = PowerPort.objects.filter(
  2166. device=self.instance.device
  2167. )
  2168. class PowerOutletCreateForm(BootstrapMixin, forms.Form):
  2169. device = DynamicModelChoiceField(
  2170. queryset=Device.objects.prefetch_related('device_type__manufacturer')
  2171. )
  2172. name_pattern = ExpandableNameField(
  2173. label='Name'
  2174. )
  2175. type = forms.ChoiceField(
  2176. choices=add_blank_choice(PowerOutletTypeChoices),
  2177. required=False,
  2178. widget=StaticSelect2()
  2179. )
  2180. power_port = forms.ModelChoiceField(
  2181. queryset=PowerPort.objects.all(),
  2182. required=False
  2183. )
  2184. feed_leg = forms.ChoiceField(
  2185. choices=add_blank_choice(PowerOutletFeedLegChoices),
  2186. required=False
  2187. )
  2188. description = forms.CharField(
  2189. max_length=100,
  2190. required=False
  2191. )
  2192. tags = TagField(
  2193. required=False
  2194. )
  2195. def __init__(self, *args, **kwargs):
  2196. super().__init__(*args, **kwargs)
  2197. # Limit power_port queryset to PowerPorts which belong to the parent Device
  2198. device = Device.objects.get(
  2199. pk=self.initial.get('device') or self.data.get('device')
  2200. )
  2201. self.fields['power_port'].queryset = PowerPort.objects.filter(device=device)
  2202. class PowerOutletBulkCreateForm(
  2203. form_from_model(PowerOutlet, ['type', 'feed_leg', 'description', 'tags']),
  2204. DeviceBulkAddComponentForm
  2205. ):
  2206. pass
  2207. class PowerOutletBulkEditForm(
  2208. form_from_model(PowerOutlet, ['type', 'feed_leg', 'power_port', 'description']),
  2209. BootstrapMixin,
  2210. AddRemoveTagsForm,
  2211. BulkEditForm
  2212. ):
  2213. pk = forms.ModelMultipleChoiceField(
  2214. queryset=PowerOutlet.objects.all(),
  2215. widget=forms.MultipleHiddenInput()
  2216. )
  2217. device = forms.ModelChoiceField(
  2218. queryset=Device.objects.all(),
  2219. required=False,
  2220. disabled=True,
  2221. widget=forms.HiddenInput()
  2222. )
  2223. class Meta:
  2224. nullable_fields = [
  2225. 'type', 'feed_leg', 'power_port', 'description',
  2226. ]
  2227. def __init__(self, *args, **kwargs):
  2228. super().__init__(*args, **kwargs)
  2229. # Limit power_port queryset to PowerPorts which belong to the parent Device
  2230. if 'device' in self.initial:
  2231. device = Device.objects.filter(pk=self.initial['device']).first()
  2232. self.fields['power_port'].queryset = PowerPort.objects.filter(device=device)
  2233. else:
  2234. self.fields['power_port'].choices = ()
  2235. self.fields['power_port'].widget.attrs['disabled'] = True
  2236. class PowerOutletBulkRenameForm(BulkRenameForm):
  2237. pk = forms.ModelMultipleChoiceField(
  2238. queryset=PowerOutlet.objects.all(),
  2239. widget=forms.MultipleHiddenInput
  2240. )
  2241. class PowerOutletBulkDisconnectForm(ConfirmationForm):
  2242. pk = forms.ModelMultipleChoiceField(
  2243. queryset=PowerOutlet.objects.all(),
  2244. widget=forms.MultipleHiddenInput
  2245. )
  2246. class PowerOutletCSVForm(CSVModelForm):
  2247. device = CSVModelChoiceField(
  2248. queryset=Device.objects.all(),
  2249. to_field_name='name'
  2250. )
  2251. power_port = CSVModelChoiceField(
  2252. queryset=PowerPort.objects.all(),
  2253. required=False,
  2254. to_field_name='name',
  2255. help_text='Local power port which feeds this outlet'
  2256. )
  2257. feed_leg = CSVChoiceField(
  2258. choices=PowerOutletFeedLegChoices,
  2259. required=False,
  2260. help_text='Electrical phase (for three-phase circuits)'
  2261. )
  2262. class Meta:
  2263. model = PowerOutlet
  2264. fields = PowerOutlet.csv_headers
  2265. def __init__(self, *args, **kwargs):
  2266. super().__init__(*args, **kwargs)
  2267. # Limit PowerPort choices to those belonging to this device (or VC master)
  2268. if self.is_bound:
  2269. try:
  2270. device = self.fields['device'].to_python(self.data['device'])
  2271. except forms.ValidationError:
  2272. device = None
  2273. else:
  2274. try:
  2275. device = self.instance.device
  2276. except Device.DoesNotExist:
  2277. device = None
  2278. if device:
  2279. self.fields['power_port'].queryset = PowerPort.objects.filter(
  2280. device__in=[device, device.get_vc_master()]
  2281. )
  2282. else:
  2283. self.fields['power_port'].queryset = PowerPort.objects.none()
  2284. #
  2285. # Interfaces
  2286. #
  2287. class InterfaceFilterForm(DeviceComponentFilterForm):
  2288. model = Interface
  2289. type = forms.MultipleChoiceField(
  2290. choices=InterfaceTypeChoices,
  2291. required=False,
  2292. widget=StaticSelect2Multiple()
  2293. )
  2294. enabled = forms.NullBooleanField(
  2295. required=False,
  2296. widget=StaticSelect2(
  2297. choices=BOOLEAN_WITH_BLANK_CHOICES
  2298. )
  2299. )
  2300. tag = TagFilterField(model)
  2301. class InterfaceForm(InterfaceCommonForm, BootstrapMixin, forms.ModelForm):
  2302. untagged_vlan = DynamicModelChoiceField(
  2303. queryset=VLAN.objects.all(),
  2304. required=False,
  2305. label='Untagged VLAN',
  2306. widget=APISelect(
  2307. display_field='display_name',
  2308. full=True,
  2309. additional_query_params={
  2310. 'site_id': 'null',
  2311. },
  2312. )
  2313. )
  2314. tagged_vlans = DynamicModelMultipleChoiceField(
  2315. queryset=VLAN.objects.all(),
  2316. required=False,
  2317. label='Tagged VLANs',
  2318. widget=APISelectMultiple(
  2319. display_field='display_name',
  2320. full=True,
  2321. additional_query_params={
  2322. 'site_id': 'null',
  2323. },
  2324. )
  2325. )
  2326. tags = TagField(
  2327. required=False
  2328. )
  2329. class Meta:
  2330. model = Interface
  2331. fields = [
  2332. 'device', 'name', 'type', 'enabled', 'lag', 'mac_address', 'mtu', 'mgmt_only', 'description',
  2333. 'mode', 'untagged_vlan', 'tagged_vlans', 'tags',
  2334. ]
  2335. widgets = {
  2336. 'device': forms.HiddenInput(),
  2337. 'type': StaticSelect2(),
  2338. 'lag': StaticSelect2(),
  2339. 'mode': StaticSelect2(),
  2340. }
  2341. labels = {
  2342. 'mode': '802.1Q Mode',
  2343. }
  2344. help_texts = {
  2345. 'mode': INTERFACE_MODE_HELP_TEXT,
  2346. }
  2347. def __init__(self, *args, **kwargs):
  2348. super().__init__(*args, **kwargs)
  2349. if self.is_bound:
  2350. device = Device.objects.get(pk=self.data['device'])
  2351. else:
  2352. device = self.instance.device
  2353. # Limit LAG choices to interfaces belonging to this device (or VC master)
  2354. self.fields['lag'].queryset = Interface.objects.filter(
  2355. device__in=[device, device.get_vc_master()],
  2356. type=InterfaceTypeChoices.TYPE_LAG
  2357. )
  2358. # Add current site to VLANs query params
  2359. self.fields['untagged_vlan'].widget.add_additional_query_param('site_id', device.site.pk)
  2360. self.fields['tagged_vlans'].widget.add_additional_query_param('site_id', device.site.pk)
  2361. class InterfaceCreateForm(BootstrapMixin, InterfaceCommonForm, forms.Form):
  2362. device = DynamicModelChoiceField(
  2363. queryset=Device.objects.prefetch_related('device_type__manufacturer')
  2364. )
  2365. name_pattern = ExpandableNameField(
  2366. label='Name'
  2367. )
  2368. type = forms.ChoiceField(
  2369. choices=InterfaceTypeChoices,
  2370. widget=StaticSelect2(),
  2371. )
  2372. enabled = forms.BooleanField(
  2373. required=False,
  2374. initial=True
  2375. )
  2376. lag = forms.ModelChoiceField(
  2377. queryset=Interface.objects.all(),
  2378. required=False,
  2379. label='Parent LAG',
  2380. widget=StaticSelect2(),
  2381. )
  2382. mtu = forms.IntegerField(
  2383. required=False,
  2384. min_value=INTERFACE_MTU_MIN,
  2385. max_value=INTERFACE_MTU_MAX,
  2386. label='MTU'
  2387. )
  2388. mac_address = forms.CharField(
  2389. required=False,
  2390. label='MAC Address'
  2391. )
  2392. mgmt_only = forms.BooleanField(
  2393. required=False,
  2394. label='Management only',
  2395. help_text='This interface is used only for out-of-band management'
  2396. )
  2397. description = forms.CharField(
  2398. max_length=100,
  2399. required=False
  2400. )
  2401. mode = forms.ChoiceField(
  2402. choices=add_blank_choice(InterfaceModeChoices),
  2403. required=False,
  2404. widget=StaticSelect2(),
  2405. )
  2406. tags = TagField(
  2407. required=False
  2408. )
  2409. untagged_vlan = DynamicModelChoiceField(
  2410. queryset=VLAN.objects.all(),
  2411. required=False,
  2412. widget=APISelect(
  2413. display_field='display_name',
  2414. full=True,
  2415. additional_query_params={
  2416. 'site_id': 'null',
  2417. },
  2418. )
  2419. )
  2420. tagged_vlans = DynamicModelMultipleChoiceField(
  2421. queryset=VLAN.objects.all(),
  2422. required=False,
  2423. widget=APISelectMultiple(
  2424. display_field='display_name',
  2425. full=True,
  2426. additional_query_params={
  2427. 'site_id': 'null',
  2428. },
  2429. )
  2430. )
  2431. def __init__(self, *args, **kwargs):
  2432. super().__init__(*args, **kwargs)
  2433. # Limit LAG choices to interfaces which belong to the parent device (or VC master)
  2434. device = Device.objects.get(
  2435. pk=self.initial.get('device') or self.data.get('device')
  2436. )
  2437. self.fields['lag'].queryset = Interface.objects.filter(
  2438. device__in=[device, device.get_vc_master()],
  2439. type=InterfaceTypeChoices.TYPE_LAG
  2440. )
  2441. # Add current site to VLANs query params
  2442. self.fields['untagged_vlan'].widget.add_additional_query_param('site_id', device.site.pk)
  2443. self.fields['tagged_vlans'].widget.add_additional_query_param('site_id', device.site.pk)
  2444. class InterfaceBulkCreateForm(
  2445. form_from_model(Interface, ['type', 'enabled', 'mtu', 'mgmt_only', 'description', 'tags']),
  2446. DeviceBulkAddComponentForm
  2447. ):
  2448. pass
  2449. class InterfaceBulkEditForm(
  2450. form_from_model(Interface, ['type', 'enabled', 'lag', 'mac_address', 'mtu', 'mgmt_only', 'description', 'mode']),
  2451. BootstrapMixin,
  2452. AddRemoveTagsForm,
  2453. BulkEditForm
  2454. ):
  2455. pk = forms.ModelMultipleChoiceField(
  2456. queryset=Interface.objects.all(),
  2457. widget=forms.MultipleHiddenInput()
  2458. )
  2459. device = forms.ModelChoiceField(
  2460. queryset=Device.objects.all(),
  2461. required=False,
  2462. disabled=True,
  2463. widget=forms.HiddenInput()
  2464. )
  2465. untagged_vlan = DynamicModelChoiceField(
  2466. queryset=VLAN.objects.all(),
  2467. required=False,
  2468. widget=APISelect(
  2469. display_field='display_name',
  2470. full=True,
  2471. additional_query_params={
  2472. 'site_id': 'null',
  2473. },
  2474. )
  2475. )
  2476. tagged_vlans = DynamicModelMultipleChoiceField(
  2477. queryset=VLAN.objects.all(),
  2478. required=False,
  2479. widget=APISelectMultiple(
  2480. display_field='display_name',
  2481. full=True,
  2482. additional_query_params={
  2483. 'site_id': 'null',
  2484. },
  2485. )
  2486. )
  2487. class Meta:
  2488. nullable_fields = [
  2489. 'lag', 'mac_address', 'mtu', 'description', 'mode', 'untagged_vlan', 'tagged_vlans'
  2490. ]
  2491. def __init__(self, *args, **kwargs):
  2492. super().__init__(*args, **kwargs)
  2493. # Limit LAG choices to interfaces which belong to the parent device (or VC master)
  2494. if 'device' in self.initial:
  2495. device = Device.objects.filter(pk=self.initial['device']).first()
  2496. self.fields['lag'].queryset = Interface.objects.filter(
  2497. device__in=[device, device.get_vc_master()],
  2498. type=InterfaceTypeChoices.TYPE_LAG
  2499. )
  2500. # Add current site to VLANs query params
  2501. self.fields['untagged_vlan'].widget.add_additional_query_param('site_id', device.site.pk)
  2502. self.fields['tagged_vlans'].widget.add_additional_query_param('site_id', device.site.pk)
  2503. else:
  2504. self.fields['lag'].choices = ()
  2505. self.fields['lag'].widget.attrs['disabled'] = True
  2506. def clean(self):
  2507. # Untagged interfaces cannot be assigned tagged VLANs
  2508. if self.cleaned_data['mode'] == InterfaceModeChoices.MODE_ACCESS and self.cleaned_data['tagged_vlans']:
  2509. raise forms.ValidationError({
  2510. 'mode': "An access interface cannot have tagged VLANs assigned."
  2511. })
  2512. # Remove all tagged VLAN assignments from "tagged all" interfaces
  2513. elif self.cleaned_data['mode'] == InterfaceModeChoices.MODE_TAGGED_ALL:
  2514. self.cleaned_data['tagged_vlans'] = []
  2515. class InterfaceBulkRenameForm(BulkRenameForm):
  2516. pk = forms.ModelMultipleChoiceField(
  2517. queryset=Interface.objects.all(),
  2518. widget=forms.MultipleHiddenInput()
  2519. )
  2520. class InterfaceBulkDisconnectForm(ConfirmationForm):
  2521. pk = forms.ModelMultipleChoiceField(
  2522. queryset=Interface.objects.all(),
  2523. widget=forms.MultipleHiddenInput()
  2524. )
  2525. class InterfaceCSVForm(CSVModelForm):
  2526. device = CSVModelChoiceField(
  2527. queryset=Device.objects.all(),
  2528. required=False,
  2529. to_field_name='name'
  2530. )
  2531. virtual_machine = CSVModelChoiceField(
  2532. queryset=VirtualMachine.objects.all(),
  2533. required=False,
  2534. to_field_name='name'
  2535. )
  2536. lag = CSVModelChoiceField(
  2537. queryset=Interface.objects.all(),
  2538. required=False,
  2539. to_field_name='name',
  2540. help_text='Parent LAG interface'
  2541. )
  2542. type = CSVChoiceField(
  2543. choices=InterfaceTypeChoices,
  2544. help_text='Physical medium'
  2545. )
  2546. mode = CSVChoiceField(
  2547. choices=InterfaceModeChoices,
  2548. required=False,
  2549. help_text='IEEE 802.1Q operational mode (for L2 interfaces)'
  2550. )
  2551. class Meta:
  2552. model = Interface
  2553. fields = Interface.csv_headers
  2554. def __init__(self, *args, **kwargs):
  2555. super().__init__(*args, **kwargs)
  2556. # Limit LAG choices to interfaces belonging to this device (or VC master)
  2557. if self.is_bound and 'device' in self.data:
  2558. try:
  2559. device = self.fields['device'].to_python(self.data['device'])
  2560. except forms.ValidationError:
  2561. device = None
  2562. else:
  2563. device = self.instance.device
  2564. if device:
  2565. self.fields['lag'].queryset = Interface.objects.filter(
  2566. device__in=[device, device.get_vc_master()], type=InterfaceTypeChoices.TYPE_LAG
  2567. )
  2568. else:
  2569. self.fields['lag'].queryset = Interface.objects.none()
  2570. def clean_enabled(self):
  2571. # Make sure enabled is True when it's not included in the uploaded data
  2572. if 'enabled' not in self.data:
  2573. return True
  2574. else:
  2575. return self.cleaned_data['enabled']
  2576. #
  2577. # Front pass-through ports
  2578. #
  2579. class FrontPortFilterForm(DeviceComponentFilterForm):
  2580. model = FrontPort
  2581. type = forms.MultipleChoiceField(
  2582. choices=PortTypeChoices,
  2583. required=False,
  2584. widget=StaticSelect2Multiple()
  2585. )
  2586. tag = TagFilterField(model)
  2587. class FrontPortForm(BootstrapMixin, forms.ModelForm):
  2588. tags = TagField(
  2589. required=False
  2590. )
  2591. class Meta:
  2592. model = FrontPort
  2593. fields = [
  2594. 'device', 'name', 'type', 'rear_port', 'rear_port_position', 'description', 'tags',
  2595. ]
  2596. widgets = {
  2597. 'device': forms.HiddenInput(),
  2598. 'type': StaticSelect2(),
  2599. 'rear_port': StaticSelect2(),
  2600. }
  2601. def __init__(self, *args, **kwargs):
  2602. super().__init__(*args, **kwargs)
  2603. # Limit RearPort choices to the local device
  2604. if hasattr(self.instance, 'device'):
  2605. self.fields['rear_port'].queryset = self.fields['rear_port'].queryset.filter(
  2606. device=self.instance.device
  2607. )
  2608. # TODO: Merge with FrontPortTemplateCreateForm to remove duplicate logic
  2609. class FrontPortCreateForm(BootstrapMixin, forms.Form):
  2610. device = DynamicModelChoiceField(
  2611. queryset=Device.objects.prefetch_related('device_type__manufacturer')
  2612. )
  2613. name_pattern = ExpandableNameField(
  2614. label='Name'
  2615. )
  2616. type = forms.ChoiceField(
  2617. choices=PortTypeChoices,
  2618. widget=StaticSelect2(),
  2619. )
  2620. rear_port_set = forms.MultipleChoiceField(
  2621. choices=[],
  2622. label='Rear ports',
  2623. help_text='Select one rear port assignment for each front port being created.',
  2624. )
  2625. description = forms.CharField(
  2626. required=False
  2627. )
  2628. def __init__(self, *args, **kwargs):
  2629. super().__init__(*args, **kwargs)
  2630. device = Device.objects.get(
  2631. pk=self.initial.get('device') or self.data.get('device')
  2632. )
  2633. # Determine which rear port positions are occupied. These will be excluded from the list of available
  2634. # mappings.
  2635. occupied_port_positions = [
  2636. (front_port.rear_port_id, front_port.rear_port_position)
  2637. for front_port in device.frontports.all()
  2638. ]
  2639. # Populate rear port choices
  2640. choices = []
  2641. rear_ports = RearPort.objects.filter(device=device)
  2642. for rear_port in rear_ports:
  2643. for i in range(1, rear_port.positions + 1):
  2644. if (rear_port.pk, i) not in occupied_port_positions:
  2645. choices.append(
  2646. ('{}:{}'.format(rear_port.pk, i), '{}:{}'.format(rear_port.name, i))
  2647. )
  2648. self.fields['rear_port_set'].choices = choices
  2649. def clean(self):
  2650. # Validate that the number of ports being created equals the number of selected (rear port, position) tuples
  2651. front_port_count = len(self.cleaned_data['name_pattern'])
  2652. rear_port_count = len(self.cleaned_data['rear_port_set'])
  2653. if front_port_count != rear_port_count:
  2654. raise forms.ValidationError({
  2655. 'rear_port_set': 'The provided name pattern will create {} ports, however {} rear port assignments '
  2656. 'were selected. These counts must match.'.format(front_port_count, rear_port_count)
  2657. })
  2658. def get_iterative_data(self, iteration):
  2659. # Assign rear port and position from selected set
  2660. rear_port, position = self.cleaned_data['rear_port_set'][iteration].split(':')
  2661. return {
  2662. 'rear_port': int(rear_port),
  2663. 'rear_port_position': int(position),
  2664. }
  2665. # class FrontPortBulkCreateForm(
  2666. # form_from_model(FrontPort, ['type', 'description', 'tags']),
  2667. # DeviceBulkAddComponentForm
  2668. # ):
  2669. # pass
  2670. class FrontPortBulkEditForm(
  2671. form_from_model(FrontPort, ['type', 'description']),
  2672. BootstrapMixin,
  2673. AddRemoveTagsForm,
  2674. BulkEditForm
  2675. ):
  2676. pk = forms.ModelMultipleChoiceField(
  2677. queryset=FrontPort.objects.all(),
  2678. widget=forms.MultipleHiddenInput()
  2679. )
  2680. class Meta:
  2681. nullable_fields = [
  2682. 'description',
  2683. ]
  2684. class FrontPortBulkRenameForm(BulkRenameForm):
  2685. pk = forms.ModelMultipleChoiceField(
  2686. queryset=FrontPort.objects.all(),
  2687. widget=forms.MultipleHiddenInput
  2688. )
  2689. class FrontPortBulkDisconnectForm(ConfirmationForm):
  2690. pk = forms.ModelMultipleChoiceField(
  2691. queryset=FrontPort.objects.all(),
  2692. widget=forms.MultipleHiddenInput
  2693. )
  2694. class FrontPortCSVForm(CSVModelForm):
  2695. device = CSVModelChoiceField(
  2696. queryset=Device.objects.all(),
  2697. to_field_name='name'
  2698. )
  2699. rear_port = CSVModelChoiceField(
  2700. queryset=RearPort.objects.all(),
  2701. to_field_name='name',
  2702. help_text='Corresponding rear port'
  2703. )
  2704. type = CSVChoiceField(
  2705. choices=PortTypeChoices,
  2706. help_text='Physical medium classification'
  2707. )
  2708. class Meta:
  2709. model = FrontPort
  2710. fields = FrontPort.csv_headers
  2711. help_texts = {
  2712. 'rear_port_position': 'Mapped position on corresponding rear port',
  2713. }
  2714. def __init__(self, *args, **kwargs):
  2715. super().__init__(*args, **kwargs)
  2716. # Limit RearPort choices to those belonging to this device (or VC master)
  2717. if self.is_bound:
  2718. try:
  2719. device = self.fields['device'].to_python(self.data['device'])
  2720. except forms.ValidationError:
  2721. device = None
  2722. else:
  2723. try:
  2724. device = self.instance.device
  2725. except Device.DoesNotExist:
  2726. device = None
  2727. if device:
  2728. self.fields['rear_port'].queryset = RearPort.objects.filter(
  2729. device__in=[device, device.get_vc_master()]
  2730. )
  2731. else:
  2732. self.fields['rear_port'].queryset = RearPort.objects.none()
  2733. #
  2734. # Rear pass-through ports
  2735. #
  2736. class RearPortFilterForm(DeviceComponentFilterForm):
  2737. model = RearPort
  2738. type = forms.MultipleChoiceField(
  2739. choices=PortTypeChoices,
  2740. required=False,
  2741. widget=StaticSelect2Multiple()
  2742. )
  2743. tag = TagFilterField(model)
  2744. class RearPortForm(BootstrapMixin, forms.ModelForm):
  2745. tags = TagField(
  2746. required=False
  2747. )
  2748. class Meta:
  2749. model = RearPort
  2750. fields = [
  2751. 'device', 'name', 'type', 'positions', 'description', 'tags',
  2752. ]
  2753. widgets = {
  2754. 'device': forms.HiddenInput(),
  2755. 'type': StaticSelect2(),
  2756. }
  2757. class RearPortCreateForm(BootstrapMixin, forms.Form):
  2758. device = DynamicModelChoiceField(
  2759. queryset=Device.objects.prefetch_related('device_type__manufacturer')
  2760. )
  2761. name_pattern = ExpandableNameField(
  2762. label='Name'
  2763. )
  2764. type = forms.ChoiceField(
  2765. choices=PortTypeChoices,
  2766. widget=StaticSelect2(),
  2767. )
  2768. positions = forms.IntegerField(
  2769. min_value=REARPORT_POSITIONS_MIN,
  2770. max_value=REARPORT_POSITIONS_MAX,
  2771. initial=1,
  2772. help_text='The number of front ports which may be mapped to each rear port'
  2773. )
  2774. description = forms.CharField(
  2775. required=False
  2776. )
  2777. class RearPortBulkCreateForm(
  2778. form_from_model(RearPort, ['type', 'positions', 'description', 'tags']),
  2779. DeviceBulkAddComponentForm
  2780. ):
  2781. pass
  2782. class RearPortBulkEditForm(
  2783. form_from_model(RearPort, ['type', 'description']),
  2784. BootstrapMixin,
  2785. AddRemoveTagsForm,
  2786. BulkEditForm
  2787. ):
  2788. pk = forms.ModelMultipleChoiceField(
  2789. queryset=RearPort.objects.all(),
  2790. widget=forms.MultipleHiddenInput()
  2791. )
  2792. class Meta:
  2793. nullable_fields = [
  2794. 'description',
  2795. ]
  2796. class RearPortBulkRenameForm(BulkRenameForm):
  2797. pk = forms.ModelMultipleChoiceField(
  2798. queryset=RearPort.objects.all(),
  2799. widget=forms.MultipleHiddenInput
  2800. )
  2801. class RearPortBulkDisconnectForm(ConfirmationForm):
  2802. pk = forms.ModelMultipleChoiceField(
  2803. queryset=RearPort.objects.all(),
  2804. widget=forms.MultipleHiddenInput
  2805. )
  2806. class RearPortCSVForm(CSVModelForm):
  2807. device = CSVModelChoiceField(
  2808. queryset=Device.objects.all(),
  2809. to_field_name='name'
  2810. )
  2811. type = CSVChoiceField(
  2812. help_text='Physical medium classification',
  2813. choices=PortTypeChoices,
  2814. )
  2815. class Meta:
  2816. model = RearPort
  2817. fields = RearPort.csv_headers
  2818. help_texts = {
  2819. 'positions': 'Number of front ports which may be mapped'
  2820. }
  2821. #
  2822. # Device bays
  2823. #
  2824. class DeviceBayFilterForm(DeviceComponentFilterForm):
  2825. model = DeviceBay
  2826. tag = TagFilterField(model)
  2827. class DeviceBayForm(BootstrapMixin, forms.ModelForm):
  2828. tags = TagField(
  2829. required=False
  2830. )
  2831. class Meta:
  2832. model = DeviceBay
  2833. fields = [
  2834. 'device', 'name', 'description', 'tags',
  2835. ]
  2836. widgets = {
  2837. 'device': forms.HiddenInput(),
  2838. }
  2839. class DeviceBayCreateForm(BootstrapMixin, forms.Form):
  2840. device = DynamicModelChoiceField(
  2841. queryset=Device.objects.prefetch_related('device_type__manufacturer')
  2842. )
  2843. name_pattern = ExpandableNameField(
  2844. label='Name'
  2845. )
  2846. tags = TagField(
  2847. required=False
  2848. )
  2849. class PopulateDeviceBayForm(BootstrapMixin, forms.Form):
  2850. installed_device = forms.ModelChoiceField(
  2851. queryset=Device.objects.all(),
  2852. label='Child Device',
  2853. help_text="Child devices must first be created and assigned to the site/rack of the parent device.",
  2854. widget=StaticSelect2(),
  2855. )
  2856. def __init__(self, device_bay, *args, **kwargs):
  2857. super().__init__(*args, **kwargs)
  2858. self.fields['installed_device'].queryset = Device.objects.filter(
  2859. site=device_bay.device.site,
  2860. rack=device_bay.device.rack,
  2861. parent_bay__isnull=True,
  2862. device_type__u_height=0,
  2863. device_type__subdevice_role=SubdeviceRoleChoices.ROLE_CHILD
  2864. ).exclude(pk=device_bay.device.pk)
  2865. class DeviceBayBulkCreateForm(
  2866. form_from_model(DeviceBay, ['description', 'tags']),
  2867. DeviceBulkAddComponentForm
  2868. ):
  2869. tags = TagField(
  2870. required=False
  2871. )
  2872. class DeviceBayBulkEditForm(
  2873. form_from_model(DeviceBay, ['description']),
  2874. BootstrapMixin,
  2875. AddRemoveTagsForm,
  2876. BulkEditForm
  2877. ):
  2878. pk = forms.ModelMultipleChoiceField(
  2879. queryset=DeviceBay.objects.all(),
  2880. widget=forms.MultipleHiddenInput()
  2881. )
  2882. class Meta:
  2883. nullable_fields = (
  2884. 'description',
  2885. )
  2886. class DeviceBayBulkRenameForm(BulkRenameForm):
  2887. pk = forms.ModelMultipleChoiceField(
  2888. queryset=DeviceBay.objects.all(),
  2889. widget=forms.MultipleHiddenInput()
  2890. )
  2891. class DeviceBayCSVForm(CSVModelForm):
  2892. device = CSVModelChoiceField(
  2893. queryset=Device.objects.all(),
  2894. to_field_name='name'
  2895. )
  2896. installed_device = CSVModelChoiceField(
  2897. queryset=Device.objects.all(),
  2898. required=False,
  2899. to_field_name='name',
  2900. help_text='Child device installed within this bay',
  2901. error_messages={
  2902. 'invalid_choice': 'Child device not found.',
  2903. }
  2904. )
  2905. class Meta:
  2906. model = DeviceBay
  2907. fields = DeviceBay.csv_headers
  2908. def __init__(self, *args, **kwargs):
  2909. super().__init__(*args, **kwargs)
  2910. # Limit installed device choices to devices of the correct type and location
  2911. if self.is_bound:
  2912. try:
  2913. device = self.fields['device'].to_python(self.data['device'])
  2914. except forms.ValidationError:
  2915. device = None
  2916. else:
  2917. try:
  2918. device = self.instance.device
  2919. except Device.DoesNotExist:
  2920. device = None
  2921. if device:
  2922. self.fields['installed_device'].queryset = Device.objects.filter(
  2923. site=device.site,
  2924. rack=device.rack,
  2925. parent_bay__isnull=True,
  2926. device_type__u_height=0,
  2927. device_type__subdevice_role=SubdeviceRoleChoices.ROLE_CHILD
  2928. ).exclude(pk=device.pk)
  2929. else:
  2930. self.fields['installed_device'].queryset = Interface.objects.none()
  2931. #
  2932. # Cables
  2933. #
  2934. class ConnectCableToDeviceForm(BootstrapMixin, forms.ModelForm):
  2935. """
  2936. Base form for connecting a Cable to a Device component
  2937. """
  2938. termination_b_site = DynamicModelChoiceField(
  2939. queryset=Site.objects.all(),
  2940. label='Site',
  2941. required=False,
  2942. widget=APISelect(
  2943. filter_for={
  2944. 'termination_b_rack': 'site_id',
  2945. 'termination_b_device': 'site_id',
  2946. }
  2947. )
  2948. )
  2949. termination_b_rack = DynamicModelChoiceField(
  2950. queryset=Rack.objects.all(),
  2951. label='Rack',
  2952. required=False,
  2953. widget=APISelect(
  2954. filter_for={
  2955. 'termination_b_device': 'rack_id',
  2956. },
  2957. attrs={
  2958. 'nullable': 'true',
  2959. }
  2960. )
  2961. )
  2962. termination_b_device = DynamicModelChoiceField(
  2963. queryset=Device.objects.all(),
  2964. label='Device',
  2965. required=False,
  2966. widget=APISelect(
  2967. display_field='display_name',
  2968. filter_for={
  2969. 'termination_b_id': 'device_id',
  2970. }
  2971. )
  2972. )
  2973. class Meta:
  2974. model = Cable
  2975. fields = [
  2976. 'termination_b_site', 'termination_b_rack', 'termination_b_device', 'termination_b_id', 'type', 'status',
  2977. 'label', 'color', 'length', 'length_unit',
  2978. ]
  2979. widgets = {
  2980. 'status': StaticSelect2,
  2981. 'type': StaticSelect2,
  2982. 'length_unit': StaticSelect2,
  2983. }
  2984. class ConnectCableToConsolePortForm(ConnectCableToDeviceForm):
  2985. termination_b_id = forms.IntegerField(
  2986. label='Name',
  2987. widget=APISelect(
  2988. api_url='/api/dcim/console-ports/',
  2989. disabled_indicator='cable',
  2990. )
  2991. )
  2992. class ConnectCableToConsoleServerPortForm(ConnectCableToDeviceForm):
  2993. termination_b_id = forms.IntegerField(
  2994. label='Name',
  2995. widget=APISelect(
  2996. api_url='/api/dcim/console-server-ports/',
  2997. disabled_indicator='cable',
  2998. )
  2999. )
  3000. class ConnectCableToPowerPortForm(ConnectCableToDeviceForm):
  3001. termination_b_id = forms.IntegerField(
  3002. label='Name',
  3003. widget=APISelect(
  3004. api_url='/api/dcim/power-ports/',
  3005. disabled_indicator='cable',
  3006. )
  3007. )
  3008. class ConnectCableToPowerOutletForm(ConnectCableToDeviceForm):
  3009. termination_b_id = forms.IntegerField(
  3010. label='Name',
  3011. widget=APISelect(
  3012. api_url='/api/dcim/power-outlets/',
  3013. disabled_indicator='cable',
  3014. )
  3015. )
  3016. class ConnectCableToInterfaceForm(ConnectCableToDeviceForm):
  3017. termination_b_id = forms.IntegerField(
  3018. label='Name',
  3019. widget=APISelect(
  3020. api_url='/api/dcim/interfaces/',
  3021. disabled_indicator='cable',
  3022. additional_query_params={
  3023. 'kind': 'physical',
  3024. }
  3025. )
  3026. )
  3027. class ConnectCableToFrontPortForm(ConnectCableToDeviceForm):
  3028. termination_b_id = forms.IntegerField(
  3029. label='Name',
  3030. widget=APISelect(
  3031. api_url='/api/dcim/front-ports/',
  3032. disabled_indicator='cable',
  3033. )
  3034. )
  3035. class ConnectCableToRearPortForm(ConnectCableToDeviceForm):
  3036. termination_b_id = forms.IntegerField(
  3037. label='Name',
  3038. widget=APISelect(
  3039. api_url='/api/dcim/rear-ports/',
  3040. disabled_indicator='cable',
  3041. )
  3042. )
  3043. class ConnectCableToCircuitTerminationForm(BootstrapMixin, forms.ModelForm):
  3044. termination_b_provider = DynamicModelChoiceField(
  3045. queryset=Provider.objects.all(),
  3046. label='Provider',
  3047. required=False,
  3048. widget=APISelect(
  3049. filter_for={
  3050. 'termination_b_circuit': 'provider_id',
  3051. }
  3052. )
  3053. )
  3054. termination_b_site = DynamicModelChoiceField(
  3055. queryset=Site.objects.all(),
  3056. label='Site',
  3057. required=False,
  3058. widget=APISelect(
  3059. filter_for={
  3060. 'termination_b_circuit': 'site_id',
  3061. }
  3062. )
  3063. )
  3064. termination_b_circuit = DynamicModelChoiceField(
  3065. queryset=Circuit.objects.all(),
  3066. label='Circuit',
  3067. widget=APISelect(
  3068. display_field='cid',
  3069. filter_for={
  3070. 'termination_b_id': 'circuit_id',
  3071. }
  3072. )
  3073. )
  3074. termination_b_id = forms.IntegerField(
  3075. label='Side',
  3076. widget=APISelect(
  3077. api_url='/api/circuits/circuit-terminations/',
  3078. disabled_indicator='cable',
  3079. display_field='term_side',
  3080. full=True
  3081. )
  3082. )
  3083. class Meta:
  3084. model = Cable
  3085. fields = [
  3086. 'termination_b_provider', 'termination_b_site', 'termination_b_circuit', 'termination_b_id', 'type',
  3087. 'status', 'label', 'color', 'length', 'length_unit',
  3088. ]
  3089. class ConnectCableToPowerFeedForm(BootstrapMixin, forms.ModelForm):
  3090. termination_b_site = DynamicModelChoiceField(
  3091. queryset=Site.objects.all(),
  3092. label='Site',
  3093. required=False,
  3094. widget=APISelect(
  3095. display_field='cid',
  3096. filter_for={
  3097. 'termination_b_rackgroup': 'site_id',
  3098. 'termination_b_powerpanel': 'site_id',
  3099. }
  3100. )
  3101. )
  3102. termination_b_rackgroup = DynamicModelChoiceField(
  3103. queryset=RackGroup.objects.all(),
  3104. label='Rack Group',
  3105. required=False,
  3106. widget=APISelect(
  3107. display_field='cid',
  3108. filter_for={
  3109. 'termination_b_powerpanel': 'rackgroup_id',
  3110. }
  3111. )
  3112. )
  3113. termination_b_powerpanel = DynamicModelChoiceField(
  3114. queryset=PowerPanel.objects.all(),
  3115. label='Power Panel',
  3116. required=False,
  3117. widget=APISelect(
  3118. filter_for={
  3119. 'termination_b_id': 'power_panel_id',
  3120. }
  3121. )
  3122. )
  3123. termination_b_id = forms.IntegerField(
  3124. label='Name',
  3125. widget=APISelect(
  3126. api_url='/api/dcim/power-feeds/',
  3127. )
  3128. )
  3129. class Meta:
  3130. model = Cable
  3131. fields = [
  3132. 'termination_b_rackgroup', 'termination_b_powerpanel', 'termination_b_id', 'type', 'status', 'label',
  3133. 'color', 'length', 'length_unit',
  3134. ]
  3135. class CableForm(BootstrapMixin, forms.ModelForm):
  3136. class Meta:
  3137. model = Cable
  3138. fields = [
  3139. 'type', 'status', 'label', 'color', 'length', 'length_unit',
  3140. ]
  3141. widgets = {
  3142. 'status': StaticSelect2,
  3143. 'type': StaticSelect2,
  3144. 'length_unit': StaticSelect2,
  3145. }
  3146. error_messages = {
  3147. 'length': {
  3148. 'max_value': 'Maximum length is 32767 (any unit)'
  3149. }
  3150. }
  3151. class CableCSVForm(CSVModelForm):
  3152. # Termination A
  3153. side_a_device = CSVModelChoiceField(
  3154. queryset=Device.objects.all(),
  3155. to_field_name='name',
  3156. help_text='Side A device'
  3157. )
  3158. side_a_type = CSVModelChoiceField(
  3159. queryset=ContentType.objects.all(),
  3160. limit_choices_to=CABLE_TERMINATION_MODELS,
  3161. to_field_name='model',
  3162. help_text='Side A type'
  3163. )
  3164. side_a_name = forms.CharField(
  3165. help_text='Side A component name'
  3166. )
  3167. # Termination B
  3168. side_b_device = CSVModelChoiceField(
  3169. queryset=Device.objects.all(),
  3170. to_field_name='name',
  3171. help_text='Side B device'
  3172. )
  3173. side_b_type = CSVModelChoiceField(
  3174. queryset=ContentType.objects.all(),
  3175. limit_choices_to=CABLE_TERMINATION_MODELS,
  3176. to_field_name='model',
  3177. help_text='Side B type'
  3178. )
  3179. side_b_name = forms.CharField(
  3180. help_text='Side B component name'
  3181. )
  3182. # Cable attributes
  3183. status = CSVChoiceField(
  3184. choices=CableStatusChoices,
  3185. required=False,
  3186. help_text='Connection status'
  3187. )
  3188. type = CSVChoiceField(
  3189. choices=CableTypeChoices,
  3190. required=False,
  3191. help_text='Physical medium classification'
  3192. )
  3193. length_unit = CSVChoiceField(
  3194. choices=CableLengthUnitChoices,
  3195. required=False,
  3196. help_text='Length unit'
  3197. )
  3198. class Meta:
  3199. model = Cable
  3200. fields = [
  3201. 'side_a_device', 'side_a_type', 'side_a_name', 'side_b_device', 'side_b_type', 'side_b_name', 'type',
  3202. 'status', 'label', 'color', 'length', 'length_unit',
  3203. ]
  3204. help_texts = {
  3205. 'color': mark_safe('RGB color in hexadecimal (e.g. <code>00ff00</code>)'),
  3206. }
  3207. # TODO: Merge the clean() methods for either end
  3208. def clean_side_a_name(self):
  3209. device = self.cleaned_data.get('side_a_device')
  3210. content_type = self.cleaned_data.get('side_a_type')
  3211. name = self.cleaned_data.get('side_a_name')
  3212. if not device or not content_type or not name:
  3213. return None
  3214. model = content_type.model_class()
  3215. try:
  3216. termination_object = model.objects.get(
  3217. device=device,
  3218. name=name
  3219. )
  3220. if termination_object.cable is not None:
  3221. raise forms.ValidationError(
  3222. "Side A: {} {} is already connected".format(device, termination_object)
  3223. )
  3224. except ObjectDoesNotExist:
  3225. raise forms.ValidationError(
  3226. "A side termination not found: {} {}".format(device, name)
  3227. )
  3228. self.instance.termination_a = termination_object
  3229. return termination_object
  3230. def clean_side_b_name(self):
  3231. device = self.cleaned_data.get('side_b_device')
  3232. content_type = self.cleaned_data.get('side_b_type')
  3233. name = self.cleaned_data.get('side_b_name')
  3234. if not device or not content_type or not name:
  3235. return None
  3236. model = content_type.model_class()
  3237. try:
  3238. termination_object = model.objects.get(
  3239. device=device,
  3240. name=name
  3241. )
  3242. if termination_object.cable is not None:
  3243. raise forms.ValidationError(
  3244. "Side B: {} {} is already connected".format(device, termination_object)
  3245. )
  3246. except ObjectDoesNotExist:
  3247. raise forms.ValidationError(
  3248. "B side termination not found: {} {}".format(device, name)
  3249. )
  3250. self.instance.termination_b = termination_object
  3251. return termination_object
  3252. def clean_length_unit(self):
  3253. # Avoid trying to save as NULL
  3254. length_unit = self.cleaned_data.get('length_unit', None)
  3255. return length_unit if length_unit is not None else ''
  3256. class CableBulkEditForm(BootstrapMixin, BulkEditForm):
  3257. pk = forms.ModelMultipleChoiceField(
  3258. queryset=Cable.objects.all(),
  3259. widget=forms.MultipleHiddenInput
  3260. )
  3261. type = forms.ChoiceField(
  3262. choices=add_blank_choice(CableTypeChoices),
  3263. required=False,
  3264. initial='',
  3265. widget=StaticSelect2()
  3266. )
  3267. status = forms.ChoiceField(
  3268. choices=add_blank_choice(CableStatusChoices),
  3269. required=False,
  3270. widget=StaticSelect2(),
  3271. initial=''
  3272. )
  3273. label = forms.CharField(
  3274. max_length=100,
  3275. required=False
  3276. )
  3277. color = forms.CharField(
  3278. max_length=6, # RGB color code
  3279. required=False,
  3280. widget=ColorSelect()
  3281. )
  3282. length = forms.IntegerField(
  3283. min_value=1,
  3284. required=False
  3285. )
  3286. length_unit = forms.ChoiceField(
  3287. choices=add_blank_choice(CableLengthUnitChoices),
  3288. required=False,
  3289. initial='',
  3290. widget=StaticSelect2()
  3291. )
  3292. class Meta:
  3293. nullable_fields = [
  3294. 'type', 'status', 'label', 'color', 'length',
  3295. ]
  3296. def clean(self):
  3297. # Validate length/unit
  3298. length = self.cleaned_data.get('length')
  3299. length_unit = self.cleaned_data.get('length_unit')
  3300. if length and not length_unit:
  3301. raise forms.ValidationError({
  3302. 'length_unit': "Must specify a unit when setting length"
  3303. })
  3304. class CableFilterForm(BootstrapMixin, forms.Form):
  3305. model = Cable
  3306. q = forms.CharField(
  3307. required=False,
  3308. label='Search'
  3309. )
  3310. site = DynamicModelMultipleChoiceField(
  3311. queryset=Site.objects.all(),
  3312. to_field_name='slug',
  3313. required=False,
  3314. widget=APISelectMultiple(
  3315. value_field="slug",
  3316. filter_for={
  3317. 'rack_id': 'site',
  3318. 'device_id': 'site',
  3319. }
  3320. )
  3321. )
  3322. tenant = DynamicModelMultipleChoiceField(
  3323. queryset=Tenant.objects.all(),
  3324. to_field_name='slug',
  3325. required=False,
  3326. widget=APISelectMultiple(
  3327. value_field='slug',
  3328. filter_for={
  3329. 'device_id': 'tenant',
  3330. }
  3331. )
  3332. )
  3333. rack_id = DynamicModelMultipleChoiceField(
  3334. queryset=Rack.objects.all(),
  3335. required=False,
  3336. label='Rack',
  3337. widget=APISelectMultiple(
  3338. null_option=True,
  3339. filter_for={
  3340. 'device_id': 'rack_id',
  3341. }
  3342. )
  3343. )
  3344. type = forms.MultipleChoiceField(
  3345. choices=add_blank_choice(CableTypeChoices),
  3346. required=False,
  3347. widget=StaticSelect2()
  3348. )
  3349. status = forms.ChoiceField(
  3350. required=False,
  3351. choices=add_blank_choice(CableStatusChoices),
  3352. widget=StaticSelect2()
  3353. )
  3354. color = forms.CharField(
  3355. max_length=6, # RGB color code
  3356. required=False,
  3357. widget=ColorSelect()
  3358. )
  3359. device_id = DynamicModelMultipleChoiceField(
  3360. queryset=Device.objects.all(),
  3361. required=False,
  3362. label='Device'
  3363. )
  3364. #
  3365. # Connections
  3366. #
  3367. class ConsoleConnectionFilterForm(BootstrapMixin, forms.Form):
  3368. site = DynamicModelMultipleChoiceField(
  3369. queryset=Site.objects.all(),
  3370. to_field_name='slug',
  3371. required=False,
  3372. widget=APISelectMultiple(
  3373. value_field="slug",
  3374. filter_for={
  3375. 'device_id': 'site',
  3376. }
  3377. )
  3378. )
  3379. device_id = DynamicModelMultipleChoiceField(
  3380. queryset=Device.objects.all(),
  3381. required=False,
  3382. label='Device'
  3383. )
  3384. class PowerConnectionFilterForm(BootstrapMixin, forms.Form):
  3385. site = DynamicModelMultipleChoiceField(
  3386. queryset=Site.objects.all(),
  3387. to_field_name='slug',
  3388. required=False,
  3389. widget=APISelectMultiple(
  3390. value_field="slug",
  3391. filter_for={
  3392. 'device_id': 'site',
  3393. }
  3394. )
  3395. )
  3396. device_id = DynamicModelMultipleChoiceField(
  3397. queryset=Device.objects.all(),
  3398. required=False,
  3399. label='Device'
  3400. )
  3401. class InterfaceConnectionFilterForm(BootstrapMixin, forms.Form):
  3402. site = DynamicModelMultipleChoiceField(
  3403. queryset=Site.objects.all(),
  3404. to_field_name='slug',
  3405. required=False,
  3406. widget=APISelectMultiple(
  3407. value_field="slug",
  3408. filter_for={
  3409. 'device_id': 'site',
  3410. }
  3411. )
  3412. )
  3413. device_id = DynamicModelMultipleChoiceField(
  3414. queryset=Device.objects.all(),
  3415. required=False,
  3416. label='Device'
  3417. )
  3418. #
  3419. # Inventory items
  3420. #
  3421. class InventoryItemForm(BootstrapMixin, forms.ModelForm):
  3422. device = DynamicModelChoiceField(
  3423. queryset=Device.objects.prefetch_related('device_type__manufacturer')
  3424. )
  3425. manufacturer = DynamicModelChoiceField(
  3426. queryset=Manufacturer.objects.all(),
  3427. required=False
  3428. )
  3429. tags = TagField(
  3430. required=False
  3431. )
  3432. class Meta:
  3433. model = InventoryItem
  3434. fields = [
  3435. 'name', 'device', 'manufacturer', 'part_id', 'serial', 'asset_tag', 'description', 'tags',
  3436. ]
  3437. class InventoryItemCreateForm(BootstrapMixin, forms.Form):
  3438. device = DynamicModelChoiceField(
  3439. queryset=Device.objects.prefetch_related('device_type__manufacturer')
  3440. )
  3441. name_pattern = ExpandableNameField(
  3442. label='Name'
  3443. )
  3444. manufacturer = DynamicModelChoiceField(
  3445. queryset=Manufacturer.objects.all(),
  3446. required=False
  3447. )
  3448. part_id = forms.CharField(
  3449. max_length=50,
  3450. required=False,
  3451. label='Part ID'
  3452. )
  3453. serial = forms.CharField(
  3454. max_length=50,
  3455. required=False,
  3456. )
  3457. asset_tag = forms.CharField(
  3458. max_length=50,
  3459. required=False,
  3460. )
  3461. description = forms.CharField(
  3462. max_length=100,
  3463. required=False
  3464. )
  3465. class InventoryItemCSVForm(CSVModelForm):
  3466. device = CSVModelChoiceField(
  3467. queryset=Device.objects.all(),
  3468. to_field_name='name'
  3469. )
  3470. manufacturer = CSVModelChoiceField(
  3471. queryset=Manufacturer.objects.all(),
  3472. to_field_name='name',
  3473. required=False
  3474. )
  3475. class Meta:
  3476. model = InventoryItem
  3477. fields = InventoryItem.csv_headers
  3478. class InventoryItemBulkEditForm(BootstrapMixin, BulkEditForm):
  3479. pk = forms.ModelMultipleChoiceField(
  3480. queryset=InventoryItem.objects.all(),
  3481. widget=forms.MultipleHiddenInput()
  3482. )
  3483. device = DynamicModelChoiceField(
  3484. queryset=Device.objects.all(),
  3485. required=False
  3486. )
  3487. manufacturer = DynamicModelChoiceField(
  3488. queryset=Manufacturer.objects.all(),
  3489. required=False
  3490. )
  3491. part_id = forms.CharField(
  3492. max_length=50,
  3493. required=False,
  3494. label='Part ID'
  3495. )
  3496. description = forms.CharField(
  3497. max_length=100,
  3498. required=False
  3499. )
  3500. class Meta:
  3501. nullable_fields = [
  3502. 'manufacturer', 'part_id', 'description',
  3503. ]
  3504. class InventoryItemFilterForm(BootstrapMixin, forms.Form):
  3505. model = InventoryItem
  3506. q = forms.CharField(
  3507. required=False,
  3508. label='Search'
  3509. )
  3510. region = DynamicModelMultipleChoiceField(
  3511. queryset=Region.objects.all(),
  3512. to_field_name='slug',
  3513. required=False,
  3514. widget=APISelectMultiple(
  3515. value_field="slug",
  3516. filter_for={
  3517. 'site': 'region'
  3518. }
  3519. )
  3520. )
  3521. site = DynamicModelMultipleChoiceField(
  3522. queryset=Site.objects.all(),
  3523. to_field_name='slug',
  3524. required=False,
  3525. widget=APISelectMultiple(
  3526. value_field="slug",
  3527. filter_for={
  3528. 'device_id': 'site'
  3529. }
  3530. )
  3531. )
  3532. device_id = DynamicModelMultipleChoiceField(
  3533. queryset=Device.objects.all(),
  3534. required=False,
  3535. label='Device'
  3536. )
  3537. manufacturer = DynamicModelMultipleChoiceField(
  3538. queryset=Manufacturer.objects.all(),
  3539. to_field_name='slug',
  3540. required=False,
  3541. widget=APISelect(
  3542. value_field="slug",
  3543. )
  3544. )
  3545. discovered = forms.NullBooleanField(
  3546. required=False,
  3547. widget=StaticSelect2(
  3548. choices=BOOLEAN_WITH_BLANK_CHOICES
  3549. )
  3550. )
  3551. tag = TagFilterField(model)
  3552. #
  3553. # Virtual chassis
  3554. #
  3555. class DeviceSelectionForm(forms.Form):
  3556. pk = forms.ModelMultipleChoiceField(
  3557. queryset=Device.objects.all(),
  3558. widget=forms.MultipleHiddenInput()
  3559. )
  3560. class VirtualChassisForm(BootstrapMixin, forms.ModelForm):
  3561. tags = TagField(
  3562. required=False
  3563. )
  3564. class Meta:
  3565. model = VirtualChassis
  3566. fields = [
  3567. 'master', 'domain', 'tags',
  3568. ]
  3569. widgets = {
  3570. 'master': SelectWithPK(),
  3571. }
  3572. class BaseVCMemberFormSet(forms.BaseModelFormSet):
  3573. def clean(self):
  3574. super().clean()
  3575. # Check for duplicate VC position values
  3576. vc_position_list = []
  3577. for form in self.forms:
  3578. vc_position = form.cleaned_data.get('vc_position')
  3579. if vc_position:
  3580. if vc_position in vc_position_list:
  3581. error_msg = 'A virtual chassis member already exists in position {}.'.format(vc_position)
  3582. form.add_error('vc_position', error_msg)
  3583. vc_position_list.append(vc_position)
  3584. class DeviceVCMembershipForm(forms.ModelForm):
  3585. class Meta:
  3586. model = Device
  3587. fields = [
  3588. 'vc_position', 'vc_priority',
  3589. ]
  3590. labels = {
  3591. 'vc_position': 'Position',
  3592. 'vc_priority': 'Priority',
  3593. }
  3594. def __init__(self, validate_vc_position=False, *args, **kwargs):
  3595. super().__init__(*args, **kwargs)
  3596. # Require VC position (only required when the Device is a VirtualChassis member)
  3597. self.fields['vc_position'].required = True
  3598. # Validation of vc_position is optional. This is only required when adding a new member to an existing
  3599. # VirtualChassis. Otherwise, vc_position validation is handled by BaseVCMemberFormSet.
  3600. self.validate_vc_position = validate_vc_position
  3601. def clean_vc_position(self):
  3602. vc_position = self.cleaned_data['vc_position']
  3603. if self.validate_vc_position:
  3604. conflicting_members = Device.objects.filter(
  3605. virtual_chassis=self.instance.virtual_chassis,
  3606. vc_position=vc_position
  3607. )
  3608. if conflicting_members.exists():
  3609. raise forms.ValidationError(
  3610. 'A virtual chassis member already exists in position {}.'.format(vc_position)
  3611. )
  3612. return vc_position
  3613. class VCMemberSelectForm(BootstrapMixin, forms.Form):
  3614. site = DynamicModelChoiceField(
  3615. queryset=Site.objects.all(),
  3616. required=False,
  3617. widget=APISelect(
  3618. filter_for={
  3619. 'rack': 'site_id',
  3620. 'device': 'site_id',
  3621. }
  3622. )
  3623. )
  3624. rack = DynamicModelChoiceField(
  3625. queryset=Rack.objects.all(),
  3626. required=False,
  3627. widget=APISelect(
  3628. filter_for={
  3629. 'device': 'rack_id'
  3630. },
  3631. attrs={
  3632. 'nullable': 'true',
  3633. }
  3634. )
  3635. )
  3636. device = DynamicModelChoiceField(
  3637. queryset=Device.objects.filter(
  3638. virtual_chassis__isnull=True
  3639. ),
  3640. widget=APISelect(
  3641. display_field='display_name',
  3642. disabled_indicator='virtual_chassis'
  3643. )
  3644. )
  3645. def clean_device(self):
  3646. device = self.cleaned_data['device']
  3647. if device.virtual_chassis is not None:
  3648. raise forms.ValidationError(
  3649. "Device {} is already assigned to a virtual chassis.".format(device)
  3650. )
  3651. return device
  3652. class VirtualChassisBulkEditForm(BootstrapMixin, AddRemoveTagsForm, BulkEditForm):
  3653. pk = forms.ModelMultipleChoiceField(
  3654. queryset=VirtualChassis.objects.all(),
  3655. widget=forms.MultipleHiddenInput()
  3656. )
  3657. domain = forms.CharField(
  3658. max_length=30,
  3659. required=False
  3660. )
  3661. class Meta:
  3662. nullable_fields = ['domain']
  3663. class VirtualChassisFilterForm(BootstrapMixin, CustomFieldFilterForm):
  3664. model = VirtualChassis
  3665. q = forms.CharField(
  3666. required=False,
  3667. label='Search'
  3668. )
  3669. region = DynamicModelMultipleChoiceField(
  3670. queryset=Region.objects.all(),
  3671. to_field_name='slug',
  3672. required=False,
  3673. widget=APISelectMultiple(
  3674. value_field="slug",
  3675. filter_for={
  3676. 'site': 'region'
  3677. }
  3678. )
  3679. )
  3680. site = DynamicModelMultipleChoiceField(
  3681. queryset=Site.objects.all(),
  3682. to_field_name='slug',
  3683. required=False,
  3684. widget=APISelectMultiple(
  3685. value_field="slug",
  3686. )
  3687. )
  3688. tenant_group = DynamicModelMultipleChoiceField(
  3689. queryset=TenantGroup.objects.all(),
  3690. to_field_name='slug',
  3691. required=False,
  3692. widget=APISelectMultiple(
  3693. value_field="slug",
  3694. null_option=True,
  3695. filter_for={
  3696. 'tenant': 'group'
  3697. }
  3698. )
  3699. )
  3700. tenant = DynamicModelMultipleChoiceField(
  3701. queryset=Tenant.objects.all(),
  3702. to_field_name='slug',
  3703. required=False,
  3704. widget=APISelectMultiple(
  3705. value_field="slug",
  3706. null_option=True,
  3707. )
  3708. )
  3709. tag = TagFilterField(model)
  3710. #
  3711. # Power panels
  3712. #
  3713. class PowerPanelForm(BootstrapMixin, forms.ModelForm):
  3714. site = DynamicModelChoiceField(
  3715. queryset=Site.objects.all(),
  3716. widget=APISelect(
  3717. filter_for={
  3718. 'rack_group': 'site_id',
  3719. }
  3720. )
  3721. )
  3722. rack_group = DynamicModelChoiceField(
  3723. queryset=RackGroup.objects.all(),
  3724. required=False
  3725. )
  3726. class Meta:
  3727. model = PowerPanel
  3728. fields = [
  3729. 'site', 'rack_group', 'name',
  3730. ]
  3731. class PowerPanelCSVForm(CSVModelForm):
  3732. site = CSVModelChoiceField(
  3733. queryset=Site.objects.all(),
  3734. to_field_name='name',
  3735. help_text='Name of parent site'
  3736. )
  3737. rack_group = CSVModelChoiceField(
  3738. queryset=RackGroup.objects.all(),
  3739. required=False,
  3740. to_field_name='name'
  3741. )
  3742. class Meta:
  3743. model = PowerPanel
  3744. fields = PowerPanel.csv_headers
  3745. def __init__(self, data=None, *args, **kwargs):
  3746. super().__init__(data, *args, **kwargs)
  3747. if data:
  3748. # Limit group queryset by assigned site
  3749. params = {f"site__{self.fields['site'].to_field_name}": data.get('site')}
  3750. self.fields['rack_group'].queryset = self.fields['rack_group'].queryset.filter(**params)
  3751. class PowerPanelBulkEditForm(BootstrapMixin, BulkEditForm):
  3752. pk = forms.ModelMultipleChoiceField(
  3753. queryset=PowerPanel.objects.all(),
  3754. widget=forms.MultipleHiddenInput
  3755. )
  3756. site = DynamicModelChoiceField(
  3757. queryset=Site.objects.all(),
  3758. required=False,
  3759. widget=APISelect(
  3760. filter_for={
  3761. 'rack_group': 'site_id',
  3762. }
  3763. )
  3764. )
  3765. rack_group = DynamicModelChoiceField(
  3766. queryset=RackGroup.objects.all(),
  3767. required=False
  3768. )
  3769. class Meta:
  3770. nullable_fields = (
  3771. 'rack_group',
  3772. )
  3773. class PowerPanelFilterForm(BootstrapMixin, CustomFieldFilterForm):
  3774. model = PowerPanel
  3775. q = forms.CharField(
  3776. required=False,
  3777. label='Search'
  3778. )
  3779. region = DynamicModelMultipleChoiceField(
  3780. queryset=Region.objects.all(),
  3781. to_field_name='slug',
  3782. required=False,
  3783. widget=APISelectMultiple(
  3784. value_field="slug",
  3785. filter_for={
  3786. 'site': 'region'
  3787. }
  3788. )
  3789. )
  3790. site = DynamicModelMultipleChoiceField(
  3791. queryset=Site.objects.all(),
  3792. to_field_name='slug',
  3793. required=False,
  3794. widget=APISelectMultiple(
  3795. value_field="slug",
  3796. filter_for={
  3797. 'rack_group_id': 'site',
  3798. }
  3799. )
  3800. )
  3801. rack_group_id = DynamicModelMultipleChoiceField(
  3802. queryset=RackGroup.objects.all(),
  3803. required=False,
  3804. label='Rack group (ID)',
  3805. widget=APISelectMultiple(
  3806. null_option=True,
  3807. )
  3808. )
  3809. #
  3810. # Power feeds
  3811. #
  3812. class PowerFeedForm(BootstrapMixin, CustomFieldModelForm):
  3813. site = DynamicModelChoiceField(
  3814. queryset=Site.objects.all(),
  3815. required=False,
  3816. widget=APISelect(
  3817. filter_for={
  3818. 'power_panel': 'site_id',
  3819. 'rack': 'site_id',
  3820. }
  3821. )
  3822. )
  3823. power_panel = DynamicModelChoiceField(
  3824. queryset=PowerPanel.objects.all()
  3825. )
  3826. rack = DynamicModelChoiceField(
  3827. queryset=Rack.objects.all(),
  3828. required=False
  3829. )
  3830. comments = CommentField()
  3831. tags = TagField(
  3832. required=False
  3833. )
  3834. class Meta:
  3835. model = PowerFeed
  3836. fields = [
  3837. 'site', 'power_panel', 'rack', 'name', 'status', 'type', 'supply', 'phase', 'voltage', 'amperage',
  3838. 'max_utilization', 'comments', 'tags',
  3839. ]
  3840. widgets = {
  3841. 'status': StaticSelect2(),
  3842. 'type': StaticSelect2(),
  3843. 'supply': StaticSelect2(),
  3844. 'phase': StaticSelect2(),
  3845. }
  3846. def __init__(self, *args, **kwargs):
  3847. super().__init__(*args, **kwargs)
  3848. # Initialize site field
  3849. if self.instance and hasattr(self.instance, 'power_panel'):
  3850. self.initial['site'] = self.instance.power_panel.site
  3851. class PowerFeedCSVForm(CustomFieldModelCSVForm):
  3852. site = CSVModelChoiceField(
  3853. queryset=Site.objects.all(),
  3854. to_field_name='name',
  3855. help_text='Assigned site'
  3856. )
  3857. power_panel = CSVModelChoiceField(
  3858. queryset=PowerPanel.objects.all(),
  3859. to_field_name='name',
  3860. help_text='Upstream power panel'
  3861. )
  3862. rack_group = CSVModelChoiceField(
  3863. queryset=RackGroup.objects.all(),
  3864. to_field_name='name',
  3865. required=False,
  3866. help_text="Rack's group (if any)"
  3867. )
  3868. rack = CSVModelChoiceField(
  3869. queryset=Rack.objects.all(),
  3870. to_field_name='name',
  3871. required=False,
  3872. help_text='Rack'
  3873. )
  3874. status = CSVChoiceField(
  3875. choices=PowerFeedStatusChoices,
  3876. required=False,
  3877. help_text='Operational status'
  3878. )
  3879. type = CSVChoiceField(
  3880. choices=PowerFeedTypeChoices,
  3881. required=False,
  3882. help_text='Primary or redundant'
  3883. )
  3884. supply = CSVChoiceField(
  3885. choices=PowerFeedSupplyChoices,
  3886. required=False,
  3887. help_text='Supply type (AC/DC)'
  3888. )
  3889. phase = CSVChoiceField(
  3890. choices=PowerFeedPhaseChoices,
  3891. required=False,
  3892. help_text='Single or three-phase'
  3893. )
  3894. class Meta:
  3895. model = PowerFeed
  3896. fields = PowerFeed.csv_headers
  3897. def __init__(self, data=None, *args, **kwargs):
  3898. super().__init__(data, *args, **kwargs)
  3899. if data:
  3900. # Limit power_panel queryset by site
  3901. params = {f"site__{self.fields['site'].to_field_name}": data.get('site')}
  3902. self.fields['power_panel'].queryset = self.fields['power_panel'].queryset.filter(**params)
  3903. # Limit rack_group queryset by site
  3904. params = {f"site__{self.fields['site'].to_field_name}": data.get('site')}
  3905. self.fields['rack_group'].queryset = self.fields['rack_group'].queryset.filter(**params)
  3906. # Limit rack queryset by site and group
  3907. params = {
  3908. f"site__{self.fields['site'].to_field_name}": data.get('site'),
  3909. f"group__{self.fields['rack_group'].to_field_name}": data.get('rack_group'),
  3910. }
  3911. self.fields['rack'].queryset = self.fields['rack'].queryset.filter(**params)
  3912. class PowerFeedBulkEditForm(BootstrapMixin, AddRemoveTagsForm, CustomFieldBulkEditForm):
  3913. pk = forms.ModelMultipleChoiceField(
  3914. queryset=PowerFeed.objects.all(),
  3915. widget=forms.MultipleHiddenInput
  3916. )
  3917. power_panel = DynamicModelChoiceField(
  3918. queryset=PowerPanel.objects.all(),
  3919. required=False,
  3920. widget=APISelect(
  3921. filter_for={
  3922. 'rackgroup': 'site_id',
  3923. }
  3924. )
  3925. )
  3926. rack = DynamicModelChoiceField(
  3927. queryset=Rack.objects.all(),
  3928. required=False
  3929. )
  3930. status = forms.ChoiceField(
  3931. choices=add_blank_choice(PowerFeedStatusChoices),
  3932. required=False,
  3933. initial='',
  3934. widget=StaticSelect2()
  3935. )
  3936. type = forms.ChoiceField(
  3937. choices=add_blank_choice(PowerFeedTypeChoices),
  3938. required=False,
  3939. initial='',
  3940. widget=StaticSelect2()
  3941. )
  3942. supply = forms.ChoiceField(
  3943. choices=add_blank_choice(PowerFeedSupplyChoices),
  3944. required=False,
  3945. initial='',
  3946. widget=StaticSelect2()
  3947. )
  3948. phase = forms.ChoiceField(
  3949. choices=add_blank_choice(PowerFeedPhaseChoices),
  3950. required=False,
  3951. initial='',
  3952. widget=StaticSelect2()
  3953. )
  3954. voltage = forms.IntegerField(
  3955. required=False
  3956. )
  3957. amperage = forms.IntegerField(
  3958. required=False
  3959. )
  3960. max_utilization = forms.IntegerField(
  3961. required=False
  3962. )
  3963. comments = CommentField(
  3964. widget=SmallTextarea,
  3965. label='Comments'
  3966. )
  3967. class Meta:
  3968. nullable_fields = [
  3969. 'rackgroup', 'comments',
  3970. ]
  3971. class PowerFeedFilterForm(BootstrapMixin, CustomFieldFilterForm):
  3972. model = PowerFeed
  3973. q = forms.CharField(
  3974. required=False,
  3975. label='Search'
  3976. )
  3977. region = DynamicModelMultipleChoiceField(
  3978. queryset=Region.objects.all(),
  3979. to_field_name='slug',
  3980. required=False,
  3981. widget=APISelectMultiple(
  3982. value_field="slug",
  3983. filter_for={
  3984. 'site': 'region'
  3985. }
  3986. )
  3987. )
  3988. site = DynamicModelMultipleChoiceField(
  3989. queryset=Site.objects.all(),
  3990. to_field_name='slug',
  3991. required=False,
  3992. widget=APISelectMultiple(
  3993. value_field="slug",
  3994. filter_for={
  3995. 'power_panel_id': 'site',
  3996. 'rack_id': 'site',
  3997. }
  3998. )
  3999. )
  4000. power_panel_id = DynamicModelMultipleChoiceField(
  4001. queryset=PowerPanel.objects.all(),
  4002. required=False,
  4003. label='Power panel',
  4004. widget=APISelectMultiple(
  4005. null_option=True,
  4006. )
  4007. )
  4008. rack_id = DynamicModelMultipleChoiceField(
  4009. queryset=Rack.objects.all(),
  4010. required=False,
  4011. label='Rack',
  4012. widget=APISelectMultiple(
  4013. null_option=True,
  4014. )
  4015. )
  4016. status = forms.MultipleChoiceField(
  4017. choices=PowerFeedStatusChoices,
  4018. required=False,
  4019. widget=StaticSelect2Multiple()
  4020. )
  4021. type = forms.ChoiceField(
  4022. choices=add_blank_choice(PowerFeedTypeChoices),
  4023. required=False,
  4024. widget=StaticSelect2()
  4025. )
  4026. supply = forms.ChoiceField(
  4027. choices=add_blank_choice(PowerFeedSupplyChoices),
  4028. required=False,
  4029. widget=StaticSelect2()
  4030. )
  4031. phase = forms.ChoiceField(
  4032. choices=add_blank_choice(PowerFeedPhaseChoices),
  4033. required=False,
  4034. widget=StaticSelect2()
  4035. )
  4036. voltage = forms.IntegerField(
  4037. required=False
  4038. )
  4039. amperage = forms.IntegerField(
  4040. required=False
  4041. )
  4042. max_utilization = forms.IntegerField(
  4043. required=False
  4044. )
  4045. tag = TagFilterField(model)