From a3f172fc77c08a5af2f5f683a281d73b8403fb16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Est=C3=A9vez?= Date: Fri, 25 Feb 2022 11:30:13 -0500 Subject: [PATCH 01/38] Conflicting documentation on remote default group In the current documentation we have two seemingly conflicting sentences: * REMOTE_AUTH_DEFAULT_GROUPS: (Requires REMOTE_AUTH_ENABLED.) * REMOTE_AUTH_ENABLED: (REMOTE_AUTH_DEFAULT_GROUPS will not function if REMOTE_AUTH_ENABLED is enabled) --- docs/configuration/remote-authentication.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/remote-authentication.md b/docs/configuration/remote-authentication.md index 73d29415b..2c3a7002f 100644 --- a/docs/configuration/remote-authentication.md +++ b/docs/configuration/remote-authentication.md @@ -43,7 +43,7 @@ A mapping of permissions to assign a new user account when created using remote Default: `False` -NetBox can be configured to support remote user authentication by inferring user authentication from an HTTP header set by the HTTP reverse proxy (e.g. nginx or Apache). Set this to `True` to enable this functionality. (Local authentication will still take effect as a fallback.) (`REMOTE_AUTH_DEFAULT_GROUPS` will not function if `REMOTE_AUTH_ENABLED` is enabled) +NetBox can be configured to support remote user authentication by inferring user authentication from an HTTP header set by the HTTP reverse proxy (e.g. nginx or Apache). Set this to `True` to enable this functionality. (Local authentication will still take effect as a fallback.) (`REMOTE_AUTH_DEFAULT_GROUPS` will not function if `REMOTE_AUTH_ENABLED` is disabled) --- From 36d6ae33d15e93cc552827cdea363a9c00c7f823 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Mon, 4 Apr 2022 18:00:38 +0200 Subject: [PATCH 02/38] Allow setting individual timeouts on scripts and reports --- docs/customization/custom-scripts.md | 4 ++++ netbox/extras/api/views.py | 6 ++++-- netbox/extras/management/commands/runreport.py | 3 ++- netbox/extras/models/models.py | 6 ++++-- netbox/extras/reports.py | 1 + netbox/extras/scripts.py | 6 +++++- netbox/extras/views.py | 7 +++++-- 7 files changed, 25 insertions(+), 8 deletions(-) diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md index 02af19726..982a4f8e3 100644 --- a/docs/customization/custom-scripts.md +++ b/docs/customization/custom-scripts.md @@ -89,6 +89,10 @@ The checkbox to commit database changes when executing a script is checked by de commit_default = False ``` +### `job_timeout` + +Set the allowed runtime of a script. If not set the `RQ_DEFAULT_TIMEOUT` will be used. + ## Accessing Request Data Details of the current HTTP request (the one being made to execute the script) are available as the instance attribute `self.request`. This can be used to infer, for example, the user executing the script and the client IP address: diff --git a/netbox/extras/api/views.py b/netbox/extras/api/views.py index 4f42b4c93..579e39d86 100644 --- a/netbox/extras/api/views.py +++ b/netbox/extras/api/views.py @@ -236,7 +236,8 @@ class ReportViewSet(ViewSet): run_report, report.full_name, report_content_type, - request.user + request.user, + job_timeout=report.job_timeout ) report.result = job_result @@ -320,7 +321,8 @@ class ScriptViewSet(ViewSet): request.user, data=data, request=copy_safe_request(request), - commit=commit + commit=commit, + job_timeout=script.job_timeout, ) script.result = job_result serializer = serializers.ScriptDetailSerializer(script, context={'request': request}) diff --git a/netbox/extras/management/commands/runreport.py b/netbox/extras/management/commands/runreport.py index de7c5c91b..ee166ae6a 100644 --- a/netbox/extras/management/commands/runreport.py +++ b/netbox/extras/management/commands/runreport.py @@ -35,7 +35,8 @@ class Command(BaseCommand): run_report, report.full_name, report_content_type, - None + None, + job_timeout=report.job_timeout ) # Wait on the job to finish diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index ef0ab8b1f..48a076f75 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -13,6 +13,7 @@ from django.urls import reverse from django.utils import timezone from django.utils.formats import date_format from rest_framework.utils.encoders import JSONEncoder +import django_rq from extras.choices import * from extras.constants import * @@ -549,8 +550,9 @@ class JobResult(models.Model): user=user, job_id=uuid.uuid4() ) - - func.delay(*args, job_id=str(job_result.job_id), job_result=job_result, **kwargs) + + queue = django_rq.get_queue("default") + queue.enqueue(func, job_id=str(job_result.job_id), job_result=job_result, **kwargs) return job_result diff --git a/netbox/extras/reports.py b/netbox/extras/reports.py index 2eb6584c9..0bdc4847e 100644 --- a/netbox/extras/reports.py +++ b/netbox/extras/reports.py @@ -119,6 +119,7 @@ class Report(object): } """ description = None + job_timeout = None def __init__(self): diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py index f80dfaefa..4b9d17d67 100644 --- a/netbox/extras/scripts.py +++ b/netbox/extras/scripts.py @@ -298,6 +298,10 @@ class BaseScript: def module(cls): return cls.__module__ + @classproperty + def job_timeout(self): + return getattr(self.Meta, 'job_timeout', None) + @classmethod def _get_vars(cls): vars = {} @@ -414,7 +418,7 @@ def is_variable(obj): return isinstance(obj, ScriptVariable) -@job('default') +#@job('default') def run_script(data, request, commit=True, *args, **kwargs): """ A wrapper for calling Script.run(). This performs error handling and provides a hook for committing changes. It diff --git a/netbox/extras/views.py b/netbox/extras/views.py index 0a190dd49..785c5eb5a 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -588,7 +588,8 @@ class ReportView(ContentTypePermissionRequiredMixin, View): run_report, report.full_name, report_content_type, - request.user + request.user, + job_timeout=report.job_timeout ) return redirect('extras:report_result', job_result_pk=job_result.pk) @@ -708,6 +709,7 @@ class ScriptView(ContentTypePermissionRequiredMixin, GetScriptMixin, View): commit = form.cleaned_data.pop('_commit') script_content_type = ContentType.objects.get(app_label='extras', model='script') + job_result = JobResult.enqueue_job( run_script, script.full_name, @@ -715,7 +717,8 @@ class ScriptView(ContentTypePermissionRequiredMixin, GetScriptMixin, View): request.user, data=form.cleaned_data, request=copy_safe_request(request), - commit=commit + commit=commit, + job_timeout=script.job_timeout, ) return redirect('extras:script_result', job_result_pk=job_result.pk) From 69b4d0d44b5f119dad14003e00dc78872cd836cb Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Mon, 4 Apr 2022 18:13:13 +0200 Subject: [PATCH 03/38] #9028 - Fix pep8 syntax --- netbox/extras/models/models.py | 2 +- netbox/extras/scripts.py | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index 48a076f75..e614a1258 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -550,7 +550,7 @@ class JobResult(models.Model): user=user, job_id=uuid.uuid4() ) - + queue = django_rq.get_queue("default") queue.enqueue(func, job_id=str(job_result.job_id), job_result=job_result, **kwargs) diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py index 4b9d17d67..5351bca8a 100644 --- a/netbox/extras/scripts.py +++ b/netbox/extras/scripts.py @@ -418,7 +418,6 @@ def is_variable(obj): return isinstance(obj, ScriptVariable) -#@job('default') def run_script(data, request, commit=True, *args, **kwargs): """ A wrapper for calling Script.run(). This performs error handling and provides a hook for committing changes. It From ea197eff5f4fe925bb354d1375912decd81752bd Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 5 Apr 2022 17:12:13 -0400 Subject: [PATCH 04/38] PRVB --- docs/release-notes/version-3.2.md | 4 ++++ netbox/netbox/settings.py | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 9f354dbd6..ddf2ebded 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -1,5 +1,9 @@ # NetBox v3.2 +## v3.2.1 (FUTURE) + +--- + ## v3.2.0 (2022-04-05) !!! warning "Python 3.8 or Later Required" diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 1e972df8c..04c0e9c3d 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -26,7 +26,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.0' +VERSION = '3.2.1-dev' # Hostname HOSTNAME = platform.node() From 523390cd8e989b49f59a757695e585a923ae199f Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Apr 2022 13:35:22 -0500 Subject: [PATCH 05/38] #9061 - Change inheritance order for DeviceComponentFilterSets --- docs/release-notes/version-3.2.md | 5 +++++ netbox/dcim/filtersets.py | 20 ++++++++++---------- 2 files changed, 15 insertions(+), 10 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index ddf2ebded..cdb319e98 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,6 +2,11 @@ ## v3.2.1 (FUTURE) +### Bug Fixes (From Beta2) + +* [#9061](https://github.com/netbox-community/netbox/issues/9061) - Change inheritance order for DeviceComponentFilterSets + + --- ## v3.2.0 (2022-04-05) diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index a380fbcce..0f4e7cf7e 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -1095,8 +1095,8 @@ class PathEndpointFilterSet(django_filters.FilterSet): class ConsolePortFilterSet( - NetBoxModelFilterSet, ModularDeviceComponentFilterSet, + NetBoxModelFilterSet, CableTerminationFilterSet, PathEndpointFilterSet ): @@ -1111,8 +1111,8 @@ class ConsolePortFilterSet( class ConsoleServerPortFilterSet( - NetBoxModelFilterSet, ModularDeviceComponentFilterSet, + NetBoxModelFilterSet, CableTerminationFilterSet, PathEndpointFilterSet ): @@ -1127,8 +1127,8 @@ class ConsoleServerPortFilterSet( class PowerPortFilterSet( - NetBoxModelFilterSet, ModularDeviceComponentFilterSet, + NetBoxModelFilterSet, CableTerminationFilterSet, PathEndpointFilterSet ): @@ -1143,8 +1143,8 @@ class PowerPortFilterSet( class PowerOutletFilterSet( - NetBoxModelFilterSet, ModularDeviceComponentFilterSet, + NetBoxModelFilterSet, CableTerminationFilterSet, PathEndpointFilterSet ): @@ -1163,8 +1163,8 @@ class PowerOutletFilterSet( class InterfaceFilterSet( - NetBoxModelFilterSet, ModularDeviceComponentFilterSet, + NetBoxModelFilterSet, CableTerminationFilterSet, PathEndpointFilterSet ): @@ -1291,8 +1291,8 @@ class InterfaceFilterSet( class FrontPortFilterSet( - NetBoxModelFilterSet, ModularDeviceComponentFilterSet, + NetBoxModelFilterSet, CableTerminationFilterSet ): type = django_filters.MultipleChoiceFilter( @@ -1306,8 +1306,8 @@ class FrontPortFilterSet( class RearPortFilterSet( - NetBoxModelFilterSet, ModularDeviceComponentFilterSet, + NetBoxModelFilterSet, CableTerminationFilterSet ): type = django_filters.MultipleChoiceFilter( @@ -1320,21 +1320,21 @@ class RearPortFilterSet( fields = ['id', 'name', 'label', 'type', 'color', 'positions', 'description'] -class ModuleBayFilterSet(NetBoxModelFilterSet, DeviceComponentFilterSet): +class ModuleBayFilterSet(DeviceComponentFilterSet, NetBoxModelFilterSet): class Meta: model = ModuleBay fields = ['id', 'name', 'label', 'description'] -class DeviceBayFilterSet(NetBoxModelFilterSet, DeviceComponentFilterSet): +class DeviceBayFilterSet(DeviceComponentFilterSet, NetBoxModelFilterSet): class Meta: model = DeviceBay fields = ['id', 'name', 'label', 'description'] -class InventoryItemFilterSet(NetBoxModelFilterSet, DeviceComponentFilterSet): +class InventoryItemFilterSet(DeviceComponentFilterSet, NetBoxModelFilterSet): parent_id = django_filters.ModelMultipleChoiceFilter( queryset=InventoryItem.objects.all(), label='Parent inventory item (ID)', From 85e65edb7d98c07f857dcb20f87359a8c81a82a2 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Apr 2022 13:46:31 -0500 Subject: [PATCH 06/38] Fixes #9057 - Fix missing instance counts for module types --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/views.py | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index cdb319e98..6fe4ed851 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -4,6 +4,7 @@ ### Bug Fixes (From Beta2) +* [#9057](https://github.com/netbox-community/netbox/issues/9057) - Fix missing instance counts for module types * [#9061](https://github.com/netbox-community/netbox/issues/9061) - Change inheritance order for DeviceComponentFilterSets diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 4157fd2e9..e60e6abc8 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -960,7 +960,7 @@ class DeviceTypeBulkDeleteView(generic.BulkDeleteView): class ModuleTypeListView(generic.ObjectListView): queryset = ModuleType.objects.prefetch_related('manufacturer').annotate( - # instance_count=count_related(Module, 'module_type') + instance_count=count_related(Module, 'module_type') ) filterset = filtersets.ModuleTypeFilterSet filterset_form = forms.ModuleTypeFilterForm @@ -1066,7 +1066,7 @@ class ModuleTypeImportView(generic.ObjectImportView): class ModuleTypeBulkEditView(generic.BulkEditView): queryset = ModuleType.objects.prefetch_related('manufacturer').annotate( - # instance_count=count_related(Module, 'module_type') + instance_count=count_related(Module, 'module_type') ) filterset = filtersets.ModuleTypeFilterSet table = tables.ModuleTypeTable @@ -1075,7 +1075,7 @@ class ModuleTypeBulkEditView(generic.BulkEditView): class ModuleTypeBulkDeleteView(generic.BulkDeleteView): queryset = ModuleType.objects.prefetch_related('manufacturer').annotate( - # instance_count=count_related(Module, 'module_type') + instance_count=count_related(Module, 'module_type') ) filterset = filtersets.ModuleTypeFilterSet table = tables.ModuleTypeTable From 6760533a101a9ecf048d19f0cab96264e8324c05 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Apr 2022 20:01:09 -0400 Subject: [PATCH 07/38] Fixes #8931: Copy assigned tenant when cloning a location --- docs/release-notes/version-3.2.md | 4 ++-- netbox/dcim/models/sites.py | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 6fe4ed851..4740d0e0c 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,12 +2,12 @@ ## v3.2.1 (FUTURE) -### Bug Fixes (From Beta2) +### Bug Fixes +* [#8931](https://github.com/netbox-community/netbox/issues/8931) - Copy assigned tenant when cloning a location * [#9057](https://github.com/netbox-community/netbox/issues/9057) - Fix missing instance counts for module types * [#9061](https://github.com/netbox-community/netbox/issues/9061) - Change inheritance order for DeviceComponentFilterSets - --- ## v3.2.0 (2022-04-05) diff --git a/netbox/dcim/models/sites.py b/netbox/dcim/models/sites.py index 53e3bcceb..d02bd0932 100644 --- a/netbox/dcim/models/sites.py +++ b/netbox/dcim/models/sites.py @@ -367,7 +367,7 @@ class Location(NestedGroupModel): to='extras.ImageAttachment' ) - clone_fields = ['site', 'parent', 'description'] + clone_fields = ['site', 'parent', 'tenant', 'description'] class Meta: ordering = ['site', 'name'] From d93e944c07a1f045514f973cb9d8a84dccc1e70e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Apr 2022 20:12:14 -0400 Subject: [PATCH 08/38] Closes #8973: Display VLAN group count under site view --- docs/release-notes/version-3.2.md | 4 ++++ netbox/dcim/views.py | 6 +++++- netbox/templates/dcim/site.html | 10 ++++++++++ 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 4740d0e0c..90f339111 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,6 +2,10 @@ ## v3.2.1 (FUTURE) +### Enhancements + +* [#8973](https://github.com/netbox-community/netbox/issues/8973) - Display VLAN group count under site view + ### Bug Fixes * [#8931](https://github.com/netbox-community/netbox/issues/8931) - Copy assigned tenant when cloning a location diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index e60e6abc8..c0b46f16e 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -14,7 +14,7 @@ from django.views.generic import View from circuits.models import Circuit from extras.views import ObjectConfigContextView -from ipam.models import ASN, IPAddress, Prefix, Service, VLAN +from ipam.models import ASN, IPAddress, Prefix, Service, VLAN, VLANGroup from ipam.tables import AssignedIPAddressesTable, InterfaceVLANTable from netbox.views import generic from utilities.forms import ConfirmationForm @@ -320,6 +320,10 @@ class SiteView(generic.ObjectView): 'rack_count': Rack.objects.restrict(request.user, 'view').filter(site=instance).count(), 'device_count': Device.objects.restrict(request.user, 'view').filter(site=instance).count(), 'prefix_count': Prefix.objects.restrict(request.user, 'view').filter(site=instance).count(), + 'vlangroup_count': VLANGroup.objects.restrict(request.user, 'view').filter( + scope_type=ContentType.objects.get_for_model(Site), + scope_id=instance.pk + ).count(), 'vlan_count': VLAN.objects.restrict(request.user, 'view').filter(site=instance).count(), 'circuit_count': Circuit.objects.restrict(request.user, 'view').filter(terminations__site=instance).count(), 'vm_count': VirtualMachine.objects.restrict(request.user, 'view').filter(cluster__site=instance).count(), diff --git a/netbox/templates/dcim/site.html b/netbox/templates/dcim/site.html index fe0a558eb..c15cab468 100644 --- a/netbox/templates/dcim/site.html +++ b/netbox/templates/dcim/site.html @@ -188,6 +188,16 @@ {% endif %} + + VLAN Groups + + {% if stats.vlangroup_count %} + {{ stats.vlangroup_count }} + {% else %} + {{ ''|placeholder }} + {% endif %} + + VLANs From f4e78b0ea6e0db8d6c07cdb0e6adfcaddcd542f4 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Apr 2022 20:29:28 -0400 Subject: [PATCH 09/38] Fixes #9065: Min/max VID should not be required when filtering VLAN groups --- docs/release-notes/version-3.2.md | 1 + netbox/ipam/forms/filtersets.py | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 90f339111..1d2516cdf 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -11,6 +11,7 @@ * [#8931](https://github.com/netbox-community/netbox/issues/8931) - Copy assigned tenant when cloning a location * [#9057](https://github.com/netbox-community/netbox/issues/9057) - Fix missing instance counts for module types * [#9061](https://github.com/netbox-community/netbox/issues/9061) - Change inheritance order for DeviceComponentFilterSets +* [#9065](https://github.com/netbox-community/netbox/issues/9065) - Min/max VID should not be required when filtering VLAN groups --- diff --git a/netbox/ipam/forms/filtersets.py b/netbox/ipam/forms/filtersets.py index 57f39f8c2..bbd6bb97b 100644 --- a/netbox/ipam/forms/filtersets.py +++ b/netbox/ipam/forms/filtersets.py @@ -377,12 +377,16 @@ class VLANGroupFilterForm(NetBoxModelFilterSetForm): label=_('Rack') ) min_vid = forms.IntegerField( + required=False, min_value=VLAN_VID_MIN, max_value=VLAN_VID_MAX, + label='Minimum VID' ) max_vid = forms.IntegerField( + required=False, min_value=VLAN_VID_MIN, max_value=VLAN_VID_MAX, + label='Maximum VID' ) tag = TagFilterField(model) From b9f6a5625f221ede86b022dd30abebe373209676 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Apr 2022 20:30:29 -0400 Subject: [PATCH 10/38] Update supported Python versions --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index ae3fe68f3..65097e9be 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -22,9 +22,9 @@ body: label: Python version description: What version of Python are you currently running? options: - - "3.7" - "3.8" - "3.9" + - "3.10" validations: required: true - type: textarea From c3d9910e082f5878a9312c0ee18cadd5b7f8a671 Mon Sep 17 00:00:00 2001 From: Jason Yates Date: Thu, 7 Apr 2022 08:21:13 +0100 Subject: [PATCH 11/38] Limit amount of nonracked devices displayed Fixes #8920 Limits the amount of non-racked devices on Site and Location view to 10 and provides a link to the device list this is pre-filtered to the relevant site or location. --- netbox/dcim/views.py | 18 ++++- .../templates/dcim/inc/nonracked_devices.html | 68 +++++++++++-------- 2 files changed, 57 insertions(+), 29 deletions(-) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index c0b46f16e..9b24ea9d1 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -346,7 +346,13 @@ class SiteView(generic.ObjectView): site=instance, position__isnull=True, parent_bay__isnull=True - ).prefetch_related('device_type__manufacturer') + ).prefetch_related('device_type__manufacturer').order_by('-pk')[:10] + + total_nonracked_devices_count = Device.objects.filter( + site=instance, + position__isnull=True, + parent_bay__isnull=True + ).count() asns = ASN.objects.restrict(request.user, 'view').filter(sites=instance) asn_count = asns.count() @@ -358,6 +364,7 @@ class SiteView(generic.ObjectView): 'locations': locations, 'asns': asns, 'nonracked_devices': nonracked_devices, + 'total_nonracked_devices_count': total_nonracked_devices_count, } @@ -439,13 +446,20 @@ class LocationView(generic.ObjectView): location=instance, position__isnull=True, parent_bay__isnull=True - ).prefetch_related('device_type__manufacturer') + ).prefetch_related('device_type__manufacturer').order_by('-pk')[:10] + + total_nonracked_devices_count = Device.objects.filter( + location=instance, + position__isnull=True, + parent_bay__isnull=True + ).count() return { 'rack_count': rack_count, 'device_count': device_count, 'child_locations_table': child_locations_table, 'nonracked_devices': nonracked_devices, + 'total_nonracked_devices_count': total_nonracked_devices_count, } diff --git a/netbox/templates/dcim/inc/nonracked_devices.html b/netbox/templates/dcim/inc/nonracked_devices.html index 7f4da2f24..68112e2a7 100644 --- a/netbox/templates/dcim/inc/nonracked_devices.html +++ b/netbox/templates/dcim/inc/nonracked_devices.html @@ -1,40 +1,54 @@ {% load helpers %}
-
- Non-Racked Devices -
-
-{% if nonracked_devices %} - - - - - - - - {% for device in nonracked_devices %} - - - - - {% if device.parent_bay %} - - - {% else %} - +
+ Non-Racked Devices +
+
+ {% if nonracked_devices %} +
NameRoleTypeParent Device
- {{ device }} - {{ device.device_role }}{{ device.device_type }}{{ device.parent_bay.device|linkify }}{{ device.parent_bay }}—
+ + + + + + + {% for device in nonracked_devices %} + + + + + {% if device.parent_bay %} + + + {% else %} + + {% endif %} + + {% endfor %} +
NameRoleTypeParent Device
+ {{ device }} + {{ device.device_role }}{{ device.device_type }}{{ device.parent_bay.device|linkify }}{{ device.parent_bay }}—
+ + {% if nonracked_devices.count == 10 %} + {% if object|meta:'verbose_name' == 'site' %} +
+ Displaying 10 of {{ total_nonracked_devices_count }} devices (View full list) +
+ {% elif object|meta:'verbose_name' == 'location' %} +
+ Displaying 10 of {{ total_nonracked_devices_count }} devices (View full list) +
{% endif %} - - {% endfor %} - + {% endif %} + {% else %}
None
{% endif %}
+ {% if perms.dcim.add_device %} {% if object|meta:'verbose_name' == 'rack' %}
From 2781b8535cd20b38afca75815d02dbebc4a195c2 Mon Sep 17 00:00:00 2001 From: Jason Yates Date: Thu, 7 Apr 2022 08:32:50 +0100 Subject: [PATCH 12/38] Update nonracked_devices.html Fixing issue where Displaying 10 of 10 would appear when it's not required. --- netbox/templates/dcim/inc/nonracked_devices.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/netbox/templates/dcim/inc/nonracked_devices.html b/netbox/templates/dcim/inc/nonracked_devices.html index 68112e2a7..d4cd58839 100644 --- a/netbox/templates/dcim/inc/nonracked_devices.html +++ b/netbox/templates/dcim/inc/nonracked_devices.html @@ -30,14 +30,14 @@ {% endfor %} - {% if nonracked_devices.count == 10 %} + {% if total_nonracked_devices_count > nonracked_devices.count %} {% if object|meta:'verbose_name' == 'site' %}
- Displaying 10 of {{ total_nonracked_devices_count }} devices (View full list) + Displaying {{ nonracked_devices.count }} of {{ total_nonracked_devices_count }} devices (View full list)
{% elif object|meta:'verbose_name' == 'location' %}
- Displaying 10 of {{ total_nonracked_devices_count }} devices (View full list) + Displaying {{ nonracked_devices.count }} of {{ total_nonracked_devices_count }} devices (View full list)
{% endif %} {% endif %} From 5526f8e3dca2f84fce34df5a134bada8479a2f69 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 7 Apr 2022 21:19:38 -0400 Subject: [PATCH 13/38] Fix dumpdata ordering for VRFs --- netbox/ipam/models/__init__.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/netbox/ipam/models/__init__.py b/netbox/ipam/models/__init__.py index 1857b7d66..ce09c482a 100644 --- a/netbox/ipam/models/__init__.py +++ b/netbox/ipam/models/__init__.py @@ -1,8 +1,9 @@ +# Ensure that VRFs are imported before IPs/prefixes so dumpdata & loaddata work correctly from .fhrp import * +from .vrfs import * from .ip import * from .services import * from .vlans import * -from .vrfs import * __all__ = ( 'ASN', From 2269bf01672119d22587aaec9477b2547cb69bfe Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 8 Apr 2022 09:08:55 -0400 Subject: [PATCH 14/38] Fixes #9079: Fail validation when an inventory item is assigned as its own parent --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/models/device_components.py | 9 +++++++++ 2 files changed, 10 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 1d2516cdf..ea5a2374a 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -12,6 +12,7 @@ * [#9057](https://github.com/netbox-community/netbox/issues/9057) - Fix missing instance counts for module types * [#9061](https://github.com/netbox-community/netbox/issues/9061) - Change inheritance order for DeviceComponentFilterSets * [#9065](https://github.com/netbox-community/netbox/issues/9065) - Min/max VID should not be required when filtering VLAN groups +* [#9079](https://github.com/netbox-community/netbox/issues/9079) - Fail validation when an inventory item is assigned as its own parent --- diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index ab5d24867..3ed786000 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -1070,3 +1070,12 @@ class InventoryItem(MPTTModel, ComponentModel): def get_absolute_url(self): return reverse('dcim:inventoryitem', kwargs={'pk': self.pk}) + + def clean(self): + super().clean() + + # An InventoryItem cannot be its own parent + if self.pk and self.parent_id == self.pk: + raise ValidationError({ + "parent": "Cannot assign self as parent." + }) From 1e65ef0c1a2b90ac408e3f810a35007ddc357b13 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 8 Apr 2022 09:41:37 -0400 Subject: [PATCH 15/38] Fixes #9055: Restore ability to move inventory item to other device --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/forms/bulk_edit.py | 6 +++++- netbox/dcim/forms/models.py | 6 +++--- netbox/dcim/forms/object_create.py | 7 ++++++- netbox/dcim/views.py | 2 +- 5 files changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index ea5a2374a..5f60e8d91 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -9,6 +9,7 @@ ### Bug Fixes * [#8931](https://github.com/netbox-community/netbox/issues/8931) - Copy assigned tenant when cloning a location +* [#9055](https://github.com/netbox-community/netbox/issues/9055) - Restore ability to move inventory item to other device * [#9057](https://github.com/netbox-community/netbox/issues/9057) - Fix missing instance counts for module types * [#9061](https://github.com/netbox-community/netbox/issues/9061) - Change inheritance order for DeviceComponentFilterSets * [#9065](https://github.com/netbox-community/netbox/issues/9065) - Min/max VID should not be required when filtering VLAN groups diff --git a/netbox/dcim/forms/bulk_edit.py b/netbox/dcim/forms/bulk_edit.py index b166530c8..9e4f5e400 100644 --- a/netbox/dcim/forms/bulk_edit.py +++ b/netbox/dcim/forms/bulk_edit.py @@ -1204,6 +1204,10 @@ class InventoryItemBulkEditForm( form_from_model(InventoryItem, ['label', 'role', 'manufacturer', 'part_id', 'description']), NetBoxModelBulkEditForm ): + device = DynamicModelChoiceField( + queryset=Device.objects.all(), + required=False + ) role = DynamicModelChoiceField( queryset=InventoryItemRole.objects.all(), required=False @@ -1215,7 +1219,7 @@ class InventoryItemBulkEditForm( model = InventoryItem fieldsets = ( - (None, ('label', 'role', 'manufacturer', 'part_id', 'description')), + (None, ('device', 'label', 'role', 'manufacturer', 'part_id', 'description')), ) nullable_fields = ('label', 'role', 'manufacturer', 'part_id', 'description') diff --git a/netbox/dcim/forms/models.py b/netbox/dcim/forms/models.py index 57e2fa820..fe9daf938 100644 --- a/netbox/dcim/forms/models.py +++ b/netbox/dcim/forms/models.py @@ -1362,6 +1362,9 @@ class PopulateDeviceBayForm(BootstrapMixin, forms.Form): class InventoryItemForm(NetBoxModelForm): + device = DynamicModelChoiceField( + queryset=Device.objects.all() + ) parent = DynamicModelChoiceField( queryset=InventoryItem.objects.all(), required=False, @@ -1399,9 +1402,6 @@ class InventoryItemForm(NetBoxModelForm): 'device', 'parent', 'name', 'label', 'role', 'manufacturer', 'part_id', 'serial', 'asset_tag', 'description', 'component_type', 'component_id', 'tags', ] - widgets = { - 'device': forms.HiddenInput(), - } # diff --git a/netbox/dcim/forms/object_create.py b/netbox/dcim/forms/object_create.py index 8618a3b9d..e3e9c1179 100644 --- a/netbox/dcim/forms/object_create.py +++ b/netbox/dcim/forms/object_create.py @@ -1,7 +1,6 @@ from django import forms from dcim.models import * -from extras.models import Tag from netbox.forms import NetBoxModelForm from utilities.forms import ( BootstrapMixin, DynamicModelChoiceField, DynamicModelMultipleChoiceField, ExpandableNameField, @@ -12,6 +11,7 @@ __all__ = ( 'DeviceComponentCreateForm', 'FrontPortCreateForm', 'FrontPortTemplateCreateForm', + 'InventoryItemCreateForm', 'ModularComponentTemplateCreateForm', 'ModuleBayCreateForm', 'ModuleBayTemplateCreateForm', @@ -199,6 +199,11 @@ class ModuleBayCreateForm(DeviceComponentCreateForm): field_order = ('device', 'name_pattern', 'label_pattern', 'position_pattern') +class InventoryItemCreateForm(ComponentCreateForm): + # Device is assigned by the model form + field_order = ('name_pattern', 'label_pattern') + + class VirtualChassisCreateForm(NetBoxModelForm): region = DynamicModelChoiceField( queryset=Region.objects.all(), diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index c0b46f16e..0e68328ad 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2517,7 +2517,7 @@ class InventoryItemEditView(generic.ObjectEditView): class InventoryItemCreateView(generic.ComponentCreateView): queryset = InventoryItem.objects.all() - form = forms.DeviceComponentCreateForm + form = forms.InventoryItemCreateForm model_form = forms.InventoryItemForm template_name = 'dcim/inventoryitem_create.html' From a5f25726cd4cfc0b50b051251bb876e9f01dc2e1 Mon Sep 17 00:00:00 2001 From: Stephan Blanke Date: Fri, 8 Apr 2022 19:39:18 +0200 Subject: [PATCH 16/38] Closes #8913: Improve documentation regarding VC masters interfaces --- docs/models/dcim/virtualchassis.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/models/dcim/virtualchassis.md b/docs/models/dcim/virtualchassis.md index 3b6fb9d17..2466b065d 100644 --- a/docs/models/dcim/virtualchassis.md +++ b/docs/models/dcim/virtualchassis.md @@ -2,7 +2,8 @@ A virtual chassis represents a set of devices which share a common control plane. A common example of this is a stack of switches which are connected and configured to operate as a single device. A virtual chassis must be assigned a name and may be assigned a domain. -Each device in the virtual chassis is referred to as a VC member, and assigned a position and (optionally) a priority. VC member devices commonly reside within the same rack, though this is not a requirement. One of the devices may be designated as the VC master: This device will typically be assigned a name, services, and other attributes related to managing the VC. +Each device in the virtual chassis is referred to as a VC member, and assigned a position and (optionally) a priority. VC member devices commonly reside within the same rack, though this is not a requirement. One of the devices may be designated as the VC master: This device will typically be assigned a name, services, virtual interfaces, and other attributes related to managing the VC. +If a VC master is defined, interfaces from all VC members are displayed when navigating to its device interfaces view. This does not include other members interfaces declared as management-only. !!! note It's important to recognize the distinction between a virtual chassis and a chassis-based device. A virtual chassis is **not** suitable for modeling a chassis-based switch with removable line cards (such as the Juniper EX9208), as its line cards are _not_ physically autonomous devices. From 1d8b8aad3b32c3d2377ad07c99e06855f0980060 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 8 Apr 2022 14:10:21 -0400 Subject: [PATCH 17/38] Changelog & documentation for #5479 --- docs/customization/custom-scripts.md | 4 +++- docs/customization/reports.md | 14 ++++++++++++++ docs/release-notes/version-3.2.md | 1 + 3 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/customization/custom-scripts.md b/docs/customization/custom-scripts.md index 982a4f8e3..230b003c6 100644 --- a/docs/customization/custom-scripts.md +++ b/docs/customization/custom-scripts.md @@ -91,7 +91,9 @@ commit_default = False ### `job_timeout` -Set the allowed runtime of a script. If not set the `RQ_DEFAULT_TIMEOUT` will be used. +Set the maximum allowed runtime for the script. If not set, `RQ_DEFAULT_TIMEOUT` will be used. + +!!! info "This feature was introduced in v3.2.1" ## Accessing Request Data diff --git a/docs/customization/reports.md b/docs/customization/reports.md index 3bf6bd8d9..ae4ceb9aa 100644 --- a/docs/customization/reports.md +++ b/docs/customization/reports.md @@ -85,6 +85,20 @@ As you can see, reports are completely customizable. Validation logic can be as !!! warning Reports should never alter data: If you find yourself using the `create()`, `save()`, `update()`, or `delete()` methods on objects within reports, stop and re-evaluate what you're trying to accomplish. Note that there are no safeguards against the accidental alteration or destruction of data. +## Report Attributes + +### `description` + +A human-friendly description of what your report does. + +### `job_timeout` + +Set the maximum allowed runtime for the report. If not set, `RQ_DEFAULT_TIMEOUT` will be used. + +!!! info "This feature was introduced in v3.2.1" + +## Logging + The following methods are available to log results within a report: * log(message) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 5f60e8d91..101797793 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -4,6 +4,7 @@ ### Enhancements +* [#5479](https://github.com/netbox-community/netbox/issues/5479) - Allow custom job timeouts for scripts & reports * [#8973](https://github.com/netbox-community/netbox/issues/8973) - Display VLAN group count under site view ### Bug Fixes From 23fddf74b6e07a8d15985f380dff23f8563a6a16 Mon Sep 17 00:00:00 2001 From: Jason Yates Date: Sun, 10 Apr 2022 09:06:14 +0100 Subject: [PATCH 18/38] Updating to use a single queryset Updating to use a single queryset for both template variables --- netbox/dcim/views.py | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 9b24ea9d1..bc2cbdcb8 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -342,17 +342,12 @@ class SiteView(generic.ObjectView): 'device_count', cumulative=True ).restrict(request.user, 'view').filter(site=instance) + nonracked_devices = Device.objects.filter( site=instance, position__isnull=True, parent_bay__isnull=True - ).prefetch_related('device_type__manufacturer').order_by('-pk')[:10] - - total_nonracked_devices_count = Device.objects.filter( - site=instance, - position__isnull=True, - parent_bay__isnull=True - ).count() + ).prefetch_related('device_type__manufacturer') asns = ASN.objects.restrict(request.user, 'view').filter(sites=instance) asn_count = asns.count() @@ -363,8 +358,8 @@ class SiteView(generic.ObjectView): 'stats': stats, 'locations': locations, 'asns': asns, - 'nonracked_devices': nonracked_devices, - 'total_nonracked_devices_count': total_nonracked_devices_count, + 'nonracked_devices': nonracked_devices.order_by('-pk')[:10], + 'total_nonracked_devices_count': nonracked_devices.count(), } @@ -442,24 +437,19 @@ class LocationView(generic.ObjectView): ).filter(pk__in=location_ids).exclude(pk=instance.pk) child_locations_table = tables.LocationTable(child_locations) child_locations_table.configure(request) + nonracked_devices = Device.objects.filter( location=instance, position__isnull=True, parent_bay__isnull=True - ).prefetch_related('device_type__manufacturer').order_by('-pk')[:10] - - total_nonracked_devices_count = Device.objects.filter( - location=instance, - position__isnull=True, - parent_bay__isnull=True - ).count() + ).prefetch_related('device_type__manufacturer') return { 'rack_count': rack_count, 'device_count': device_count, 'child_locations_table': child_locations_table, - 'nonracked_devices': nonracked_devices, - 'total_nonracked_devices_count': total_nonracked_devices_count, + 'nonracked_devices': nonracked_devices.order_by('-pk')[:10], + 'total_nonracked_devices_count': nonracked_devices.count(), } From 9b3e43cb21acb05f9622779a01dbf9f021509d2f Mon Sep 17 00:00:00 2001 From: Joe Izzard Date: Mon, 11 Apr 2022 12:20:44 +0100 Subject: [PATCH 19/38] Closes #8415: Adds Neutrik power connectors --- netbox/dcim/choices.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index c5f70c1b6..1bfbcbc94 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -345,6 +345,10 @@ class PowerPortTypeChoices(ChoiceSet): TYPE_DC = 'dc-terminal' # Proprietary TYPE_SAF_D_GRID = 'saf-d-grid' + TYPE_NEUTRIK_POWERCON = 'neutrik-powercon' + TYPE_NEUTRIK_POWERCON_32A = 'neutrik-powercon-32' + TYPE_NEUTRIK_TRUE1 = 'neutrik-true1' + TYPE_NEUTRIK_TRUE1_TOP = 'neutrik-true1-top' # Other TYPE_HARDWIRED = 'hardwired' @@ -456,6 +460,10 @@ class PowerPortTypeChoices(ChoiceSet): )), ('Proprietary', ( (TYPE_SAF_D_GRID, 'Saf-D-Grid'), + (TYPE_NEUTRIK_POWERCON, 'Neutrik powerCon'), + (TYPE_NEUTRIK_POWERCON_32A, 'Neutrik powerCon (32A)'), + (TYPE_NEUTRIK_TRUE1, 'Neutrik powerCon TRUE1'), + (TYPE_NEUTRIK_TRUE1_TOP, 'Neutrik powerCon TRUE1 TOP'), )), ('Other', ( (TYPE_HARDWIRED, 'Hardwired'), @@ -561,6 +569,10 @@ class PowerOutletTypeChoices(ChoiceSet): # Proprietary TYPE_HDOT_CX = 'hdot-cx' TYPE_SAF_D_GRID = 'saf-d-grid' + TYPE_NEUTRIK_POWERCON = 'neutrik-powercon' + TYPE_NEUTRIK_POWERCON_32A = 'neutrik-powercon-32' + TYPE_NEUTRIK_TRUE1 = 'neutrik-true1' + TYPE_NEUTRIK_TRUE1_TOP = 'neutrik-true1-top' # Other TYPE_HARDWIRED = 'hardwired' @@ -665,6 +677,10 @@ class PowerOutletTypeChoices(ChoiceSet): ('Proprietary', ( (TYPE_HDOT_CX, 'HDOT Cx'), (TYPE_SAF_D_GRID, 'Saf-D-Grid'), + (TYPE_NEUTRIK_POWERCON, 'Neutrik powerCon'), + (TYPE_NEUTRIK_POWERCON_32A, 'Neutrik powerCon (32A)'), + (TYPE_NEUTRIK_TRUE1, 'Neutrik powerCon TRUE1'), + (TYPE_NEUTRIK_TRUE1_TOP, 'Neutrik powerCon TRUE1 TOP'), )), ('Other', ( (TYPE_HARDWIRED, 'Hardwired'), From a9e05aec7c54736e8ffa46ce45a24fa01068fdf3 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Apr 2022 08:28:10 -0400 Subject: [PATCH 20/38] Fixes #9100: Include position field in module type YAML export --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/models/devices.py | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 101797793..8dc2302e5 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -15,6 +15,7 @@ * [#9061](https://github.com/netbox-community/netbox/issues/9061) - Change inheritance order for DeviceComponentFilterSets * [#9065](https://github.com/netbox-community/netbox/issues/9065) - Min/max VID should not be required when filtering VLAN groups * [#9079](https://github.com/netbox-community/netbox/issues/9079) - Fail validation when an inventory item is assigned as its own parent +* [#9100](https://github.com/netbox-community/netbox/issues/9100) - Include position field in module type YAML export --- diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index d95063601..6ed7b349f 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -257,6 +257,7 @@ class DeviceType(NetBoxModel): { 'name': c.name, 'label': c.label, + 'position': c.position, 'description': c.description, } for c in self.modulebaytemplates.all() From 517d0158b67b4295480e9748b159d3349cdeb7b1 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Apr 2022 08:51:11 -0400 Subject: [PATCH 21/38] Fixes #9096: Remove duplicate filter tag when filtering by "none" --- docs/release-notes/version-3.2.md | 1 + netbox/utilities/forms/utils.py | 10 +++++----- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 8dc2302e5..4269cb5f0 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -15,6 +15,7 @@ * [#9061](https://github.com/netbox-community/netbox/issues/9061) - Change inheritance order for DeviceComponentFilterSets * [#9065](https://github.com/netbox-community/netbox/issues/9065) - Min/max VID should not be required when filtering VLAN groups * [#9079](https://github.com/netbox-community/netbox/issues/9079) - Fail validation when an inventory item is assigned as its own parent +* [#9096](https://github.com/netbox-community/netbox/issues/9096) - Remove duplicate filter tag when filtering by "none" * [#9100](https://github.com/netbox-community/netbox/issues/9100) - Include position field in module type YAML export --- diff --git a/netbox/utilities/forms/utils.py b/netbox/utilities/forms/utils.py index 6d45d524d..db10cf1e0 100644 --- a/netbox/utilities/forms/utils.py +++ b/netbox/utilities/forms/utils.py @@ -144,11 +144,11 @@ def get_selected_values(form, field_name): label for value, label in choices if str(value) in filter_data or None in filter_data ] - if hasattr(field, 'null_option'): - # If the field has a `null_option` attribute set and it is selected, - # add it to the field's grouped choices. - if field.null_option is not None and None in filter_data: - values.append(field.null_option) + # If the field has a `null_option` attribute set and it is selected, + # add it to the field's grouped choices. + if getattr(field, 'null_option') and None in filter_data: + values.remove(None) + values.insert(0, field.null_option) return values From 27a931339674c80a94c46c22aed73f846be80def Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 12 Apr 2022 08:13:08 -0400 Subject: [PATCH 22/38] #9096: Correct getattr() call --- netbox/utilities/forms/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/utilities/forms/utils.py b/netbox/utilities/forms/utils.py index db10cf1e0..9a4b011e0 100644 --- a/netbox/utilities/forms/utils.py +++ b/netbox/utilities/forms/utils.py @@ -146,7 +146,7 @@ def get_selected_values(form, field_name): # If the field has a `null_option` attribute set and it is selected, # add it to the field's grouped choices. - if getattr(field, 'null_option') and None in filter_data: + if getattr(field, 'null_option', None) and None in filter_data: values.remove(None) values.insert(0, field.null_option) From 916e976297ca04c12f020cc0e9d8c6b98a10c40e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 12 Apr 2022 08:22:17 -0400 Subject: [PATCH 23/38] Tweak changelog for #9061 --- docs/release-notes/version-3.2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 4269cb5f0..8fcfd6136 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -12,7 +12,7 @@ * [#8931](https://github.com/netbox-community/netbox/issues/8931) - Copy assigned tenant when cloning a location * [#9055](https://github.com/netbox-community/netbox/issues/9055) - Restore ability to move inventory item to other device * [#9057](https://github.com/netbox-community/netbox/issues/9057) - Fix missing instance counts for module types -* [#9061](https://github.com/netbox-community/netbox/issues/9061) - Change inheritance order for DeviceComponentFilterSets +* [#9061](https://github.com/netbox-community/netbox/issues/9061) - Fix general search for device components * [#9065](https://github.com/netbox-community/netbox/issues/9065) - Min/max VID should not be required when filtering VLAN groups * [#9079](https://github.com/netbox-community/netbox/issues/9079) - Fail validation when an inventory item is assigned as its own parent * [#9096](https://github.com/netbox-community/netbox/issues/9096) - Remove duplicate filter tag when filtering by "none" From d11031c694898f18b43c17dc1acfaa24c0f61dfe Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 12 Apr 2022 09:00:19 -0400 Subject: [PATCH 24/38] Closes #9099: Enable display of installed module serial & asset tag in module bays list --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/tables/devices.py | 16 ++++++++++++++-- netbox/templates/dcim/modulebay.html | 12 ++++++++++++ 3 files changed, 27 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 8fcfd6136..faa87c6d2 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -6,6 +6,7 @@ * [#5479](https://github.com/netbox-community/netbox/issues/5479) - Allow custom job timeouts for scripts & reports * [#8973](https://github.com/netbox-community/netbox/issues/8973) - Display VLAN group count under site view +* [#9099](https://github.com/netbox-community/netbox/issues/9099) - Enable display of installed module serial & asset tag in module bays list ### Bug Fixes diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index f3e1d39e0..25ad1415d 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -739,13 +739,22 @@ class ModuleBayTable(DeviceComponentTable): linkify=True, verbose_name='Installed module' ) + module_serial = tables.Column( + accessor=tables.A('installed_module__serial') + ) + module_asset_tag = tables.Column( + accessor=tables.A('installed_module__asset_tag') + ) tags = columns.TagColumn( url_name='dcim:modulebay_list' ) class Meta(DeviceComponentTable.Meta): model = ModuleBay - fields = ('pk', 'id', 'name', 'device', 'label', 'position', 'installed_module', 'description', 'tags') + fields = ( + 'pk', 'id', 'name', 'device', 'label', 'position', 'installed_module', 'module_serial', 'module_asset_tag', + 'description', 'tags', + ) default_columns = ('pk', 'name', 'device', 'label', 'installed_module', 'description') @@ -756,7 +765,10 @@ class DeviceModuleBayTable(ModuleBayTable): class Meta(DeviceComponentTable.Meta): model = ModuleBay - fields = ('pk', 'id', 'name', 'label', 'position', 'installed_module', 'description', 'tags', 'actions') + fields = ( + 'pk', 'id', 'name', 'label', 'position', 'installed_module', 'module_serial', 'module_asset_tag', + 'description', 'tags', 'actions', + ) default_columns = ('pk', 'name', 'label', 'installed_module', 'description') diff --git a/netbox/templates/dcim/modulebay.html b/netbox/templates/dcim/modulebay.html index a12e020e9..3ef539156 100644 --- a/netbox/templates/dcim/modulebay.html +++ b/netbox/templates/dcim/modulebay.html @@ -52,6 +52,10 @@ {% if object.installed_module %} {% with module=object.installed_module %} + + + + @@ -60,6 +64,14 @@ + + + + + + + +
Module{{ module|linkify }}
Manufacturer {{ module.module_type.manufacturer|linkify }}Module Type {{ module.module_type|linkify }}
Serial Number{{ module.serial|placeholder }}
Asset Tag{{ module.asset_tag|placeholder }}
{% endwith %} {% else %} From 23d2cf1718f30f144440ebdf700d1d7a979ced0c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 12 Apr 2022 09:56:33 -0400 Subject: [PATCH 25/38] Closes #9081: Add fhrpgroup_id filter for IP addresses --- docs/release-notes/version-3.2.md | 1 + netbox/ipam/filtersets.py | 5 +++++ netbox/ipam/tests/test_filtersets.py | 23 +++++++++++++++++++---- 3 files changed, 25 insertions(+), 4 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index faa87c6d2..171783e36 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -6,6 +6,7 @@ * [#5479](https://github.com/netbox-community/netbox/issues/5479) - Allow custom job timeouts for scripts & reports * [#8973](https://github.com/netbox-community/netbox/issues/8973) - Display VLAN group count under site view +* [#9081](https://github.com/netbox-community/netbox/issues/9081) - Add `fhrpgroup_id` filter for IP addresses * [#9099](https://github.com/netbox-community/netbox/issues/9099) - Enable display of installed module serial & asset tag in module bays list ### Bug Fixes diff --git a/netbox/ipam/filtersets.py b/netbox/ipam/filtersets.py index 88b586bf2..977e70020 100644 --- a/netbox/ipam/filtersets.py +++ b/netbox/ipam/filtersets.py @@ -535,6 +535,11 @@ class IPAddressFilterSet(NetBoxModelFilterSet, TenancyFilterSet): queryset=VMInterface.objects.all(), label='VM interface (ID)', ) + fhrpgroup_id = django_filters.ModelMultipleChoiceFilter( + field_name='fhrpgroup', + queryset=FHRPGroup.objects.all(), + label='FHRP group (ID)', + ) assigned_to_interface = django_filters.BooleanFilter( method='_assigned_to_interface', label='Is assigned to an interface', diff --git a/netbox/ipam/tests/test_filtersets.py b/netbox/ipam/tests/test_filtersets.py index eaf84ee16..9bae84e3a 100644 --- a/netbox/ipam/tests/test_filtersets.py +++ b/netbox/ipam/tests/test_filtersets.py @@ -771,6 +771,12 @@ class IPAddressTestCase(TestCase, ChangeLoggedFilterSetTests): ) VMInterface.objects.bulk_create(vminterfaces) + fhrp_groups = ( + FHRPGroup(protocol=FHRPGroupProtocolChoices.PROTOCOL_VRRP2, group_id=101), + FHRPGroup(protocol=FHRPGroupProtocolChoices.PROTOCOL_VRRP2, group_id=102), + ) + FHRPGroup.objects.bulk_create(fhrp_groups) + tenant_groups = ( TenantGroup(name='Tenant group 1', slug='tenant-group-1'), TenantGroup(name='Tenant group 2', slug='tenant-group-2'), @@ -791,18 +797,22 @@ class IPAddressTestCase(TestCase, ChangeLoggedFilterSetTests): IPAddress(address='10.0.0.2/24', tenant=tenants[0], vrf=vrfs[0], assigned_object=interfaces[0], status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-b'), IPAddress(address='10.0.0.3/24', tenant=tenants[1], vrf=vrfs[1], assigned_object=interfaces[1], status=IPAddressStatusChoices.STATUS_RESERVED, role=IPAddressRoleChoices.ROLE_VIP, dns_name='ipaddress-c'), IPAddress(address='10.0.0.4/24', tenant=tenants[2], vrf=vrfs[2], assigned_object=interfaces[2], status=IPAddressStatusChoices.STATUS_DEPRECATED, role=IPAddressRoleChoices.ROLE_SECONDARY, dns_name='ipaddress-d'), + IPAddress(address='10.0.0.5/24', tenant=None, vrf=None, assigned_object=fhrp_groups[0], status=IPAddressStatusChoices.STATUS_ACTIVE), IPAddress(address='10.0.0.1/25', tenant=None, vrf=None, assigned_object=None, status=IPAddressStatusChoices.STATUS_ACTIVE), IPAddress(address='2001:db8::1/64', tenant=None, vrf=None, assigned_object=None, status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-a', description='foobar2'), IPAddress(address='2001:db8::2/64', tenant=tenants[0], vrf=vrfs[0], assigned_object=vminterfaces[0], status=IPAddressStatusChoices.STATUS_ACTIVE, dns_name='ipaddress-b'), IPAddress(address='2001:db8::3/64', tenant=tenants[1], vrf=vrfs[1], assigned_object=vminterfaces[1], status=IPAddressStatusChoices.STATUS_RESERVED, role=IPAddressRoleChoices.ROLE_VIP, dns_name='ipaddress-c'), IPAddress(address='2001:db8::4/64', tenant=tenants[2], vrf=vrfs[2], assigned_object=vminterfaces[2], status=IPAddressStatusChoices.STATUS_DEPRECATED, role=IPAddressRoleChoices.ROLE_SECONDARY, dns_name='ipaddress-d'), + IPAddress(address='2001:db8::5/64', tenant=None, vrf=None, assigned_object=fhrp_groups[1], status=IPAddressStatusChoices.STATUS_ACTIVE), IPAddress(address='2001:db8::1/65', tenant=None, vrf=None, assigned_object=None, status=IPAddressStatusChoices.STATUS_ACTIVE), ) IPAddress.objects.bulk_create(ipaddresses) def test_family(self): + params = {'family': '4'} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) params = {'family': '6'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 5) + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) def test_dns_name(self): params = {'dns_name': ['ipaddress-a', 'ipaddress-b']} @@ -814,9 +824,9 @@ class IPAddressTestCase(TestCase, ChangeLoggedFilterSetTests): def test_parent(self): params = {'parent': '10.0.0.0/24'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 5) + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) params = {'parent': '2001:db8::/64'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 5) + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) def test_filter_address(self): # Check IPv4 and IPv6, with and without a mask @@ -835,7 +845,7 @@ class IPAddressTestCase(TestCase, ChangeLoggedFilterSetTests): def test_mask_length(self): params = {'mask_length': '24'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 5) def test_vrf(self): vrfs = VRF.objects.all()[:2] @@ -872,6 +882,11 @@ class IPAddressTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'vminterface': ['Interface 1', 'Interface 2']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_fhrpgroup(self): + fhrp_groups = FHRPGroup.objects.all()[:2] + params = {'fhrpgroup_id': [fhrp_groups[0].pk, fhrp_groups[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_assigned_to_interface(self): params = {'assigned_to_interface': 'true'} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) From 1266a2f753cb3f1c5a31af0a6e33572fc234d1db Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 12 Apr 2022 10:07:31 -0400 Subject: [PATCH 26/38] Fixes #9116: assigned_to_interface filter for IP addresses should not match FHRP group assignments --- docs/release-notes/version-3.2.md | 1 + netbox/ipam/filtersets.py | 12 +++++++++++- netbox/ipam/tests/test_filtersets.py | 2 +- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 171783e36..a7cccf946 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -19,6 +19,7 @@ * [#9079](https://github.com/netbox-community/netbox/issues/9079) - Fail validation when an inventory item is assigned as its own parent * [#9096](https://github.com/netbox-community/netbox/issues/9096) - Remove duplicate filter tag when filtering by "none" * [#9100](https://github.com/netbox-community/netbox/issues/9100) - Include position field in module type YAML export +* [#9116](https://github.com/netbox-community/netbox/issues/9116) - `assigned_to_interface` filter for IP addresses should not match FHRP group assignments --- diff --git a/netbox/ipam/filtersets.py b/netbox/ipam/filtersets.py index 977e70020..53c589bb3 100644 --- a/netbox/ipam/filtersets.py +++ b/netbox/ipam/filtersets.py @@ -618,7 +618,17 @@ class IPAddressFilterSet(NetBoxModelFilterSet, TenancyFilterSet): ) def _assigned_to_interface(self, queryset, name, value): - return queryset.exclude(assigned_object_id__isnull=value) + content_types = ContentType.objects.get_for_models(Interface, VMInterface).values() + if value: + return queryset.filter( + assigned_object_type__in=content_types, + assigned_object_id__isnull=False + ) + else: + return queryset.exclude( + assigned_object_type__in=content_types, + assigned_object_id__isnull=False + ) class FHRPGroupFilterSet(NetBoxModelFilterSet): diff --git a/netbox/ipam/tests/test_filtersets.py b/netbox/ipam/tests/test_filtersets.py index 9bae84e3a..4bb72dce2 100644 --- a/netbox/ipam/tests/test_filtersets.py +++ b/netbox/ipam/tests/test_filtersets.py @@ -891,7 +891,7 @@ class IPAddressTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'assigned_to_interface': 'true'} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) params = {'assigned_to_interface': 'false'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) def test_status(self): params = {'status': [PrefixStatusChoices.STATUS_DEPRECATED, PrefixStatusChoices.STATUS_RESERVED]} From f13a00b2dd33bffc3048c861b494096df457f212 Mon Sep 17 00:00:00 2001 From: kkthxbye <> Date: Thu, 24 Mar 2022 13:42:07 +0100 Subject: [PATCH 27/38] Save old JobResults --- netbox/extras/api/views.py | 4 ++-- netbox/extras/management/commands/runscript.py | 7 ------- netbox/extras/reports.py | 9 --------- netbox/extras/scripts.py | 11 +---------- netbox/extras/views.py | 4 ++-- netbox/netbox/views/__init__.py | 11 +---------- 6 files changed, 6 insertions(+), 40 deletions(-) diff --git a/netbox/extras/api/views.py b/netbox/extras/api/views.py index 579e39d86..688f3c7ab 100644 --- a/netbox/extras/api/views.py +++ b/netbox/extras/api/views.py @@ -179,7 +179,7 @@ class ReportViewSet(ViewSet): for r in JobResult.objects.filter( obj_type=report_content_type, status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES - ).defer('data') + ).order_by('name', '-created').distinct('name').defer('data') } # Iterate through all available Reports. @@ -271,7 +271,7 @@ class ScriptViewSet(ViewSet): for r in JobResult.objects.filter( obj_type=script_content_type, status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES - ).defer('data').order_by('created') + ).order_by('name', '-created').distinct('name').defer('data') } flat_list = [] diff --git a/netbox/extras/management/commands/runscript.py b/netbox/extras/management/commands/runscript.py index 0d1dc5cea..12188619f 100644 --- a/netbox/extras/management/commands/runscript.py +++ b/netbox/extras/management/commands/runscript.py @@ -113,13 +113,6 @@ class Command(BaseCommand): script_content_type = ContentType.objects.get(app_label='extras', model='script') - # Delete any previous terminal state results - JobResult.objects.filter( - obj_type=script_content_type, - name=script.full_name, - status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES - ).delete() - # Create the job result job_result = JobResult.objects.create( name=script.full_name, diff --git a/netbox/extras/reports.py b/netbox/extras/reports.py index 0bdc4847e..0a8a8d89b 100644 --- a/netbox/extras/reports.py +++ b/netbox/extras/reports.py @@ -84,15 +84,6 @@ def run_report(job_result, *args, **kwargs): job_result.save() logging.error(f"Error during execution of report {job_result.name}") - # Delete any previous terminal state results - JobResult.objects.filter( - obj_type=job_result.obj_type, - name=job_result.name, - status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES - ).exclude( - pk=job_result.pk - ).delete() - class Report(object): """ diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py index 5351bca8a..4eacddbeb 100644 --- a/netbox/extras/scripts.py +++ b/netbox/extras/scripts.py @@ -481,15 +481,6 @@ def run_script(data, request, commit=True, *args, **kwargs): else: _run_script() - # Delete any previous terminal state results - JobResult.objects.filter( - obj_type=job_result.obj_type, - name=job_result.name, - status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES - ).exclude( - pk=job_result.pk - ).delete() - def get_scripts(use_names=False): """ @@ -497,7 +488,7 @@ def get_scripts(use_names=False): defined name in place of the actual module name. """ scripts = OrderedDict() - # Iterate through all modules within the reports path. These are the user-created files in which reports are + # Iterate through all modules within the scripts path. These are the user-created files in which reports are # defined. for importer, module_name, _ in pkgutil.iter_modules([settings.SCRIPTS_ROOT]): # Remove cached module to ensure consistency with filesystem diff --git a/netbox/extras/views.py b/netbox/extras/views.py index 785c5eb5a..9825d10de 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -524,7 +524,7 @@ class ReportListView(ContentTypePermissionRequiredMixin, View): for r in JobResult.objects.filter( obj_type=report_content_type, status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES - ).defer('data') + ).order_by('name', '-created').distinct('name').defer('data') } ret = [] @@ -656,7 +656,7 @@ class ScriptListView(ContentTypePermissionRequiredMixin, View): for r in JobResult.objects.filter( obj_type=script_content_type, status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES - ).defer('data') + ).order_by('name', '-created').distinct('name').defer('data') } for _scripts in scripts.values(): diff --git a/netbox/netbox/views/__init__.py b/netbox/netbox/views/__init__.py index 5d388be35..fad347c36 100644 --- a/netbox/netbox/views/__init__.py +++ b/netbox/netbox/views/__init__.py @@ -19,8 +19,7 @@ from circuits.models import Circuit, Provider from dcim.models import ( Cable, ConsolePort, Device, DeviceType, Interface, PowerPanel, PowerFeed, PowerPort, Rack, Site, ) -from extras.choices import JobResultStatusChoices -from extras.models import ObjectChange, JobResult +from extras.models import ObjectChange from extras.tables import ObjectChangeTable from ipam.models import Aggregate, IPAddress, IPRange, Prefix, VLAN, VRF from netbox.constants import SEARCH_MAX_RESULTS, SEARCH_TYPES @@ -48,13 +47,6 @@ class HomeView(View): pk__lt=F('_path__destination_id') ) - # Report Results - report_content_type = ContentType.objects.get(app_label='extras', model='report') - report_results = JobResult.objects.filter( - obj_type=report_content_type, - status__in=JobResultStatusChoices.TERMINAL_STATE_CHOICES - ).defer('data')[:10] - def build_stats(): org = ( ("dcim.view_site", "Sites", Site.objects.restrict(request.user, 'view').count), @@ -150,7 +142,6 @@ class HomeView(View): return render(request, self.template_name, { 'search_form': SearchForm(), 'stats': build_stats(), - 'report_results': report_results, 'changelog_table': changelog_table, 'new_release': new_release, }) From aa2ec3b9c9d91e1b03429a508249fe516e3e4a84 Mon Sep 17 00:00:00 2001 From: kkthxbye <> Date: Fri, 25 Mar 2022 09:00:02 +0100 Subject: [PATCH 28/38] Add dynamic config JOBRESULT_RETENTION and cleanup functionality to the housekeeping script --- docs/administration/housekeeping.md | 1 + docs/configuration/dynamic-settings.md | 12 ++++++++ netbox/extras/admin.py | 2 +- .../management/commands/housekeeping.py | 28 +++++++++++++++++++ netbox/netbox/config/parameters.py | 7 +++++ 5 files changed, 49 insertions(+), 1 deletion(-) diff --git a/docs/administration/housekeeping.md b/docs/administration/housekeeping.md index bbb03dc27..1989e41c0 100644 --- a/docs/administration/housekeeping.md +++ b/docs/administration/housekeeping.md @@ -4,6 +4,7 @@ NetBox includes a `housekeeping` management command that should be run nightly. * Clearing expired authentication sessions from the database * Deleting changelog records older than the configured [retention time](../configuration/dynamic-settings.md#changelog_retention) +* Deleting job result records older than the configured [retention time](../configuration/dynamic-settings.md#jobresult_retention) This command can be invoked directly, or by using the shell script provided at `/opt/netbox/contrib/netbox-housekeeping.sh`. This script can be linked from your cron scheduler's daily jobs directory (e.g. `/etc/cron.daily`) or referenced directly within the cron configuration file. diff --git a/docs/configuration/dynamic-settings.md b/docs/configuration/dynamic-settings.md index 5649eb9be..4a12726ba 100644 --- a/docs/configuration/dynamic-settings.md +++ b/docs/configuration/dynamic-settings.md @@ -43,6 +43,18 @@ changes in the database indefinitely. --- +## JOBRESULT_RETENTION + +Default: 0 + +The number of days to retain job results (scripts and reports). Set this to `0` to retain +job results in the database indefinitely. + +!!! warning + If enabling indefinite job results retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity. + +--- + ## CUSTOM_VALIDATORS This is a mapping of models to [custom validators](../customization/custom-validation.md) that have been defined locally to enforce custom validation logic. An example is provided below: diff --git a/netbox/extras/admin.py b/netbox/extras/admin.py index 64c224cb1..28902c323 100644 --- a/netbox/extras/admin.py +++ b/netbox/extras/admin.py @@ -40,7 +40,7 @@ class ConfigRevisionAdmin(admin.ModelAdmin): 'fields': ('DEFAULT_USER_PREFERENCES',), }), ('Miscellaneous', { - 'fields': ('MAINTENANCE_MODE', 'GRAPHQL_ENABLED', 'CHANGELOG_RETENTION', 'MAPS_URL'), + 'fields': ('MAINTENANCE_MODE', 'GRAPHQL_ENABLED', 'CHANGELOG_RETENTION', 'JOBRESULT_RETENTION', 'MAPS_URL'), }), ('Config Revision', { 'fields': ('comment',), diff --git a/netbox/extras/management/commands/housekeeping.py b/netbox/extras/management/commands/housekeeping.py index 0607a16c2..51d50d7e1 100644 --- a/netbox/extras/management/commands/housekeeping.py +++ b/netbox/extras/management/commands/housekeeping.py @@ -9,6 +9,7 @@ from django.db import DEFAULT_DB_ALIAS from django.utils import timezone from packaging import version +from extras.models import JobResult from extras.models import ObjectChange from netbox.config import Config @@ -63,6 +64,33 @@ class Command(BaseCommand): f"\tSkipping: No retention period specified (CHANGELOG_RETENTION = {config.CHANGELOG_RETENTION})" ) + # Delete expired JobResults + if options['verbosity']: + self.stdout.write("[*] Checking for expired jobresult records") + if config.JOBRESULT_RETENTION: + cutoff = timezone.now() - timedelta(days=config.JOBRESULT_RETENTION) + if options['verbosity'] >= 2: + self.stdout.write(f"\tRetention period: {config.JOBRESULT_RETENTION} days") + self.stdout.write(f"\tCut-off time: {cutoff}") + expired_records = JobResult.objects.filter(created__lt=cutoff).count() + if expired_records: + if options['verbosity']: + self.stdout.write( + f"\tDeleting {expired_records} expired records... ", + self.style.WARNING, + ending="" + ) + self.stdout.flush() + JobResult.objects.filter(created__lt=cutoff)._raw_delete(using=DEFAULT_DB_ALIAS) + if options['verbosity']: + self.stdout.write("Done.", self.style.SUCCESS) + elif options['verbosity']: + self.stdout.write("\tNo expired records found.", self.style.SUCCESS) + elif options['verbosity']: + self.stdout.write( + f"\tSkipping: No retention period specified (JOBRESULT_RETENTION = {config.JOBRESULT_RETENTION})" + ) + # Check for new releases (if enabled) if options['verbosity']: self.stdout.write("[*] Checking for latest release") diff --git a/netbox/netbox/config/parameters.py b/netbox/netbox/config/parameters.py index 89de94674..9bbf45ceb 100644 --- a/netbox/netbox/config/parameters.py +++ b/netbox/netbox/config/parameters.py @@ -187,6 +187,13 @@ PARAMS = ( description="Days to retain changelog history (set to zero for unlimited)", field=forms.IntegerField ), + ConfigParam( + name='JOBRESULT_RETENTION', + label='Job result retention', + default=0, + description="Days to retain job result history (set to zero for unlimited)", + field=forms.IntegerField + ), ConfigParam( name='MAPS_URL', label='Maps URL', From c216405a8109c7e9769782cf7732b11d99903102 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Fri, 8 Apr 2022 22:10:17 +0200 Subject: [PATCH 29/38] Change default JOBRESULT_RETENTION from 0 to 90 --- docs/configuration/dynamic-settings.md | 2 +- netbox/netbox/config/parameters.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/dynamic-settings.md b/docs/configuration/dynamic-settings.md index 4a12726ba..2fa046fcf 100644 --- a/docs/configuration/dynamic-settings.md +++ b/docs/configuration/dynamic-settings.md @@ -45,7 +45,7 @@ changes in the database indefinitely. ## JOBRESULT_RETENTION -Default: 0 +Default: 90 The number of days to retain job results (scripts and reports). Set this to `0` to retain job results in the database indefinitely. diff --git a/netbox/netbox/config/parameters.py b/netbox/netbox/config/parameters.py index 9bbf45ceb..68c96b38a 100644 --- a/netbox/netbox/config/parameters.py +++ b/netbox/netbox/config/parameters.py @@ -190,7 +190,7 @@ PARAMS = ( ConfigParam( name='JOBRESULT_RETENTION', label='Job result retention', - default=0, + default=90, description="Days to retain job result history (set to zero for unlimited)", field=forms.IntegerField ), From 4e493d7836e38710c07f7b2b4519df860cc2c624 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 12 Apr 2022 12:05:09 -0400 Subject: [PATCH 30/38] Changelog for #8920, #8956 --- docs/release-notes/version-3.2.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index a7cccf946..d3af481d7 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -5,6 +5,8 @@ ### Enhancements * [#5479](https://github.com/netbox-community/netbox/issues/5479) - Allow custom job timeouts for scripts & reports +* [#8920](https://github.com/netbox-community/netbox/issues/8920) - Limit number of non-racked devices displayed +* [#8956](https://github.com/netbox-community/netbox/issues/8956) - Retain old script/report results for configured lifetime * [#8973](https://github.com/netbox-community/netbox/issues/8973) - Display VLAN group count under site view * [#9081](https://github.com/netbox-community/netbox/issues/9081) - Add `fhrpgroup_id` filter for IP addresses * [#9099](https://github.com/netbox-community/netbox/issues/9099) - Enable display of installed module serial & asset tag in module bays list From d35cd187453cdeb4e57357b252ae95e7048abbf6 Mon Sep 17 00:00:00 2001 From: Joe Izzard Date: Tue, 12 Apr 2022 17:06:33 +0100 Subject: [PATCH 31/38] fix: standardisation --- netbox/dcim/choices.py | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index 1bfbcbc94..b0aa1c60c 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -345,10 +345,10 @@ class PowerPortTypeChoices(ChoiceSet): TYPE_DC = 'dc-terminal' # Proprietary TYPE_SAF_D_GRID = 'saf-d-grid' - TYPE_NEUTRIK_POWERCON = 'neutrik-powercon' + TYPE_NEUTRIK_POWERCON_20A = 'neutrik-powercon-20' TYPE_NEUTRIK_POWERCON_32A = 'neutrik-powercon-32' - TYPE_NEUTRIK_TRUE1 = 'neutrik-true1' - TYPE_NEUTRIK_TRUE1_TOP = 'neutrik-true1-top' + TYPE_NEUTRIK_POWERCON_TRUE1 = 'neutrik-powercon-true1' + TYPE_NEUTRIK_POWERCON_TRUE1_TOP = 'neutrik-powercon-true1-top' # Other TYPE_HARDWIRED = 'hardwired' @@ -460,10 +460,10 @@ class PowerPortTypeChoices(ChoiceSet): )), ('Proprietary', ( (TYPE_SAF_D_GRID, 'Saf-D-Grid'), - (TYPE_NEUTRIK_POWERCON, 'Neutrik powerCon'), - (TYPE_NEUTRIK_POWERCON_32A, 'Neutrik powerCon (32A)'), - (TYPE_NEUTRIK_TRUE1, 'Neutrik powerCon TRUE1'), - (TYPE_NEUTRIK_TRUE1_TOP, 'Neutrik powerCon TRUE1 TOP'), + (TYPE_NEUTRIK_POWERCON_20A, 'Neutrik powerCON (20A)'), + (TYPE_NEUTRIK_POWERCON_32A, 'Neutrik powerCON (32A)'), + (TYPE_NEUTRIK_POWERCON_TRUE1, 'Neutrik powerCON TRUE1'), + (TYPE_NEUTRIK_POWERCON_TRUE1_TOP, 'Neutrik powerCON TRUE1 TOP'), )), ('Other', ( (TYPE_HARDWIRED, 'Hardwired'), @@ -569,10 +569,10 @@ class PowerOutletTypeChoices(ChoiceSet): # Proprietary TYPE_HDOT_CX = 'hdot-cx' TYPE_SAF_D_GRID = 'saf-d-grid' - TYPE_NEUTRIK_POWERCON = 'neutrik-powercon' - TYPE_NEUTRIK_POWERCON_32A = 'neutrik-powercon-32' - TYPE_NEUTRIK_TRUE1 = 'neutrik-true1' - TYPE_NEUTRIK_TRUE1_TOP = 'neutrik-true1-top' + TYPE_NEUTRIK_POWERCON_20A = 'neutrik-powercon-20a' + TYPE_NEUTRIK_POWERCON_32A = 'neutrik-powercon-32a' + TYPE_NEUTRIK_POWERCON_TRUE1 = 'neutrik-powercon-true1' + TYPE_NEUTRIK_POWERCON_TRUE1_TOP = 'neutrik-powercon-true1-top' # Other TYPE_HARDWIRED = 'hardwired' @@ -677,10 +677,10 @@ class PowerOutletTypeChoices(ChoiceSet): ('Proprietary', ( (TYPE_HDOT_CX, 'HDOT Cx'), (TYPE_SAF_D_GRID, 'Saf-D-Grid'), - (TYPE_NEUTRIK_POWERCON, 'Neutrik powerCon'), - (TYPE_NEUTRIK_POWERCON_32A, 'Neutrik powerCon (32A)'), - (TYPE_NEUTRIK_TRUE1, 'Neutrik powerCon TRUE1'), - (TYPE_NEUTRIK_TRUE1_TOP, 'Neutrik powerCon TRUE1 TOP'), + (TYPE_NEUTRIK_POWERCON_20A, 'Neutrik powerCON (20A)'), + (TYPE_NEUTRIK_POWERCON_32A, 'Neutrik powerCON (32A)'), + (TYPE_NEUTRIK_POWERCON_TRUE1, 'Neutrik powerCON TRUE1'), + (TYPE_NEUTRIK_POWERCON_TRUE1_TOP, 'Neutrik powerCON TRUE1 TOP'), )), ('Other', ( (TYPE_HARDWIRED, 'Hardwired'), From f09a5aacaed2717e05f0524bc4170784f37264fd Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 12 Apr 2022 14:14:51 -0400 Subject: [PATCH 32/38] Changelog for #9110 --- docs/release-notes/version-3.2.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index d3af481d7..d4efe536f 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -10,6 +10,7 @@ * [#8973](https://github.com/netbox-community/netbox/issues/8973) - Display VLAN group count under site view * [#9081](https://github.com/netbox-community/netbox/issues/9081) - Add `fhrpgroup_id` filter for IP addresses * [#9099](https://github.com/netbox-community/netbox/issues/9099) - Enable display of installed module serial & asset tag in module bays list +* [#9110](https://github.com/netbox-community/netbox/issues/9110) - Add Neutrik proprietary power connectors ### Bug Fixes From 01ba1b8c036a021ba611716e18c8bb792689cd8d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 13 Apr 2022 13:43:18 -0400 Subject: [PATCH 33/38] Fixes #9118: Fix validation error when importing VM child interfaces --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/forms/bulk_import.py | 10 +++++----- netbox/virtualization/forms/bulk_import.py | 12 ++++++++++++ 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index d4efe536f..c5c20379a 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -23,6 +23,7 @@ * [#9096](https://github.com/netbox-community/netbox/issues/9096) - Remove duplicate filter tag when filtering by "none" * [#9100](https://github.com/netbox-community/netbox/issues/9100) - Include position field in module type YAML export * [#9116](https://github.com/netbox-community/netbox/issues/9116) - `assigned_to_interface` filter for IP addresses should not match FHRP group assignments +* [#9118](https://github.com/netbox-community/netbox/issues/9118) - Fix validation error when importing VM child interfaces --- diff --git a/netbox/dcim/forms/bulk_import.py b/netbox/dcim/forms/bulk_import.py index d9c738cc2..b28c16fad 100644 --- a/netbox/dcim/forms/bulk_import.py +++ b/netbox/dcim/forms/bulk_import.py @@ -651,11 +651,11 @@ class InterfaceCSVForm(NetBoxModelCSVForm): super().__init__(data, *args, **kwargs) if data: - # Limit interface choices for parent, bridge and lag to device only - params = {} - if data.get('device'): - params[f"device__{self.fields['device'].to_field_name}"] = data.get('device') - if params: + # Limit choices for parent, bridge, and LAG interfaces to the assigned device + if device := data.get('device'): + params = { + f"device__{self.fields['device'].to_field_name}": device + } self.fields['parent'].queryset = self.fields['parent'].queryset.filter(**params) self.fields['bridge'].queryset = self.fields['bridge'].queryset.filter(**params) self.fields['lag'].queryset = self.fields['lag'].queryset.filter(**params) diff --git a/netbox/virtualization/forms/bulk_import.py b/netbox/virtualization/forms/bulk_import.py index b0315dd95..eab6fc9e7 100644 --- a/netbox/virtualization/forms/bulk_import.py +++ b/netbox/virtualization/forms/bulk_import.py @@ -136,6 +136,18 @@ class VMInterfaceCSVForm(NetBoxModelCSVForm): 'vrf', ) + def __init__(self, data=None, *args, **kwargs): + super().__init__(data, *args, **kwargs) + + if data: + # Limit interface choices for parent & bridge interfaces to the assigned VM + if virtual_machine := data.get('virtual_machine'): + params = { + f"virtual_machine__{self.fields['virtual_machine'].to_field_name}": virtual_machine + } + self.fields['parent'].queryset = self.fields['parent'].queryset.filter(**params) + self.fields['bridge'].queryset = self.fields['bridge'].queryset.filter(**params) + def clean_enabled(self): # Make sure enabled is True when it's not included in the uploaded data if 'enabled' not in self.data: From 1a374a1669d6d0cb90d2e932ddf7cd8666b997d4 Mon Sep 17 00:00:00 2001 From: Tyler Bigler Date: Thu, 14 Apr 2022 00:58:17 -0400 Subject: [PATCH 34/38] Add filters to VLAN selection group --- netbox/wireless/forms/models.py | 61 ++++++++++++++++++++++++++++++--- 1 file changed, 56 insertions(+), 5 deletions(-) diff --git a/netbox/wireless/forms/models.py b/netbox/wireless/forms/models.py index 64c9e96ef..7c5c048d6 100644 --- a/netbox/wireless/forms/models.py +++ b/netbox/wireless/forms/models.py @@ -1,6 +1,6 @@ -from dcim.models import Device, Interface, Location, Site +from dcim.models import Device, Interface, Location, Region, Site, SiteGroup from extras.models import Tag -from ipam.models import VLAN +from ipam.models import VLAN, VLANGroup from netbox.forms import NetBoxModelForm from utilities.forms import DynamicModelChoiceField, DynamicModelMultipleChoiceField, SlugField, StaticSelect from wireless.models import * @@ -31,22 +31,73 @@ class WirelessLANForm(NetBoxModelForm): queryset=WirelessLANGroup.objects.all(), required=False ) + + region = DynamicModelChoiceField( + queryset=Region.objects.all(), + required=False, + initial_params={ + 'sites': '$site' + } + ) + site_group = DynamicModelChoiceField( + queryset=SiteGroup.objects.all(), + required=False, + initial_params={ + 'sites': '$site' + } + ) + site = DynamicModelChoiceField( + queryset=Site.objects.all(), + required=False, + null_option='None', + query_params={ + 'region_id': '$region', + 'group_id': '$site_group', + } + ) + vlan_group = DynamicModelChoiceField( + queryset=VLANGroup.objects.all(), + required=False, + label='VLAN group', + null_option='None', + query_params={ + 'site': '$site' + }, + initial_params={ + 'vlans': '$vlan' + } + ) vlan = DynamicModelChoiceField( queryset=VLAN.objects.all(), required=False, - label='VLAN' + label='VLAN', + query_params={ + 'site_id': '$site', + 'group_id': '$vlan_group', + } ) fieldsets = ( ('Wireless LAN', ('ssid', 'group', 'description', 'tags')), - ('VLAN', ('vlan',)), + ('VLAN', ('region', 'site_group', 'site', 'vlan_group', 'vlan',)), ('Authentication', ('auth_type', 'auth_cipher', 'auth_psk')), ) class Meta: model = WirelessLAN fields = [ - 'ssid', 'group', 'description', 'vlan', 'auth_type', 'auth_cipher', 'auth_psk', 'tags', + 'ssid', + 'group', + 'description', + 'region', + 'site_group', + 'site', + 'vlan_group', + 'vlan', + 'auth_type', + 'auth_cipher', + 'auth_psk', + 'tags', ] widgets = { 'auth_type': StaticSelect, From 78836389f0b8b7b074be8bd93419cf0e115bdfd4 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 14 Apr 2022 08:37:58 -0400 Subject: [PATCH 35/38] Changelog for #8543 & cleanup --- docs/release-notes/version-3.2.md | 1 + netbox/wireless/forms/models.py | 17 +++-------------- 2 files changed, 4 insertions(+), 14 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index c5c20379a..43c6469ba 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -5,6 +5,7 @@ ### Enhancements * [#5479](https://github.com/netbox-community/netbox/issues/5479) - Allow custom job timeouts for scripts & reports +* [#8543](https://github.com/netbox-community/netbox/issues/8543) - Improve filtering for wireless LAN VLAN selection * [#8920](https://github.com/netbox-community/netbox/issues/8920) - Limit number of non-racked devices displayed * [#8956](https://github.com/netbox-community/netbox/issues/8956) - Retain old script/report results for configured lifetime * [#8973](https://github.com/netbox-community/netbox/issues/8973) - Display VLAN group count under site view diff --git a/netbox/wireless/forms/models.py b/netbox/wireless/forms/models.py index 7c5c048d6..6d7dc84a9 100644 --- a/netbox/wireless/forms/models.py +++ b/netbox/wireless/forms/models.py @@ -1,8 +1,7 @@ from dcim.models import Device, Interface, Location, Region, Site, SiteGroup -from extras.models import Tag from ipam.models import VLAN, VLANGroup from netbox.forms import NetBoxModelForm -from utilities.forms import DynamicModelChoiceField, DynamicModelMultipleChoiceField, SlugField, StaticSelect +from utilities.forms import DynamicModelChoiceField, SlugField, StaticSelect from wireless.models import * __all__ = ( @@ -86,18 +85,8 @@ class WirelessLANForm(NetBoxModelForm): class Meta: model = WirelessLAN fields = [ - 'ssid', - 'group', - 'description', - 'region', - 'site_group', - 'site', - 'vlan_group', - 'vlan', - 'auth_type', - 'auth_cipher', - 'auth_psk', - 'tags', + 'ssid', 'group', 'description', 'region', 'site_group', 'site', 'vlan_group', 'vlan', 'auth_type', + 'auth_cipher', 'auth_psk', 'tags', ] widgets = { 'auth_type': StaticSelect, From d6df6b444f1bcc1b77b1b6ae6e726f3024e0abd4 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 14 Apr 2022 10:54:07 -0400 Subject: [PATCH 36/38] Closes #9123: Improve appearance of SSO login providers --- docs/release-notes/version-3.2.md | 1 + netbox/netbox/authentication.py | 39 ++++++++++++++++++++++++++++++- netbox/templates/login.html | 10 ++++---- netbox/users/views.py | 7 +++++- 4 files changed, 51 insertions(+), 6 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 43c6469ba..33cfd140d 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -12,6 +12,7 @@ * [#9081](https://github.com/netbox-community/netbox/issues/9081) - Add `fhrpgroup_id` filter for IP addresses * [#9099](https://github.com/netbox-community/netbox/issues/9099) - Enable display of installed module serial & asset tag in module bays list * [#9110](https://github.com/netbox-community/netbox/issues/9110) - Add Neutrik proprietary power connectors +* [#9123](https://github.com/netbox-community/netbox/issues/9123) - Improve appearance of SSO login providers ### Bug Fixes diff --git a/netbox/netbox/authentication.py b/netbox/netbox/authentication.py index acb04ce34..6367d6d70 100644 --- a/netbox/netbox/authentication.py +++ b/netbox/netbox/authentication.py @@ -13,8 +13,45 @@ from utilities.permissions import permission_is_exempt, resolve_permission, reso UserModel = get_user_model() +AUTH_BACKEND_ATTRS = { + # backend name: title, MDI icon name + 'amazon': ('Amazon AWS', 'aws'), + 'apple': ('Apple', 'apple'), + 'auth0': ('Auth0', None), + 'azuread-oauth2': ('Microsoft Azure AD', 'microsoft'), + 'azuread-b2c-oauth2': ('Microsoft Azure AD', 'microsoft'), + 'azuread-tenant-oauth2': ('Microsoft Azure AD', 'microsoft'), + 'bitbucket': ('BitBucket', 'bitbucket'), + 'bitbucket-oauth2': ('BitBucket', 'bitbucket'), + 'digitalocean': ('DigitalOcean', 'digital-ocean'), + 'docker': ('Docker', 'docker'), + 'github': ('GitHub', 'docker'), + 'github-app': ('GitHub', 'github'), + 'github-org': ('GitHub', 'github'), + 'github-team': ('GitHub', 'github'), + 'github-enterprise': ('GitHub Enterprise', 'github'), + 'github-enterprise-org': ('GitHub Enterprise', 'github'), + 'github-enterprise-team': ('GitHub Enterprise', 'github'), + 'gitlab': ('GitLab', 'gitlab'), + 'google-oauth2': ('Google', 'google'), + 'google-openidconnect': ('Google', 'google'), + 'hubspot': ('HubSpot', 'hubspot'), + 'keycloak': ('Keycloak', None), + 'microsoft-graph': ('Microsoft Graph', 'microsoft'), + 'okta': ('Okta', None), + 'salesforce-oauth2': ('Salesforce', 'salesforce'), +} -class ObjectPermissionMixin(): + +def get_auth_backend_display(name): + """ + Return the user-friendly name and icon name for a remote authentication backend, if known. Defaults to the + raw backend name and no icon. + """ + return AUTH_BACKEND_ATTRS.get(name, (name, None)) + + +class ObjectPermissionMixin: def get_all_permissions(self, user_obj, obj=None): if not user_obj.is_active or user_obj.is_anonymous: diff --git a/netbox/templates/login.html b/netbox/templates/login.html index 9cf882e9c..f4dd9c696 100644 --- a/netbox/templates/login.html +++ b/netbox/templates/login.html @@ -39,11 +39,13 @@
- {# TODO: Improve the design & layout #} {% if auth_backends %} -
Or use an SSO provider:
- {% for name, backend in auth_backends.items %} -

{{ name }}

+
Or use a single sign-on (SSO) provider:
+ {% for name, display in auth_backends.items %} +
+ {% if display.1 %}{% endif %} + {{ display.0 }} +
{% endfor %} {% endif %} diff --git a/netbox/users/views.py b/netbox/users/views.py index 04c0c5155..6a923e77e 100644 --- a/netbox/users/views.py +++ b/netbox/users/views.py @@ -16,6 +16,7 @@ from social_core.backends.utils import load_backends from extras.models import ObjectChange from extras.tables import ObjectChangeTable +from netbox.authentication import get_auth_backend_display from netbox.config import get_config from utilities.forms import ConfirmationForm from .forms import LoginForm, PasswordChangeForm, TokenForm, UserConfigForm @@ -43,9 +44,13 @@ class LoginView(View): logger = logging.getLogger('netbox.auth.login') return self.redirect_to_next(request, logger) + auth_backends = { + name: get_auth_backend_display(name) for name in load_backends(settings.AUTHENTICATION_BACKENDS).keys() + } + return render(request, self.template_name, { 'form': form, - 'auth_backends': load_backends(settings.AUTHENTICATION_BACKENDS), + 'auth_backends': auth_backends, }) def post(self, request): From fa5cf665ce7e36a5a8abd6c43b558365f3c4fe41 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 14 Apr 2022 11:13:04 -0400 Subject: [PATCH 37/38] Fixes #9128: Resolve component labels per module bay position when installing modules --- docs/release-notes/version-3.2.md | 1 + .../dcim/models/device_component_templates.py | 19 ++++++++++++------- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 33cfd140d..e73c3048e 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -26,6 +26,7 @@ * [#9100](https://github.com/netbox-community/netbox/issues/9100) - Include position field in module type YAML export * [#9116](https://github.com/netbox-community/netbox/issues/9116) - `assigned_to_interface` filter for IP addresses should not match FHRP group assignments * [#9118](https://github.com/netbox-community/netbox/issues/9118) - Fix validation error when importing VM child interfaces +* [#9128](https://github.com/netbox-community/netbox/issues/9128) - Resolve component labels per module bay position when installing modules --- diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index b363d6ea4..647abe148 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -124,6 +124,11 @@ class ModularComponentTemplateModel(ComponentTemplateModel): return self.name.replace('{module}', module.module_bay.position) return self.name + def resolve_label(self, module): + if module: + return self.label.replace('{module}', module.module_bay.position) + return self.label + class ConsolePortTemplate(ModularComponentTemplateModel): """ @@ -147,7 +152,7 @@ class ConsolePortTemplate(ModularComponentTemplateModel): def instantiate(self, **kwargs): return self.component_model( name=self.resolve_name(kwargs.get('module')), - label=self.label, + label=self.resolve_label(kwargs.get('module')), type=self.type, **kwargs ) @@ -175,7 +180,7 @@ class ConsoleServerPortTemplate(ModularComponentTemplateModel): def instantiate(self, **kwargs): return self.component_model( name=self.resolve_name(kwargs.get('module')), - label=self.label, + label=self.resolve_label(kwargs.get('module')), type=self.type, **kwargs ) @@ -215,7 +220,7 @@ class PowerPortTemplate(ModularComponentTemplateModel): def instantiate(self, **kwargs): return self.component_model( name=self.resolve_name(kwargs.get('module')), - label=self.label, + label=self.resolve_label(kwargs.get('module')), type=self.type, maximum_draw=self.maximum_draw, allocated_draw=self.allocated_draw, @@ -286,7 +291,7 @@ class PowerOutletTemplate(ModularComponentTemplateModel): power_port = None return self.component_model( name=self.resolve_name(kwargs.get('module')), - label=self.label, + label=self.resolve_label(kwargs.get('module')), type=self.type, power_port=power_port, feed_leg=self.feed_leg, @@ -326,7 +331,7 @@ class InterfaceTemplate(ModularComponentTemplateModel): def instantiate(self, **kwargs): return self.component_model( name=self.resolve_name(kwargs.get('module')), - label=self.label, + label=self.resolve_label(kwargs.get('module')), type=self.type, mgmt_only=self.mgmt_only, **kwargs @@ -397,7 +402,7 @@ class FrontPortTemplate(ModularComponentTemplateModel): rear_port = None return self.component_model( name=self.resolve_name(kwargs.get('module')), - label=self.label, + label=self.resolve_label(kwargs.get('module')), type=self.type, color=self.color, rear_port=rear_port, @@ -437,7 +442,7 @@ class RearPortTemplate(ModularComponentTemplateModel): def instantiate(self, **kwargs): return self.component_model( name=self.resolve_name(kwargs.get('module')), - label=self.label, + label=self.resolve_label(kwargs.get('module')), type=self.type, color=self.color, positions=self.positions, From fdc018d8096355f87615318c6ab2b611777eebed Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 14 Apr 2022 13:58:18 -0400 Subject: [PATCH 38/38] Release v3.2.1 --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 2 +- docs/release-notes/version-3.2.md | 2 +- netbox/netbox/settings.py | 2 +- requirements.txt | 6 +++--- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 65097e9be..b5de9bfee 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -14,7 +14,7 @@ body: attributes: label: NetBox version description: What version of NetBox are you currently running? - placeholder: v3.2.0 + placeholder: v3.2.1 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 1ce4c0a11..138e0f9b4 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -14,7 +14,7 @@ body: attributes: label: NetBox version description: What version of NetBox are you currently running? - placeholder: v3.2.0 + placeholder: v3.2.1 validations: required: true - type: dropdown diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index e73c3048e..cd19a6d65 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -1,6 +1,6 @@ # NetBox v3.2 -## v3.2.1 (FUTURE) +## v3.2.1 (2022-04-14) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 04c0e9c3d..4e3017d8d 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -26,7 +26,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.1-dev' +VERSION = '3.2.1' # Hostname HOSTNAME = platform.node() diff --git a/requirements.txt b/requirements.txt index ce0e52087..35867410b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -Django==4.0.3 +Django==4.0.4 django-cors-headers==3.11.0 django-debug-toolbar==3.2.4 django-filter==21.1 @@ -18,7 +18,7 @@ gunicorn==20.1.0 Jinja2==3.0.3 Markdown==3.3.6 markdown-include==0.6.0 -mkdocs-material==8.2.8 +mkdocs-material==8.2.9 mkdocstrings==0.17.0 netaddr==0.8.0 Pillow==9.1.0 @@ -27,7 +27,7 @@ PyYAML==6.0 social-auth-app-django==5.0.0 social-auth-core==4.2.0 svgwrite==1.4.2 -tablib==3.2.0 +tablib==3.2.1 tzdata==2022.1 # Workaround for #7401