12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769 |
- from __future__ import unicode_literals
- from mptt.forms import TreeNodeChoiceField
- import re
- from django import forms
- from django.contrib.postgres.forms.array import SimpleArrayField
- from django.db.models import Count, Q
- from extras.forms import CustomFieldForm, CustomFieldBulkEditForm, CustomFieldFilterForm
- from ipam.models import IPAddress
- from tenancy.forms import TenancyForm
- from tenancy.models import Tenant
- from utilities.forms import (
- APISelect, add_blank_choice, ArrayFieldSelectMultiple, BootstrapMixin, BulkEditForm, BulkEditNullBooleanSelect,
- ChainedFieldsMixin, ChainedModelChoiceField, CommentField, ConfirmationForm, CSVChoiceField, ExpandableNameField,
- FilterChoiceField, FlexibleModelChoiceField, Livesearch, SelectWithDisabled, SmallTextarea, SlugField,
- FilterTreeNodeMultipleChoiceField,
- )
- from .formfields import MACAddressFormField
- from .models import (
- DeviceBay, DeviceBayTemplate, CONNECTION_STATUS_CHOICES, CONNECTION_STATUS_CONNECTED, ConsolePort,
- ConsolePortTemplate, ConsoleServerPort, ConsoleServerPortTemplate, Device, DeviceRole, DeviceType, Interface,
- IFACE_FF_CHOICES, IFACE_FF_LAG, IFACE_ORDERING_CHOICES, InterfaceConnection, InterfaceTemplate, Manufacturer,
- InventoryItem, Platform, PowerOutlet, PowerOutletTemplate, PowerPort, PowerPortTemplate, RACK_FACE_CHOICES,
- RACK_TYPE_CHOICES, RACK_WIDTH_CHOICES, Rack, RackGroup, RackReservation, RackRole, RACK_WIDTH_19IN, RACK_WIDTH_23IN,
- Region, Site, STATUS_CHOICES, SUBDEVICE_ROLE_CHILD, SUBDEVICE_ROLE_PARENT,
- )
- FORM_STATUS_CHOICES = [
- ['', '---------'],
- ]
- FORM_STATUS_CHOICES += STATUS_CHOICES
- DEVICE_BY_PK_RE = '{\d+\}'
- def get_device_by_name_or_pk(name):
- """
- Attempt to retrieve a device by either its name or primary key ('{pk}').
- """
- if re.match(DEVICE_BY_PK_RE, name):
- pk = name.strip('{}')
- device = Device.objects.get(pk=pk)
- else:
- device = Device.objects.get(name=name)
- return device
- class DeviceComponentForm(BootstrapMixin, forms.Form):
- """
- Allow inclusion of the parent device as context for limiting field choices.
- """
- def __init__(self, device, *args, **kwargs):
- self.device = device
- super(DeviceComponentForm, self).__init__(*args, **kwargs)
- #
- # Regions
- #
- class RegionForm(BootstrapMixin, forms.ModelForm):
- slug = SlugField()
- class Meta:
- model = Region
- fields = ['parent', 'name', 'slug']
- #
- # Sites
- #
- class SiteForm(BootstrapMixin, TenancyForm, CustomFieldForm):
- region = TreeNodeChoiceField(queryset=Region.objects.all(), required=False)
- slug = SlugField()
- comments = CommentField()
- class Meta:
- model = Site
- fields = [
- 'name', 'slug', 'region', 'tenant_group', 'tenant', 'facility', 'asn', 'physical_address',
- 'shipping_address', 'contact_name', 'contact_phone', 'contact_email', 'comments',
- ]
- widgets = {
- 'physical_address': SmallTextarea(attrs={'rows': 3}),
- 'shipping_address': SmallTextarea(attrs={'rows': 3}),
- }
- help_texts = {
- 'name': "Full name of the site",
- 'facility': "Data center provider and facility (e.g. Equinix NY7)",
- 'asn': "BGP autonomous system number",
- 'physical_address': "Physical location of the building (e.g. for GPS)",
- 'shipping_address': "If different from the physical address"
- }
- class SiteCSVForm(forms.ModelForm):
- region = forms.ModelChoiceField(
- queryset=Region.objects.all(),
- required=False,
- to_field_name='name',
- help_text='Name of assigned region',
- error_messages={
- 'invalid_choice': 'Region not found.',
- }
- )
- tenant = forms.ModelChoiceField(
- queryset=Tenant.objects.all(),
- required=False,
- to_field_name='name',
- help_text='Name of assigned tenant',
- error_messages={
- 'invalid_choice': 'Tenant not found.',
- }
- )
- class Meta:
- model = Site
- fields = [
- 'name', 'slug', 'region', 'tenant', 'facility', 'asn', 'physical_address', 'shipping_address',
- 'contact_name', 'contact_phone', 'contact_email', 'comments',
- ]
- help_texts = {
- 'name': 'Site name',
- 'slug': 'URL-friendly slug',
- 'asn': '32-bit autonomous system number',
- }
- class SiteBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
- pk = forms.ModelMultipleChoiceField(queryset=Site.objects.all(), widget=forms.MultipleHiddenInput)
- region = TreeNodeChoiceField(queryset=Region.objects.all(), required=False)
- tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
- asn = forms.IntegerField(min_value=1, max_value=4294967295, required=False, label='ASN')
- class Meta:
- nullable_fields = ['region', 'tenant', 'asn']
- class SiteFilterForm(BootstrapMixin, CustomFieldFilterForm):
- model = Site
- q = forms.CharField(required=False, label='Search')
- region = FilterTreeNodeMultipleChoiceField(
- queryset=Region.objects.annotate(filter_count=Count('sites')),
- to_field_name='slug',
- required=False,
- )
- tenant = FilterChoiceField(
- queryset=Tenant.objects.annotate(filter_count=Count('sites')),
- to_field_name='slug',
- null_option=(0, 'None')
- )
- #
- # Rack groups
- #
- class RackGroupForm(BootstrapMixin, forms.ModelForm):
- slug = SlugField()
- class Meta:
- model = RackGroup
- fields = ['site', 'name', 'slug']
- class RackGroupFilterForm(BootstrapMixin, forms.Form):
- site = FilterChoiceField(queryset=Site.objects.annotate(filter_count=Count('rack_groups')), to_field_name='slug')
- #
- # Rack roles
- #
- class RackRoleForm(BootstrapMixin, forms.ModelForm):
- slug = SlugField()
- class Meta:
- model = RackRole
- fields = ['name', 'slug', 'color']
- #
- # Racks
- #
- class RackForm(BootstrapMixin, TenancyForm, CustomFieldForm):
- group = ChainedModelChoiceField(
- queryset=RackGroup.objects.all(),
- chains=(
- ('site', 'site'),
- ),
- required=False,
- widget=APISelect(
- api_url='/api/dcim/rack-groups/?site_id={{site}}',
- )
- )
- comments = CommentField()
- class Meta:
- model = Rack
- fields = [
- 'site', 'group', 'name', 'facility_id', 'tenant_group', 'tenant', 'role', 'type', 'width', 'u_height',
- 'desc_units', 'comments',
- ]
- help_texts = {
- 'site': "The site at which the rack exists",
- 'name': "Organizational rack name",
- 'facility_id': "The unique rack ID assigned by the facility",
- 'u_height': "Height in rack units",
- }
- widgets = {
- 'site': forms.Select(attrs={'filter-for': 'group'}),
- }
- class RackCSVForm(forms.ModelForm):
- site = forms.ModelChoiceField(
- queryset=Site.objects.all(),
- to_field_name='name',
- help_text='Name of parent site',
- error_messages={
- 'invalid_choice': 'Site not found.',
- }
- )
- group_name = forms.CharField(
- help_text='Name of rack group',
- required=False
- )
- tenant = forms.ModelChoiceField(
- queryset=Tenant.objects.all(),
- required=False,
- to_field_name='name',
- help_text='Name of assigned tenant',
- error_messages={
- 'invalid_choice': 'Tenant not found.',
- }
- )
- role = forms.ModelChoiceField(
- queryset=RackRole.objects.all(),
- required=False,
- to_field_name='name',
- help_text='Name of assigned role',
- error_messages={
- 'invalid_choice': 'Role not found.',
- }
- )
- type = CSVChoiceField(
- choices=RACK_TYPE_CHOICES,
- required=False,
- help_text='Rack type'
- )
- width = forms.ChoiceField(
- choices=(
- (RACK_WIDTH_19IN, '19'),
- (RACK_WIDTH_23IN, '23'),
- ),
- help_text='Rail-to-rail width (in inches)'
- )
- class Meta:
- model = Rack
- fields = [
- 'site', 'group_name', 'name', 'facility_id', 'tenant', 'role', 'type', 'width', 'u_height', 'desc_units',
- ]
- help_texts = {
- 'name': 'Rack name',
- 'u_height': 'Height in rack units',
- }
- def clean(self):
- super(RackCSVForm, self).clean()
- site = self.cleaned_data.get('site')
- group_name = self.cleaned_data.get('group_name')
- # Validate rack group
- if group_name:
- try:
- self.instance.group = RackGroup.objects.get(site=site, name=group_name)
- except RackGroup.DoesNotExist:
- raise forms.ValidationError("Rack group {} not found for site {}".format(group_name, site))
- class RackBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
- pk = forms.ModelMultipleChoiceField(queryset=Rack.objects.all(), widget=forms.MultipleHiddenInput)
- site = forms.ModelChoiceField(queryset=Site.objects.all(), required=False, label='Site')
- group = forms.ModelChoiceField(queryset=RackGroup.objects.all(), required=False, label='Group')
- tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
- role = forms.ModelChoiceField(queryset=RackRole.objects.all(), required=False)
- type = forms.ChoiceField(choices=add_blank_choice(RACK_TYPE_CHOICES), required=False, label='Type')
- width = forms.ChoiceField(choices=add_blank_choice(RACK_WIDTH_CHOICES), required=False, label='Width')
- u_height = forms.IntegerField(required=False, label='Height (U)')
- desc_units = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Descending units')
- comments = CommentField(widget=SmallTextarea)
- class Meta:
- nullable_fields = ['group', 'tenant', 'role', 'comments']
- class RackFilterForm(BootstrapMixin, CustomFieldFilterForm):
- model = Rack
- q = forms.CharField(required=False, label='Search')
- site = FilterChoiceField(
- queryset=Site.objects.annotate(filter_count=Count('racks')),
- to_field_name='slug'
- )
- group_id = FilterChoiceField(
- queryset=RackGroup.objects.select_related('site').annotate(filter_count=Count('racks')),
- label='Rack group',
- null_option=(0, 'None')
- )
- tenant = FilterChoiceField(
- queryset=Tenant.objects.annotate(filter_count=Count('racks')),
- to_field_name='slug',
- null_option=(0, 'None')
- )
- role = FilterChoiceField(
- queryset=RackRole.objects.annotate(filter_count=Count('racks')),
- to_field_name='slug',
- null_option=(0, 'None')
- )
- #
- # Rack reservations
- #
- class RackReservationForm(BootstrapMixin, forms.ModelForm):
- units = SimpleArrayField(forms.IntegerField(), widget=ArrayFieldSelectMultiple(attrs={'size': 10}))
- class Meta:
- model = RackReservation
- fields = ['units', 'description']
- def __init__(self, *args, **kwargs):
- super(RackReservationForm, self).__init__(*args, **kwargs)
- # Populate rack unit choices
- self.fields['units'].widget.choices = self._get_unit_choices()
- def _get_unit_choices(self):
- rack = self.instance.rack
- reserved_units = []
- for resv in rack.reservations.exclude(pk=self.instance.pk):
- for u in resv.units:
- reserved_units.append(u)
- unit_choices = [(u, {'label': str(u), 'disabled': u in reserved_units}) for u in rack.units]
- return unit_choices
- class RackReservationFilterForm(BootstrapMixin, forms.Form):
- q = forms.CharField(required=False, label='Search')
- site = FilterChoiceField(
- queryset=Site.objects.annotate(filter_count=Count('racks__reservations')),
- to_field_name='slug'
- )
- group_id = FilterChoiceField(
- queryset=RackGroup.objects.select_related('site').annotate(filter_count=Count('racks__reservations')),
- label='Rack group',
- null_option=(0, 'None')
- )
- #
- # Manufacturers
- #
- class ManufacturerForm(BootstrapMixin, forms.ModelForm):
- slug = SlugField()
- class Meta:
- model = Manufacturer
- fields = ['name', 'slug']
- #
- # Device types
- #
- class DeviceTypeForm(BootstrapMixin, CustomFieldForm):
- slug = SlugField(slug_source='model')
- class Meta:
- model = DeviceType
- fields = ['manufacturer', 'model', 'slug', 'part_number', 'u_height', 'is_full_depth', 'is_console_server',
- 'is_pdu', 'is_network_device', 'subdevice_role', 'interface_ordering', 'comments']
- labels = {
- 'interface_ordering': 'Order interfaces by',
- }
- class DeviceTypeBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
- pk = forms.ModelMultipleChoiceField(queryset=DeviceType.objects.all(), widget=forms.MultipleHiddenInput)
- manufacturer = forms.ModelChoiceField(queryset=Manufacturer.objects.all(), required=False)
- u_height = forms.IntegerField(min_value=1, required=False)
- is_full_depth = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Is full depth')
- interface_ordering = forms.ChoiceField(choices=add_blank_choice(IFACE_ORDERING_CHOICES), required=False)
- is_console_server = forms.NullBooleanField(
- required=False, widget=BulkEditNullBooleanSelect, label='Is a console server'
- )
- is_pdu = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Is a PDU')
- is_network_device = forms.NullBooleanField(
- required=False, widget=BulkEditNullBooleanSelect, label='Is a network device'
- )
- class Meta:
- nullable_fields = []
- class DeviceTypeFilterForm(BootstrapMixin, CustomFieldFilterForm):
- model = DeviceType
- q = forms.CharField(required=False, label='Search')
- manufacturer = FilterChoiceField(
- queryset=Manufacturer.objects.annotate(filter_count=Count('device_types')),
- to_field_name='slug'
- )
- is_console_server = forms.BooleanField(
- required=False, label='Is a console server', widget=forms.CheckboxInput(attrs={'value': 'True'}))
- is_pdu = forms.BooleanField(
- required=False, label='Is a PDU', widget=forms.CheckboxInput(attrs={'value': 'True'})
- )
- is_network_device = forms.BooleanField(
- required=False, label='Is a network device', widget=forms.CheckboxInput(attrs={'value': 'True'})
- )
- subdevice_role = forms.NullBooleanField(
- required=False, label='Subdevice role', widget=forms.Select(choices=(
- ('', '---------'),
- (SUBDEVICE_ROLE_PARENT, 'Parent'),
- (SUBDEVICE_ROLE_CHILD, 'Child'),
- ))
- )
- #
- # Device component templates
- #
- class ConsolePortTemplateForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = ConsolePortTemplate
- fields = ['device_type', 'name']
- widgets = {
- 'device_type': forms.HiddenInput(),
- }
- class ConsolePortTemplateCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- class ConsoleServerPortTemplateForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = ConsoleServerPortTemplate
- fields = ['device_type', 'name']
- widgets = {
- 'device_type': forms.HiddenInput(),
- }
- class ConsoleServerPortTemplateCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- class PowerPortTemplateForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = PowerPortTemplate
- fields = ['device_type', 'name']
- widgets = {
- 'device_type': forms.HiddenInput(),
- }
- class PowerPortTemplateCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- class PowerOutletTemplateForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = PowerOutletTemplate
- fields = ['device_type', 'name']
- widgets = {
- 'device_type': forms.HiddenInput(),
- }
- class PowerOutletTemplateCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- class InterfaceTemplateForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = InterfaceTemplate
- fields = ['device_type', 'name', 'form_factor', 'mgmt_only']
- widgets = {
- 'device_type': forms.HiddenInput(),
- }
- class InterfaceTemplateCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- form_factor = forms.ChoiceField(choices=IFACE_FF_CHOICES)
- mgmt_only = forms.BooleanField(required=False, label='OOB Management')
- class InterfaceTemplateBulkEditForm(BootstrapMixin, BulkEditForm):
- pk = forms.ModelMultipleChoiceField(queryset=InterfaceTemplate.objects.all(), widget=forms.MultipleHiddenInput)
- form_factor = forms.ChoiceField(choices=add_blank_choice(IFACE_FF_CHOICES), required=False)
- mgmt_only = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Management only')
- class Meta:
- nullable_fields = []
- class DeviceBayTemplateForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = DeviceBayTemplate
- fields = ['device_type', 'name']
- widgets = {
- 'device_type': forms.HiddenInput(),
- }
- class DeviceBayTemplateCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- #
- # Device roles
- #
- class DeviceRoleForm(BootstrapMixin, forms.ModelForm):
- slug = SlugField()
- class Meta:
- model = DeviceRole
- fields = ['name', 'slug', 'color']
- #
- # Platforms
- #
- class PlatformForm(BootstrapMixin, forms.ModelForm):
- slug = SlugField()
- class Meta:
- model = Platform
- fields = ['name', 'slug', 'rpc_client']
- #
- # Devices
- #
- class DeviceForm(BootstrapMixin, TenancyForm, CustomFieldForm):
- site = forms.ModelChoiceField(
- queryset=Site.objects.all(),
- widget=forms.Select(
- attrs={'filter-for': 'rack'}
- )
- )
- rack = ChainedModelChoiceField(
- queryset=Rack.objects.all(),
- chains=(
- ('site', 'site'),
- ),
- required=False,
- widget=APISelect(
- api_url='/api/dcim/racks/?site_id={{site}}',
- display_field='display_name',
- attrs={'filter-for': 'position'}
- )
- )
- position = forms.TypedChoiceField(
- required=False,
- empty_value=None,
- help_text="The lowest-numbered unit occupied by the device",
- widget=APISelect(
- api_url='/api/dcim/racks/{{rack}}/units/?face={{face}}',
- disabled_indicator='device'
- )
- )
- manufacturer = forms.ModelChoiceField(
- queryset=Manufacturer.objects.all(),
- widget=forms.Select(
- attrs={'filter-for': 'device_type'}
- )
- )
- device_type = ChainedModelChoiceField(
- queryset=DeviceType.objects.all(),
- chains=(
- ('manufacturer', 'manufacturer'),
- ),
- label='Device type',
- widget=APISelect(
- api_url='/api/dcim/device-types/?manufacturer_id={{manufacturer}}',
- display_field='model'
- )
- )
- comments = CommentField()
- class Meta:
- model = Device
- fields = [
- 'name', 'device_role', 'device_type', 'serial', 'asset_tag', 'site', 'rack', 'position', 'face', 'status',
- 'platform', 'primary_ip4', 'primary_ip6', 'tenant_group', 'tenant', 'comments',
- ]
- help_texts = {
- 'device_role': "The function this device serves",
- 'serial': "Chassis serial number",
- }
- widgets = {
- 'face': forms.Select(attrs={'filter-for': 'position'}),
- }
- def __init__(self, *args, **kwargs):
- # Initialize helper selectors
- instance = kwargs.get('instance')
- # Using hasattr() instead of "is not None" to avoid RelatedObjectDoesNotExist on required field
- if instance and hasattr(instance, 'device_type'):
- initial = kwargs.get('initial', {}).copy()
- initial['manufacturer'] = instance.device_type.manufacturer
- kwargs['initial'] = initial
- super(DeviceForm, self).__init__(*args, **kwargs)
- if self.instance.pk:
- # Compile list of choices for primary IPv4 and IPv6 addresses
- for family in [4, 6]:
- ip_choices = []
- interface_ips = IPAddress.objects.filter(family=family, interface__device=self.instance)
- ip_choices += [(ip.id, '{} ({})'.format(ip.address, ip.interface)) for ip in interface_ips]
- nat_ips = IPAddress.objects.filter(family=family, nat_inside__interface__device=self.instance)\
- .select_related('nat_inside__interface')
- ip_choices += [(ip.id, '{} ({} NAT)'.format(ip.address, ip.nat_inside.interface)) for ip in nat_ips]
- self.fields['primary_ip{}'.format(family)].choices = [(None, '---------')] + ip_choices
- # If editing an existing device, exclude it from the list of occupied rack units. This ensures that a device
- # can be flipped from one face to another.
- self.fields['position'].widget.attrs['api-url'] += '&exclude={}'.format(self.instance.pk)
- else:
- # An object that doesn't exist yet can't have any IPs assigned to it
- self.fields['primary_ip4'].choices = []
- self.fields['primary_ip4'].widget.attrs['readonly'] = True
- self.fields['primary_ip6'].choices = []
- self.fields['primary_ip6'].widget.attrs['readonly'] = True
- # Rack position
- pk = self.instance.pk if self.instance.pk else None
- try:
- if self.is_bound and self.data.get('rack') and str(self.data.get('face')):
- position_choices = Rack.objects.get(pk=self.data['rack'])\
- .get_rack_units(face=self.data.get('face'), exclude=pk)
- elif self.initial.get('rack') and str(self.initial.get('face')):
- position_choices = Rack.objects.get(pk=self.initial['rack'])\
- .get_rack_units(face=self.initial.get('face'), exclude=pk)
- else:
- position_choices = []
- except Rack.DoesNotExist:
- position_choices = []
- self.fields['position'].choices = [('', '---------')] + [
- (p['id'], {
- 'label': p['name'],
- 'disabled': bool(p['device'] and p['id'] != self.initial.get('position')),
- }) for p in position_choices
- ]
- # Disable rack assignment if this is a child device installed in a parent device
- if pk and self.instance.device_type.is_child_device and hasattr(self.instance, 'parent_bay'):
- self.fields['site'].disabled = True
- self.fields['rack'].disabled = True
- self.initial['site'] = self.instance.parent_bay.device.site_id
- self.initial['rack'] = self.instance.parent_bay.device.rack_id
- class BaseDeviceCSVForm(forms.ModelForm):
- device_role = forms.ModelChoiceField(
- queryset=DeviceRole.objects.all(),
- to_field_name='name',
- help_text='Name of assigned role',
- error_messages={
- 'invalid_choice': 'Invalid device role.',
- }
- )
- tenant = forms.ModelChoiceField(
- queryset=Tenant.objects.all(),
- required=False,
- to_field_name='name',
- help_text='Name of assigned tenant',
- error_messages={
- 'invalid_choice': 'Tenant not found.',
- }
- )
- manufacturer = forms.ModelChoiceField(
- queryset=Manufacturer.objects.all(),
- to_field_name='name',
- help_text='Device type manufacturer',
- error_messages={
- 'invalid_choice': 'Invalid manufacturer.',
- }
- )
- model_name = forms.CharField(
- help_text='Device type model name'
- )
- platform = forms.ModelChoiceField(
- queryset=Platform.objects.all(),
- required=False,
- to_field_name='name',
- help_text='Name of assigned platform',
- error_messages={
- 'invalid_choice': 'Invalid platform.',
- }
- )
- status = CSVChoiceField(
- choices=STATUS_CHOICES,
- help_text='Operational status of device'
- )
- class Meta:
- fields = []
- model = Device
- help_texts = {
- 'name': 'Device name',
- }
- def clean(self):
- super(BaseDeviceCSVForm, self).clean()
- manufacturer = self.cleaned_data.get('manufacturer')
- model_name = self.cleaned_data.get('model_name')
- # Validate device type
- if manufacturer and model_name:
- try:
- self.instance.device_type = DeviceType.objects.get(manufacturer=manufacturer, model=model_name)
- except DeviceType.DoesNotExist:
- raise forms.ValidationError("Device type {} {} not found".format(manufacturer, model_name))
- class DeviceCSVForm(BaseDeviceCSVForm):
- site = forms.ModelChoiceField(
- queryset=Site.objects.all(),
- to_field_name='name',
- help_text='Name of parent site',
- error_messages={
- 'invalid_choice': 'Invalid site name.',
- }
- )
- rack_group = forms.CharField(
- required=False,
- help_text='Parent rack\'s group (if any)'
- )
- rack_name = forms.CharField(
- required=False,
- help_text='Name of parent rack'
- )
- face = CSVChoiceField(
- choices=RACK_FACE_CHOICES,
- required=False,
- help_text='Mounted rack face'
- )
- class Meta(BaseDeviceCSVForm.Meta):
- fields = [
- 'name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag', 'status',
- 'site', 'rack_group', 'rack_name', 'position', 'face',
- ]
- def clean(self):
- super(DeviceCSVForm, self).clean()
- site = self.cleaned_data.get('site')
- rack_group = self.cleaned_data.get('rack_group')
- rack_name = self.cleaned_data.get('rack_name')
- # Validate rack
- if site and rack_group and rack_name:
- try:
- self.instance.rack = Rack.objects.get(site=site, group__name=rack_group, name=rack_name)
- except Rack.DoesNotExist:
- raise forms.ValidationError("Rack {} not found in site {} group {}".format(rack_name, site, rack_group))
- elif site and rack_name:
- try:
- self.instance.rack = Rack.objects.get(site=site, group__isnull=True, name=rack_name)
- except Rack.DoesNotExist:
- raise forms.ValidationError("Rack {} not found in site {} (no group)".format(rack_name, site))
- class ChildDeviceCSVForm(BaseDeviceCSVForm):
- parent = FlexibleModelChoiceField(
- queryset=Device.objects.all(),
- to_field_name='name',
- help_text='Name or ID of parent device',
- error_messages={
- 'invalid_choice': 'Parent device not found.',
- }
- )
- device_bay_name = forms.CharField(
- help_text='Name of device bay',
- )
- class Meta(BaseDeviceCSVForm.Meta):
- fields = [
- 'name', 'device_role', 'tenant', 'manufacturer', 'model_name', 'platform', 'serial', 'asset_tag', 'status',
- 'parent', 'device_bay_name',
- ]
- def clean(self):
- super(ChildDeviceCSVForm, self).clean()
- parent = self.cleaned_data.get('parent')
- device_bay_name = self.cleaned_data.get('device_bay_name')
- # Validate device bay
- if parent and device_bay_name:
- try:
- self.instance.parent_bay = DeviceBay.objects.get(device=parent, name=device_bay_name)
- # Inherit site and rack from parent device
- self.instance.site = parent.site
- self.instance.rack = parent.rack
- except DeviceBay.DoesNotExist:
- raise forms.ValidationError("Parent device/bay ({} {}) not found".format(parent, device_bay_name))
- class DeviceBulkEditForm(BootstrapMixin, CustomFieldBulkEditForm):
- pk = forms.ModelMultipleChoiceField(queryset=Device.objects.all(), widget=forms.MultipleHiddenInput)
- device_type = forms.ModelChoiceField(queryset=DeviceType.objects.all(), required=False, label='Type')
- device_role = forms.ModelChoiceField(queryset=DeviceRole.objects.all(), required=False, label='Role')
- tenant = forms.ModelChoiceField(queryset=Tenant.objects.all(), required=False)
- platform = forms.ModelChoiceField(queryset=Platform.objects.all(), required=False)
- status = forms.ChoiceField(choices=FORM_STATUS_CHOICES, required=False, initial='', label='Status')
- serial = forms.CharField(max_length=50, required=False, label='Serial Number')
- class Meta:
- nullable_fields = ['tenant', 'platform']
- def device_status_choices():
- status_counts = {}
- for status in Device.objects.values('status').annotate(count=Count('status')).order_by('status'):
- status_counts[status['status']] = status['count']
- return [(s[0], '{} ({})'.format(s[1], status_counts.get(s[0], 0))) for s in STATUS_CHOICES]
- class DeviceFilterForm(BootstrapMixin, CustomFieldFilterForm):
- model = Device
- q = forms.CharField(required=False, label='Search')
- site = FilterChoiceField(
- queryset=Site.objects.annotate(filter_count=Count('devices')),
- to_field_name='slug',
- )
- rack_group_id = FilterChoiceField(
- queryset=RackGroup.objects.select_related('site').annotate(filter_count=Count('racks__devices')),
- label='Rack group',
- )
- rack_id = FilterChoiceField(
- queryset=Rack.objects.annotate(filter_count=Count('devices')),
- label='Rack',
- null_option=(0, 'None'),
- )
- role = FilterChoiceField(
- queryset=DeviceRole.objects.annotate(filter_count=Count('devices')),
- to_field_name='slug',
- )
- tenant = FilterChoiceField(
- queryset=Tenant.objects.annotate(filter_count=Count('devices')),
- to_field_name='slug',
- null_option=(0, 'None'),
- )
- manufacturer_id = FilterChoiceField(queryset=Manufacturer.objects.all(), label='Manufacturer')
- device_type_id = FilterChoiceField(
- queryset=DeviceType.objects.select_related('manufacturer').order_by('model').annotate(
- filter_count=Count('instances'),
- ),
- label='Model',
- )
- platform = FilterChoiceField(
- queryset=Platform.objects.annotate(filter_count=Count('devices')),
- to_field_name='slug',
- null_option=(0, 'None'),
- )
- status = forms.MultipleChoiceField(choices=device_status_choices, required=False)
- mac_address = forms.CharField(required=False, label='MAC address')
- #
- # Bulk device component creation
- #
- class DeviceBulkAddComponentForm(BootstrapMixin, forms.Form):
- pk = forms.ModelMultipleChoiceField(queryset=Device.objects.all(), widget=forms.MultipleHiddenInput)
- name_pattern = ExpandableNameField(label='Name')
- class DeviceBulkAddInterfaceForm(forms.ModelForm, DeviceBulkAddComponentForm):
- class Meta:
- model = Interface
- fields = ['pk', 'name_pattern', 'form_factor', 'mgmt_only', 'description']
- #
- # Console ports
- #
- class ConsolePortForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = ConsolePort
- fields = ['device', 'name']
- widgets = {
- 'device': forms.HiddenInput(),
- }
- class ConsolePortCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- class ConsoleConnectionCSVForm(forms.ModelForm):
- console_server = FlexibleModelChoiceField(
- queryset=Device.objects.filter(device_type__is_console_server=True),
- to_field_name='name',
- help_text='Console server name or ID',
- error_messages={
- 'invalid_choice': 'Console server not found',
- }
- )
- cs_port = forms.CharField(
- help_text='Console server port name'
- )
- device = FlexibleModelChoiceField(
- queryset=Device.objects.all(),
- to_field_name='name',
- help_text='Device name or ID',
- error_messages={
- 'invalid_choice': 'Device not found',
- }
- )
- console_port = forms.CharField(
- help_text='Console port name'
- )
- connection_status = CSVChoiceField(
- choices=CONNECTION_STATUS_CHOICES,
- help_text='Connection status'
- )
- class Meta:
- model = ConsolePort
- fields = ['console_server', 'cs_port', 'device', 'console_port', 'connection_status']
- def clean_console_port(self):
- console_port_name = self.cleaned_data.get('console_port')
- if not self.cleaned_data.get('device') or not console_port_name:
- return None
- try:
- # Retrieve console port by name
- consoleport = ConsolePort.objects.get(
- device=self.cleaned_data['device'], name=console_port_name
- )
- # Check if the console port is already connected
- if consoleport.cs_port is not None:
- raise forms.ValidationError("{} {} is already connected".format(
- self.cleaned_data['device'], console_port_name
- ))
- except ConsolePort.DoesNotExist:
- raise forms.ValidationError("Invalid console port ({} {})".format(
- self.cleaned_data['device'], console_port_name
- ))
- self.instance = consoleport
- return consoleport
- def clean_cs_port(self):
- cs_port_name = self.cleaned_data.get('cs_port')
- if not self.cleaned_data.get('console_server') or not cs_port_name:
- return None
- try:
- # Retrieve console server port by name
- cs_port = ConsoleServerPort.objects.get(
- device=self.cleaned_data['console_server'], name=cs_port_name
- )
- # Check if the console server port is already connected
- if ConsolePort.objects.filter(cs_port=cs_port).count():
- raise forms.ValidationError("{} {} is already connected".format(
- self.cleaned_data['console_server'], cs_port_name
- ))
- except ConsoleServerPort.DoesNotExist:
- raise forms.ValidationError("Invalid console server port ({} {})".format(
- self.cleaned_data['console_server'], cs_port_name
- ))
- return cs_port
- class ConsolePortConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.ModelForm):
- site = forms.ModelChoiceField(
- queryset=Site.objects.all(),
- required=False,
- widget=forms.Select(
- attrs={'filter-for': 'rack'}
- )
- )
- rack = ChainedModelChoiceField(
- queryset=Rack.objects.all(),
- chains=(
- ('site', 'site'),
- ),
- label='Rack',
- required=False,
- widget=APISelect(
- api_url='/api/dcim/racks/?site_id={{site}}',
- attrs={'filter-for': 'console_server', 'nullable': 'true'}
- )
- )
- console_server = ChainedModelChoiceField(
- queryset=Device.objects.filter(device_type__is_console_server=True),
- chains=(
- ('site', 'site'),
- ('rack', 'rack'),
- ),
- label='Console Server',
- required=False,
- widget=APISelect(
- api_url='/api/dcim/devices/?site_id={{site}}&rack_id={{rack}}&is_console_server=True',
- display_field='display_name',
- attrs={'filter-for': 'cs_port'}
- )
- )
- livesearch = forms.CharField(
- required=False,
- label='Console Server',
- widget=Livesearch(
- query_key='q',
- query_url='dcim-api:device-list',
- field_to_update='console_server',
- )
- )
- cs_port = ChainedModelChoiceField(
- queryset=ConsoleServerPort.objects.all(),
- chains=(
- ('device', 'console_server'),
- ),
- label='Port',
- widget=APISelect(
- api_url='/api/dcim/console-server-ports/?device_id={{console_server}}',
- disabled_indicator='connected_console',
- )
- )
- class Meta:
- model = ConsolePort
- fields = ['site', 'rack', 'console_server', 'livesearch', 'cs_port', 'connection_status']
- labels = {
- 'cs_port': 'Port',
- 'connection_status': 'Status',
- }
- def __init__(self, *args, **kwargs):
- super(ConsolePortConnectionForm, self).__init__(*args, **kwargs)
- if not self.instance.pk:
- raise RuntimeError("ConsolePortConnectionForm must be initialized with an existing ConsolePort instance.")
- #
- # Console server ports
- #
- class ConsoleServerPortForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = ConsoleServerPort
- fields = ['device', 'name']
- widgets = {
- 'device': forms.HiddenInput(),
- }
- class ConsoleServerPortCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- class ConsoleServerPortConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.Form):
- site = forms.ModelChoiceField(
- queryset=Site.objects.all(),
- required=False,
- widget=forms.Select(
- attrs={'filter-for': 'rack'}
- )
- )
- rack = ChainedModelChoiceField(
- queryset=Rack.objects.all(),
- chains=(
- ('site', 'site'),
- ),
- label='Rack',
- required=False,
- widget=APISelect(
- api_url='/api/dcim/racks/?site_id={{site}}',
- attrs={'filter-for': 'device', 'nullable': 'true'}
- )
- )
- device = ChainedModelChoiceField(
- queryset=Device.objects.all(),
- chains=(
- ('site', 'site'),
- ('rack', 'rack'),
- ),
- label='Device',
- required=False,
- widget=APISelect(
- api_url='/api/dcim/devices/?site_id={{site}}&rack_id={{rack}}',
- display_field='display_name',
- attrs={'filter-for': 'port'}
- )
- )
- livesearch = forms.CharField(
- required=False,
- label='Device',
- widget=Livesearch(
- query_key='q',
- query_url='dcim-api:device-list',
- field_to_update='device'
- )
- )
- port = ChainedModelChoiceField(
- queryset=ConsolePort.objects.all(),
- chains=(
- ('device', 'device'),
- ),
- label='Port',
- widget=APISelect(
- api_url='/api/dcim/console-ports/?device_id={{device}}',
- disabled_indicator='cs_port'
- )
- )
- connection_status = forms.BooleanField(
- required=False,
- initial=CONNECTION_STATUS_CONNECTED,
- label='Status',
- widget=forms.Select(
- choices=CONNECTION_STATUS_CHOICES
- )
- )
- class Meta:
- fields = ['site', 'rack', 'device', 'livesearch', 'port', 'connection_status']
- labels = {
- 'connection_status': 'Status',
- }
- class ConsoleServerPortBulkDisconnectForm(ConfirmationForm):
- pk = forms.ModelMultipleChoiceField(queryset=ConsoleServerPort.objects.all(), widget=forms.MultipleHiddenInput)
- #
- # Power ports
- #
- class PowerPortForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = PowerPort
- fields = ['device', 'name']
- widgets = {
- 'device': forms.HiddenInput(),
- }
- class PowerPortCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- class PowerConnectionCSVForm(forms.ModelForm):
- pdu = FlexibleModelChoiceField(
- queryset=Device.objects.filter(device_type__is_pdu=True),
- to_field_name='name',
- help_text='PDU name or ID',
- error_messages={
- 'invalid_choice': 'PDU not found.',
- }
- )
- power_outlet = forms.CharField(
- help_text='Power outlet name'
- )
- device = FlexibleModelChoiceField(
- queryset=Device.objects.all(),
- to_field_name='name',
- help_text='Device name or ID',
- error_messages={
- 'invalid_choice': 'Device not found',
- }
- )
- power_port = forms.CharField(
- help_text='Power port name'
- )
- connection_status = CSVChoiceField(
- choices=CONNECTION_STATUS_CHOICES,
- help_text='Connection status'
- )
- class Meta:
- model = PowerPort
- fields = ['pdu', 'power_outlet', 'device', 'power_port', 'connection_status']
- def clean_power_port(self):
- power_port_name = self.cleaned_data.get('power_port')
- if not self.cleaned_data.get('device') or not power_port_name:
- return None
- try:
- # Retrieve power port by name
- powerport = PowerPort.objects.get(
- device=self.cleaned_data['device'], name=power_port_name
- )
- # Check if the power port is already connected
- if powerport.power_outlet is not None:
- raise forms.ValidationError("{} {} is already connected".format(
- self.cleaned_data['device'], power_port_name
- ))
- except PowerPort.DoesNotExist:
- raise forms.ValidationError("Invalid power port ({} {})".format(
- self.cleaned_data['device'], power_port_name
- ))
- self.instance = powerport
- return powerport
- def clean_power_outlet(self):
- power_outlet_name = self.cleaned_data.get('power_outlet')
- if not self.cleaned_data.get('pdu') or not power_outlet_name:
- return None
- try:
- # Retrieve power outlet by name
- power_outlet = PowerOutlet.objects.get(
- device=self.cleaned_data['pdu'], name=power_outlet_name
- )
- # Check if the power outlet is already connected
- if PowerPort.objects.filter(power_outlet=power_outlet).count():
- raise forms.ValidationError("{} {} is already connected".format(
- self.cleaned_data['pdu'], power_outlet_name
- ))
- except PowerOutlet.DoesNotExist:
- raise forms.ValidationError("Invalid power outlet ({} {})".format(
- self.cleaned_data['pdu'], power_outlet_name
- ))
- return power_outlet
- class PowerPortConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.ModelForm):
- site = forms.ModelChoiceField(
- queryset=Site.objects.all(),
- required=False,
- widget=forms.Select(
- attrs={'filter-for': 'rack'}
- )
- )
- rack = ChainedModelChoiceField(
- queryset=Rack.objects.all(),
- chains=(
- ('site', 'site'),
- ),
- label='Rack',
- required=False,
- widget=APISelect(
- api_url='/api/dcim/racks/?site_id={{site}}',
- attrs={'filter-for': 'pdu', 'nullable': 'true'}
- )
- )
- pdu = ChainedModelChoiceField(
- queryset=Device.objects.all(),
- chains=(
- ('site', 'site'),
- ('rack', 'rack'),
- ),
- label='PDU',
- required=False,
- widget=APISelect(
- api_url='/api/dcim/devices/?site_id={{site}}&rack_id={{rack}}&is_pdu=True',
- display_field='display_name',
- attrs={'filter-for': 'power_outlet'}
- )
- )
- livesearch = forms.CharField(
- required=False,
- label='PDU',
- widget=Livesearch(
- query_key='q',
- query_url='dcim-api:device-list',
- field_to_update='pdu'
- )
- )
- power_outlet = ChainedModelChoiceField(
- queryset=PowerOutlet.objects.all(),
- chains=(
- ('device', 'pdu'),
- ),
- label='Outlet',
- widget=APISelect(
- api_url='/api/dcim/power-outlets/?device_id={{pdu}}',
- disabled_indicator='connected_port'
- )
- )
- class Meta:
- model = PowerPort
- fields = ['site', 'rack', 'pdu', 'livesearch', 'power_outlet', 'connection_status']
- labels = {
- 'power_outlet': 'Outlet',
- 'connection_status': 'Status',
- }
- def __init__(self, *args, **kwargs):
- super(PowerPortConnectionForm, self).__init__(*args, **kwargs)
- if not self.instance.pk:
- raise RuntimeError("PowerPortConnectionForm must be initialized with an existing PowerPort instance.")
- #
- # Power outlets
- #
- class PowerOutletForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = PowerOutlet
- fields = ['device', 'name']
- widgets = {
- 'device': forms.HiddenInput(),
- }
- class PowerOutletCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- class PowerOutletConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.Form):
- site = forms.ModelChoiceField(
- queryset=Site.objects.all(),
- required=False,
- widget=forms.Select(
- attrs={'filter-for': 'rack'}
- )
- )
- rack = ChainedModelChoiceField(
- queryset=Rack.objects.all(),
- chains=(
- ('site', 'site'),
- ),
- label='Rack',
- required=False,
- widget=APISelect(
- api_url='/api/dcim/racks/?site_id={{site}}',
- attrs={'filter-for': 'device', 'nullable': 'true'}
- )
- )
- device = ChainedModelChoiceField(
- queryset=Device.objects.all(),
- chains=(
- ('site', 'site'),
- ('rack', 'rack'),
- ),
- label='Device',
- required=False,
- widget=APISelect(
- api_url='/api/dcim/devices/?site_id={{site}}&rack_id={{rack}}',
- display_field='display_name',
- attrs={'filter-for': 'port'}
- )
- )
- livesearch = forms.CharField(
- required=False,
- label='Device',
- widget=Livesearch(
- query_key='q',
- query_url='dcim-api:device-list',
- field_to_update='device'
- )
- )
- port = ChainedModelChoiceField(
- queryset=PowerPort.objects.all(),
- chains=(
- ('device', 'device'),
- ),
- label='Port',
- widget=APISelect(
- api_url='/api/dcim/power-ports/?device_id={{device}}',
- disabled_indicator='power_outlet'
- )
- )
- connection_status = forms.BooleanField(
- required=False,
- initial=CONNECTION_STATUS_CONNECTED,
- label='Status',
- widget=forms.Select(
- choices=CONNECTION_STATUS_CHOICES
- )
- )
- class Meta:
- fields = ['site', 'rack', 'device', 'livesearch', 'port', 'connection_status']
- labels = {
- 'connection_status': 'Status',
- }
- class PowerOutletBulkDisconnectForm(ConfirmationForm):
- pk = forms.ModelMultipleChoiceField(queryset=PowerOutlet.objects.all(), widget=forms.MultipleHiddenInput)
- #
- # Interfaces
- #
- class InterfaceForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = Interface
- fields = ['device', 'name', 'form_factor', 'enabled', 'lag', 'mac_address', 'mtu', 'mgmt_only', 'description']
- widgets = {
- 'device': forms.HiddenInput(),
- }
- def __init__(self, *args, **kwargs):
- super(InterfaceForm, self).__init__(*args, **kwargs)
- # Limit LAG choices to interfaces belonging to this device
- if self.is_bound:
- self.fields['lag'].queryset = Interface.objects.order_naturally().filter(
- device_id=self.data['device'], form_factor=IFACE_FF_LAG
- )
- else:
- self.fields['lag'].queryset = Interface.objects.order_naturally().filter(
- device=self.instance.device, form_factor=IFACE_FF_LAG
- )
- class InterfaceCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- form_factor = forms.ChoiceField(choices=IFACE_FF_CHOICES)
- enabled = forms.BooleanField(required=False)
- lag = forms.ModelChoiceField(queryset=Interface.objects.all(), required=False, label='Parent LAG')
- mtu = forms.IntegerField(required=False, min_value=1, max_value=32767, label='MTU')
- mac_address = MACAddressFormField(required=False, label='MAC Address')
- mgmt_only = forms.BooleanField(required=False, label='OOB Management')
- description = forms.CharField(max_length=100, required=False)
- def __init__(self, *args, **kwargs):
- # Set interfaces enabled by default
- kwargs['initial'] = kwargs.get('initial', {}).copy()
- kwargs['initial'].update({'enabled': True})
- super(InterfaceCreateForm, self).__init__(*args, **kwargs)
- # Limit LAG choices to interfaces belonging to this device
- if self.device is not None:
- self.fields['lag'].queryset = Interface.objects.order_naturally().filter(
- device=self.device, form_factor=IFACE_FF_LAG
- )
- else:
- self.fields['lag'].queryset = Interface.objects.none()
- class InterfaceBulkEditForm(BootstrapMixin, BulkEditForm):
- pk = forms.ModelMultipleChoiceField(queryset=Interface.objects.all(), widget=forms.MultipleHiddenInput)
- device = forms.ModelChoiceField(queryset=Device.objects.all(), widget=forms.HiddenInput)
- form_factor = forms.ChoiceField(choices=add_blank_choice(IFACE_FF_CHOICES), required=False)
- enabled = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect)
- lag = forms.ModelChoiceField(queryset=Interface.objects.all(), required=False, label='Parent LAG')
- mtu = forms.IntegerField(required=False, min_value=1, max_value=32767, label='MTU')
- mgmt_only = forms.NullBooleanField(required=False, widget=BulkEditNullBooleanSelect, label='Management only')
- description = forms.CharField(max_length=100, required=False)
- class Meta:
- nullable_fields = ['lag', 'mtu', 'description']
- def __init__(self, *args, **kwargs):
- super(InterfaceBulkEditForm, self).__init__(*args, **kwargs)
- # Limit LAG choices to interfaces which belong to the parent device.
- device = None
- if self.initial.get('device'):
- try:
- device = Device.objects.get(pk=self.initial.get('device'))
- except Device.DoesNotExist:
- pass
- if device is not None:
- interface_ordering = device.device_type.interface_ordering
- self.fields['lag'].queryset = Interface.objects.order_naturally(method=interface_ordering).filter(
- device=device, form_factor=IFACE_FF_LAG
- )
- else:
- self.fields['lag'].choices = []
- class InterfaceBulkDisconnectForm(ConfirmationForm):
- pk = forms.ModelMultipleChoiceField(queryset=Interface.objects.all(), widget=forms.MultipleHiddenInput)
- #
- # Interface connections
- #
- class InterfaceConnectionForm(BootstrapMixin, ChainedFieldsMixin, forms.ModelForm):
- interface_a = forms.ChoiceField(
- choices=[],
- widget=SelectWithDisabled,
- label='Interface'
- )
- site_b = forms.ModelChoiceField(
- queryset=Site.objects.all(),
- label='Site',
- required=False,
- widget=forms.Select(
- attrs={'filter-for': 'rack_b'}
- )
- )
- rack_b = ChainedModelChoiceField(
- queryset=Rack.objects.all(),
- chains=(
- ('site', 'site_b'),
- ),
- label='Rack',
- required=False,
- widget=APISelect(
- api_url='/api/dcim/racks/?site_id={{site_b}}',
- attrs={'filter-for': 'device_b', 'nullable': 'true'}
- )
- )
- device_b = ChainedModelChoiceField(
- queryset=Device.objects.all(),
- chains=(
- ('site', 'site_b'),
- ('rack', 'rack_b'),
- ),
- label='Device',
- required=False,
- widget=APISelect(
- api_url='/api/dcim/devices/?site_id={{site_b}}&rack_id={{rack_b}}',
- display_field='display_name',
- attrs={'filter-for': 'interface_b'}
- )
- )
- livesearch = forms.CharField(
- required=False,
- label='Device',
- widget=Livesearch(
- query_key='q',
- query_url='dcim-api:device-list',
- field_to_update='device_b'
- )
- )
- interface_b = ChainedModelChoiceField(
- queryset=Interface.objects.connectable().select_related(
- 'circuit_termination', 'connected_as_a', 'connected_as_b'
- ),
- chains=(
- ('device', 'device_b'),
- ),
- label='Interface',
- widget=APISelect(
- api_url='/api/dcim/interfaces/?device_id={{device_b}}&type=physical',
- disabled_indicator='is_connected'
- )
- )
- class Meta:
- model = InterfaceConnection
- fields = ['interface_a', 'site_b', 'rack_b', 'device_b', 'interface_b', 'livesearch', 'connection_status']
- def __init__(self, device_a, *args, **kwargs):
- super(InterfaceConnectionForm, self).__init__(*args, **kwargs)
- # Initialize interface A choices
- device_a_interfaces = Interface.objects.connectable().order_naturally().filter(device=device_a).select_related(
- 'circuit_termination', 'connected_as_a', 'connected_as_b'
- )
- self.fields['interface_a'].choices = [
- (iface.id, {'label': iface.name, 'disabled': iface.is_connected}) for iface in device_a_interfaces
- ]
- # Mark connected interfaces as disabled
- if self.data.get('device_b'):
- self.fields['interface_b'].choices = [
- (iface.id, {'label': iface.name, 'disabled': iface.is_connected}) for iface in self.fields['interface_b'].queryset
- ]
- class InterfaceConnectionCSVForm(forms.ModelForm):
- device_a = FlexibleModelChoiceField(
- queryset=Device.objects.all(),
- to_field_name='name',
- help_text='Name or ID of device A',
- error_messages={'invalid_choice': 'Device A not found.'}
- )
- interface_a = forms.CharField(
- help_text='Name of interface A'
- )
- device_b = FlexibleModelChoiceField(
- queryset=Device.objects.all(),
- to_field_name='name',
- help_text='Name or ID of device B',
- error_messages={'invalid_choice': 'Device B not found.'}
- )
- interface_b = forms.CharField(
- help_text='Name of interface B'
- )
- connection_status = CSVChoiceField(
- choices=CONNECTION_STATUS_CHOICES,
- help_text='Connection status'
- )
- class Meta:
- model = InterfaceConnection
- fields = ['device_a', 'interface_a', 'device_b', 'interface_b', 'connection_status']
- def clean_interface_a(self):
- interface_name = self.cleaned_data.get('interface_a')
- if not interface_name:
- return None
- try:
- # Retrieve interface by name
- interface = Interface.objects.get(
- device=self.cleaned_data['device_a'], name=interface_name
- )
- # Check for an existing connection to this interface
- if InterfaceConnection.objects.filter(Q(interface_a=interface) | Q(interface_b=interface)).count():
- raise forms.ValidationError("{} {} is already connected".format(
- self.cleaned_data['device_a'], interface_name
- ))
- except Interface.DoesNotExist:
- raise forms.ValidationError("Invalid interface ({} {})".format(
- self.cleaned_data['device_a'], interface_name
- ))
- return interface
- def clean_interface_b(self):
- interface_name = self.cleaned_data.get('interface_b')
- if not interface_name:
- return None
- try:
- # Retrieve interface by name
- interface = Interface.objects.get(
- device=self.cleaned_data['device_b'], name=interface_name
- )
- # Check for an existing connection to this interface
- if InterfaceConnection.objects.filter(Q(interface_a=interface) | Q(interface_b=interface)).count():
- raise forms.ValidationError("{} {} is already connected".format(
- self.cleaned_data['device_b'], interface_name
- ))
- except Interface.DoesNotExist:
- raise forms.ValidationError("Invalid interface ({} {})".format(
- self.cleaned_data['device_b'], interface_name
- ))
- return interface
- class InterfaceConnectionDeletionForm(ConfirmationForm):
- # Used for HTTP redirect upon successful deletion
- device = forms.ModelChoiceField(queryset=Device.objects.all(), widget=forms.HiddenInput(), required=False)
- #
- # Device bays
- #
- class DeviceBayForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = DeviceBay
- fields = ['device', 'name']
- widgets = {
- 'device': forms.HiddenInput(),
- }
- class DeviceBayCreateForm(DeviceComponentForm):
- name_pattern = ExpandableNameField(label='Name')
- class PopulateDeviceBayForm(BootstrapMixin, forms.Form):
- installed_device = forms.ModelChoiceField(
- queryset=Device.objects.all(),
- label='Child Device',
- help_text="Child devices must first be created and assigned to the site/rack of the parent device."
- )
- def __init__(self, device_bay, *args, **kwargs):
- super(PopulateDeviceBayForm, self).__init__(*args, **kwargs)
- self.fields['installed_device'].queryset = Device.objects.filter(
- site=device_bay.device.site,
- rack=device_bay.device.rack,
- parent_bay__isnull=True,
- device_type__u_height=0,
- device_type__subdevice_role=SUBDEVICE_ROLE_CHILD
- ).exclude(pk=device_bay.device.pk)
- #
- # Connections
- #
- class ConsoleConnectionFilterForm(BootstrapMixin, forms.Form):
- site = forms.ModelChoiceField(required=False, queryset=Site.objects.all(), to_field_name='slug')
- device = forms.CharField(required=False, label='Device name')
- class PowerConnectionFilterForm(BootstrapMixin, forms.Form):
- site = forms.ModelChoiceField(required=False, queryset=Site.objects.all(), to_field_name='slug')
- device = forms.CharField(required=False, label='Device name')
- class InterfaceConnectionFilterForm(BootstrapMixin, forms.Form):
- site = forms.ModelChoiceField(required=False, queryset=Site.objects.all(), to_field_name='slug')
- device = forms.CharField(required=False, label='Device name')
- #
- # Inventory items
- #
- class InventoryItemForm(BootstrapMixin, forms.ModelForm):
- class Meta:
- model = InventoryItem
- fields = ['name', 'manufacturer', 'part_id', 'serial', 'asset_tag', 'description']
|