From 03535ce50b7063414dea71f753305d27506a646a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 8 Apr 2022 16:00:33 -0400 Subject: [PATCH 001/593] Closes #8995: Enable arbitrary ordering of REST API results --- docs/release-notes/version-3.3.md | 7 ++++ docs/rest-api/filtering.md | 20 +++++++++++ netbox/netbox/settings.py | 3 +- netbox/utilities/tests/test_api.py | 58 ++++++++++++++++++++++++++++++ 4 files changed, 87 insertions(+), 1 deletion(-) create mode 100644 docs/release-notes/version-3.3.md diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md new file mode 100644 index 000000000..de59d0327 --- /dev/null +++ b/docs/release-notes/version-3.3.md @@ -0,0 +1,7 @@ +# NetBox v3.3 + +## v3.3.0 (FUTURE) + +### Enhancements + +* [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results diff --git a/docs/rest-api/filtering.md b/docs/rest-api/filtering.md index 45dfcfa36..7ddda6f3c 100644 --- a/docs/rest-api/filtering.md +++ b/docs/rest-api/filtering.md @@ -106,3 +106,23 @@ expression: `n`. Here is an example of a lookup expression on a foreign key, it ```no-highlight GET /api/ipam/vlans/?group_id__n=3203 ``` + +## Ordering Objects + +To order results by a particular field, include the `ordering` query parameter. For example, order the list of sites according to their facility values: + +```no-highlight +GET /api/dcim/sites/?ordering=facility +``` + +To invert the ordering, prepend a hyphen to the field name: + +```no-highlight +GET /api/dcim/sites/?ordering=-facility +``` + +Multiple fields can be specified by separating the field names with a comma. For example: + +```no-highlight +GET /api/dcim/sites/?ordering=facility,-name +``` diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 04c0e9c3d..0db41373f 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.3.0-dev' # Hostname HOSTNAME = platform.node() @@ -469,6 +469,7 @@ REST_FRAMEWORK = { ), 'DEFAULT_FILTER_BACKENDS': ( 'django_filters.rest_framework.DjangoFilterBackend', + 'rest_framework.filters.OrderingFilter', ), 'DEFAULT_METADATA_CLASS': 'netbox.api.metadata.BulkOperationMetadata', 'DEFAULT_PAGINATION_CLASS': 'netbox.api.pagination.OptionalLimitOffsetPagination', diff --git a/netbox/utilities/tests/test_api.py b/netbox/utilities/tests/test_api.py index 1171bd496..e341442be 100644 --- a/netbox/utilities/tests/test_api.py +++ b/netbox/utilities/tests/test_api.py @@ -176,6 +176,64 @@ class APIPaginationTestCase(APITestCase): self.assertEqual(len(response.data['results']), 100) +class APIOrderingTestCase(APITestCase): + user_permissions = ('dcim.view_site',) + + @classmethod + def setUpTestData(cls): + cls.url = reverse('dcim-api:site-list') + + sites = ( + Site(name='Site 1', slug='site-1', facility='C', description='Z'), + Site(name='Site 2', slug='site-2', facility='C', description='Y'), + Site(name='Site 3', slug='site-3', facility='B', description='X'), + Site(name='Site 4', slug='site-4', facility='B', description='W'), + Site(name='Site 5', slug='site-5', facility='A', description='V'), + Site(name='Site 6', slug='site-6', facility='A', description='U'), + ) + Site.objects.bulk_create(sites) + + def test_default_order(self): + response = self.client.get(self.url, format='json', **self.header) + + self.assertHttpStatus(response, status.HTTP_200_OK) + self.assertEqual(response.data['count'], 6) + self.assertListEqual( + [s['name'] for s in response.data['results']], + ['Site 1', 'Site 2', 'Site 3', 'Site 4', 'Site 5', 'Site 6'] + ) + + def test_order_single_field(self): + response = self.client.get(f'{self.url}?ordering=description', format='json', **self.header) + + self.assertHttpStatus(response, status.HTTP_200_OK) + self.assertEqual(response.data['count'], 6) + self.assertListEqual( + [s['name'] for s in response.data['results']], + ['Site 6', 'Site 5', 'Site 4', 'Site 3', 'Site 2', 'Site 1'] + ) + + def test_order_reversed(self): + response = self.client.get(f'{self.url}?ordering=-name', format='json', **self.header) + + self.assertHttpStatus(response, status.HTTP_200_OK) + self.assertEqual(response.data['count'], 6) + self.assertListEqual( + [s['name'] for s in response.data['results']], + ['Site 6', 'Site 5', 'Site 4', 'Site 3', 'Site 2', 'Site 1'] + ) + + def test_order_multiple_fields(self): + response = self.client.get(f'{self.url}?ordering=facility,name', format='json', **self.header) + + self.assertHttpStatus(response, status.HTTP_200_OK) + self.assertEqual(response.data['count'], 6) + self.assertListEqual( + [s['name'] for s in response.data['results']], + ['Site 5', 'Site 6', 'Site 3', 'Site 4', 'Site 1', 'Site 2'] + ) + + class APIDocsTestCase(TestCase): def setUp(self): From 17df8a5c4394785cb2e176788e468bd508c5a169 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 15 Apr 2022 14:45:28 -0400 Subject: [PATCH 002/593] Closes #8495: Enable custom field grouping --- docs/release-notes/version-3.3.md | 6 ++ netbox/extras/api/serializers.py | 4 +- netbox/extras/filtersets.py | 3 +- netbox/extras/forms/bulk_edit.py | 5 +- netbox/extras/forms/bulk_import.py | 4 +- netbox/extras/forms/filtersets.py | 5 +- netbox/extras/forms/models.py | 4 +- .../migrations/0074_customfield_group_name.py | 22 +++++ netbox/extras/models/customfields.py | 7 +- netbox/extras/tables/tables.py | 4 +- netbox/netbox/models/features.py | 12 +++ netbox/templates/extras/customfield.html | 4 + .../templates/inc/panels/custom_fields.html | 95 ++++++++++--------- 13 files changed, 119 insertions(+), 56 deletions(-) create mode 100644 netbox/extras/migrations/0074_customfield_group_name.py diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index de59d0327..1dd19a5c0 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -4,4 +4,10 @@ ### Enhancements +* [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results + +### REST API Changes + +* extras.CustomField + * Added `group_name` field diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index e05d4083c..eed7f7603 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -88,8 +88,8 @@ class CustomFieldSerializer(ValidatedModelSerializer): class Meta: model = CustomField fields = [ - 'id', 'url', 'display', 'content_types', 'type', 'object_type', 'data_type', 'name', 'label', 'description', - 'required', 'filter_logic', 'default', 'weight', 'validation_minimum', 'validation_maximum', + 'id', 'url', 'display', 'content_types', 'type', 'object_type', 'data_type', 'name', 'label', 'group_name', + 'description', 'required', 'filter_logic', 'default', 'weight', 'validation_minimum', 'validation_maximum', 'validation_regex', 'choices', 'created', 'last_updated', ] diff --git a/netbox/extras/filtersets.py b/netbox/extras/filtersets.py index 25477fbda..467ae23af 100644 --- a/netbox/extras/filtersets.py +++ b/netbox/extras/filtersets.py @@ -62,7 +62,7 @@ class CustomFieldFilterSet(BaseFilterSet): class Meta: model = CustomField - fields = ['id', 'content_types', 'name', 'required', 'filter_logic', 'weight', 'description'] + fields = ['id', 'content_types', 'name', 'group_name', 'required', 'filter_logic', 'weight', 'description'] def search(self, queryset, name, value): if not value.strip(): @@ -70,6 +70,7 @@ class CustomFieldFilterSet(BaseFilterSet): return queryset.filter( Q(name__icontains=value) | Q(label__icontains=value) | + Q(group_name__icontains=value) | Q(description__icontains=value) ) diff --git a/netbox/extras/forms/bulk_edit.py b/netbox/extras/forms/bulk_edit.py index e16f8aeac..b722bd751 100644 --- a/netbox/extras/forms/bulk_edit.py +++ b/netbox/extras/forms/bulk_edit.py @@ -24,6 +24,9 @@ class CustomFieldBulkEditForm(BulkEditForm): queryset=CustomField.objects.all(), widget=forms.MultipleHiddenInput ) + group_name = forms.CharField( + required=False + ) description = forms.CharField( required=False ) @@ -35,7 +38,7 @@ class CustomFieldBulkEditForm(BulkEditForm): required=False ) - nullable_fields = ('description',) + nullable_fields = ('group_name', 'description',) class CustomLinkBulkEditForm(BulkEditForm): diff --git a/netbox/extras/forms/bulk_import.py b/netbox/extras/forms/bulk_import.py index fa6d8af55..dabf2f811 100644 --- a/netbox/extras/forms/bulk_import.py +++ b/netbox/extras/forms/bulk_import.py @@ -36,8 +36,8 @@ class CustomFieldCSVForm(CSVModelForm): class Meta: model = CustomField fields = ( - 'name', 'label', 'type', 'content_types', 'required', 'description', 'weight', 'filter_logic', 'default', - 'choices', 'weight', 'validation_minimum', 'validation_maximum', 'validation_regex', + 'name', 'label', 'group_name', 'type', 'content_types', 'required', 'description', 'weight', 'filter_logic', + 'default', 'choices', 'weight', 'validation_minimum', 'validation_maximum', 'validation_regex', ) diff --git a/netbox/extras/forms/filtersets.py b/netbox/extras/forms/filtersets.py index 5d66c8be8..1710ecb89 100644 --- a/netbox/extras/forms/filtersets.py +++ b/netbox/extras/forms/filtersets.py @@ -32,7 +32,7 @@ __all__ = ( class CustomFieldFilterForm(FilterForm): fieldsets = ( (None, ('q',)), - ('Attributes', ('type', 'content_types', 'weight', 'required')), + ('Attributes', ('content_types', 'type', 'group_name', 'weight', 'required')), ) content_types = ContentTypeMultipleChoiceField( queryset=ContentType.objects.all(), @@ -44,6 +44,9 @@ class CustomFieldFilterForm(FilterForm): required=False, label=_('Field type') ) + group_name = forms.CharField( + required=False + ) weight = forms.IntegerField( required=False ) diff --git a/netbox/extras/forms/models.py b/netbox/extras/forms/models.py index 112911f42..b07853f86 100644 --- a/netbox/extras/forms/models.py +++ b/netbox/extras/forms/models.py @@ -40,7 +40,9 @@ class CustomFieldForm(BootstrapMixin, forms.ModelForm): ) fieldsets = ( - ('Custom Field', ('content_types', 'name', 'label', 'type', 'object_type', 'weight', 'required', 'description')), + ('Custom Field', ( + 'content_types', 'name', 'label', 'group_name', 'type', 'object_type', 'weight', 'required', 'description', + )), ('Behavior', ('filter_logic',)), ('Values', ('default', 'choices')), ('Validation', ('validation_minimum', 'validation_maximum', 'validation_regex')), diff --git a/netbox/extras/migrations/0074_customfield_group_name.py b/netbox/extras/migrations/0074_customfield_group_name.py new file mode 100644 index 000000000..e1be76b1f --- /dev/null +++ b/netbox/extras/migrations/0074_customfield_group_name.py @@ -0,0 +1,22 @@ +# Generated by Django 4.0.4 on 2022-04-15 17:13 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('extras', '0073_journalentry_tags_custom_fields'), + ] + + operations = [ + migrations.AlterModelOptions( + name='customfield', + options={'ordering': ['group_name', 'weight', 'name']}, + ), + migrations.AddField( + model_name='customfield', + name='group_name', + field=models.CharField(blank=True, max_length=50), + ), + ] diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index 49afe1bba..55caa4a70 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -79,6 +79,11 @@ class CustomField(ExportTemplatesMixin, WebhooksMixin, ChangeLoggedModel): help_text='Name of the field as displayed to users (if not provided, ' 'the field\'s name will be used)' ) + group_name = models.CharField( + max_length=50, + blank=True, + help_text="Custom fields within the same group will be displayed together" + ) description = models.CharField( max_length=200, blank=True @@ -134,7 +139,7 @@ class CustomField(ExportTemplatesMixin, WebhooksMixin, ChangeLoggedModel): objects = CustomFieldManager() class Meta: - ordering = ['weight', 'name'] + ordering = ['group_name', 'weight', 'name'] def __str__(self): return self.label or self.name.replace('_', ' ').capitalize() diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py index a13054d56..1a0f5d58a 100644 --- a/netbox/extras/tables/tables.py +++ b/netbox/extras/tables/tables.py @@ -32,10 +32,10 @@ class CustomFieldTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = CustomField fields = ( - 'pk', 'id', 'name', 'content_types', 'label', 'type', 'required', 'weight', 'default', + 'pk', 'id', 'name', 'content_types', 'label', 'type', 'group_name', 'required', 'weight', 'default', 'description', 'filter_logic', 'choices', 'created', 'last_updated', ) - default_columns = ('pk', 'name', 'content_types', 'label', 'type', 'required', 'description') + default_columns = ('pk', 'name', 'content_types', 'label', 'group_name', 'type', 'required', 'description') # diff --git a/netbox/netbox/models/features.py b/netbox/netbox/models/features.py index e443dde5f..4bd1b0e9c 100644 --- a/netbox/netbox/models/features.py +++ b/netbox/netbox/models/features.py @@ -1,3 +1,5 @@ +from collections import defaultdict + from django.contrib.contenttypes.fields import GenericRelation from django.db.models.signals import class_prepared from django.dispatch import receiver @@ -117,6 +119,16 @@ class CustomFieldsMixin(models.Model): return data + def get_custom_fields_by_group(self): + """ + Return a dictionary of custom field/value mappings organized by group. + """ + grouped_custom_fields = defaultdict(dict) + for cf, value in self.get_custom_fields().items(): + grouped_custom_fields[cf.group_name][cf] = value + + return dict(grouped_custom_fields) + def clean(self): super().clean() from extras.models import CustomField diff --git a/netbox/templates/extras/customfield.html b/netbox/templates/extras/customfield.html index 9be7a485a..0d9856938 100644 --- a/netbox/templates/extras/customfield.html +++ b/netbox/templates/extras/customfield.html @@ -19,6 +19,10 @@ Label {{ object.label|placeholder }} + + Group Name + {{ object.group_name|placeholder }} + Type {{ object.get_type_display }} diff --git a/netbox/templates/inc/panels/custom_fields.html b/netbox/templates/inc/panels/custom_fields.html index 32e586d3a..b18d44030 100644 --- a/netbox/templates/inc/panels/custom_fields.html +++ b/netbox/templates/inc/panels/custom_fields.html @@ -1,49 +1,54 @@ {% load helpers %} -{% with custom_fields=object.get_custom_fields %} - {% if custom_fields %} -
-
Custom Fields
-
- - {% for field, value in custom_fields.items %} - - - - +{% with custom_fields=object.get_custom_fields_by_group %} + {% if custom_fields %} +
+
Custom Fields
+
+ {% for group_name, fields in custom_fields.items %} + {% if group_name %} +
{{ group_name }}
+ {% endif %} +
- {{ field }} - - {% if field.type == 'integer' and value is not None %} - {{ value }} - {% elif field.type == 'longtext' and value %} - {{ value|markdown }} - {% elif field.type == 'boolean' and value == True %} - {% checkmark value true="True" %} - {% elif field.type == 'boolean' and value == False %} - {% checkmark value false="False" %} - {% elif field.type == 'url' and value %} - {{ value|truncatechars:70 }} - {% elif field.type == 'json' and value %} - 
{{ value|json }}
- {% elif field.type == 'multiselect' and value %} - {{ value|join:", " }} - {% elif field.type == 'object' and value %} - {{ value|linkify }} - {% elif field.type == 'multiobject' and value %} - {% for obj in value %} - {{ obj|linkify }}{% if not forloop.last %}
{% endif %} - {% endfor %} - {% elif value %} - {{ value }} - {% elif field.required %} - Not defined - {% else %} - — - {% endif %} -
+ {% for field, value in fields.items %} + + +
+ {{ field }} + + {% if field.type == 'integer' and value is not None %} + {{ value }} + {% elif field.type == 'longtext' and value %} + {{ value|markdown }} + {% elif field.type == 'boolean' and value == True %} + {% checkmark value true="True" %} + {% elif field.type == 'boolean' and value == False %} + {% checkmark value false="False" %} + {% elif field.type == 'url' and value %} + {{ value|truncatechars:70 }} + {% elif field.type == 'json' and value %} + 
{{ value|json }}
+ {% elif field.type == 'multiselect' and value %} + {{ value|join:", " }} + {% elif field.type == 'object' and value %} + {{ value|linkify }} + {% elif field.type == 'multiobject' and value %} + {% for obj in value %} + {{ obj|linkify }}{% if not forloop.last %}
{% endif %} {% endfor %} -
-
-
- {% endif %} + {% elif value %} + {{ value }} + {% elif field.required %} + Not defined + {% else %} + {{ ''|placeholder }} + {% endif %} + + + {% endfor %} + + {% endfor %} + + + {% endif %} {% endwith %} From 25877202983182fd12a7b6a31dedca7edf5a589c Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Tue, 19 Apr 2022 14:44:35 +0200 Subject: [PATCH 003/593] Fix 8878: Restrict API key usage by Source IP --- docs/release-notes/version-3.3.md | 1 + netbox/netbox/api/authentication.py | 26 ++++++++++++++++++ netbox/templates/users/api_tokens.html | 15 ++++++++--- netbox/users/admin/__init__.py | 6 ++++- netbox/users/admin/forms.py | 2 +- netbox/users/api/serializers.py | 2 +- netbox/users/forms.py | 10 ++++++- .../migrations/0003_token_allowed_ips.py | 20 ++++++++++++++ netbox/users/models.py | 27 +++++++++++++++++++ 9 files changed, 101 insertions(+), 8 deletions(-) create mode 100644 netbox/users/migrations/0003_token_allowed_ips.py diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 1dd19a5c0..09dcfcf22 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -6,6 +6,7 @@ * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results +* [#8878](https://github.com/netbox-community/netbox/issues/8878) - Restrict API key usage by source IP ### REST API Changes diff --git a/netbox/netbox/api/authentication.py b/netbox/netbox/api/authentication.py index 5e177bfcb..2f86a1da2 100644 --- a/netbox/netbox/api/authentication.py +++ b/netbox/netbox/api/authentication.py @@ -1,4 +1,5 @@ from django.conf import settings +from django.core.exceptions import ValidationError from rest_framework import authentication, exceptions from rest_framework.permissions import BasePermission, DjangoObjectPermissions, SAFE_METHODS @@ -11,6 +12,31 @@ class TokenAuthentication(authentication.TokenAuthentication): """ model = Token + def authenticate(self, request): + authenticationresult = super().authenticate(request) + if authenticationresult: + token_user, token = authenticationresult + + # Verify source IP is allowed + if token.allowed_ips: + # Replace 'HTTP_X_REAL_IP' with the settings variable choosen in #8867 + if 'HTTP_X_REAL_IP' in request.META: + clientip = request.META['HTTP_X_REAL_IP'].split(",")[0].strip() + http_header = 'HTTP_X_REAL_IP' + elif 'REMOTE_ADDR' in request.META: + clientip = request.META['REMOTE_ADDR'] + http_header = 'REMOTE_ADDR' + else: + raise exceptions.AuthenticationFailed(f"A HTTP header containing the SourceIP (HTTP_X_REAL_IP, REMOTE_ADDR) is missing from the request.") + + try: + if not token.validate_client_ip(clientip): + raise exceptions.AuthenticationFailed(f"Source IP {clientip} is not allowed to use this token.") + except ValidationError as ValidationErrorInfo: + raise exceptions.ValidationError(f"The value in the HTTP Header {http_header} has a ValidationError: {ValidationErrorInfo.message}") + + return authenticationresult + def authenticate_credentials(self, key): model = self.get_model() try: diff --git a/netbox/templates/users/api_tokens.html b/netbox/templates/users/api_tokens.html index 01ffec23a..360e65a67 100644 --- a/netbox/templates/users/api_tokens.html +++ b/netbox/templates/users/api_tokens.html @@ -22,11 +22,11 @@
-
+
Created
{{ token.created|annotated_date }}
-
+
Expires
{% if token.expires %} {{ token.expires|annotated_date }} @@ -34,7 +34,7 @@ Never {% endif %}
-
+
Create/Edit/Delete Operations
{% if token.write_enabled %} Enabled @@ -42,7 +42,14 @@ Disabled {% endif %}
-
+
+ Allowed Source IPs
+ {% if token.allowed_ips %} + {{ token.allowed_ips|join:', ' }} + {% else %} + Any + {% endif %} +
{% if token.description %}
{{ token.description }} {% endif %} diff --git a/netbox/users/admin/__init__.py b/netbox/users/admin/__init__.py index 1b163ed06..ede26cd1b 100644 --- a/netbox/users/admin/__init__.py +++ b/netbox/users/admin/__init__.py @@ -58,9 +58,13 @@ class UserAdmin(UserAdmin_): class TokenAdmin(admin.ModelAdmin): form = forms.TokenAdminForm list_display = [ - 'key', 'user', 'created', 'expires', 'write_enabled', 'description' + 'key', 'user', 'created', 'expires', 'write_enabled', 'description', 'list_allowed_ips' ] + def list_allowed_ips(self, obj): + return obj.allowed_ips or 'Any' + list_allowed_ips.short_description = "Allowed IPs" + # # Permissions diff --git a/netbox/users/admin/forms.py b/netbox/users/admin/forms.py index 7d0212441..bc3d44862 100644 --- a/netbox/users/admin/forms.py +++ b/netbox/users/admin/forms.py @@ -51,7 +51,7 @@ class TokenAdminForm(forms.ModelForm): class Meta: fields = [ - 'user', 'key', 'write_enabled', 'expires', 'description' + 'user', 'key', 'write_enabled', 'expires', 'description', 'allowed_ips' ] model = Token diff --git a/netbox/users/api/serializers.py b/netbox/users/api/serializers.py index d490e8fe9..4b1f5bff3 100644 --- a/netbox/users/api/serializers.py +++ b/netbox/users/api/serializers.py @@ -62,7 +62,7 @@ class TokenSerializer(ValidatedModelSerializer): class Meta: model = Token - fields = ('id', 'url', 'display', 'user', 'created', 'expires', 'key', 'write_enabled', 'description') + fields = ('id', 'url', 'display', 'user', 'created', 'expires', 'key', 'write_enabled', 'description', 'allowed_ips') def to_internal_value(self, data): if 'key' not in data: diff --git a/netbox/users/forms.py b/netbox/users/forms.py index d5e6218e5..9720f92b7 100644 --- a/netbox/users/forms.py +++ b/netbox/users/forms.py @@ -1,7 +1,9 @@ from django import forms from django.contrib.auth.forms import AuthenticationForm, PasswordChangeForm as DjangoPasswordChangeForm +from django.contrib.postgres.forms import SimpleArrayField from django.utils.html import mark_safe +from ipam.formfields import IPNetworkFormField from netbox.preferences import PREFERENCES from utilities.forms import BootstrapMixin, DateTimePicker, StaticSelect from utilities.utils import flatten_dict @@ -100,10 +102,16 @@ class TokenForm(BootstrapMixin, forms.ModelForm): help_text="If no key is provided, one will be generated automatically." ) + allowed_ips = SimpleArrayField( + base_field=IPNetworkFormField(), + required=False, + help_text='Allowed IPv4/IPv6 networks from where the token can be used. Leave blank for no restrictions. Ex: "10.1.1.0/24, 192.168.10.16/32, 2001:DB8:1::/64"', + ) + class Meta: model = Token fields = [ - 'key', 'write_enabled', 'expires', 'description', + 'key', 'write_enabled', 'expires', 'description', 'allowed_ips', ] widgets = { 'expires': DateTimePicker(), diff --git a/netbox/users/migrations/0003_token_allowed_ips.py b/netbox/users/migrations/0003_token_allowed_ips.py new file mode 100644 index 000000000..f4eaa9f96 --- /dev/null +++ b/netbox/users/migrations/0003_token_allowed_ips.py @@ -0,0 +1,20 @@ +# Generated by Django 3.2.12 on 2022-04-19 12:37 + +import django.contrib.postgres.fields +from django.db import migrations +import ipam.fields + + +class Migration(migrations.Migration): + + dependencies = [ + ('users', '0002_standardize_id_fields'), + ] + + operations = [ + migrations.AddField( + model_name='token', + name='allowed_ips', + field=django.contrib.postgres.fields.ArrayField(base_field=ipam.fields.IPNetworkField(), blank=True, null=True, size=None), + ), + ] diff --git a/netbox/users/models.py b/netbox/users/models.py index 722ec5ba6..40ff78b98 100644 --- a/netbox/users/models.py +++ b/netbox/users/models.py @@ -4,17 +4,20 @@ import os from django.contrib.auth.models import Group, User from django.contrib.contenttypes.models import ContentType from django.contrib.postgres.fields import ArrayField +from django.core.exceptions import ValidationError from django.core.validators import MinLengthValidator from django.db import models from django.db.models.signals import post_save from django.dispatch import receiver from django.utils import timezone +from ipam.fields import IPNetworkField from netbox.config import get_config from utilities.querysets import RestrictedQuerySet from utilities.utils import flatten_dict from .constants import * +import ipaddress __all__ = ( 'ObjectPermission', @@ -216,6 +219,12 @@ class Token(models.Model): max_length=200, blank=True ) + allowed_ips = ArrayField( + base_field=IPNetworkField(), + blank=True, + null=True, + help_text='Allowed IPv4/IPv6 networks from where the token can be used. Leave blank for no restrictions. Ex: "10.1.1.0/24, 192.168.10.16/32, 2001:DB8:1::/64"', + ) class Meta: pass @@ -240,6 +249,24 @@ class Token(models.Model): return False return True + def validate_client_ip(self, raw_ip_address): + """ + Checks that an IP address falls within the allowed IPs. + """ + if not self.allowed_ips: + return True + + try: + ip_address = ipaddress.ip_address(raw_ip_address) + except ValueError as e: + raise ValidationError(str(e)) + + for ip_network in self.allowed_ips: + if ip_address in ipaddress.ip_network(ip_network): + return True + + return False + # # Permissions From 086e34f728c4fb873b7e63561bc901e9954a5ec3 Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Tue, 19 Apr 2022 21:33:29 +0200 Subject: [PATCH 004/593] Updated docs relnotes to refer to 8233 --- docs/release-notes/version-3.3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 09dcfcf22..415e61963 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -6,7 +6,7 @@ * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results -* [#8878](https://github.com/netbox-community/netbox/issues/8878) - Restrict API key usage by source IP +* [#8233](https://github.com/netbox-community/netbox/issues/8233) - Restrict API key usage by source IP ### REST API Changes From fa4807be8ccf93aed93c42dbcb5231e7657c8e54 Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Tue, 19 Apr 2022 21:55:39 +0200 Subject: [PATCH 005/593] Update releasenotes --- docs/release-notes/version-3.3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 415e61963..294f8f4d7 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -6,7 +6,7 @@ * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results -* [#8233](https://github.com/netbox-community/netbox/issues/8233) - Restrict API key usage by source IP +* [#8233](https://github.com/netbox-community/netbox/issues/8233) - Restrict API key access by source IP ### REST API Changes From 61d756c7c48d67417255d3ca277c09abfe147bcc Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 29 Apr 2022 13:09:39 -0400 Subject: [PATCH 006/593] Closes #9261: NetBoxTable no longer automatically clears pre-existing calls to prefetch_related() on its queryset --- docs/release-notes/version-3.3.md | 4 ++++ netbox/netbox/tables/tables.py | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 1dd19a5c0..9b061b7d6 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -7,6 +7,10 @@ * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results +### Other Changes + +* [#9261](https://github.com/netbox-community/netbox/issues/9261) - `NetBoxTable` no longer automatically clears pre-existing calls to `prefetch_related()` on its queryset + ### REST API Changes * extras.CustomField diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index 8c5fb039c..5ebb78865 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -97,7 +97,7 @@ class BaseTable(tables.Table): break if prefetch_path: prefetch_fields.append('__'.join(prefetch_path)) - self.data.data = self.data.data.prefetch_related(None).prefetch_related(*prefetch_fields) + self.data.data = self.data.data.prefetch_related(*prefetch_fields) def _get_columns(self, visible=True): columns = [] From 2979a64ce3c0983f2aee7c7a49141bb5c092e1b1 Mon Sep 17 00:00:00 2001 From: CroogQT Date: Thu, 5 May 2022 12:11:02 -0700 Subject: [PATCH 007/593] add file, skeleton from "select all" --- netbox/project-static/src/buttons/selectMultiple.ts | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 netbox/project-static/src/buttons/selectMultiple.ts diff --git a/netbox/project-static/src/buttons/selectMultiple.ts b/netbox/project-static/src/buttons/selectMultiple.ts new file mode 100644 index 000000000..465edc2f3 --- /dev/null +++ b/netbox/project-static/src/buttons/selectMultiple.ts @@ -0,0 +1,5 @@ +import { getElement, getElements, findFirstAdjacent } from '../util'; + +export function initSelectMultiple(): void { +} + From 2e38e621017e8d6de0057c8c767b60aee9423063 Mon Sep 17 00:00:00 2001 From: CroogQT Date: Thu, 5 May 2022 12:13:02 -0700 Subject: [PATCH 008/593] create store to store previously checked element --- netbox/project-static/src/stores/previousPkCheck.ts | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 netbox/project-static/src/stores/previousPkCheck.ts diff --git a/netbox/project-static/src/stores/previousPkCheck.ts b/netbox/project-static/src/stores/previousPkCheck.ts new file mode 100644 index 000000000..7fba2faba --- /dev/null +++ b/netbox/project-static/src/stores/previousPkCheck.ts @@ -0,0 +1,7 @@ +import { createState } from '../state'; + +export const previousPKCheckState = createState<{ hidden: boolean }>( + { hidden: false }, + { persist: false }, +); + From ae7ddecaa65f7ccff69352fb9d75bf775b6c0b6c Mon Sep 17 00:00:00 2001 From: CroogQT Date: Thu, 5 May 2022 12:14:15 -0700 Subject: [PATCH 009/593] now exports previousPkCheck.ts --- netbox/project-static/src/stores/index.ts | 1 + 1 file changed, 1 insertion(+) diff --git a/netbox/project-static/src/stores/index.ts b/netbox/project-static/src/stores/index.ts index 42d4aa0b5..5e53410ad 100644 --- a/netbox/project-static/src/stores/index.ts +++ b/netbox/project-static/src/stores/index.ts @@ -1,2 +1,3 @@ export * from './objectDepth'; export * from './rackImages'; +export * from './previousPkCheck'; \ No newline at end of file From c536944a101d87bd38f1c33d1c14a0788e453251 Mon Sep 17 00:00:00 2001 From: CroogQT Date: Thu, 5 May 2022 12:36:17 -0700 Subject: [PATCH 010/593] now exports multiselect function --- netbox/project-static/src/buttons/index.ts | 2 ++ 1 file changed, 2 insertions(+) diff --git a/netbox/project-static/src/buttons/index.ts b/netbox/project-static/src/buttons/index.ts index 6a9001cd1..e677ff599 100644 --- a/netbox/project-static/src/buttons/index.ts +++ b/netbox/project-static/src/buttons/index.ts @@ -3,6 +3,7 @@ import { initDepthToggle } from './depthToggle'; import { initMoveButtons } from './moveOptions'; import { initReslug } from './reslug'; import { initSelectAll } from './selectAll'; +import { initSelectMultiple } from './selectMultiple'; export function initButtons(): void { for (const func of [ @@ -10,6 +11,7 @@ export function initButtons(): void { initConnectionToggle, initReslug, initSelectAll, + initSelectMultiple, initMoveButtons, ]) { func(); From db142061ffc77cd16bcc89df199f070697873694 Mon Sep 17 00:00:00 2001 From: CroogQT Date: Thu, 5 May 2022 12:37:28 -0700 Subject: [PATCH 011/593] clicking a PkCheckbox updates state --- netbox/project-static/dist/netbox.js | Bin 375393 -> 375642 bytes netbox/project-static/dist/netbox.js.map | Bin 344719 -> 345022 bytes .../src/buttons/selectMultiple.ts | 20 ++++++++++++++++-- .../src/stores/previousPkCheck.ts | 6 +++--- 4 files changed, 21 insertions(+), 5 deletions(-) diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index acd1abbf28c867420280fb8364a550d7f54c9ec4..3d6bb9d1a610d4977fd9c887d49450d097f78f7d 100644 GIT binary patch delta 27130 zcma)l349yH+4pZ|r5q&Wbeub}6~~d{wIh>+1Unle%d#z7vSeGfW1Apk9k#5~x_yKY zTAx~J2 zDxHXyrK0=9v`5mXqM|>Fc}Lv*XT+^X$sneDQYtF#_9pcycF_siRdSrRka76|T7kii z(2c|*3xb0T%iY2z)JzI`5|?ijs!J^x#;51+Ma!jVIvj5Bx%HVt?+N}4amx0I6|R>7{pg*b|=$%jHuJmXQwmz(Emz?>tx`ba?dg;jdQD zGE7bJpBH?!US4*wg@ok6i@SBsQL(i+!njK^CG>{+){z>2E*?vyl2ZA&OfFq2KlbJv zS^B|3`Lm0+;Kj{y|9Xo{Y96VqEN>jC@p{5x{bX(3ar?wtLw&_aO+d29H^|L%x;&CO zs@HePAIp;qMn}cI;!JLN{E}+omVbE3x?Q29(rau~>@Bu;tB{CUm(&;28^oMT(&=iF z@o+Fz-#Y_cH-PI{l63)R21(L&rxL;Fu&yB|doHaZt@1^e#@9EFiv7i5T`nn<#BdIm zG>&2G`$y#3Yu0L9F1#}nn%TUrE|N|An&`Zae2k4*isz8>6J3TkZ5voT$jqH zUN%qu^s+X)$)$IC2UF3#hC20GS*bn;{n5Sq_8Am5Y#UJ)Ix#BlDGq3MNlrjizh`Dq zX88iPan6{EyFU40HnMWmQy+~t=siIx8dtHP*VX6@;;6jq@@V6zNAd&*Yxf!qhWbRj zNV-u^Wo6Z@wp>0%*7sn2{RJ=REb@HFCS~I@`lynV_#P?23IpsxHml!%+ zg@sP2uXm1$!^PLTTv8)nXe2IG$o8wVq)YzU)jg#HqhhAmXSBc*8QFBzGP&&9IkNql zIpV0oTZU;8?nx+E^w)|*#TUn1l7;hVt9;-Z%eGdRDi32Wt`Ed$wD@kH3RtRE9524x z=#q?Lv;5gL1DZxxRkOV3+I9P*wPJU%Lq%cX6E10jufP(Q_HYL5gJAHoJFZYj>{XF2 zb|j?)#;iiO185KL~qY7t-leto$muJ1^Skgchya=kk~HI*8V`(uH!jwEMw2wYMXID?_G677|h zc%e&qp`p;FOX*oxDD?m`6`C4d6^1ncTt3n?b{%mAyNO!S6*p8BG#aB8DgfJJtY4l2+t{Pv=n~wOSDRDsl?hU)i zfc)eQ`kl#Iv8ni;-yu~5F;&W;=vFc6kea!4G|fmyx!(arnsUg8FE)^zrfpljH4Z(Ta5UKCb%Au$n+nFF z;7HDplfeLfNl8b6LnV(xk805?m)*FrG|a1cH$%bR#T@$bpgeeEWofup3>6oab|`eI z4=K32^MzTn(hjbN<>&L2^6zh~(gg}@@D*Tl#-(0Pu#p1n9r1(ZrSasSGsuoR8d&WL&C1fU zh@&Q;@(TLtYn3JMlixgdt$fwZD@y~l;#hIqKCe{4(Vvl@yV*@La@7xyFZb1ojl~W_ z4pl#mgFc)Nt#N5cKK+Lc$B#Sot#N~)pqqMC6);jORuo^g09HkkflvNyj>CF>`oj~J zyA^a6`FK<{lX1D_mJQZOt=L~2q1z$#@JX`;AaW{YM3+M{b1d|GRVHaKtik~x`AjB< zG%6purDCPoA!QvkeSS~K?um;%9&s!w_IpH|Lq2%Pveo?_PS%Do?wJ_sdU#2k+-KM) zHaXZ6Ye<=V;;qLXn^Tx+Y6^@bjmZPI_K|M+-dpv=EWdthIq8uP-?mI%a$6@ElP|iY zRGzr4g!X&*=<-dsEnDtz=%GsBtwCp*9E0xIUa8zD@|W6|xHuL>cZ`cP{_PXh5#qPc zmF>6BpB^QC`~P}mMl#8GE0$X5tb%TeYm(6=Qnb#poFa7Zoj8jLP>El_?I=7ePyfAl1=${+to zx2~%oUeTIlEDeBwCGYfaP{4SHVTs*gnDj&&Qc>+)G|diuqx|T8uIio&g zE3bk&F&gUn`0t|?b0VVP-vY^tOnW4~1^w3Jka8Tq{qkdX?OfBVYAR1u>T&2}(VDP7 zI-DAT_KQmW^3uD1y~ABA28(0tnP&IGSS=1I5z!lJf>ED8=Lm>2u9{rqlRZ_dt5IFHbr#~$Zy@-ROhM{!$pw%M#ak$Q%0$UzY#S`oqU9ZQBjHY;YiVI^Bd(;4pl8q z8KImKMy~nLEh-+Jdr7>k7 zK8^?DiZLjEdFziilc0R^kE=^fwW6;$YS^gSDX)C}k4s3S+ zG-7NhH`YPkC7=B9k5?}aE0fffmvbpi8>L2h&3#)D;yCXs-5)?PS>yAhJksPo(WjI; zOfGA$MbdTX#1W;!>9F-TTWvN;=hW5vW>C_YEHHaGsBnzARvan9>rbniH?FQ8tBV*_ z*&Q}YSPQo_zRVh1sYF z{=|4xG8y$F_?3xD4h3oHsJIn$h)Oou_>+~S=}_BG?k3s}_rsogt5$TV{nl6^0}!YhD0+*>J0gaRQi22K1Yq(DkFG%E{O+UW)M{k+ zlxkM8*Go0)=fqTUj2*H*R!SE%!dWY>t5uFXaZ+omu|T+xs-c=|MQgE3V?jQe3s|i% zsxj1rQEE2AjK%$4)%C)qDo)`ysR8Qf%us%lEIhTb zbwFi|o?5ZD*gIuXeY~hi>f*fD8c|hb!ldY2F=&#;czw*Ic)?;4{pI*mMv|1Tf9gl2 z9+On`RSil$2f37(?EP5-RMiiDc4}#xN9^<*-6xe8pKOzN{Je^E%HE$Fm$rEt`Xc%^ zkD<*6au zlWGA*Ose?BflWSj1oa%tZ4oJM((9}ix3kOPa=^P9mOGzWM? zr>-70)$yFu^a6)e8EJ!U9#$mMno+?M2QVg=upyJGWycFJSPIK`n+lmopl}~(b%X+s7vE?vyYWcWH?}~|$G=2{ie&Ur2 zp0gb14=Y-<6Q+K6+Fi)1IEK>C6~J&6z(@>BE?N8hHj%F?Bih z4wE#5Wz<*;@HrE)RE&qWqNzYXGgz1-(`J(VVLY2mQV%yLb}V4XX)@^@CUG+A&!y_j zCN+B4$2$Y3u(Kjo%1uI(X)pnY&TfK1n8s~*SXqdFO!O2NVwDfRumSGkeJ}V*Q)8mH z*bpiRlvCdF%a7-TOmKgo-Q-O#Hff_{;*h$Uxg91c%-z*4`GOabuqr_8!$iDx%%mE^ z)&g!UY1rmxUKHz6VJSXb)7aC}((mpzHJiGuZmY}EWpX*Xy2Xm5)cQ>VMusI_$UmOc ziBWmWOM8(-IsYYzq~zybI*CTZ^5Egka`)l0Nrimm@J3V%FJD(yk=$D@>852`2lF|s z&qOh{m>Gs+Gb%s%^2VjnaAoB%OzUv8ChCd!%O!X_pT8_ER$i7yxX~Tf!(>#*)?Za1 zK#uo1kf7n3B>eaZ-!EbeCy(Y+j7ydDx^|9z~ zPqf}Jt=)Z5BuKWraz%YYm7wI9Xe;v9o&ry_L4H8(R7}mGx;(>>So1KvwR-dLV4Ezw zdP0L|Ol&H?*lCgyTr7fNHA6d47|3sy2L8uDDYFy|BfYUyzTnl>px|wa)idYKDiPvl-EI;-2Ocm3jAM)Wc;eV3tgrOtG+}8`M<=%vHL*I?-pAy8OeITwJd^SyvSc^Z#_4 zfyt3#!*pc@$8UN%fS#k3(q_F^{`_|vh)-UBWDOaScO7Y2H!>!U6=8^*RaZAsfMHm^ z{z%F8B!t*p6Za&Nek&4D8MCzIzcI`-jX8MeZ$Rh6>)muvs7BRN)C_b<+bwC?;_C?%hVjuNiYq%AZW}JWNCF@pZLE zq&Vu5;ey{}Q>{m2OspsZZvoPIZ0Rll-))|wVzhafBVoe|)!u`=ZnM5yoty_MmP60{ zeid1e854VpW0~bo-Z&nq1^pkY%7(_o_F{w0tft3$hLt!AGSMU_|B$41vmCj2#l>&7 zlP1~r<~p-o8NaS)SZ`Bjn%2#2s%{=16ZaGcwSv^hTh;HGVXbnj8Qi=|-uc;l`B!gl z+V4>%%Q7bVGt;&yWL9;u)2zBa9cI-nx2IL3-DOt%1Hjm+LMx7%rIul!Xbe5MwU_u1|K!cfGZ?y3t%!C1#P? zX+rE(H@OcB-6uAikM63dEeJt*hy3riCdxu-E`bi&M2IM`@e`1a~m>U-SIiG4?nZkJcXzEGFk|xp85`Y+Cl=>KO`CaekNo(%%T{K`#9(nWzfEU;kzKyosc~yw37P=#3t08AFk|A+f>;J*i?;Y$tV%K z=(DMw%!p0$aN`rVNgaHV5u4P-pJQoN##+;A5@XmV4fDlkY^o18B$s`ZBmw!7kD7?@ z(5oNS5(J3zKG}f3TRyoMI`^la1h6%0_}h8QA~yXHkNEMD zI&AQc+mvV?UhT9^0FOvW)HZnKsZYn3ql*`)D(H2D*2&?+bLFwmpjT~DC{uL#Y&N~FkQ>*bD<;A2jjgiM zj(_?-`GwCmZZ_L6g=Z-2$DHjk$!e>K7vqVFwA3D}@%h94lpktu&F5>0Nv`{R?aFkR zD_X=nKIMmM|KJG)ZLVx7auQv`28f(?^m{N|R&knVs)g~1^m`0ma z*k>FL$A(~9C0%StzV53U`06iyRX3-?CNj-8FE-C|1k8F|MkL>G!Frv65l`ll;X@<_;rWrb?r+){d;+~@%Bg5phKiedq_H`)< zu=#UHfV8pX9AYBg{C#u403@A%bS@czZD5<`k^HLvo%ZZs^GF}@G3R`;g^aM%<`Z41 zuSq3rxalaucCrWNgBM2FNAtYj zjGhWK6=<3oQk;hlc%wtp-e{aHT0nNJh&0VeadTl;7;-$!+zZHhu>Af7WCa;wmoFe? zWL%|(MWsi3Mj8h_Py#*Jz(R5iaWg-cnr?R4LJ}y+Ho@j1GCoT6<=CP{+c2;Rg4!^A?kHMO%~JFv-L28n>HoGPvDRf3l%JspmN@19y9iGTOwU{}ORMJ;c%z@KUP?BT5IbiXS-WUPqLf1q{VchZR1+J!ekm!HnwsiOv6&Tf zgD=^?Rfok&)^F7z(;$V|e=j9jFj=?+kaTbmR%v2Ghfy5rwP_>L~ zSvab2*fb|cSa2DrHO8SWClU6eWu)EZY^rZL8ZOoRNFCp*=HPaHtB!*^`mH(+?igz? z1-Py3$x^b3nA!WKWc|X%Z-6q)RxT&&N1DG`3G2oaB2Z2oJzO|us8R91b_E#U>^i}_ zDzQp|OvCKDU0GV<2|Bx_w}^tF9~fSPa=EEAQj9OHTgGv14^)g{H$UH8F#Z>;TXn9jRKJ3s0LI zQOA=6Id-*a4NXmj>^L)LukT{j8_0%vR)t(V(_&_W8_0FUmj7Y{ z=_DAlVqjohg8yk{b2*Bz`+0IR*jU?E2Hj&EmF}qSLHV&yM zZ^qiV8{TSH6VZ+NXE%{qgfz0ldh!xf)(r-7B?MU7Omrm3PT36FHnWM%qz;e!Hk0y| zu|~14i2sTLi%eh|_R(hY3aMbfsDk>QU}Yj%bDXD9>?w9`DRAc=yXqAL!m(IFY_s!o zqzQjK?144uWKj{SbAVka67S{#`?Lhaa00im{R0;tsA;h)d3S`ropx-iur<}>?_kD7 zHRP5RL)Lmn0P$HO=m`fW{L;8p;r$4EsfH{o8@6JL)f@Bqd%CRVSR@{c^3!4&tF)!Q zZ1Wb;#X#+m67Y#lvdBqd~+yHE1QUm zQ9Id`zodzLI9t=#D0Y3j&vQ1igIyRPn`YSp;I>eHi=F&ZgVDe0Bz_G}O*`3e7um1~ zzk`wNKjfiYpfDE$i_sFKX(A0&w9}AFsuuwJ@AxrVz841gZ$?b>ThPhyp$ZIsb=Q6jBH*J8keH}Y*`^sZN*N;a1gq}$$oGdcw!H`gpp?W zKCd&fYh`G>Xno*o&ahS+GhU8fPL{o#SndPyK-Wod!es2X7?XDR2MyW-=wvRER}yBh?gdUVR(L$h%x{2bm9K zgxFPgl4}eui{c`uJYrXXyU6-!`wwfyH+q$92u`}DnD;IcUVvjOJP1`7yCKDn+(isD zC*h_yUEhUSp1eJ$jw@Co8HP!J49;Ow($} zKPRj3xb1Ut0tw~c{v6&PabETTS(ab%C8-ri^3pb{TN(6-Nd%o?zb7H}Th!mNq+e>k z^bD#aEtlRxtG0G3^$EW(;mJzv0p5xGGk$mB7gDKyDW#NBvEkvcUy89=gnqVYzygf- zb7@Jq@h8d_QCbRMHc{F@NHRYx(5EN~=fzocAqA|v=FpQtZsS~9$)1=)qgXF~FD7$C zz!i@|D|nYR?EJZOem-#wy@3d!sKhQhjxJ;3e0st$=qFlu-Y3Lj^XXblb^d%hUx3!X zav@!f8SY<5ZM+v^7^Nji~$66ZZ&CPM7g74$KTuzMw4UcyHR zMQf1DK#vZnY!q2=CGDRdLW)|!6abO0eWH{-WS~pfKUdPzNgo?uMF&>&aGK<>{}HXp z`u(B4geQ*h2#bAx6>Y=>HLL045T=h-(;GFt=*t$arK|JzuA#5+1)N((gPKs3YtUP@ z%b0Veb~Y<1r!An`N#*nl&X{i2c{%7YrlZDUaVdL1M-PDFbsOk~WC4igj@E}@|8jV+ z-&W8nj4f=Wc@kw0Z=`!M1-z^~DnRRs{LZ82Ox89TF-y}Jp_6Jr0`M6ERDVQ=oEC9F?RYe|fqt*6JM>2W>Xz5S70!lWS*aebYvze~T$2Zd&XrKJGRdgPKt8lwW z?*zXMRMV62YFP)Se6E@{;rF5%ngGA{*OalI#$UvwOOh~W9$RzBkd`|UP*3+czpC$%+PX!zk7H8LzqMh8PU zi0}2Jyd#{92$_!>BgWQt&|Bujl6ueq9Qi^Ay?H0+bxRb^R2W*u=Tf%0k*P$dZ`T^? z%6aGV9RCx`-|hh8kYN5-PWm;T>{nfM6l}V?o4W9jyXoyfM1zZRUFmkwaXemiQ7axB zdT3l5iefl+c@I5(c_>=I5XPTjj~J`%r5Tu|TY70d-g>*29$BP>JD=rLQm2~De`RHk6 zc2Xgnfn5}%rTM4)P$%Hh*~9b|0_mx&%pL9ThS(<~5S)R0S&*K{b-yR12;}7<+Ktj* zLv#d>o-lQT5)HZ$_Hl@=%)cC_(K(pbl%}^hRF9(Hzxd(Q*!ec#^DkoR+hH=IEus%X#B4 zB4KvhIDA9sk#TCIUJv^kJ=S>wIMbsO!$~RZsqrS0UFontSvWH+B9NQ_Z-m(&CTPhV zucylEMo)H~mab(hC+X-cE zM@Ln)D($ClfSK2xM%NSuVGXCzi-72tP6G=7Hw~v#8}+-{`KQx8+moKbToi|6igAWo zF@2J8#v$Q?T2KQaw(2`{%{KJ39QA60TK<2$Ir<%X&dQ_4f+15f?%YLy%{=zI^t1m< zbJ-cR{r}SZ-81N=8;%-0#Lwj5L_ZSdaH9AWm6e@AOtb4uYJ$BMxrQk&>bx^)#W5+j zYAO)4R{QAk{NXccgpz2!;cRNqE&&7cz0nyyPvj>qpeFba`JWu5$g{`TCzsMI00V45 zPSIuD5bw%O9~OsAgT(Nb{2iBpb)aaTV^pF^H(SSbaoOdx8g(6)Ln4(&=`viX+a(!i zrsSM4$(*ZbN&ZKdgA>3ViV?x9OW7$`(WM}D>MCvlJozox&=U!`EPgG07}er+u%qa| z=X$yy#aFJUA0s}=KXWrA@tAIYCc1vyt?y>bZlNu!oH5apNW`*rdU&QI9?_Fd#gyM^ zmbryqiL~qDTdAeanLu*Lr!)kTIClVt!xl`Y{84`*snmAGu>Tc|E59=yaU|&TE5C=> zMYq!WrQ;q^iGum{CG~|7_WN6@6LH{{+vrJ)10FFG^k?}sP~|lryXrPLhiUe^+vvvi zfuy9v^g3|>2VlIICXSnzPQ~rP`7j?VyB(q%VAk7d1N!d8j{o3Z9D_+pgL`Ydu_)|} z-VziC(`aJ$+o{NYbvwi~ojSEzEo|Wj=~A&c z!oYhD(WOqcEy2~3^2$&wm5N0Quc!s(m9RgMD%A3yO5fbKE5%5PKLHS4Tql*ZNFW#?Mrg?d~gJhXGPtOB)yp*SL^f5ia&0~l?@*rKwPJfWrslRpT z_=g9n4=G;DLvUM$**Oo*AH_S8on7&AI`5S*i1ui|e zJOYE}WWRd^R>8qZa~l@>`lIytg(Ki+evYqBr?4?Iy-C;3a}_D&V6BhAEj6)=9-|Gc z?`gW2{oygXV^t)n$AA9lW)OyBdTPojj@R*8R{J=;9~tLAJr4iH$!>l^LCKp>&^0K1 z^#tYd_=!KI31Z40`YDVs5*vVLbAI7d@a-4d+#=r+;F|zSVkXWSo`!{O;(gZqF!eMg z^Wq+a9mq`Lpdlms$Qt(jU(jQ)oST0E+Qr%Dzra%CY|AsWYjM-JMzgbvpP^?hu)CFu zz6K@Ku(D0h;-Yti*`I|EV9lTPEPaO?(#Q++J9vEZ0?0hfhJH!Cc>MgA&=kY@*)P&c z5ItY>5~Z9$Y7f&A^ld(@=p+AO_zQ4r4^uY)`RXum?#y?+3`0i7^UwT>{+U454*i$n z?f>Ck1WwC-gQ)5)iadN98KvAD9yI~mR`RG*@>P6PCFn88I{J9dT8c=9{~)m zPC40Me+%ctnQwcA{*z$;%Jdptp$&NI0v>kJYX|}+UIXho+3eTpbJ=VgBcmYw-ce*`+Q&2`G#)WLSVhdAtsx9OX#_fPbA_R2emu1DDC??4F0*oJrM z^VkUc_+8qfX?5?bXJ3B^?4I~2ozFb)(N$=gdXHX>gyyP0(OpPdPQ!czFrD;gnmrb{ z^?3Cz6}QauF5;4}{>*_K&j0a!ya}ov_<$PLJEMEWNKo!7B+kI( zw|xl_BR%<>z5*ZU`rT5k|9G*TKemc-ucS*QJkey3Ux`(0SPT2)YdS&t?+Xi05X22N zRQQ~<=Qr~YHINoIp%D&}Y<|90SWiigiL-^Xk>t96w(ulr%TLS^;F<5qpEg&pkor!y zv}N$*n!TI#4bn+9HJc45)lAhO&pUv6Ufv@5yQM94btn07E<((B`E4kZPpTDD-IvW1 zjPQ4A=Lv68g!xMs2;=Z>&R-yW%CURKB4Imt<>5tw4V~sJ7Mx^Fr<)%FfOP|pMH_q>=3kfO?;yh>O=;nYUf2+wc#bW1u<7<;*JyYX`< zSyL#Dd!trCc%TU*L#FgA<}JNpIjs?W1;mz7xi^t_Ns6q`+B`_oo1vPu>GJ+*t8?V*OG=G5Y>r8 z{CBcux;PG~u&^Nxj0H_cEzHeGxv;sk`zW}(_fNkYCfQ!YWp#6RP3ybm)Y7wW^d|rxTVCOa72fa0=a76&kN65lbiiVVzi! zP~ge(NydENfG3B(*qM)IZSYrgqHDU?#eE%}=;)TV8;zog^;Qb)u(CH)3ODR`CncTY z3+Y5#w=_AJ>)u=EPKtvrJOeRY{l(&vVR)1klNAX}+2~Wtg`yqJxGCU^Wut`}D{3Mf zR(PBKM4>V?U5O-TW_l@6eMfbw#<9>ywW48q*|mCM#mb)l(Hg}C5*>~)yrdVFkF=w?u##%Uq1TBm zsH&Ns$K@#&u+gWIUYSHE?&1BuRoC`E>dJzVVI8);90su00NZB}R<7`8aU_I$NYz8h zYBfKC6CtTAyVHO#)I{^YF$gUL>40@r0(Ne)tX&j_NN4^|QFsu?3G*X0!l?vo^WGL= zH=MdkqtKysC&47_<4c6)>>{I3g)OC@7@@bUY;LW9Bv*c0t#B2E*LZlVumPI%A6qd| zD_gq_8g!IBw@uK&@}9X3UEA3`+k}MxCz3Kmn0!KAFF}m0&gbP;Lf{t3#%!TiSZMK546qQ z98W_gp>joIx5&e_Nv>m{Uwd&v3}-R*QFfh4_};PINkuyQICCY~_C~BX$o4i0TlUAY z5S)=%wqmk7iN<812(eMhNb8@%1GhpktQLL#>2@zF5Pfmwi2fCmi7W<*gEje>Ix(9B z%f`ZCPdo`Wb%1>eCH|Ql(d3aTrYrmi<$9qvl$Z(18BC$ZNx0#{wwQ(GG{+M#P*;Oy z;Zj(^Pt2f0j+Hb)L*??$CSebSuD!KcxBxt|vqgA}3GKofwzO3^NV7@y#sOg+b$Hk( zr$Obu-YWEJO&$Y=MzVT6>#;)fIN0@8VLe`c!Ya66SW4T352z>04%`WSxV~MG)gG(a zFWZIL==Pg-;Ra=pusX<9Ho-SDNVy%{5@x&YumnM-?Eq_~S$l`j0GQA15WXzM^mVvO z?hPYw;&F40$LG_V^4B_E=Da3g)^G%@vbbZd`N0Y0hwCS$s|DxK8XY z{8ltowop)Xq)yDC81-a^JjkfI3LJ2bODJ37LIbXA@s?^lz+LPoF5yI|fG=IbS}26o zJ$TsI2|bYUCbpM9aOkQBTw`T7@<)h0-6O;`&a5=aF1$u4&!5yQqzMgW**zD4&-UL4 z2g8|V7fcAN@{9K11#Kn^|AsTfQr6ZFtKIEkoehF6|9HPJ%Eh&6P&feDzGF~m6LKB{ zJMukfAouA|9xF}~&LBhiYfci(WbSwt5eH<|&&GU6-F*Bbt(MV~h2u35G_Y7bIJEO* zA*l@U;LXA&_TkCGPvEfM?iS|LW4p7(FQeGA>}rp&YJPU6%F6!Y5mF`YEI+8zV9wT= zvbZAO(3GvSvBZ$D6|!>kkPxEF9a&L5u!j6g8W)&@Vc0Kymg)T*ZTV)u&`C5S*{LaJ zAAt(|aRAk>{L2C1F}l!?bC zz-Ow1PKqb|IK{+IW1)7?xR-CWspCMunb{?yAfS!?*QhWBG^tZKgr?qp1` z53|CK#eFl3uTC(F*2ghjT&+>1XfegpC{9IoGPN`fy$& z1})e!Q#BOxjl+~O<2aDr#yZA@@6q-wTVExVvJc0F{j|x$d2?<4yb0kdzR_)%0v3An zG3+@LT2atdkG~_#V)8!WbavV$f`*-XP*}h&v%laZarPV7V;%RX@1Uk1g8d|_n#%~q7&-y`FqY1uE8!)R@{?iXI>_( zV~KNx1oYuM=L#p+bYd~kR!Fwvv~tFSRGdpySDhTYzL9UJs{uB4p0JeqbL`CXgj$-) zu?No+`u9h3(|X3m^-!Wvgq~5#L6lXZD8=CsrKp%BrNZiwP6^<%NXg*z8!^05FjDAI zG3gt@u*vDl8ecFO2_}<;;XUl&`NB%5?%U57bkv(uj86Wo^M$^)_R&R@&Q@+MTr&G z$BrO3sxN-R$;vLdL^w;6%!$~Gxm4IhJvnywcZ5nHC?CI6SWGmr9QF^+xJ=jwbPEiw z!T`I733gbP-!oxgSs;hg&K{ftsvbNkTfKKPKl$!s_RB%z5qAFN!dZ~fWmgC-CFvYL z0jr$mYmCL<`~nIVzd|TQKRim<_pgBHMcDEy1p^7>O;-x{QM~)#j!RGoF9>YT+pY5oXr{d+z){t`*{Bc_ar1f$uDv zW6?lxSiSZwcC)GLg}0%TJvRs?-46H-ss~{z{<6W=;d^0lDsteW!kpE?DDurZ(Tr{* z@Y3Gu5QTZKmnb$i$y4dF}u#|~E{5I;gwCL7qtcfhuM^nh@jaCAwVKk-2jiKO%FAz>xO4EOv5 zuC{}{@e^TLi79EAL|)phV5*yc@JKSTIgbe2sVT|sc~q!m{zn9U@b|VykZ~~QcReaR zi#%0+_T$16lw|VH{8V_AEN}p;prDFv6TAByw{>AMLF6=fd0btQbm-ow1kkwBTV6Jq=}bGQO_HYk@1GX_ zM6}kN7|OAId4$aKo)wlLPaYo)Bp|b6_Xw8jpv08>l$;?ref5BS-`K# zgu1<(#O54(^EK#%?Jo!m;i_9+5GpDs0M$`WT;I_}2oOIT0|%I0_yTl~jR)yV*=gg# zhWr~Z2s;SO*YX#IL(ufky(oM_VYwc88Hs|0eK{ms;6fsMf!h}oEc{!fWt!O|zZLdi z-qKfuAnYG>)Z=`}SA}aAx8~F+VLCi$WS_h$EZuKYjym(BFYO7vEvcR==mCf+&k%w` z6`{)SCN+@g=csH~*1!WdC7;p)JgIuQiANH9)S{x7m5MfwSS8X>ik*cblyr?!F@TDK zmPWZ^vYpT2$9FfUUEgZ%spv#IyXQ4w{h}0FjzVaZ{oyrXH%++IAYtq4!U@ZRM|UYA zImW*8y3k2`a_pm<;n;liI^1?UbNvon8D*FJPMBm}M}#Hp!z02%W;_D7uZ?T{N;ZB( z@FLV(bVMj)Umg)wkxoVZ=WBj1jF9DaV2#IKI4)U0t|RK#$JiZjK)~(nw{Hmjoaz4{ z{EqrvY~h>2vc)MEzEO#s|1>dzZ2OzShFKU18EG}9*!QOJ7tH{u%tCJoY;_U~0&AyY zxU&j}SGBB37x3g^YyT)L-ye1rvK(AED<&P>etL^_Y2+M~sx+#KCQ_*hOxHle7CQM* zrP5RBF`^a~dMXuhRH*b+iV+ld@-hgjR15>yf^0)C@R4wPt*FhNsN=nrKrqAJ|09C> zA=dG>@DG}CDNYU>dPiu4)fsyaVKjUiD@@NZ?+P{4Iif^!u&7Fq6=9io1xXVcF^KHN z1F*PG_U^kvSZhsU3x^#(9yGr39Ylf%;cz19U3huJ5=j&i9;?{b}885)%S&d_SE}O=4rP0uW*CTd0$uo zV~O7;GAA`5btUv&BP{kIDBXe2;qXiQric{8wZZxhcG?F*(`c7by-hf3lw$lgVKS{W zi(~2sq?FI&*dqMv5~D@~JY`Q>>M{=6B74Q=q~u9gR(jGiS3gi!S=pSN-i3!>o=h9~ z0h=+SzM0j0D6A@*X+@i|Q{+kGHPIGPc1Ij+COGi3iBgaAxYg1K9OW`vireVo}i{n8nF-H0cTW>&mA;ku+Yo<=!|f zwes%c?B5>=jb&N0WW%&I-Vsm2loE4=OaBwY>YY{>8~j*Uv)+L#@ak7LOv*2ubw?1? zj62AE`09p>UG}lCex<{F^anNihDG(e5Oq2B%a0M6nAqPwhWDRkEuRQG$}`G}owx&9 zIGRsrH(|wcwF!6b`2ocCw5T?Y zLsL*TsUW_>yhUuwU-lW2U)zSliie4$KTcd>W36!30@Z~pI6U&psP|5%+gR%t zaF*Ix?h6ELZS1BmAd`FYzxYD9l5aqGzk>R8vZud7A1C|tE8%w~7!5~y_^v}1`&(ID z{2vd?wI8j%k7|BON-Y0#T^aTY(R=}~>c6O_8vdOiXddAH=}$D8+o8@!w0N(RRn5{| zsdtBQe|ey31~t>W7v<&d@IKLRmyX+R6jS#62eULf9vLi}qq&{>?d*{`nv>v{ubQj* zBSrJqb2YCMd$)?ns9j9sTcguoL*-i{7_G8072R#Dtn9{ecw!hr<_=e3i$qi!mFgJ2 z7OQR_C+zsl5N%1a#d9>P%(!##K zOf%t17j9kz?2;RIK(HGZNQpkX`nj{*kopm_5!`Lz7ewNA$!FK=uzi>I@&l|9yHq}6 z$3d^5-8)X;k6k;r)~At<`9LV2RUXHMkO;d7-$o+=c6X_!tz_7)ev~GIODRyC_(p{< zz!oneC5whIa$x4F-Z(pMxu#;tFvc#|yN0-U_yXX$3>#Ul*}81Vj+`_ufAf@sp(dgn zE*xifFV~dM=~g5)6Hqkt34L~HoS#PSwX2^==&`F`HRukgw`Ka#u6*MGw>p%5xa)%_ zwBM!`nw_Mdow7ocLJHu&R%njQZs#|RAcGIC)L8cWt?I}rt9mCTYE@@QSk>>51g+{! zZ83GG82a;>l2&ylk5%gDC=FYc8AY#Ez0;BnNM0*Pv2ut8I8NhyJOAn?zh)em{v8zX z4FPuADorgyyL(q@!n5L5sXS%nSB=FV5T86+IsBN#)~JM_>BUC3rQZ_OxF9X`ZzX* zS!SJP0y|=#tkZaw#I5*V(g^;v52@PGl=rRI9Ol{k2HqYRKiI`iG*nrF2T zly&o?$xP>H9%K#YX}Z?!QN3>-;o%SmGK_m6 z`}J)~e2%+5qvvY2u-~I2)>C`FW(C&Mc0R7N*w~5Z0cmO_yX`#9HmvEWDz%@x#cTzi z4&i@B5UTfjkcLlrhKG@Due1Hf`f7-auCD1@ZMr&B{^RpCa|wIuLQN@Kc%fzh?$;yWlAUwN5^5_aM|ew7B7?%8`+Y0ko_=-Abo1Ei0A zay59ZhsoDyoTM@T_BERKwCMW$jhf?2nyueRmY=+#Vse0$-lW-BQt_W!95-q3Wi2*& zlV%e}_`yw3ntklZP2jFxR(rEXPkQnLH*2s<)z4o2q2?SU9DTQFq=oJL($%zCDeGr< z-=Zm5=vPjpOz)JpvtQk!**2>+%undC>rcSt=vG#Ft0uJoRWmn2TJyKus`)B#3}iAM zt#?It;c&_#ZRuQRbkG&ui?bT6{6%o_TZ^N`L)helzHsh5_VlwJ1@U0suggj#*;V2w4YFI zG6aOOv3s$)>n_wD!v+&td~hlM!-Vz=N|PaWQ(7AWsTXIoBSKY_OC8U{<5SYp=;rs5 z8o5(~di5xkGayBi?8b5JuDN(&k{?K{V~6k1E@fYgYZujWzbars7yTr@ufb0;7SdUh z$ZsXFt5a8Ai>P|q;+OeY>4f$|_U8%h3GDY1+Ia|X4qU4(y=+ojOFbdBbyDlx9LM?k zx)J;leHN};I4H#dBK+`uVUN$r?wHi>oP%Bpz--Y0?YiB_5AB}xg!Ik;6v^~e5tni{ z9%mr&4IN;xL79Soi-=D%Gk7?}KA6(huN9nh|#=@9Eb zpgolaLitw@XwN3phqLwvv}NqO-_c$uj9c`q^8z5-@LjD9eOUIp+8+MSFTbm8?D2(; zf_;S3p5tl~r#q9#Y1SaQ&X07VPVo|T1p;Af`Dlb%jzVZ_RKJN`d%AYRQpGLjX!b|T z_${oc!O!Jjzk*%hHHm|p{ObXpVUO}%dz^vcD5z1luf>1`xs(}XG~=eK@?|5Ha2Rng zViCO-amXT$TSSXR9JUm+AZMrqg5;<_H5AKLW4APxsK$N)V&`~BTC211GZSTYr6LlN zbWNT_s8DpX)6UQ?Ti1;*8b^G=>M-v)lnxK+X4r2y#15UI-9j_ClW>N%d`UvN6+Z*$ zP>3x*Q!C9*@B|J->G3lmX|Xf4wPle|9lscdWDF+6-AXVfzGscps|)7`q&Tk2oT>Gc zx-I-$(cjwB>}EU8(pIkM{!eXqL7n96v$W?UpT7Ki+D$7nA#o_Q*MKXA-=NfZh<*G$ z?RxaeeovdFmSSwWgnlT-B4)> zK{gTX&Ctb-iN9%%au&sqvHo+lu~LVH2edBm%uzyZQYGZS&(-Q--q)U|U9rgg%^tSA z;SBDOxA8$=sJ4+Rtx_K z%u05Wq&+78lB``Oz?{E(nKp-A3pdlY@zbJrU8^n6KX--pK5o-7jc$I33$>~jJ9zV1 zP^LSs)3zUrbgBZ!6?bSCF78l!6;;+~{=qx60ZJVqR(`j3cgZMkhjKb0Ol`=@kw4I&UisMM}wIdS(!Oo45CE1oOS+Xr}f{FTIfuvmzI3fG>G!7n4Lmb)pnNqAcn(yQ&JX!h;)qAO z;L_3q=N_REM+>iu4|K1VAH7F=AYVbE2VQC*LAjJzNJJhax6zz7!9PL5vSVuXyl_nF)raNq zR0RniJZI|mvZeMhacp#Umvc*#=(b^C zRIa;fgC^_N=j7urE?qP}Cblb;+m!-&-^ERSZa0T@nSAoai{yV^ z+~#n*^D<&hfcTT!i*aF=N9FZ&t+Q{ zjH$3|mLFuJYr4D*u|%WZ8+)7r zRd;y{gLnCq!7Inacw&}fLJ4Wii`AIqzh1I~nB?+HvlUZgVyald?3TKGm|beFSF?Qo zrMryd>g@W)L~pUOU0sT3aZ6*ok$0|jSFB&q zq$UPr@rolhkIx=v3F+1CNI0P#Ncul7Fww` zZy6JV#pYqR)XEncO-RkM~c$1PNQS;saIK#9&@Yw(BN`?ZRUN6?Y$!b%&!oHk>9jvNGgIkq=vELW zH(#-gFMq$j!kW;BQzCe4W~M^#NzBZoClmg7pgf%7qz;BlsSIZ@R8^t8stOG{lm?B3 zDjiDA`a-G?GgD_%tE)!0227XtGz(p4LV>QoPIM;>)dhi`O-Oxw#kqtu&R5*)mV603 zd)$(R=MT809yxzaHyMx@UHkAcy&Pd&Fwb_{suF&>PBayv+U}N|ypI;Q(r1H7!TIG6 zE+p;p#_P&Ri@ftXT}`Y`v=^K77Z71COsB~w^}B0F;=WAOA4`jE@^`P>L)zrWuhSo! ztP?H8cAY?62ty4PB%0qTHFNH;%yCCWryGKF@Nhv({IcVEYeU+pHjX(Z7aEC4r_{k= z5OPYroaEw8sg>uaoGMj#QJ<$BiGqSVy1|x!I8Hko9f|rtCgw|r;xP~=r_1S30B=&r zSs+v??$je&^vdNoY$;3eY+lV!P)4_!WuG#xrGx_FUMP;F!zqcfr_$*hAuu&pR=*!+w&BY>Quvt*?9)k zc_ITvVn&|1@!B2UI&rKxr;);tqfTjx!#<&ctzm2q<|EEVR<~NSrmTF_SsPGE2KDrH z%98iVZ=AJ3zT&1eWsy2@yx4D_Pip4ikIK*7K{jl+v38%g_VK5X#RG%sdGIe5QvFR}8%=@0iocXgk0VVp+A0D@AQUPa?oV!$Q z8IW6U-fSDG69q)tM z{4GZw*{u-M%nS%g8j}Za=_6M8o?G<9DZg?{1?iO!-C8QIxV4jv$>(2KCQsd3LVLWt zclpL!OIPKbdPo%5Y!F>;=a479SE?|Iyixm#EQf;ViF3}z-#$oN-b3QHg|g$e#k0L6 zZri>e^A7sc^_cspH&u`M`(uH4(&w)?Ie7tuU2{BHZ+6bghiqICI-_-Be-V`S0tnk7 zkT~cp1^#k4r6vwCTLHf<38|a&q01??Bx=#S7+#{h7RD4iWbsFj!_@ltN4kw+m27>n z+EhG)2?0vQcd0`*-fmc7cN(U>vBq?an+;MdR_~C*w_js%VezA(l%d$rR>%PORnuZz zrHVwI*j8Lbms4_h(=gBcp$Nd`yrXIRn6tjiY2XN)U42eneY8&OEH)f>O5@y0YLy?o zW4or+sUMgBc86XUtP=-|b(#uwnhS$Oy*aT`mhPvu$#-u){J|3%$_+!EJs6mXt zE|yo`_1j~I>%>s8kNyI=_Z0dXa7xLj-cTEgjreoUfY=VQ=ayF}3LCIQUUuJN(jzzC zy#*@3e|HPC$?bRR7YwMJIw`+)_Zgepl|(99P)sdOsg3hnzf&6EM9~H!k%>TLN}Ukn9I%5LR(L)xf_#D++;XuNeg<&zFpFCSEdlaWh4 zNdK7Rm#;Wjw>?`YW{RE0j4E3vjgk-R6GKL6igy~v6SUiqDXj0u%T^|pj(9(DV{Jf; zL-@-(e!PvuRFg8{g z>%s3*M*jH6>z1dKLFy|iIG09@QmefF-W|j%yY4O9??W~=}#(lw0CfuuE6AofT|p%{0aI9i;qKch^28~jH18Tx34FXUNqq77s2$3GX&kcX<(fhW-XM69yfxSVaJ`fW}z%W>N zZEDmTotYVlRaK3s2^c=3N(~(^(uoyDXd9zG5)*wf5e*eiD@;3`QKs#z6BEj`6MWn< z`L2sJ^8NV}SDEU>XmL5iMk$@a+@k8-%KyAT18qHg&~bkQSz@jegTH$A7 z5tH0T{V3ihVp2{4S|%p$fX0hSCfWGYHNNOV1H)w=3Lr&@2l#VECap=u%MtzO@#=rBr2J~5k7a>&m;yqehLcOI^w79+d6 zOtXf)Ql{CoAg-dL{Zu7mk|$KyM6l`yG_Lv$KdKXq)bt4^aVJh7#< zQzeY4IzRcdC)+l#7iejt{w6m`vEx-4RZaQd`r6&zNJPW3vBuNwT z&`7zlF&V4(n_zHq`*2oy4yd^3s}p;QOHY|pHuIXKPTohvq}re(87U<{_~cQD`F!|f z1?1tfU+#fHe( zssREfmHkElO+NG}@;Q{-qSA;-ud`V_t}dtB3F|5$cRsa|jLM0pwl4^nxJZW?{llkD zUY9V{^U%}m0*6%|X@_nODjaExs?!q(qf&x%SkR39-j`-4(NooJO`e|C+We>zR0Cb{C$mGbe=Y~M6#f{Pi1Os$wO>D_TLn!$Up@QNnq zK4U#D%Gzg-Cf#!Vvm1yHtBOFaXRMDrR$w0 z)qB{7fC`5x^sI=La+P2<4JBdF*-cOgv#^Z>6?M>7CwhwuvB(FW+YEE@-seWjI_pGV zvA|(cohF;S{Z}6^aF}5JK)T6WpSNfS>%?JoH49xPDZY^)jR=BJ()>-`Za5v*n{4i6Kt1{l!ZgViAS#lH;PiNMG#*nrJae?Z9?Au7*NH7h|D&Tpla!3ehb~wtpZn4}VB*%7c5C`g zjY;`0FZCYfH*-Tojom8}sncZOLES=(sS)1LAnHcAEnE*l426(<*-ql}BQLL6pEj%0 zh?ylP*LaRORHfzrewmxNn_gMF$~!K)ic?RS)!>gS$n7w0U!~-+SA0iA#>KEwDJ=i~ z6?w!rE_M{#c+E=SSd5sZ9?nxfvt;68Fcgt=L%M38xmveZCuYo2mp^FDCG@%zb=9E= z|EJpqNCt`pvze6~zL{AEdVyAonDt)y^H(>MjJ)Z!^&}wgeywF=W?URE&SAu?n!2Nf zIV9w3Un|)ek4Pit+JrZm^4k!PikhYECk|ED>}@m-_2>3(7lURg9?_2lt98a*Is=$% z*UU^@{>y6{_6N<4Md~d?h6>g|!mJfqc_ z89w;bAJ&p3iE**F*q2lOx@Pt`T{V_%DW;uGn z>I>dzCuZ6H#zwPU>A$`ws5hx2&C2FBRW=95#r|Ta7N8p8lZO5|(yFkSLCtIBU7szM zfAhxH{VA2RCdNho#H?;|m{pl<1M2z0U1rrRcVtwh9X2cW0p{4L&Q|O&OD#dv>_Q3G zIAdn1ji(0{#c2;oU1q&5>Q8$?I^$-3vw}KC#t&cvbF`^N?VLOaAwpQ{}Du=0O@BgHmSNWCrq^lYak{zrNYLufZlCc)QFvJT9h-0PZuZ z23IdAiYw+G02lx|%;Ff3fB$x4cdxltk<~Ei($E+K=Aj-lV%SI&?YXc@u#@9rve-8Jnfs1B0OCwzxdukl9bQ>b3dt+-~Kb#(2M>u05R(Si>)+m zhqr4mOmm%)iGj3&F)1cL{+9;S{rWGf7FDM76?KMvP$eO`;{CIbd;9yV$_lv!uJ2NT zn3Z3C|GYK1aWPt)bIPt_YGgu69X#!?qhyJDTpTVId*y$9kc43z{;&y5eaDAu1|oKq zcYJnL;#nsYk6p~zRZAvdmr`8$jM$|PzQ|F#)Wx6U8I{LcGinecVV8n@@lm^K!v*E? zk5a@ZU-*%QWDdUcQ5}I1v*?q}_}%`=1(3Nv`y_xJTEnMjmyX)?!`%Ppp1iV&XNn=D z`}C(3h!Xtu(}!Wr-}bk1#0{SP+fI#X9CGIF56kvvCnO7>hc}|kj|T>4DO#K;Ag-w} z$Kk@9Ckt!HO(?Fc=$=sJgL6U+Fd0o!mZ9L2+ z=IlUXB%*E%|LnheN%z4uf7cTD^qc;1bNR3x5lAo?XMNGCBvg9^Y9KUHpOfGH$3}z} z=KXUUEa$p^)@<}f^b>Z)n}=09s}n#Y5(2f25qajHldDk02T&E{Mxa=>_+R6^43U7@ zG7wmy-G%=O{jX&u|2}?Ljfj(?d1YdyTmvW6g2in!sMd${wzo5x3joW8tTIJMkP0Y-#2SSmG`jo1mY&6>@9&f zNiREELykcztRd}mz|J}slUmwtXQwVE6=ef<75kO;qV$&}8{4EM$CS1!WwZNltrHE< z&ZBHhOB&JJty*H+;j)W5#F)6b25RWQYPmJWMO88UJ~Pubm)$sqH62Mxv7FuW$c9Zl z_JYvvQ8~;3^QtJ1TkLH460(Y&H;>E@_x~rnw|xumo&O8o2fu}PzlGDmVR%nl=I|b4 zWIk!4NsIi#SH~?3S)`a{W(KLc3)Xduam)Y2bIKycEpvGGTITQ^nSBq%#Qwt!Bg1q7 zJ|T;I%GYJY#}+Rj0n)-!3y6t$^Y<{2Z;50p~7!NjBqr~aDe4JpOC1ewc zvi(cQY7%6ZEFtA!00kezDn8mFdVvq5fDbmflpH}OnV)lwm0i4)1WG&>=v;Wlhl##! zwrm->r>^@jBn@VymWf(y&^fa)#9R{oWO`D}T6kuWVRP(n%Lq#v$x2j zW@cVNBmyp6K{k>ecFhW4(85#e78Gcshpk&lwh;$Avy^ODHir}C>_ZPrtt2(X#I9XQ z$|SR;!4#icF<1DK{ablhtYrCC9wH5rgZ=kPk|j14DZxx!dG(IM5@l;vkxdn?-^_$|;{g!}Ck`IY92c)5 ztG7oF%g2~Je-2B{ybHxKDc~f^u31HDG5YhXNSSTi(qKM(d3+tM-^%0bX!=$jUq`d0 zp-2n~R=XOD>0!OAiFi__I&ba@4Nma+%*^yDSp`X4QKtx8sOSMDduGO}JR5VC`k-Z& zPW&;IZ+q3Ib8CvSH&>I*M@(6`N=H;&T8>>hu&_0h3kN(wLo-NA)`0>^LZw zM#0zonP7(XBvdukDq4$jBj!-{qr{{`4Kart>W)vG-M^k3y*cLK(^SBM-PxprFO6@@ zh8%h?-Vl+B=a+5(;>5mIvAfu7%Ap30ybi^lYv>*>T3ac!WTA~@GZ|p#Y$R*QF#F*~ zEOeMXyOI2K@ub>9v=2*@?7~gtcgME0ijHE(R)=c%dkWRM9g@dUtHxv+9CM>s9f&=b zuzSmiWlvZYm;J4xtJqJr&`++=kJ};Tiv76e`pNQsR)SUAE6528b7~l%t(DzXK~`Ix z4mDO}LTAIU3_FG;3xAp&>WL4#L)|H`I8-YYR4h6GUtY)Nkiz_#Wk>4BYK_YwnVCUH zjwM;<)sgDu*~qMR5p_HskY!iu$mFW9Ly87wW`g+Z8lIVPIB-hN(GX@eo5|)y76n;6 zsN!Tpo5?lAl>cHg>4a0jI<}D4AcDjyawY4z_D6X(N92 zovoy*q6+}w9$3?`3h-vEja%Gfm?)2rjpv`0l@ub+|;3r3u{zSwJ#nI1VBBW#+J5MCOZEcQO`j6wxZDFSe);vHn;7~&B z@O1kfI48!|*O0%FcDAgR+`KwyYj6hOiX}tdNNCD0P1qF5A7wAplG5^o4ZEqn_=vx! z%Vv&86Y&^79~QMq+Z)QaZ5Pc-cBwoAGYzpHdqP~f}({tCle-^=|b!h-ESl%&;ZXFVSSp}hC1NZ z%;I(AV?0j61{5*ppF4_7P%x8aC+r;yd&5M^*v4Bl^V$0ElPdQ5ab(e2i)wN6qtpo4 zTOzZp*=WgsxRYEjEV8L&KHelc{!<6+w>ycLFRLeCYe_g?c03WeC1o~|KDX zv}48_-Q**R^?A5Zi^Z9|@4V=b_zr zl&nO%??uUug=;XfaZcY@Vz5)fF@)s8`9l+A+j7lRlQ{NG5Dc;N0$7lBQd!Uq-zPJR zNI$E%kgPm%z&6*_KprSRi_o?v_N$A?0ovKbycd>6h^)%%3eUgrRNNs0fB2AHwYV zi$MqN>_SGGv5Hq1*}cX!S=2Xtd#b1wTbS_@)C#lgCB%j{k6i*K8P5Ot5}3-cm0g#S zQaad_4_=0aLLf|EPX5u*Z<8E+%565Oi$9wurE&i3v`J0;IcQUk$74TNIpaRJ5Wg$` zqbtZ}fu>#gLsygA1*~@e^{{{1*b~>2ztNa0|G*7oC*|cI-$Z5vI%s3DTS*N?%PVgM zu6UJmZzqch?X$}ja?^gXI00~g&)t9SG(`APps(wmjq1H2NqU^4aD)!g{ z8pC?=zML#{0ao0}tmIYJvvU^G#rfnB^g1HAViG(5C|b(I#q_u%P*1e-u#Stx7t;+G z>YT-Nu|SgSvZZt#M!0V&wewnVQD9$L*+Wa|T2{4;R?k;6t@5ePmGeC@F&7hEEV+zI z=;N+sbRJpC=TMM&zNFs8e!iS;UKPW-3Nm~jpCAU0#Pluf>*e%K(w={F1&#BCc9qag z0)|hnqQBqi!cL+-kksqqu>pYHJnD@F`H{mU!t*#L!%I0zGRY(aH?INJ;9@7QrjMY9 zJ!|Ny65fL=#y49~qXS|ZNfuf|2Nt^!fmR@eiO5$!R>po}pexuv*3i>PC7WDJ2UquT zoaADXCsv#F`@?-nZvx&A7W@8M+JpgW*U?8wjD56@-k_O6UAA-sU6;RSJ$;cc;H+{Q z(z;?|M~rozDwHtS8tr^mQbAjQwi7Do7o0LZtn(5eWL!s$#pFtMzmA?tLizg5^gOZz zSo6dhTu^#BJlO9mX*D_*w$MD3@`GFGUJb9oZm$HgcU94?K*C8?w3%#kh4j&oehg^F ziIiDxDo3srhcgRAg2jb!&t&}cGWO0^P>+lKYb&+Uke9u&kCw1LJ*^`l_5(dV21SqR z>CV+aZA03t$GXtRT(?c^NCUN_(x8F9v%(dtuB!oAM3NAtspM|pTrw4m0xxg{RzSInH_w@X7>A|>CL1vf67k!CAf*5 zyo;{Ua@0*TZwD=7=b7p9{NuZ5s}^%uyoYY%Q#p$2@&kKljx6GYU!ZGtszg`jKWe1k z6SSO8)DH6KU=>}cl4s1TXXU5R(&b_bdqal-t2h5&R(c76?H_BQ50Qbq*h(MQ)^e`l zhhtRFuRIkSa^bwa&zts*ax}svKCF)r+t5L8UJy#@fd`P}a~<@iU7XmhF<4L$h?x<$ zvW<;MBr1J7*HB-7H)t#zXF=w*e51ZpwwF z$4w{kc*#v|cx>*W2~at@W0&;M(^k1+1qh-4Ir0dxx?VZ~y>xRgZ9uEHdg*J+)M=@k z?QqD+6*;bjC4F=!iL;x1 z^kmYX-#S81A@k!3;tcHkI4#RR;fFi{mCg^+7YVqhsw#K5k?UfgjDm66^5r3VJQx1n zu)>g+glRWYe+|=7JbEJ3157mPM%l+@q>oLL5#Vz6B(#W^-8u;)3vy(V8fnDKzDA9W-T=<*=tQ{pUT>{0mFmhw{Hem3U=hCK z6llZC{y0TT7DT+&UJq)rYqWF&TQg0^=5g*3WBDIULy4hhai7AL6&|{hjqRgnLrjS5 zj|r@J#mRI9;c|3L6|2&I`Z|bt!zpxqp%d143Oyfye&H050ASO28nx3-D?8^j+P^dI z9m>UU_@(Gvs2Q^-73VCH!_=FLt^E#Ne>7@Z4{O?}rvD!;$G$_)Tyt1o&}2$Po!bad znn!+@e)fMUF8>~F|GyM}_j~lB&4+dF;%9DfVjlrt}I4^YI> zlkAg==%ttgbU;p#Wn2^Q&dnYMhfV{>@RI!P7lU*lXr5tIq9G64$YpW)CA0>49hZP3 zl}A}A?#=C%jB`VB%9v)ZwX`Jvqf0;upbkZepy^6>(iL4V4?uYn##{r+p|ek5PKmVOK`B>&V+;KU<5{LFL1ga`V$^k&+!HXIkd$z(iRuZL+m z;uXD_bXSxEP3p63Tnf zD~^Un{L1?TJO38iuyWWdDy}cTrKC0(VSl)Vx)8SAek(m;dB!VFg#1~4+f!*4U{~A< z>(Iwuy_Ig+lu1cC46hRhalplgVG_7t=~C<-oc{{2^4q|=8D_hUHlprc?C1~e#eQr` z8roayi^rg6^wy9#4>2>K^)FO*q7N&9kAA^yqee6=+luJN0U| zn%K?{%BAB8ID2;=q$^!&S(1wX`25>e0m>dVsEB zr#(RH)ps2#{_z1i0tepu6PPVgcIHp$4jN3c&c6#QH+WO2P%x&)>G>!(QN9r^onRmR zgtiFX9!b9Qs#VPOAaxsqh^VTU_WY3kx>zPU45``ZM?f*fy&!7{M#P*KmSw+vkUmek z^EdpI3Y>dxeh3OJ%wBy6S|P_#b1N46%ER=Sr6Ztceon7mr;sr-y+JoD$`&z|W37+C zEOoQ<9|1Wz*$YUmO{Dbr=Z|dzRydevW{l!wJdb6_&o}y?E!@r_FJbv*jh>2)^{`0ho z5J$fD1xh(})E%NF*j{Kp1Yu-j{zEVpVACF=9!%t`Ljbrf-}P%~F*2Ng>NoVy1dMj@ zzZ6sdkN3cBD*YXX3b0FmN2k}#p?TtPG*1A{Z2Rx&wd)ap=t<%z1MV{6FjYzqu^jNj zeZjq`F#GH8VVQ*UZ7XoFcg6UvEfH^s4DX#2ws1Bdrd!#`@6q}B4X@HZ z&JdZ`XglQ3W3SN^M!oAzTFTn~K(E33`+op9!+GcH^euwzsiWV3(hlc6Z*T{oL%}t> z^-b7Q;fwzSNQd)V{{)a?1M8%>sB=k&=P)|&Vh_DV-zHnZ!&{E4<9OetYf(P)F1-@L&9(2*-R!!z=`rl=_rN~z#r{mQM*`+v zpWdy)oO$1Yv+~uS`P8HNKfRB3SnH`DP{XEhY_Av%N&ZlE6pAap7iUG0s6oOO+6y!M zsSoJJ4QU*C4;kvyUR)iG4WWtT3W)=SH>UZJZiXDye+Z+nl>s6f*z||=9An4b6G<2QtgrMGb}Og8*+PWgf;OAl^ zF=-m7U-CzP3H~E}`5V6iiRgMgQl0-8v4=l)hzXyhODDatRES@ORkYgx`{ZjnMSAaz z2#*nX6tz_Nob=?k@h>%C17b=e9Dqz*tQ9s$ZePI1A3&Vu-%sGE*TYu5VL%!33DCM5w?R z;Szznx#yP%5K~DemkL9))5AV4748JOuPGBA;-1fmYlS5gj(l{z@a)cbx1{q%u#2k` zQ+ORt)fQ5dKIx>|%IQ@1zLP{RN|eiAHQq!>Cq`IogRs%=>y}RPMG*686jU-NmovLd0!)Q1CHV~;2rVv{p%Mu2*@C%f6#FA63wvFRmYEi2avHL!&`bV7rgRmQH-2`k8C{-929LC34J@p+T+ zOv)e8iIquZJ{~^E_{cZr(~Y{=laFWZuw-;%b~f3?tstG4>y~yJjiQ_NRtfD;!Piv@ z*X_5aB%NX<=|oevG(FVay|><)5{I&Q2I9E%i^ZiPur({EE0Y+qX+%vIl6Dm1j=)Gf z8!O~kkQ3!|g&pco7BU^PnTUT*%ywl%CVPCVuzbG@Z|Qi(HyVu>OT)8yVBA749mq<= zL%iR^2JD*4%_Isn$B>68Y7jn4GF`|UM_wfERXeMk9v{JKT9N0A*cFH8n0FwPP)<$vUrhoV7NZb0PlB!jRXvGsihVa@7J z)EnXkRLyXzMva}|G{|5#yTgEw)cEtiGYC)>ZTXGW0yc5FS-U6GC?`{|Nz~HMg3LRQ&3S`1QzED`j&Nm9x*iHPY5t7To7S;*d*n>u4alWxmI6z@k z9@-&nhB*EE4vaO%HXJQj*#}1p^Vy-Jh4pONPGJd?j}|r{uyyy*!WtM#&m1l2Af-O! zk1$)lQ|N;+7}_bMAh=)KDZGp>?>|O33fABI#|S6Wfo^u_Sa8($juqNyXLlZnReaWe z-X-+l$r|g03ztoG*H?D))2@M7V_$cDZ~jm9!r5FqCUy%R?v%VB3Ax2s6pR~Obd5J! z^X@&uI*NE>;&|Z$ZEH6N*RV;bT0Pz^a*uAB3mXX9UK|p`aZJ6RU1Jiyf21d+uxTHs zvNYS-gf++5-X>xD{$v&$G#bxVPJ2=)3>A{#A0-_}n)`NzWJ*nr_-D(pH2{)TC>HfA zr_)(!YZ2OF&fCNA+vB1)Zr&)AR^03ED%-Myvri=QwZH#nuT*gD!W>QM`$w3PQ3%j zENvCequnX?`l-T3>h`ivPJ#G+rB&!<*VqIN4HSafAKj`wg7w%SjNI&6o3IJpJZ2Nz z&^2Xk!Uyc1E$C`fyCAE@>)5Z_h54xSyLREac}_1sc%TNym42?U3nO#=R5(EODYnM} z{Saf?4yf!1Ywr*mv4FEWgfGj`z8+W0eGxcX+|RD{j*RG?`Kz45yF}y7irM@RI0yXhGNQ;(=|)Kg3rWz0lAb_Xp$qm=x3HsU7)c0b zE)h{&Ii2MyHy4^ElSwR#uPKwziPplqBELL^gd#aXPDsYQ6T@Ca;Bp0WIMXeZugIbR z*SB~{4IU_EKXnVo0|Q^W!Ng9st_KejJFW*zZ)SV>1BbABKtdLF1AjQ!lRZL0W6Mg@ z?7XXliu?(^LWWRBmfd|Wh;IK4Fgt8ncJ7q0HovSN4YbiLtR7BbD_PqBbh*dNIvWLD z{?P$pjPq{wkZ>ySd;5^kCS<(^_S*L$l{}|G#H>C+_#O%7uR1|6lZ6vmxF}#;KN}xG zsOQVQLW5=$c`V)lGVMH3NGYu!xJlT`K0HzQDM{pS^9YOSk=AVSBPn(q!0-xd7klQi zEbK2{Azd<=<;Qp$o!NSK7PsXa&DnYrOAZS=U|8NXEQIN*Tvk-it|3&D!CmH11PV>x z&Gddi%$#rb3!Ow0$j;0#$EdJ|{WyT^T>jSqFxXNPzV!sxsurk4tkKM_3GwfWv8O^p z+dPvOH+2e&632u++j1#GBOj?AvMG`Dg7*CB5#da}v#~r0W(u>uq%c+50V;^bN4$}mVXrUD2}&n+ z<=;sP+bA5hJ-S`kz;4b!Nrdyi%?M!vEpU8RD493Ld1;&tW-*6W zc6nAXFKYt%s#0)@TOG~p!>n-Z^2#}ySF$bam>lHA6gw*?>|EYA%K??sD1|O(hjKy* zj!eCi6Si#W;RLJBbp+=*;*f>|b6LajkxA%QW}F1DTUf`W@O|2oWt*ynGWOx5u%Ft! zoGdrw&z=&l;G5!x89-qwAIJVQp-qb1Tgx7OTbRe>eZpy=aR@Y3VzFH(3vVNGuyH@6 z7uHvG3Z&3LK5z=mLt2TJFM{fBIZd#YSRm6J@W*2M;^&4e`FY|Je&<$YRzHXH$mlm@ zRvQ~XTUbdu(a+gJ9UaWF2hJ7-_WN_Q!p6;oQM!6AxRFssG;qXc) z1@OtFRA{zE5-kd93pFaIM@G?YXg0HUB$SGVQmI1sadzMwm;fnu+c|=cdUJ{z%D;Jz zu$P}dIQ~50642vIIDAduKb`U-a0K|3vUvxDRvOE339*)q9T1kW(vyW1`LhoIrw~53 zULafysbi9b3}5H{vhYjx>1k+u@rA;r@a27956ozDaZG|C^CFj(r#;gqu%hlFZ|PRQ2m-NsMAXPDy>pgF+KxkNYv z3|e}r&{7h~@sqI1LBFPW9HwwgpJ9nhg)-E`ql8_4Dfn)bt-4Gw5MSPOnQ$*f+kajm z^dbP&aivgJmdF8YlRzOi;Lt}p1dfZcsVjvo2$WoNCH$a?{I9PRoLc0C>xD1qWKNOn%yEOT zfm(BOG9U9l_XfdBh&%uBjlyvPf@9lm5gsPg>Seb-09T6MCRCx&aGL=9XIagUg!=>= zq`l(fef}fiyEvP1%I(5-^uX@AL&#{L3JlD1r%(#?HQovD+Qc$<0>ZZZ)prV~6U1Sw z?iQ*wHm~T;_uMVqI1ixvJTE-GGMh6f)*Y@&z?+1aOf|BPZ--9#=zifS;qa6;fBXYL z5|GAzBCMep;qITpuXD54e=3xgI8%mc#IHRHq`LWsk8mPy!9&7M>P)e_9~P>Z{~^Hw zoq6j+h(DO}yB`*wM%*hu|54#FiXhTcKNDUeOLBlJFsMQsOM3$3;O6AuQOTiL=47uv zA#Bl@a*~f}e=fYIG4r=iehzxHv$|ghZ!NN*E7g;Bu<|DbFEy#ypt&4#-T-sgemFwR z`9C}pYbZw^d;M8q^TzR3J_w~pd6zEjU0<|ky@lX`PXJ$ulH zDW<){u*_9}D(`mHm+0l7>`~UhT{tDSG5|QKg4oWTiFP%q2x29pg#%V`Hk4$4AqlBm zt7Nnxqac=%uAJ`SV{~GSS%bHR8!6y!cK6G|re%Z5=tW!D&;Izbu!pAIs-Ljq72&v5 zF?_+Z2=gM4lk7XM2%WSKr#o+gP4m$!FxD;1{VHhE&n|owVsC&gdrfG9W`%gKVw0~4 zKDc?vDraB5Cafj>ik#2a{y`Wet1N&Pce`+cvH(M^8LpeV8Ay?+xKEnzkIAw(y$*TNlD|K-lRx z?ybUqQWa^)4JgIghCd0b_NUy1cn4?9%4sK8m)>Gt2GIv4D}t<|MpSZqvpJBig-RJ@ zsn}F%1k|L0O(kOl87elF7oS@4O>Kw2lmB2t>Q^EgXI#*%XyRxHE`TPp5n!SjNIe^(tY9QHt}cgsF^DEOx11 zk5aykV~_GrOLQ0wu#LSLDQq0FNB4?NICzk$s`6&$?tLJys;Vh9yG0L6Je4u<(>Gm4 zeG{wwP*__&SBf%aC&`;ZGtnMZ_DKGHJ}xY?&4!`}C>mQRFZD-z0z!?*yduGmqy zJ=`&&qPUk`{fS_z=uOp5cq18qO2P3+M8WX{$8mc`a@dEkP57zcs~?Hr#Qwz4NMx^i zE!r996?;>>qAxV$jPt`Cy(#{ppt?7MY|$Ai(CK0 z5xMT8b@x)u&q&GS|6Es)y+|})Ag29aR8vES^MatcpCI{DjpjB;^HD9@^|R`En#=Uo z2re(TS>`}9yMa+rVU6q)J1x>tJB{L?CI7)ZjgET&%NA&Eqn#G^&;rc~Fviy|)clE} z`0It5SBS%-0@CjgGl97-`K}0htEx)J_86$npgU3hDT%rlnc8I72nzizszg)!DFU4BBS=&;S zce9h1Y8Z&MY?+d3Tc&vyF@ROeHBa$vq&HS*a5lF+Us0kwnYUDP95mkLrJ5;sq;MC* zhwCi36@m@9Kw8W=)Nh^ThSe{S1sqbAUl|#3NEwG-haJ3(j~{Oxbx0Kf2Tp+v?>Y83 z{@A^1M?=JcEl8naUd0Hmh>WuH@nJN??(Qnnw3Q@qJ%tO*sAKj66(a$*d>JWO7Ia7> zfw_Bn6YQu}n#vUk^j)EM4|Dby34rFJY;=`oM`_SexT1m}gP}I6oIIRhcdgP?ESOX{ zbt0fh=;JCK(j-5tJmpY7ZP15HAN+$3-2wIfOfSln4?N(W2d~#VEP3#R^xL{xvkR{9 zNvkz!IQ{>%TJzfc9)9yk>|+nC(OCC)7J42mT<7uI3Lj6fsUIVW+0>ER;_66An>td+ zrj8W1Ndp|DDVs8)=(VZ0T(SYlYvUkRPS^m(5uASKpWNhkjD553At468@07KgI{0(< ztkp#3jo74$LFLL2J9eGMM>`$tigg+%_S*isPLn~veR#cQ9zRzU+Mwy1AF}aV`Z4z8 z2F>vN2oktD!i*a=<+zP3)iq$VHc>qO#4i;X+z9L7TCzT4(T=_+1RGj{Bbd!i?(a(a4D8a$7)`K zd$n$tCb${d-x<>UWGOtVJz>odZaK5dVwx9`OvN>MqH#tV-1*vZ&3Ac39#2kH@rV3ur&}Euy=$MV2dnv9A z4PB)=cipThSvsgt#O$7V5Btr{nxp59NBAi|cI|OwHOqdVEMYrt(FB(umw%l=y*V$J}v0SHHTYjs+hbg=^_t#VxXB5fIa_!{lH{69?E z8w8Z(udr(CE42WDH^#2LSy*}TC0cF%Zz1hz{5<4DRD0Dzl<_;C=@|1mv?c7Cn08Tq zcT6h~I+)6v;@VFr4Y}B>7>e~KwJt>FewfsLp=92e(S}KDe))uURH$y^76^~L<73jZ zz~)z%S_}E=d8=?hYKpKMCbhdMo^MWSw;eHSF_j0HG^ITc5wYdd+Fk6iDXoRsrnO6H z95)B1wXW@>I7(kXf*&zp<&pxn&>Vp$_&NK+UR^lAO(XW#o3v}#r_Q$b#tZAS28l3yWe9G9r_i0b1s4#P~_VSfp z7YEwmC%J=c+kWj?IHXi}HlX-mR#bK)$wH8=k`IrQp!!4N_lh4)OLp?6mavq*$D_cLI*~x=_=W9!7w=3UrzV<aXR7`TjZsf~(Y>&V}8hc-ZI7Dwps*6u0k;N|?L-yF)jSmbW)RlLUHd$j&CwFZ|6 zht(NV=XK>h+V9dFuA>~(ZiYTn=DPQwc2bkWqS?$n+Vw3%*-6o36}!PdlVWaCj95jJ zRcwxkZmVdwiZ-hlwu)U=am*@?&oWqXwrpeVI0GrzPrAlo@3H9327q}^n`;?$hf zKrzn@C!IvFUXXgQUa+M*@Y%`r49W$LEj&XE!bOsq53bM!; zsxjNi(HZOoBd~T~9e+nh6DJ*C=P*;3>2Kv(4W|bx5M$&>ABn@#N7P3#$gm }; + +function updatePreviousPkCheckState(eventTargetElement: HTMLInputElement, state: StateManager): void { + console.log(state) + state.set('element', eventTargetElement); } + +export function initSelectMultiple(): void { + const checkboxElements = getElements('input[type="checkbox"][name="pk"]'); + for (const element of checkboxElements) { + element.addEventListener('click', (event) => { + event.stopPropagation(); + updatePreviousPkCheckState(event.target as HTMLInputElement, previousPkCheckState); + }); + } +} diff --git a/netbox/project-static/src/stores/previousPkCheck.ts b/netbox/project-static/src/stores/previousPkCheck.ts index 7fba2faba..a5d06ceee 100644 --- a/netbox/project-static/src/stores/previousPkCheck.ts +++ b/netbox/project-static/src/stores/previousPkCheck.ts @@ -1,7 +1,7 @@ import { createState } from '../state'; -export const previousPKCheckState = createState<{ hidden: boolean }>( - { hidden: false }, - { persist: false }, +export const previousPkCheckState = createState<{ element: Nullable }>( + { element: null}, + { persist: false } ); From ea9258d36cabaf5de25c45f65fd92bfc5959bbe0 Mon Sep 17 00:00:00 2001 From: CroogQT Date: Thu, 5 May 2022 13:23:43 -0700 Subject: [PATCH 012/593] added main multi-select function --- .../src/buttons/selectMultiple.ts | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/netbox/project-static/src/buttons/selectMultiple.ts b/netbox/project-static/src/buttons/selectMultiple.ts index 08b5165e2..68cd57032 100644 --- a/netbox/project-static/src/buttons/selectMultiple.ts +++ b/netbox/project-static/src/buttons/selectMultiple.ts @@ -9,6 +9,43 @@ function updatePreviousPkCheckState(eventTargetElement: HTMLInputElement, state: state.set('element', eventTargetElement); } +function handlePkCheck(event: _MouseEvent, state: StateManager): void { + const eventTargetElement = event.target as HTMLInputElement; + const previousStateElement = state.get('element'); + updatePreviousPkCheckState(eventTargetElement, state); + //Stop if user is not holding shift key + if(event.shiftKey === false){ + return + } + //If no previous state, store event target element as previous state and return + if (previousStateElement === null) { + return updatePreviousPkCheckState(eventTargetElement, state); + } + const checkboxList = getElements('input[type="checkbox"][name="pk"]'); + let changePkCheckboxState = false; + for(const element of checkboxList){ + //The previously clicked checkbox was above the shift clicked checkbox + if(element === previousStateElement){ + if(changePkCheckboxState === true){ + changePkCheckboxState = false; + return + } + changePkCheckboxState = true; + } + //Change loop's current checkbox state to eventTargetElement checkbox state + if(changePkCheckboxState === true){ + element.checked = eventTargetElement.checked; + } + //The previously clicked checkbox was below the shift clicked checkbox + if(element === eventTargetElement){ + if(changePkCheckboxState === true){ + changePkCheckboxState = false + return + } + changePkCheckboxState = true; + } + } +} export function initSelectMultiple(): void { const checkboxElements = getElements('input[type="checkbox"][name="pk"]'); From 1493c920fd1a49f8aac53584abcb61c24a49078f Mon Sep 17 00:00:00 2001 From: CroogQT Date: Thu, 5 May 2022 13:24:12 -0700 Subject: [PATCH 013/593] silly text highlight workaround... --- netbox/project-static/src/buttons/selectMultiple.ts | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/netbox/project-static/src/buttons/selectMultiple.ts b/netbox/project-static/src/buttons/selectMultiple.ts index 68cd57032..62e66ed0a 100644 --- a/netbox/project-static/src/buttons/selectMultiple.ts +++ b/netbox/project-static/src/buttons/selectMultiple.ts @@ -4,6 +4,10 @@ import { previousPkCheckState } from '../stores'; type PreviousPkCheckState = { element: Nullable }; +function preventTextHighlight(): void { + return +} + function updatePreviousPkCheckState(eventTargetElement: HTMLInputElement, state: StateManager): void { console.log(state) state.set('element', eventTargetElement); From 3effa37fa77a5123c65dd85e6f87599b99b3b133 Mon Sep 17 00:00:00 2001 From: CroogQT Date: Thu, 5 May 2022 13:24:50 -0700 Subject: [PATCH 014/593] click event calls multiselect function --- netbox/project-static/dist/netbox.js | Bin 375642 -> 376041 bytes netbox/project-static/dist/netbox.js.map | Bin 345022 -> 345446 bytes .../src/buttons/selectMultiple.ts | 9 +++++++-- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index 3d6bb9d1a610d4977fd9c887d49450d097f78f7d..b7095fa78873efc9370ca09754b6e9cf3b8641cb 100644 GIT binary patch delta 22477 zcma)kd3+ni_4sFYrQCOX#3;wa83E_a3IBm-0Ve{mmfYjPsL;lj|*t8 zn-w2^Yt>c8kxTbz&V=IXmjsrUfP|nkXaU#4N=jw|F1bhMXcz zJCIj&(w!(I-ayw^IH9Ls>q|lZ8dk_eB296(cI?>u^z8_7$1YW0nO@5atRt-z1ST!$ z7?;5EfSckf$i0H3XBPQvfDp(1k&k9K*R9IetOb%;Y3IqJw$_XuMd zE|SOXV)>+2*Jv5m2lDY)GM!>;+#7YvPUDsb)H;^ATx97it8u22VIibxa)_Qw zHpp|gh!d}$eFbKyt6pew{PE}buaacLW}iOqQZ$z;;r5vIR1smaB5 z!laG;)A*ajgIFs=>N)lsT#2g4pn(x47B6l{IL;`v{XN z^|QLzZXWw5z-Qv4fu3IqTVmn+z!|^?nlilKy ztIF1nxC#^<_sIMgFfyUi*o4@8)mbPZ{`RUa8F1RjWJ@nCg+0oO+?C~G^)+)u`_*$8 z%lG%GU)d+Y$aqTwn_aA#@J@@k|7!Er7MH@M%`R;K#7GdP_gKLwX=KJqV{2Wkff*OS zx_WS5t!v}BOQ%oA6z_KVWBPShsOzwW{9t%QgSkfX@% z7N5L1DI>#|V0O7!2Z1r@l3_OTG9p*}W-jUy*Ir*SG$<3aDIhcy2s8s;ivrJMWNamP z0f)jUTmjc+9~*G!{V`uA8W7S<+QD*hZL?2TSI3EmuHQnX9pdBHpR|*#HDY8;B{+hE ztqlWSNr$Ymn6QIwA^dEb=I0v00s1NF5MR1Thr*)$=cl#;7;C&>3t|NbDF-_WBN>l_ z?Iu)biO))P;+r?D)5AKti|ZIJtRr5)uQSf}lHHCL@b8EpuBn*a*iCR97A-fPyf~`h z(izt#0j0P&dE=1=E-df8-^h%VrVbS#XC3S~p|w|`P~*rnjYEzmY+RvQSy7#J=z|JB zK|ifgUfq=V_Rp%sD{m^7<$Bo2BucRRd~7YD_L%t0O>Q(MZv4e&S*^v5OmnG|xxg%L z*b+i|OPn=}XZ@mSyW63)#C5uYQt4GhIBH~SOGBN2Gl8FTD1z4#2b=W8FHWt@$&@Vd z{76b(cSvl#d0iXfvaFFAC_%|P*d8*mtAL0Dpb^^gz@~&E13rZ}+6$}U08uilO}z8w z^(##d*5%Om1w5m6Pn_xTFo_g1;9=|z@$kjvqWYGVl+}SBS%a#@-M1`64zc4FAIgh& z-J(S%@%3B&ypVHfHL0{G9RS^66QB5H58}nDTd&w>cQ7Ha@PTAYEZJan6va0elb7N( zGX13mj1~}Yk1Ggw7MQsM#DyT*U7&0$kcTk+h=Xm7>j65Gke>oVFqZTM7>k1~$hR{s z?)dNfP^b9me{0qz6i)I9`cy0f{lEb!J+l_kaGP$~s6#j55t`D%P(awj3PMANIC|T) zrV-eN;c!Y<8rWTEm@4k7McJ7#Bhyw|PP2oxd(z->1i}%}?2g-;t6Cfl%?=%rjv^iM z3LVTwrb}FR$13s3+t;hc9oky)AGg=aK9AeT43d7-bB6~-DPoK;w zjRg@Egq?<_Ub5beAiD-#Ll1eLsXmiYnf^}T{b-EqpA0Yxo% z1h(CwjS2clKnSIWLG=i1tGN8m7aIv9=8R0Z1gF2iX#E9vZ4NdW)#~(N!5_#wf=ri# z9UA=xeQ24hU-6-4dymsCdpjIy+gM$;b?sPzYocTNqLn1xRNNikNy0Y>u$Y zm_ZR!vw;ng<+}~+AS}OexVX)OpgKqIb-{V#;d|G^Ipl+T2lki^+MvMrK_Fm3`qZ!| zIyvbV>gxPT1x#yJ?x7*CG)#>FG`m3?5g4Dqz(84&3Ys;Yk+<4zWa2W`aWZd(c;_W5 z@jhvAHCd6>$V5vkavIol2Jnk2_*MUHjtUH+^O*g<9Y{89qu}_JdgsJTf3*$H0MGtv zrR=D7f)7@DnKvk^)*EHBWa%!0;>0)%tV>+>>w`=3@@CZ45jz_Yh8*IZziyQ0=rA(w z5*S|m=GXP0H#h!f?Ph{*w~@)0UUCLFl>uyaqfy%Wk>9 z3*P&!uZ{Gvg%q2LDfD;$Rhu5O=d7}zfHoA%%yg=Ob;Bs)vyC3A_z6m4a zQ2MUv1la&t(}RXKdwj!8hk;F!)pQ%!4)M7MSDLj6KT9V%ckCI!jRd4T?5u6Q6!` zi?g5XG1E4!fw~n$dW=j*X-JnraRmnzoxlWm#Q{q5Y=kgl$F%P0GBjZnqsm18V`XIl zo@k#&AfJ{T_CRr@dGY+mYS5r~`(vAAOECcMP-z~4S59yv)9?gdq#xJvWE0zsOmC@c zvVcOEXS)gWTB3?>jq$RYW>P$xAnhJr_F9<;FA9%url7d~@mni>JX>-nb#mMyEwCP5 z^#67jmEy%4e*1rvj~B1`orQ|=;@^JPO(l7eeS&Qc^Wf0UJlhN?)M_;{JtfpKydpE}jyqQIFrFW&sr)M_u^Kq4+h zr@*T){va6VkSuC#V+!`nV3ds$u`%6{7TXni>PizI?g3`tHzbK#MUIrL1cfsiJU zV8WrIyWmnb11y1~fCXQ`A{kR5f z^V!0S553S!K~ec)hDz|q4!*dRqAa}l`0xL#;MFl)$*eL<+ao}FLu1V%HIc!8`7u1N$!=OO3t{}9nv*ALnT*d9Eh1rdd3)y zTxgh*SSttbi9R4Jc)`pBVd(~Uh)H{r0IdP$d-mlGR4;$*%a_+88JkpsaVgkr&V>|( z*HhqNS4LKJ%mA-AUG2PbqHQe*SU)cY|G1m#;g8+?M-!r2dGV7!)zl2|z-B&hL7{An z3A;Q(qpqk6{Q?Vv46j_#O;|LNU~Hvr>MAhgAWR10Pz;Q?JRy(>E(HEhBNrMPV!;Rqb-mx~8q zT}_2K@m7e_2E_MY9XL765r06@7P2}JI2{QNrV7D9IDjNMG4NWCtk^Q*L$9r@iWTNg zajb(F4Er?FF;4vaH64}W#Ol|}WuEmXn9&l}8BU3cjLPh-245$`iKDL%&EXYwGb}#; z`ekx_GoD~NO2dMj9C&2>9NRo+tMjHy1pnu>BFd%S8Nm(dzQO$q)6c-joE zeKH&+k6TI}y+x7PXo5+UunTdDTbeCk=LG~ppi{_bW(4#QK{XX&L!3VDNu~l;h}(>D z?55L)HrDTHG7Ru3ftf zaFiV5^yxq^jpq}UED3opq5ptch zQZc7s>T{enuS`x(3Qq3W({Gj|d4tCiOm7LGiIX)+V=vj@G7%hF@#|gl#Ok+ZQzlN- zy;Ua%EzAj~y)?wmDeOGq3>#-@*hEpJH%0^@;(UT&(fn;Wu)_pmiZ zXIIF|b}W}*(j`i^7t~QJFcz_v{oFFP9Y`_58))OiSKi&_YUT8@vS(SimYJMv>#){)q;{K74}7lm>+h zgJL#T$ikviHsx64fjZFv5gQvL?LP6z4<17v@%+D?0ddy(9}Xa&82Hdy9<#wgRHvID zRwW|X2=Ga*u`<2t92|R#O zm!SCN-;;3u9{ohQjj@Zjf3kAGZ&O%)*rq5kb5=evGjW^Z5=3pRhuE2rjqM<7$lBO$ zQYJErXjn2zSioyzLu74ZK!4KTELNXLp<(gj6DAZFUp;Y}k%uU6AvP3)({)WEqlKoX z8e@Y~P%ax}(+&qgmNhgP8u(+uPlphSijRI4gj+)0|DIo-wQ0TNq)yJ<@`V$0Hj7XH zZ_WCUP3sgGUKsMg334Jm>`6E90>e4o<_=f4)$D9Y3gDIT;QTv(s8u-=^5`OkGb^ETFzl|31k{8aK}7zgZiRv(1; z62q4stt8sSa5mUVUxeIxRf>=PbHyw^3sMN~<3CSf(ZQyVY`*)vmNFYV&X|F?dw)uzO1M@7|FSFP`~v7^&U!EV!P3UOEsW6d)5EF4R1 zb#E%DZJ5(%V{2`bljGvj@2U*FuyH>)8!9*3H6*FK{qNXIY*)E>`T{Y?x_kCAMwc7B)Ip8;a^IbC27j1>2X)YRA z4;RlSp&r;1Zk^!)VnaP7)KYH|iUvC*G_~9CLvxV^#zYZ1d9Fp+1zjd5EqKX1bTWPz zp)(PWISTEE9;eJl>!H{?ADz1f*tt{C2P2u(FzX`EQ$;tSx*s2+(G92-Z&jhQs5Tq! zT7dLamksYVZ}VaLIPP44HlZj!a{|TV{p)tH~5n6%F__9T?ShupHPGv{i zv#c9-6l$=ecyKYAhjKWu7#UC=U%D6t%UmW_b}Xi2AdCYqS%U5|I%aJ1V1{kY>W4ik zM^1ple>{*(k1@Q7G!~C)42S=*1VMHSE?IjbTTB&<6Ojoj+)U^EKOn|G6CHP&ba0p|xm)%)JWNm7_)YSQ%CBcH{@m1f|3e+6YRPAG8sanoan+r6{|r#iZ4N zVGgJCZZ`@1yWQ*rj2Uha0=a4)0zRHNdDNOE`BZ6zv0<9L20 zTDc5xAdEe&1^eW7JXML7qF#Kc5;0}m%(W;)Zo$_r2O`&+8o&3FtZ4iPZDd7#KWHN> z>cyHBXbbAcy(ZnY z1_VXsTJcLO(AIeaCUVYe5`-b_Swb(znw4k^lOyAZLr@$9Q^TD&^lHe)!v1Q*G%W`3 z{*`DPwd1c>qFOKvHLK9QD1={Gg`TS7fVhG%6$t8ih=K=LF4j21l03K?Z8=53RF0$q z-paC?_-O^wpwSd@fcI<`wv3cstXqQu8;DQUZeh$NSx?#JTMou!R|1$3yK;Tt!}qO0 zTTe>a$ueXr!403sPL@ut_9Awz2c970;*%Cvfn>??zg7$5EJ4oLmFP#%E_*tSPH*X4 zld)@qIJ_3EnZqmUrwd=O7Og~1{EM|f6DNLlExMWHNel-I7kivnabU%nzJ)ND7ZkO5Q9$+~yiCyBy)}c14@T{puz%H=*Kr>@6;h488U|j{U4m;~A zfwfN~oVOEz$bs*vMy>KOIo-^RmcZ}@FkBHkJImpk8dOH{%0L@#uR(6v0Tb{YHE1Pk zvMb>dI}G)Luh!vZO{BEimAn2?yAsmww9A*-@-=pcowbra-B_(b)v6JwVx0#4y)t2E zqru6^5d81r1_ol7Lv$-2@jowu0?j~>yywX3RDnN2d>O0zP%3Z zMI2td9<5kvu@|C|Ue*O?g+_36)}s~~^BDfgdIU*wKqGRBXfA9?3t&$22wGs#Bmh(^ zJ-r^yLZA{}(xMkZdtI+XM^Fo9H=wmLoD|->0XBOak8eN?r;OVRl2f=jZZMY4mhPZz zn>@`-Uy0Ox1+MDFA8$afqdxrPM$`v7rJ6x2c98w`H8VY>-fac0?y@TmLogDHC7D4x zNx@47;t>y+iGUTy7_^Q`Tk(Yq@@`05i}DkLOh;A`U$~kB0=C)ZI4(pK16GJ5;5GH= zAK<4g(WCQ#epl#G)e5t<(Gi4GNHXk+gvSG{+bRoB7Qd)R<&|D5IF!DaKhV={O}{s0*|IhnQMXHG#I@TZ&5 z#nnzL3H^dF0@+F);k34KWA0+O!MM)=+Sw~TXFypM$d_pwYCxQ{ZyPFC$>);sX2y!& z=1>J*dy8r|UUM$0lm2`v`alhi%acuL?QC)!gmWMMdlMQ#7O8(X3Lr304{~U=ys3TC zn;iN?$*}8{UgA;R92oj#J6KyDZ?_?fJWWqCFz@%K(Mr$Q&}=fzAG**fP%P*M_l%c1 zATta>^@tOBq4>s$Ho|l|7t}1$`7ZQ1d3jbZYJt8_^`iF|$?yl7nGpiN6F+4`jI=d~ z`Y7mk{xGV66)+iLh?njjMn_c8=!l|SWsss82d`ZV`KU$e@zQlsA|5<`DTY=-@o@~X zm2jGMg2E$4l0?`cx3wt=H=)w*IO-*+-~@;U5UJ56=pm#Lg${6Ast>2E0;IhNY1Rt| z30`_LfsR4uDtV`y;HAq`=utA$X<1~0;+8Dh1X;9N-IN!O6UtSnwrBvf78qi||H`6M zp{pT>;3`-;J%=73i&--X#}*zpO@e2}WA`LzQ6B$v62TR&bo(SaMYV(+@!>EJ$b>?H zq?X73IujlFk5=j0{V0!MA*}2Ufa!(XmnfXyb&Wg(1^_LYT)cGZPf#0~_@@U@6BLgh zKwIP;Xm4f`(>weNV59{n6R}LUFx(h%FuAdk8ECUkTemg|`1F9nKLUR45_C{ztE9B| zQn2SBWEW#}1$gg<%g}|WOM2uobP!bz5{Uu6FZi;FF|wNvg42h#TVQN6-KJ90L_xAGg1Gzn75KtOi8M&}KZ>5B zVf;D2LywiKOa!F;4YYkV4cmv`dJk1dSAKzPv!LhSzCnkmg{@{L1>u}XEEQn;FFBji zptehHrZ#Q~xJi35;7@vTYS5Xfk)qq*6!;7n^)zV#Sr~|W5L~1yR`n?+UNegw9JF&qx015rB(@A z%@k^t{>MyRhQNIkTB!$6o5WbCiA8|w&ApT`7wA~Iml~vj3zI(TZYtoGw0`Of6_s{N zHDT(_`G~(XLw&f+?`DSGrQ@gHy>VFjIzvTNaOez=QwP;SHxo(WYt>Yhv~q$<&PIZC z{#jJ53MHkZ=TH|=z%xz%MK!2_mBtTJ91Xm4|6vN^2OjCOOQ=eUin#GwSc+7A8MSB@ z5OCAg)NTY+k6%M^vwq8swk8Fx{4&|t*$_fq#l@$S9U9^{gEiMo=4@~vM{y@+AIaNiTKTW>u?%|^(CKX{nB8fH512n99*zxD`q5151t z9|bHti>_!+7R45;H7YB7BN zAi1BVo~KcVq<@jBMAaQ`;wCpFV%o3|E=`G!0_$8_b2kpW1SIR0x_?jA63dtS6IHXC z7+79_$f({I1ES^A=172~5l>EX_}HJQFf6C)6|zRD^%bh0#uvOp&BiyqPFdi{2#Z;d z&-j3vEmgfi?IPyrwByu@6(eqK6s9IwJH%!Yz&=kJRR8(Msh0rI>2Feph!Owf&s0Bw z`xYRN5|aCEN{{gM?*f1R@*PS|;T`W&%kU$ArQXK9A5h!zEAPSwBF)lC?@?t))#9FN z#NT~Ft-`w>q!wV$`_z5l`K|hZ+6fLG!AkGGGx@dl% zOmE^Oanj2ts7(mX8_-SR5h>jpT4xll99X zYJBULfEACQ`;uZnj=uVmT19Xz|B7PEAvnZpihHO5e-Lf~EK=wz3j81#@o#Dric`O) zCP9M8o)s9)MZKG6XsHLju?iBh_EHvJeHl*Z@K zYUm}MIhQu0hJcgZG<3Rt&jxK1dzxOqL3f&dQomsnlZJLu-^2*;)X;F6A7Z;q)<<&w zct2}olK8uMv=N1|aX!5kSiEyS-Az^S{*4=__L93BeJ1QTXJrQE@qG*FK@`Kw7tv$H z(k-IZ6bOm9gieDpo3j)?B3cu0k~kLZE*v9;rj(QTx{z}U_n{3jDZPva+vve(EvFxx zla_ljNy$=1w~^7g1)p#NhAkr`y zc=V?9h1!^p-K(#i$T+9=GC_DFCpOl5;$aQr$3hjo);8>9_sTZ0c4Ev2z2e2Xzt9ks z8^XR(xn4UFB(Or$6K3Ht=<&lhN?!a*6}=t#@Zz=f@8C@T$F)GgVLWFYypXM?optK)XBX1tcyt|5HtxLiReCr6ZXJECD(VE>eqK$l-!Vqkl1Zmyf`&1Z z=ajx!bpuwgFf&2M39n`>EQe7IyMOch=BGYRrj0HPb6_lbc?SkJQjw zD(A%Cy+U(vs-!I_FLh|>duXRina<})#xkiuM8ni3oY#iEr5u40Zu+ld8@~URDwV_!=#} zVrBb(ycNKfXqZ;~qL!{K>xb8cmDC4_^b+mzZ!NuE-vw_V3a#w63|GSp{zqGNI2zJ0 zfgJAC(F~Q&;WKpfib^2|HwVOq)_YU+O4<(uij(*@9jyfg@JAipilDQ!ZX2PXg`s`4$=i5x8nA zXf+FdW-F~h&G?+H(6t{Q-Ab>-OSaLo@k?9jH4xbNguG7RrQ7H}F!|wabP5#W@ohxO zSn)^O=`*M{Cw^%My$YYb19Xfay|{y>=_Lcsh8`!m*$u*7kh7sx`bz_SKCvS4o%DC$ zbK>}J`tPc7CoIjw(d$>#IvFiF(-66a6GJZ?+TfB=8^+gi^u?eLw>1OKDZHnd-qZ=M z_1@HQEC+I!0tSc_s=&x{-3RqynepXnMydJ(#rHvI@I_>Pfey73G5kg|&8+7=z%j8% z#1l^iz*6*rT;{_5^e|{Q*puOaB7novCY~On(Xez&3*CV*-A=EOmRmrt&*DAsA&-E& z_S0qf#4pwJaF3OK7_@3d8~u06m&5ySr&meq+UWtMYh-5ED{b_3D1&#|LD{9Sx&wB` zFSU2jEUEyo4e&95FXBn1Y~fT|@A3QLw0yOLejlNrbWRt27}duCMbKz|2<;QG(lE_o zS;fS2K%gAh!5KP@!zL%)xG$PxH#4CeO9In{OrpKD6M5g%WbK5_L;iA}sl9L&ULt36 z7=U?akW+3Lg9c?c!fQfPIwDyhzLErt)0jbvyl&j zgu?!6m>evNtSJ-MF!{o>ETXPLMOF?PxbYZq(Yu%N(5e?aS+6Hq4+W@8d_S~dvtf_|VmKjdWTsok3Jb4j(-T zI)2{`U?{tD_~1Bf<&u6FpdQPC?InA=TxuJjy(9#2+YtRJGD}yVM)PQ{I|tr7Fm?bZ z{M2&%%^tc@m4!AOYoy_bbvm#EM3ZiH(+jAD`CRGKuhAU7%0sVO;F@mg#2}FCV8x8kAsBY?2z@F-PU-nkx_K7J{?a7yVFLFh>G5(4&^8+Ldm{B- zk8hN03NV@UUXtEGff8Aop&3vjyE1e;HIl;*Z=$R4%^7+l_`ok`=urgfW_OM*o7F=2 zu@(>JU{}WR6*-z;(g!S{i0e49Q@!|;9K8cPzq&lV8HhQM2g5&rf0n1WEp4CXCFl!w z0>6}}%i3E3HN|Vl3>P_v1D;pV1r|w%eHx~pFo)9QhlpYflyBQ~lQ-rc(=c7wFa{hl zh&#sUbE*Cu1~pqDeKJPxpj5mM!j!s6pvZs}o1`g3^(iuqAAXmfg~ciQL2z`t&!GQ+ zU}<${(oNt{2G0cDPW3>?S75hqIg37zo(F)ybJ+!VDfsXt@KN76G(xBq4;-L(QoRM3 zM-R}4V8gg`LG5#R z<_l<}-UH1Av7QDLDK_f;;Z!u7N)^WV@Zk&Sm7w2ly@1wG!8|sOfw;VL0lf!-P1}8l zK7v5SpZN-1fq_Kjc-CRsLZ$MG#vD0J+bB5DOCs$@sz{#6;B}YK>nUFz-}w`Iy%f8I zUWQbV!w{6tzLcH^)-jI{V=#Yy{3fOc%ZKxDo$i4ka{bV0x%xdDNZv&p+b@ItiQ)?` zqYr>UlwVG_mihDKf>ge1YL3Og;SscP9KW2dfPPSv;VUkuCr}nw9-(!h|G6XdJrs=n z;!3&~d2z>8bVY@iP<#w1PK-CeNQXg6#_;%6^vQ6&d+k-g%5LfRSJ97ylwo`gtUo7x zehnQ*mDxO_oTB)c5DbTuBy}b)OYR6DLr{T9Y$0xFRL(Yzk#lz^7(1y2Iw8Uf&L5v&eEB; z0YgJjqUjEL8}MG{4*E`nTvFXp`sG=G{l6vp>E(Q0CtGaDoFtz^v0SPNe|j5TiBH@| zZ>DF~)Y9%>(Qy(MIeI_Mm+>jxgdphMGPX|gF(b?4ISk3jQ(@>{wYG{5n8^k3(90uV)ebl~bIXb=AN6Z9f{WE?a-m&cA9=+)HdObS`0 zH=m$CKrkTi`Jhsr#0u74a3-4%&>V2bk{9X!ra-$t@OwCAE$+#~=~D@ZLPkw5j{FJE zspI&8Khga#dBrQha~28YdoNnrl2;tPqK8+DKYNwd?rVo>(;hE)*YE(Olb=l~nP{zq zX#Fy_#4(mnoNYi6#cG&{57?ztWhYN=7$hW=eMGq$a4A*LVsbqV^@93>dhNulelmxE zuYQeQTgw6WC>&vfC&d#YOw~>}hy@6i+A`@vlOLL7 z?Ggrp%AJObEufqVO>t;awn**~RjTq9$qgZBP_{^}W}&)})Qcd!_~F06nPd!q^cUI- z>a*jo^jeA!D9y-TR|Pqdk?&hEY7}1e}!*& zmtKRx@t%##-h+vUAX!ZApff$(F6GLkLYr+A4@+5 z8++bI^a_YP!1FbrkB)v!U%rG7EBE-xake|D?Hg>&pL)ulpV^|-VWHY$&_Q6$lVKD1 z%fG{RHsg(-&;y2^!fXS@&;7y?I8!t2@XaFmTB;R3+l9~Vf^sV)z4Z`eG*nG1e&rK- z9W^lH>%W?KGg(F+&`@w|D||-7hgb(>c{jF+3*Ob>^a*;&7Cr=vfrCgm1o72SVJ)7* zhY}GbE1vOjtd)%OaFde}4ofHKsyZLXOk{+VCm3ibWmLNhdFag{)4^pude1GO+DW+}TK*Zmed(A?j7~`MRfy4n4}C_j0!jPj zXS5T}(%*hYpFL-J7s<&>dnZ9kz`689HZgB+C@Ac<#g`W6m{ zJns0GZl4E{&zR8U6*ltt=ih>Tv)~WDrK=$_%j5)n=D&d-H+@H+GK&hpNn5RYgp|xI z)zwtmj-Q>SS}{kkvzxaWAfET}EY(TiJK-gBRJVfo-#Y+Ivm0Nm-Sd+G5H~9_UYIiddDId{%aVkTheJXJmp_CF3I(WP?^h zVmXllXzaHtX%-|ocewZ*rUh_a&s?Q4f=hbWDph1w$ja6vt#XRaj@2q3u)-CqRh?iS zK3=WLfN$+xqk{aA3=UVR`esM0B-=WLpQuu~=RxG&Z`BT4wJ~g1t7<~v>aJC-C&|4- z&glydNWlf>^ue9AX=VloWGk#yo!ko7=(;KS`#4Ai_E|~bA0~hSFbwXeAd>>Fx_7Zr zuu0l6VIxa^1Okr!0k}(nUb>Af1f{5GspX_tkp@DXqn{SyeI@L>XCxo}x zsQv*?;0BHAtp!ld-=s1^=BdQ)P?>9?{K=5&*Ned?*)^&ff=gU{L{Pl~)l^I+fdEPy z6RH}D;)7!1(sJxesdR9UcR@<^H2B{AX;lRUH+iwFYTxp_as@tpy|f`Ap`2yzB(txL>suy6@c&+@HW_?pFy599Hu6 z61ljV;_+AeRn_1%tv*Zjdlf9~lXFySp}Oz@k!B7X&jsW-Jan#VHxyT%tFi--56@L) zq2~E7)k9F!oTqvfH=VEY;XOZ7?Zj`Mueu4`+TG`?t_HUjiV`}@4FXpy{q<_q+F8(b=Z&g$SaYLlCG>~q zUC@8xMwJKpAHPxMTryxKN#CCOaV5W>$GdNWuI+g6Ce=>hReY0b3tG&N>87UBC0g;T zzfheA5fuN;Dt2+d%%#OFhE{y%%_IF>&2(?of@(Ozzvv8{v{eQvE|hqea-+ zQhIF>Hg42`__hc`7PxXOz#N9WAbjak^)PVFcT3f~;1>_}fCYh8C>uzLJC><;z}s_{ zsmY2TTc%Fa+lsS8T1`a$)e}Gkz{6r-oIdP_vtQ8id3jOmjjFk zbZU?v9>2Xot+BwhZ!AtO{8HpX60(tGAtg7@#g&+TY$bB$1ANG!EC+Ir@O6y3Qu1z8 zKT9q>HyPCpFw=-peI23!5cZ_0Ram=4eKIgp#};)L6xVK1L$12?$QJeU3n9bcLQXx8 zWExyyRzI*FxOX6`K0q#o-xkz=B;|c^^*Ev;qxg-TYK_#JR4=DN2u3pMQ{hVPhK#yV z4b`{C)x1)ijI9&u#mI*TCe)Wh(?2HECa9eJ~pZTIRf)HsosQ}r_{%w!@s7~ zeNc3qp=K&Gqa>~YGV%j`b@&YRK%ox`N-OrMgB19^`}V7i(0X*g+Kz^$@Aj+DLnw}+ ztiiYbM14IO@Kbfi^5IeCXA+3C1_VU`!kCr#jkDBC@vA>ouL4;A{HdC+i;vC_Pcz9C znU+?!SBp6MRieYN{HQ2xioRNnEzR`dm!X?E= zISCjr`wv*U{{S{MO*JPWqGEaAU{Iv`LVU;B>Mi)sREg{qy!GU&HIEOSqh1XMvRltl8{jPW#yRTEaF$zqK-~ju z6gZ&X3a7Lq2h>%|Lo>Jue)~)|r%xYHcUI&8IXSv8^8y62Z_ZWM>GD7J4hBp!W)alB zbJh2)7#n5GqkD7#fh3Yl6Vr_y|E0bR)(OQ)c>a0nzW~A~&Qo7qmK*&MBY)k`)D6qr zGg;atr$5D`s&ywjXDlO4mNArr8NY9!9N2ii`iw>}gpk|<3>(XV`63#MGn11T571x% zh3`bFZ3K9c31yJrXnc6SdZUgrLn3R?lZhzb2oMOh5dy*VeF%1G*9B@7D$D=aYI+Z< z8!KEy=%!~WO7kxcs+(b(K0K%%s&M>xm!U)IQ=rSmhtvVeYQ}4_s%_YCp}HKDWy^)? z`{9;QqAyZI8if_l71d*9qd&HqOGV(?j*HdH0MZ+xTEE=&Ln^|Ot1ea>mpgvsh38`R z_Qm|n{pd84kHS_;4_&N=Or=izXROYnPO1MgbsI%>m~qo3Ama~StDY}Cenfqb8c*D= zUS0*_PeM=-1k>rrrC0}1Ov=8DC_^L|(oUjY^M0;A7qqh^-mJC|!}G>1>TX!@reCUU zsvU_RSs{Sdr{GSK+)63XM-=F#UA9Pf-A=SGhgTj|>wpfxu;pbI(hDSa2D3Kf$WgTx zI$Uy8oq_K2?*hS6y5r?XROJ;UP^eLYY|3z8vMC*Y?U;HE1!O#O7nmU%)*MsUmeu|U zs(A32x?>Iy1BU6~V_-*_c=*v!nRndvq&2{Y3SEoP?H{6ncQ5$-H`ek*X#-D=wc6YO{KXCTFe2UpNADL!t6 O55LBxFYi`+XZ=4EDc3Im delta 22089 zcma)kd3+ni_4sFYrQCOXu@mMvMfCEo-^w`EJK`|w2wZ6T$Q z5SC;hgm5%aDCGzNmbTo`au;Z6%TXxMavyJI9+h@1D1M z_y0;>`cKJhtyahG9L=~B<-S9+tEmCkp^D<^A%BvIx!6lCFFtf&mWqkwALkr$ED;~L zU42NZK$$}?)*_Esj6SA3F7ZjUO01$vrw_QaDS?TICd!C-F+*`^SiGBRMrM(w?IwP@%YM0r&DW}=hBUj>uL$LbSv0u7-U-H z!7Xw}as0?mdHPE6fg?o}=fn?wPM3&hADJzFexw<3Vm)5FhAcWV$n+Ez<(+IBELz($ z2|q6$z*>2x?o+?TrD!D?)HTRNV-p7wim`DwKxzeqh^H?zAgfq@c~YLdbC5|E`k9<; zhZiPK#tH{#67Rmewwlb?JIJ^TJ#7jYjK#?gk`eC75f-uhXdSYNdyZOVpju9yJlcWe z$3}6+u~qU@kH{RmY8jcfd60<}rX6y!8K4}dO?>m%syVHIU}yh8Z1>n$o4DZ0qOw+J z9-|{}nf}@bnP6dThgg5*xu`?@-IeX~#C?NIrtoqwe?}RRJ60@~Uo}It9iPDre)pVu zlymYM8Bbwg+{u~=?KFw|j+-|(ITb36JGFjbBSDxvV+Ep=kr^(Gt#`5pra}DTc;DW7 z=lTYxPM?Y@)TQ0DwJ_48tST58M`2`T9uFf+<%FWc_a`=Z`-#4n_nJ}1k^wDn$HRTVEDymk}S=M*2gcJ&Uj*QAj#73T5V*~$>W zm9onsixKQ>1EFWrBt2L7?I530cJaAObVv|wKR=@prm@8Gsvwb{A!KKVU?dZ@vmFF$ zNjuv`2*+(_n@D@ut{kBk`jfgXme(1ZYb`MlbqRZ&Emjjq3*J;HDgb#A>KY9N;E7Gz z^W?_5?I7fJj8`l_v8E(Unn^cZ!kJsEFH_w9I>+_1lK_YL$!mGIF8xtuyKiMX-Rp+t`8{m1pTx| zd3WRD>pxp59=pC+=Ielwi5KSX_Og`(+Zpl6>s=@#uK&eGS*-btOnsq~$F4|~VK@?k z`lcA`5zqZa-PU2dwkf95<%LR@!omYarm`^93^2^Ix1%>XI>8p!vb1 zyziLUc*Ck@LS+#n(_5IuVP`wZ!r43^Ihc*$)@f&Xf{|XYLK`jl-Pi$8vMMLucEj4G zyq(S3_1%8=kj))qI^9e>$@IDzt6e;FX|brjaVcf8;|Euua&gyy9fVadHfGv4q9s+hDfVSl^+ZbaVgy>uCY-3Chvojs?lV1o#6J9?vXlL{M?MR8+ zeswpph#&t-Q`V8EYC)fjrlB7gAl`{*c2G3jtXpKW>qgx|T}tTp3%glCs2LK6Zob;o z3db-IO6m#&+wu+L6Q|mwoJ_{ZG#9oLx3e~P3M>wPC=8O_eoOs^CVNfXt|Qzrfrp%e z2al0yFAS^)W*{oRL44qr4XOsawqE@7mdY9Az=w@YpLokH%T(?h(=D>MR(Dp)BvPB_ zO+naUs2d?0T@Ora(A9L4=c#ft5s?vZ2BMElXzs4O6zR0HIfB?;@%~%4ujo?bfm>iZ z?b@iI5Br5+Y5-)6!1juZZ+o_u0OT?4O}dw}V&vxCH} z2t~k#DH0dlH3zkbbtl(=c=n%c1WAAM$@Q}0c8IT>yr2T+Pe$?ru-VQw6XI^Svn_-c z`s{4GUEF`Wqqtd?Pkr_RO4~t_iyz;SfC!txR|6%~GAoJosI@7#*KV%wc1HdxesLK&|OY&G#x;{ zpHNlhQ!1cSBXSQ7d8J`03?R}C+OWWQ1qKGnER+|iskD65RwEOWp^lMtOT^m_tHisd zzU5>`CL}P$h5B0y3ExIAR9v z06b;DS(7oC7MM+NC<1F04fiZXCb9V*9T@(pdny-#I~EiABf@Ut&1D2|$Zou+9o~I; z&l>n!aqkxR+kNjN^u`1E~CP@DMHeHE0&fKQgFmg1L7RI3(7l>?0%8D7Q$ zf2!mDnUsvSda$bsm}wFt51!f7WXRLOkRsX|jEtqwr9RI<4f%tqG$>BW2+*tnG*-;- z1>ahutF@55tejP8*vW1&j*V5+i`yUCibllfL!8W(BSxmJFl&oJkw%T;6Ax{2w2(7q z8Vv;r)S&>O2hB}O*RFUX=xTvUICZJkC zpO$!eAUOIA;)M@apl0!whd0P>aTnM@g?0R#;<^n^&gbVu`VlQp4zbh7bQQX$IK}u9 zIJScjZ&O5(tqD#R(@cnCu7PNKZVb-pwk=EQp*HBxEtF&{0byqvi3u`^_)(IVO(TcsttY&0^Bg{cCZ5+`V!L`X$| z)8dL#s0h!QuUa7f<}rtl4C?_UTo~r#6q!E2DclwVWD!Ur&`yxj9ARUeR%0={+B)n` zJ6JtIj3)`0=zy> zeC??vqVz6==CsZz6G_9fC;v#s9DK6TKv2^TYCbq& zE@YL%08Nm~L*dLrkqEL*PMr4CCMw5?wNI^}vYgoaRJAM<`ix9e+0+g@$9iBhdP^S4 zwh4SOT>iXyAW5oy7PQ2@Bm#jNdamHKdI+W*` zHcmAB;q=TQ4lE-OW}K*frcU0b5NABfHfObRY?v6{9e~GYN|p`g_u>NxNOPQ1)MpbX z-v3M&1x4wzX{v)eb>P{}6g9|+kNojJOX8ds`Ay`suGSw;`pa86@sEGnA+MK+ zGY(}vs-6?|&zDgRoY?yOGG8SSZcv{D>v%+dDp=uKS5Q~$2o_A822RT*67FF}BNrN` zz}AY#Jz5E91@o5~B_v(r3Nk5o0%og$^`3fu9W}z8`tS2)NQNd9XPgQ&8?!-0;C1II z*a@slD7cGLjIK^jab_FBT8HxSSGr z@g@k+wu^7S*tyr%uoU9Ft3C|hGg5DV1g<)P^jyN)Dp6w*`8sJ%u9AGreYWg+n1N?f;ZVlt(#jE~Sx@3T7JN!X&E~br! z*TX-}x=MoS^n}YeV;Y<0wO(HQ>Tenf#+1LZoEqRo_LY@;`LxyuVoLDUz|%&Ek|aVA z^0=v>Pn#5;9f&jW0(3E6F-s$P=z;)15M&A&%?t(=P?KRc#_MD5MAC18fK7&HH=NbK zzIu0^p}!}$djsR)!Tf&l75!chUss^|d{88>ZG*fvLQYGko3Oc)VMT%M+_}>LK4ga1 zr~Jtj2~X4+x7HX9;Of^T!+D#;s-QR$XDSPzo8df&f9J}B?%-!Am~IFXbgf>hs8dk& zE?(FEznFfB+uE`5P;FyY5Ui{*X%cx3T zy!0PlYJ?|Y5vqw77yNV0g6=6pbfaCoX#VH#sUcpR`)1AFL0%si2a;gAc-EgO2;EV? z;P!<5HQhWDa3@nO{^6PioS*Mei7RVxR_!NH1gsLZ|-#V@_Jd?vn*W5jEyz&{Vn`%xl-V| zHidK@aVAk%phpotOmlvL_WXil#aniAiCYX?e++P8a#H-#uT|?-{8E4XkK|+2|!paI6 z*mTIM_(f5u6M2=ivQg6R79V@(VH6cFeD`dKu+Dz37r90MdzRva6+BU$Zj`8%v;fo+ z6xfjX@O!&aQmlCY4tZ(2_|p47TS=DY;!LElbl9rk+m~U(r_TMrr?`(im;i+?Uh%&l zCcpt7`bfElv5L2Rw6r&ERcJn7Riv0XBfHFu&#Kr216I~e6iv*^wvs(WtZWA<<7tIA zn$k*KAZTTSWN#U(VkddT^3zEa5HCG#LO$`u(`Onvi0@7WZo$2-h^MvCR99iFaR|ya zgRI-Z6J%LKouP(175KOxp#kxsPXcg1sQcH2#SyF4LtJ&@bjw#w(AgtC@vn-tF{{=g zFr3iu1{ZQPHQ-Lwa8P%+%&pE2i`h|=5WpQt_dGFPX+=fD6HX{P%VUUoQP@1NgR<&;ATv_p1Nwh9Ktnf11n9RxN}V zqH@5DamW?L=mDJ&^3~YIxBpWHp@3e#*$%d8Mq^`R#n-=$G%v% zfVb)up#gKYL|KbSeYp*Br)s{ui;`({Nc`+;W^bDnv~yJUL&}xg8Bo%#R#1FrCfAR_ z|H=(Pri0Y`tJm)~y>T$Uqg+AMqh9)ap(5CfPmKcQ5 zKzT46^|-@ezeGLa)!*n*gZRuhH8U!$Y`t}CtU+A(?MlN49NhPuBc|KRj#vw~RZN#v ziI+wow%IA3^=&z-6!(5xO7&Xt+!-JSzW%lzbsgS?oG6ZG%|x4_sGEs;*TR*vNvH<$ zg!^WAfZ$LkiM3S6g$a!v6zV#y`2Lwl17jixt(h4Yc0!l2u{d5Z3$4KqAaoAmFh`+% z&|~{-v=)jzv(f$)K+bJ~J`heP2UsV09-pui%3JV38l6DBc(V$fOEp??`y8aFdaQWg z98^)#XeH9Fs;b+X=Q48b+lE)E(N@%hyVU5)O|4c&1Ca+}Xh8IC5Kuwv2*PBAXf8lF z*<9BIo0yA=Q3u{J4Xs?&V$B;For)-J1Dl{Acbctu;XG7|4^BhVhuVLLDEhuf6n@hW z6Ge)&Paz6Hu1_I~glUo}LKsa)^;Fa(KKsoXGm|DZWEvZTn(>n54#sWzUm^&bShs1C z2)w3AB1lg>hXkf4J*kxo0xfA0&-u0l1@N31D1e%Aat7j%7vDMK`!rJZ|3xEdeBVs8 z`UgqmI)ysixO6ru|1OEZn|Ei!@;=-)2W>zD_?$UNQ|dD*#~(ILIsSGl{`DNR1^S$x zgRb1z_nq@k0TzDX{DsNpx&*#&E-KmKpVBmvsaX%sZP%m_37GO!k@Cm}LMzx>o(Wqk zh8N63+m=L3lR}~)e;Ej3B8Xk{&?=O{d*`7g$b&DN2b&#MPSmWNXiJ72h7*MvoG9*_ zk7gkk_RmKK@#4j3BO1aN6r+{cyBMu2;-Zsq>AhjUJHcAEMa>`(dG*6%eFkUGBCMnD?;UK;@^Zo=0rL>WtyNvi|J97^h4E)w~7 zx!6${Gf*S=v*jE_eB3eesO8~M8>3(>$sTC_?f9gytH-lTQ8j8H#nR~j2_f$zrKl2* zm!gGe1RpF#Oc6hI7Ycft@HLA8z4fNr@4O^?Y4~0n*-Pd3+Q?o;ux1I`gj#Ud62#cM zWzHgZ))jpj0>#)^r`(jkpRO><5*7UGM!9)x%psR`c2kYVG$C63g2HXR__-x$^Q!(2KEVDcZ!i$T)I$HZcg6hI?@6Rg;N^eC38o^mO5UOVJ4G#9u8%m7o$T zmZ7^)48O1pJ-(6$vuq8jg_*-PCGg?3$u>@{!&C5R!ZxiJhsw~38Jr?` zdhkVMXelz|Uz7n(%=oD?bOXta7zpI=^mvbA#JZHp7^{bM+4M>np>`mk?`(B+wzb(i zoMw}&m*qVqY>6LUg_^1Sv!)yYxxnt*n;2UGMu$zAHk+R|XJfO4X>F4LJ8Wb^l*4zH zqej_7?rUO(3e!0A)7bOVa5mPCD=JVC>N}S>C2ZN~|!{16EqA zhc%JXWK-_ z8?r%ulC8D_SFc8^XItbWBtZcl_pe4*Bdhe)YP5j@;losc5o5!*RG~eH$Me^sB?|{_ zinkH>uukwQY6tQ5wWvXcJb{0-7J*k_lix7)`6Fon$Vu)%lTC?L)=N*UMbi+f$Iofe zvmm#w)uE%P3A5`^nLJMj?^y?j-GE2dp_=Utwmj$LFO6%A1+UT-khM~@p6M>2x-w5y zBlv@L=w*;8kF7`DAXCa2v}7AOUw1vzS?JxEr|KS?Vk!i}(P)Bcwvn{Egg+K`gMw(c z;V6SvQGGUiF@rqo`fL;Y6NT(XR$*Vbl>-De+T;)}1QXkB5Z1>ls?n!lp)Js(3jlvt z=+Vk09!sq~0RBfJ zR0ReW{%;HDSq^Wtq9%En?s}%$C#`5YS>{jeXgd^hI>0dFq}C49f}ncTfjm%r z?Lg~cIh_+~ap^)Q`i#6hw+l5u-^aVq+w+=>`!a{zTy(C@+lQ~^6+ z(n3Ec-7$cUs-V#xK|6~eEj0%Ax)yR!C$Ps!*F*?=aQL|>S_Z`jQN)&lAL{^tN7N$; zu0uX+T>>sarCl-9ML@xEU=2W0ty9oLFe3sT;G$F?N?HU+brDjm2V4kFdNqztLAEM+ zryJ#@%aiCKveKCuWQF3!4B7yhvs&G_2OJ6I7F0W-0JL!!6373^pfjMWAqy&&lg`Sb zd&y>2jDf?#;kq%f$vEs911ZYkACDopy_IemL)%pg0Jc$Z;{ljp(4Ww9_&?{MqyN(? zUA+(G5Nw2%4FOQSaPblW&s|r`K}Z0=lF`LUXZ#2?lZAhLKB|M_k@L|e`2;%anfT-h z{{jeU&Kkm&ef11KOiW9DxS$3aEtA@XybK*crOkw6fbR2FYg7>GdN8>a~;m9w+Y!jqozl1bvczw~$Xf8s2e8ny3DwWgB^3u** z(VrK<0Tn%fc2eMXXgdVP3j3Kj@$y2`Xr8mDQ0q6f z%k2rjFX7IzEdkPr*iwF1{t04?el{i7Qqf>A>}R8R8lt{f&}RmW^#X#qto zSD~=POr!3ZT^fSMyeu6jo~v14!-BRMf4h)+1J3Y`MN||ax71NYRZTXy#gLY2~LGTSJ2w^AkeAWton9^Ou!oTct8v`Wxwrckf+XESvf z0`pO5r0zwH64OMD&I3?y=%R#~fXC83R38mgnDA0}Q0-<(>!UtbQGI5qB1FA98*xX{ z)O(B4E+*hAIG$L#!+n4k=@zOIf#(I4rP61&QfE`MT`tBS2*53LjYB&7 zcIs9dl$ic5>MkhWyo=h6vJx**$0#UY`!&^t=$wlcZ#`a$+kQ*^2s!cdzoni5ljy`f z)CV8|4&6)Dsz9*C@w4|*+d)`?H4OP|0^Hl$0|D935UNf2{IUXt+a-W!E}HEufMUl@ z_fw59;l=k;b)ci3y`L(DuL|%x4^YRU_525^4ye8KAay6`gNq*mBIfX^hbSG?UU`Tj zqOtU0Y7}bX!&EzXd@%nyY5pVBDjF&q9;LM4{z2OcDfK8dms)6YF~rv)5q()v+wdii zQ|HgKxky?c#P|u_TJYK@0HYRs{u9*su=xBZWytJLQu6^a$@LWV2O14Y`ey;s@*x+o zk!#{nZOE(T6GT9PYA$TJ4f~%1e6>j(f21mj+ROfxs#s36DaSD?wzKjDvPY@$1*(U})z4DX@%1lLP2efQX4c}f-=U^UEB{9AB)aI#SEwaR zT3y-*EKRa?h{7Thd)+CJ`xm}KJqHt=^(u9cXz-8zPW6y^Un6MlkX)}*dIUbFjG|w@ zL8+;EgRb#OF&M}9{*!tW%(;nW=iwLLq?%!d)o)QnXkOFQ&h_#%*!?zjH<*LV-l2Bj zYu}`{N*BIEZ6$y{{4TWv#qWBLT2CNh-lr;{Xnmi$vm`F`+aXTeCl`?O8zKrfj+cHw ztyaTRbzI^;pjJ>|L;}Do@#sg?McDKAwIPhoAm0 z#Q=YO@n32g0l4@JiY33u05ly+9P zE3dA)@H<~o+h%o5)H@~J*Fd=-0aOYZ!>CyrnL(?emvqid+Kg)2 zUF?Sbv-G>yY3tZC_4;+XGxcNobsLyIXeadzjNid-sHr*A2hm<8<0WZ;oR2j!Dg5m$ z+K2>foK2Sj^|#HYJE#)Qw|@Qj9&($bPltTwj7+;6zI!g+hZ1=4JbIXDzJbIG)d~Mjv z?$K9{h8^R37%#k$a~-SQv593A#TFW*Gnmv0!58$#Y8xn4Qy zC3D3l7mUDT!0m(Ym4f(%mGoBR#`DYQ-=i4*OBrA=fM=|t*Ub((bhQw|Az@v7jhil^ zBMu$@cJ9b753LuUqJt0=Hwla@34>RM18$%A=_R<%1woCY6||OeIqVQ1 zbQ5w&ts44H+L2Y3^STq!bkZNzFqH{;!7N!Y?)%PyIp_-!zG&9!55NgHC#oHx-~iO^ z4t9&dz;L*$if#eAxVDPEd9T&Mj`rsqyK7uYrr!x=AUe*N0OVviqKKD zTIkp@(FVMipKuVGV$l%MaZ}cgPqwCG`JPSC2If^zStP#+XbVT(%4C(JaUX1~0ouG_ zt4vg|(|l_sAZ`-j15u!9_$VU-lr;ixWW;Eg?kSzBi3?IK3yCg#m6l$zwDW)73ZP~* zOfP;`OP3b4!0Y@@s{Mp}iFEl=ORrtm18*QMt(>+zuZC&o+H&6=|dE<p#H4yjsh!h=o;TF0ZjDpY>Itg;|l`TZp znDF~s>9eUu2YzlFy$t_k8;Bae^z1g8rWbTMYPucd$~OR)M2?zX=^r)pg+!UecF^B~ zNs42;=nqv54%ncZqt`B}cQ9Jw@(}h0hoTF7I=Fq*3ixV{z7)jbmU;j?gm>4|8``2- zpy+{UwsO>w1Ug9Ot3c0k9Srk512X-~)v!|a`6u3cp}`xL$p$)9jwbNm>S<;z=LW)w zhQsby(hmxw3)nLo@}&kq$ic}B_!T}3NE>*1m_`BV#s<0-QPC{kcMH8jDsG}zplO^N z@_7W@z7G!f>|d#8;Z6(v0La&pX8J??c_Z{&)k60w{lZiG9kbHcpfKKP1DO}X>Q+!Y zX{n`^W>E>uSp%O5c*E{w(i%#p^lqOIoay6s`fY@~(s}LlAyn-H5J9l{Am&fFOT*NM zWJ%-80)n!j4yTAV9-AC=?cRYbyOD`ySrW0%=NRp&9L;&h$0|pyZt|CRkMDsy@&Y>R zLoiuz3OeP63^XXGAy+;5Dqvf#4?{hVZMoh8;)vAoHx9b8$qa8n8WG-yx0Rz=qCIjU zU{p9?4da4skv*kj8pe@-mN_+>ugEe&16Lt~PI}iOC$#DXcgEvRR6_w$6W;^vz#LyY zfwXzNyb}s5KBE&@!Gw2{0&X@sfx<2L1Sy8_qn&h2)s|&P@xkMCg>+^YokrA97N0x- zqJHlQ(3fpld|-rLCN1cJ0qRT^R4}1|#Zq%G?V-Tfzqz0O7uBKMc|J(?9?$OaL)<;O+!HQalI< zjzoR#aJ9$n9U>>AVdBzT33?p`cJRV9&48)5GflTpty%oQ26`pFAx*CbQ~CKcJ%m8) z?8?$b)0zlT*5ke`98CkhB1`iNDuE6Zo*f}NYXpCkrMH0nH9(J;M@QgL30Wa`EMAze~*jHVD(Df9m_{J@*^G%SwO z_kqpZaW?%Y1Usubhpq$LGH?#fP*gW`d;t#o#&hWl=vgok7%@BHx& zX&F9jy9`cf0AF+&eLiqR@#S=5Q94KNPvr}#`e+oaA3^KGvCHWa=m$j+zT$Fv6h(09 zQCbIDfICXxNx|69kI`Kyh+D6uOG<({z}Yb1oG5abBNYNR$>5PI={0csd-at-%fr$i zucRLVHpBQTz<^8o>?%5jN+UT&ajE#I5C{d8BzDFjja@_2$igKj2-^yT9ZiGbk=X!EQe>@OK+jLBtCf` zU4{Mk(k9^lU)~E!j+b`aM?Zl;vQB@1evm>L>G6l?7tuUB>l)_f?iJ9 zrsBsWz4|Eq4pLik%uo)GOW<|Peu91y_5~ny;p!*p_gA&SjKGpfZvu>pWDEpLn_Je& zZ3MPfyzME#Xa|lwMep1^2uvfJseppY(KgV#Oq}qXJT~9Z1Puz;!u!h6R{Zy;=+$NQ zId*NqYJ^pQLgYc3-D{bK9De;JV5Kcj)APaNGCxgMZX5xqrkDxcQ>#F%Bw`7+543_P zfj|`eeuQ+z(?IYb*Gr$FPpP_caIx`+XJ`&+W5KiZuP6}i_x=$auKC?La72}eDWuzs z;P79;Wo^Ls{*~^5#Y*nvGtRW|hGhGv37*-n(J?fEK5F}dCc^}P6kdgbV} z7P5vPAAgB1tK@-p6ne12lVXje;3p`i;7-7=y+rS%5>8o^;Y}~oXOxDfb}8U9ihuMn z-A;Ap@agO6rTFyA^a%(GT>3Y_Ya?Fp3Q%D)1_@Y&hhL$+5S)Ofa{Tox^fJ`0NJRas z^u0h_AG`|IWE9{0cluqZ;n(O4xb*X0r%M*5obWRaaOp6C(U7#|br9#OJ~$LS^ahQW zCjl~o(v8ODaA80LTR;NOdJ8O#2+q7ke}Q~B{x-db8gSx6 zZ_yg*v$yFMTJ3f+9w#n83~D2c7k&U5^n&;4CCE#jEAS)llW4;GbT8ic0ev=zo|7NY zmoMN#%DsMSgzZRZI|gv{Bf5BDD|}-{GWfX&8-k3)+E#qdhqS(#i;OcQ>y><$R|6Gg zXoo>bUmP^BQIfuxOv{6qxboGf{3V(-QXUe@2Msz1sJYW@2mbGeaENid{v*2A(4Akc zYvRklP#An^rV~E+BOgxn8rV+w@-85^Li$@b0Y*br^x_vjqE}H}Q$7T&@YR!T zw#NJyHC&LjL&A4$qd4bH4Nje=7i{8!uo>_?LO}?*2J?G~=D(Rp@=98*n`bR#T$CRh zOY&GcO|PtS^UP>kNV)_5nnG^%a6ToyKFBta{=+=};xx@wWO>#K!05dL?gW=&a`^=Q zk)ZNHx|7FeeoQYfw?oFd^63pHKf#R~V4wl=i@V{|8|Z~UrpuPuAs>43vzqSUMD9(F z$IpBW7~y#Q>BqE#%JR7B6ME~yjEsynNcUBcF@z6(0-VR=Uw%S6AXNR$C-hHdEbbxM zc`45r@CF!??(hbtSvv9siJmp%>%Ia^{pm>a%}EDzoA=ZLBumE)Om#U z9RB$?pvvO-op0!J2+J~A0iW|F5aot%>Fv{~b`uV%RS%MqnWj2U^_lQf(^N}l_-*XQ zEe43=eK1Y68Vn`8V20`@VETJzsCJW1%V(Mw2x#g?xoooa&k#<;E&ypX40AJq^*DKIV zx4waVa|brwx>YLeqL>A~2OfYwEgpsQILWt4^&Gjt+FGId6zsiq8r5rapq#xyWt;&e zyG>=Tgz`uIs^82917zorsvj`hZt&giJD2fY+@gv39n^fuGUhkr$ z>IpEjds3gs*sJKA&B5ZNjg(?r; z{WH}L=m*b(*m9Ao7JqSp%8S4HnQ8|9<%O!v`0}5ruE#&V2o8z|SZh5A_~@n9>rVQ? ztb$AipQgt8gYDJsa9C4g`rbPYSb85{q1!pRkLvQ6)G!8fRQUyHK-ond4=jY7_ZJ_s!PClefyZ| ze7Gi$Ua8s#F^NyER9%BQv3MN#u3q}*aaGwg=(^)N)hevHP6dgIX0auU8?wF%AVhILb}4}0;8zffHOp!;r6vGZGG zVx35C=*73)pwgfg=}$MPp3#&5Z##s3kFdKo1D8rdav&6d>r3hGCsmi37Eiv+e}%~j z__BrS)%d&x>buEX1LUjh7?}7al3EV8FH|qy2!a8A083zlLTy~w(NK6D7uK)W0T(w2 z{c*T<%+EOh=|cF(LiGSp%eM>FJK;AFcEh*Z&JAQbPIz?}p zSRJx$!t(E+04Oj$YzD^ZLq6~((~ueDtEwXTIPl|dAWJwYT%vAU40GJ8Qv(}u`1N&a zO%q%QM`Pr^FG=nrAxTN*RdOdiu@ln|?L2BW$L zRvI*_uR%0Sgxx7>8P;x6uK_A*-K1`Z;_6LmNM4s7+@$`)Tojcq=G3!D0>Tw$^}P^k zmwF@W^C9*ny)LN#Ldv^i>Jfyc6OhOJ&JJ~n)Rj;#rs0?e)9N$ePVPinU8{!bYa?o2 zDb`@isCqtJiS>@EFNda2N7W{%Z68x_1xX(rQ~w;SS12~%`f>Fs=pV|h&jc@mFupsc_*{YZT+ z8SrCu>*BzWPBvJHB=o~iR}o1FW0vCi=c(u7KmS-=26O%U$7+79Z)gfj4h+dzdvG*x z!=8lTiXI|xa+)mO{S$TBTr){B$=?7>o$$T$)SFgApdguw#z?kJ=c}tBD)G?y>Z+}=Ay#80LHlwWWCCiK2-HpP#8AHKf?sEe_(IiT(#4Yw zd#cF=p#zugS1$)QqGrDu^8fJAe)UH1KaTHLcf#KPymB(1pQ@{Ljvsml117OKG1a^a)ORn*3^AUe-8#P@r*0J_+c19h z0`+CEPbgO7qd!ys0{}kzLiO>1NrYA$~iLm_o;38fO@^oZickX zfIA(Qv)ttwD#K(3{<||+rKb<5RjA1EL%VtNpt=?mZpFpwA~=z)7pv=`7`|BD4?(JY z<9ipYw?pIVLux-|GUF8))fRmJA$2iwN`F42z6UO@q)S9KT=1LlWtXali)=px@tVWx zO^Y4h#||9w&|$THarOsZ{OYjUh%HxL15MzSlK=n! delta 104 zcmaFXCAzO&w4sHug{g(Pg=GtCs>1X_1y%{AKu5r#5S9LpjwVhzzRqE$F5CAju`X8v05p^xJ^%m! diff --git a/netbox/project-static/src/buttons/selectMultiple.ts b/netbox/project-static/src/buttons/selectMultiple.ts index 62e66ed0a..dc33e4fc5 100644 --- a/netbox/project-static/src/buttons/selectMultiple.ts +++ b/netbox/project-static/src/buttons/selectMultiple.ts @@ -9,7 +9,6 @@ function preventTextHighlight(): void { } function updatePreviousPkCheckState(eventTargetElement: HTMLInputElement, state: StateManager): void { - console.log(state) state.set('element', eventTargetElement); } @@ -55,8 +54,14 @@ export function initSelectMultiple(): void { const checkboxElements = getElements('input[type="checkbox"][name="pk"]'); for (const element of checkboxElements) { element.addEventListener('click', (event) => { + //Prevents shift+click from selecting table text + document.addEventListener('selectstart', preventTextHighlight) + //Stop propogation to avoid event firing multiple times event.stopPropagation(); - updatePreviousPkCheckState(event.target as HTMLInputElement, previousPkCheckState); + //Main logic for multi select + handlePkCheck(event, previousPkCheckState); + //Re-enables user's ability to select table text + document.removeEventListener('selectstart', preventTextHighlight) }); } } From ef29bffb723c86b51f1ae00ae65b59786ae5298c Mon Sep 17 00:00:00 2001 From: CroogQT Date: Thu, 5 May 2022 13:27:09 -0700 Subject: [PATCH 015/593] is this supposed to be ignored? --- netbox/project-static/dist/netbox.js.map | Bin 345446 -> 345447 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/netbox/project-static/dist/netbox.js.map b/netbox/project-static/dist/netbox.js.map index 8538f4c2a701fe35487ac56132d7e08be5a42f1f..61469e070456ceeedee6d1878b86d8a63390bc29 100644 GIT binary patch delta 92 zcmaFXCHlNew4sHug{g(Pg=Gutas}ReCmnZ3$4nO;XGdql?VA-?_cJoOPA^tsRZ@5L r14$)=2!9< Date: Thu, 5 May 2022 15:01:40 -0700 Subject: [PATCH 016/593] fixed text deselection and refactor --- netbox/project-static/dist/netbox.js | Bin 376041 -> 376078 bytes netbox/project-static/dist/netbox.js.map | Bin 345447 -> 345520 bytes .../src/buttons/selectMultiple.ts | 52 +++++++++--------- 3 files changed, 27 insertions(+), 25 deletions(-) diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index b7095fa78873efc9370ca09754b6e9cf3b8641cb..ce2e0efd2ede7b7f41e1b1837cc1373283e0cee2 100644 GIT binary patch delta 1655 zcmaizdr(wW9LMLoyGLn!G?gw+BC*oQu5&YSv>By!1Vuy^L|9*#@p6}iyL&IY?5>ZM z)D%GxMGwnCAS^SbNRh63H7B3VsF{{&Qa&J`X}-&5vYDFBBG&jGg;(D}fF9oUo(4|O&LP)Kh!t%0n}+xR?CqLja% z1?18zANb&;GdEG>D|a>p0lV_<<_5q)BeyUV)7@KI;G%h3y(pmVTV?oZQgbx&6tP*< zVu8}$GDm|%I%>NQ*|cSQF*0dHYZ>M#n_3fr`Sj+FN3bfF+LD2I8l!B1g`QHrzyxLW z&KMw7*}1C|y^>>vVpnMU#V)>mJ>3!1(LL(h5S8#fZXlhm+?&Ix{<4>Zs6P074yT&7 z?^6wN#|l;#TNjD`wBP<^WKyg!r8{if&oEI*KA_id#5so+Uu?TcQT>q< zoaU7ysYp_Wf0?J{IO)-Sm`tY}i{>;-jx`}mdGWXj#O4;Hg02?Iw6Ds*xn4NYN+h=+ zKlw{Hf8EIeFFzSXq4M&nsUWgj$m^~s`=&}qO58$bcPyN}2a@X+tlja*a}65g({F!p z!l#&jT*~Rw1LqfV_+u_m4*%4JMz|F5;s9{^%P(E!+#MYOaNyTEWn?SXpWXl`UU}Ki ziEFNWq~*k$uh+p!<8Rbp3O#q@7{=3$KmUe!h2ET~<@C?rUd!nh-C4rv)7y6sBU#yg zFO%p*w-8U;?&+0*k5&*}x?2#tqJ57?>yV-R{+BllMQTwG)b)g0)%L~OzDQDO1U>;~ zvayj!LzY?#9+WSc+^${&JdKS%VKa*gIty~6n;3>_Mxx=KGiH>b|2l0 z1RLz{B|1)}v6(sRhwNR_*oZ$1g{DpaJ~R zsDTD;`_!<)h2{*8F~h;+d)of0d{=uIaH%8iYc2fjtBW6MGlqm&6G9rlJ*3f>-w)TR z_rpn+>p6d}C(0|u8NKY`IfM@~naz^V>0GqPD-HA5T(aL5?{sG5N(HtOqlqP#kui$} zNiqeTHgA+iG8g?1xPnazgbLxvb-X;{9)mM_}onz?27r%8}Q z0^2iUQ{aiA$L95Uq|#6@oa>&}JS~soR;9c}mxK3z9ZE|}?LH~rTgcZ}z!sH}HzN#u zAtjDNyEnzQ!1SbB95+l%G@1l)_iF1iYNfJB~?{8w;R*+&tS61SMUb#5kBNyiu zTGO>b;KsIZt zAghqaOe@JC_|>G9WHEXtibA$H$7GX?UWtj7EC&HL-UwDU)^3sqBXFx@79tucD9-fV&-bXFrFEz zNd$XX%{}AQ@7IxKTDBob!kHW-L)oPuw{H!SVO-Y{B$K!#rj{&;fQ2=GMjpbV)+w$Qbl&CibSz%yNCs;YV2;Zr^i2ocWmzf delta 1606 zcmZXTdr(wW9LMLoyGNPPXfj=xKmu`)b#4xrHlxlu0`+a}k-<;1m zck2`F?Z?`V`SnPU7u3HB#M4#VlaVC1Z(ju1=>zJ*o7B>fiAZ|3p&v_Vo!f@#6pbkp z$_j*-Je_`_D<+SIw@#(yjgeSRk2M}d8WmYAQsrLe2dtz6O~(*Jn|5SiDgA3l4_3&X zJJW!-s8>rc5~A7+517@+ zmIvBat58bk9x8%?wjHt|gZj5uAX(nsZUENN;f_Zrk*{<{15tE_yblrdocsl1<@dT~ z0E^|W?jcNw3m0sKp5xmJ`SG>1!>yq`${Iw=K0S88Ot&1#4fjqm+b zMGC@<NY?fGKqH(M`l2E-V`hJC8C%%F%sV6-S(TycA`0@c1Cd+1;OsRH{93hSR)$ zA`UTf*q7OAj+373#R|IYR4}LMJk^RsdD3YeNP4&+<~|)Er+!rd&h^rnb|TpY>u8ql z{d$N4-h9>#hy2R9M38*DkUiE>@lCCUSnWdcSS)-$0^+m_DP!@Ri_I!n=(j&wkR$7V z+Q{kCzQHmMfBq%P;h($I0-J2U>BsZ0Fm))+YX14*$ARRzGB*m$^7T2ay5g0D#g{T z9!T_ZlIk(M zr9g`qXf*{|MV*T)EF$l5jPALN_lN0Rqxw;sa!(Le&ZT4JkPzN9D<{vGV>YhUi_f+? z;i;GSKd(ui;m?_sv(PGHV?)vK3v(JR#vI8hWjUm2g2A8@xT90D+7cXATUKtCly4P7 zbwZ&zR1^ghFEj4~O@R0FUF=8|NqH&Pte+N}pPMHI##z@IrwPR@pqeZ~Hp{3cVJKyF z)nqmd>_jzr7sV`o3z>>s#j=I0hi|D_Fql{CjAE!H>dH+;Vvc8SUVX z4VljRYRC<4xaU36s#<4e;T>cOo3&9hj;*OB;mBZhwIuB2WV7xWYstfU)jH)uEeTe! zh+3j$6YI!4q_8J-#Ghr?5ylL4WGd6vbLS}KNj=%5MhWY4b7g~@%w*+m;=_J$lh@c$ zPtLcIyv}v8jbwvABG}o_$U{UZeKOGkvFu_O>EcUGH+dV2*>E>0#9}4wFzFfhFCOe! AJpcdz diff --git a/netbox/project-static/dist/netbox.js.map b/netbox/project-static/dist/netbox.js.map index 61469e070456ceeedee6d1878b86d8a63390bc29..9814304071db1bcd00884cef28580bc2cee1a997 100644 GIT binary patch delta 312 zcmX9(yH3ME5EPI50E!eKglr4CZ7jqi6`EZ;Ckr{oK`2U1Lxdof!b_&1a78}gK7p1Z zh?XCr<~O*#G^5q*?9A-nd+&46d+XM^^=_lvT$-EcU?wCOHbNDuoW?*!QwA>R5_n{~ zW!RQo6Pfhvn8^ZjQG5>Q8G$?$$`n+1S|xJC-VHUCz*yOdSCuF3D>kWnjm_zvyacP7 zYT!zb@7Ry_DVSRK8ynv4GfhH;)!O4U)3nwtBa`n65Y(kFDkGm)47||*bdKC@#iqY= spQ-aKB&~4HzKv}&7bj-4FNdOHsH)UQWvJt|LPe#dS;OByiTOzW0i(87L;wH) delta 239 zcmdncE&9Amw4sHug{g(Pg=GtCh5|>ivyQ8yXNmLlUIkV|;Zi3ZcSpy3Fq!G1Jy?_A)d|b zf^;}Lx@LeCxKCGAWOZcnH=O<#Xxa2$MOI6uGN }; -function preventTextHighlight(): void { - return +function removeTextSelection(): void{ + window.getSelection()?.removeAllRanges(); } function updatePreviousPkCheckState(eventTargetElement: HTMLInputElement, state: StateManager): void { state.set('element', eventTargetElement); } -function handlePkCheck(event: _MouseEvent, state: StateManager): void { - const eventTargetElement = event.target as HTMLInputElement; - const previousStateElement = state.get('element'); - updatePreviousPkCheckState(eventTargetElement, state); - //Stop if user is not holding shift key - if(event.shiftKey === false){ - return - } - //If no previous state, store event target element as previous state and return - if (previousStateElement === null) { - return updatePreviousPkCheckState(eventTargetElement, state); - } - const checkboxList = getElements('input[type="checkbox"][name="pk"]'); - let changePkCheckboxState = false; - for(const element of checkboxList){ +function toggleCheckboxRange(eventTargetElement: HTMLInputElement, previousStateElement: HTMLInputElement, elementList: Generator): void{ + let changePkCheckboxState = false + for(let element of elementList){ + //Change loop's current checkbox state to eventTargetElement checkbox state + if(changePkCheckboxState === true){ + element.checked = eventTargetElement.checked; + } //The previously clicked checkbox was above the shift clicked checkbox if(element === previousStateElement){ if(changePkCheckboxState === true){ @@ -34,9 +26,6 @@ function handlePkCheck(event: _MouseEvent, state: StateManager): void { + const eventTargetElement = event.target as HTMLInputElement; + const previousStateElement = state.get('element'); + updatePreviousPkCheckState(eventTargetElement, state); + //Stop if user is not holding shift key + if(!event.shiftKey){ + return + } + removeTextSelection(); + //If no previous state, store event target element as previous state and return + if (previousStateElement === null) { + return updatePreviousPkCheckState(eventTargetElement, state); + } + const checkboxList = getElements('input[type="checkbox"][name="pk"]'); + toggleCheckboxRange(eventTargetElement, previousStateElement, checkboxList) +} + export function initSelectMultiple(): void { const checkboxElements = getElements('input[type="checkbox"][name="pk"]'); for (const element of checkboxElements) { element.addEventListener('click', (event) => { - //Prevents shift+click from selecting table text - document.addEventListener('selectstart', preventTextHighlight) + removeTextSelection() //Stop propogation to avoid event firing multiple times event.stopPropagation(); - //Main logic for multi select handlePkCheck(event, previousPkCheckState); - //Re-enables user's ability to select table text - document.removeEventListener('selectstart', preventTextHighlight) }); } } From 90d8395a2c9438b99be7ac0213e08f38cbc2225c Mon Sep 17 00:00:00 2001 From: CroogQT Date: Thu, 5 May 2022 15:24:16 -0700 Subject: [PATCH 017/593] Fixed variable type issue...i think. --- netbox/project-static/src/buttons/selectMultiple.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/netbox/project-static/src/buttons/selectMultiple.ts b/netbox/project-static/src/buttons/selectMultiple.ts index 0ec19672c..8d75fb866 100644 --- a/netbox/project-static/src/buttons/selectMultiple.ts +++ b/netbox/project-static/src/buttons/selectMultiple.ts @@ -14,10 +14,11 @@ function updatePreviousPkCheckState(eventTargetElement: HTMLInputElement, state: function toggleCheckboxRange(eventTargetElement: HTMLInputElement, previousStateElement: HTMLInputElement, elementList: Generator): void{ let changePkCheckboxState = false - for(let element of elementList){ + for(const element of elementList){ + const typedElement = element as HTMLInputElement //Change loop's current checkbox state to eventTargetElement checkbox state if(changePkCheckboxState === true){ - element.checked = eventTargetElement.checked; + typedElement.checked = eventTargetElement.checked; } //The previously clicked checkbox was above the shift clicked checkbox if(element === previousStateElement){ @@ -26,7 +27,7 @@ function toggleCheckboxRange(eventTargetElement: HTMLInputElement, previousState return } changePkCheckboxState = true; - element.checked = eventTargetElement.checked; + typedElement.checked = eventTargetElement.checked; } //The previously clicked checkbox was below the shift clicked checkbox if(element === eventTargetElement){ From 491a4e7d787a75c0560136d597d491a3c2266bf0 Mon Sep 17 00:00:00 2001 From: CroogQT Date: Fri, 6 May 2022 11:33:00 -0700 Subject: [PATCH 018/593] various punctuation and spacing fixes --- .../src/buttons/selectMultiple.ts | 49 +++++++++++-------- netbox/project-static/src/stores/index.ts | 2 +- .../src/stores/previousPkCheck.ts | 5 +- 3 files changed, 31 insertions(+), 25 deletions(-) diff --git a/netbox/project-static/src/buttons/selectMultiple.ts b/netbox/project-static/src/buttons/selectMultiple.ts index 8d75fb866..8a5d2aabb 100644 --- a/netbox/project-static/src/buttons/selectMultiple.ts +++ b/netbox/project-static/src/buttons/selectMultiple.ts @@ -4,36 +4,43 @@ import { previousPkCheckState } from '../stores'; type PreviousPkCheckState = { element: Nullable }; -function removeTextSelection(): void{ +function removeTextSelection(): void { window.getSelection()?.removeAllRanges(); } -function updatePreviousPkCheckState(eventTargetElement: HTMLInputElement, state: StateManager): void { +function updatePreviousPkCheckState( + eventTargetElement: HTMLInputElement, + state: StateManager, +): void { state.set('element', eventTargetElement); } -function toggleCheckboxRange(eventTargetElement: HTMLInputElement, previousStateElement: HTMLInputElement, elementList: Generator): void{ - let changePkCheckboxState = false - for(const element of elementList){ - const typedElement = element as HTMLInputElement +function toggleCheckboxRange( + eventTargetElement: HTMLInputElement, + previousStateElement: HTMLInputElement, + elementList: Generator, +): void { + let changePkCheckboxState = false; + for (const element of elementList) { + const typedElement = element as HTMLInputElement; //Change loop's current checkbox state to eventTargetElement checkbox state - if(changePkCheckboxState === true){ + if (changePkCheckboxState === true) { typedElement.checked = eventTargetElement.checked; } - //The previously clicked checkbox was above the shift clicked checkbox - if(element === previousStateElement){ - if(changePkCheckboxState === true){ + //The previously clicked checkbox was above the shift clicked checkbox + if (element === previousStateElement) { + if (changePkCheckboxState === true) { changePkCheckboxState = false; - return + return; } changePkCheckboxState = true; typedElement.checked = eventTargetElement.checked; } - //The previously clicked checkbox was below the shift clicked checkbox - if(element === eventTargetElement){ - if(changePkCheckboxState === true){ - changePkCheckboxState = false - return + //The previously clicked checkbox was below the shift clicked checkbox + if (element === eventTargetElement) { + if (changePkCheckboxState === true) { + changePkCheckboxState = false; + return; } changePkCheckboxState = true; } @@ -45,8 +52,8 @@ function handlePkCheck(event: MouseEvent, state: StateManager('input[type="checkbox"][name="pk"]'); - toggleCheckboxRange(eventTargetElement, previousStateElement, checkboxList) + toggleCheckboxRange(eventTargetElement, previousStateElement, checkboxList); } export function initSelectMultiple(): void { const checkboxElements = getElements('input[type="checkbox"][name="pk"]'); for (const element of checkboxElements) { - element.addEventListener('click', (event) => { - removeTextSelection() + element.addEventListener('click', event => { + removeTextSelection(); //Stop propogation to avoid event firing multiple times event.stopPropagation(); handlePkCheck(event, previousPkCheckState); diff --git a/netbox/project-static/src/stores/index.ts b/netbox/project-static/src/stores/index.ts index 5e53410ad..d4644e619 100644 --- a/netbox/project-static/src/stores/index.ts +++ b/netbox/project-static/src/stores/index.ts @@ -1,3 +1,3 @@ export * from './objectDepth'; export * from './rackImages'; -export * from './previousPkCheck'; \ No newline at end of file +export * from './previousPkCheck'; diff --git a/netbox/project-static/src/stores/previousPkCheck.ts b/netbox/project-static/src/stores/previousPkCheck.ts index a5d06ceee..19b244ec7 100644 --- a/netbox/project-static/src/stores/previousPkCheck.ts +++ b/netbox/project-static/src/stores/previousPkCheck.ts @@ -1,7 +1,6 @@ import { createState } from '../state'; export const previousPkCheckState = createState<{ element: Nullable }>( - { element: null}, - { persist: false } + { element: null }, + { persist: false }, ); - From 9c5355a300e4a2139d12f3ff9a60e5415c00e38f Mon Sep 17 00:00:00 2001 From: CroogQT Date: Fri, 6 May 2022 11:43:18 -0700 Subject: [PATCH 019/593] added JSDoc comments --- .../src/buttons/selectMultiple.ts | 29 +++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/netbox/project-static/src/buttons/selectMultiple.ts b/netbox/project-static/src/buttons/selectMultiple.ts index 8a5d2aabb..d05c21716 100644 --- a/netbox/project-static/src/buttons/selectMultiple.ts +++ b/netbox/project-static/src/buttons/selectMultiple.ts @@ -4,10 +4,20 @@ import { previousPkCheckState } from '../stores'; type PreviousPkCheckState = { element: Nullable }; +/** + * If there is a text selection, removes it. + */ function removeTextSelection(): void { window.getSelection()?.removeAllRanges(); } +/** + * Sets the state object passed in to the eventTargetElement object passed in. + * + * @param eventTargetElement HTML Input Element, retrieved from getting the target of the + * event passed in from handlePkCheck() + * @param state PreviousPkCheckState object. + */ function updatePreviousPkCheckState( eventTargetElement: HTMLInputElement, state: StateManager, @@ -15,6 +25,14 @@ function updatePreviousPkCheckState( state.set('element', eventTargetElement); } +/** + * For all checkboxes between eventTargetElement and previousStateElement in elementList, toggle + * "checked" value to eventTargetElement.checked + * + * @param eventTargetElement HTML Input Element, retrieved from getting the target of the + * event passed in from handlePkCheck() + * @param state PreviousPkCheckState object. + */ function toggleCheckboxRange( eventTargetElement: HTMLInputElement, previousStateElement: HTMLInputElement, @@ -47,6 +65,14 @@ function toggleCheckboxRange( } } + +/** + * IF the shift key is pressed and there is state is not null, toggleCheckboxRange between the + * event target element and the state element. + * + * @param event Mouse event. + * @param state PreviousPkCheckState object. + */ function handlePkCheck(event: MouseEvent, state: StateManager): void { const eventTargetElement = event.target as HTMLInputElement; const previousStateElement = state.get('element'); @@ -64,6 +90,9 @@ function handlePkCheck(event: MouseEvent, state: StateManager('input[type="checkbox"][name="pk"]'); for (const element of checkboxElements) { From fbd933b56a82c774853e347627909fe6788f2848 Mon Sep 17 00:00:00 2001 From: CroogQT Date: Fri, 6 May 2022 11:44:34 -0700 Subject: [PATCH 020/593] prettier fixes --- .../project-static/src/buttons/selectMultiple.ts | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/netbox/project-static/src/buttons/selectMultiple.ts b/netbox/project-static/src/buttons/selectMultiple.ts index d05c21716..d8bad3105 100644 --- a/netbox/project-static/src/buttons/selectMultiple.ts +++ b/netbox/project-static/src/buttons/selectMultiple.ts @@ -13,9 +13,9 @@ function removeTextSelection(): void { /** * Sets the state object passed in to the eventTargetElement object passed in. - * + * * @param eventTargetElement HTML Input Element, retrieved from getting the target of the - * event passed in from handlePkCheck() + * event passed in from handlePkCheck() * @param state PreviousPkCheckState object. */ function updatePreviousPkCheckState( @@ -27,10 +27,10 @@ function updatePreviousPkCheckState( /** * For all checkboxes between eventTargetElement and previousStateElement in elementList, toggle - * "checked" value to eventTargetElement.checked - * + * "checked" value to eventTargetElement.checked + * * @param eventTargetElement HTML Input Element, retrieved from getting the target of the - * event passed in from handlePkCheck() + * event passed in from handlePkCheck() * @param state PreviousPkCheckState object. */ function toggleCheckboxRange( @@ -65,11 +65,10 @@ function toggleCheckboxRange( } } - /** - * IF the shift key is pressed and there is state is not null, toggleCheckboxRange between the + * IF the shift key is pressed and there is state is not null, toggleCheckboxRange between the * event target element and the state element. - * + * * @param event Mouse event. * @param state PreviousPkCheckState object. */ From 124e93f73726d99a0383768e797d3ad774a2e6ef Mon Sep 17 00:00:00 2001 From: CroogQT Date: Fri, 6 May 2022 12:16:45 -0700 Subject: [PATCH 021/593] yarn bundle. --- netbox/project-static/dist/netbox.js | Bin 376078 -> 376088 bytes netbox/project-static/dist/netbox.js.map | Bin 345520 -> 345522 bytes 2 files changed, 0 insertions(+), 0 deletions(-) diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index ce2e0efd2ede7b7f41e1b1837cc1373283e0cee2..ce02d4bbb227926941d2adc3ae38e721d48ce21b 100644 GIT binary patch delta 57 zcmeDCB{t)iSVIeA3sVbo3(FSPhpiGhsU-@DdA9j^)|qJX&Oa&wzjs425M>=`O|;4vf44`Z?|Y;eP9Lv DuRjqe diff --git a/netbox/project-static/dist/netbox.js.map b/netbox/project-static/dist/netbox.js.map index 9814304071db1bcd00884cef28580bc2cee1a997..e21571e0c84f1680154cb438612199fef77a0f4e 100644 GIT binary patch delta 377 zcmY+AJxc>Y5QfReBG_3(un}_>HdBa_BB0>AOLCsaCWhoV4ne%aLXD^qja;L}bpgR@ zOKUq3!GGXi@ozYDeuOm3?#%N(Gwkc6_BN?K}r=eNR zA^Vd=D$uDB$_jPNH#-t^FQ5=u*Ibnp_fqNsk)Y?A7xM4cj39|ruC<6R3(;S&aB_9% z!n*RdXW~8hjVW9xE(*nPTIJa@ils`3#C_J)!NR8e6Mon3!wlSprw&WjJ$Y)^J#Q&h T<-wWz^3-y<+5VVYRWIH*)~sdF delta 390 zcmY+Ay-EW?6opB2iZlU>6e37=ZEv9j6$^_q6Pc{bx~{T>MF`p%qp0`?+r(nKJiz!0 zb}E8TVe32i7T!BSLYm=n?)lC=%*UklHfcRqwW?k%REwYLv^~DCrJ*z6+K|D)jiD6j z9`%8gh8j4eW8gv4NW+$z3U9Q)ogsdQU4~5AlR2RXh$sj8JlRKY-qNy~nx8zv3M2QC z=n+Nkr>&ZUjFKsag15=GQ2Ul*U|n;V>Bx(WG9VZ5N^>pCW!X`PaO+bq{e^#y Date: Wed, 11 May 2022 16:13:35 -0400 Subject: [PATCH 022/593] Remove erroneous field from prefetch --- netbox/ipam/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 79804aabd..078848b3e 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -585,7 +585,7 @@ class IPRangeIPAddressesView(generic.ObjectChildrenView): def get_children(self, request, parent): return parent.get_child_ips().restrict(request.user, 'view').prefetch_related( - 'vrf', 'role', 'tenant', + 'vrf', 'tenant', ) def get_extra_context(self, request, instance): From 01d2ede097b8f908f8a57302d868ae0e50ef4dcb Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 11 May 2022 16:22:07 -0400 Subject: [PATCH 023/593] Closes #1202: Support overlapping assignment of NAT IP addresses --- docs/release-notes/version-3.3.md | 8 ++++++++ netbox/ipam/api/serializers.py | 3 +-- .../0058_ipaddress_nat_inside_nonunique.py | 17 +++++++++++++++++ netbox/ipam/models/ip.py | 2 +- netbox/templates/ipam/ipaddress.html | 10 ++++++++-- 5 files changed, 35 insertions(+), 5 deletions(-) create mode 100644 netbox/ipam/migrations/0058_ipaddress_nat_inside_nonunique.py diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 9b061b7d6..c46fceea5 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -2,8 +2,13 @@ ## v3.3.0 (FUTURE) +### Breaking Changes + +* The `nat_outside` relation on the IP address model now returns a list of zero or more related IP addresses, rather than a single instance (or None). + ### Enhancements +* [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results @@ -15,3 +20,6 @@ * extras.CustomField * Added `group_name` field +* ipam.IPAddress + * The `nat_inside` field no longer requires a unique value + * The `nat_outside` field has changed from a single IP address instance to a list of multiple IP addresses diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index 3fa1bcc7e..ea5c37f91 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -360,7 +360,7 @@ class IPAddressSerializer(NetBoxModelSerializer): ) assigned_object = serializers.SerializerMethodField(read_only=True) nat_inside = NestedIPAddressSerializer(required=False, allow_null=True) - nat_outside = NestedIPAddressSerializer(required=False, read_only=True) + nat_outside = NestedIPAddressSerializer(many=True, read_only=True) class Meta: model = IPAddress @@ -369,7 +369,6 @@ class IPAddressSerializer(NetBoxModelSerializer): 'assigned_object_id', 'assigned_object', 'nat_inside', 'nat_outside', 'dns_name', 'description', 'tags', 'custom_fields', 'created', 'last_updated', ] - read_only_fields = ['family', 'nat_outside'] @swagger_serializer_method(serializer_or_field=serializers.DictField) def get_assigned_object(self, obj): diff --git a/netbox/ipam/migrations/0058_ipaddress_nat_inside_nonunique.py b/netbox/ipam/migrations/0058_ipaddress_nat_inside_nonunique.py new file mode 100644 index 000000000..63e93d137 --- /dev/null +++ b/netbox/ipam/migrations/0058_ipaddress_nat_inside_nonunique.py @@ -0,0 +1,17 @@ +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('ipam', '0057_created_datetimefield'), + ] + + operations = [ + migrations.AlterField( + model_name='ipaddress', + name='nat_inside', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='nat_outside', to='ipam.ipaddress'), + ), + ] diff --git a/netbox/ipam/models/ip.py b/netbox/ipam/models/ip.py index a3b8fb2c1..db662f49c 100644 --- a/netbox/ipam/models/ip.py +++ b/netbox/ipam/models/ip.py @@ -813,7 +813,7 @@ class IPAddress(NetBoxModel): ct_field='assigned_object_type', fk_field='assigned_object_id' ) - nat_inside = models.OneToOneField( + nat_inside = models.ForeignKey( to='self', on_delete=models.SET_NULL, related_name='nat_outside', diff --git a/netbox/templates/ipam/ipaddress.html b/netbox/templates/ipam/ipaddress.html index 7867e829b..96a76cf8c 100644 --- a/netbox/templates/ipam/ipaddress.html +++ b/netbox/templates/ipam/ipaddress.html @@ -91,8 +91,14 @@ - NAT (outside) - {{ object.nat_outside|linkify|placeholder }} + Outside NAT IPs + + {% for ip in object.nat_outside.all %} + {{ ip|linkify }}
+ {% empty %} + {{ ''|placeholder }} + {% endfor %} +
From c48c8cc353efc21a20a7c67fa435c19619ef6359 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 25 Apr 2022 14:05:44 -0400 Subject: [PATCH 024/593] Remove termination IDs from cable creation view paths --- netbox/circuits/urls.py | 2 +- netbox/dcim/forms/connections.py | 3 +- netbox/dcim/tables/template_code.py | 50 +++++++++---------- netbox/dcim/urls.py | 16 +++--- netbox/dcim/views.py | 26 +++++----- .../circuits/inc/circuit_termination.html | 8 +-- netbox/templates/dcim/consoleport.html | 6 +-- netbox/templates/dcim/consoleserverport.html | 6 +-- netbox/templates/dcim/frontport.html | 12 ++--- netbox/templates/dcim/interface.html | 8 +-- netbox/templates/dcim/powerfeed.html | 2 +- netbox/templates/dcim/poweroutlet.html | 2 +- netbox/templates/dcim/powerport.html | 4 +- netbox/templates/dcim/rearport.html | 8 +-- 14 files changed, 76 insertions(+), 77 deletions(-) diff --git a/netbox/circuits/urls.py b/netbox/circuits/urls.py index f3ee64cf0..894be27f3 100644 --- a/netbox/circuits/urls.py +++ b/netbox/circuits/urls.py @@ -60,7 +60,7 @@ urlpatterns = [ path('circuit-terminations/add/', views.CircuitTerminationEditView.as_view(), name='circuittermination_add'), path('circuit-terminations//edit/', views.CircuitTerminationEditView.as_view(), name='circuittermination_edit'), path('circuit-terminations//delete/', views.CircuitTerminationDeleteView.as_view(), name='circuittermination_delete'), - path('circuit-terminations//connect//', CableCreateView.as_view(), name='circuittermination_connect', kwargs={'termination_a_type': CircuitTermination}), path('circuit-terminations//trace/', PathTraceView.as_view(), name='circuittermination_trace', kwargs={'model': CircuitTermination}), + path('circuit-terminations/connect/', CableCreateView.as_view(), name='circuittermination_connect', kwargs={'termination_a_type': CircuitTermination}), ] diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index 1ba7adf84..13ab0ae09 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -1,9 +1,8 @@ from circuits.models import Circuit, CircuitTermination, Provider from dcim.models import * -from extras.models import Tag from netbox.forms import NetBoxModelForm from tenancy.forms import TenancyForm -from utilities.forms import DynamicModelChoiceField, DynamicModelMultipleChoiceField, StaticSelect +from utilities.forms import DynamicModelChoiceField, StaticSelect __all__ = ( 'ConnectCableToCircuitTerminationForm', diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index 92739c6ed..0c1e0ed9e 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -133,9 +133,9 @@ CONSOLEPORT_BUTTONS = """ {% else %} @@ -165,9 +165,9 @@ CONSOLESERVERPORT_BUTTONS = """ {% else %} @@ -197,8 +197,8 @@ POWERPORT_BUTTONS = """ {% else %} @@ -224,7 +224,7 @@ POWEROUTLET_BUTTONS = """ {% if not record.mark_connected %} - + {% else %} @@ -274,10 +274,10 @@ INTERFACE_BUTTONS = """ {% else %} @@ -313,12 +313,12 @@ FRONTPORT_BUTTONS = """ {% else %} @@ -350,12 +350,12 @@ REARPORT_BUTTONS = """ {% else %} diff --git a/netbox/dcim/urls.py b/netbox/dcim/urls.py index c5cd0fa65..0c04c734e 100644 --- a/netbox/dcim/urls.py +++ b/netbox/dcim/urls.py @@ -294,7 +294,7 @@ urlpatterns = [ path('console-ports//delete/', views.ConsolePortDeleteView.as_view(), name='consoleport_delete'), path('console-ports//changelog/', ObjectChangeLogView.as_view(), name='consoleport_changelog', kwargs={'model': ConsolePort}), path('console-ports//trace/', views.PathTraceView.as_view(), name='consoleport_trace', kwargs={'model': ConsolePort}), - path('console-ports//connect//', views.CableCreateView.as_view(), name='consoleport_connect', kwargs={'termination_a_type': ConsolePort}), + path('console-ports/connect/', views.CableCreateView.as_view(), name='consoleport_connect', kwargs={'termination_a_type': ConsolePort}), path('devices/console-ports/add/', views.DeviceBulkAddConsolePortView.as_view(), name='device_bulk_add_consoleport'), # Console server ports @@ -310,7 +310,7 @@ urlpatterns = [ path('console-server-ports//delete/', views.ConsoleServerPortDeleteView.as_view(), name='consoleserverport_delete'), path('console-server-ports//changelog/', ObjectChangeLogView.as_view(), name='consoleserverport_changelog', kwargs={'model': ConsoleServerPort}), path('console-server-ports//trace/', views.PathTraceView.as_view(), name='consoleserverport_trace', kwargs={'model': ConsoleServerPort}), - path('console-server-ports//connect//', views.CableCreateView.as_view(), name='consoleserverport_connect', kwargs={'termination_a_type': ConsoleServerPort}), + path('console-server-ports/connect/', views.CableCreateView.as_view(), name='consoleserverport_connect', kwargs={'termination_a_type': ConsoleServerPort}), path('devices/console-server-ports/add/', views.DeviceBulkAddConsoleServerPortView.as_view(), name='device_bulk_add_consoleserverport'), # Power ports @@ -326,7 +326,7 @@ urlpatterns = [ path('power-ports//delete/', views.PowerPortDeleteView.as_view(), name='powerport_delete'), path('power-ports//changelog/', ObjectChangeLogView.as_view(), name='powerport_changelog', kwargs={'model': PowerPort}), path('power-ports//trace/', views.PathTraceView.as_view(), name='powerport_trace', kwargs={'model': PowerPort}), - path('power-ports//connect//', views.CableCreateView.as_view(), name='powerport_connect', kwargs={'termination_a_type': PowerPort}), + path('power-ports/connect/', views.CableCreateView.as_view(), name='powerport_connect', kwargs={'termination_a_type': PowerPort}), path('devices/power-ports/add/', views.DeviceBulkAddPowerPortView.as_view(), name='device_bulk_add_powerport'), # Power outlets @@ -342,7 +342,7 @@ urlpatterns = [ path('power-outlets//delete/', views.PowerOutletDeleteView.as_view(), name='poweroutlet_delete'), path('power-outlets//changelog/', ObjectChangeLogView.as_view(), name='poweroutlet_changelog', kwargs={'model': PowerOutlet}), path('power-outlets//trace/', views.PathTraceView.as_view(), name='poweroutlet_trace', kwargs={'model': PowerOutlet}), - path('power-outlets//connect//', views.CableCreateView.as_view(), name='poweroutlet_connect', kwargs={'termination_a_type': PowerOutlet}), + path('power-outlets/connect/', views.CableCreateView.as_view(), name='poweroutlet_connect', kwargs={'termination_a_type': PowerOutlet}), path('devices/power-outlets/add/', views.DeviceBulkAddPowerOutletView.as_view(), name='device_bulk_add_poweroutlet'), # Interfaces @@ -358,7 +358,7 @@ urlpatterns = [ path('interfaces//delete/', views.InterfaceDeleteView.as_view(), name='interface_delete'), path('interfaces//changelog/', ObjectChangeLogView.as_view(), name='interface_changelog', kwargs={'model': Interface}), path('interfaces//trace/', views.PathTraceView.as_view(), name='interface_trace', kwargs={'model': Interface}), - path('interfaces//connect//', views.CableCreateView.as_view(), name='interface_connect', kwargs={'termination_a_type': Interface}), + path('interfaces/connect/', views.CableCreateView.as_view(), name='interface_connect', kwargs={'termination_a_type': Interface}), path('devices/interfaces/add/', views.DeviceBulkAddInterfaceView.as_view(), name='device_bulk_add_interface'), # Front ports @@ -374,7 +374,7 @@ urlpatterns = [ path('front-ports//delete/', views.FrontPortDeleteView.as_view(), name='frontport_delete'), path('front-ports//changelog/', ObjectChangeLogView.as_view(), name='frontport_changelog', kwargs={'model': FrontPort}), path('front-ports//trace/', views.PathTraceView.as_view(), name='frontport_trace', kwargs={'model': FrontPort}), - path('front-ports//connect//', views.CableCreateView.as_view(), name='frontport_connect', kwargs={'termination_a_type': FrontPort}), + path('front-ports/connect/', views.CableCreateView.as_view(), name='frontport_connect', kwargs={'termination_a_type': FrontPort}), # path('devices/front-ports/add/', views.DeviceBulkAddFrontPortView.as_view(), name='device_bulk_add_frontport'), # Rear ports @@ -390,7 +390,7 @@ urlpatterns = [ path('rear-ports//delete/', views.RearPortDeleteView.as_view(), name='rearport_delete'), path('rear-ports//changelog/', ObjectChangeLogView.as_view(), name='rearport_changelog', kwargs={'model': RearPort}), path('rear-ports//trace/', views.PathTraceView.as_view(), name='rearport_trace', kwargs={'model': RearPort}), - path('rear-ports//connect//', views.CableCreateView.as_view(), name='rearport_connect', kwargs={'termination_a_type': RearPort}), + path('rear-ports/connect/', views.CableCreateView.as_view(), name='rearport_connect', kwargs={'termination_a_type': RearPort}), path('devices/rear-ports/add/', views.DeviceBulkAddRearPortView.as_view(), name='device_bulk_add_rearport'), # Module bays @@ -500,6 +500,6 @@ urlpatterns = [ path('power-feeds//trace/', views.PathTraceView.as_view(), name='powerfeed_trace', kwargs={'model': PowerFeed}), path('power-feeds//changelog/', ObjectChangeLogView.as_view(), name='powerfeed_changelog', kwargs={'model': PowerFeed}), path('power-feeds//journal/', ObjectJournalView.as_view(), name='powerfeed_journal', kwargs={'model': PowerFeed}), - path('power-feeds//connect//', views.CableCreateView.as_view(), name='powerfeed_connect', kwargs={'termination_a_type': PowerFeed}), + path('power-feeds/connect/', views.CableCreateView.as_view(), name='powerfeed_connect', kwargs={'termination_a_type': PowerFeed}), ] diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 57e8b1c79..b18b6d4b3 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2812,16 +2812,16 @@ class CableCreateView(generic.ObjectEditView): # Set the form class based on the type of component being connected self.form = { - 'console-port': forms.ConnectCableToConsolePortForm, - 'console-server-port': forms.ConnectCableToConsoleServerPortForm, - 'power-port': forms.ConnectCableToPowerPortForm, - 'power-outlet': forms.ConnectCableToPowerOutletForm, - 'interface': forms.ConnectCableToInterfaceForm, - 'front-port': forms.ConnectCableToFrontPortForm, - 'rear-port': forms.ConnectCableToRearPortForm, - 'power-feed': forms.ConnectCableToPowerFeedForm, - 'circuit-termination': forms.ConnectCableToCircuitTerminationForm, - }[kwargs.get('termination_b_type')] + 'dcim.consoleport': forms.ConnectCableToConsolePortForm, + 'dcim.consoleserverport': forms.ConnectCableToConsoleServerPortForm, + 'dcim.powerport': forms.ConnectCableToPowerPortForm, + 'dcim.poweroutlet': forms.ConnectCableToPowerOutletForm, + 'dcim.interface': forms.ConnectCableToInterfaceForm, + 'dcim.frontport': forms.ConnectCableToFrontPortForm, + 'dcim.rearport': forms.ConnectCableToRearPortForm, + 'dcim.powerfeed': forms.ConnectCableToPowerFeedForm, + 'circuits.circuittermination': forms.ConnectCableToCircuitTerminationForm, + }[request.GET.get('termination_b_type')] return super().dispatch(request, *args, **kwargs) @@ -2831,9 +2831,9 @@ class CableCreateView(generic.ObjectEditView): def alter_object(self, obj, request, url_args, url_kwargs): termination_a_type = url_kwargs.get('termination_a_type') - termination_a_id = url_kwargs.get('termination_a_id') - termination_b_type_name = url_kwargs.get('termination_b_type') - self.termination_b_type = ContentType.objects.get(model=termination_b_type_name.replace('-', '')) + termination_a_id = request.GET.get('termination_a_id') + app_label, model = request.GET.get('termination_b_type').split('.') + self.termination_b_type = ContentType.objects.get(app_label=app_label, model=model) # Initialize Cable termination attributes obj.termination_a = termination_a_type.objects.get(pk=termination_a_id) diff --git a/netbox/templates/circuits/inc/circuit_termination.html b/netbox/templates/circuits/inc/circuit_termination.html index fdb01e803..12fb85d57 100644 --- a/netbox/templates/circuits/inc/circuit_termination.html +++ b/netbox/templates/circuits/inc/circuit_termination.html @@ -70,10 +70,10 @@ Connect
{% endif %} diff --git a/netbox/templates/dcim/consoleport.html b/netbox/templates/dcim/consoleport.html index ce2c1655d..f2ebc16d9 100644 --- a/netbox/templates/dcim/consoleport.html +++ b/netbox/templates/dcim/consoleport.html @@ -113,7 +113,7 @@
  • Console Server Port @@ -121,7 +121,7 @@
  • Front Port @@ -129,7 +129,7 @@
  • Rear Port diff --git a/netbox/templates/dcim/consoleserverport.html b/netbox/templates/dcim/consoleserverport.html index 52b1a3229..47b784ede 100644 --- a/netbox/templates/dcim/consoleserverport.html +++ b/netbox/templates/dcim/consoleserverport.html @@ -115,7 +115,7 @@
  • Console Port @@ -123,7 +123,7 @@
  • Front Port @@ -131,7 +131,7 @@
  • Rear Port diff --git a/netbox/templates/dcim/frontport.html b/netbox/templates/dcim/frontport.html index 891f217ee..75402e2e7 100644 --- a/netbox/templates/dcim/frontport.html +++ b/netbox/templates/dcim/frontport.html @@ -105,22 +105,22 @@
    • diff --git a/netbox/templates/dcim/interface.html b/netbox/templates/dcim/interface.html index 358922730..7181d2554 100644 --- a/netbox/templates/dcim/interface.html +++ b/netbox/templates/dcim/interface.html @@ -251,22 +251,22 @@
    • - + Interface
    • - + Front Port
    • - + Rear Port
    • - + Circuit Termination
      • diff --git a/netbox/templates/dcim/powerfeed.html b/netbox/templates/dcim/powerfeed.html index 777af5563..7c18c402a 100644 --- a/netbox/templates/dcim/powerfeed.html +++ b/netbox/templates/dcim/powerfeed.html @@ -158,7 +158,7 @@ {% if not object.mark_connected and not object.cable %}
      {% if perms.dcim.add_cable %} - Connect diff --git a/netbox/templates/dcim/poweroutlet.html b/netbox/templates/dcim/poweroutlet.html index 6408bc759..d63d7c87f 100644 --- a/netbox/templates/dcim/poweroutlet.html +++ b/netbox/templates/dcim/poweroutlet.html @@ -111,7 +111,7 @@
      Not Connected {% if perms.dcim.add_cable %} - + Connect {% endif %} diff --git a/netbox/templates/dcim/powerport.html b/netbox/templates/dcim/powerport.html index 6dc06f528..de5385cea 100644 --- a/netbox/templates/dcim/powerport.html +++ b/netbox/templates/dcim/powerport.html @@ -117,10 +117,10 @@ diff --git a/netbox/templates/dcim/rearport.html b/netbox/templates/dcim/rearport.html index 3cdccbd7c..5076ca083 100644 --- a/netbox/templates/dcim/rearport.html +++ b/netbox/templates/dcim/rearport.html @@ -101,16 +101,16 @@ From 6c290353c1162d7b01c10089170705e86c6ffc02 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 25 Apr 2022 15:02:08 -0400 Subject: [PATCH 025/593] Allow editing A side termination when creating cable --- netbox/dcim/forms/connections.py | 84 +++++++++++++++++++----- netbox/dcim/views.py | 9 ++- netbox/templates/dcim/cable_connect.html | 19 ++---- 3 files changed, 77 insertions(+), 35 deletions(-) diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index 13ab0ae09..aae33e621 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -21,15 +21,29 @@ class ConnectCableToDeviceForm(TenancyForm, NetBoxModelForm): """ Base form for connecting a Cable to a Device component """ + # Termination A + termination_a_id = DynamicModelChoiceField( + queryset=Interface.objects.all(), + label='Name', + disabled_indicator='_occupied' + ) + + # Termination B termination_b_region = DynamicModelChoiceField( queryset=Region.objects.all(), label='Region', - required=False + required=False, + initial_params={ + 'sites': '$termination_b_site' + } ) termination_b_sitegroup = DynamicModelChoiceField( queryset=SiteGroup.objects.all(), label='Site group', - required=False + required=False, + initial_params={ + 'sites': '$termination_b_site' + } ) termination_b_site = DynamicModelChoiceField( queryset=Site.objects.all(), @@ -73,9 +87,9 @@ class ConnectCableToDeviceForm(TenancyForm, NetBoxModelForm): class Meta: model = Cable fields = [ - 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', 'termination_b_rack', - 'termination_b_device', 'termination_b_id', 'type', 'status', 'tenant_group', 'tenant', 'label', 'color', - 'length', 'length_unit', 'tags', + 'termination_a_id', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', + 'termination_b_rack', 'termination_b_device', 'termination_b_id', 'type', 'status', 'tenant_group', + 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', ] widgets = { 'status': StaticSelect, @@ -83,6 +97,10 @@ class ConnectCableToDeviceForm(TenancyForm, NetBoxModelForm): 'length_unit': StaticSelect, } + def clean_termination_a_id(self): + # Return the PK rather than the object + return getattr(self.cleaned_data['termination_a_id'], 'pk', None) + def clean_termination_b_id(self): # Return the PK rather than the object return getattr(self.cleaned_data['termination_b_id'], 'pk', None) @@ -167,6 +185,14 @@ class ConnectCableToRearPortForm(ConnectCableToDeviceForm): class ConnectCableToCircuitTerminationForm(TenancyForm, NetBoxModelForm): + # Termination A + termination_a_id = DynamicModelChoiceField( + queryset=Interface.objects.all(), + label='Side', + disabled_indicator='_occupied' + ) + + # Termination B termination_b_provider = DynamicModelChoiceField( queryset=Provider.objects.all(), label='Provider', @@ -175,12 +201,18 @@ class ConnectCableToCircuitTerminationForm(TenancyForm, NetBoxModelForm): termination_b_region = DynamicModelChoiceField( queryset=Region.objects.all(), label='Region', - required=False + required=False, + initial_params={ + 'sites': '$termination_b_site' + } ) termination_b_sitegroup = DynamicModelChoiceField( queryset=SiteGroup.objects.all(), label='Site group', - required=False + required=False, + initial_params={ + 'sites': '$termination_b_site' + } ) termination_b_site = DynamicModelChoiceField( queryset=Site.objects.all(), @@ -210,26 +242,44 @@ class ConnectCableToCircuitTerminationForm(TenancyForm, NetBoxModelForm): class Meta(ConnectCableToDeviceForm.Meta): fields = [ - 'termination_b_provider', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', - 'termination_b_circuit', 'termination_b_id', 'type', 'status', 'tenant_group', 'tenant', 'label', 'color', - 'length', 'length_unit', 'tags', + 'termination_a_id', 'termination_b_provider', 'termination_b_region', 'termination_b_sitegroup', + 'termination_b_site', 'termination_b_circuit', 'termination_b_id', 'type', 'status', 'tenant_group', + 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', ] + def clean_termination_a_id(self): + # Return the PK rather than the object + return getattr(self.cleaned_data['termination_a_id'], 'pk', None) + def clean_termination_b_id(self): # Return the PK rather than the object return getattr(self.cleaned_data['termination_b_id'], 'pk', None) class ConnectCableToPowerFeedForm(TenancyForm, NetBoxModelForm): + # Termination A + termination_a_id = DynamicModelChoiceField( + queryset=Interface.objects.all(), + label='Name', + disabled_indicator='_occupied' + ) + + # Termination B termination_b_region = DynamicModelChoiceField( queryset=Region.objects.all(), label='Region', - required=False + required=False, + initial_params={ + 'sites': '$termination_b_site' + } ) termination_b_sitegroup = DynamicModelChoiceField( queryset=SiteGroup.objects.all(), label='Site group', - required=False + required=False, + initial_params={ + 'sites': '$termination_b_site' + } ) termination_b_site = DynamicModelChoiceField( queryset=Site.objects.all(), @@ -268,11 +318,15 @@ class ConnectCableToPowerFeedForm(TenancyForm, NetBoxModelForm): class Meta(ConnectCableToDeviceForm.Meta): fields = [ - 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', 'termination_b_location', - 'termination_b_powerpanel', 'termination_b_id', 'type', 'status', 'tenant_group', 'tenant', 'label', - 'color', 'length', 'length_unit', 'tags', + 'termination_a_id', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', + 'termination_b_location', 'termination_b_powerpanel', 'termination_b_id', 'type', 'status', 'tenant_group', + 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', ] + def clean_termination_a_id(self): + # Return the PK rather than the object + return getattr(self.cleaned_data['termination_a_id'], 'pk', None) + def clean_termination_b_id(self): # Return the PK rather than the object return getattr(self.cleaned_data['termination_b_id'], 'pk', None) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index b18b6d4b3..204862548 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -12,7 +12,7 @@ from django.utils.html import escape from django.utils.safestring import mark_safe from django.views.generic import View -from circuits.models import Circuit +from circuits.models import Circuit, CircuitTermination from extras.views import ObjectConfigContextView from ipam.models import ASN, IPAddress, Prefix, Service, VLAN, VLANGroup from ipam.tables import AssignedIPAddressesTable, InterfaceVLANTable @@ -2850,10 +2850,6 @@ class CableCreateView(generic.ObjectEditView): # Set initial site and rack based on side A termination (if not already set) termination_a_site = getattr(obj.termination_a.parent_object, 'site', None) - if termination_a_site and 'termination_b_region' not in initial_data: - initial_data['termination_b_region'] = termination_a_site.region - if termination_a_site and 'termination_b_site_group' not in initial_data: - initial_data['termination_b_site_group'] = termination_a_site.group if 'termination_b_site' not in initial_data: initial_data['termination_b_site'] = termination_a_site if 'termination_b_rack' not in initial_data: @@ -2861,6 +2857,9 @@ class CableCreateView(generic.ObjectEditView): form = self.form(instance=obj, initial=initial_data) + # Set the queryset of termination A + form.fields['termination_a_id'].queryset = kwargs['termination_a_type'].objects.all() + return render(request, self.template_name, { 'obj': obj, 'obj_type': Cable._meta.verbose_name, diff --git a/netbox/templates/dcim/cable_connect.html b/netbox/templates/dcim/cable_connect.html index 1d50040c7..4edb55bcc 100644 --- a/netbox/templates/dcim/cable_connect.html +++ b/netbox/templates/dcim/cable_connect.html @@ -71,39 +71,28 @@
      -
      - -
      - -
      -
      {% else %} {# Circuit termination #}
      - +
      - +
      - +
      -
      - -
      - -
      -
      {% endif %} + {% render_field form.termination_a_id %} From 4bb9b6ee2639db683b70d6ddbee055497e0a3647 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 25 Apr 2022 17:10:15 -0400 Subject: [PATCH 026/593] Extend Cable model to support multiple A/B terminations --- netbox/dcim/api/serializers.py | 16 +- netbox/dcim/api/views.py | 4 +- netbox/dcim/filtersets.py | 10 +- netbox/dcim/forms/connections.py | 46 ++--- .../0154_cable_add_termination_id_arrays.py | 24 +++ .../0155_cable_copy_termination_ids.py | 36 ++++ .../0156_cable_delete_old_termination_ids.py | 25 +++ netbox/dcim/models/cables.py | 161 +++++++++--------- netbox/dcim/signals.py | 39 +++-- netbox/dcim/tables/cables.py | 8 +- netbox/dcim/tables/template_code.py | 20 ++- netbox/dcim/views.py | 25 ++- netbox/templates/dcim/cable.html | 148 ++++++++-------- netbox/templates/dcim/cable_connect.html | 8 +- .../templates/dcim/inc/cable_termination.html | 80 ++++----- netbox/utilities/utils.py | 1 + 16 files changed, 368 insertions(+), 283 deletions(-) create mode 100644 netbox/dcim/migrations/0154_cable_add_termination_id_arrays.py create mode 100644 netbox/dcim/migrations/0155_cable_copy_termination_ids.py create mode 100644 netbox/dcim/migrations/0156_cable_delete_old_termination_ids.py diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 7fcab6ba3..9368fa6ee 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -977,8 +977,8 @@ class CableSerializer(NetBoxModelSerializer): class Meta: model = Cable fields = [ - 'id', 'url', 'display', 'termination_a_type', 'termination_a_id', 'termination_a', 'termination_b_type', - 'termination_b_id', 'termination_b', 'type', 'status', 'tenant', 'label', 'color', 'length', 'length_unit', + 'id', 'url', 'display', 'termination_a_type', 'termination_a_ids', 'termination_a', 'termination_b_type', + 'termination_b_ids', 'termination_b', 'type', 'status', 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', 'custom_fields', 'created', 'last_updated', ] @@ -986,14 +986,12 @@ class CableSerializer(NetBoxModelSerializer): """ Serialize a nested representation of a termination. """ - if side.lower() not in ['a', 'b']: - raise ValueError("Termination side must be either A or B.") - termination = getattr(obj, 'termination_{}'.format(side.lower())) - if termination is None: - return None - serializer = get_serializer_for_model(termination, prefix='Nested') + assert side.lower() in ('a', 'b') + termination_type = getattr(obj, f'termination_{side}_type').model_class() + termination = getattr(obj, f'termination_{side}') + serializer = get_serializer_for_model(termination_type, prefix='Nested') context = {'request': self.context['request']} - data = serializer(termination, context=context).data + data = serializer(termination, context=context, many=True).data return data diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index e99ef333a..b3bda01cd 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -647,9 +647,7 @@ class InventoryItemRoleViewSet(NetBoxModelViewSet): class CableViewSet(NetBoxModelViewSet): metadata_class = ContentTypeMetadata - queryset = Cable.objects.prefetch_related( - 'termination_a', 'termination_b' - ) + queryset = Cable.objects.all() serializer_class = serializers.CableSerializer filterset_class = filtersets.CableFilterSet diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index d57d0a59b..563c5d4ce 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -1499,9 +1499,9 @@ class VirtualChassisFilterSet(NetBoxModelFilterSet): class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): termination_a_type = ContentTypeFilter() - termination_a_id = MultiValueNumberFilter() + termination_a_ids = MultiValueNumberFilter() termination_b_type = ContentTypeFilter() - termination_b_id = MultiValueNumberFilter() + termination_b_ids = MultiValueNumberFilter() type = django_filters.MultipleChoiceFilter( choices=CableTypeChoices ) @@ -1537,7 +1537,7 @@ class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): class Meta: model = Cable - fields = ['id', 'label', 'length', 'length_unit', 'termination_a_id', 'termination_b_id'] + fields = ['id', 'label', 'length', 'length_unit', 'termination_a_ids', 'termination_b_ids'] def search(self, queryset, name, value): if not value.strip(): @@ -1546,8 +1546,8 @@ class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): def filter_device(self, queryset, name, value): queryset = queryset.filter( - Q(**{'_termination_a_{}__in'.format(name): value}) | - Q(**{'_termination_b_{}__in'.format(name): value}) + Q(**{f'_termination_a_{name}__in': value}) | + Q(**{f'_termination_b_{name}__in': value}) ) return queryset diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index aae33e621..a56099b3e 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -2,7 +2,7 @@ from circuits.models import Circuit, CircuitTermination, Provider from dcim.models import * from netbox.forms import NetBoxModelForm from tenancy.forms import TenancyForm -from utilities.forms import DynamicModelChoiceField, StaticSelect +from utilities.forms import DynamicModelChoiceField, DynamicModelMultipleChoiceField, StaticSelect __all__ = ( 'ConnectCableToCircuitTerminationForm', @@ -22,7 +22,7 @@ class ConnectCableToDeviceForm(TenancyForm, NetBoxModelForm): Base form for connecting a Cable to a Device component """ # Termination A - termination_a_id = DynamicModelChoiceField( + termination_a_ids = DynamicModelMultipleChoiceField( queryset=Interface.objects.all(), label='Name', disabled_indicator='_occupied' @@ -87,8 +87,8 @@ class ConnectCableToDeviceForm(TenancyForm, NetBoxModelForm): class Meta: model = Cable fields = [ - 'termination_a_id', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', - 'termination_b_rack', 'termination_b_device', 'termination_b_id', 'type', 'status', 'tenant_group', + 'termination_a_ids', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', + 'termination_b_rack', 'termination_b_device', 'termination_b_ids', 'type', 'status', 'tenant_group', 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', ] widgets = { @@ -97,17 +97,17 @@ class ConnectCableToDeviceForm(TenancyForm, NetBoxModelForm): 'length_unit': StaticSelect, } - def clean_termination_a_id(self): + def clean_termination_a_ids(self): # Return the PK rather than the object - return getattr(self.cleaned_data['termination_a_id'], 'pk', None) + return [getattr(obj, 'pk') for obj in self.cleaned_data['termination_a_ids']] - def clean_termination_b_id(self): + def clean_termination_b_ids(self): # Return the PK rather than the object - return getattr(self.cleaned_data['termination_b_id'], 'pk', None) + return [getattr(obj, 'pk') for obj in self.cleaned_data['termination_b_ids']] class ConnectCableToConsolePortForm(ConnectCableToDeviceForm): - termination_b_id = DynamicModelChoiceField( + termination_b_ids = DynamicModelMultipleChoiceField( queryset=ConsolePort.objects.all(), label='Name', disabled_indicator='_occupied', @@ -118,7 +118,7 @@ class ConnectCableToConsolePortForm(ConnectCableToDeviceForm): class ConnectCableToConsoleServerPortForm(ConnectCableToDeviceForm): - termination_b_id = DynamicModelChoiceField( + termination_b_ids = DynamicModelMultipleChoiceField( queryset=ConsoleServerPort.objects.all(), label='Name', disabled_indicator='_occupied', @@ -129,7 +129,7 @@ class ConnectCableToConsoleServerPortForm(ConnectCableToDeviceForm): class ConnectCableToPowerPortForm(ConnectCableToDeviceForm): - termination_b_id = DynamicModelChoiceField( + termination_b_ids = DynamicModelMultipleChoiceField( queryset=PowerPort.objects.all(), label='Name', disabled_indicator='_occupied', @@ -140,7 +140,7 @@ class ConnectCableToPowerPortForm(ConnectCableToDeviceForm): class ConnectCableToPowerOutletForm(ConnectCableToDeviceForm): - termination_b_id = DynamicModelChoiceField( + termination_b_ids = DynamicModelMultipleChoiceField( queryset=PowerOutlet.objects.all(), label='Name', disabled_indicator='_occupied', @@ -151,7 +151,7 @@ class ConnectCableToPowerOutletForm(ConnectCableToDeviceForm): class ConnectCableToInterfaceForm(ConnectCableToDeviceForm): - termination_b_id = DynamicModelChoiceField( + termination_b_ids = DynamicModelMultipleChoiceField( queryset=Interface.objects.all(), label='Name', disabled_indicator='_occupied', @@ -163,7 +163,7 @@ class ConnectCableToInterfaceForm(ConnectCableToDeviceForm): class ConnectCableToFrontPortForm(ConnectCableToDeviceForm): - termination_b_id = DynamicModelChoiceField( + termination_b_ids = DynamicModelMultipleChoiceField( queryset=FrontPort.objects.all(), label='Name', disabled_indicator='_occupied', @@ -174,7 +174,7 @@ class ConnectCableToFrontPortForm(ConnectCableToDeviceForm): class ConnectCableToRearPortForm(ConnectCableToDeviceForm): - termination_b_id = DynamicModelChoiceField( + termination_b_ids = DynamicModelMultipleChoiceField( queryset=RearPort.objects.all(), label='Name', disabled_indicator='_occupied', @@ -186,7 +186,7 @@ class ConnectCableToRearPortForm(ConnectCableToDeviceForm): class ConnectCableToCircuitTerminationForm(TenancyForm, NetBoxModelForm): # Termination A - termination_a_id = DynamicModelChoiceField( + termination_a_ids = DynamicModelMultipleChoiceField( queryset=Interface.objects.all(), label='Side', disabled_indicator='_occupied' @@ -231,7 +231,7 @@ class ConnectCableToCircuitTerminationForm(TenancyForm, NetBoxModelForm): 'site_id': '$termination_b_site', } ) - termination_b_id = DynamicModelChoiceField( + termination_b_ids = DynamicModelMultipleChoiceField( queryset=CircuitTermination.objects.all(), label='Side', disabled_indicator='_occupied', @@ -242,8 +242,8 @@ class ConnectCableToCircuitTerminationForm(TenancyForm, NetBoxModelForm): class Meta(ConnectCableToDeviceForm.Meta): fields = [ - 'termination_a_id', 'termination_b_provider', 'termination_b_region', 'termination_b_sitegroup', - 'termination_b_site', 'termination_b_circuit', 'termination_b_id', 'type', 'status', 'tenant_group', + 'termination_a_ids', 'termination_b_provider', 'termination_b_region', 'termination_b_sitegroup', + 'termination_b_site', 'termination_b_circuit', 'termination_b_ids', 'type', 'status', 'tenant_group', 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', ] @@ -258,7 +258,7 @@ class ConnectCableToCircuitTerminationForm(TenancyForm, NetBoxModelForm): class ConnectCableToPowerFeedForm(TenancyForm, NetBoxModelForm): # Termination A - termination_a_id = DynamicModelChoiceField( + termination_a_ids = DynamicModelMultipleChoiceField( queryset=Interface.objects.all(), label='Name', disabled_indicator='_occupied' @@ -307,7 +307,7 @@ class ConnectCableToPowerFeedForm(TenancyForm, NetBoxModelForm): 'location_id': '$termination_b_location', } ) - termination_b_id = DynamicModelChoiceField( + termination_b_ids = DynamicModelMultipleChoiceField( queryset=PowerFeed.objects.all(), label='Name', disabled_indicator='_occupied', @@ -318,8 +318,8 @@ class ConnectCableToPowerFeedForm(TenancyForm, NetBoxModelForm): class Meta(ConnectCableToDeviceForm.Meta): fields = [ - 'termination_a_id', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', - 'termination_b_location', 'termination_b_powerpanel', 'termination_b_id', 'type', 'status', 'tenant_group', + 'termination_a_ids', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', + 'termination_b_location', 'termination_b_powerpanel', 'termination_b_ids', 'type', 'status', 'tenant_group', 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', ] diff --git a/netbox/dcim/migrations/0154_cable_add_termination_id_arrays.py b/netbox/dcim/migrations/0154_cable_add_termination_id_arrays.py new file mode 100644 index 000000000..40e215a3d --- /dev/null +++ b/netbox/dcim/migrations/0154_cable_add_termination_id_arrays.py @@ -0,0 +1,24 @@ +# Generated by Django 4.0.4 on 2022-04-25 16:35 + +import django.contrib.postgres.fields +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0153_created_datetimefield'), + ] + + operations = [ + migrations.AddField( + model_name='cable', + name='termination_a_ids', + field=django.contrib.postgres.fields.ArrayField(base_field=models.PositiveBigIntegerField(), null=True, size=None), + ), + migrations.AddField( + model_name='cable', + name='termination_b_ids', + field=django.contrib.postgres.fields.ArrayField(base_field=models.PositiveBigIntegerField(), null=True, size=None), + ), + ] diff --git a/netbox/dcim/migrations/0155_cable_copy_termination_ids.py b/netbox/dcim/migrations/0155_cable_copy_termination_ids.py new file mode 100644 index 000000000..5e1effa51 --- /dev/null +++ b/netbox/dcim/migrations/0155_cable_copy_termination_ids.py @@ -0,0 +1,36 @@ +from django.contrib.postgres.fields import ArrayField +from django.db import migrations +from django.db.models import ExpressionWrapper, F + + +def copy_termination_ids(apps, schema_editor): + """ + Copy original A & B termination ID values to new array fields. + """ + Cable = apps.get_model('dcim', 'Cable') + + # TODO: Optimize data migration using F expressions + # Cable.objects.update( + # termination_a_ids=ExpressionWrapper(F('termination_a_id'), output_field=ArrayField), + # termination_b_ids=ExpressionWrapper(F('termination_b_id'), output_field=ArrayField) + # ) + + for cable in Cable.objects.all(): + Cable.objects.filter(pk=cable.pk).update( + termination_a_ids=[cable.termination_a_id], + termination_b_ids=[cable.termination_b_id] + ) + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0154_cable_add_termination_id_arrays'), + ] + + operations = [ + migrations.RunPython( + code=copy_termination_ids, + reverse_code=migrations.RunPython.noop + ), + ] diff --git a/netbox/dcim/migrations/0156_cable_delete_old_termination_ids.py b/netbox/dcim/migrations/0156_cable_delete_old_termination_ids.py new file mode 100644 index 000000000..942a27df6 --- /dev/null +++ b/netbox/dcim/migrations/0156_cable_delete_old_termination_ids.py @@ -0,0 +1,25 @@ +# Generated by Django 4.0.4 on 2022-04-25 20:45 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0155_cable_copy_termination_ids'), + ] + + operations = [ + migrations.AlterUniqueTogether( + name='cable', + unique_together=set(), + ), + migrations.RemoveField( + model_name='cable', + name='termination_a_id', + ), + migrations.RemoveField( + model_name='cable', + name='termination_b_id', + ), + ] diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index dcc564717..0edda0f5e 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -2,6 +2,7 @@ from collections import defaultdict from django.contrib.contenttypes.fields import GenericForeignKey from django.contrib.contenttypes.models import ContentType +from django.contrib.postgres.fields import ArrayField from django.core.exceptions import ObjectDoesNotExist, ValidationError from django.db import models from django.db.models import Sum @@ -38,10 +39,9 @@ class Cable(NetBoxModel): on_delete=models.PROTECT, related_name='+' ) - termination_a_id = models.PositiveBigIntegerField() - termination_a = GenericForeignKey( - ct_field='termination_a_type', - fk_field='termination_a_id' + termination_a_ids = ArrayField( + base_field=models.PositiveBigIntegerField(), + null=True ) termination_b_type = models.ForeignKey( to=ContentType, @@ -49,10 +49,9 @@ class Cable(NetBoxModel): on_delete=models.PROTECT, related_name='+' ) - termination_b_id = models.PositiveBigIntegerField() - termination_b = GenericForeignKey( - ct_field='termination_b_type', - fk_field='termination_b_id' + termination_b_ids = ArrayField( + base_field=models.PositiveBigIntegerField(), + null=True ) type = models.CharField( max_length=50, @@ -115,10 +114,6 @@ class Cable(NetBoxModel): class Meta: ordering = ['pk'] - unique_together = ( - ('termination_a_type', 'termination_a_id'), - ('termination_b_type', 'termination_b_id'), - ) def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) @@ -137,9 +132,9 @@ class Cable(NetBoxModel): instance = super().from_db(db, field_names, values) instance._orig_termination_a_type_id = instance.termination_a_type_id - instance._orig_termination_a_id = instance.termination_a_id + instance._orig_termination_a_ids = instance.termination_a_ids instance._orig_termination_b_type_id = instance.termination_b_type_id - instance._orig_termination_b_id = instance.termination_b_id + instance._orig_termination_b_ids = instance.termination_b_ids return instance @@ -150,6 +145,18 @@ class Cable(NetBoxModel): def get_absolute_url(self): return reverse('dcim:cable', args=[self.pk]) + @property + def termination_a(self): + if not hasattr(self, 'termination_a_type') or not self.termination_a_ids: + return [] + return list(self.termination_a_type.model_class().objects.filter(pk__in=self.termination_a_ids)) + + @property + def termination_b(self): + if not hasattr(self, 'termination_b_type') or not self.termination_b_ids: + return [] + return list(self.termination_b_type.model_class().objects.filter(pk__in=self.termination_b_ids)) + def clean(self): from circuits.models import CircuitTermination @@ -158,9 +165,8 @@ class Cable(NetBoxModel): # Validate that termination A exists if not hasattr(self, 'termination_a_type'): raise ValidationError('Termination A type has not been specified') - try: - self.termination_a_type.model_class().objects.get(pk=self.termination_a_id) - except ObjectDoesNotExist: + model = self.termination_a_type.model_class() + if model.objects.filter(pk__in=self.termination_a_ids).count() != len(self.termination_a_ids): raise ValidationError({ 'termination_a': 'Invalid ID for type {}'.format(self.termination_a_type) }) @@ -168,9 +174,8 @@ class Cable(NetBoxModel): # Validate that termination B exists if not hasattr(self, 'termination_b_type'): raise ValidationError('Termination B type has not been specified') - try: - self.termination_b_type.model_class().objects.get(pk=self.termination_b_id) - except ObjectDoesNotExist: + model = self.termination_a_type.model_class() + if model.objects.filter(pk__in=self.termination_b_ids).count() != len(self.termination_b_ids): raise ValidationError({ 'termination_b': 'Invalid ID for type {}'.format(self.termination_b_type) }) @@ -180,14 +185,14 @@ class Cable(NetBoxModel): err_msg = 'Cable termination points may not be modified. Delete and recreate the cable instead.' if ( self.termination_a_type_id != self._orig_termination_a_type_id or - self.termination_a_id != self._orig_termination_a_id + set(self.termination_a_ids) != set(self._orig_termination_a_ids) ): raise ValidationError({ 'termination_a': err_msg }) if ( self.termination_b_type_id != self._orig_termination_b_type_id or - self.termination_b_id != self._orig_termination_b_id + set(self.termination_b_ids) != set(self._orig_termination_b_ids) ): raise ValidationError({ 'termination_b': err_msg @@ -197,18 +202,18 @@ class Cable(NetBoxModel): type_b = self.termination_b_type.model # Validate interface types - if type_a == 'interface' and self.termination_a.type in NONCONNECTABLE_IFACE_TYPES: - raise ValidationError({ - 'termination_a_id': 'Cables cannot be terminated to {} interfaces'.format( - self.termination_a.get_type_display() - ) - }) - if type_b == 'interface' and self.termination_b.type in NONCONNECTABLE_IFACE_TYPES: - raise ValidationError({ - 'termination_b_id': 'Cables cannot be terminated to {} interfaces'.format( - self.termination_b.get_type_display() - ) - }) + if type_a == 'interface': + for term in self.termination_a: + if term.type in NONCONNECTABLE_IFACE_TYPES: + raise ValidationError({ + 'termination_a_id': f'Cables cannot be terminated to {term.get_type_display()} interfaces' + }) + if type_a == 'interface': + for term in self.termination_b: + if term.type in NONCONNECTABLE_IFACE_TYPES: + raise ValidationError({ + 'termination_b_id': f'Cables cannot be terminated to {term.get_type_display()} interfaces' + }) # Check that termination types are compatible if type_b not in COMPATIBLE_TERMINATION_TYPES.get(type_a): @@ -216,50 +221,48 @@ class Cable(NetBoxModel): f"Incompatible termination types: {self.termination_a_type} and {self.termination_b_type}" ) - # Check that two connected RearPorts have the same number of positions (if both are >1) - if isinstance(self.termination_a, RearPort) and isinstance(self.termination_b, RearPort): - if self.termination_a.positions > 1 and self.termination_b.positions > 1: - if self.termination_a.positions != self.termination_b.positions: - raise ValidationError( - f"{self.termination_a} has {self.termination_a.positions} position(s) but " - f"{self.termination_b} has {self.termination_b.positions}. " - f"Both terminations must have the same number of positions (if greater than one)." - ) + # TODO: Is this validation still necessary? + # # Check that two connected RearPorts have the same number of positions (if both are >1) + # if isinstance(self.termination_a, RearPort) and isinstance(self.termination_b, RearPort): + # if self.termination_a.positions > 1 and self.termination_b.positions > 1: + # if self.termination_a.positions != self.termination_b.positions: + # raise ValidationError( + # f"{self.termination_a} has {self.termination_a.positions} position(s) but " + # f"{self.termination_b} has {self.termination_b.positions}. " + # f"Both terminations must have the same number of positions (if greater than one)." + # ) # A termination point cannot be connected to itself - if self.termination_a == self.termination_b: + if set(self.termination_a).intersection(self.termination_b): raise ValidationError(f"Cannot connect {self.termination_a_type} to itself") - # A front port cannot be connected to its corresponding rear port - if ( - type_a in ['frontport', 'rearport'] and - type_b in ['frontport', 'rearport'] and - ( - getattr(self.termination_a, 'rear_port', None) == self.termination_b or - getattr(self.termination_b, 'rear_port', None) == self.termination_a - ) - ): - raise ValidationError("A front port cannot be connected to it corresponding rear port") + # TODO + # # A front port cannot be connected to its corresponding rear port + # if ( + # type_a in ['frontport', 'rearport'] and + # type_b in ['frontport', 'rearport'] and + # ( + # getattr(self.termination_a, 'rear_port', None) == self.termination_b or + # getattr(self.termination_b, 'rear_port', None) == self.termination_a + # ) + # ): + # raise ValidationError("A front port cannot be connected to it corresponding rear port") - # A CircuitTermination attached to a ProviderNetwork cannot have a Cable - if isinstance(self.termination_a, CircuitTermination) and self.termination_a.provider_network is not None: - raise ValidationError({ - 'termination_a_id': "Circuit terminations attached to a provider network may not be cabled." - }) - if isinstance(self.termination_b, CircuitTermination) and self.termination_b.provider_network is not None: - raise ValidationError({ - 'termination_b_id': "Circuit terminations attached to a provider network may not be cabled." - }) + # TODO + # # A CircuitTermination attached to a ProviderNetwork cannot have a Cable + # if isinstance(self.termination_a, CircuitTermination) and self.termination_a.provider_network is not None: + # raise ValidationError({ + # 'termination_a_id': "Circuit terminations attached to a provider network may not be cabled." + # }) + # if isinstance(self.termination_b, CircuitTermination) and self.termination_b.provider_network is not None: + # raise ValidationError({ + # 'termination_b_id': "Circuit terminations attached to a provider network may not be cabled." + # }) # Check for an existing Cable connected to either termination object - if self.termination_a.cable not in (None, self): - raise ValidationError("{} already has a cable attached (#{})".format( - self.termination_a, self.termination_a.cable_id - )) - if self.termination_b.cable not in (None, self): - raise ValidationError("{} already has a cable attached (#{})".format( - self.termination_b, self.termination_b.cable_id - )) + for term in [*self.termination_a, *self.termination_b]: + if term.cable not in (None, self): + raise ValidationError(f'{term} already has a cable attached (#{term.cable_id})') # Validate length and length_unit if self.length is not None and not self.length_unit: @@ -276,10 +279,10 @@ class Cable(NetBoxModel): self._abs_length = None # Store the parent Device for the A and B terminations (if applicable) to enable filtering - if hasattr(self.termination_a, 'device'): - self._termination_a_device = self.termination_a.device - if hasattr(self.termination_b, 'device'): - self._termination_b_device = self.termination_b.device + if hasattr(self.termination_a[0], 'device'): + self._termination_a_device = self.termination_a[0].device + if hasattr(self.termination_b[0], 'device'): + self._termination_b_device = self.termination_b[0].device super().save(*args, **kwargs) @@ -289,14 +292,6 @@ class Cable(NetBoxModel): def get_status_color(self): return LinkStatusChoices.colors.get(self.status) - def get_compatible_types(self): - """ - Return all termination types compatible with termination A. - """ - if self.termination_a is None: - return - return COMPATIBLE_TERMINATION_TYPES[self.termination_a._meta.model_name] - class CablePath(models.Model): """ diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 79e9c6687..fa75cf992 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -79,21 +79,24 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): logger.debug(f"Skipping endpoint updates for imported cable {instance}") return - # Cache the Cable on its two termination points - if instance.termination_a.cable != instance: - logger.debug(f"Updating termination A for cable {instance}") - instance.termination_a.cable = instance - instance.termination_a._link_peer = instance.termination_b - instance.termination_a.save() - if instance.termination_b.cable != instance: - logger.debug(f"Updating termination B for cable {instance}") - instance.termination_b.cable = instance - instance.termination_b._link_peer = instance.termination_a - instance.termination_b.save() + # TODO: Update link peer fields + # Cache the Cable on its termination points + for term in instance.termination_a: + if term.cable != instance: + logger.debug(f"Updating termination A for cable {instance}: {term}") + term.cable = instance + # term._link_peer = instance.termination_b + term.save() + for term in instance.termination_b: + if term.cable != instance: + logger.debug(f"Updating termination B for cable {instance}") + term.cable = instance + # term._link_peer = instance.termination_a + term.save() # Create/update cable paths if created: - for termination in (instance.termination_a, instance.termination_b): + for termination in [*instance.termination_a, *instance.termination_b]: if isinstance(termination, PathEndpoint): create_cablepath(termination) else: @@ -116,14 +119,14 @@ def nullify_connected_endpoints(instance, **kwargs): logger = logging.getLogger('netbox.dcim.cable') # Disassociate the Cable from its termination points - if instance.termination_a is not None: + if instance.termination_a: logger.debug(f"Nullifying termination A for cable {instance}") - model = instance.termination_a._meta.model - model.objects.filter(pk=instance.termination_a.pk).update(_link_peer_type=None, _link_peer_id=None) - if instance.termination_b is not None: + model = instance.termination_a_type.model_class() + model.objects.filter(pk__in=instance.termination_a_ids).update(_link_peer_type=None, _link_peer_id=None) + if instance.termination_b: logger.debug(f"Nullifying termination B for cable {instance}") - model = instance.termination_b._meta.model - model.objects.filter(pk=instance.termination_b.pk).update(_link_peer_type=None, _link_peer_id=None) + model = instance.termination_b_type.model_class() + model.objects.filter(pk__in=instance.termination_b_ids).update(_link_peer_type=None, _link_peer_id=None) # Delete and retrace any dependent cable paths for cablepath in CablePath.objects.filter(path__contains=instance): diff --git a/netbox/dcim/tables/cables.py b/netbox/dcim/tables/cables.py index 4b062ad48..8abdb54d2 100644 --- a/netbox/dcim/tables/cables.py +++ b/netbox/dcim/tables/cables.py @@ -4,7 +4,7 @@ from django_tables2.utils import Accessor from dcim.models import Cable from netbox.tables import NetBoxTable, columns from tenancy.tables import TenantColumn -from .template_code import CABLE_LENGTH, CABLE_TERMINATION_PARENT +from .template_code import CABLE_LENGTH, CABLE_TERMINATION, CABLE_TERMINATION_PARENT __all__ = ( 'CableTable', @@ -28,7 +28,8 @@ class CableTable(NetBoxTable): linkify=True, verbose_name='Rack A' ) - termination_a = tables.Column( + termination_a = tables.TemplateColumn( + template_code=CABLE_TERMINATION, accessor=Accessor('termination_a'), orderable=False, linkify=True, @@ -46,7 +47,8 @@ class CableTable(NetBoxTable): linkify=True, verbose_name='Rack B' ) - termination_b = tables.Column( + termination_b = tables.TemplateColumn( + template_code=CABLE_TERMINATION, accessor=Accessor('termination_b'), orderable=False, linkify=True, diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index 0c1e0ed9e..9911a938d 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -13,14 +13,20 @@ CABLE_LENGTH = """ {% if record.length %}{{ record.length|simplify_decimal }} {{ record.length_unit }}{% endif %} """ +CABLE_TERMINATION = """ +{{ value|join:", " }} +""" + CABLE_TERMINATION_PARENT = """ -{% if value.device %} - {{ value.device }} -{% elif value.circuit %} - {{ value.circuit }} -{% elif value.power_panel %} - {{ value.power_panel }} -{% endif %} +{% with value.0 as termination %} + {% if termination.device %} + {{ termination.device }} + {% elif termination.circuit %} + {{ termination.circuit }} + {% elif termination.power_panel %} + {{ termination.power_panel }} + {% endif %} +{% endwith %} """ DEVICE_LINK = """ diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 204862548..d9803f2be 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2831,12 +2831,13 @@ class CableCreateView(generic.ObjectEditView): def alter_object(self, obj, request, url_args, url_kwargs): termination_a_type = url_kwargs.get('termination_a_type') - termination_a_id = request.GET.get('termination_a_id') + termination_a_ids = request.GET.get('termination_a_ids', []) app_label, model = request.GET.get('termination_b_type').split('.') self.termination_b_type = ContentType.objects.get(app_label=app_label, model=model) # Initialize Cable termination attributes - obj.termination_a = termination_a_type.objects.get(pk=termination_a_id) + obj.termination_a_type = ContentType.objects.get_for_model(termination_a_type) + obj.termination_a_ids = termination_a_type.objects.filter(pk__in=termination_a_ids) obj.termination_b_type = self.termination_b_type return obj @@ -2844,21 +2845,19 @@ class CableCreateView(generic.ObjectEditView): def get(self, request, *args, **kwargs): obj = self.get_object(**kwargs) obj = self.alter_object(obj, request, args, kwargs) + initial_data = request.GET - # Parse initial data manually to avoid setting field values as lists - initial_data = {k: request.GET[k] for k in request.GET} - - # Set initial site and rack based on side A termination (if not already set) - termination_a_site = getattr(obj.termination_a.parent_object, 'site', None) - if 'termination_b_site' not in initial_data: - initial_data['termination_b_site'] = termination_a_site - if 'termination_b_rack' not in initial_data: - initial_data['termination_b_rack'] = getattr(obj.termination_a.parent_object, 'rack', None) - + # TODO + # # Set initial site and rack based on side A termination (if not already set) + # termination_a_site = getattr(obj.termination_a.parent_object, 'site', None) + # if 'termination_b_site' not in initial_data: + # initial_data['termination_b_site'] = termination_a_site + # if 'termination_b_rack' not in initial_data: + # initial_data['termination_b_rack'] = getattr(obj.termination_a.parent_object, 'rack', None) form = self.form(instance=obj, initial=initial_data) # Set the queryset of termination A - form.fields['termination_a_id'].queryset = kwargs['termination_a_type'].objects.all() + form.fields['termination_a_ids'].queryset = kwargs['termination_a_type'].objects.all() return render(request, self.template_name, { 'obj': obj, diff --git a/netbox/templates/dcim/cable.html b/netbox/templates/dcim/cable.html index f1cf986e6..712704f67 100644 --- a/netbox/templates/dcim/cable.html +++ b/netbox/templates/dcim/cable.html @@ -5,85 +5,79 @@ {% load plugins %} {% block content %} -
      -
      -
      -
      - Cable -
      -
      - - - - - - - - - - - - - - - - - - - - - - - - - -
      Type{{ object.get_type_display|placeholder }}
      Status{% badge object.get_status_display bg_color=object.get_status_color %}
      Tenant - {% if object.tenant.group %} - {{ object.tenant.group|linkify }} / - {% endif %} - {{ object.tenant|linkify|placeholder }} -
      Label{{ object.label|placeholder }}
      Color - {% if object.color %} -   - {% else %} - — - {% endif %} -
      Length - {% if object.length %} - {{ object.length|floatformat }} {{ object.get_length_unit_display }} - {% else %} - — - {% endif %} -
      -
      -
      - {% include 'inc/panels/custom_fields.html' %} - {% include 'inc/panels/tags.html' %} - {% plugin_left_page object %} -
      -
      -
      -
      - Termination A -
      -
      - {% include 'dcim/inc/cable_termination.html' with termination=object.termination_a %} -
      -
      -
      -
      - Termination B -
      -
      - {% include 'dcim/inc/cable_termination.html' with termination=object.termination_b %} -
      -
      - {% plugin_right_page object %} +
      +
      +
      +
      Cable
      +
      + + + + + + + + + + + + + + + + + + + + + + + + + +
      Type{{ object.get_type_display|placeholder }}
      Status{% badge object.get_status_display bg_color=object.get_status_color %}
      Tenant + {% if object.tenant.group %} + {{ object.tenant.group|linkify }} / + {% endif %} + {{ object.tenant|linkify|placeholder }} +
      Label{{ object.label|placeholder }}
      Color + {% if object.color %} +   + {% else %} + — + {% endif %} +
      Length + {% if object.length %} + {{ object.length|floatformat }} {{ object.get_length_unit_display }} + {% else %} + — + {% endif %} +
      +
      + {% include 'inc/panels/custom_fields.html' %} + {% include 'inc/panels/tags.html' %} + {% plugin_left_page object %}
      -
      -
      - {% plugin_full_width_page object %} +
      +
      +
      Termination A
      +
      + {% include 'dcim/inc/cable_termination.html' with termination=object.termination_a %}
      +
      +
      +
      Termination B
      +
      + {% include 'dcim/inc/cable_termination.html' with termination=object.termination_b %} +
      +
      + {% plugin_right_page object %}
      +
      +
      +
      + {% plugin_full_width_page object %} +
      +
      {% endblock %} diff --git a/netbox/templates/dcim/cable_connect.html b/netbox/templates/dcim/cable_connect.html index 4edb55bcc..bba9609b4 100644 --- a/netbox/templates/dcim/cable_connect.html +++ b/netbox/templates/dcim/cable_connect.html @@ -3,7 +3,7 @@ {% load helpers %} {% load form_helpers %} -{% block title %}Connect {{ form.instance.termination_a.device }} {{ form.instance.termination_a }} to {{ termination_b_type|bettertitle }}{% endblock %} +{% block title %}Connect Cable to {{ termination_b_type|bettertitle }}{% endblock %} {% block tabs %}
        @@ -15,7 +15,7 @@ {% block content-wrapper %}
        - {% with termination_a=form.instance.termination_a %} + {% with termination_a=form.instance.termination_a.0 %} {% render_errors form %}
        {% csrf_token %} @@ -92,7 +92,7 @@
      {% endif %} - {% render_field form.termination_a_id %} + {% render_field form.termination_a_ids %}
      @@ -148,7 +148,7 @@ - {% render_field form.termination_b_id %} + {% render_field form.termination_b_ids %} diff --git a/netbox/templates/dcim/inc/cable_termination.html b/netbox/templates/dcim/inc/cable_termination.html index 6d75aee85..4a0a25372 100644 --- a/netbox/templates/dcim/inc/cable_termination.html +++ b/netbox/templates/dcim/inc/cable_termination.html @@ -1,42 +1,46 @@ {% load helpers %} - {% if termination.device %} - {# Device component #} - - - - - - - - - {% if termination.device.rack %} - - - - - {% endif %} - - - - - - - - - {% else %} - {# Circuit termination #} - - - - - - - - - - - - + {% if termination.0.device %} + {# Device component #} + + + + + + + + + {% if termination.0.device.rack %} + + + + {% endif %} + + + + + + + + + {% else %} + {# Circuit termination #} + + + + + + + + + {% endif %}
      Device{{ termination.device|linkify }}
      Site{{ termination.device.site|linkify }}
      Rack{{ termination.device.rack|linkify }}
      Type{{ termination|meta:"verbose_name"|capfirst }}
      Component{{ termination|linkify }}
      Provider{{ termination.circuit.provider|linkify }}
      Circuit{{ termination.circuit|linkify }}
      Termination{{ termination }}
      Device{{ termination.0.device|linkify }}
      Site{{ termination.0.device.site|linkify }}
      Rack{{ termination.0.device.rack|linkify }}
      Type{{ termination.0|meta:"verbose_name"|capfirst }}
      Component(s) + {% for term in termination %} + {{ term|linkify }}{% if not forloop.last %},{% endif %} + {% endfor %} +
      Provider{{ termination.0.circuit.provider|linkify }}
      Circuit + {% for term in termination %} + {{ term.circuit|linkify }} ({{ term }}){% if not forloop.last %},{% endif %} + {% endfor %} +
      diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index 7b37c0b70..28218fc74 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -132,6 +132,7 @@ def serialize_object(obj, extra=None): implicitly excluded. """ json_str = serialize('json', [obj]) + print(json_str) data = json.loads(json_str)[0]['fields'] # Exclude any MPTTModel fields From e0fc1b4f41b38fa700ab452793b33b477d9ea72b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 26 Apr 2022 16:42:20 -0400 Subject: [PATCH 027/593] Remove errant print statement --- netbox/utilities/utils.py | 1 - 1 file changed, 1 deletion(-) diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index 28218fc74..7b37c0b70 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -132,7 +132,6 @@ def serialize_object(obj, extra=None): implicitly excluded. """ json_str = serialize('json', [obj]) - print(json_str) data = json.loads(json_str)[0]['fields'] # Exclude any MPTTModel fields From 907323d46fd1b507c08f89cd750774969801ae49 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 29 Apr 2022 09:16:49 -0400 Subject: [PATCH 028/593] Revert initial model changes --- netbox/dcim/filtersets.py | 6 ++-- netbox/dcim/forms/connections.py | 5 +++ .../0154_cable_add_termination_id_arrays.py | 24 ------------- .../0155_cable_copy_termination_ids.py | 36 ------------------- .../0156_cable_delete_old_termination_ids.py | 25 ------------- netbox/dcim/models/cables.py | 18 ++++++---- 6 files changed, 20 insertions(+), 94 deletions(-) delete mode 100644 netbox/dcim/migrations/0154_cable_add_termination_id_arrays.py delete mode 100644 netbox/dcim/migrations/0155_cable_copy_termination_ids.py delete mode 100644 netbox/dcim/migrations/0156_cable_delete_old_termination_ids.py diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index 563c5d4ce..19c3a414e 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -1499,9 +1499,9 @@ class VirtualChassisFilterSet(NetBoxModelFilterSet): class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): termination_a_type = ContentTypeFilter() - termination_a_ids = MultiValueNumberFilter() + termination_a_id = MultiValueNumberFilter() termination_b_type = ContentTypeFilter() - termination_b_ids = MultiValueNumberFilter() + termination_b_id = MultiValueNumberFilter() type = django_filters.MultipleChoiceFilter( choices=CableTypeChoices ) @@ -1537,7 +1537,7 @@ class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): class Meta: model = Cable - fields = ['id', 'label', 'length', 'length_unit', 'termination_a_ids', 'termination_b_ids'] + fields = ['id', 'label', 'length', 'length_unit', 'termination_a_id', 'termination_b_id'] def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index a56099b3e..bcac15044 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -83,6 +83,11 @@ class ConnectCableToDeviceForm(TenancyForm, NetBoxModelForm): 'rack_id': '$termination_b_rack', } ) + termination_b_ids = DynamicModelMultipleChoiceField( + queryset=Interface.objects.all(), + label='Name', + disabled_indicator='_occupied' + ) class Meta: model = Cable diff --git a/netbox/dcim/migrations/0154_cable_add_termination_id_arrays.py b/netbox/dcim/migrations/0154_cable_add_termination_id_arrays.py deleted file mode 100644 index 40e215a3d..000000000 --- a/netbox/dcim/migrations/0154_cable_add_termination_id_arrays.py +++ /dev/null @@ -1,24 +0,0 @@ -# Generated by Django 4.0.4 on 2022-04-25 16:35 - -import django.contrib.postgres.fields -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('dcim', '0153_created_datetimefield'), - ] - - operations = [ - migrations.AddField( - model_name='cable', - name='termination_a_ids', - field=django.contrib.postgres.fields.ArrayField(base_field=models.PositiveBigIntegerField(), null=True, size=None), - ), - migrations.AddField( - model_name='cable', - name='termination_b_ids', - field=django.contrib.postgres.fields.ArrayField(base_field=models.PositiveBigIntegerField(), null=True, size=None), - ), - ] diff --git a/netbox/dcim/migrations/0155_cable_copy_termination_ids.py b/netbox/dcim/migrations/0155_cable_copy_termination_ids.py deleted file mode 100644 index 5e1effa51..000000000 --- a/netbox/dcim/migrations/0155_cable_copy_termination_ids.py +++ /dev/null @@ -1,36 +0,0 @@ -from django.contrib.postgres.fields import ArrayField -from django.db import migrations -from django.db.models import ExpressionWrapper, F - - -def copy_termination_ids(apps, schema_editor): - """ - Copy original A & B termination ID values to new array fields. - """ - Cable = apps.get_model('dcim', 'Cable') - - # TODO: Optimize data migration using F expressions - # Cable.objects.update( - # termination_a_ids=ExpressionWrapper(F('termination_a_id'), output_field=ArrayField), - # termination_b_ids=ExpressionWrapper(F('termination_b_id'), output_field=ArrayField) - # ) - - for cable in Cable.objects.all(): - Cable.objects.filter(pk=cable.pk).update( - termination_a_ids=[cable.termination_a_id], - termination_b_ids=[cable.termination_b_id] - ) - - -class Migration(migrations.Migration): - - dependencies = [ - ('dcim', '0154_cable_add_termination_id_arrays'), - ] - - operations = [ - migrations.RunPython( - code=copy_termination_ids, - reverse_code=migrations.RunPython.noop - ), - ] diff --git a/netbox/dcim/migrations/0156_cable_delete_old_termination_ids.py b/netbox/dcim/migrations/0156_cable_delete_old_termination_ids.py deleted file mode 100644 index 942a27df6..000000000 --- a/netbox/dcim/migrations/0156_cable_delete_old_termination_ids.py +++ /dev/null @@ -1,25 +0,0 @@ -# Generated by Django 4.0.4 on 2022-04-25 20:45 - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('dcim', '0155_cable_copy_termination_ids'), - ] - - operations = [ - migrations.AlterUniqueTogether( - name='cable', - unique_together=set(), - ), - migrations.RemoveField( - model_name='cable', - name='termination_a_id', - ), - migrations.RemoveField( - model_name='cable', - name='termination_b_id', - ), - ] diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 0edda0f5e..680ea78a8 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -39,9 +39,10 @@ class Cable(NetBoxModel): on_delete=models.PROTECT, related_name='+' ) - termination_a_ids = ArrayField( - base_field=models.PositiveBigIntegerField(), - null=True + termination_a_id = models.PositiveBigIntegerField() + termination_a = GenericForeignKey( + ct_field='termination_a_type', + fk_field='termination_a_id' ) termination_b_type = models.ForeignKey( to=ContentType, @@ -49,9 +50,10 @@ class Cable(NetBoxModel): on_delete=models.PROTECT, related_name='+' ) - termination_b_ids = ArrayField( - base_field=models.PositiveBigIntegerField(), - null=True + termination_b_id = models.PositiveBigIntegerField() + termination_b = GenericForeignKey( + ct_field='termination_b_type', + fk_field='termination_b_id' ) type = models.CharField( max_length=50, @@ -114,6 +116,10 @@ class Cable(NetBoxModel): class Meta: ordering = ['pk'] + unique_together = ( + ('termination_a_type', 'termination_a_id'), + ('termination_b_type', 'termination_b_id'), + ) def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) From 1f4ad444ae488be0667ae329de945c6d537036e0 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 29 Apr 2022 13:13:01 -0400 Subject: [PATCH 029/593] Introduce CableTermination model & migrate data --- netbox/dcim/choices.py | 15 ++ netbox/dcim/filtersets.py | 10 +- .../dcim/migrations/0154_cabletermination.py | 30 +++ .../0155_populate_cable_terminations.py | 51 ++++ .../0156_cable_remove_terminations.py | 37 +++ netbox/dcim/models/cables.py | 245 +++++++----------- netbox/dcim/tables/cables.py | 93 ++++--- netbox/dcim/views.py | 4 +- 8 files changed, 286 insertions(+), 199 deletions(-) create mode 100644 netbox/dcim/migrations/0154_cabletermination.py create mode 100644 netbox/dcim/migrations/0155_populate_cable_terminations.py create mode 100644 netbox/dcim/migrations/0156_cable_remove_terminations.py diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index a89960457..2354ef6c8 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -1204,6 +1204,21 @@ class CableLengthUnitChoices(ChoiceSet): ) +# +# CableTerminations +# + +class CableEndChoices(ChoiceSet): + + SIDE_A = 'A' + SIDE_B = 'B' + + CHOICES = ( + (SIDE_A, 'A'), + (SIDE_B, 'B') + ) + + # # PowerFeeds # diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index 19c3a414e..6fefe4ac0 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -1498,10 +1498,10 @@ class VirtualChassisFilterSet(NetBoxModelFilterSet): class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): - termination_a_type = ContentTypeFilter() - termination_a_id = MultiValueNumberFilter() - termination_b_type = ContentTypeFilter() - termination_b_id = MultiValueNumberFilter() + # termination_a_type = ContentTypeFilter() + # termination_a_id = MultiValueNumberFilter() + # termination_b_type = ContentTypeFilter() + # termination_b_id = MultiValueNumberFilter() type = django_filters.MultipleChoiceFilter( choices=CableTypeChoices ) @@ -1537,7 +1537,7 @@ class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): class Meta: model = Cable - fields = ['id', 'label', 'length', 'length_unit', 'termination_a_id', 'termination_b_id'] + fields = ['id', 'label', 'length', 'length_unit'] def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/dcim/migrations/0154_cabletermination.py b/netbox/dcim/migrations/0154_cabletermination.py new file mode 100644 index 000000000..5a3a335fe --- /dev/null +++ b/netbox/dcim/migrations/0154_cabletermination.py @@ -0,0 +1,30 @@ +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('contenttypes', '0002_remove_content_type_name'), + ('dcim', '0153_created_datetimefield'), + ] + + operations = [ + migrations.CreateModel( + name='CableTermination', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), + ('cable_end', models.CharField(max_length=1)), + ('termination_id', models.PositiveBigIntegerField()), + ('cable', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='terminations', to='dcim.cable')), + ('termination_type', models.ForeignKey(limit_choices_to=models.Q(models.Q(models.Q(('app_label', 'circuits'), ('model__in', ('circuittermination',))), models.Q(('app_label', 'dcim'), ('model__in', ('consoleport', 'consoleserverport', 'frontport', 'interface', 'powerfeed', 'poweroutlet', 'powerport', 'rearport'))), _connector='OR')), on_delete=django.db.models.deletion.PROTECT, related_name='+', to='contenttypes.contenttype')), + ], + options={ + 'ordering': ['pk'], + }, + ), + migrations.AddConstraint( + model_name='cabletermination', + constraint=models.UniqueConstraint(fields=('termination_type', 'termination_id'), name='unique_termination'), + ), + ] diff --git a/netbox/dcim/migrations/0155_populate_cable_terminations.py b/netbox/dcim/migrations/0155_populate_cable_terminations.py new file mode 100644 index 000000000..c570f240b --- /dev/null +++ b/netbox/dcim/migrations/0155_populate_cable_terminations.py @@ -0,0 +1,51 @@ +from django.db import migrations + + +def populate_cable_terminations(apps, schema_editor): + """ + Replicate terminations from the Cable model into CableTermination instances. + """ + Cable = apps.get_model('dcim', 'Cable') + CableTermination = apps.get_model('dcim', 'CableTermination') + + # Retrieve the necessary data from Cable objects + cables = Cable.objects.values( + 'id', 'termination_a_type', 'termination_a_id', 'termination_b_type', 'termination_b_id' + ) + + # Queue CableTerminations to be created + cable_terminations = [] + for i, cable in enumerate(cables, start=1): + cable_terminations.append( + CableTermination( + cable_id=cable['id'], + cable_end='A', + termination_type_id=cable['termination_a_type'], + termination_id=cable['termination_a_id'] + ) + ) + cable_terminations.append( + CableTermination( + cable_id=cable['id'], + cable_end='B', + termination_type_id=cable['termination_b_type'], + termination_id=cable['termination_b_id'] + ) + ) + + # Bulk create the termination objects + CableTermination.objects.bulk_create(cable_terminations, batch_size=100) + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0154_cabletermination'), + ] + + operations = [ + migrations.RunPython( + code=populate_cable_terminations, + reverse_code=migrations.RunPython.noop + ), + ] diff --git a/netbox/dcim/migrations/0156_cable_remove_terminations.py b/netbox/dcim/migrations/0156_cable_remove_terminations.py new file mode 100644 index 000000000..268224717 --- /dev/null +++ b/netbox/dcim/migrations/0156_cable_remove_terminations.py @@ -0,0 +1,37 @@ +# Generated by Django 4.0.4 on 2022-04-29 14:05 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0155_populate_cable_terminations'), + ] + + operations = [ + migrations.AlterModelOptions( + name='cable', + options={'ordering': ('pk',)}, + ), + migrations.AlterUniqueTogether( + name='cable', + unique_together=set(), + ), + migrations.RemoveField( + model_name='cable', + name='termination_a_id', + ), + migrations.RemoveField( + model_name='cable', + name='termination_a_type', + ), + migrations.RemoveField( + model_name='cable', + name='termination_b_id', + ), + migrations.RemoveField( + model_name='cable', + name='termination_b_type', + ), + ] diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 680ea78a8..18de8cb58 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -2,7 +2,6 @@ from collections import defaultdict from django.contrib.contenttypes.fields import GenericForeignKey from django.contrib.contenttypes.models import ContentType -from django.contrib.postgres.fields import ArrayField from django.core.exceptions import ObjectDoesNotExist, ValidationError from django.db import models from django.db.models import Sum @@ -22,6 +21,7 @@ from .device_components import FrontPort, RearPort __all__ = ( 'Cable', 'CablePath', + 'CableTermination', ) @@ -33,28 +33,6 @@ class Cable(NetBoxModel): """ A physical connection between two endpoints. """ - termination_a_type = models.ForeignKey( - to=ContentType, - limit_choices_to=CABLE_TERMINATION_MODELS, - on_delete=models.PROTECT, - related_name='+' - ) - termination_a_id = models.PositiveBigIntegerField() - termination_a = GenericForeignKey( - ct_field='termination_a_type', - fk_field='termination_a_id' - ) - termination_b_type = models.ForeignKey( - to=ContentType, - limit_choices_to=CABLE_TERMINATION_MODELS, - on_delete=models.PROTECT, - related_name='+' - ) - termination_b_id = models.PositiveBigIntegerField() - termination_b = GenericForeignKey( - ct_field='termination_b_type', - fk_field='termination_b_id' - ) type = models.CharField( max_length=50, choices=CableTypeChoices, @@ -115,11 +93,7 @@ class Cable(NetBoxModel): ) class Meta: - ordering = ['pk'] - unique_together = ( - ('termination_a_type', 'termination_a_id'), - ('termination_b_type', 'termination_b_id'), - ) + ordering = ('pk',) def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) @@ -130,19 +104,19 @@ class Cable(NetBoxModel): # Cache the original status so we can check later if it's been changed self._orig_status = self.status - @classmethod - def from_db(cls, db, field_names, values): - """ - Cache the original A and B terminations of existing Cable instances for later reference inside clean(). - """ - instance = super().from_db(db, field_names, values) - - instance._orig_termination_a_type_id = instance.termination_a_type_id - instance._orig_termination_a_ids = instance.termination_a_ids - instance._orig_termination_b_type_id = instance.termination_b_type_id - instance._orig_termination_b_ids = instance.termination_b_ids - - return instance + # @classmethod + # def from_db(cls, db, field_names, values): + # """ + # Cache the original A and B terminations of existing Cable instances for later reference inside clean(). + # """ + # instance = super().from_db(db, field_names, values) + # + # instance._orig_termination_a_type_id = instance.termination_a_type_id + # instance._orig_termination_a_ids = instance.termination_a_ids + # instance._orig_termination_b_type_id = instance.termination_b_type_id + # instance._orig_termination_b_ids = instance.termination_b_ids + # + # return instance def __str__(self): pk = self.pk or self._pk @@ -151,82 +125,9 @@ class Cable(NetBoxModel): def get_absolute_url(self): return reverse('dcim:cable', args=[self.pk]) - @property - def termination_a(self): - if not hasattr(self, 'termination_a_type') or not self.termination_a_ids: - return [] - return list(self.termination_a_type.model_class().objects.filter(pk__in=self.termination_a_ids)) - - @property - def termination_b(self): - if not hasattr(self, 'termination_b_type') or not self.termination_b_ids: - return [] - return list(self.termination_b_type.model_class().objects.filter(pk__in=self.termination_b_ids)) - def clean(self): - from circuits.models import CircuitTermination - super().clean() - # Validate that termination A exists - if not hasattr(self, 'termination_a_type'): - raise ValidationError('Termination A type has not been specified') - model = self.termination_a_type.model_class() - if model.objects.filter(pk__in=self.termination_a_ids).count() != len(self.termination_a_ids): - raise ValidationError({ - 'termination_a': 'Invalid ID for type {}'.format(self.termination_a_type) - }) - - # Validate that termination B exists - if not hasattr(self, 'termination_b_type'): - raise ValidationError('Termination B type has not been specified') - model = self.termination_a_type.model_class() - if model.objects.filter(pk__in=self.termination_b_ids).count() != len(self.termination_b_ids): - raise ValidationError({ - 'termination_b': 'Invalid ID for type {}'.format(self.termination_b_type) - }) - - # If editing an existing Cable instance, check that neither termination has been modified. - if self.pk: - err_msg = 'Cable termination points may not be modified. Delete and recreate the cable instead.' - if ( - self.termination_a_type_id != self._orig_termination_a_type_id or - set(self.termination_a_ids) != set(self._orig_termination_a_ids) - ): - raise ValidationError({ - 'termination_a': err_msg - }) - if ( - self.termination_b_type_id != self._orig_termination_b_type_id or - set(self.termination_b_ids) != set(self._orig_termination_b_ids) - ): - raise ValidationError({ - 'termination_b': err_msg - }) - - type_a = self.termination_a_type.model - type_b = self.termination_b_type.model - - # Validate interface types - if type_a == 'interface': - for term in self.termination_a: - if term.type in NONCONNECTABLE_IFACE_TYPES: - raise ValidationError({ - 'termination_a_id': f'Cables cannot be terminated to {term.get_type_display()} interfaces' - }) - if type_a == 'interface': - for term in self.termination_b: - if term.type in NONCONNECTABLE_IFACE_TYPES: - raise ValidationError({ - 'termination_b_id': f'Cables cannot be terminated to {term.get_type_display()} interfaces' - }) - - # Check that termination types are compatible - if type_b not in COMPATIBLE_TERMINATION_TYPES.get(type_a): - raise ValidationError( - f"Incompatible termination types: {self.termination_a_type} and {self.termination_b_type}" - ) - # TODO: Is this validation still necessary? # # Check that two connected RearPorts have the same number of positions (if both are >1) # if isinstance(self.termination_a, RearPort) and isinstance(self.termination_b, RearPort): @@ -238,38 +139,6 @@ class Cable(NetBoxModel): # f"Both terminations must have the same number of positions (if greater than one)." # ) - # A termination point cannot be connected to itself - if set(self.termination_a).intersection(self.termination_b): - raise ValidationError(f"Cannot connect {self.termination_a_type} to itself") - - # TODO - # # A front port cannot be connected to its corresponding rear port - # if ( - # type_a in ['frontport', 'rearport'] and - # type_b in ['frontport', 'rearport'] and - # ( - # getattr(self.termination_a, 'rear_port', None) == self.termination_b or - # getattr(self.termination_b, 'rear_port', None) == self.termination_a - # ) - # ): - # raise ValidationError("A front port cannot be connected to it corresponding rear port") - - # TODO - # # A CircuitTermination attached to a ProviderNetwork cannot have a Cable - # if isinstance(self.termination_a, CircuitTermination) and self.termination_a.provider_network is not None: - # raise ValidationError({ - # 'termination_a_id': "Circuit terminations attached to a provider network may not be cabled." - # }) - # if isinstance(self.termination_b, CircuitTermination) and self.termination_b.provider_network is not None: - # raise ValidationError({ - # 'termination_b_id': "Circuit terminations attached to a provider network may not be cabled." - # }) - - # Check for an existing Cable connected to either termination object - for term in [*self.termination_a, *self.termination_b]: - if term.cable not in (None, self): - raise ValidationError(f'{term} already has a cable attached (#{term.cable_id})') - # Validate length and length_unit if self.length is not None and not self.length_unit: raise ValidationError("Must specify a unit when setting a cable length") @@ -284,11 +153,12 @@ class Cable(NetBoxModel): else: self._abs_length = None - # Store the parent Device for the A and B terminations (if applicable) to enable filtering - if hasattr(self.termination_a[0], 'device'): - self._termination_a_device = self.termination_a[0].device - if hasattr(self.termination_b[0], 'device'): - self._termination_b_device = self.termination_b[0].device + # TODO: Move to CableTermination + # # Store the parent Device for the A and B terminations (if applicable) to enable filtering + # if hasattr(self.termination_a[0], 'device'): + # self._termination_a_device = self.termination_a[0].device + # if hasattr(self.termination_b[0], 'device'): + # self._termination_b_device = self.termination_b[0].device super().save(*args, **kwargs) @@ -299,6 +169,79 @@ class Cable(NetBoxModel): return LinkStatusChoices.colors.get(self.status) +class CableTermination(models.Model): + """ + A mapping between side A or B of a Cable and a terminating object (e.g. an Interface or CircuitTermination). + """ + cable = models.ForeignKey( + to='dcim.Cable', + on_delete=models.CASCADE, + related_name='terminations' + ) + cable_end = models.CharField( + max_length=1, + choices=CableEndChoices, + verbose_name='End' + ) + termination_type = models.ForeignKey( + to=ContentType, + limit_choices_to=CABLE_TERMINATION_MODELS, + on_delete=models.PROTECT, + related_name='+' + ) + termination_id = models.PositiveBigIntegerField() + termination = GenericForeignKey( + ct_field='termination_type', + fk_field='termination_id' + ) + + class Meta: + ordering = ['pk'] + constraints = ( + models.UniqueConstraint( + fields=('termination_type', 'termination_id'), + name='unique_termination' + ), + ) + + def __str__(self): + return f'Cable {self.cable} to {self.termination}' + + def clean(self): + super().clean() + + # Validate interface type (if applicable) + if self.termination_type.model == 'interface' and self.termination.type in NONCONNECTABLE_IFACE_TYPES: + raise ValidationError({ + 'termination': f'Cables cannot be terminated to {self.termination.get_type_display()} interfaces' + }) + + # A CircuitTermination attached to a ProviderNetwork cannot have a Cable + if self.termination_type.model == 'circuittermination' and self.termination.provider_network is not None: + raise ValidationError({ + 'termination': "Circuit terminations attached to a provider network may not be cabled." + }) + + # TODO + # # A front port cannot be connected to its corresponding rear port + # if ( + # type_a in ['frontport', 'rearport'] and + # type_b in ['frontport', 'rearport'] and + # ( + # getattr(self.termination_a, 'rear_port', None) == self.termination_b or + # getattr(self.termination_b, 'rear_port', None) == self.termination_a + # ) + # ): + # raise ValidationError("A front port cannot be connected to it corresponding rear port") + + # TODO + # # Check that termination types are compatible + # if type_b not in COMPATIBLE_TERMINATION_TYPES.get(type_a): + # raise ValidationError( + # f"Incompatible termination types: {self.termination_a_type} and {self.termination_b_type}" + # ) + + class CablePath(models.Model): """ A CablePath instance represents the physical path from an origin to a destination, including all intermediate diff --git a/netbox/dcim/tables/cables.py b/netbox/dcim/tables/cables.py index 8abdb54d2..b17cf628e 100644 --- a/netbox/dcim/tables/cables.py +++ b/netbox/dcim/tables/cables.py @@ -4,55 +4,67 @@ from django_tables2.utils import Accessor from dcim.models import Cable from netbox.tables import NetBoxTable, columns from tenancy.tables import TenantColumn -from .template_code import CABLE_LENGTH, CABLE_TERMINATION, CABLE_TERMINATION_PARENT +from .template_code import CABLE_LENGTH __all__ = ( 'CableTable', ) +class CableTerminationColumn(tables.TemplateColumn): + + def __init__(self, cable_end, *args, **kwargs): + template_code = """ + {% for term in value.all %} + {% if term.cable_end == '""" + cable_end + """' %} + {{ term.termination }} + {% endif %} + {% endfor %} + """ + super().__init__(template_code=template_code, *args, **kwargs) + + def value(self, value): + return ', '.join(value.all()) + + # # Cables # class CableTable(NetBoxTable): - termination_a_parent = tables.TemplateColumn( - template_code=CABLE_TERMINATION_PARENT, - accessor=Accessor('termination_a'), - orderable=False, - verbose_name='Side A' + # termination_a_parent = tables.TemplateColumn( + # template_code=CABLE_TERMINATION_PARENT, + # accessor=Accessor('termination_a'), + # orderable=False, + # verbose_name='Side A' + # ) + # rack_a = tables.Column( + # accessor=Accessor('termination_a__device__rack'), + # orderable=False, + # linkify=True, + # verbose_name='Rack A' + # ) + # termination_b_parent = tables.TemplateColumn( + # template_code=CABLE_TERMINATION_PARENT, + # accessor=Accessor('termination_b'), + # orderable=False, + # verbose_name='Side B' + # ) + # rack_b = tables.Column( + # accessor=Accessor('termination_b__device__rack'), + # orderable=False, + # linkify=True, + # verbose_name='Rack B' + # ) + a_terminations = CableTerminationColumn( + cable_end='A', + accessor=Accessor('terminations'), + orderable=False ) - rack_a = tables.Column( - accessor=Accessor('termination_a__device__rack'), - orderable=False, - linkify=True, - verbose_name='Rack A' - ) - termination_a = tables.TemplateColumn( - template_code=CABLE_TERMINATION, - accessor=Accessor('termination_a'), - orderable=False, - linkify=True, - verbose_name='Termination A' - ) - termination_b_parent = tables.TemplateColumn( - template_code=CABLE_TERMINATION_PARENT, - accessor=Accessor('termination_b'), - orderable=False, - verbose_name='Side B' - ) - rack_b = tables.Column( - accessor=Accessor('termination_b__device__rack'), - orderable=False, - linkify=True, - verbose_name='Rack B' - ) - termination_b = tables.TemplateColumn( - template_code=CABLE_TERMINATION, - accessor=Accessor('termination_b'), - orderable=False, - linkify=True, - verbose_name='Termination B' + b_terminations = CableTerminationColumn( + cable_end='B', + accessor=Accessor('terminations'), + orderable=False ) status = columns.ChoiceFieldColumn() tenant = TenantColumn() @@ -68,10 +80,9 @@ class CableTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Cable fields = ( - 'pk', 'id', 'label', 'termination_a_parent', 'rack_a', 'termination_a', 'termination_b_parent', 'rack_b', 'termination_b', - 'status', 'type', 'tenant', 'color', 'length', 'tags', 'created', 'last_updated', + 'pk', 'id', 'label', 'a_terminations', 'b_terminations', 'status', 'type', 'tenant', 'color', 'length', + 'tags', 'created', 'last_updated', ) default_columns = ( - 'pk', 'id', 'label', 'termination_a_parent', 'termination_a', 'termination_b_parent', 'termination_b', - 'status', 'type', + 'pk', 'id', 'label', 'a_terminations', 'b_terminations', 'status', 'type', ) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index d9803f2be..43085702c 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -12,7 +12,7 @@ from django.utils.html import escape from django.utils.safestring import mark_safe from django.views.generic import View -from circuits.models import Circuit, CircuitTermination +from circuits.models import Circuit from extras.views import ObjectConfigContextView from ipam.models import ASN, IPAddress, Prefix, Service, VLAN, VLANGroup from ipam.tables import AssignedIPAddressesTable, InterfaceVLANTable @@ -2738,7 +2738,7 @@ class DeviceBulkAddInventoryItemView(generic.BulkComponentCreateView): # class CableListView(generic.ObjectListView): - queryset = Cable.objects.all() + queryset = Cable.objects.prefetch_related('terminations__termination') filterset = filtersets.CableFilterSet filterset_form = forms.CableFilterForm table = tables.CableTable From 5d37f9f9759b0b31bf0e4fd8fdb7964ff3729abf Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 29 Apr 2022 15:16:35 -0400 Subject: [PATCH 030/593] Update cable connection forms --- netbox/dcim/api/serializers.py | 15 +-- netbox/dcim/forms/connections.py | 122 ++++++++---------- netbox/dcim/models/cables.py | 10 ++ netbox/dcim/signals.py | 43 +++--- netbox/dcim/tables/template_code.py | 50 +++---- netbox/dcim/views.py | 25 ++-- .../circuits/inc/circuit_termination.html | 8 +- netbox/templates/dcim/cable.html | 4 +- netbox/templates/dcim/cable_connect.html | 52 ++++---- netbox/templates/dcim/consoleport.html | 6 +- netbox/templates/dcim/consoleserverport.html | 6 +- netbox/templates/dcim/frontport.html | 12 +- .../templates/dcim/inc/cable_termination.html | 20 +-- netbox/templates/dcim/interface.html | 8 +- netbox/templates/dcim/powerfeed.html | 2 +- netbox/templates/dcim/poweroutlet.html | 2 +- netbox/templates/dcim/powerport.html | 4 +- netbox/templates/dcim/rearport.html | 8 +- 18 files changed, 185 insertions(+), 212 deletions(-) diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 9368fa6ee..cc218c61c 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -962,14 +962,8 @@ class InventoryItemRoleSerializer(NetBoxModelSerializer): class CableSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cable-detail') - termination_a_type = ContentTypeField( - queryset=ContentType.objects.filter(CABLE_TERMINATION_MODELS) - ) - termination_b_type = ContentTypeField( - queryset=ContentType.objects.filter(CABLE_TERMINATION_MODELS) - ) - termination_a = serializers.SerializerMethodField(read_only=True) - termination_b = serializers.SerializerMethodField(read_only=True) + # termination_a = serializers.SerializerMethodField(read_only=True) + # termination_b = serializers.SerializerMethodField(read_only=True) status = ChoiceField(choices=LinkStatusChoices, required=False) tenant = NestedTenantSerializer(required=False, allow_null=True) length_unit = ChoiceField(choices=CableLengthUnitChoices, allow_blank=True, required=False) @@ -977,9 +971,8 @@ class CableSerializer(NetBoxModelSerializer): class Meta: model = Cable fields = [ - 'id', 'url', 'display', 'termination_a_type', 'termination_a_ids', 'termination_a', 'termination_b_type', - 'termination_b_ids', 'termination_b', 'type', 'status', 'tenant', 'label', 'color', 'length', 'length_unit', - 'tags', 'custom_fields', 'created', 'last_updated', + 'id', 'url', 'display', 'type', 'status', 'tenant', 'label', 'color', + 'length', 'length_unit', 'tags', 'custom_fields', 'created', 'last_updated', ] def _get_termination(self, obj, side): diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index bcac15044..593a2b2fe 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -17,18 +17,47 @@ __all__ = ( ) -class ConnectCableToDeviceForm(TenancyForm, NetBoxModelForm): - """ - Base form for connecting a Cable to a Device component - """ - # Termination A - termination_a_ids = DynamicModelMultipleChoiceField( +class BaseCableConnectionForm(TenancyForm, NetBoxModelForm): + a_terminations = DynamicModelMultipleChoiceField( + queryset=Interface.objects.all(), + label='Name', + disabled_indicator='_occupied' + ) + b_terminations = DynamicModelMultipleChoiceField( queryset=Interface.objects.all(), label='Name', disabled_indicator='_occupied' ) - # Termination B + def save(self, commit=True): + instance = super().save(commit=commit) + + # Create CableTermination instances + terminations = [] + terminations.extend([ + CableTermination(cable=instance, cable_end='A', termination=termination) + for termination in self.cleaned_data['a_terminations'] + ]) + terminations.extend([ + CableTermination(cable=instance, cable_end='B', termination=termination) + for termination in self.cleaned_data['b_terminations'] + ]) + + if commit: + CableTermination.objects.bulk_create(terminations) + else: + instance.terminations = [ + *self.cleaned_data['a_terminations'], + *self.cleaned_data['b_terminations'], + ] + + return instance + + +class ConnectCableToDeviceForm(BaseCableConnectionForm): + """ + Base form for connecting a Cable to a Device component + """ termination_b_region = DynamicModelChoiceField( queryset=Region.objects.all(), label='Region', @@ -83,17 +112,12 @@ class ConnectCableToDeviceForm(TenancyForm, NetBoxModelForm): 'rack_id': '$termination_b_rack', } ) - termination_b_ids = DynamicModelMultipleChoiceField( - queryset=Interface.objects.all(), - label='Name', - disabled_indicator='_occupied' - ) class Meta: model = Cable fields = [ - 'termination_a_ids', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', - 'termination_b_rack', 'termination_b_device', 'termination_b_ids', 'type', 'status', 'tenant_group', + 'a_terminations', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', + 'termination_b_rack', 'termination_b_device', 'b_terminations', 'type', 'status', 'tenant_group', 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', ] widgets = { @@ -102,17 +126,9 @@ class ConnectCableToDeviceForm(TenancyForm, NetBoxModelForm): 'length_unit': StaticSelect, } - def clean_termination_a_ids(self): - # Return the PK rather than the object - return [getattr(obj, 'pk') for obj in self.cleaned_data['termination_a_ids']] - - def clean_termination_b_ids(self): - # Return the PK rather than the object - return [getattr(obj, 'pk') for obj in self.cleaned_data['termination_b_ids']] - class ConnectCableToConsolePortForm(ConnectCableToDeviceForm): - termination_b_ids = DynamicModelMultipleChoiceField( + b_terminations = DynamicModelMultipleChoiceField( queryset=ConsolePort.objects.all(), label='Name', disabled_indicator='_occupied', @@ -123,7 +139,7 @@ class ConnectCableToConsolePortForm(ConnectCableToDeviceForm): class ConnectCableToConsoleServerPortForm(ConnectCableToDeviceForm): - termination_b_ids = DynamicModelMultipleChoiceField( + b_terminations = DynamicModelMultipleChoiceField( queryset=ConsoleServerPort.objects.all(), label='Name', disabled_indicator='_occupied', @@ -134,7 +150,7 @@ class ConnectCableToConsoleServerPortForm(ConnectCableToDeviceForm): class ConnectCableToPowerPortForm(ConnectCableToDeviceForm): - termination_b_ids = DynamicModelMultipleChoiceField( + b_terminations = DynamicModelMultipleChoiceField( queryset=PowerPort.objects.all(), label='Name', disabled_indicator='_occupied', @@ -145,7 +161,7 @@ class ConnectCableToPowerPortForm(ConnectCableToDeviceForm): class ConnectCableToPowerOutletForm(ConnectCableToDeviceForm): - termination_b_ids = DynamicModelMultipleChoiceField( + b_terminations = DynamicModelMultipleChoiceField( queryset=PowerOutlet.objects.all(), label='Name', disabled_indicator='_occupied', @@ -156,7 +172,7 @@ class ConnectCableToPowerOutletForm(ConnectCableToDeviceForm): class ConnectCableToInterfaceForm(ConnectCableToDeviceForm): - termination_b_ids = DynamicModelMultipleChoiceField( + b_terminations = DynamicModelMultipleChoiceField( queryset=Interface.objects.all(), label='Name', disabled_indicator='_occupied', @@ -168,7 +184,7 @@ class ConnectCableToInterfaceForm(ConnectCableToDeviceForm): class ConnectCableToFrontPortForm(ConnectCableToDeviceForm): - termination_b_ids = DynamicModelMultipleChoiceField( + b_terminations = DynamicModelMultipleChoiceField( queryset=FrontPort.objects.all(), label='Name', disabled_indicator='_occupied', @@ -179,7 +195,7 @@ class ConnectCableToFrontPortForm(ConnectCableToDeviceForm): class ConnectCableToRearPortForm(ConnectCableToDeviceForm): - termination_b_ids = DynamicModelMultipleChoiceField( + b_terminations = DynamicModelMultipleChoiceField( queryset=RearPort.objects.all(), label='Name', disabled_indicator='_occupied', @@ -189,15 +205,7 @@ class ConnectCableToRearPortForm(ConnectCableToDeviceForm): ) -class ConnectCableToCircuitTerminationForm(TenancyForm, NetBoxModelForm): - # Termination A - termination_a_ids = DynamicModelMultipleChoiceField( - queryset=Interface.objects.all(), - label='Side', - disabled_indicator='_occupied' - ) - - # Termination B +class ConnectCableToCircuitTerminationForm(BaseCableConnectionForm): termination_b_provider = DynamicModelChoiceField( queryset=Provider.objects.all(), label='Provider', @@ -236,7 +244,7 @@ class ConnectCableToCircuitTerminationForm(TenancyForm, NetBoxModelForm): 'site_id': '$termination_b_site', } ) - termination_b_ids = DynamicModelMultipleChoiceField( + b_terminations = DynamicModelMultipleChoiceField( queryset=CircuitTermination.objects.all(), label='Side', disabled_indicator='_occupied', @@ -247,29 +255,13 @@ class ConnectCableToCircuitTerminationForm(TenancyForm, NetBoxModelForm): class Meta(ConnectCableToDeviceForm.Meta): fields = [ - 'termination_a_ids', 'termination_b_provider', 'termination_b_region', 'termination_b_sitegroup', - 'termination_b_site', 'termination_b_circuit', 'termination_b_ids', 'type', 'status', 'tenant_group', + 'a_terminations', 'termination_b_provider', 'termination_b_region', 'termination_b_sitegroup', + 'termination_b_site', 'termination_b_circuit', 'b_terminations', 'type', 'status', 'tenant_group', 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', ] - def clean_termination_a_id(self): - # Return the PK rather than the object - return getattr(self.cleaned_data['termination_a_id'], 'pk', None) - def clean_termination_b_id(self): - # Return the PK rather than the object - return getattr(self.cleaned_data['termination_b_id'], 'pk', None) - - -class ConnectCableToPowerFeedForm(TenancyForm, NetBoxModelForm): - # Termination A - termination_a_ids = DynamicModelMultipleChoiceField( - queryset=Interface.objects.all(), - label='Name', - disabled_indicator='_occupied' - ) - - # Termination B +class ConnectCableToPowerFeedForm(BaseCableConnectionForm): termination_b_region = DynamicModelChoiceField( queryset=Region.objects.all(), label='Region', @@ -312,7 +304,7 @@ class ConnectCableToPowerFeedForm(TenancyForm, NetBoxModelForm): 'location_id': '$termination_b_location', } ) - termination_b_ids = DynamicModelMultipleChoiceField( + b_terminations = DynamicModelMultipleChoiceField( queryset=PowerFeed.objects.all(), label='Name', disabled_indicator='_occupied', @@ -323,15 +315,7 @@ class ConnectCableToPowerFeedForm(TenancyForm, NetBoxModelForm): class Meta(ConnectCableToDeviceForm.Meta): fields = [ - 'termination_a_ids', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', - 'termination_b_location', 'termination_b_powerpanel', 'termination_b_ids', 'type', 'status', 'tenant_group', + 'a_terminations', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', + 'termination_b_location', 'termination_b_powerpanel', 'b_terminations', 'type', 'status', 'tenant_group', 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', ] - - def clean_termination_a_id(self): - # Return the PK rather than the object - return getattr(self.cleaned_data['termination_a_id'], 'pk', None) - - def clean_termination_b_id(self): - # Return the PK rather than the object - return getattr(self.cleaned_data['termination_b_id'], 'pk', None) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 18de8cb58..5eb48fbf2 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -168,6 +168,16 @@ class Cable(NetBoxModel): def get_status_color(self): return LinkStatusChoices.colors.get(self.status) + def get_a_terminations(self): + return [ + term.termination for term in CableTermination.objects.filter(cable=self, cable_end='A') + ] + + def get_b_terminations(self): + return [ + term.termination for term in CableTermination.objects.filter(cable=self, cable_end='B') + ] + class CableTermination(models.Model): """ diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index fa75cf992..38349e680 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -81,34 +81,27 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): # TODO: Update link peer fields # Cache the Cable on its termination points - for term in instance.termination_a: - if term.cable != instance: + for term in instance.terminations.all(): + if term.termination.cable != instance: logger.debug(f"Updating termination A for cable {instance}: {term}") - term.cable = instance - # term._link_peer = instance.termination_b - term.save() - for term in instance.termination_b: - if term.cable != instance: - logger.debug(f"Updating termination B for cable {instance}") - term.cable = instance - # term._link_peer = instance.termination_a + term.termination.cable = instance term.save() - # Create/update cable paths - if created: - for termination in [*instance.termination_a, *instance.termination_b]: - if isinstance(termination, PathEndpoint): - create_cablepath(termination) - else: - rebuild_paths(termination) - elif instance.status != instance._orig_status: - # We currently don't support modifying either termination of an existing Cable. (This - # may change in the future.) However, we do need to capture status changes and update - # any CablePaths accordingly. - if instance.status != LinkStatusChoices.STATUS_CONNECTED: - CablePath.objects.filter(path__contains=instance).update(is_active=False) - else: - rebuild_paths(instance) + # # Create/update cable paths + # if created: + # for term in instance.terminations.all(): + # if isinstance(term.termination, PathEndpoint): + # create_cablepath(term.termination) + # else: + # rebuild_paths(term.termination) + # elif instance.status != instance._orig_status: + # # We currently don't support modifying either termination of an existing Cable. (This + # # may change in the future.) However, we do need to capture status changes and update + # # any CablePaths accordingly. + # if instance.status != LinkStatusChoices.STATUS_CONNECTED: + # CablePath.objects.filter(path__contains=instance).update(is_active=False) + # else: + # rebuild_paths(instance) @receiver(post_delete, sender=Cable) diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index 9911a938d..b72b4738f 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -139,9 +139,9 @@ CONSOLEPORT_BUTTONS = """ {% else %} @@ -171,9 +171,9 @@ CONSOLESERVERPORT_BUTTONS = """ {% else %} @@ -203,8 +203,8 @@ POWERPORT_BUTTONS = """ {% else %} @@ -230,7 +230,7 @@ POWEROUTLET_BUTTONS = """ {% if not record.mark_connected %} - + {% else %} @@ -280,10 +280,10 @@ INTERFACE_BUTTONS = """ {% else %} @@ -319,12 +319,12 @@ FRONTPORT_BUTTONS = """ {% else %} @@ -356,12 +356,12 @@ REARPORT_BUTTONS = """ {% else %} diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 43085702c..09e15676d 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2829,24 +2829,14 @@ class CableCreateView(generic.ObjectEditView): # Always return a new instance return self.queryset.model() - def alter_object(self, obj, request, url_args, url_kwargs): - termination_a_type = url_kwargs.get('termination_a_type') - termination_a_ids = request.GET.get('termination_a_ids', []) - app_label, model = request.GET.get('termination_b_type').split('.') - self.termination_b_type = ContentType.objects.get(app_label=app_label, model=model) - - # Initialize Cable termination attributes - obj.termination_a_type = ContentType.objects.get_for_model(termination_a_type) - obj.termination_a_ids = termination_a_type.objects.filter(pk__in=termination_a_ids) - obj.termination_b_type = self.termination_b_type - - return obj - def get(self, request, *args, **kwargs): obj = self.get_object(**kwargs) obj = self.alter_object(obj, request, args, kwargs) initial_data = request.GET + app_label, model = request.GET.get('termination_b_type').split('.') + termination_b_type = ContentType.objects.get(app_label=app_label, model=model) + # TODO # # Set initial site and rack based on side A termination (if not already set) # termination_a_site = getattr(obj.termination_a.parent_object, 'site', None) @@ -2857,12 +2847,17 @@ class CableCreateView(generic.ObjectEditView): form = self.form(instance=obj, initial=initial_data) # Set the queryset of termination A - form.fields['termination_a_ids'].queryset = kwargs['termination_a_type'].objects.all() + form.fields['a_terminations'].queryset = kwargs['termination_a_type'].objects.all() + + # TODO Find a better way to infer the near-end parent object + termination_a = kwargs['termination_a_type'].objects.filter(pk__in=initial_data['a_terminations']).first() return render(request, self.template_name, { 'obj': obj, 'obj_type': Cable._meta.verbose_name, - 'termination_b_type': self.termination_b_type.name, + 'termination_a_type': kwargs['termination_a_type']._meta.model_name, + 'termination_a': termination_a, + 'termination_b_type': termination_b_type.name, 'form': form, 'return_url': self.get_return_url(request, obj), }) diff --git a/netbox/templates/circuits/inc/circuit_termination.html b/netbox/templates/circuits/inc/circuit_termination.html index 12fb85d57..71732938e 100644 --- a/netbox/templates/circuits/inc/circuit_termination.html +++ b/netbox/templates/circuits/inc/circuit_termination.html @@ -70,10 +70,10 @@ Connect {% endif %} diff --git a/netbox/templates/dcim/cable.html b/netbox/templates/dcim/cable.html index 712704f67..effb55c02 100644 --- a/netbox/templates/dcim/cable.html +++ b/netbox/templates/dcim/cable.html @@ -63,13 +63,13 @@
      Termination A
      - {% include 'dcim/inc/cable_termination.html' with termination=object.termination_a %} + {% include 'dcim/inc/cable_termination.html' with terminations=object.get_a_terminations %}
      Termination B
      - {% include 'dcim/inc/cable_termination.html' with termination=object.termination_b %} + {% include 'dcim/inc/cable_termination.html' with terminations=object.get_b_terminations %}
      {% plugin_right_page object %} diff --git a/netbox/templates/dcim/cable_connect.html b/netbox/templates/dcim/cable_connect.html index bba9609b4..1ce465018 100644 --- a/netbox/templates/dcim/cable_connect.html +++ b/netbox/templates/dcim/cable_connect.html @@ -15,9 +15,8 @@ {% block content-wrapper %}
      - {% with termination_a=form.instance.termination_a.0 %} - {% render_errors form %} - + {% render_errors form %} + {% csrf_token %} {% for field in form.hidden_fields %} {{ field }} @@ -27,7 +26,27 @@
      A Side
      - {% if termination_a.device %} + {% if termination_a_type == 'circuit' %} + {# Circuit termination #} +
      + +
      + +
      +
      +
      + +
      + +
      +
      +
      + +
      + +
      +
      + {% else %} {# Device component #}
      @@ -71,28 +90,8 @@
      - {% else %} - {# Circuit termination #} -
      - -
      - -
      -
      -
      - -
      - -
      -
      -
      - -
      - -
      -
      {% endif %} - {% render_field form.termination_a_ids %} + {% render_field form.a_terminations %}
      @@ -148,7 +147,7 @@ - {% render_field form.termination_b_ids %} + {% render_field form.b_terminations %} @@ -170,6 +169,5 @@ - {% endwith %} {% endblock %} diff --git a/netbox/templates/dcim/consoleport.html b/netbox/templates/dcim/consoleport.html index f2ebc16d9..b80f86dd4 100644 --- a/netbox/templates/dcim/consoleport.html +++ b/netbox/templates/dcim/consoleport.html @@ -113,7 +113,7 @@
    • Console Server Port @@ -121,7 +121,7 @@
    • Front Port @@ -129,7 +129,7 @@
    • Rear Port diff --git a/netbox/templates/dcim/consoleserverport.html b/netbox/templates/dcim/consoleserverport.html index 47b784ede..2d863cd7d 100644 --- a/netbox/templates/dcim/consoleserverport.html +++ b/netbox/templates/dcim/consoleserverport.html @@ -115,7 +115,7 @@
    • Console Port @@ -123,7 +123,7 @@
    • Front Port @@ -131,7 +131,7 @@
    • Rear Port diff --git a/netbox/templates/dcim/frontport.html b/netbox/templates/dcim/frontport.html index 75402e2e7..003c3c020 100644 --- a/netbox/templates/dcim/frontport.html +++ b/netbox/templates/dcim/frontport.html @@ -105,22 +105,22 @@ diff --git a/netbox/templates/dcim/inc/cable_termination.html b/netbox/templates/dcim/inc/cable_termination.html index 4a0a25372..7d5aef46d 100644 --- a/netbox/templates/dcim/inc/cable_termination.html +++ b/netbox/templates/dcim/inc/cable_termination.html @@ -1,29 +1,29 @@ {% load helpers %} - {% if termination.0.device %} + {% if terminations.0.device %} {# Device component #} - + - + - {% if termination.0.device.rack %} + {% if terminations.0.device.rack %} - + {% endif %} - + - + @@ -32,12 +32,12 @@ {# Circuit termination #} - + diff --git a/netbox/templates/dcim/interface.html b/netbox/templates/dcim/interface.html index 7181d2554..708ea7370 100644 --- a/netbox/templates/dcim/interface.html +++ b/netbox/templates/dcim/interface.html @@ -251,22 +251,22 @@
      • - + Interface
      • - + Front Port
      • - + Rear Port
      • - + Circuit Termination
        • diff --git a/netbox/templates/dcim/powerfeed.html b/netbox/templates/dcim/powerfeed.html index 7c18c402a..f8b1e3368 100644 --- a/netbox/templates/dcim/powerfeed.html +++ b/netbox/templates/dcim/powerfeed.html @@ -158,7 +158,7 @@ {% if not object.mark_connected and not object.cable %}
        {% if perms.dcim.add_cable %} - Connect diff --git a/netbox/templates/dcim/poweroutlet.html b/netbox/templates/dcim/poweroutlet.html index d63d7c87f..3cb4afa29 100644 --- a/netbox/templates/dcim/poweroutlet.html +++ b/netbox/templates/dcim/poweroutlet.html @@ -111,7 +111,7 @@
        Not Connected {% if perms.dcim.add_cable %} - + Connect {% endif %} diff --git a/netbox/templates/dcim/powerport.html b/netbox/templates/dcim/powerport.html index de5385cea..9d2ad2ce4 100644 --- a/netbox/templates/dcim/powerport.html +++ b/netbox/templates/dcim/powerport.html @@ -117,10 +117,10 @@ diff --git a/netbox/templates/dcim/rearport.html b/netbox/templates/dcim/rearport.html index 5076ca083..c9b9fb9cd 100644 --- a/netbox/templates/dcim/rearport.html +++ b/netbox/templates/dcim/rearport.html @@ -101,16 +101,16 @@ From c3742f63fd01e4dafa79318646c85c651a496221 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 2 May 2022 08:26:02 -0400 Subject: [PATCH 031/593] Update signal handlers (WIP) --- netbox/dcim/models/device_components.py | 12 -------- netbox/dcim/signals.py | 39 +++++++++++++++---------- 2 files changed, 23 insertions(+), 28 deletions(-) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 9a0609c12..4d3c5674f 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -139,18 +139,6 @@ class LinkTermination(models.Model): help_text="Treat as if a cable is connected" ) - # Generic relations to Cable. These ensure that an attached Cable is deleted if the terminated object is deleted. - _cabled_as_a = GenericRelation( - to='dcim.Cable', - content_type_field='termination_a_type', - object_id_field='termination_a_id' - ) - _cabled_as_b = GenericRelation( - to='dcim.Cable', - content_type_field='termination_b_type', - object_id_field='termination_b_id' - ) - class Meta: abstract = True diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 38349e680..5a5cedcd5 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -5,7 +5,7 @@ from django.db.models.signals import post_save, post_delete, pre_delete from django.dispatch import receiver from .choices import LinkStatusChoices -from .models import Cable, CablePath, Device, PathEndpoint, PowerPanel, Rack, Location, VirtualChassis +from .models import Cable, CablePath, CableTermination, Device, PathEndpoint, PowerPanel, Rack, Location, VirtualChassis from .utils import create_cablepath, rebuild_paths @@ -80,12 +80,6 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): return # TODO: Update link peer fields - # Cache the Cable on its termination points - for term in instance.terminations.all(): - if term.termination.cable != instance: - logger.debug(f"Updating termination A for cable {instance}: {term}") - term.termination.cable = instance - term.save() # # Create/update cable paths # if created: @@ -104,6 +98,19 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): # rebuild_paths(instance) +@receiver(post_save, sender=CableTermination) +def cache_cable_on_endpoints(instance, created, raw=False, **kwargs): + if not raw: + model = instance.termination_type.model_class() + model.objects.filter(pk=instance.termination_id).update(cable=instance.cable) + + +@receiver(post_delete, sender=CableTermination) +def clear_cable_on_endpoints(instance, **kwargs): + model = instance.termination_type.model_class() + model.objects.filter(pk=instance.termination_id).update(cable=None) + + @receiver(post_delete, sender=Cable) def nullify_connected_endpoints(instance, **kwargs): """ @@ -111,15 +118,15 @@ def nullify_connected_endpoints(instance, **kwargs): """ logger = logging.getLogger('netbox.dcim.cable') - # Disassociate the Cable from its termination points - if instance.termination_a: - logger.debug(f"Nullifying termination A for cable {instance}") - model = instance.termination_a_type.model_class() - model.objects.filter(pk__in=instance.termination_a_ids).update(_link_peer_type=None, _link_peer_id=None) - if instance.termination_b: - logger.debug(f"Nullifying termination B for cable {instance}") - model = instance.termination_b_type.model_class() - model.objects.filter(pk__in=instance.termination_b_ids).update(_link_peer_type=None, _link_peer_id=None) + # # Disassociate the Cable from its termination points + # if instance.termination_a: + # logger.debug(f"Nullifying termination A for cable {instance}") + # model = instance.termination_a_type.model_class() + # model.objects.filter(pk__in=instance.termination_a_ids).update(_link_peer_type=None, _link_peer_id=None) + # if instance.termination_b: + # logger.debug(f"Nullifying termination B for cable {instance}") + # model = instance.termination_b_type.model_class() + # model.objects.filter(pk__in=instance.termination_b_ids).update(_link_peer_type=None, _link_peer_id=None) # Delete and retrace any dependent cable paths for cablepath in CablePath.objects.filter(path__contains=instance): From f0fc8bf2cf40b669ba9b412f79d9666dafc8322e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 3 May 2022 09:53:01 -0400 Subject: [PATCH 032/593] Restrict A terminations by parent object --- netbox/dcim/models/device_components.py | 2 +- netbox/dcim/views.py | 11 +++++++---- netbox/templates/dcim/cable_connect.html | 24 +++++++++--------------- 3 files changed, 17 insertions(+), 20 deletions(-) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 4d3c5674f..d2e4a3c88 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -159,7 +159,7 @@ class LinkTermination(models.Model): @property def parent_object(self): - raise NotImplementedError("CableTermination models must implement parent_object()") + raise NotImplementedError(f"{self.__class__.__name__} models must declare a parent_object property") @property def link(self): diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 09e15676d..3ea7ecc06 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2846,17 +2846,20 @@ class CableCreateView(generic.ObjectEditView): # initial_data['termination_b_rack'] = getattr(obj.termination_a.parent_object, 'rack', None) form = self.form(instance=obj, initial=initial_data) + # TODO Find a better way to infer the near-end parent object + termination_a = kwargs['termination_a_type'].objects.filter(pk=int(initial_data['a_terminations'])).first() + # Set the queryset of termination A form.fields['a_terminations'].queryset = kwargs['termination_a_type'].objects.all() - - # TODO Find a better way to infer the near-end parent object - termination_a = kwargs['termination_a_type'].objects.filter(pk__in=initial_data['a_terminations']).first() + form.fields['a_terminations'].widget.add_query_params({ + 'device_id': termination_a.device_id, + }) return render(request, self.template_name, { 'obj': obj, 'obj_type': Cable._meta.verbose_name, 'termination_a_type': kwargs['termination_a_type']._meta.model_name, - 'termination_a': termination_a, + 'termination_a_parent': termination_a.parent_object, 'termination_b_type': termination_b_type.name, 'form': form, 'return_url': self.get_return_url(request, obj), diff --git a/netbox/templates/dcim/cable_connect.html b/netbox/templates/dcim/cable_connect.html index 1ce465018..fdbc4cf97 100644 --- a/netbox/templates/dcim/cable_connect.html +++ b/netbox/templates/dcim/cable_connect.html @@ -28,22 +28,16 @@
        {% if termination_a_type == 'circuit' %} {# Circuit termination #} -
        - -
        - -
        -
        - +
        - +
        {% else %} @@ -51,43 +45,43 @@
        - +
        - +
        - +
        - +
        - +
        - +
        - +
        {% endif %} From c22007939b9447a0100f3318a3b7579efdbb0d91 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 3 May 2022 10:07:14 -0400 Subject: [PATCH 033/593] Ensure cable is cached on terminating endpoints --- netbox/dcim/forms/connections.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index 593a2b2fe..ef796ea64 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -44,7 +44,8 @@ class BaseCableConnectionForm(TenancyForm, NetBoxModelForm): ]) if commit: - CableTermination.objects.bulk_create(terminations) + for ct in terminations: + ct.save() else: instance.terminations = [ *self.cleaned_data['a_terminations'], From 82706eb3a68e963d7ac089478788b87892d4ee79 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 3 May 2022 11:32:52 -0400 Subject: [PATCH 034/593] Migrate CablePath to use two-dimensional array --- netbox/dcim/api/views.py | 12 +-- netbox/dcim/fields.py | 13 ++++ netbox/dcim/migrations/0157_cablepath.py | 29 +++++++ .../0158_cablepath_populate_path.py | 50 ++++++++++++ ...159_cablepath_remove_origin_destination.py | 33 ++++++++ netbox/dcim/models/cables.py | 78 +++++++++---------- netbox/dcim/models/device_components.py | 2 +- netbox/dcim/signals.py | 2 +- netbox/dcim/utils.py | 10 +++ netbox/dcim/views.py | 2 +- netbox/netbox/views/__init__.py | 7 +- 11 files changed, 183 insertions(+), 55 deletions(-) create mode 100644 netbox/dcim/migrations/0157_cablepath.py create mode 100644 netbox/dcim/migrations/0158_cablepath_populate_path.py create mode 100644 netbox/dcim/migrations/0159_cablepath_remove_origin_destination.py diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index b3bda01cd..c82c4aff2 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -546,7 +546,7 @@ class ModuleViewSet(NetBoxModelViewSet): class ConsolePortViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = ConsolePort.objects.prefetch_related( - 'device', 'module__module_bay', '_path__destination', 'cable', '_link_peer', 'tags' + 'device', 'module__module_bay', '_path', 'cable', '_link_peer', 'tags' ) serializer_class = serializers.ConsolePortSerializer filterset_class = filtersets.ConsolePortFilterSet @@ -555,7 +555,7 @@ class ConsolePortViewSet(PathEndpointMixin, NetBoxModelViewSet): class ConsoleServerPortViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = ConsoleServerPort.objects.prefetch_related( - 'device', 'module__module_bay', '_path__destination', 'cable', '_link_peer', 'tags' + 'device', 'module__module_bay', '_path', 'cable', '_link_peer', 'tags' ) serializer_class = serializers.ConsoleServerPortSerializer filterset_class = filtersets.ConsoleServerPortFilterSet @@ -564,7 +564,7 @@ class ConsoleServerPortViewSet(PathEndpointMixin, NetBoxModelViewSet): class PowerPortViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = PowerPort.objects.prefetch_related( - 'device', 'module__module_bay', '_path__destination', 'cable', '_link_peer', 'tags' + 'device', 'module__module_bay', '_path', 'cable', '_link_peer', 'tags' ) serializer_class = serializers.PowerPortSerializer filterset_class = filtersets.PowerPortFilterSet @@ -573,7 +573,7 @@ class PowerPortViewSet(PathEndpointMixin, NetBoxModelViewSet): class PowerOutletViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = PowerOutlet.objects.prefetch_related( - 'device', 'module__module_bay', '_path__destination', 'cable', '_link_peer', 'tags' + 'device', 'module__module_bay', '_path', 'cable', '_link_peer', 'tags' ) serializer_class = serializers.PowerOutletSerializer filterset_class = filtersets.PowerOutletFilterSet @@ -582,7 +582,7 @@ class PowerOutletViewSet(PathEndpointMixin, NetBoxModelViewSet): class InterfaceViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = Interface.objects.prefetch_related( - 'device', 'module__module_bay', 'parent', 'bridge', 'lag', '_path__destination', 'cable', '_link_peer', + 'device', 'module__module_bay', 'parent', 'bridge', 'lag', '_path', 'cable', '_link_peer', 'wireless_lans', 'untagged_vlan', 'tagged_vlans', 'vrf', 'ip_addresses', 'fhrp_group_assignments', 'tags' ) serializer_class = serializers.InterfaceSerializer @@ -685,7 +685,7 @@ class PowerPanelViewSet(NetBoxModelViewSet): class PowerFeedViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = PowerFeed.objects.prefetch_related( - 'power_panel', 'rack', '_path__destination', 'cable', '_link_peer', 'tags' + 'power_panel', 'rack', '_path', 'cable', '_link_peer', 'tags' ) serializer_class = serializers.PowerFeedSerializer filterset_class = filtersets.PowerFeedFilterSet diff --git a/netbox/dcim/fields.py b/netbox/dcim/fields.py index d3afe5c08..5ec88f89a 100644 --- a/netbox/dcim/fields.py +++ b/netbox/dcim/fields.py @@ -10,6 +10,7 @@ from .lookups import PathContains __all__ = ( 'ASNField', 'MACAddressField', + 'MultiNodePathField', 'PathField', 'WWNField', ) @@ -104,4 +105,16 @@ class PathField(ArrayField): super().__init__(**kwargs) +class MultiNodePathField(ArrayField): + """ + A two-dimensional ArrayField which represents a path, with one or more nodes at each hop. Each node is + identified by a (type, ID) tuple. + """ + def __init__(self, **kwargs): + kwargs['base_field'] = ArrayField( + base_field=models.CharField(max_length=40) + ) + super().__init__(**kwargs) + + PathField.register_lookup(PathContains) diff --git a/netbox/dcim/migrations/0157_cablepath.py b/netbox/dcim/migrations/0157_cablepath.py new file mode 100644 index 000000000..0ff773cba --- /dev/null +++ b/netbox/dcim/migrations/0157_cablepath.py @@ -0,0 +1,29 @@ +import dcim.fields +import django.contrib.postgres.fields +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0156_cable_remove_terminations'), + ] + + operations = [ + migrations.RenameField( + model_name='cablepath', + old_name='path', + new_name='_nodes', + ), + migrations.AddField( + model_name='cablepath', + name='path', + field=dcim.fields.MultiNodePathField(base_field=django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=40), size=None), default=[], size=None), + preserve_default=False, + ), + migrations.AddField( + model_name='cablepath', + name='is_complete', + field=models.BooleanField(default=False), + ), + ] diff --git a/netbox/dcim/migrations/0158_cablepath_populate_path.py b/netbox/dcim/migrations/0158_cablepath_populate_path.py new file mode 100644 index 000000000..972c70143 --- /dev/null +++ b/netbox/dcim/migrations/0158_cablepath_populate_path.py @@ -0,0 +1,50 @@ +from django.db import migrations + +from dcim.utils import compile_path_node + + +def populate_cable_paths(apps, schema_editor): + """ + Replicate terminations from the Cable model into CableTermination instances. + """ + CablePath = apps.get_model('dcim', 'CablePath') + + # Construct the new two-dimensional path, and add the origin & destination objects to the nodes list + cable_paths = [] + for cablepath in CablePath.objects.all(): + + # Origin + origin = compile_path_node(cablepath.origin_type_id, cablepath.origin_id) + cablepath.path.append([origin]) + cablepath._nodes.insert(0, origin) + + # Transit nodes + cablepath.path.extend([ + [node] for node in cablepath._nodes[1:] + ]) + + # Destination + if cablepath.destination_id: + destination = compile_path_node(cablepath.destination_type_id, cablepath.destination_id) + cablepath.path.append([destination]) + cablepath._nodes.append(destination) + cablepath.is_complete = True + + cable_paths.append(cablepath) + + # Bulk create the termination objects + CablePath.objects.bulk_update(cable_paths, fields=('path', 'is_complete'), batch_size=100) + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0157_cablepath'), + ] + + operations = [ + migrations.RunPython( + code=populate_cable_paths, + reverse_code=migrations.RunPython.noop + ), + ] diff --git a/netbox/dcim/migrations/0159_cablepath_remove_origin_destination.py b/netbox/dcim/migrations/0159_cablepath_remove_origin_destination.py new file mode 100644 index 000000000..12d585bf0 --- /dev/null +++ b/netbox/dcim/migrations/0159_cablepath_remove_origin_destination.py @@ -0,0 +1,33 @@ +# Generated by Django 4.0.4 on 2022-05-03 14:50 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0158_cablepath_populate_path'), + ] + + operations = [ + migrations.AlterUniqueTogether( + name='cablepath', + unique_together=set(), + ), + migrations.RemoveField( + model_name='cablepath', + name='destination_id', + ), + migrations.RemoveField( + model_name='cablepath', + name='destination_type', + ), + migrations.RemoveField( + model_name='cablepath', + name='origin_id', + ), + migrations.RemoveField( + model_name='cablepath', + name='origin_type', + ), + ] diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 5eb48fbf2..efe564e12 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -9,8 +9,8 @@ from django.urls import reverse from dcim.choices import * from dcim.constants import * -from dcim.fields import PathField -from dcim.utils import decompile_path_node, object_to_path_node, path_node_to_object +from dcim.fields import MultiNodePathField, PathField +from dcim.utils import decompile_path_node, flatten_path, object_to_path_node, path_node_to_object from netbox.models import NetBoxModel from utilities.fields import ColorField from utilities.utils import to_meters @@ -276,57 +276,39 @@ class CablePath(models.Model): `is_active` is set to True only if 1) `destination` is not null, and 2) every Cable within the path has a status of "connected". """ - origin_type = models.ForeignKey( - to=ContentType, - on_delete=models.CASCADE, - related_name='+' - ) - origin_id = models.PositiveBigIntegerField() - origin = GenericForeignKey( - ct_field='origin_type', - fk_field='origin_id' - ) - destination_type = models.ForeignKey( - to=ContentType, - on_delete=models.CASCADE, - related_name='+', - blank=True, - null=True - ) - destination_id = models.PositiveBigIntegerField( - blank=True, - null=True - ) - destination = GenericForeignKey( - ct_field='destination_type', - fk_field='destination_id' - ) - path = PathField() + path = MultiNodePathField() is_active = models.BooleanField( default=False ) + is_complete = models.BooleanField( + default=False + ) is_split = models.BooleanField( default=False ) + _nodes = PathField() class Meta: - unique_together = ('origin_type', 'origin_id') + pass def __str__(self): status = ' (active)' if self.is_active else ' (split)' if self.is_split else '' - return f"Path #{self.pk}: {self.origin} to {self.destination} via {len(self.path)} nodes{status}" + return f"Path #{self.pk}: {len(self.path)} nodes{status}" def save(self, *args, **kwargs): super().save(*args, **kwargs) + # Save the flattened nodes list + self._nodes = flatten_path(self.path) + + # TODO # Record a direct reference to this CablePath on its originating object - model = self.origin._meta.model - model.objects.filter(pk=self.origin.pk).update(_path=self.pk) + # model = self.origin._meta.model + # model.objects.filter(pk=self.origin.pk).update(_path=self.pk) @property def segment_count(self): - total_length = 1 + len(self.path) + (1 if self.destination else 0) - return int(total_length / 3) + return int(len(self.path) / 3) @classmethod def from_origin(cls, origin): @@ -421,7 +403,7 @@ class CablePath(models.Model): """ # Compile a list of IDs to prefetch for each type of model in the path to_prefetch = defaultdict(list) - for node in self.path: + for node in self._nodes: ct_id, object_id = decompile_path_node(node) to_prefetch[ct_id].append(object_id) @@ -438,18 +420,30 @@ class CablePath(models.Model): # Replicate the path using the prefetched objects. path = [] - for node in self.path: - ct_id, object_id = decompile_path_node(node) - path.append(prefetched[ct_id][object_id]) + for step in self.path: + nodes = [] + for node in step: + ct_id, object_id = decompile_path_node(node) + nodes.append(prefetched[ct_id][object_id]) + path.append(nodes) return path + def get_destination(self): + if not self.is_complete: + return None + return [ + path_node_to_object(node) for node in self.path[-1] + ] + @property - def last_node(self): + def last_nodes(self): """ Return either the destination or the last node within the path. """ - return self.destination or path_node_to_object(self.path[-1]) + return [ + path_node_to_object(node) for node in self.path[-1] + ] def get_cable_ids(self): """ @@ -458,7 +452,7 @@ class CablePath(models.Model): cable_ct = ContentType.objects.get_for_model(Cable).pk cable_ids = [] - for node in self.path: + for node in self._nodes: ct, id = decompile_path_node(node) if ct == cable_ct: cable_ids.append(id) @@ -481,6 +475,6 @@ class CablePath(models.Model): """ Return all available next segments in a split cable path. """ - rearport = path_node_to_object(self.path[-1]) + rearport = path_node_to_object(self._nodes[-1]) return FrontPort.objects.filter(rear_port=rearport) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index d2e4a3c88..ec82e6606 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -229,7 +229,7 @@ class PathEndpoint(models.Model): Caching accessor for the attached CablePath's destination (if any) """ if not hasattr(self, '_connected_endpoint'): - self._connected_endpoint = self._path.destination if self._path else None + self._connected_endpoint = self._path.get_destination() return self._connected_endpoint diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 5a5cedcd5..5adf83869 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -133,7 +133,7 @@ def nullify_connected_endpoints(instance, **kwargs): cp = CablePath.from_origin(cablepath.origin) if cp: CablePath.objects.filter(pk=cablepath.pk).update( - path=cp.path, + _nodes=cp._nodes, destination_type=ContentType.objects.get_for_model(cp.destination) if cp.destination else None, destination_id=cp.destination.pk if cp.destination else None, is_active=cp.is_active, diff --git a/netbox/dcim/utils.py b/netbox/dcim/utils.py index ec3a44603..28199aa97 100644 --- a/netbox/dcim/utils.py +++ b/netbox/dcim/utils.py @@ -29,6 +29,16 @@ def path_node_to_object(repr): return ct.model_class().objects.get(pk=object_id) +def flatten_path(path): + """ + Flatten a two-dimensional array (list of lists) into a flat list. + """ + ret = [] + for step in path: + ret.extend(step) + return ret + + def create_cablepath(node): """ Create CablePaths for all paths originating from the specified node. diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 3ea7ecc06..5824e8186 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -1711,7 +1711,7 @@ class DeviceLLDPNeighborsView(generic.ObjectView): def get_extra_context(self, request, instance): interfaces = instance.vc_interfaces().restrict(request.user, 'view').prefetch_related( - '_path__destination' + '_path' ).exclude( type__in=NONCONNECTABLE_IFACE_TYPES ) diff --git a/netbox/netbox/views/__init__.py b/netbox/netbox/views/__init__.py index f159ee637..5528faec2 100644 --- a/netbox/netbox/views/__init__.py +++ b/netbox/netbox/views/__init__.py @@ -37,14 +37,13 @@ class HomeView(View): return redirect("login") connected_consoleports = ConsolePort.objects.restrict(request.user, 'view').prefetch_related('_path').filter( - _path__destination_id__isnull=False + _path__is_active=True ) connected_powerports = PowerPort.objects.restrict(request.user, 'view').prefetch_related('_path').filter( - _path__destination_id__isnull=False + _path__is_active=True ) connected_interfaces = Interface.objects.restrict(request.user, 'view').prefetch_related('_path').filter( - _path__destination_id__isnull=False, - pk__lt=F('_path__destination_id') + _path__is_active=True ) def build_stats(): From f0b722b0a508fc959eb403da0e082f2ed67e1e35 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 3 May 2022 16:30:39 -0400 Subject: [PATCH 035/593] Update cable tracing logic --- .../dcim/migrations/0154_cabletermination.py | 2 +- netbox/dcim/models/cables.py | 167 +++++++++++------- netbox/dcim/signals.py | 79 +++++---- 3 files changed, 156 insertions(+), 92 deletions(-) diff --git a/netbox/dcim/migrations/0154_cabletermination.py b/netbox/dcim/migrations/0154_cabletermination.py index 5a3a335fe..b8bbd5101 100644 --- a/netbox/dcim/migrations/0154_cabletermination.py +++ b/netbox/dcim/migrations/0154_cabletermination.py @@ -16,7 +16,7 @@ class Migration(migrations.Migration): ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), ('cable_end', models.CharField(max_length=1)), ('termination_id', models.PositiveBigIntegerField()), - ('cable', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='terminations', to='dcim.cable')), + ('cable', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='+', to='dcim.cable')), ('termination_type', models.ForeignKey(limit_choices_to=models.Q(models.Q(models.Q(('app_label', 'circuits'), ('model__in', ('circuittermination',))), models.Q(('app_label', 'dcim'), ('model__in', ('consoleport', 'consoleserverport', 'frontport', 'interface', 'powerfeed', 'poweroutlet', 'powerport', 'rearport'))), _connector='OR')), on_delete=django.db.models.deletion.PROTECT, related_name='+', to='contenttypes.contenttype')), ], options={ diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index efe564e12..2eb4ba8cf 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -92,10 +92,12 @@ class Cable(NetBoxModel): null=True ) + terminations = [] + class Meta: ordering = ('pk',) - def __init__(self, *args, **kwargs): + def __init__(self, *args, terminations=None, **kwargs): super().__init__(*args, **kwargs) # A copy of the PK to be used by __str__ in case the object is deleted @@ -104,19 +106,29 @@ class Cable(NetBoxModel): # Cache the original status so we can check later if it's been changed self._orig_status = self.status - # @classmethod - # def from_db(cls, db, field_names, values): - # """ - # Cache the original A and B terminations of existing Cable instances for later reference inside clean(). - # """ - # instance = super().from_db(db, field_names, values) - # - # instance._orig_termination_a_type_id = instance.termination_a_type_id - # instance._orig_termination_a_ids = instance.termination_a_ids - # instance._orig_termination_b_type_id = instance.termination_b_type_id - # instance._orig_termination_b_ids = instance.termination_b_ids - # - # return instance + # Assign associated CableTerminations (if any) + if terminations: + assert type(terminations) is list + assert self.pk is None + for t in terminations: + t.cable = self + self.terminations.append(t) + + @classmethod + def from_db(cls, db, field_names, values): + """ + Cache the original A and B terminations of existing Cable instances for later reference inside clean(). + """ + instance = super().from_db(db, field_names, values) + + instance.terminations = CableTermination.objects.filter(cable=instance) + + # instance._orig_termination_a_type_id = instance.termination_a_type_id + # instance._orig_termination_a_ids = instance.termination_a_ids + # instance._orig_termination_b_type_id = instance.termination_b_type_id + # instance._orig_termination_b_ids = instance.termination_b_ids + + return instance def __str__(self): pk = self.pk or self._pk @@ -186,7 +198,7 @@ class CableTermination(models.Model): cable = models.ForeignKey( to='dcim.Cable', on_delete=models.CASCADE, - related_name='terminations' + related_name='+' ) cable_end = models.CharField( max_length=1, @@ -296,59 +308,80 @@ class CablePath(models.Model): return f"Path #{self.pk}: {len(self.path)} nodes{status}" def save(self, *args, **kwargs): - super().save(*args, **kwargs) # Save the flattened nodes list self._nodes = flatten_path(self.path) - # TODO - # Record a direct reference to this CablePath on its originating object - # model = self.origin._meta.model - # model.objects.filter(pk=self.origin.pk).update(_path=self.pk) + super().save(*args, **kwargs) + + # Record a direct reference to this CablePath on its originating object(s) + origins = [path_node_to_object(n) for n in self.path[0]] + origin_model = origins[0]._meta.model + origin_ids = [o.id for o in origins] + origin_model.objects.filter(pk__in=origin_ids).update(_path=self.pk) @property def segment_count(self): return int(len(self.path) / 3) @classmethod - def from_origin(cls, origin): + def from_origin(cls, terminations): """ Create a new CablePath instance as traced from the given path origin. """ from circuits.models import CircuitTermination - if origin is None or origin.link is None: + if not terminations or terminations[0].termination.link is None: return None - destination = None path = [] position_stack = [] is_active = True is_split = False - node = origin + # Start building the path from its originating CableTerminations + path.append([ + object_to_path_node(t.termination) for t in terminations + ]) + + node = terminations[0].termination while node.link is not None: if hasattr(node.link, 'status') and node.link.status != LinkStatusChoices.STATUS_CONNECTED: is_active = False + # Append the cable + path.append([object_to_path_node(node.link)]) + # Follow the link to its far-end termination - path.append(object_to_path_node(node.link)) - peer_termination = node.get_link_peer() + if terminations[0].cable_end == 'A': + peer_terminations = CableTermination.objects.filter(cable=terminations[0].cable, cable_end='B') + else: + peer_terminations = CableTermination.objects.filter(cable=terminations[0].cable, cable_end='A') - # Follow a FrontPort to its corresponding RearPort - if isinstance(peer_termination, FrontPort): - path.append(object_to_path_node(peer_termination)) - node = peer_termination.rear_port + # Follow FrontPorts to their corresponding RearPorts + if isinstance(peer_terminations[0].termination, FrontPort): + path.append([ + object_to_path_node(t.termination) for t in peer_terminations + ]) + terminations = CableTermination.objects.filter( + termination_type=ContentType.objects.get_for_model(RearPort), + termination_id__in=[t.termination_id for t in peer_terminations] + ) + node = terminations[0].termination if node.positions > 1: - position_stack.append(peer_termination.rear_port_position) - path.append(object_to_path_node(node)) + position_stack.append(node.rear_port_position) + path.append([ + object_to_path_node(t.termination) for t in terminations + ]) - # Follow a RearPort to its corresponding FrontPort (if any) - elif isinstance(peer_termination, RearPort): - path.append(object_to_path_node(peer_termination)) + # Follow RearPorts to their corresponding FrontPorts (if any) + elif isinstance(peer_terminations[0], RearPort): + path.append([ + object_to_path_node(t.termination) for t in peer_terminations + ]) # Determine the peer FrontPort's position - if peer_termination.positions == 1: + if peer_terminations[0].termination.positions == 1: position = 1 elif position_stack: position = position_stack.pop() @@ -357,41 +390,55 @@ class CablePath(models.Model): is_split = True break - try: - node = FrontPort.objects.get(rear_port=peer_termination, rear_port_position=position) - path.append(object_to_path_node(node)) - except ObjectDoesNotExist: - # No corresponding FrontPort found for the RearPort - break + # Map FrontPorts to their corresponding RearPorts + terminations = FrontPort.objects.filter( + rear_port_id__in=[t.rear_port_id for t in peer_terminations], + rear_port_position=position + ) + if terminations: + path.append([ + object_to_path_node(t.termination) for t in terminations + ]) # Follow a CircuitTermination to its corresponding CircuitTermination (A to Z or vice versa) - elif isinstance(peer_termination, CircuitTermination): - path.append(object_to_path_node(peer_termination)) - # Get peer CircuitTermination - node = peer_termination.get_peer_termination() - if node: - path.append(object_to_path_node(node)) - if node.provider_network: - destination = node.provider_network - break - elif node.site and not node.cable: - destination = node.site - break + elif isinstance(peer_terminations[0], CircuitTermination): + path.append([ + object_to_path_node(t.termination) for t in peer_terminations + ]) + + # Get peer CircuitTerminations + term_side = 'Z' if peer_terminations[0].termination == 'A' else 'Z' + terminations = CircuitTermination.objects.filter( + circuit=peer_terminations[0].circuit, + term_side=term_side + ) + # Tracing across multiple circuits not currently supported + if len(terminations) > 1: + is_split = True + break + elif terminations: + path.append([ + object_to_path_node(t.termination) for t in terminations + ]) + # TODO + # if node.provider_network: + # destination = node.provider_network + # break + # elif node.site and not node.cable: + # destination = node.site + # break else: # No peer CircuitTermination exists; halt the trace break # Anything else marks the end of the path else: - destination = peer_termination + path.append([ + object_to_path_node(t.termination) for t in peer_terminations + ]) break - if destination is None: - is_active = False - return cls( - origin=origin, - destination=destination, path=path, is_active=is_active, is_split=is_split diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 5adf83869..91870c037 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -79,15 +79,30 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): logger.debug(f"Skipping endpoint updates for imported cable {instance}") return - # TODO: Update link peer fields + # Save any new CableTerminations + CableTermination.objects.bulk_create([ + term for term in instance.terminations if not term.pk + ]) - # # Create/update cable paths - # if created: - # for term in instance.terminations.all(): - # if isinstance(term.termination, PathEndpoint): - # create_cablepath(term.termination) - # else: - # rebuild_paths(term.termination) + # TODO: Update link peers + # Set cable on terminating endpoints + _terms = { + 'A': [], + 'B': [], + } + for term in instance.terminations: + if term.termination.cable != instance: + term.termination.cable = instance + term.termination.save() + _terms[term.cable_end].append(term) + + # Create/update cable paths + if created: + for terms in _terms.values(): + if isinstance(terms[0].termination, PathEndpoint): + create_cablepath(terms) + else: + rebuild_paths(terms) # elif instance.status != instance._orig_status: # # We currently don't support modifying either termination of an existing Cable. (This # # may change in the future.) However, we do need to capture status changes and update @@ -98,17 +113,17 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): # rebuild_paths(instance) -@receiver(post_save, sender=CableTermination) -def cache_cable_on_endpoints(instance, created, raw=False, **kwargs): - if not raw: - model = instance.termination_type.model_class() - model.objects.filter(pk=instance.termination_id).update(cable=instance.cable) - - -@receiver(post_delete, sender=CableTermination) -def clear_cable_on_endpoints(instance, **kwargs): - model = instance.termination_type.model_class() - model.objects.filter(pk=instance.termination_id).update(cable=None) +# @receiver(post_save, sender=CableTermination) +# def cache_cable_on_endpoints(instance, created, raw=False, **kwargs): +# if not raw: +# model = instance.termination_type.model_class() +# model.objects.filter(pk=instance.termination_id).update(cable=instance.cable) +# +# +# @receiver(post_delete, sender=CableTermination) +# def clear_cable_on_endpoints(instance, **kwargs): +# model = instance.termination_type.model_class() +# model.objects.filter(pk=instance.termination_id).update(cable=None) @receiver(post_delete, sender=Cable) @@ -129,15 +144,17 @@ def nullify_connected_endpoints(instance, **kwargs): # model.objects.filter(pk__in=instance.termination_b_ids).update(_link_peer_type=None, _link_peer_id=None) # Delete and retrace any dependent cable paths - for cablepath in CablePath.objects.filter(path__contains=instance): - cp = CablePath.from_origin(cablepath.origin) - if cp: - CablePath.objects.filter(pk=cablepath.pk).update( - _nodes=cp._nodes, - destination_type=ContentType.objects.get_for_model(cp.destination) if cp.destination else None, - destination_id=cp.destination.pk if cp.destination else None, - is_active=cp.is_active, - is_split=cp.is_split - ) - else: - cablepath.delete() + for cablepath in CablePath.objects.filter(_nodes__contains=instance): + cablepath.delete() + # TODO: Create new traces + # cp = CablePath.from_origin(cablepath.origin) + # if cp: + # CablePath.objects.filter(pk=cablepath.pk).update( + # _nodes=cp._nodes, + # destination_type=ContentType.objects.get_for_model(cp.destination) if cp.destination else None, + # destination_id=cp.destination.pk if cp.destination else None, + # is_active=cp.is_active, + # is_split=cp.is_split + # ) + # else: + # cablepath.delete() From e129ae50f04827b618844c0c535d380e927036d6 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 3 May 2022 16:54:09 -0400 Subject: [PATCH 036/593] Start updating tests --- netbox/dcim/tests/test_cablepaths.py | 142 +++++++++++++++++---------- 1 file changed, 92 insertions(+), 50 deletions(-) diff --git a/netbox/dcim/tests/test_cablepaths.py b/netbox/dcim/tests/test_cablepaths.py index 6849df012..e36de5784 100644 --- a/netbox/dcim/tests/test_cablepaths.py +++ b/netbox/dcim/tests/test_cablepaths.py @@ -1,4 +1,3 @@ -from django.contrib.contenttypes.models import ContentType from django.test import TestCase from circuits.models import * @@ -33,40 +32,30 @@ class CablePathTestCase(TestCase): circuit_type = CircuitType.objects.create(name='Circuit Type', slug='circuit-type') cls.circuit = Circuit.objects.create(provider=provider, type=circuit_type, cid='Circuit 1') - def assertPathExists(self, origin, destination, path=None, is_active=None, msg=None): + def assertPathExists(self, nodes, is_active=None): """ Assert that a CablePath from origin to destination with a specific intermediate path exists. - :param origin: Originating endpoint - :param destination: Terminating endpoint, or None - :param path: Sequence of objects comprising the intermediate path (optional) + :param nodes: Iterable of steps, with each step being either a single node or a list of nodes :param is_active: Boolean indicating whether the end-to-end path is complete and active (optional) - :param msg: Custom failure message (optional) :return: The matching CablePath (if any) """ + path = [] + for step in nodes: + if type(step) is list: + path.append([object_to_path_node(node) for node in step]) + else: + path.append([object_to_path_node(step)]) + kwargs = { - 'origin_type': ContentType.objects.get_for_model(origin), - 'origin_id': origin.pk, + 'path': path } - if destination is not None: - kwargs['destination_type'] = ContentType.objects.get_for_model(destination) - kwargs['destination_id'] = destination.pk - else: - kwargs['destination_type__isnull'] = True - kwargs['destination_id__isnull'] = True - if path is not None: - kwargs['path'] = [object_to_path_node(obj) for obj in path] if is_active is not None: kwargs['is_active'] = is_active - if msg is None: - if destination is not None: - msg = f"Missing path from {origin} to {destination}" - else: - msg = f"Missing partial path originating from {origin}" cablepath = CablePath.objects.filter(**kwargs).first() - self.assertIsNotNone(cablepath, msg=msg) + self.assertIsNotNone(cablepath, msg='CablePath not found') return cablepath @@ -101,18 +90,20 @@ class CablePathTestCase(TestCase): interface2 = Interface.objects.create(device=self.device, name='Interface 2') # Create cable 1 - cable1 = Cable(termination_a=interface1, termination_b=interface2) + cable1 = Cable( + terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=interface2), + ] + ) cable1.save() + path1 = self.assertPathExists( - origin=interface1, - destination=interface2, - path=(cable1,), + (interface1, cable1, interface2), is_active=True ) path2 = self.assertPathExists( - origin=interface2, - destination=interface1, - path=(cable1,), + (interface2, cable1, interface1), is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -135,18 +126,20 @@ class CablePathTestCase(TestCase): consoleserverport1 = ConsoleServerPort.objects.create(device=self.device, name='Console Server Port 1') # Create cable 1 - cable1 = Cable(termination_a=consoleport1, termination_b=consoleserverport1) + cable1 = Cable( + terminations=[ + CableTermination(cable_end='A', termination=consoleport1), + CableTermination(cable_end='B', termination=consoleserverport1), + ] + ) cable1.save() + path1 = self.assertPathExists( - origin=consoleport1, - destination=consoleserverport1, - path=(cable1,), + (consoleport1, cable1, consoleserverport1), is_active=True ) path2 = self.assertPathExists( - origin=consoleserverport1, - destination=consoleport1, - path=(cable1,), + (consoleserverport1, cable1, consoleport1), is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -169,18 +162,20 @@ class CablePathTestCase(TestCase): poweroutlet1 = PowerOutlet.objects.create(device=self.device, name='Power Outlet 1') # Create cable 1 - cable1 = Cable(termination_a=powerport1, termination_b=poweroutlet1) + cable1 = Cable( + terminations=[ + CableTermination(cable_end='A', termination=powerport1), + CableTermination(cable_end='B', termination=poweroutlet1), + ] + ) cable1.save() + path1 = self.assertPathExists( - origin=powerport1, - destination=poweroutlet1, - path=(cable1,), + (powerport1, cable1, poweroutlet1), is_active=True ) path2 = self.assertPathExists( - origin=poweroutlet1, - destination=powerport1, - path=(cable1,), + (poweroutlet1, cable1, powerport1), is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -203,18 +198,20 @@ class CablePathTestCase(TestCase): powerfeed1 = PowerFeed.objects.create(power_panel=self.powerpanel, name='Power Feed 1') # Create cable 1 - cable1 = Cable(termination_a=powerport1, termination_b=powerfeed1) + cable1 = Cable( + terminations=[ + CableTermination(cable_end='A', termination=powerport1), + CableTermination(cable_end='B', termination=powerfeed1), + ] + ) cable1.save() + path1 = self.assertPathExists( - origin=powerport1, - destination=powerfeed1, - path=(cable1,), + (powerport1, cable1, powerfeed1), is_active=True ) path2 = self.assertPathExists( - origin=powerfeed1, - destination=powerport1, - path=(cable1,), + (powerfeed1, cable1, powerport1), is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -229,6 +226,51 @@ class CablePathTestCase(TestCase): # Check that all CablePaths have been deleted self.assertEqual(CablePath.objects.count(), 0) + def test_120_multi_term_to_multi_term(self): + """ + [IF1] --C1-- [IF3] + [IF2] [IF4] + """ + interface1 = Interface.objects.create(device=self.device, name='Interface 1') + interface2 = Interface.objects.create(device=self.device, name='Interface 2') + interface3 = Interface.objects.create(device=self.device, name='Interface 3') + interface4 = Interface.objects.create(device=self.device, name='Interface 4') + + # Create cable 1 + cable1 = Cable( + terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='A', termination=interface2), + CableTermination(cable_end='B', termination=interface3), + CableTermination(cable_end='B', termination=interface4), + ] + ) + cable1.save() + + path1 = self.assertPathExists( + ((interface1, interface2), cable1, (interface3, interface4)), + is_active=True + ) + path2 = self.assertPathExists( + ((interface3, interface4), cable1, (interface1, interface2)), + is_active=True + ) + self.assertEqual(CablePath.objects.count(), 2) + interface1.refresh_from_db() + interface2.refresh_from_db() + interface3.refresh_from_db() + interface4.refresh_from_db() + self.assertPathIsSet(interface1, path1) + self.assertPathIsSet(interface2, path1) + self.assertPathIsSet(interface3, path2) + self.assertPathIsSet(interface4, path2) + + # Delete cable 1 + cable1.delete() + + # Check that all CablePaths have been deleted + self.assertEqual(CablePath.objects.count(), 0) + def test_201_single_path_via_pass_through(self): """ [IF1] --C1-- [FP1] [RP1] --C2-- [IF2] From 83fdab5feb30bf91e977ec193e52e7f995d99145 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 5 May 2022 14:29:28 -0400 Subject: [PATCH 037/593] Change CablePath.path to JSONField --- netbox/dcim/fields.py | 13 ------------- netbox/dcim/migrations/0157_cablepath.py | 3 +-- netbox/dcim/models/cables.py | 8 +++++--- 3 files changed, 6 insertions(+), 18 deletions(-) diff --git a/netbox/dcim/fields.py b/netbox/dcim/fields.py index 5ec88f89a..d3afe5c08 100644 --- a/netbox/dcim/fields.py +++ b/netbox/dcim/fields.py @@ -10,7 +10,6 @@ from .lookups import PathContains __all__ = ( 'ASNField', 'MACAddressField', - 'MultiNodePathField', 'PathField', 'WWNField', ) @@ -105,16 +104,4 @@ class PathField(ArrayField): super().__init__(**kwargs) -class MultiNodePathField(ArrayField): - """ - A two-dimensional ArrayField which represents a path, with one or more nodes at each hop. Each node is - identified by a (type, ID) tuple. - """ - def __init__(self, **kwargs): - kwargs['base_field'] = ArrayField( - base_field=models.CharField(max_length=40) - ) - super().__init__(**kwargs) - - PathField.register_lookup(PathContains) diff --git a/netbox/dcim/migrations/0157_cablepath.py b/netbox/dcim/migrations/0157_cablepath.py index 0ff773cba..a40f6a10e 100644 --- a/netbox/dcim/migrations/0157_cablepath.py +++ b/netbox/dcim/migrations/0157_cablepath.py @@ -18,8 +18,7 @@ class Migration(migrations.Migration): migrations.AddField( model_name='cablepath', name='path', - field=dcim.fields.MultiNodePathField(base_field=django.contrib.postgres.fields.ArrayField(base_field=models.CharField(max_length=40), size=None), default=[], size=None), - preserve_default=False, + field=models.JSONField(default=list), ), migrations.AddField( model_name='cablepath', diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 2eb4ba8cf..f72c37702 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -2,14 +2,14 @@ from collections import defaultdict from django.contrib.contenttypes.fields import GenericForeignKey from django.contrib.contenttypes.models import ContentType -from django.core.exceptions import ObjectDoesNotExist, ValidationError +from django.core.exceptions import ValidationError from django.db import models from django.db.models import Sum from django.urls import reverse from dcim.choices import * from dcim.constants import * -from dcim.fields import MultiNodePathField, PathField +from dcim.fields import PathField from dcim.utils import decompile_path_node, flatten_path, object_to_path_node, path_node_to_object from netbox.models import NetBoxModel from utilities.fields import ColorField @@ -288,7 +288,9 @@ class CablePath(models.Model): `is_active` is set to True only if 1) `destination` is not null, and 2) every Cable within the path has a status of "connected". """ - path = MultiNodePathField() + path = models.JSONField( + default=list + ) is_active = models.BooleanField( default=False ) From ecee7421ea416e39cf7bc3a471ada7d0f644d519 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 5 May 2022 15:19:10 -0400 Subject: [PATCH 038/593] Fix terminations assignment --- netbox/dcim/models/cables.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index f72c37702..96ff6779d 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -92,8 +92,6 @@ class Cable(NetBoxModel): null=True ) - terminations = [] - class Meta: ordering = ('pk',) @@ -112,7 +110,9 @@ class Cable(NetBoxModel): assert self.pk is None for t in terminations: t.cable = self - self.terminations.append(t) + self.terminations = terminations + else: + self.terminations = [] @classmethod def from_db(cls, db, field_names, values): From 93daa6406b71cc665e1150679642c40ce6252c60 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 5 May 2022 16:41:30 -0400 Subject: [PATCH 039/593] Fix cable path tracing --- netbox/dcim/models/cables.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 96ff6779d..6078aa9af 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -338,6 +338,7 @@ class CablePath(models.Model): path = [] position_stack = [] + is_complete = False is_active = True is_split = False @@ -369,11 +370,12 @@ class CablePath(models.Model): termination_type=ContentType.objects.get_for_model(RearPort), termination_id__in=[t.termination_id for t in peer_terminations] ) - node = terminations[0].termination + rear_ports = RearPort.objects.filter(pk__in=[t.termination.rear_port_id for t in peer_terminations]) + node = rear_ports[0] if node.positions > 1: position_stack.append(node.rear_port_position) path.append([ - object_to_path_node(t.termination) for t in terminations + object_to_path_node(rp) for rp in rear_ports ]) # Follow RearPorts to their corresponding FrontPorts (if any) @@ -438,10 +440,12 @@ class CablePath(models.Model): path.append([ object_to_path_node(t.termination) for t in peer_terminations ]) + is_complete = True break return cls( path=path, + is_complete=is_complete, is_active=is_active, is_split=is_split ) From 304282bd4f20aa80b4826b47777b87972ac11832 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 5 May 2022 16:47:57 -0400 Subject: [PATCH 040/593] Update tests --- netbox/dcim/tests/test_cablepaths.py | 644 +++++++++++++++------------ 1 file changed, 359 insertions(+), 285 deletions(-) diff --git a/netbox/dcim/tests/test_cablepaths.py b/netbox/dcim/tests/test_cablepaths.py index e36de5784..ec55c5b6d 100644 --- a/netbox/dcim/tests/test_cablepaths.py +++ b/netbox/dcim/tests/test_cablepaths.py @@ -32,7 +32,7 @@ class CablePathTestCase(TestCase): circuit_type = CircuitType.objects.create(name='Circuit Type', slug='circuit-type') cls.circuit = Circuit.objects.create(provider=provider, type=circuit_type, cid='Circuit 1') - def assertPathExists(self, nodes, is_active=None): + def assertPathExists(self, nodes, **kwargs): """ Assert that a CablePath from origin to destination with a specific intermediate path exists. @@ -43,18 +43,12 @@ class CablePathTestCase(TestCase): """ path = [] for step in nodes: - if type(step) is list: + if type(step) in (list, tuple): path.append([object_to_path_node(node) for node in step]) else: path.append([object_to_path_node(step)]) - kwargs = { - 'path': path - } - if is_active is not None: - kwargs['is_active'] = is_active - - cablepath = CablePath.objects.filter(**kwargs).first() + cablepath = CablePath.objects.filter(path=path, **kwargs).first() self.assertIsNotNone(cablepath, msg='CablePath not found') return cablepath @@ -100,10 +94,12 @@ class CablePathTestCase(TestCase): path1 = self.assertPathExists( (interface1, cable1, interface2), + is_complete=True, is_active=True ) path2 = self.assertPathExists( (interface2, cable1, interface1), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -136,10 +132,12 @@ class CablePathTestCase(TestCase): path1 = self.assertPathExists( (consoleport1, cable1, consoleserverport1), + is_complete=True, is_active=True ) path2 = self.assertPathExists( (consoleserverport1, cable1, consoleport1), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -172,10 +170,12 @@ class CablePathTestCase(TestCase): path1 = self.assertPathExists( (powerport1, cable1, poweroutlet1), + is_complete=True, is_active=True ) path2 = self.assertPathExists( (poweroutlet1, cable1, powerport1), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -208,10 +208,12 @@ class CablePathTestCase(TestCase): path1 = self.assertPathExists( (powerport1, cable1, powerfeed1), + is_complete=True, is_active=True ) path2 = self.assertPathExists( (powerfeed1, cable1, powerport1), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -249,10 +251,12 @@ class CablePathTestCase(TestCase): path1 = self.assertPathExists( ((interface1, interface2), cable1, (interface3, interface4)), + is_complete=True, is_active=True ) path2 = self.assertPathExists( ((interface3, interface4), cable1, (interface1, interface2)), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -283,29 +287,31 @@ class CablePathTestCase(TestCase): ) # Create cable 1 - cable1 = Cable(termination_a=interface1, termination_b=frontport1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1), + ]) cable1.save() self.assertPathExists( - origin=interface1, - destination=None, - path=(cable1, frontport1, rearport1), - is_active=False + (interface1, cable1, frontport1, rearport1), + is_complete=False ) self.assertEqual(CablePath.objects.count(), 1) # Create cable 2 - cable2 = Cable(termination_a=rearport1, termination_b=interface2) + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='B', termination=interface2), + ]) cable2.save() self.assertPathExists( - origin=interface1, - destination=interface2, - path=(cable1, frontport1, rearport1, cable2), + (interface1, cable1, frontport1, rearport1, cable2, interface2), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface2, - destination=interface1, - path=(cable2, rearport1, frontport1, cable1), + (interface2, cable2, rearport1, frontport1, cable1, interface1), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -313,10 +319,8 @@ class CablePathTestCase(TestCase): # Delete cable 2 cable2.delete() path1 = self.assertPathExists( - origin=interface1, - destination=None, - path=(cable1, frontport1, rearport1), - is_active=False + (interface1, cable1, frontport1, rearport1), + is_complete=False ) self.assertEqual(CablePath.objects.count(), 1) interface1.refresh_from_db() @@ -349,80 +353,72 @@ class CablePathTestCase(TestCase): ) # Create cables 1-2 - cable1 = Cable(termination_a=interface1, termination_b=frontport1_1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1_1), + ]) cable1.save() - cable2 = Cable(termination_a=interface2, termination_b=frontport1_2) + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface2), + CableTermination(cable_end='B', termination=frontport1_2), + ]) cable2.save() self.assertPathExists( - origin=interface1, - destination=None, - path=(cable1, frontport1_1, rearport1), - is_active=False + (interface1, cable1, frontport1_1, rearport1), + is_complete=False ) self.assertPathExists( - origin=interface2, - destination=None, - path=(cable2, frontport1_2, rearport1), - is_active=False + (interface2, cable2, frontport1_2, rearport1), + is_complete=False ) self.assertEqual(CablePath.objects.count(), 2) # Create cable 3 - cable3 = Cable(termination_a=rearport1, termination_b=rearport2) + cable3 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='B', termination=rearport2), + ]) cable3.save() self.assertPathExists( - origin=interface1, - destination=None, - path=(cable1, frontport1_1, rearport1, cable3, rearport2, frontport2_1), - is_active=False + (interface1, cable1, frontport1_1, rearport1, cable3, rearport2, frontport2_1), + is_complete=False ) self.assertPathExists( - origin=interface2, - destination=None, - path=(cable2, frontport1_2, rearport1, cable3, rearport2, frontport2_2), - is_active=False + (interface2, cable2, frontport1_2, rearport1, cable3, rearport2, frontport2_2), + is_active=False, + is_complete=False ) self.assertEqual(CablePath.objects.count(), 2) # Create cables 4-5 - cable4 = Cable(termination_a=frontport2_1, termination_b=interface3) + cable4 = Cable(terminations=[ + CableTermination(cable_end='A', termination=frontport2_1), + CableTermination(cable_end='B', termination=interface3), + ]) cable4.save() - cable5 = Cable(termination_a=frontport2_2, termination_b=interface4) + cable5 = Cable(terminations=[ + CableTermination(cable_end='A', termination=frontport2_2), + CableTermination(cable_end='B', termination=interface4), + ]) cable5.save() path1 = self.assertPathExists( - origin=interface1, - destination=interface3, - path=( - cable1, frontport1_1, rearport1, cable3, rearport2, frontport2_1, - cable4, - ), + (interface1, cable1, frontport1_1, rearport1, cable3, rearport2, frontport2_1, cable4, interface3), + is_complete=True, is_active=True ) path2 = self.assertPathExists( - origin=interface2, - destination=interface4, - path=( - cable2, frontport1_2, rearport1, cable3, rearport2, frontport2_2, - cable5, - ), + (interface2, cable2, frontport1_2, rearport1, cable3, rearport2, frontport2_2, cable5, interface4), + is_complete=True, is_active=True ) path3 = self.assertPathExists( - origin=interface3, - destination=interface1, - path=( - cable4, frontport2_1, rearport2, cable3, rearport1, frontport1_1, - cable1 - ), + (interface3, cable4, frontport2_1, rearport2, cable3, rearport1, frontport1_1, cable1, interface1), + is_complete=True, is_active=True ) path4 = self.assertPathExists( - origin=interface4, - destination=interface2, - path=( - cable5, frontport2_2, rearport2, cable3, rearport1, frontport1_2, - cable2 - ), + (interface4, cable5, frontport2_2, rearport2, cable3, rearport1, frontport1_2, cable2, interface2), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 4) @@ -475,64 +471,77 @@ class CablePathTestCase(TestCase): ) # Create cables 1-2, 6-7 - cable1 = Cable(termination_a=interface1, termination_b=frontport1_1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1_1), + ]) cable1.save() - cable2 = Cable(termination_a=interface2, termination_b=frontport1_2) + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface2), + CableTermination(cable_end='B', termination=frontport1_2), + ]) cable2.save() - cable6 = Cable(termination_a=interface3, termination_b=frontport4_1) + cable6 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface3), + CableTermination(cable_end='B', termination=frontport4_1), + ]) cable6.save() - cable7 = Cable(termination_a=interface4, termination_b=frontport4_2) + cable7 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface4), + CableTermination(cable_end='B', termination=frontport4_2), + ]) cable7.save() self.assertEqual(CablePath.objects.count(), 4) # Four partial paths; one from each interface # Create cables 3 and 5 - cable3 = Cable(termination_a=rearport1, termination_b=frontport2) + cable3 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='B', termination=frontport2), + ]) cable3.save() - cable5 = Cable(termination_a=rearport4, termination_b=frontport3) + cable5 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport4), + CableTermination(cable_end='B', termination=frontport3), + ]) cable5.save() self.assertEqual(CablePath.objects.count(), 4) # Four (longer) partial paths; one from each interface # Create cable 4 - cable4 = Cable(termination_a=rearport2, termination_b=rearport3) + cable4 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport2), + CableTermination(cable_end='B', termination=rearport3), + ]) cable4.save() self.assertPathExists( - origin=interface1, - destination=interface3, - path=( - cable1, frontport1_1, rearport1, cable3, frontport2, rearport2, - cable4, rearport3, frontport3, cable5, rearport4, frontport4_1, - cable6 + ( + interface1, cable1, frontport1_1, rearport1, cable3, frontport2, rearport2, cable4, rearport3, + frontport3, cable5, rearport4, frontport4_1, cable6, interface3, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface2, - destination=interface4, - path=( - cable2, frontport1_2, rearport1, cable3, frontport2, rearport2, - cable4, rearport3, frontport3, cable5, rearport4, frontport4_2, - cable7 + ( + interface2, cable2, frontport1_2, rearport1, cable3, frontport2, rearport2, cable4, rearport3, + frontport3, cable5, rearport4, frontport4_2, cable7, interface4, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface3, - destination=interface1, - path=( - cable6, frontport4_1, rearport4, cable5, frontport3, rearport3, - cable4, rearport2, frontport2, cable3, rearport1, frontport1_1, - cable1 + ( + interface3, cable6, frontport4_1, rearport4, cable5, frontport3, rearport3, cable4, rearport2, + frontport2, cable3, rearport1, frontport1_1, cable1, interface1, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface4, - destination=interface2, - path=( - cable7, frontport4_2, rearport4, cable5, frontport3, rearport3, - cable4, rearport2, frontport2, cable3, rearport1, frontport1_2, - cable2 + ( + interface4, cable7, frontport4_2, rearport4, cable5, frontport3, rearport3, cable4, rearport2, + frontport2, cable3, rearport1, frontport1_2, cable2, interface2, ), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 4) @@ -583,63 +592,83 @@ class CablePathTestCase(TestCase): ) # Create cables 1-3, 6-8 - cable1 = Cable(termination_a=interface1, termination_b=frontport1_1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1_1), + ]) cable1.save() - cable2 = Cable(termination_a=interface2, termination_b=frontport1_2) + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface2), + CableTermination(cable_end='B', termination=frontport1_2), + ]) cable2.save() - cable3 = Cable(termination_a=rearport1, termination_b=rearport2) + cable3 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='B', termination=rearport2), + ]) cable3.save() - cable6 = Cable(termination_a=rearport3, termination_b=rearport4) + cable6 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport3), + CableTermination(cable_end='B', termination=rearport4), + ]) cable6.save() - cable7 = Cable(termination_a=interface3, termination_b=frontport4_1) + cable7 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface3), + CableTermination(cable_end='B', termination=frontport4_1), + ]) cable7.save() - cable8 = Cable(termination_a=interface4, termination_b=frontport4_2) + cable8 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface4), + CableTermination(cable_end='B', termination=frontport4_2), + ]) cable8.save() self.assertEqual(CablePath.objects.count(), 4) # Four partial paths; one from each interface # Create cables 4 and 5 - cable4 = Cable(termination_a=frontport2_1, termination_b=frontport3_1) + cable4 = Cable(terminations=[ + CableTermination(cable_end='A', termination=frontport2_1), + CableTermination(cable_end='B', termination=frontport3_1), + ]) cable4.save() - cable5 = Cable(termination_a=frontport2_2, termination_b=frontport3_2) + cable5 = Cable(terminations=[ + CableTermination(cable_end='A', termination=frontport2_2), + CableTermination(cable_end='B', termination=frontport3_2), + ]) cable5.save() self.assertPathExists( - origin=interface1, - destination=interface3, - path=( - cable1, frontport1_1, rearport1, cable3, rearport2, frontport2_1, + ( + interface1, cable1, frontport1_1, rearport1, cable3, rearport2, frontport2_1, cable4, frontport3_1, rearport3, cable6, rearport4, frontport4_1, - cable7 + cable7, interface3, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface2, - destination=interface4, - path=( - cable2, frontport1_2, rearport1, cable3, rearport2, frontport2_2, + ( + interface2, cable2, frontport1_2, rearport1, cable3, rearport2, frontport2_2, cable5, frontport3_2, rearport3, cable6, rearport4, frontport4_2, - cable8 + cable8, interface4, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface3, - destination=interface1, - path=( - cable7, frontport4_1, rearport4, cable6, rearport3, frontport3_1, + ( + interface3, cable7, frontport4_1, rearport4, cable6, rearport3, frontport3_1, cable4, frontport2_1, rearport2, cable3, rearport1, frontport1_1, - cable1 + cable1, interface1, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface4, - destination=interface2, - path=( - cable8, frontport4_2, rearport4, cable6, rearport3, frontport3_2, + ( + interface4, cable8, frontport4_2, rearport4, cable6, rearport3, frontport3_2, cable5, frontport2_2, rearport2, cable3, rearport1, frontport1_2, - cable2 + cable2, interface2, ), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 4) @@ -680,55 +709,69 @@ class CablePathTestCase(TestCase): ) # Create cables 1-2, 5-6 - cable1 = Cable(termination_a=interface1, termination_b=frontport1_1) # IF1 -> FP1:1 + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1_1), + ]) cable1.save() - cable2 = Cable(termination_a=interface2, termination_b=frontport1_2) # IF2 -> FP1:2 + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface2), + CableTermination(cable_end='B', termination=frontport1_2), + ]) cable2.save() - cable5 = Cable(termination_a=interface3, termination_b=frontport3_1) # IF3 -> FP3:1 + cable5 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface3), + CableTermination(cable_end='B', termination=frontport3_1), + ]) cable5.save() - cable6 = Cable(termination_a=interface4, termination_b=frontport3_2) # IF4 -> FP3:2 + cable6 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface4), + CableTermination(cable_end='B', termination=frontport3_2), + ]) cable6.save() self.assertEqual(CablePath.objects.count(), 4) # Four partial paths; one from each interface # Create cables 3-4 - cable3 = Cable(termination_a=rearport1, termination_b=frontport2) # RP1 -> FP2 + cable3 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='B', termination=frontport2), + ]) cable3.save() - cable4 = Cable(termination_a=rearport2, termination_b=rearport3) # RP2 -> RP3 + cable4 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport2), + CableTermination(cable_end='B', termination=rearport3), + ]) cable4.save() self.assertPathExists( - origin=interface1, - destination=interface3, - path=( - cable1, frontport1_1, rearport1, cable3, frontport2, rearport2, - cable4, rearport3, frontport3_1, cable5 + ( + interface1, cable1, frontport1_1, rearport1, cable3, frontport2, rearport2, + cable4, rearport3, frontport3_1, cable5, interface3, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface2, - destination=interface4, - path=( - cable2, frontport1_2, rearport1, cable3, frontport2, rearport2, - cable4, rearport3, frontport3_2, cable6 + ( + interface2, cable2, frontport1_2, rearport1, cable3, frontport2, rearport2, + cable4, rearport3, frontport3_2, cable6, interface4, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface3, - destination=interface1, - path=( - cable5, frontport3_1, rearport3, cable4, rearport2, frontport2, - cable3, rearport1, frontport1_1, cable1 + ( + interface3, cable5, frontport3_1, rearport3, cable4, rearport2, frontport2, + cable3, rearport1, frontport1_1, cable1, interface1, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface4, - destination=interface2, - path=( - cable6, frontport3_2, rearport3, cable4, rearport2, frontport2, - cable3, rearport1, frontport1_2, cable2 + ( + interface4, cable6, frontport3_2, rearport3, cable4, rearport2, frontport2, + cable3, rearport1, frontport1_2, cable2, interface2, ), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 4) @@ -757,31 +800,37 @@ class CablePathTestCase(TestCase): ) # Create cables 1 - cable1 = Cable(termination_a=interface1, termination_b=rearport1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=rearport1), + ]) cable1.save() self.assertPathExists( - origin=interface1, - destination=None, - path=(cable1, rearport1), - is_active=False + (interface1, cable1, rearport1), + is_complete=False, + is_split=True ) self.assertEqual(CablePath.objects.count(), 1) # Create cables 2-3 - cable2 = Cable(termination_a=interface2, termination_b=frontport1_1) + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface2), + CableTermination(cable_end='B', termination=frontport1_1), + ]) cable2.save() - cable3 = Cable(termination_a=interface3, termination_b=frontport1_2) + cable3 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface3), + CableTermination(cable_end='B', termination=frontport1_2), + ]) cable3.save() self.assertPathExists( - origin=interface2, - destination=interface1, - path=(cable2, frontport1_1, rearport1, cable1), + (interface2, cable2, frontport1_1, rearport1, cable1, interface1), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface3, - destination=interface1, - path=(cable3, frontport1_2, rearport1, cable1), + (interface3, cable3, frontport1_2, rearport1, cable1, interface1), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 3) @@ -791,16 +840,12 @@ class CablePathTestCase(TestCase): # Check that the partial path was deleted and the two complete paths are now partial self.assertPathExists( - origin=interface2, - destination=None, - path=(cable2, frontport1_1, rearport1), - is_active=False + (interface2, cable2, frontport1_1, rearport1), + is_complete=False ) self.assertPathExists( - origin=interface3, - destination=None, - path=(cable3, frontport1_2, rearport1), - is_active=False + (interface3, cable3, frontport1_2, rearport1), + is_complete=False ) self.assertEqual(CablePath.objects.count(), 2) @@ -816,15 +861,19 @@ class CablePathTestCase(TestCase): ) # Create cables - cable1 = Cable(termination_a=interface1, termination_b=frontport1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1), + ]) cable1.save() - cable2 = Cable(termination_a=rearport1, termination_b=rearport2) + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='B', termination=rearport2), + ]) cable2.save() self.assertPathExists( - origin=interface1, - destination=None, - path=(cable1, frontport1, rearport1, cable2, rearport2), - is_active=False + (interface1, cable1, frontport1, rearport1, cable2, rearport2), + is_complete=False ) self.assertEqual(CablePath.objects.count(), 1) @@ -836,15 +885,16 @@ class CablePathTestCase(TestCase): circuittermination1 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='A') # Create cable 1 - cable1 = Cable(termination_a=interface1, termination_b=circuittermination1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=circuittermination1), + ]) cable1.save() # Check for incomplete path self.assertPathExists( - origin=interface1, - destination=None, - path=(cable1, circuittermination1), - is_active=False + (interface1, cable1, circuittermination1), + is_complete=False ) self.assertEqual(CablePath.objects.count(), 1) @@ -863,15 +913,16 @@ class CablePathTestCase(TestCase): circuittermination1 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='A') # Create cable 1 - cable1 = Cable(termination_a=interface1, termination_b=circuittermination1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=circuittermination1), + ]) cable1.save() # Check for partial path from interface1 self.assertPathExists( - origin=interface1, - destination=None, - path=(cable1, circuittermination1), - is_active=False + (interface1, cable1, circuittermination1), + is_complete=False ) # Create CT2 @@ -879,27 +930,26 @@ class CablePathTestCase(TestCase): # Check for partial path to site self.assertPathExists( - origin=interface1, - destination=self.site, - path=(cable1, circuittermination1, circuittermination2), + (interface1, cable1, circuittermination1, circuittermination2, self.site), is_active=True ) # Create cable 2 - cable2 = Cable(termination_a=circuittermination2, termination_b=interface2) + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=circuittermination2), + CableTermination(cable_end='B', termination=interface2), + ]) cable2.save() # Check for complete path in each direction self.assertPathExists( - origin=interface1, - destination=interface2, - path=(cable1, circuittermination1, circuittermination2, cable2), + (interface1, cable1, circuittermination1, circuittermination2, cable2, interface2), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface2, - destination=interface1, - path=(cable2, circuittermination2, circuittermination1, cable1), + (interface2, cable2, circuittermination2, circuittermination1, cable1, interface1), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -907,9 +957,7 @@ class CablePathTestCase(TestCase): # Delete cable 2 cable2.delete() path1 = self.assertPathExists( - origin=interface1, - destination=self.site, - path=(cable1, circuittermination1, circuittermination2), + (interface1, cable1, circuittermination1, circuittermination2, self.site), is_active=True ) self.assertEqual(CablePath.objects.count(), 1) @@ -928,12 +976,13 @@ class CablePathTestCase(TestCase): circuittermination2 = CircuitTermination.objects.create(circuit=self.circuit, site=site2, term_side='Z') # Create cable 1 - cable1 = Cable(termination_a=interface1, termination_b=circuittermination1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=circuittermination1), + ]) cable1.save() self.assertPathExists( - origin=interface1, - destination=site2, - path=(cable1, circuittermination1, circuittermination2), + (interface1, cable1, circuittermination1, circuittermination2, site2), is_active=True ) self.assertEqual(CablePath.objects.count(), 1) @@ -954,12 +1003,13 @@ class CablePathTestCase(TestCase): circuittermination2 = CircuitTermination.objects.create(circuit=self.circuit, provider_network=providernetwork, term_side='Z') # Create cable 1 - cable1 = Cable(termination_a=interface1, termination_b=circuittermination1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=circuittermination1), + ]) cable1.save() self.assertPathExists( - origin=interface1, - destination=providernetwork, - path=(cable1, circuittermination1, circuittermination2), + (interface1, cable1, circuittermination1, circuittermination2, providernetwork), is_active=True ) self.assertEqual(CablePath.objects.count(), 1) @@ -997,52 +1047,66 @@ class CablePathTestCase(TestCase): circuittermination2 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='Z') # Create cables - cable1 = Cable(termination_a=interface1, termination_b=frontport1_1) # IF1 -> FP1:1 + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1_1), + ]) cable1.save() - cable2 = Cable(termination_a=interface2, termination_b=frontport1_2) # IF2 -> FP1:2 + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface2), + CableTermination(cable_end='B', termination=frontport1_2), + ]) cable2.save() - cable3 = Cable(termination_a=rearport1, termination_b=circuittermination1) # RP1 -> CT1 + cable3 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='B', termination=circuittermination1), + ]) cable3.save() - cable4 = Cable(termination_a=rearport2, termination_b=circuittermination2) # RP2 -> CT2 + cable4 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport2), + CableTermination(cable_end='B', termination=circuittermination2), + ]) cable4.save() - cable5 = Cable(termination_a=interface3, termination_b=frontport2_1) # IF3 -> FP2:1 + cable5 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface3), + CableTermination(cable_end='B', termination=frontport2_1), + ]) cable5.save() - cable6 = Cable(termination_a=interface4, termination_b=frontport2_2) # IF4 -> FP2:2 + cable6 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface4), + CableTermination(cable_end='B', termination=frontport2_2), + ]) cable6.save() self.assertPathExists( - origin=interface1, - destination=interface3, - path=( - cable1, frontport1_1, rearport1, cable3, circuittermination1, circuittermination2, - cable4, rearport2, frontport2_1, cable5 + ( + interface1, cable1, frontport1_1, rearport1, cable3, circuittermination1, circuittermination2, + cable4, rearport2, frontport2_1, cable5, interface3, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface2, - destination=interface4, - path=( - cable2, frontport1_2, rearport1, cable3, circuittermination1, circuittermination2, - cable4, rearport2, frontport2_2, cable6 + ( + interface2, cable2, frontport1_2, rearport1, cable3, circuittermination1, circuittermination2, + cable4, rearport2, frontport2_2, cable6, interface4, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface3, - destination=interface1, - path=( - cable5, frontport2_1, rearport2, cable4, circuittermination2, circuittermination1, - cable3, rearport1, frontport1_1, cable1 + ( + interface3, cable5, frontport2_1, rearport2, cable4, circuittermination2, circuittermination1, + cable3, rearport1, frontport1_1, cable1, interface1, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface4, - destination=interface2, - path=( - cable6, frontport2_2, rearport2, cable4, circuittermination2, circuittermination1, - cable3, rearport1, frontport1_2, cable2 + ( + interface4, cable6, frontport2_2, rearport2, cable4, circuittermination2, circuittermination1, + cable3, rearport1, frontport1_2, cable2, interface2, ), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 4) @@ -1068,30 +1132,37 @@ class CablePathTestCase(TestCase): circuittermination4 = CircuitTermination.objects.create(circuit=circuit2, site=self.site, term_side='Z') # Create cables - cable1 = Cable(termination_a=interface1, termination_b=circuittermination1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=circuittermination1), + ]) cable1.save() - cable2 = Cable(termination_a=circuittermination2, termination_b=circuittermination3) + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=circuittermination2), + CableTermination(cable_end='B', termination=circuittermination3), + ]) cable2.save() - cable3 = Cable(termination_a=circuittermination4, termination_b=interface2) + cable3 = Cable(terminations=[ + CableTermination(cable_end='A', termination=circuittermination4), + CableTermination(cable_end='B', termination=interface2), + ]) cable3.save() # Check for paths self.assertPathExists( - origin=interface1, - destination=interface2, - path=( - cable1, circuittermination1, circuittermination2, cable2, circuittermination3, circuittermination4, - cable3 + ( + interface1, cable1, circuittermination1, circuittermination2, cable2, circuittermination3, + circuittermination4, cable3, interface2, ), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface2, - destination=interface1, - path=( - cable3, circuittermination4, circuittermination3, cable2, circuittermination2, circuittermination1, - cable1 + ( + interface2, cable3, circuittermination4, circuittermination3, cable2, circuittermination2, + circuittermination1, cable1, interface1, ), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -1099,15 +1170,11 @@ class CablePathTestCase(TestCase): # Delete cable 2 cable2.delete() path1 = self.assertPathExists( - origin=interface1, - destination=self.site, - path=(cable1, circuittermination1, circuittermination2), + (interface1, cable1, circuittermination1, circuittermination2, self.site), is_active=True ) path2 = self.assertPathExists( - origin=interface2, - destination=self.site, - path=(cable3, circuittermination4, circuittermination3), + (interface2, cable3, circuittermination4, circuittermination3, self.site), is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -1132,34 +1199,39 @@ class CablePathTestCase(TestCase): ) # Create cable 2 - cable2 = Cable(termination_a=rearport1, termination_b=rearport2) + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='B', termination=rearport2), + ]) cable2.save() self.assertEqual(CablePath.objects.count(), 0) # Create cable1 - cable1 = Cable(termination_a=interface1, termination_b=frontport1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1), + ]) cable1.save() self.assertPathExists( - origin=interface1, - destination=None, - path=(cable1, frontport1, rearport1, cable2, rearport2, frontport2), - is_active=False + (interface1, cable1, frontport1, rearport1, cable2, rearport2, frontport2), + is_complete=False ) self.assertEqual(CablePath.objects.count(), 1) # Create cable 3 - cable3 = Cable(termination_a=frontport2, termination_b=interface2) + cable3 = Cable(terminations=[ + CableTermination(cable_end='A', termination=frontport2), + CableTermination(cable_end='B', termination=interface2), + ]) cable3.save() self.assertPathExists( - origin=interface1, - destination=interface2, - path=(cable1, frontport1, rearport1, cable2, rearport2, frontport2, cable3), + (interface1, cable1, frontport1, rearport1, cable2, rearport2, frontport2, cable3, interface2), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface2, - destination=interface1, - path=(cable3, frontport2, rearport2, cable2, rearport1, frontport1, cable1), + (interface2, cable3, frontport2, rearport2, cable2, rearport1, frontport1, cable1, interface1), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 2) @@ -1176,9 +1248,15 @@ class CablePathTestCase(TestCase): ) # Create cables 1 and 2 - cable1 = Cable(termination_a=interface1, termination_b=frontport1) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1), + ]) cable1.save() - cable2 = Cable(termination_a=rearport1, termination_b=interface2) + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='B', termination=interface2), + ]) cable2.save() self.assertEqual(CablePath.objects.filter(is_active=True).count(), 2) self.assertEqual(CablePath.objects.count(), 2) @@ -1187,15 +1265,13 @@ class CablePathTestCase(TestCase): cable2.status = LinkStatusChoices.STATUS_PLANNED cable2.save() self.assertPathExists( - origin=interface1, - destination=interface2, - path=(cable1, frontport1, rearport1, cable2), + (interface1, cable1, frontport1, rearport1, cable2, interface2), + is_complete=True, is_active=False ) self.assertPathExists( - origin=interface2, - destination=interface1, - path=(cable2, rearport1, frontport1, cable1), + (interface2, cable2, rearport1, frontport1, cable1, interface1), + is_complete=True, is_active=False ) self.assertEqual(CablePath.objects.count(), 2) @@ -1205,15 +1281,13 @@ class CablePathTestCase(TestCase): cable2.status = LinkStatusChoices.STATUS_CONNECTED cable2.save() self.assertPathExists( - origin=interface1, - destination=interface2, - path=(cable1, frontport1, rearport1, cable2), + (interface1, cable1, frontport1, rearport1, cable2, interface2), + is_complete=True, is_active=True ) self.assertPathExists( - origin=interface2, - destination=interface1, - path=(cable2, rearport1, frontport1, cable1), + (interface2, cable2, rearport1, frontport1, cable1, interface1), + is_complete=True, is_active=True ) self.assertEqual(CablePath.objects.count(), 2) From b44bfa1aa60d00588c04de4096bc44c73bd1e095 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 6 May 2022 16:17:27 -0400 Subject: [PATCH 041/593] WIP --- netbox/dcim/models/cables.py | 15 +++++++++++---- netbox/dcim/signals.py | 16 +++++++++------- netbox/dcim/utils.py | 8 +++++--- 3 files changed, 25 insertions(+), 14 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 6078aa9af..840af64cb 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -330,6 +330,8 @@ class CablePath(models.Model): def from_origin(cls, terminations): """ Create a new CablePath instance as traced from the given path origin. + + :param terminations: An iterable of one or more CableTermination objects. """ from circuits.models import CircuitTermination @@ -348,7 +350,7 @@ class CablePath(models.Model): ]) node = terminations[0].termination - while node.link is not None: + while terminations and node.link is not None: if hasattr(node.link, 'status') and node.link.status != LinkStatusChoices.STATUS_CONNECTED: is_active = False @@ -371,9 +373,10 @@ class CablePath(models.Model): termination_id__in=[t.termination_id for t in peer_terminations] ) rear_ports = RearPort.objects.filter(pk__in=[t.termination.rear_port_id for t in peer_terminations]) + # TODO: We're assuming that each of the front-to-rear mapping use equivalent positions. node = rear_ports[0] - if node.positions > 1: - position_stack.append(node.rear_port_position) + if rear_ports[0].positions > 1: + position_stack.append(peer_terminations[0].termination.rear_port_position) path.append([ object_to_path_node(rp) for rp in rear_ports ]) @@ -395,10 +398,14 @@ class CablePath(models.Model): break # Map FrontPorts to their corresponding RearPorts - terminations = FrontPort.objects.filter( + front_ports = FrontPort.objects.filter( rear_port_id__in=[t.rear_port_id for t in peer_terminations], rear_port_position=position ) + terminations = CableTermination.objects.filter( + termination_type=ContentType.objects.get_for_model(FrontPort), + termination_id__in=[fp.pk for fp in front_ports] + ) if terminations: path.append([ object_to_path_node(t.termination) for t in terminations diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 91870c037..defaf097c 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -1,3 +1,4 @@ +from collections import defaultdict import logging from django.contrib.contenttypes.models import ContentType @@ -84,25 +85,26 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): term for term in instance.terminations if not term.pk ]) + # Split terminations into A/B sets + _terms = defaultdict(list) + for term in instance.terminations: + _terms[term.cable_end].append(term) + # TODO: Update link peers # Set cable on terminating endpoints - _terms = { - 'A': [], - 'B': [], - } for term in instance.terminations: if term.termination.cable != instance: term.termination.cable = instance term.termination.save() - _terms[term.cable_end].append(term) # Create/update cable paths if created: for terms in _terms.values(): + # Examine type of first termination to determine object type (all must be the same) if isinstance(terms[0].termination, PathEndpoint): create_cablepath(terms) - else: - rebuild_paths(terms) + # else: + # rebuild_paths(terms) # elif instance.status != instance._orig_status: # # We currently don't support modifying either termination of an existing Cable. (This # # may change in the future.) However, we do need to capture status changes and update diff --git a/netbox/dcim/utils.py b/netbox/dcim/utils.py index 28199aa97..47a9bacec 100644 --- a/netbox/dcim/utils.py +++ b/netbox/dcim/utils.py @@ -39,13 +39,15 @@ def flatten_path(path): return ret -def create_cablepath(node): +def create_cablepath(terminations): """ - Create CablePaths for all paths originating from the specified node. + Create CablePaths for all paths originating from the specified set of nodes. + + :param terminations: Iterable of CableTermination objects """ from dcim.models import CablePath - cp = CablePath.from_origin(node) + cp = CablePath.from_origin(terminations) if cp: cp.save() From 5667a9c456e0514a2d00d6475e7013748b4a7c1e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 10 May 2022 09:53:55 -0400 Subject: [PATCH 042/593] Refactor CablePath.from_origin() --- netbox/circuits/signals.py | 4 +- netbox/dcim/models/cables.py | 174 ++++++++++++++++++----------------- netbox/dcim/signals.py | 19 ++-- 3 files changed, 100 insertions(+), 97 deletions(-) diff --git a/netbox/circuits/signals.py b/netbox/circuits/signals.py index 6ec9cc6c3..8193b29e8 100644 --- a/netbox/circuits/signals.py +++ b/netbox/circuits/signals.py @@ -23,5 +23,5 @@ def rebuild_cablepaths(instance, raw=False, **kwargs): """ if not raw: peer_termination = instance.get_peer_termination() - if peer_termination: - rebuild_paths(peer_termination) + # if peer_termination: + # rebuild_paths(peer_termination) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 840af64cb..8b2db479e 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -14,6 +14,7 @@ from dcim.utils import decompile_path_node, flatten_path, object_to_path_node, p from netbox.models import NetBoxModel from utilities.fields import ColorField from utilities.utils import to_meters +from wireless.models import WirelessLink from .devices import Device from .device_components import FrontPort, RearPort @@ -329,124 +330,129 @@ class CablePath(models.Model): @classmethod def from_origin(cls, terminations): """ - Create a new CablePath instance as traced from the given path origin. - - :param terminations: An iterable of one or more CableTermination objects. + Create a new CablePath instance as traced from the given termination objects. These can be any object to which a + Cable or WirelessLink connects (interfaces, console ports, circuit termination, etc.). All terminations must be + of the same type and must belong to the same parent object. """ from circuits.models import CircuitTermination - if not terminations or terminations[0].termination.link is None: - return None - path = [] position_stack = [] is_complete = False is_active = True is_split = False - # Start building the path from its originating CableTerminations - path.append([ - object_to_path_node(t.termination) for t in terminations - ]) + while terminations: - node = terminations[0].termination - while terminations and node.link is not None: - if hasattr(node.link, 'status') and node.link.status != LinkStatusChoices.STATUS_CONNECTED: + # Terminations must all be of the same type and belong to the same parent + assert all(isinstance(t, type(terminations[0])) for t in terminations[1:]) + assert all(t.parent is terminations[0].parent for t in terminations[1:]) + + # Step 1: Record the near-end termination object(s) + path.append([ + object_to_path_node(t) for t in terminations + ]) + + # Step 2: Determine the attached link (Cable or WirelessLink), if any + link = terminations[0].link + assert all(t.link is link for t in terminations[1:]) + if link is None: + # No attached link; abort + break + assert type(link) in (Cable, WirelessLink) + + # Step 3: Record the link and update path status if not "connected" + path.append([object_to_path_node(link)]) + if hasattr(link, 'status') and link.status != LinkStatusChoices.STATUS_CONNECTED: is_active = False - # Append the cable - path.append([object_to_path_node(node.link)]) - - # Follow the link to its far-end termination - if terminations[0].cable_end == 'A': - peer_terminations = CableTermination.objects.filter(cable=terminations[0].cable, cable_end='B') - else: - peer_terminations = CableTermination.objects.filter(cable=terminations[0].cable, cable_end='A') - - # Follow FrontPorts to their corresponding RearPorts - if isinstance(peer_terminations[0].termination, FrontPort): - path.append([ - object_to_path_node(t.termination) for t in peer_terminations - ]) - terminations = CableTermination.objects.filter( - termination_type=ContentType.objects.get_for_model(RearPort), - termination_id__in=[t.termination_id for t in peer_terminations] + # Step 4: Determine the far-end terminations + if isinstance(link, Cable): + termination_type = ContentType.objects.get_for_model(terminations[0]) + local_cable_terminations = CableTermination.objects.filter( + termination_type=termination_type, + termination_id__in=[t.pk for t in terminations] ) - rear_ports = RearPort.objects.filter(pk__in=[t.termination.rear_port_id for t in peer_terminations]) - # TODO: We're assuming that each of the front-to-rear mapping use equivalent positions. - node = rear_ports[0] - if rear_ports[0].positions > 1: - position_stack.append(peer_terminations[0].termination.rear_port_position) - path.append([ - object_to_path_node(rp) for rp in rear_ports - ]) + # Terminations must all belong to same end of Cable + local_cable_end = local_cable_terminations[0].cable_end + assert all(ct.cable_end == local_cable_end for ct in local_cable_terminations[1:]) + remote_cable_terminations = CableTermination.objects.filter( + cable=link, + cable_end='A' if local_cable_end == 'B' else 'B' + ) + remote_terminations = [ct.termination for ct in remote_cable_terminations] + else: + # WirelessLink + remote_terminations = [link.interface_b] if link.interface_a is terminations[0] else [link.interface_a] - # Follow RearPorts to their corresponding FrontPorts (if any) - elif isinstance(peer_terminations[0], RearPort): - path.append([ - object_to_path_node(t.termination) for t in peer_terminations - ]) + # Step 5: Record the far-end termination object(s) + path.append([ + object_to_path_node(t) for t in remote_terminations + ]) - # Determine the peer FrontPort's position - if peer_terminations[0].termination.positions == 1: + # Step 6: Determine the "next hop" terminations, if applicable + if isinstance(remote_terminations[0], FrontPort): + # Follow FrontPorts to their corresponding RearPorts + rear_ports = RearPort.objects.filter( + pk__in=[t.rear_port_id for t in remote_terminations] + ) + # RearPorts must have the same number of positions + rp_position_count = rear_ports[0].positions + assert all(rp.positions == rp_position_count for rp in terminations[1:]) + # Push position to stack if >1 + if rp_position_count > 1: + position_stack.append(remote_terminations[0].rear_port_position) + + terminations = rear_ports + + elif isinstance(remote_terminations[0], RearPort): + # If the RearPort has multiple positions, pop the current position from the stack + rp_position_count = remote_terminations[0].positions + assert all(rp.positions == rp_position_count for rp in remote_terminations[1:]) + if rp_position_count == 1: position = 1 elif position_stack: position = position_stack.pop() else: - # No position indicated: path has split, so we stop at the RearPort + # No position indicated: path has split, so we stop at the RearPorts is_split = True break - # Map FrontPorts to their corresponding RearPorts + # Follow RearPorts to their corresponding FrontPorts (if any) front_ports = FrontPort.objects.filter( - rear_port_id__in=[t.rear_port_id for t in peer_terminations], + rear_port_id__in=[t.pk for t in remote_terminations], rear_port_position=position ) - terminations = CableTermination.objects.filter( - termination_type=ContentType.objects.get_for_model(FrontPort), - termination_id__in=[fp.pk for fp in front_ports] - ) - if terminations: - path.append([ - object_to_path_node(t.termination) for t in terminations - ]) - # Follow a CircuitTermination to its corresponding CircuitTermination (A to Z or vice versa) - elif isinstance(peer_terminations[0], CircuitTermination): - path.append([ - object_to_path_node(t.termination) for t in peer_terminations - ]) + terminations = front_ports - # Get peer CircuitTerminations - term_side = 'Z' if peer_terminations[0].termination == 'A' else 'Z' - terminations = CircuitTermination.objects.filter( - circuit=peer_terminations[0].circuit, - term_side=term_side - ) - # Tracing across multiple circuits not currently supported - if len(terminations) > 1: - is_split = True + elif isinstance(remote_terminations[0], CircuitTermination): + # Follow a CircuitTermination to its corresponding CircuitTermination (A to Z or vice versa) + term_side = remote_terminations[0].term_side + assert all(ct.term_side == term_side for ct in remote_terminations[1:]) + circuit_termination = CircuitTermination.objects.filter( + circuit=remote_terminations[0].circuit, + term_side='Z' if term_side == 'A' else 'Z' + ).first() + if circuit_termination is None: break - elif terminations: + elif circuit_termination.provider_network: + # Circuit terminates to a ProviderNetwork path.append([ - object_to_path_node(t.termination) for t in terminations + object_to_path_node(circuit_termination.provider_network) ]) - # TODO - # if node.provider_network: - # destination = node.provider_network - # break - # elif node.site and not node.cable: - # destination = node.site - # break - else: - # No peer CircuitTermination exists; halt the trace break + elif circuit_termination.site and not circuit_termination.cable: + # Circuit terminates to a Site + path.append([ + object_to_path_node(circuit_termination.site) + ]) + break + + terminations = [circuit_termination] # Anything else marks the end of the path else: - path.append([ - object_to_path_node(t.termination) for t in peer_terminations - ]) is_complete = True break diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index defaf097c..dcc7ee33e 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -85,23 +85,20 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): term for term in instance.terminations if not term.pk ]) - # Split terminations into A/B sets - _terms = defaultdict(list) - for term in instance.terminations: - _terms[term.cable_end].append(term) - + # Split terminations into A/B sets and save link assignments # TODO: Update link peers - # Set cable on terminating endpoints - for term in instance.terminations: - if term.termination.cable != instance: - term.termination.cable = instance - term.termination.save() + _terms = defaultdict(list) + for t in instance.terminations: + if t.termination.cable != instance: + t.termination.cable = instance + t.termination.save() + _terms[t.cable_end].append(t.termination) # Create/update cable paths if created: for terms in _terms.values(): # Examine type of first termination to determine object type (all must be the same) - if isinstance(terms[0].termination, PathEndpoint): + if isinstance(terms[0], PathEndpoint): create_cablepath(terms) # else: # rebuild_paths(terms) From d89f067c00a584e8361b4fd5971c94bcd550de6d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 10 May 2022 10:30:58 -0400 Subject: [PATCH 043/593] Update & restore rebuild_paths() --- netbox/circuits/signals.py | 4 ++-- netbox/dcim/signals.py | 4 ++-- netbox/dcim/utils.py | 15 ++++++++------- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/netbox/circuits/signals.py b/netbox/circuits/signals.py index 8193b29e8..70f2abb41 100644 --- a/netbox/circuits/signals.py +++ b/netbox/circuits/signals.py @@ -23,5 +23,5 @@ def rebuild_cablepaths(instance, raw=False, **kwargs): """ if not raw: peer_termination = instance.get_peer_termination() - # if peer_termination: - # rebuild_paths(peer_termination) + if peer_termination: + rebuild_paths([peer_termination]) diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index dcc7ee33e..10d2ee9c5 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -100,8 +100,8 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): # Examine type of first termination to determine object type (all must be the same) if isinstance(terms[0], PathEndpoint): create_cablepath(terms) - # else: - # rebuild_paths(terms) + else: + rebuild_paths(terms) # elif instance.status != instance._orig_status: # # We currently don't support modifying either termination of an existing Cable. (This # # may change in the future.) However, we do need to capture status changes and update diff --git a/netbox/dcim/utils.py b/netbox/dcim/utils.py index 47a9bacec..0ea5f4580 100644 --- a/netbox/dcim/utils.py +++ b/netbox/dcim/utils.py @@ -52,16 +52,17 @@ def create_cablepath(terminations): cp.save() -def rebuild_paths(obj): +def rebuild_paths(terminations): """ Rebuild all CablePaths which traverse the specified node """ from dcim.models import CablePath - cable_paths = CablePath.objects.filter(path__contains=obj) + for obj in terminations: + cable_paths = CablePath.objects.filter(_nodes__contains=obj) - with transaction.atomic(): - for cp in cable_paths: - cp.delete() - if cp.origin: - create_cablepath(cp.origin) + with transaction.atomic(): + for cp in cable_paths: + cp.delete() + origins = [path_node_to_object(node) for node in cp.path[0]] + create_cablepath(origins) From eb4984afe6621a9878f344974b405dfd95b5d7a1 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 10 May 2022 11:34:57 -0400 Subject: [PATCH 044/593] Correct test queries --- netbox/dcim/tests/test_cablepaths.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/netbox/dcim/tests/test_cablepaths.py b/netbox/dcim/tests/test_cablepaths.py index ec55c5b6d..a72f22c75 100644 --- a/netbox/dcim/tests/test_cablepaths.py +++ b/netbox/dcim/tests/test_cablepaths.py @@ -550,8 +550,8 @@ class CablePathTestCase(TestCase): cable3.delete() # Check for four partial paths; one from each interface - self.assertEqual(CablePath.objects.filter(destination_id__isnull=True).count(), 4) - self.assertEqual(CablePath.objects.filter(destination_id__isnull=False).count(), 0) + self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 4) + self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) def test_204_multiple_paths_via_multiple_pass_throughs(self): """ @@ -677,8 +677,8 @@ class CablePathTestCase(TestCase): cable5.delete() # Check for two complete paths (IF1 <--> IF2) and two partial (IF3 <--> IF4) - self.assertEqual(CablePath.objects.filter(destination_id__isnull=True).count(), 2) - self.assertEqual(CablePath.objects.filter(destination_id__isnull=False).count(), 2) + self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 2) + self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 2) def test_205_multiple_paths_via_patched_pass_throughs(self): """ @@ -780,8 +780,8 @@ class CablePathTestCase(TestCase): cable3.delete() # Check for four partial paths; one from each interface - self.assertEqual(CablePath.objects.filter(destination_id__isnull=True).count(), 4) - self.assertEqual(CablePath.objects.filter(destination_id__isnull=False).count(), 0) + self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 4) + self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) def test_206_unidirectional_split_paths(self): """ From 8bc6d8cb231ad45cd8b97ffb26cc3d989c60c277 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 10 May 2022 11:58:48 -0400 Subject: [PATCH 045/593] Introduce CablePath.retrace() to handle deleted cables --- netbox/dcim/models/cables.py | 23 +++++++++++++++++++-- netbox/dcim/signals.py | 40 +++++++++++------------------------- 2 files changed, 33 insertions(+), 30 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 8b2db479e..6b3d35137 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -356,8 +356,11 @@ class CablePath(models.Model): # Step 2: Determine the attached link (Cable or WirelessLink), if any link = terminations[0].link assert all(t.link is link for t in terminations[1:]) - if link is None: - # No attached link; abort + if link is None and len(path) == 1: + # If this is the start of the path and no link exists, return None + return None + elif link is None: + # Otherwise, halt the trace if no link exists break assert type(link) in (Cable, WirelessLink) @@ -463,6 +466,22 @@ class CablePath(models.Model): is_split=is_split ) + def retrace(self): + """ + Retrace the path from the currently-defined originating termination(s) + """ + _new = self.from_origin([ + path_node_to_object(node) for node in self.path[0] + ]) + if _new: + self.path = _new.path + self.is_complete = _new.is_complete + self.is_active = _new.is_active + self.is_split = _new.is_split + self.save() + else: + self.delete() + def get_path(self): """ Return the path as a list of prefetched objects. diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 10d2ee9c5..128cedf66 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -126,34 +126,18 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): @receiver(post_delete, sender=Cable) +def retrace_cable_paths(instance, **kwargs): + """ + When a Cable is deleted, check for and update its connected endpoints + """ + for cablepath in CablePath.objects.filter(_nodes__contains=instance): + cablepath.retrace() + + +@receiver(post_delete, sender=CableTermination) def nullify_connected_endpoints(instance, **kwargs): """ - When a Cable is deleted, check for and update its two connected endpoints + Disassociate the Cable from the termination object. """ - logger = logging.getLogger('netbox.dcim.cable') - - # # Disassociate the Cable from its termination points - # if instance.termination_a: - # logger.debug(f"Nullifying termination A for cable {instance}") - # model = instance.termination_a_type.model_class() - # model.objects.filter(pk__in=instance.termination_a_ids).update(_link_peer_type=None, _link_peer_id=None) - # if instance.termination_b: - # logger.debug(f"Nullifying termination B for cable {instance}") - # model = instance.termination_b_type.model_class() - # model.objects.filter(pk__in=instance.termination_b_ids).update(_link_peer_type=None, _link_peer_id=None) - - # Delete and retrace any dependent cable paths - for cablepath in CablePath.objects.filter(_nodes__contains=instance): - cablepath.delete() - # TODO: Create new traces - # cp = CablePath.from_origin(cablepath.origin) - # if cp: - # CablePath.objects.filter(pk=cablepath.pk).update( - # _nodes=cp._nodes, - # destination_type=ContentType.objects.get_for_model(cp.destination) if cp.destination else None, - # destination_id=cp.destination.pk if cp.destination else None, - # is_active=cp.is_active, - # is_split=cp.is_split - # ) - # else: - # cablepath.delete() + model = instance.termination_type.model_class() + model.objects.filter(pk=instance.termination_id).update(_link_peer_type=None, _link_peer_id=None) From c88f7b8408363aa9da8ce729a1e79c39966379cb Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 10 May 2022 13:45:52 -0400 Subject: [PATCH 046/593] Fix circuit termination tracing & update tests --- netbox/dcim/models/cables.py | 12 +++++++----- netbox/dcim/signals.py | 16 ++++++++-------- netbox/dcim/tests/test_cablepaths.py | 9 ++++----- 3 files changed, 19 insertions(+), 18 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 6b3d35137..d714cb317 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -435,20 +435,22 @@ class CablePath(models.Model): assert all(ct.term_side == term_side for ct in remote_terminations[1:]) circuit_termination = CircuitTermination.objects.filter( circuit=remote_terminations[0].circuit, - term_side='Z' if term_side == 'A' else 'Z' + term_side='Z' if term_side == 'A' else 'A' ).first() if circuit_termination is None: break elif circuit_termination.provider_network: # Circuit terminates to a ProviderNetwork - path.append([ - object_to_path_node(circuit_termination.provider_network) + path.extend([ + [object_to_path_node(circuit_termination)], + [object_to_path_node(circuit_termination.provider_network)], ]) break elif circuit_termination.site and not circuit_termination.cable: # Circuit terminates to a Site - path.append([ - object_to_path_node(circuit_termination.site) + path.extend([ + [object_to_path_node(circuit_termination)], + [object_to_path_node(circuit_termination.site)], ]) break diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 128cedf66..30e3b6ed0 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -102,14 +102,14 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): create_cablepath(terms) else: rebuild_paths(terms) - # elif instance.status != instance._orig_status: - # # We currently don't support modifying either termination of an existing Cable. (This - # # may change in the future.) However, we do need to capture status changes and update - # # any CablePaths accordingly. - # if instance.status != LinkStatusChoices.STATUS_CONNECTED: - # CablePath.objects.filter(path__contains=instance).update(is_active=False) - # else: - # rebuild_paths(instance) + elif instance.status != instance._orig_status: + # We currently don't support modifying either termination of an existing Cable. (This + # may change in the future.) However, we do need to capture status changes and update + # any CablePaths accordingly. + if instance.status != LinkStatusChoices.STATUS_CONNECTED: + CablePath.objects.filter(_nodes__contains=instance).update(is_active=False) + else: + rebuild_paths([instance]) # @receiver(post_save, sender=CableTermination) diff --git a/netbox/dcim/tests/test_cablepaths.py b/netbox/dcim/tests/test_cablepaths.py index a72f22c75..e2031dcbc 100644 --- a/netbox/dcim/tests/test_cablepaths.py +++ b/netbox/dcim/tests/test_cablepaths.py @@ -385,7 +385,6 @@ class CablePathTestCase(TestCase): ) self.assertPathExists( (interface2, cable2, frontport1_2, rearport1, cable3, rearport2, frontport2_2), - is_active=False, is_complete=False ) self.assertEqual(CablePath.objects.count(), 2) @@ -427,8 +426,8 @@ class CablePathTestCase(TestCase): cable3.delete() # Check for four partial paths; one from each interface - self.assertEqual(CablePath.objects.filter(destination_id__isnull=True).count(), 4) - self.assertEqual(CablePath.objects.filter(destination_id__isnull=False).count(), 0) + self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 4) + self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) interface1.refresh_from_db() interface2.refresh_from_db() interface3.refresh_from_db() @@ -1116,8 +1115,8 @@ class CablePathTestCase(TestCase): cable4.delete() # Check for four partial paths; one from each interface - self.assertEqual(CablePath.objects.filter(destination_id__isnull=True).count(), 4) - self.assertEqual(CablePath.objects.filter(destination_id__isnull=False).count(), 0) + self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 4) + self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) def test_213_multiple_circuits_to_interface(self): """ From 4d5bcb65c87a1df3fb39bebc507e278af3567a0d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 10 May 2022 15:45:12 -0400 Subject: [PATCH 047/593] Fix up pass-through port traversal --- netbox/dcim/models/cables.py | 36 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 20 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index d714cb317..e11259e2e 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -346,7 +346,7 @@ class CablePath(models.Model): # Terminations must all be of the same type and belong to the same parent assert all(isinstance(t, type(terminations[0])) for t in terminations[1:]) - assert all(t.parent is terminations[0].parent for t in terminations[1:]) + assert all(t.parent_object == terminations[0].parent_object for t in terminations[1:]) # Step 1: Record the near-end termination object(s) path.append([ @@ -355,7 +355,7 @@ class CablePath(models.Model): # Step 2: Determine the attached link (Cable or WirelessLink), if any link = terminations[0].link - assert all(t.link is link for t in terminations[1:]) + assert all(t.link == link for t in terminations[1:]) if link is None and len(path) == 1: # If this is the start of the path and no link exists, return None return None @@ -399,34 +399,30 @@ class CablePath(models.Model): rear_ports = RearPort.objects.filter( pk__in=[t.rear_port_id for t in remote_terminations] ) - # RearPorts must have the same number of positions - rp_position_count = rear_ports[0].positions - assert all(rp.positions == rp_position_count for rp in terminations[1:]) - # Push position to stack if >1 - if rp_position_count > 1: - position_stack.append(remote_terminations[0].rear_port_position) + if len(rear_ports) > 1: + assert all(rp.positions == 1 for rp in rear_ports) + elif rear_ports[0].positions > 1: + position_stack.append([fp.rear_port_position for fp in remote_terminations]) terminations = rear_ports elif isinstance(remote_terminations[0], RearPort): - # If the RearPort has multiple positions, pop the current position from the stack - rp_position_count = remote_terminations[0].positions - assert all(rp.positions == rp_position_count for rp in remote_terminations[1:]) - if rp_position_count == 1: - position = 1 + + if len(remote_terminations) > 1 or remote_terminations[0].positions == 1: + front_ports = FrontPort.objects.filter( + rear_port_id__in=[rp.pk for rp in remote_terminations], + rear_port_position=1 + ) elif position_stack: - position = position_stack.pop() + front_ports = FrontPort.objects.filter( + rear_port_id=remote_terminations[0].pk, + rear_port_position__in=position_stack.pop() + ) else: # No position indicated: path has split, so we stop at the RearPorts is_split = True break - # Follow RearPorts to their corresponding FrontPorts (if any) - front_ports = FrontPort.objects.filter( - rear_port_id__in=[t.pk for t in remote_terminations], - rear_port_position=position - ) - terminations = front_ports elif isinstance(remote_terminations[0], CircuitTermination): From bb9eb119a424dad0d7abca0b6d0c91d993a5d0ae Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 10 May 2022 15:46:12 -0400 Subject: [PATCH 048/593] Extend cable tracing tests --- netbox/dcim/tests/test_cablepaths.py | 280 ++++++++++++++++++++++++++- 1 file changed, 271 insertions(+), 9 deletions(-) diff --git a/netbox/dcim/tests/test_cablepaths.py b/netbox/dcim/tests/test_cablepaths.py index e2031dcbc..40281b757 100644 --- a/netbox/dcim/tests/test_cablepaths.py +++ b/netbox/dcim/tests/test_cablepaths.py @@ -228,7 +228,54 @@ class CablePathTestCase(TestCase): # Check that all CablePaths have been deleted self.assertEqual(CablePath.objects.count(), 0) - def test_120_multi_term_to_multi_term(self): + def test_120_single_interface_to_multi_interface(self): + """ + [IF1] --C1-- [IF2] + [IF3] + """ + interface1 = Interface.objects.create(device=self.device, name='Interface 1') + interface2 = Interface.objects.create(device=self.device, name='Interface 2') + interface3 = Interface.objects.create(device=self.device, name='Interface 3') + + # Create cable 1 + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=interface2), + CableTermination(cable_end='B', termination=interface3), + ]) + cable1.save() + + path1 = self.assertPathExists( + (interface1, cable1, (interface2, interface3)), + is_complete=True, + is_active=True + ) + path2 = self.assertPathExists( + ((interface2, interface3), cable1, interface1), + is_complete=True, + is_active=True + ) + self.assertEqual(CablePath.objects.count(), 2) + interface1.refresh_from_db() + interface2.refresh_from_db() + interface3.refresh_from_db() + self.assertPathIsSet(interface1, path1) + self.assertPathIsSet(interface2, path2) + self.assertPathIsSet(interface3, path2) + + # Delete cable 1 + cable1.delete() + + # Check that all CablePaths have been deleted + self.assertEqual(CablePath.objects.count(), 0) + interface1.refresh_from_db() + interface2.refresh_from_db() + interface3.refresh_from_db() + self.assertPathIsNotSet(interface1) + self.assertPathIsNotSet(interface2) + self.assertPathIsNotSet(interface3) + + def test_121_multi_interface_to_multi_interface(self): """ [IF1] --C1-- [IF3] [IF2] [IF4] @@ -239,14 +286,12 @@ class CablePathTestCase(TestCase): interface4 = Interface.objects.create(device=self.device, name='Interface 4') # Create cable 1 - cable1 = Cable( - terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='A', termination=interface2), - CableTermination(cable_end='B', termination=interface3), - CableTermination(cable_end='B', termination=interface4), - ] - ) + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='A', termination=interface2), + CableTermination(cable_end='B', termination=interface3), + CableTermination(cable_end='B', termination=interface4), + ]) cable1.save() path1 = self.assertPathExists( @@ -274,6 +319,14 @@ class CablePathTestCase(TestCase): # Check that all CablePaths have been deleted self.assertEqual(CablePath.objects.count(), 0) + interface1.refresh_from_db() + interface2.refresh_from_db() + interface3.refresh_from_db() + interface4.refresh_from_db() + self.assertPathIsNotSet(interface1) + self.assertPathIsNotSet(interface2) + self.assertPathIsNotSet(interface3) + self.assertPathIsNotSet(interface4) def test_201_single_path_via_pass_through(self): """ @@ -1118,6 +1171,215 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 4) self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) + def test_250_interface_to_interface_via_rear_ports(self): + """ + [IF1] --C1-- [FP1] [RP1] --C2-- [RP3] [FP3] --C3-- [IF2] + [FP2] [RP2] [RP4] [FP4] + """ + interface1 = Interface.objects.create(device=self.device, name='Interface 1') + interface2 = Interface.objects.create(device=self.device, name='Interface 2') + rearport1 = RearPort.objects.create(device=self.device, name='Rear Port 1', positions=1) + rearport2 = RearPort.objects.create(device=self.device, name='Rear Port 2', positions=1) + rearport3 = RearPort.objects.create(device=self.device, name='Rear Port 3', positions=1) + rearport4 = RearPort.objects.create(device=self.device, name='Rear Port 4', positions=1) + frontport1 = FrontPort.objects.create( + device=self.device, name='Front Port 1', rear_port=rearport1, rear_port_position=1 + ) + frontport2 = FrontPort.objects.create( + device=self.device, name='Front Port 2', rear_port=rearport2, rear_port_position=1 + ) + frontport3 = FrontPort.objects.create( + device=self.device, name='Front Port 3', rear_port=rearport3, rear_port_position=1 + ) + frontport4 = FrontPort.objects.create( + device=self.device, name='Front Port 4', rear_port=rearport4, rear_port_position=1 + ) + + # Create cables 1-2 + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1), + CableTermination(cable_end='B', termination=frontport2), + ]) + cable1.save() + cable3 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface2), + CableTermination(cable_end='B', termination=frontport3), + CableTermination(cable_end='B', termination=frontport4), + ]) + cable3.save() + self.assertPathExists( + (interface1, cable1, (frontport1, frontport2), (rearport1, rearport2)), + is_complete=False + ) + self.assertPathExists( + (interface2, cable3, (frontport3, frontport4), (rearport3, rearport4)), + is_complete=False + ) + self.assertEqual(CablePath.objects.count(), 2) + + # Create cable 2 + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='A', termination=rearport2), + CableTermination(cable_end='B', termination=rearport3), + CableTermination(cable_end='B', termination=rearport4), + ]) + cable2.save() + path1 = self.assertPathExists( + ( + interface1, cable1, (frontport1, frontport2), (rearport1, rearport2), cable2, + (rearport3, rearport4), (frontport3, frontport4), cable3, interface2 + ), + is_complete=True + ) + path2 = self.assertPathExists( + ( + interface2, cable3, (frontport3, frontport4), (rearport3, rearport4), cable2, + (rearport1, rearport2), (frontport1, frontport2), cable1, interface1 + ), + is_complete=True + ) + self.assertEqual(CablePath.objects.count(), 2) + + # Delete cable 2 + cable2.delete() + + # Check for two partial paths; one from each interface + self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 2) + self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) + interface1.refresh_from_db() + interface2.refresh_from_db() + self.assertPathIsSet(interface1, path1) + self.assertPathIsSet(interface2, path2) + + def test_251_interfaces_to_interfaces_via_multiposition_rear_ports(self): + """ + [IF1] --C1-- [FP1:1] [RP1] --C3-- [RP2] [FP2:1] --C4-- [IF3] + [FP1:2] [FP2:2] + [IF2] --C2-- [FP1:3] [FP2:3] --C5-- [IF4] + [FP1:4] [FP2:4] + """ + interface1 = Interface.objects.create(device=self.device, name='Interface 1') + interface2 = Interface.objects.create(device=self.device, name='Interface 2') + interface3 = Interface.objects.create(device=self.device, name='Interface 3') + interface4 = Interface.objects.create(device=self.device, name='Interface 4') + rearport1 = RearPort.objects.create(device=self.device, name='Rear Port 1', positions=4) + rearport2 = RearPort.objects.create(device=self.device, name='Rear Port 2', positions=4) + frontport1_1 = FrontPort.objects.create( + device=self.device, name='Front Port 1:1', rear_port=rearport1, rear_port_position=1 + ) + frontport1_2 = FrontPort.objects.create( + device=self.device, name='Front Port 1:2', rear_port=rearport1, rear_port_position=2 + ) + frontport1_3 = FrontPort.objects.create( + device=self.device, name='Front Port 1:3', rear_port=rearport1, rear_port_position=3 + ) + frontport1_4 = FrontPort.objects.create( + device=self.device, name='Front Port 1:4', rear_port=rearport1, rear_port_position=4 + ) + frontport2_1 = FrontPort.objects.create( + device=self.device, name='Front Port 2:1', rear_port=rearport2, rear_port_position=1 + ) + frontport2_2 = FrontPort.objects.create( + device=self.device, name='Front Port 2:2', rear_port=rearport2, rear_port_position=2 + ) + frontport2_3 = FrontPort.objects.create( + device=self.device, name='Front Port 2:3', rear_port=rearport2, rear_port_position=3 + ) + frontport2_4 = FrontPort.objects.create( + device=self.device, name='Front Port 2:4', rear_port=rearport2, rear_port_position=4 + ) + + # Create cables 1-2 + cable1 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface1), + CableTermination(cable_end='B', termination=frontport1_1), + CableTermination(cable_end='B', termination=frontport1_2), + ]) + cable1.save() + cable2 = Cable(terminations=[ + CableTermination(cable_end='A', termination=interface2), + CableTermination(cable_end='B', termination=frontport1_3), + CableTermination(cable_end='B', termination=frontport1_4), + ]) + cable2.save() + self.assertPathExists( + (interface1, cable1, (frontport1_1, frontport1_2), rearport1), + is_complete=False + ) + self.assertPathExists( + (interface2, cable2, (frontport1_3, frontport1_4), rearport1), + is_complete=False + ) + self.assertEqual(CablePath.objects.count(), 2) + + # Create cable 3 + cable3 = Cable(terminations=[ + CableTermination(cable_end='A', termination=rearport1), + CableTermination(cable_end='B', termination=rearport2), + ]) + cable3.save() + self.assertPathExists( + (interface1, cable1, (frontport1_1, frontport1_2), rearport1, cable3, rearport2, (frontport2_1, frontport2_2)), + is_complete=False + ) + self.assertPathExists( + (interface2, cable2, (frontport1_3, frontport1_4), rearport1, cable3, rearport2, (frontport2_3, frontport2_4)), + is_complete=False + ) + self.assertEqual(CablePath.objects.count(), 2) + + # Create cables 4-5 + cable4 = Cable(terminations=[ + CableTermination(cable_end='A', termination=frontport2_1), + CableTermination(cable_end='A', termination=frontport2_2), + CableTermination(cable_end='B', termination=interface3), + ]) + cable4.save() + cable5 = Cable(terminations=[ + CableTermination(cable_end='A', termination=frontport2_3), + CableTermination(cable_end='A', termination=frontport2_4), + CableTermination(cable_end='B', termination=interface4), + ]) + cable5.save() + path1 = self.assertPathExists( + (interface1, cable1, (frontport1_1, frontport1_2), rearport1, cable3, rearport2, (frontport2_1, frontport2_2), cable4, interface3), + is_complete=True, + is_active=True + ) + path2 = self.assertPathExists( + (interface2, cable2, (frontport1_3, frontport1_4), rearport1, cable3, rearport2, (frontport2_3, frontport2_4), cable5, interface4), + is_complete=True, + is_active=True + ) + path3 = self.assertPathExists( + (interface3, cable4, (frontport2_1, frontport2_2), rearport2, cable3, rearport1, (frontport1_1, frontport1_2), cable1, interface1), + is_complete=True, + is_active=True + ) + path4 = self.assertPathExists( + (interface4, cable5, (frontport2_3, frontport2_4), rearport2, cable3, rearport1, (frontport1_3, frontport1_4), cable2, interface2), + is_complete=True, + is_active=True + ) + self.assertEqual(CablePath.objects.count(), 4) + + # Delete cable 3 + cable3.delete() + + # Check for four partial paths; one from each interface + self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 4) + self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) + interface1.refresh_from_db() + interface2.refresh_from_db() + interface3.refresh_from_db() + interface4.refresh_from_db() + self.assertPathIsSet(interface1, path1) + self.assertPathIsSet(interface2, path2) + self.assertPathIsSet(interface3, path3) + self.assertPathIsSet(interface4, path4) + def test_213_multiple_circuits_to_interface(self): """ [IF1] --C1-- [CT1] [CT2] --C2-- [CT3] [CT4] --C3-- [IF2] From 594964aebe2d98785cffb5bf1cfc968d95ee6239 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 12 May 2022 17:11:01 -0400 Subject: [PATCH 049/593] Simplify Cable init signature --- netbox/dcim/models/cables.py | 14 +- netbox/dcim/tests/test_cablepaths.py | 531 +++++++++++++-------------- 2 files changed, 266 insertions(+), 279 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index e11259e2e..5baa767be 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -96,7 +96,7 @@ class Cable(NetBoxModel): class Meta: ordering = ('pk',) - def __init__(self, *args, terminations=None, **kwargs): + def __init__(self, *args, a_terminations=None, b_terminations=None, **kwargs): super().__init__(*args, **kwargs) # A copy of the PK to be used by __str__ in case the object is deleted @@ -106,11 +106,17 @@ class Cable(NetBoxModel): self._orig_status = self.status # Assign associated CableTerminations (if any) + terminations = [] + if a_terminations and type(a_terminations) is list: + terminations.extend([ + CableTermination(cable=self, cable_end='A', termination=t) for t in a_terminations + ]) + if b_terminations and type(b_terminations) is list: + terminations.extend([ + CableTermination(cable=self, cable_end='B', termination=t) for t in b_terminations + ]) if terminations: - assert type(terminations) is list assert self.pk is None - for t in terminations: - t.cable = self self.terminations = terminations else: self.terminations = [] diff --git a/netbox/dcim/tests/test_cablepaths.py b/netbox/dcim/tests/test_cablepaths.py index 40281b757..9f0b1a43c 100644 --- a/netbox/dcim/tests/test_cablepaths.py +++ b/netbox/dcim/tests/test_cablepaths.py @@ -85,10 +85,8 @@ class CablePathTestCase(TestCase): # Create cable 1 cable1 = Cable( - terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=interface2), - ] + a_terminations=[interface1], + b_terminations=[interface2] ) cable1.save() @@ -123,10 +121,8 @@ class CablePathTestCase(TestCase): # Create cable 1 cable1 = Cable( - terminations=[ - CableTermination(cable_end='A', termination=consoleport1), - CableTermination(cable_end='B', termination=consoleserverport1), - ] + a_terminations=[consoleport1], + b_terminations=[consoleserverport1] ) cable1.save() @@ -161,10 +157,8 @@ class CablePathTestCase(TestCase): # Create cable 1 cable1 = Cable( - terminations=[ - CableTermination(cable_end='A', termination=powerport1), - CableTermination(cable_end='B', termination=poweroutlet1), - ] + a_terminations=[powerport1], + b_terminations=[poweroutlet1] ) cable1.save() @@ -199,10 +193,8 @@ class CablePathTestCase(TestCase): # Create cable 1 cable1 = Cable( - terminations=[ - CableTermination(cable_end='A', termination=powerport1), - CableTermination(cable_end='B', termination=powerfeed1), - ] + a_terminations=[powerport1], + b_terminations=[powerfeed1] ) cable1.save() @@ -238,11 +230,10 @@ class CablePathTestCase(TestCase): interface3 = Interface.objects.create(device=self.device, name='Interface 3') # Create cable 1 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=interface2), - CableTermination(cable_end='B', termination=interface3), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[interface2, interface3] + ) cable1.save() path1 = self.assertPathExists( @@ -286,12 +277,10 @@ class CablePathTestCase(TestCase): interface4 = Interface.objects.create(device=self.device, name='Interface 4') # Create cable 1 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='A', termination=interface2), - CableTermination(cable_end='B', termination=interface3), - CableTermination(cable_end='B', termination=interface4), - ]) + cable1 = Cable( + a_terminations=[interface1, interface2], + b_terminations=[interface3, interface4] + ) cable1.save() path1 = self.assertPathExists( @@ -340,10 +329,10 @@ class CablePathTestCase(TestCase): ) # Create cable 1 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1] + ) cable1.save() self.assertPathExists( (interface1, cable1, frontport1, rearport1), @@ -352,10 +341,10 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.count(), 1) # Create cable 2 - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='B', termination=interface2), - ]) + cable2 = Cable( + a_terminations=[rearport1], + b_terminations=[interface2] + ) cable2.save() self.assertPathExists( (interface1, cable1, frontport1, rearport1, cable2, interface2), @@ -406,15 +395,15 @@ class CablePathTestCase(TestCase): ) # Create cables 1-2 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1_1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1_1] + ) cable1.save() - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface2), - CableTermination(cable_end='B', termination=frontport1_2), - ]) + cable2 = Cable( + a_terminations=[interface2], + b_terminations=[frontport1_2] + ) cable2.save() self.assertPathExists( (interface1, cable1, frontport1_1, rearport1), @@ -427,10 +416,10 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.count(), 2) # Create cable 3 - cable3 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='B', termination=rearport2), - ]) + cable3 = Cable( + a_terminations=[rearport1], + b_terminations=[rearport2] + ) cable3.save() self.assertPathExists( (interface1, cable1, frontport1_1, rearport1, cable3, rearport2, frontport2_1), @@ -443,15 +432,15 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.count(), 2) # Create cables 4-5 - cable4 = Cable(terminations=[ - CableTermination(cable_end='A', termination=frontport2_1), - CableTermination(cable_end='B', termination=interface3), - ]) + cable4 = Cable( + a_terminations=[frontport2_1], + b_terminations=[interface3] + ) cable4.save() - cable5 = Cable(terminations=[ - CableTermination(cable_end='A', termination=frontport2_2), - CableTermination(cable_end='B', termination=interface4), - ]) + cable5 = Cable( + a_terminations=[frontport2_2], + b_terminations=[interface4] + ) cable5.save() path1 = self.assertPathExists( (interface1, cable1, frontport1_1, rearport1, cable3, rearport2, frontport2_1, cable4, interface3), @@ -523,46 +512,46 @@ class CablePathTestCase(TestCase): ) # Create cables 1-2, 6-7 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1_1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1_1] + ) cable1.save() - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface2), - CableTermination(cable_end='B', termination=frontport1_2), - ]) + cable2 = Cable( + a_terminations=[interface2], + b_terminations=[frontport1_2] + ) cable2.save() - cable6 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface3), - CableTermination(cable_end='B', termination=frontport4_1), - ]) + cable6 = Cable( + a_terminations=[interface3], + b_terminations=[frontport4_1] + ) cable6.save() - cable7 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface4), - CableTermination(cable_end='B', termination=frontport4_2), - ]) + cable7 = Cable( + a_terminations=[interface4], + b_terminations=[frontport4_2] + ) cable7.save() self.assertEqual(CablePath.objects.count(), 4) # Four partial paths; one from each interface # Create cables 3 and 5 - cable3 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='B', termination=frontport2), - ]) + cable3 = Cable( + a_terminations=[rearport1], + b_terminations=[frontport2] + ) cable3.save() - cable5 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport4), - CableTermination(cable_end='B', termination=frontport3), - ]) + cable5 = Cable( + a_terminations=[rearport4], + b_terminations=[frontport3] + ) cable5.save() self.assertEqual(CablePath.objects.count(), 4) # Four (longer) partial paths; one from each interface # Create cable 4 - cable4 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport2), - CableTermination(cable_end='B', termination=rearport3), - ]) + cable4 = Cable( + a_terminations=[rearport2], + b_terminations=[rearport3] + ) cable4.save() self.assertPathExists( ( @@ -644,48 +633,48 @@ class CablePathTestCase(TestCase): ) # Create cables 1-3, 6-8 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1_1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1_1] + ) cable1.save() - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface2), - CableTermination(cable_end='B', termination=frontport1_2), - ]) + cable2 = Cable( + a_terminations=[interface2], + b_terminations=[frontport1_2] + ) cable2.save() - cable3 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='B', termination=rearport2), - ]) + cable3 = Cable( + a_terminations=[rearport1], + b_terminations=[rearport2] + ) cable3.save() - cable6 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport3), - CableTermination(cable_end='B', termination=rearport4), - ]) + cable6 = Cable( + a_terminations=[rearport3], + b_terminations=[rearport4] + ) cable6.save() - cable7 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface3), - CableTermination(cable_end='B', termination=frontport4_1), - ]) + cable7 = Cable( + a_terminations=[interface3], + b_terminations=[frontport4_1] + ) cable7.save() - cable8 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface4), - CableTermination(cable_end='B', termination=frontport4_2), - ]) + cable8 = Cable( + a_terminations=[interface4], + b_terminations=[frontport4_2] + ) cable8.save() self.assertEqual(CablePath.objects.count(), 4) # Four partial paths; one from each interface # Create cables 4 and 5 - cable4 = Cable(terminations=[ - CableTermination(cable_end='A', termination=frontport2_1), - CableTermination(cable_end='B', termination=frontport3_1), - ]) + cable4 = Cable( + a_terminations=[frontport2_1], + b_terminations=[frontport3_1] + ) cable4.save() - cable5 = Cable(terminations=[ - CableTermination(cable_end='A', termination=frontport2_2), - CableTermination(cable_end='B', termination=frontport3_2), - ]) + cable5 = Cable( + a_terminations=[frontport2_2], + b_terminations=[frontport3_2] + ) cable5.save() self.assertPathExists( ( @@ -761,38 +750,38 @@ class CablePathTestCase(TestCase): ) # Create cables 1-2, 5-6 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1_1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1_1] + ) cable1.save() - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface2), - CableTermination(cable_end='B', termination=frontport1_2), - ]) + cable2 = Cable( + a_terminations=[interface2], + b_terminations=[frontport1_2] + ) cable2.save() - cable5 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface3), - CableTermination(cable_end='B', termination=frontport3_1), - ]) + cable5 = Cable( + a_terminations=[interface3], + b_terminations=[frontport3_1] + ) cable5.save() - cable6 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface4), - CableTermination(cable_end='B', termination=frontport3_2), - ]) + cable6 = Cable( + a_terminations=[interface4], + b_terminations=[frontport3_2] + ) cable6.save() self.assertEqual(CablePath.objects.count(), 4) # Four partial paths; one from each interface # Create cables 3-4 - cable3 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='B', termination=frontport2), - ]) + cable3 = Cable( + a_terminations=[rearport1], + b_terminations=[frontport2] + ) cable3.save() - cable4 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport2), - CableTermination(cable_end='B', termination=rearport3), - ]) + cable4 = Cable( + a_terminations=[rearport2], + b_terminations=[rearport3] + ) cable4.save() self.assertPathExists( ( @@ -852,10 +841,10 @@ class CablePathTestCase(TestCase): ) # Create cables 1 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=rearport1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[rearport1] + ) cable1.save() self.assertPathExists( (interface1, cable1, rearport1), @@ -865,15 +854,15 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.count(), 1) # Create cables 2-3 - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface2), - CableTermination(cable_end='B', termination=frontport1_1), - ]) + cable2 = Cable( + a_terminations=[interface2], + b_terminations=[frontport1_1] + ) cable2.save() - cable3 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface3), - CableTermination(cable_end='B', termination=frontport1_2), - ]) + cable3 = Cable( + a_terminations=[interface3], + b_terminations=[frontport1_2] + ) cable3.save() self.assertPathExists( (interface2, cable2, frontport1_1, rearport1, cable1, interface1), @@ -913,15 +902,15 @@ class CablePathTestCase(TestCase): ) # Create cables - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1] + ) cable1.save() - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='B', termination=rearport2), - ]) + cable2 = Cable( + a_terminations=[rearport1], + b_terminations=[rearport2] + ) cable2.save() self.assertPathExists( (interface1, cable1, frontport1, rearport1, cable2, rearport2), @@ -937,10 +926,10 @@ class CablePathTestCase(TestCase): circuittermination1 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='A') # Create cable 1 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=circuittermination1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[circuittermination1] + ) cable1.save() # Check for incomplete path @@ -965,10 +954,10 @@ class CablePathTestCase(TestCase): circuittermination1 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='A') # Create cable 1 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=circuittermination1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[circuittermination1] + ) cable1.save() # Check for partial path from interface1 @@ -987,10 +976,10 @@ class CablePathTestCase(TestCase): ) # Create cable 2 - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=circuittermination2), - CableTermination(cable_end='B', termination=interface2), - ]) + cable2 = Cable( + a_terminations=[circuittermination2], + b_terminations=[interface2] + ) cable2.save() # Check for complete path in each direction @@ -1028,10 +1017,10 @@ class CablePathTestCase(TestCase): circuittermination2 = CircuitTermination.objects.create(circuit=self.circuit, site=site2, term_side='Z') # Create cable 1 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=circuittermination1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[circuittermination1] + ) cable1.save() self.assertPathExists( (interface1, cable1, circuittermination1, circuittermination2, site2), @@ -1055,10 +1044,10 @@ class CablePathTestCase(TestCase): circuittermination2 = CircuitTermination.objects.create(circuit=self.circuit, provider_network=providernetwork, term_side='Z') # Create cable 1 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=circuittermination1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[circuittermination1] + ) cable1.save() self.assertPathExists( (interface1, cable1, circuittermination1, circuittermination2, providernetwork), @@ -1099,35 +1088,35 @@ class CablePathTestCase(TestCase): circuittermination2 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='Z') # Create cables - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1_1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1_1] + ) cable1.save() - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface2), - CableTermination(cable_end='B', termination=frontport1_2), - ]) + cable2 = Cable( + a_terminations=[interface2], + b_terminations=[frontport1_2] + ) cable2.save() - cable3 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='B', termination=circuittermination1), - ]) + cable3 = Cable( + a_terminations=[rearport1], + b_terminations=[circuittermination1] + ) cable3.save() - cable4 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport2), - CableTermination(cable_end='B', termination=circuittermination2), - ]) + cable4 = Cable( + a_terminations=[rearport2], + b_terminations=[circuittermination2] + ) cable4.save() - cable5 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface3), - CableTermination(cable_end='B', termination=frontport2_1), - ]) + cable5 = Cable( + a_terminations=[interface3], + b_terminations=[frontport2_1] + ) cable5.save() - cable6 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface4), - CableTermination(cable_end='B', termination=frontport2_2), - ]) + cable6 = Cable( + a_terminations=[interface4], + b_terminations=[frontport2_2] + ) cable6.save() self.assertPathExists( ( @@ -1196,17 +1185,15 @@ class CablePathTestCase(TestCase): ) # Create cables 1-2 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1), - CableTermination(cable_end='B', termination=frontport2), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1, frontport2] + ) cable1.save() - cable3 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface2), - CableTermination(cable_end='B', termination=frontport3), - CableTermination(cable_end='B', termination=frontport4), - ]) + cable3 = Cable( + a_terminations=[interface2], + b_terminations=[frontport3, frontport4] + ) cable3.save() self.assertPathExists( (interface1, cable1, (frontport1, frontport2), (rearport1, rearport2)), @@ -1219,12 +1206,10 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.count(), 2) # Create cable 2 - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='A', termination=rearport2), - CableTermination(cable_end='B', termination=rearport3), - CableTermination(cable_end='B', termination=rearport4), - ]) + cable2 = Cable( + a_terminations=[rearport1, rearport2], + b_terminations=[rearport3, rearport4] + ) cable2.save() path1 = self.assertPathExists( ( @@ -1292,17 +1277,15 @@ class CablePathTestCase(TestCase): ) # Create cables 1-2 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1_1), - CableTermination(cable_end='B', termination=frontport1_2), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1_1, frontport1_2] + ) cable1.save() - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface2), - CableTermination(cable_end='B', termination=frontport1_3), - CableTermination(cable_end='B', termination=frontport1_4), - ]) + cable2 = Cable( + a_terminations=[interface2], + b_terminations=[frontport1_3, frontport1_4] + ) cable2.save() self.assertPathExists( (interface1, cable1, (frontport1_1, frontport1_2), rearport1), @@ -1315,10 +1298,10 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.count(), 2) # Create cable 3 - cable3 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='B', termination=rearport2), - ]) + cable3 = Cable( + a_terminations=[rearport1], + b_terminations=[rearport2] + ) cable3.save() self.assertPathExists( (interface1, cable1, (frontport1_1, frontport1_2), rearport1, cable3, rearport2, (frontport2_1, frontport2_2)), @@ -1331,17 +1314,15 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.count(), 2) # Create cables 4-5 - cable4 = Cable(terminations=[ - CableTermination(cable_end='A', termination=frontport2_1), - CableTermination(cable_end='A', termination=frontport2_2), - CableTermination(cable_end='B', termination=interface3), - ]) + cable4 = Cable( + a_terminations=[frontport2_1, frontport2_2], + b_terminations=[interface3] + ) cable4.save() - cable5 = Cable(terminations=[ - CableTermination(cable_end='A', termination=frontport2_3), - CableTermination(cable_end='A', termination=frontport2_4), - CableTermination(cable_end='B', termination=interface4), - ]) + cable5 = Cable( + a_terminations=[frontport2_3, frontport2_4], + b_terminations=[interface4] + ) cable5.save() path1 = self.assertPathExists( (interface1, cable1, (frontport1_1, frontport1_2), rearport1, cable3, rearport2, (frontport2_1, frontport2_2), cable4, interface3), @@ -1393,20 +1374,20 @@ class CablePathTestCase(TestCase): circuittermination4 = CircuitTermination.objects.create(circuit=circuit2, site=self.site, term_side='Z') # Create cables - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=circuittermination1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[circuittermination1] + ) cable1.save() - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=circuittermination2), - CableTermination(cable_end='B', termination=circuittermination3), - ]) + cable2 = Cable( + a_terminations=[circuittermination2], + b_terminations=[circuittermination3] + ) cable2.save() - cable3 = Cable(terminations=[ - CableTermination(cable_end='A', termination=circuittermination4), - CableTermination(cable_end='B', termination=interface2), - ]) + cable3 = Cable( + a_terminations=[circuittermination4], + b_terminations=[interface2] + ) cable3.save() # Check for paths @@ -1460,18 +1441,18 @@ class CablePathTestCase(TestCase): ) # Create cable 2 - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='B', termination=rearport2), - ]) + cable2 = Cable( + a_terminations=[rearport1], + b_terminations=[rearport2] + ) cable2.save() self.assertEqual(CablePath.objects.count(), 0) # Create cable1 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1] + ) cable1.save() self.assertPathExists( (interface1, cable1, frontport1, rearport1, cable2, rearport2, frontport2), @@ -1480,10 +1461,10 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.count(), 1) # Create cable 3 - cable3 = Cable(terminations=[ - CableTermination(cable_end='A', termination=frontport2), - CableTermination(cable_end='B', termination=interface2), - ]) + cable3 = Cable( + a_terminations=[frontport2], + b_terminations=[interface2] + ) cable3.save() self.assertPathExists( (interface1, cable1, frontport1, rearport1, cable2, rearport2, frontport2, cable3, interface2), @@ -1509,15 +1490,15 @@ class CablePathTestCase(TestCase): ) # Create cables 1 and 2 - cable1 = Cable(terminations=[ - CableTermination(cable_end='A', termination=interface1), - CableTermination(cable_end='B', termination=frontport1), - ]) + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[frontport1] + ) cable1.save() - cable2 = Cable(terminations=[ - CableTermination(cable_end='A', termination=rearport1), - CableTermination(cable_end='B', termination=interface2), - ]) + cable2 = Cable( + a_terminations=[rearport1], + b_terminations=[interface2] + ) cable2.save() self.assertEqual(CablePath.objects.filter(is_active=True).count(), 2) self.assertEqual(CablePath.objects.count(), 2) From 3a461d02793e6f9d41c2b1a92647e691de1abaac Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 13 May 2022 09:33:00 -0400 Subject: [PATCH 050/593] Update Cable instantiations to match new signature --- netbox/circuits/tests/test_filtersets.py | 2 +- netbox/circuits/tests/test_views.py | 2 +- netbox/dcim/api/views.py | 2 +- netbox/dcim/tests/test_api.py | 10 +++--- netbox/dcim/tests/test_filtersets.py | 46 ++++++++++++------------ netbox/dcim/tests/test_models.py | 30 ++++++++-------- netbox/dcim/tests/test_views.py | 22 ++++++------ netbox/dcim/views.py | 2 +- netbox/wireless/signals.py | 2 +- 9 files changed, 59 insertions(+), 59 deletions(-) diff --git a/netbox/circuits/tests/test_filtersets.py b/netbox/circuits/tests/test_filtersets.py index 205236712..96a469951 100644 --- a/netbox/circuits/tests/test_filtersets.py +++ b/netbox/circuits/tests/test_filtersets.py @@ -356,7 +356,7 @@ class CircuitTerminationTestCase(TestCase, ChangeLoggedFilterSetTests): )) CircuitTermination.objects.bulk_create(circuit_terminations) - Cable(termination_a=circuit_terminations[0], termination_b=circuit_terminations[1]).save() + Cable(a_terminations=[circuit_terminations[0]], b_terminations=[circuit_terminations[1]]).save() def test_term_side(self): params = {'term_side': 'A'} diff --git a/netbox/circuits/tests/test_views.py b/netbox/circuits/tests/test_views.py index 17c846c86..968aa2f21 100644 --- a/netbox/circuits/tests/test_views.py +++ b/netbox/circuits/tests/test_views.py @@ -245,7 +245,7 @@ class CircuitTerminationTestCase( device=device, name='Interface 1' ) - Cable(termination_a=circuittermination, termination_b=interface).save() + Cable(a_terminations=[circuittermination], b_terminations=[interface]).save() response = self.client.get(reverse('circuits:circuittermination_trace', kwargs={'pk': circuittermination.pk})) self.assertHttpStatus(response, 200) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index c82c4aff2..1ee6082f0 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -93,7 +93,7 @@ class PassThroughPortMixin(object): Return all CablePaths which traverse a given pass-through port. """ obj = get_object_or_404(self.queryset, pk=pk) - cablepaths = CablePath.objects.filter(path__contains=obj).prefetch_related('origin', 'destination') + cablepaths = CablePath.objects.filter(_nodes__contains=obj).prefetch_related('origin', 'destination') serializer = serializers.CablePathSerializer(cablepaths, context={'request': request}, many=True) return Response(serializer.data) diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index 22537abe0..9855c5b6d 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -45,7 +45,7 @@ class Mixins: device=peer_device, name='Peer Termination' ) - cable = Cable(termination_a=obj, termination_b=peer_obj, label='Cable 1') + cable = Cable(termination_a=obj, b_terminations=[peer_obj], label='Cable 1') cable.save() self.add_permissions(f'dcim.view_{self.model._meta.model_name}') @@ -1879,9 +1879,9 @@ class CableTest(APIViewTestCases.APIViewTestCase): Interface.objects.bulk_create(interfaces) cables = ( - Cable(termination_a=interfaces[0], termination_b=interfaces[10], label='Cable 1'), - Cable(termination_a=interfaces[1], termination_b=interfaces[11], label='Cable 2'), - Cable(termination_a=interfaces[2], termination_b=interfaces[12], label='Cable 3'), + Cable(a_terminations=[interfaces[0]], b_terminations=[interfaces[10]], label='Cable 1'), + Cable(a_terminations=[interfaces[1]], b_terminations=[interfaces[11]], label='Cable 2'), + Cable(a_terminations=[interfaces[2]], b_terminations=[interfaces[12]], label='Cable 3'), ) for cable in cables: cable.save() @@ -1931,7 +1931,7 @@ class ConnectedDeviceTest(APITestCase): self.interface2 = Interface.objects.create(device=self.device2, name='eth0') self.interface3 = Interface.objects.create(device=self.device1, name='eth1') # Not connected - cable = Cable(termination_a=self.interface1, termination_b=self.interface2) + cable = Cable(a_terminations=[self.interface1], b_terminations=[self.interface2]) cable.save() @override_settings(EXEMPT_VIEW_PERMISSIONS=['*']) diff --git a/netbox/dcim/tests/test_filtersets.py b/netbox/dcim/tests/test_filtersets.py index 273ee6570..dab19f1e6 100644 --- a/netbox/dcim/tests/test_filtersets.py +++ b/netbox/dcim/tests/test_filtersets.py @@ -1941,8 +1941,8 @@ class ConsolePortTestCase(TestCase, ChangeLoggedFilterSetTests): ConsolePort.objects.bulk_create(console_ports) # Cables - Cable(termination_a=console_ports[0], termination_b=console_server_ports[0]).save() - Cable(termination_a=console_ports[1], termination_b=console_server_ports[1]).save() + Cable(a_terminations=[console_ports[0]], b_terminations=[console_server_ports[0]]).save() + Cable(a_terminations=[console_ports[1]], b_terminations=[console_server_ports[1]]).save() # Third port is not connected def test_name(self): @@ -2088,8 +2088,8 @@ class ConsoleServerPortTestCase(TestCase, ChangeLoggedFilterSetTests): ConsoleServerPort.objects.bulk_create(console_server_ports) # Cables - Cable(termination_a=console_server_ports[0], termination_b=console_ports[0]).save() - Cable(termination_a=console_server_ports[1], termination_b=console_ports[1]).save() + Cable(a_terminations=[console_server_ports[0]], b_terminations=[console_ports[0]]).save() + Cable(a_terminations=[console_server_ports[1]], b_terminations=[console_ports[1]]).save() # Third port is not connected def test_name(self): @@ -2235,8 +2235,8 @@ class PowerPortTestCase(TestCase, ChangeLoggedFilterSetTests): PowerPort.objects.bulk_create(power_ports) # Cables - Cable(termination_a=power_ports[0], termination_b=power_outlets[0]).save() - Cable(termination_a=power_ports[1], termination_b=power_outlets[1]).save() + Cable(a_terminations=[power_ports[0]], b_terminations=[power_outlets[0]]).save() + Cable(a_terminations=[power_ports[1]], b_terminations=[power_outlets[1]]).save() # Third port is not connected def test_name(self): @@ -2390,8 +2390,8 @@ class PowerOutletTestCase(TestCase, ChangeLoggedFilterSetTests): PowerOutlet.objects.bulk_create(power_outlets) # Cables - Cable(termination_a=power_outlets[0], termination_b=power_ports[0]).save() - Cable(termination_a=power_outlets[1], termination_b=power_ports[1]).save() + Cable(a_terminations=[power_outlets[0]], b_terminations=[power_ports[0]]).save() + Cable(a_terminations=[power_outlets[1]], b_terminations=[power_ports[1]]).save() # Third port is not connected def test_name(self): @@ -2552,8 +2552,8 @@ class InterfaceTestCase(TestCase, ChangeLoggedFilterSetTests): Interface.objects.bulk_create(interfaces) # Cables - Cable(termination_a=interfaces[0], termination_b=interfaces[3]).save() - Cable(termination_a=interfaces[1], termination_b=interfaces[4]).save() + Cable(a_terminations=[interfaces[0]], b_terminations=[interfaces[3]]).save() + Cable(a_terminations=[interfaces[1]], b_terminations=[interfaces[4]]).save() # Third pair is not connected def test_name(self): @@ -2820,8 +2820,8 @@ class FrontPortTestCase(TestCase, ChangeLoggedFilterSetTests): FrontPort.objects.bulk_create(front_ports) # Cables - Cable(termination_a=front_ports[0], termination_b=front_ports[3]).save() - Cable(termination_a=front_ports[1], termination_b=front_ports[4]).save() + Cable(a_terminations=[front_ports[0]], b_terminations=[front_ports[3]]).save() + Cable(a_terminations=[front_ports[1]], b_terminations=[front_ports[4]]).save() # Third port is not connected def test_name(self): @@ -2966,8 +2966,8 @@ class RearPortTestCase(TestCase, ChangeLoggedFilterSetTests): RearPort.objects.bulk_create(rear_ports) # Cables - Cable(termination_a=rear_ports[0], termination_b=rear_ports[3]).save() - Cable(termination_a=rear_ports[1], termination_b=rear_ports[4]).save() + Cable(a_terminations=[rear_ports[0]], b_terminations=[rear_ports[3]]).save() + Cable(a_terminations=[rear_ports[1]], b_terminations=[rear_ports[4]]).save() # Third port is not connected def test_name(self): @@ -3599,13 +3599,13 @@ class CableTestCase(TestCase, ChangeLoggedFilterSetTests): console_server_port = ConsoleServerPort.objects.create(device=devices[0], name='Console Server Port 1') # Cables - Cable(termination_a=interfaces[1], termination_b=interfaces[2], label='Cable 1', type=CableTypeChoices.TYPE_CAT3, tenant=tenants[0], status=LinkStatusChoices.STATUS_CONNECTED, color='aa1409', length=10, length_unit=CableLengthUnitChoices.UNIT_FOOT).save() - Cable(termination_a=interfaces[3], termination_b=interfaces[4], label='Cable 2', type=CableTypeChoices.TYPE_CAT3, tenant=tenants[0], status=LinkStatusChoices.STATUS_CONNECTED, color='aa1409', length=20, length_unit=CableLengthUnitChoices.UNIT_FOOT).save() - Cable(termination_a=interfaces[5], termination_b=interfaces[6], label='Cable 3', type=CableTypeChoices.TYPE_CAT5E, tenant=tenants[1], status=LinkStatusChoices.STATUS_CONNECTED, color='f44336', length=30, length_unit=CableLengthUnitChoices.UNIT_FOOT).save() - Cable(termination_a=interfaces[7], termination_b=interfaces[8], label='Cable 4', type=CableTypeChoices.TYPE_CAT5E, tenant=tenants[1], status=LinkStatusChoices.STATUS_PLANNED, color='f44336', length=40, length_unit=CableLengthUnitChoices.UNIT_FOOT).save() - Cable(termination_a=interfaces[9], termination_b=interfaces[10], label='Cable 5', type=CableTypeChoices.TYPE_CAT6, tenant=tenants[2], status=LinkStatusChoices.STATUS_PLANNED, color='e91e63', length=10, length_unit=CableLengthUnitChoices.UNIT_METER).save() - Cable(termination_a=interfaces[11], termination_b=interfaces[0], label='Cable 6', type=CableTypeChoices.TYPE_CAT6, tenant=tenants[2], status=LinkStatusChoices.STATUS_PLANNED, color='e91e63', length=20, length_unit=CableLengthUnitChoices.UNIT_METER).save() - Cable(termination_a=console_port, termination_b=console_server_port, label='Cable 7').save() + Cable(a_terminations=[interfaces[1]], b_terminations=[interfaces[2]], label='Cable 1', type=CableTypeChoices.TYPE_CAT3, tenant=tenants[0], status=LinkStatusChoices.STATUS_CONNECTED, color='aa1409', length=10, length_unit=CableLengthUnitChoices.UNIT_FOOT).save() + Cable(a_terminations=[interfaces[3]], b_terminations=[interfaces[4]], label='Cable 2', type=CableTypeChoices.TYPE_CAT3, tenant=tenants[0], status=LinkStatusChoices.STATUS_CONNECTED, color='aa1409', length=20, length_unit=CableLengthUnitChoices.UNIT_FOOT).save() + Cable(a_terminations=[interfaces[5]], b_terminations=[interfaces[6]], label='Cable 3', type=CableTypeChoices.TYPE_CAT5E, tenant=tenants[1], status=LinkStatusChoices.STATUS_CONNECTED, color='f44336', length=30, length_unit=CableLengthUnitChoices.UNIT_FOOT).save() + Cable(a_terminations=[interfaces[7]], b_terminations=[interfaces[8]], label='Cable 4', type=CableTypeChoices.TYPE_CAT5E, tenant=tenants[1], status=LinkStatusChoices.STATUS_PLANNED, color='f44336', length=40, length_unit=CableLengthUnitChoices.UNIT_FOOT).save() + Cable(a_terminations=[interfaces[9]], b_terminations=[interfaces[10]], label='Cable 5', type=CableTypeChoices.TYPE_CAT6, tenant=tenants[2], status=LinkStatusChoices.STATUS_PLANNED, color='e91e63', length=10, length_unit=CableLengthUnitChoices.UNIT_METER).save() + Cable(a_terminations=[interfaces[11]], b_terminations=[interfaces[0]], label='Cable 6', type=CableTypeChoices.TYPE_CAT6, tenant=tenants[2], status=LinkStatusChoices.STATUS_PLANNED, color='e91e63', length=20, length_unit=CableLengthUnitChoices.UNIT_METER).save() + Cable(a_terminations=[console_port], b_terminations=[console_server_port], label='Cable 7').save() def test_label(self): params = {'label': ['Cable 1', 'Cable 2']} @@ -3812,8 +3812,8 @@ class PowerFeedTestCase(TestCase, ChangeLoggedFilterSetTests): PowerPort(device=device, name='Power Port 2'), ] PowerPort.objects.bulk_create(power_ports) - Cable(termination_a=power_feeds[0], termination_b=power_ports[0]).save() - Cable(termination_a=power_feeds[1], termination_b=power_ports[1]).save() + Cable(a_terminations=[power_feeds[0]], b_terminations=[power_ports[0]]).save() + Cable(a_terminations=[power_feeds[1]], b_terminations=[power_ports[1]]).save() def test_name(self): params = {'name': ['Power Feed 1', 'Power Feed 2']} diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index 8566f969b..5a57852c4 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -465,7 +465,7 @@ class CableTestCase(TestCase): self.interface1 = Interface.objects.create(device=self.device1, name='eth0') self.interface2 = Interface.objects.create(device=self.device2, name='eth0') self.interface3 = Interface.objects.create(device=self.device2, name='eth1') - self.cable = Cable(termination_a=self.interface1, termination_b=self.interface2) + self.cable = Cable(a_terminations=[self.interface1], b_terminations=[self.interface2]) self.cable.save() self.power_port1 = PowerPort.objects.create(device=self.device2, name='psu1') @@ -536,7 +536,7 @@ class CableTestCase(TestCase): The clean method should have a check to ensure only compatible port types can be connected by a cable """ # An interface cannot be connected to a power port - cable = Cable(termination_a=self.interface1, termination_b=self.power_port1) + cable = Cable(a_terminations=[self.interface1], b_terminations=[self.power_port1]) with self.assertRaises(ValidationError): cable.clean() @@ -544,7 +544,7 @@ class CableTestCase(TestCase): """ A cable cannot be made with the same A and B side terminations """ - cable = Cable(termination_a=self.interface1, termination_b=self.interface1) + cable = Cable(a_terminations=[self.interface1], b_terminations=[self.interface1]) with self.assertRaises(ValidationError): cable.clean() @@ -552,7 +552,7 @@ class CableTestCase(TestCase): """ A cable cannot connect a front port to its corresponding rear port """ - cable = Cable(termination_a=self.front_port1, termination_b=self.rear_port1) + cable = Cable(a_terminations=[self.front_port1], b_terminations=[self.rear_port1]) with self.assertRaises(ValidationError): cable.clean() @@ -561,7 +561,7 @@ class CableTestCase(TestCase): Either side of a cable cannot be terminated when that side already has a connection """ # Try to create a cable with the same interface terminations - cable = Cable(termination_a=self.interface2, termination_b=self.interface1) + cable = Cable(a_terminations=[self.interface2], b_terminations=[self.interface1]) with self.assertRaises(ValidationError): cable.clean() @@ -569,7 +569,7 @@ class CableTestCase(TestCase): """ Neither side of a cable can be terminated to a CircuitTermination which is attached to a ProviderNetwork """ - cable = Cable(termination_a=self.interface3, termination_b=self.circuittermination3) + cable = Cable(a_terminations=[self.interface3], b_terminations=[self.circuittermination3]) with self.assertRaises(ValidationError): cable.clean() @@ -578,36 +578,36 @@ class CableTestCase(TestCase): Test various combinations of RearPort connections. """ # Connecting a single-position RearPort to a multi-position RearPort is ok - Cable(termination_a=self.rear_port1, termination_b=self.rear_port2).full_clean() + Cable(a_terminations=[self.rear_port1], b_terminations=[self.rear_port2]).full_clean() # Connecting a single-position RearPort to an Interface is ok - Cable(termination_a=self.rear_port1, termination_b=self.interface3).full_clean() + Cable(a_terminations=[self.rear_port1], b_terminations=[self.interface3]).full_clean() # Connecting a single-position RearPort to a CircuitTermination is ok - Cable(termination_a=self.rear_port1, termination_b=self.circuittermination1).full_clean() + Cable(a_terminations=[self.rear_port1], b_terminations=[self.circuittermination1]).full_clean() # Connecting a multi-position RearPort to another RearPort with the same number of positions is ok - Cable(termination_a=self.rear_port3, termination_b=self.rear_port4).full_clean() + Cable(a_terminations=[self.rear_port3], b_terminations=[self.rear_port4]).full_clean() # Connecting a multi-position RearPort to an Interface is ok - Cable(termination_a=self.rear_port2, termination_b=self.interface3).full_clean() + Cable(a_terminations=[self.rear_port2], b_terminations=[self.interface3]).full_clean() # Connecting a multi-position RearPort to a CircuitTermination is ok - Cable(termination_a=self.rear_port2, termination_b=self.circuittermination1).full_clean() + Cable(a_terminations=[self.rear_port2], b_terminations=[self.circuittermination1]).full_clean() # Connecting a two-position RearPort to a three-position RearPort is NOT ok with self.assertRaises( ValidationError, msg='Connecting a 2-position RearPort to a 3-position RearPort should fail' ): - Cable(termination_a=self.rear_port2, termination_b=self.rear_port3).full_clean() + Cable(a_terminations=[self.rear_port2], b_terminations=[self.rear_port3]).full_clean() def test_cable_cannot_terminate_to_a_virtual_interface(self): """ A cable cannot terminate to a virtual interface """ virtual_interface = Interface(device=self.device1, name="V1", type=InterfaceTypeChoices.TYPE_VIRTUAL) - cable = Cable(termination_a=self.interface2, termination_b=virtual_interface) + cable = Cable(a_terminations=[self.interface2], b_terminations=[virtual_interface]) with self.assertRaises(ValidationError): cable.clean() @@ -616,6 +616,6 @@ class CableTestCase(TestCase): A cable cannot terminate to a wireless interface """ wireless_interface = Interface(device=self.device1, name="W1", type=InterfaceTypeChoices.TYPE_80211A) - cable = Cable(termination_a=self.interface2, termination_b=wireless_interface) + cable = Cable(a_terminations=[self.interface2], b_terminations=[wireless_interface]) with self.assertRaises(ValidationError): cable.clean() diff --git a/netbox/dcim/tests/test_views.py b/netbox/dcim/tests/test_views.py index e17f94682..389e23457 100644 --- a/netbox/dcim/tests/test_views.py +++ b/netbox/dcim/tests/test_views.py @@ -1960,7 +1960,7 @@ class ConsolePortTestCase(ViewTestCases.DeviceComponentViewTestCase): device=consoleport.device, name='Console Server Port 1' ) - Cable(termination_a=consoleport, termination_b=consoleserverport).save() + Cable(a_terminations=[consoleport], b_terminations=[consoleserverport]).save() response = self.client.get(reverse('dcim:consoleport_trace', kwargs={'pk': consoleport.pk})) self.assertHttpStatus(response, 200) @@ -2016,7 +2016,7 @@ class ConsoleServerPortTestCase(ViewTestCases.DeviceComponentViewTestCase): device=consoleserverport.device, name='Console Port 1' ) - Cable(termination_a=consoleserverport, termination_b=consoleport).save() + Cable(a_terminations=[consoleserverport], b_terminations=[consoleport]).save() response = self.client.get(reverse('dcim:consoleserverport_trace', kwargs={'pk': consoleserverport.pk})) self.assertHttpStatus(response, 200) @@ -2078,7 +2078,7 @@ class PowerPortTestCase(ViewTestCases.DeviceComponentViewTestCase): device=powerport.device, name='Power Outlet 1' ) - Cable(termination_a=powerport, termination_b=poweroutlet).save() + Cable(a_terminations=[powerport], b_terminations=[poweroutlet]).save() response = self.client.get(reverse('dcim:powerport_trace', kwargs={'pk': powerport.pk})) self.assertHttpStatus(response, 200) @@ -2143,7 +2143,7 @@ class PowerOutletTestCase(ViewTestCases.DeviceComponentViewTestCase): def test_trace(self): poweroutlet = PowerOutlet.objects.first() powerport = PowerPort.objects.first() - Cable(termination_a=poweroutlet, termination_b=powerport).save() + Cable(a_terminations=[poweroutlet], b_terminations=[powerport]).save() response = self.client.get(reverse('dcim:poweroutlet_trace', kwargs={'pk': poweroutlet.pk})) self.assertHttpStatus(response, 200) @@ -2261,7 +2261,7 @@ class InterfaceTestCase(ViewTestCases.DeviceComponentViewTestCase): @override_settings(EXEMPT_VIEW_PERMISSIONS=['*']) def test_trace(self): interface1, interface2 = Interface.objects.all()[:2] - Cable(termination_a=interface1, termination_b=interface2).save() + Cable(a_terminations=[interface1], b_terminations=[interface2]).save() response = self.client.get(reverse('dcim:interface_trace', kwargs={'pk': interface1.pk})) self.assertHttpStatus(response, 200) @@ -2332,7 +2332,7 @@ class FrontPortTestCase(ViewTestCases.DeviceComponentViewTestCase): device=frontport.device, name='Interface 1' ) - Cable(termination_a=frontport, termination_b=interface).save() + Cable(a_terminations=[frontport], b_terminations=[interface]).save() response = self.client.get(reverse('dcim:frontport_trace', kwargs={'pk': frontport.pk})) self.assertHttpStatus(response, 200) @@ -2390,7 +2390,7 @@ class RearPortTestCase(ViewTestCases.DeviceComponentViewTestCase): device=rearport.device, name='Interface 1' ) - Cable(termination_a=rearport, termination_b=interface).save() + Cable(a_terminations=[rearport], b_terminations=[interface]).save() response = self.client.get(reverse('dcim:rearport_trace', kwargs={'pk': rearport.pk})) self.assertHttpStatus(response, 200) @@ -2623,9 +2623,9 @@ class CableTestCase( ) Interface.objects.bulk_create(interfaces) - Cable(termination_a=interfaces[0], termination_b=interfaces[3], type=CableTypeChoices.TYPE_CAT6).save() - Cable(termination_a=interfaces[1], termination_b=interfaces[4], type=CableTypeChoices.TYPE_CAT6).save() - Cable(termination_a=interfaces[2], termination_b=interfaces[5], type=CableTypeChoices.TYPE_CAT6).save() + Cable(a_terminations=[interfaces[0]], b_terminations=[interfaces[3]], type=CableTypeChoices.TYPE_CAT6).save() + Cable(a_terminations=[interfaces[1]], b_terminations=[interfaces[4]], type=CableTypeChoices.TYPE_CAT6).save() + Cable(a_terminations=[interfaces[2]], b_terminations=[interfaces[5]], type=CableTypeChoices.TYPE_CAT6).save() tags = create_tags('Alpha', 'Bravo', 'Charlie') @@ -2857,7 +2857,7 @@ class PowerFeedTestCase(ViewTestCases.PrimaryObjectViewTestCase): device=device, name='Power Port 1' ) - Cable(termination_a=powerfeed, termination_b=powerport).save() + Cable(a_terminations=[powerfeed], b_terminations=[powerport]).save() response = self.client.get(reverse('dcim:powerfeed_trace', kwargs={'pk': powerfeed.pk})) self.assertHttpStatus(response, 200) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 5824e8186..96f72b309 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2771,7 +2771,7 @@ class PathTraceView(generic.ObjectView): # Otherwise, find all CablePaths which traverse the specified object else: - related_paths = CablePath.objects.filter(path__contains=instance).prefetch_related('origin') + related_paths = CablePath.objects.filter(_nodes__contains=instance).prefetch_related('origin') # Check for specification of a particular path (when tracing pass-through ports) try: path_id = int(request.GET.get('cablepath_id')) diff --git a/netbox/wireless/signals.py b/netbox/wireless/signals.py index 3b4831a8d..a5903cfdb 100644 --- a/netbox/wireless/signals.py +++ b/netbox/wireless/signals.py @@ -62,5 +62,5 @@ def nullify_connected_interfaces(instance, **kwargs): ) # Delete and retrace any dependent cable paths - for cablepath in CablePath.objects.filter(path__contains=instance): + for cablepath in CablePath.objects.filter(_nodes__contains=instance): cablepath.delete() From 4c51dbba809b6b199a96da30f32f4dd3cd6ea6ed Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 13 May 2022 11:04:38 -0400 Subject: [PATCH 051/593] Update connected_endpoint serializer field to support multiple objects --- netbox/dcim/api/serializers.py | 100 ++++++++++++++++-------- netbox/dcim/api/views.py | 2 +- netbox/dcim/models/device_components.py | 8 +- netbox/dcim/tests/test_api.py | 2 +- netbox/dcim/views.py | 2 +- 5 files changed, 73 insertions(+), 41 deletions(-) diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index cc218c61c..f84ceacae 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -51,32 +51,64 @@ class LinkTerminationSerializer(serializers.ModelSerializer): return obj._occupied -class ConnectedEndpointSerializer(serializers.ModelSerializer): - connected_endpoint_type = serializers.SerializerMethodField(read_only=True) - connected_endpoint = serializers.SerializerMethodField(read_only=True) - connected_endpoint_reachable = serializers.SerializerMethodField(read_only=True) +# class ConnectedEndpointSerializer(serializers.ModelSerializer): +# """ +# Legacy serializer for pre-v3.3 connections +# """ +# connected_endpoint_type = serializers.SerializerMethodField(read_only=True) +# connected_endpoint = serializers.SerializerMethodField(read_only=True) +# connected_endpoint_reachable = serializers.SerializerMethodField(read_only=True) +# +# def get_connected_endpoint_type(self, obj): +# if obj._path is not None and obj._path.destination is not None: +# return f'{obj._path.destination._meta.app_label}.{obj._path.destination._meta.model_name}' +# return None +# +# @swagger_serializer_method(serializer_or_field=serializers.DictField) +# def get_connected_endpoint(self, obj): +# """ +# Return the appropriate serializer for the type of connected object. +# """ +# if obj._path is not None and obj._path.destination is not None: +# serializer = get_serializer_for_model(obj._path.destination, prefix='Nested') +# context = {'request': self.context['request']} +# return serializer(obj._path.destination, context=context).data +# return None +# +# @swagger_serializer_method(serializer_or_field=serializers.BooleanField) +# def get_connected_endpoint_reachable(self, obj): +# if obj._path is not None: +# return obj._path.is_active +# return None - def get_connected_endpoint_type(self, obj): - if obj._path is not None and obj._path.destination is not None: - return f'{obj._path.destination._meta.app_label}.{obj._path.destination._meta.model_name}' - return None + +class ConnectedEndpointsSerializer(serializers.ModelSerializer): + """ + Legacy serializer for pre-v3.3 connections + """ + connected_endpoints_type = serializers.SerializerMethodField(read_only=True) + connected_endpoints = serializers.SerializerMethodField(read_only=True) + connected_endpoints_reachable = serializers.SerializerMethodField(read_only=True) + + def get_connected_endpoints_type(self, obj): + endpoints = obj.connected_endpoints + if endpoints: + return f'{endpoints[0]._meta.app_label}.{endpoints[0]._meta.model_name}' @swagger_serializer_method(serializer_or_field=serializers.DictField) - def get_connected_endpoint(self, obj): + def get_connected_endpoints(self, obj): """ Return the appropriate serializer for the type of connected object. """ - if obj._path is not None and obj._path.destination is not None: - serializer = get_serializer_for_model(obj._path.destination, prefix='Nested') + endpoints = obj.connected_endpoints + if endpoints: + serializer = get_serializer_for_model(endpoints[0], prefix='Nested') context = {'request': self.context['request']} - return serializer(obj._path.destination, context=context).data - return None + return serializer(endpoints, many=True, context=context).data @swagger_serializer_method(serializer_or_field=serializers.BooleanField) - def get_connected_endpoint_reachable(self, obj): - if obj._path is not None: - return obj._path.is_active - return None + def get_connected_endpoints_reachable(self, obj): + return obj._path and obj._path.is_complete and obj._path.is_active # @@ -659,7 +691,7 @@ class DeviceNAPALMSerializer(serializers.Serializer): # Device components # -class ConsoleServerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointSerializer): +class ConsoleServerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:consoleserverport-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -682,12 +714,12 @@ class ConsoleServerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializ model = ConsoleServerPort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'speed', 'description', - 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoint', 'connected_endpoint_type', - 'connected_endpoint_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', + 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoints', 'connected_endpoints_type', + 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] -class ConsolePortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointSerializer): +class ConsolePortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:consoleport-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -710,12 +742,12 @@ class ConsolePortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Co model = ConsolePort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'speed', 'description', - 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoint', 'connected_endpoint_type', - 'connected_endpoint_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', + 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoints', 'connected_endpoints_type', + 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] -class PowerOutletSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointSerializer): +class PowerOutletSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:poweroutlet-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -744,13 +776,13 @@ class PowerOutletSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Co model = PowerOutlet fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'power_port', 'feed_leg', - 'description', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoint', - 'connected_endpoint_type', 'connected_endpoint_reachable', 'tags', 'custom_fields', 'created', + 'description', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoints', + 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] -class PowerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointSerializer): +class PowerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:powerport-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -768,13 +800,13 @@ class PowerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn model = PowerPort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'maximum_draw', 'allocated_draw', - 'description', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoint', - 'connected_endpoint_type', 'connected_endpoint_reachable', 'tags', 'custom_fields', 'created', + 'description', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoints', + 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] -class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointSerializer): +class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:interface-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -814,8 +846,8 @@ class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'enabled', 'parent', 'bridge', 'lag', 'mtu', 'mac_address', 'speed', 'duplex', 'wwn', 'mgmt_only', 'description', 'mode', 'rf_role', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'untagged_vlan', 'tagged_vlans', 'mark_connected', - 'cable', 'wireless_link', 'link_peer', 'link_peer_type', 'wireless_lans', 'vrf', 'connected_endpoint', - 'connected_endpoint_type', 'connected_endpoint_reachable', 'tags', 'custom_fields', 'created', + 'cable', 'wireless_link', 'link_peer', 'link_peer_type', 'wireless_lans', 'vrf', 'connected_endpoints', + 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', 'count_ipaddresses', 'count_fhrp_groups', '_occupied', ] @@ -1092,7 +1124,7 @@ class PowerPanelSerializer(NetBoxModelSerializer): ] -class PowerFeedSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointSerializer): +class PowerFeedSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:powerfeed-detail') power_panel = NestedPowerPanelSerializer() rack = NestedRackSerializer( @@ -1123,6 +1155,6 @@ class PowerFeedSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn fields = [ 'id', 'url', 'display', 'power_panel', 'rack', 'name', 'status', 'type', 'supply', 'phase', 'voltage', 'amperage', 'max_utilization', 'comments', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', - 'connected_endpoint', 'connected_endpoint_type', 'connected_endpoint_reachable', 'tags', 'custom_fields', + 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 1ee6082f0..fd5bf13c2 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -93,7 +93,7 @@ class PassThroughPortMixin(object): Return all CablePaths which traverse a given pass-through port. """ obj = get_object_or_404(self.queryset, pk=pk) - cablepaths = CablePath.objects.filter(_nodes__contains=obj).prefetch_related('origin', 'destination') + cablepaths = CablePath.objects.filter(_nodes__contains=obj) serializer = serializers.CablePathSerializer(cablepaths, context={'request': request}, many=True) return Response(serializer.data) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index ec82e6606..92c8dc09f 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -224,13 +224,13 @@ class PathEndpoint(models.Model): return self._path @property - def connected_endpoint(self): + def connected_endpoints(self): """ Caching accessor for the attached CablePath's destination (if any) """ - if not hasattr(self, '_connected_endpoint'): - self._connected_endpoint = self._path.get_destination() - return self._connected_endpoint + if not hasattr(self, '_connected_endpoints'): + self._connected_endpoints = self._path.get_destination() if self._path else [] + return self._connected_endpoints # diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index 9855c5b6d..aaad18577 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -45,7 +45,7 @@ class Mixins: device=peer_device, name='Peer Termination' ) - cable = Cable(termination_a=obj, b_terminations=[peer_obj], label='Cable 1') + cable = Cable(a_terminations=[obj], b_terminations=[peer_obj], label='Cable 1') cable.save() self.add_permissions(f'dcim.view_{self.model._meta.model_name}') diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 96f72b309..0c7f38a4c 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2771,7 +2771,7 @@ class PathTraceView(generic.ObjectView): # Otherwise, find all CablePaths which traverse the specified object else: - related_paths = CablePath.objects.filter(_nodes__contains=instance).prefetch_related('origin') + related_paths = CablePath.objects.filter(_nodes__contains=instance) # Check for specification of a particular path (when tracing pass-through ports) try: path_id = int(request.GET.get('cablepath_id')) From 3082c76ec67353b15df84579c83aa46174c4e7c4 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 13 May 2022 14:37:20 -0400 Subject: [PATCH 052/593] Update object trace() method --- netbox/dcim/models/device_components.py | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 92c8dc09f..546f82a6b 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -194,20 +194,22 @@ class PathEndpoint(models.Model): origin = self path = [] - # Construct the complete path + # Construct the complete path (including e.g. bridged interfaces) while origin is not None: if origin._path is None: break - path.extend([origin, *origin._path.get_path()]) - while (len(path) + 1) % 3: + path.extend(*origin._path.get_path()) + while (len(path)) % 3: # Pad to ensure we have complete three-tuples (e.g. for paths that end at a non-connected FrontPort) - path.append(None) - path.append(origin._path.destination) + # by inserting empty entries immediately prior to the path's destination node(s) + path.insert(-1, [None]) - # Check for bridge interface to continue the trace - origin = getattr(origin._path.destination, 'bridge', None) + # TODO: Add bridging support + # # Check for bridge interface to continue the trace + # origin = getattr(origin._path.destination, 'bridge', None) + origin = None # Return the path as a list of three-tuples (A termination, cable, B termination) return list(zip(*[iter(path)] * 3)) From 6ff2e55ce408f0f7f2fe99129048421c25ecafe6 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 13 May 2022 15:05:38 -0400 Subject: [PATCH 053/593] Add origins, destinations properties on CablePath --- netbox/dcim/api/serializers.py | 2 +- netbox/dcim/models/cables.py | 72 +++++++++++++++++-------- netbox/dcim/models/device_components.py | 4 +- netbox/dcim/utils.py | 3 +- 4 files changed, 53 insertions(+), 28 deletions(-) diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index f84ceacae..f6fa4af7b 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -1078,7 +1078,7 @@ class CablePathSerializer(serializers.ModelSerializer): @swagger_serializer_method(serializer_or_field=serializers.ListField) def get_path(self, obj): ret = [] - for node in obj.get_path(): + for node in obj.path_objects(): serializer = get_serializer_for_model(node, prefix='Nested') context = {'request': self.context['request']} ret.append(serializer(node, context=context).data) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 5baa767be..372bf7655 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -324,11 +324,55 @@ class CablePath(models.Model): super().save(*args, **kwargs) # Record a direct reference to this CablePath on its originating object(s) - origins = [path_node_to_object(n) for n in self.path[0]] - origin_model = origins[0]._meta.model - origin_ids = [o.id for o in origins] + origin_model = self.origins[0]._meta.model + origin_ids = [o.id for o in self.origins] origin_model.objects.filter(pk__in=origin_ids).update(_path=self.pk) + @property + def origin_type(self): + ct_id, _ = decompile_path_node(self.path[0][0]) + return ContentType.objects.get_for_id(ct_id) + + @property + def destination_type(self): + if not self.is_complete: + return None + ct_id, _ = decompile_path_node(self.path[-1][0]) + return ContentType.objects.get_for_id(ct_id) + + @property + def path_objects(self): + """ + Cache and return the complete path as lists of objects, derived from their annotation within the path. + """ + if not hasattr(self, '_path_objects'): + self._path_objects = self._get_path() + return self._path_objects + + @property + def origins(self): + """ + Return the list of originating objects (from cache, if available). + """ + if hasattr(self, '_path_objects'): + return self.path_objects[0] + return [ + path_node_to_object(node) for node in self.path[0] + ] + + @property + def destinations(self): + """ + Return the list of destination objects (from cache, if available), if the path is complete. + """ + if not self.is_complete: + return [] + if hasattr(self, '_path_objects'): + return self.path_objects[-1] + return [ + path_node_to_object(node) for node in self.path[-1] + ] + @property def segment_count(self): return int(len(self.path) / 3) @@ -474,9 +518,7 @@ class CablePath(models.Model): """ Retrace the path from the currently-defined originating termination(s) """ - _new = self.from_origin([ - path_node_to_object(node) for node in self.path[0] - ]) + _new = self.from_origin(self.origins) if _new: self.path = _new.path self.is_complete = _new.is_complete @@ -486,7 +528,7 @@ class CablePath(models.Model): else: self.delete() - def get_path(self): + def _get_path(self): """ Return the path as a list of prefetched objects. """ @@ -518,22 +560,6 @@ class CablePath(models.Model): return path - def get_destination(self): - if not self.is_complete: - return None - return [ - path_node_to_object(node) for node in self.path[-1] - ] - - @property - def last_nodes(self): - """ - Return either the destination or the last node within the path. - """ - return [ - path_node_to_object(node) for node in self.path[-1] - ] - def get_cable_ids(self): """ Return all Cable IDs within the path. diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 546f82a6b..9bc444203 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -200,7 +200,7 @@ class PathEndpoint(models.Model): if origin._path is None: break - path.extend(*origin._path.get_path()) + path.extend(origin._path.path_objects) while (len(path)) % 3: # Pad to ensure we have complete three-tuples (e.g. for paths that end at a non-connected FrontPort) # by inserting empty entries immediately prior to the path's destination node(s) @@ -231,7 +231,7 @@ class PathEndpoint(models.Model): Caching accessor for the attached CablePath's destination (if any) """ if not hasattr(self, '_connected_endpoints'): - self._connected_endpoints = self._path.get_destination() if self._path else [] + self._connected_endpoints = self._path.destinations if self._path else [] return self._connected_endpoints diff --git a/netbox/dcim/utils.py b/netbox/dcim/utils.py index 0ea5f4580..e773dacc0 100644 --- a/netbox/dcim/utils.py +++ b/netbox/dcim/utils.py @@ -64,5 +64,4 @@ def rebuild_paths(terminations): with transaction.atomic(): for cp in cable_paths: cp.delete() - origins = [path_node_to_object(node) for node in cp.path[0]] - create_cablepath(origins) + create_cablepath(cp.origins) From 951627093c11584ffb73ad2be2aef40a91a90934 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 13 May 2022 15:34:01 -0400 Subject: [PATCH 054/593] Test cleanup --- netbox/dcim/management/commands/trace_paths.py | 2 +- netbox/dcim/views.py | 4 ++-- netbox/wireless/signals.py | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/netbox/dcim/management/commands/trace_paths.py b/netbox/dcim/management/commands/trace_paths.py index d0cd64486..4bb81bfd4 100644 --- a/netbox/dcim/management/commands/trace_paths.py +++ b/netbox/dcim/management/commands/trace_paths.py @@ -81,7 +81,7 @@ class Command(BaseCommand): self.stdout.write(f'Retracing {origins_count} cabled {model._meta.verbose_name_plural}...') i = 0 for i, obj in enumerate(origins, start=1): - create_cablepath(obj) + create_cablepath([obj]) if not i % 100: self.draw_progress_bar(i * 100 / origins_count) self.draw_progress_bar(100) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 0c7f38a4c..595b8febe 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2792,8 +2792,8 @@ class PathTraceView(generic.ObjectView): total_length, is_definitive = path.get_total_length() if path else (None, False) # Determine the path to the SVG trace image - api_viewname = f"{path.origin._meta.app_label}-api:{path.origin._meta.model_name}-trace" - svg_url = f"{reverse(api_viewname, kwargs={'pk': path.origin.pk})}?render=svg" + api_viewname = f"{path.origin_type.app_label}-api:{path.origin_type.model}-trace" + svg_url = f"{reverse(api_viewname, kwargs={'pk': path.origins[0].pk})}?render=svg" return { 'path': path, diff --git a/netbox/wireless/signals.py b/netbox/wireless/signals.py index a5903cfdb..015428807 100644 --- a/netbox/wireless/signals.py +++ b/netbox/wireless/signals.py @@ -36,7 +36,7 @@ def update_connected_interfaces(instance, created, raw=False, **kwargs): # Create/update cable paths if created: for interface in (instance.interface_a, instance.interface_b): - create_cablepath(interface) + create_cablepath([interface]) @receiver(post_delete, sender=WirelessLink) From 1b593384e597d7f60077e27d0777317fac6215fa Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 13 May 2022 15:45:58 -0400 Subject: [PATCH 055/593] Restore reverse relation to CableTerminations from Cable --- netbox/dcim/forms/connections.py | 2 +- netbox/dcim/migrations/0154_cabletermination.py | 2 +- netbox/dcim/models/cables.py | 8 +++----- netbox/dcim/signals.py | 4 ++-- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index ef796ea64..7058c01d6 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -47,7 +47,7 @@ class BaseCableConnectionForm(TenancyForm, NetBoxModelForm): for ct in terminations: ct.save() else: - instance.terminations = [ + instance._terminations = [ *self.cleaned_data['a_terminations'], *self.cleaned_data['b_terminations'], ] diff --git a/netbox/dcim/migrations/0154_cabletermination.py b/netbox/dcim/migrations/0154_cabletermination.py index b8bbd5101..5a3a335fe 100644 --- a/netbox/dcim/migrations/0154_cabletermination.py +++ b/netbox/dcim/migrations/0154_cabletermination.py @@ -16,7 +16,7 @@ class Migration(migrations.Migration): ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), ('cable_end', models.CharField(max_length=1)), ('termination_id', models.PositiveBigIntegerField()), - ('cable', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='+', to='dcim.cable')), + ('cable', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='terminations', to='dcim.cable')), ('termination_type', models.ForeignKey(limit_choices_to=models.Q(models.Q(models.Q(('app_label', 'circuits'), ('model__in', ('circuittermination',))), models.Q(('app_label', 'dcim'), ('model__in', ('consoleport', 'consoleserverport', 'frontport', 'interface', 'powerfeed', 'poweroutlet', 'powerport', 'rearport'))), _connector='OR')), on_delete=django.db.models.deletion.PROTECT, related_name='+', to='contenttypes.contenttype')), ], options={ diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 372bf7655..8090258f4 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -117,9 +117,9 @@ class Cable(NetBoxModel): ]) if terminations: assert self.pk is None - self.terminations = terminations + self._terminations = terminations else: - self.terminations = [] + self._terminations = [] @classmethod def from_db(cls, db, field_names, values): @@ -128,8 +128,6 @@ class Cable(NetBoxModel): """ instance = super().from_db(db, field_names, values) - instance.terminations = CableTermination.objects.filter(cable=instance) - # instance._orig_termination_a_type_id = instance.termination_a_type_id # instance._orig_termination_a_ids = instance.termination_a_ids # instance._orig_termination_b_type_id = instance.termination_b_type_id @@ -205,7 +203,7 @@ class CableTermination(models.Model): cable = models.ForeignKey( to='dcim.Cable', on_delete=models.CASCADE, - related_name='+' + related_name='terminations' ) cable_end = models.CharField( max_length=1, diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 30e3b6ed0..48fb2f25c 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -82,13 +82,13 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): # Save any new CableTerminations CableTermination.objects.bulk_create([ - term for term in instance.terminations if not term.pk + term for term in instance._terminations if not term.pk ]) # Split terminations into A/B sets and save link assignments # TODO: Update link peers _terms = defaultdict(list) - for t in instance.terminations: + for t in instance._terminations: if t.termination.cable != instance: t.termination.cable = instance t.termination.save() From 906c3dca8b63dfa9c3ec459346d20e74da3e062c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 13 May 2022 16:23:44 -0400 Subject: [PATCH 056/593] Tests cleanup --- netbox/dcim/api/views.py | 16 ++++++++-------- netbox/dcim/tables/cables.py | 14 ++++++++------ netbox/dcim/tests/test_api.py | 4 ++-- netbox/dcim/tests/test_filtersets.py | 5 ++++- netbox/dcim/tests/test_models.py | 10 ++++------ netbox/dcim/views.py | 4 ++-- 6 files changed, 28 insertions(+), 25 deletions(-) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index fd5bf13c2..874d0bb09 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -68,15 +68,15 @@ class PathEndpointMixin(object): break # Serialize each object - serializer_a = get_serializer_for_model(near_end, prefix='Nested') - x = serializer_a(near_end, context={'request': request}).data + serializer_a = get_serializer_for_model(near_end[0], prefix='Nested') + x = serializer_a(near_end, many=True, context={'request': request}).data if cable is not None: - y = serializers.TracedCableSerializer(cable, context={'request': request}).data + y = serializers.TracedCableSerializer(cable[0], context={'request': request}).data else: y = None if far_end is not None: - serializer_b = get_serializer_for_model(far_end, prefix='Nested') - z = serializer_b(far_end, context={'request': request}).data + serializer_b = get_serializer_for_model(far_end[0], prefix='Nested') + z = serializer_b(far_end, many=True, context={'request': request}).data else: z = None @@ -745,13 +745,13 @@ class ConnectedDeviceViewSet(ViewSet): device=peer_device, name=peer_interface_name ) - endpoint = peer_interface.connected_endpoint + endpoints = peer_interface.connected_endpoints # If an Interface, return the parent device - if type(endpoint) is Interface: + if endpoints and type(endpoints[0]) is Interface: device = get_object_or_404( Device.objects.restrict(request.user, 'view'), - pk=endpoint.device_id + pk=endpoints[0].device_id ) return Response(serializers.DeviceSerializer(device, context={'request': request}).data) diff --git a/netbox/dcim/tables/cables.py b/netbox/dcim/tables/cables.py index b17cf628e..f3643dd1b 100644 --- a/netbox/dcim/tables/cables.py +++ b/netbox/dcim/tables/cables.py @@ -11,7 +11,7 @@ __all__ = ( ) -class CableTerminationColumn(tables.TemplateColumn): +class CableTerminationsColumn(tables.TemplateColumn): def __init__(self, cable_end, *args, **kwargs): template_code = """ @@ -24,7 +24,7 @@ class CableTerminationColumn(tables.TemplateColumn): super().__init__(template_code=template_code, *args, **kwargs) def value(self, value): - return ', '.join(value.all()) + return ', '.join([str(t.termination) for t in value.all()]) # @@ -56,15 +56,17 @@ class CableTable(NetBoxTable): # linkify=True, # verbose_name='Rack B' # ) - a_terminations = CableTerminationColumn( + a_terminations = CableTerminationsColumn( cable_end='A', accessor=Accessor('terminations'), - orderable=False + orderable=False, + verbose_name='A Side' ) - b_terminations = CableTerminationColumn( + b_terminations = CableTerminationsColumn( cable_end='B', accessor=Accessor('terminations'), - orderable=False + orderable=False, + verbose_name='B Side' ) status = columns.ChoiceFieldColumn() tenant = TenantColumn() diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index aaad18577..bdf1f287f 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -55,9 +55,9 @@ class Mixins: self.assertHttpStatus(response, status.HTTP_200_OK) self.assertEqual(len(response.data), 1) segment1 = response.data[0] - self.assertEqual(segment1[0]['name'], obj.name) + self.assertEqual(segment1[0][0]['name'], obj.name) self.assertEqual(segment1[1]['label'], cable.label) - self.assertEqual(segment1[2]['name'], peer_obj.name) + self.assertEqual(segment1[2][0]['name'], peer_obj.name) class RegionTest(APIViewTestCases.APIViewTestCase): diff --git a/netbox/dcim/tests/test_filtersets.py b/netbox/dcim/tests/test_filtersets.py index dab19f1e6..174e02e67 100644 --- a/netbox/dcim/tests/test_filtersets.py +++ b/netbox/dcim/tests/test_filtersets.py @@ -3668,7 +3668,10 @@ class CableTestCase(TestCase, ChangeLoggedFilterSetTests): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) def test_termination_ids(self): - interface_ids = Cable.objects.values_list('termination_a_id', flat=True)[:3] + interface_ids = CableTermination.objects.filter( + cable__in=Cable.objects.all()[:3], + cable_end='A' + ).values_list('termination_id', flat=True) params = { 'termination_a_type': 'dcim.interface', 'termination_a_id': list(interface_ids), diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index 5a57852c4..d070efad9 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -501,12 +501,10 @@ class CableTestCase(TestCase): """ When a new Cable is created, it must be cached on either termination point. """ - interface1 = Interface.objects.get(pk=self.interface1.pk) - interface2 = Interface.objects.get(pk=self.interface2.pk) - self.assertEqual(self.cable.termination_a, interface1) - self.assertEqual(interface1._link_peer, interface2) - self.assertEqual(self.cable.termination_b, interface2) - self.assertEqual(interface2._link_peer, interface1) + self.interface1.refresh_from_db() + self.interface2.refresh_from_db() + self.assertEqual(self.interface1._link_peer, self.interface2) + self.assertEqual(self.interface2._link_peer, self.interface1) def test_cable_deletion(self): """ diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 595b8febe..5c27f734e 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2883,14 +2883,14 @@ class CableBulkImportView(generic.BulkImportView): class CableBulkEditView(generic.BulkEditView): - queryset = Cable.objects.prefetch_related('termination_a', 'termination_b') + queryset = Cable.objects.prefetch_related('terminations') filterset = filtersets.CableFilterSet table = tables.CableTable form = forms.CableBulkEditForm class CableBulkDeleteView(generic.BulkDeleteView): - queryset = Cable.objects.prefetch_related('termination_a', 'termination_b') + queryset = Cable.objects.prefetch_related('terminations') filterset = filtersets.CableFilterSet table = tables.CableTable From 399afffddfb4611708bc63ffff39a8a58459de94 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 13 May 2022 16:46:55 -0400 Subject: [PATCH 057/593] Fix CablePath migration --- netbox/dcim/migrations/0158_cablepath_populate_path.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/migrations/0158_cablepath_populate_path.py b/netbox/dcim/migrations/0158_cablepath_populate_path.py index 972c70143..47113513f 100644 --- a/netbox/dcim/migrations/0158_cablepath_populate_path.py +++ b/netbox/dcim/migrations/0158_cablepath_populate_path.py @@ -32,8 +32,8 @@ def populate_cable_paths(apps, schema_editor): cable_paths.append(cablepath) - # Bulk create the termination objects - CablePath.objects.bulk_update(cable_paths, fields=('path', 'is_complete'), batch_size=100) + # Bulk update all CableTerminations + CablePath.objects.bulk_update(cable_paths, fields=('path', '_nodes', 'is_complete'), batch_size=100) class Migration(migrations.Migration): From 15053691331d202bee705c84e93c97c3c8a94575 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 16 May 2022 15:33:57 -0400 Subject: [PATCH 058/593] Update Cable API serializer --- netbox/dcim/api/serializers.py | 53 +++++++++++++++++++++++----------- netbox/dcim/api/views.py | 2 +- netbox/dcim/tests/test_api.py | 24 +++++++-------- 3 files changed, 49 insertions(+), 30 deletions(-) diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index f6fa4af7b..98ec8979d 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -6,6 +6,7 @@ from timezone_field.rest_framework import TimeZoneSerializerField from dcim.choices import * from dcim.constants import * from dcim.models import * +from extras.api.serializers import ContentTypeSerializer from ipam.api.nested_serializers import ( NestedASNSerializer, NestedIPAddressSerializer, NestedVLANSerializer, NestedVRFSerializer, ) @@ -994,8 +995,10 @@ class InventoryItemRoleSerializer(NetBoxModelSerializer): class CableSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cable-detail') - # termination_a = serializers.SerializerMethodField(read_only=True) - # termination_b = serializers.SerializerMethodField(read_only=True) + a_terminations_type = serializers.SerializerMethodField(read_only=True) + b_terminations_type = serializers.SerializerMethodField(read_only=True) + a_terminations = serializers.SerializerMethodField(read_only=True) + b_terminations = serializers.SerializerMethodField(read_only=True) status = ChoiceField(choices=LinkStatusChoices, required=False) tenant = NestedTenantSerializer(required=False, allow_null=True) length_unit = ChoiceField(choices=CableLengthUnitChoices, allow_blank=True, required=False) @@ -1003,30 +1006,46 @@ class CableSerializer(NetBoxModelSerializer): class Meta: model = Cable fields = [ - 'id', 'url', 'display', 'type', 'status', 'tenant', 'label', 'color', - 'length', 'length_unit', 'tags', 'custom_fields', 'created', 'last_updated', + 'id', 'url', 'display', 'type', 'a_terminations_type', 'a_terminations', 'b_terminations_type', + 'b_terminations', 'status', 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', 'custom_fields', + 'created', 'last_updated', ] - def _get_termination(self, obj, side): - """ - Serialize a nested representation of a termination. - """ + def _get_terminations_type(self, obj, side): assert side.lower() in ('a', 'b') - termination_type = getattr(obj, f'termination_{side}_type').model_class() - termination = getattr(obj, f'termination_{side}') - serializer = get_serializer_for_model(termination_type, prefix='Nested') + terms = [t.termination for t in obj.terminations.all() if t.cable_end == side.upper()] + if terms: + ct = ContentType.objects.get_for_model(terms[0]) + return f"{ct.app_label}.{ct.model}" + + def _get_terminations(self, obj, side): + assert side.lower() in ('a', 'b') + terms = [t.termination for t in obj.terminations.all() if t.cable_end == side.upper()] + if not terms: + return [] + + termination_type = ContentType.objects.get_for_model(terms[0]) + serializer = get_serializer_for_model(termination_type.model_class(), prefix='Nested') context = {'request': self.context['request']} - data = serializer(termination, context=context, many=True).data + data = serializer(terms, context=context, many=True).data return data - @swagger_serializer_method(serializer_or_field=serializers.DictField) - def get_termination_a(self, obj): - return self._get_termination(obj, 'a') + @swagger_serializer_method(serializer_or_field=serializers.CharField) + def get_a_terminations_type(self, obj): + return self._get_terminations_type(obj, 'a') + + @swagger_serializer_method(serializer_or_field=serializers.CharField) + def get_b_terminations_type(self, obj): + return self._get_terminations_type(obj, 'b') @swagger_serializer_method(serializer_or_field=serializers.DictField) - def get_termination_b(self, obj): - return self._get_termination(obj, 'b') + def get_a_terminations(self, obj): + return self._get_terminations(obj, 'a') + + @swagger_serializer_method(serializer_or_field=serializers.DictField) + def get_b_terminations(self, obj): + return self._get_terminations(obj, 'b') class TracedCableSerializer(serializers.ModelSerializer): diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 874d0bb09..60809b051 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -647,7 +647,7 @@ class InventoryItemRoleViewSet(NetBoxModelViewSet): class CableViewSet(NetBoxModelViewSet): metadata_class = ContentTypeMetadata - queryset = Cable.objects.all() + queryset = Cable.objects.prefetch_related('terminations__termination') serializer_class = serializers.CableSerializer filterset_class = filtersets.CableFilterSet diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index bdf1f287f..f18c7793a 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -1888,24 +1888,24 @@ class CableTest(APIViewTestCases.APIViewTestCase): cls.create_data = [ { - 'termination_a_type': 'dcim.interface', - 'termination_a_id': interfaces[4].pk, - 'termination_b_type': 'dcim.interface', - 'termination_b_id': interfaces[14].pk, + 'a_terminations_type': 'dcim.interface', + 'a_terminations': [interfaces[4].pk], + 'b_terminations_type': 'dcim.interface', + 'b_terminations': [interfaces[14].pk], 'label': 'Cable 4', }, { - 'termination_a_type': 'dcim.interface', - 'termination_a_id': interfaces[5].pk, - 'termination_b_type': 'dcim.interface', - 'termination_b_id': interfaces[15].pk, + 'a_terminations_type': 'dcim.interface', + 'a_terminations': [interfaces[5].pk], + 'b_terminations_type': 'dcim.interface', + 'b_terminations': [interfaces[15].pk], 'label': 'Cable 5', }, { - 'termination_a_type': 'dcim.interface', - 'termination_a_id': interfaces[6].pk, - 'termination_b_type': 'dcim.interface', - 'termination_b_id': interfaces[16].pk, + 'a_terminations_type': 'dcim.interface', + 'a_terminations': [interfaces[6].pk], + 'b_terminations_type': 'dcim.interface', + 'b_terminations': [interfaces[16].pk], 'label': 'Cable 6', }, ] From 9ef9443969439dc9e54f0d35a8ddfac845557d39 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 16 May 2022 16:16:51 -0400 Subject: [PATCH 059/593] Add REST API endpoint for CableTermination --- netbox/circuits/filtersets.py | 4 ++-- netbox/dcim/api/serializers.py | 20 ++++++++++++++++++++ netbox/dcim/api/urls.py | 1 + netbox/dcim/api/views.py | 8 +++++++- netbox/dcim/filtersets.py | 26 +++++++++++++++++--------- netbox/dcim/models/cables.py | 3 +++ 6 files changed, 50 insertions(+), 12 deletions(-) diff --git a/netbox/circuits/filtersets.py b/netbox/circuits/filtersets.py index b7fa100a8..2087d90d2 100644 --- a/netbox/circuits/filtersets.py +++ b/netbox/circuits/filtersets.py @@ -1,7 +1,7 @@ import django_filters from django.db.models import Q -from dcim.filtersets import CableTerminationFilterSet +from dcim.filtersets import CabledObjectFilterSet from dcim.models import Region, Site, SiteGroup from ipam.models import ASN from netbox.filtersets import ChangeLoggedModelFilterSet, NetBoxModelFilterSet, OrganizationalModelFilterSet @@ -198,7 +198,7 @@ class CircuitFilterSet(NetBoxModelFilterSet, TenancyFilterSet, ContactModelFilte ).distinct() -class CircuitTerminationFilterSet(ChangeLoggedModelFilterSet, CableTerminationFilterSet): +class CircuitTerminationFilterSet(ChangeLoggedModelFilterSet, CabledObjectFilterSet): q = django_filters.CharFilter( method='search', label='Search', diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 98ec8979d..53f5d1327 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -1061,6 +1061,26 @@ class TracedCableSerializer(serializers.ModelSerializer): ] +class CableTerminationSerializer(NetBoxModelSerializer): + url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cable-detail') + termination_type = ContentTypeField( + queryset=ContentType.objects.filter(CABLE_TERMINATION_MODELS) + ) + termination = serializers.SerializerMethodField(read_only=True) + + class Meta: + model = CableTermination + fields = [ + 'id', 'url', 'display', 'cable', 'cable_end', 'termination_type', 'termination_id', 'termination' + ] + + @swagger_serializer_method(serializer_or_field=serializers.DictField) + def get_termination(self, obj): + serializer = get_serializer_for_model(obj.termination, prefix='Nested') + context = {'request': self.context['request']} + return serializer(obj.termination, context=context).data + + class CablePathSerializer(serializers.ModelSerializer): origin_type = ContentTypeField(read_only=True) origin = serializers.SerializerMethodField(read_only=True) diff --git a/netbox/dcim/api/urls.py b/netbox/dcim/api/urls.py index f67d241d5..e73678f71 100644 --- a/netbox/dcim/api/urls.py +++ b/netbox/dcim/api/urls.py @@ -56,6 +56,7 @@ router.register('inventory-item-roles', views.InventoryItemRoleViewSet) # Cables router.register('cables', views.CableViewSet) +router.register('cable-terminations', views.CableTerminationViewSet) # Virtual chassis router.register('virtual-chassis', views.VirtualChassisViewSet) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 60809b051..363523819 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -646,12 +646,18 @@ class InventoryItemRoleViewSet(NetBoxModelViewSet): # class CableViewSet(NetBoxModelViewSet): - metadata_class = ContentTypeMetadata queryset = Cable.objects.prefetch_related('terminations__termination') serializer_class = serializers.CableSerializer filterset_class = filtersets.CableFilterSet +class CableTerminationViewSet(NetBoxModelViewSet): + metadata_class = ContentTypeMetadata + queryset = CableTermination.objects.prefetch_related('cable', 'termination') + serializer_class = serializers.CableTerminationSerializer + filterset_class = filtersets.CableTerminationFilterSet + + # # Virtual chassis # diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index 6fefe4ac0..7da042253 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -21,6 +21,7 @@ from .models import * __all__ = ( 'CableFilterSet', + 'CabledObjectFilterSet', 'CableTerminationFilterSet', 'ConsoleConnectionFilterSet', 'ConsolePortFilterSet', @@ -1107,7 +1108,7 @@ class ModularDeviceComponentFilterSet(DeviceComponentFilterSet): ) -class CableTerminationFilterSet(django_filters.FilterSet): +class CabledObjectFilterSet(django_filters.FilterSet): cabled = django_filters.BooleanFilter( field_name='cable', lookup_expr='isnull', @@ -1130,7 +1131,7 @@ class PathEndpointFilterSet(django_filters.FilterSet): class ConsolePortFilterSet( ModularDeviceComponentFilterSet, NetBoxModelFilterSet, - CableTerminationFilterSet, + CabledObjectFilterSet, PathEndpointFilterSet ): type = django_filters.MultipleChoiceFilter( @@ -1146,7 +1147,7 @@ class ConsolePortFilterSet( class ConsoleServerPortFilterSet( ModularDeviceComponentFilterSet, NetBoxModelFilterSet, - CableTerminationFilterSet, + CabledObjectFilterSet, PathEndpointFilterSet ): type = django_filters.MultipleChoiceFilter( @@ -1162,7 +1163,7 @@ class ConsoleServerPortFilterSet( class PowerPortFilterSet( ModularDeviceComponentFilterSet, NetBoxModelFilterSet, - CableTerminationFilterSet, + CabledObjectFilterSet, PathEndpointFilterSet ): type = django_filters.MultipleChoiceFilter( @@ -1178,7 +1179,7 @@ class PowerPortFilterSet( class PowerOutletFilterSet( ModularDeviceComponentFilterSet, NetBoxModelFilterSet, - CableTerminationFilterSet, + CabledObjectFilterSet, PathEndpointFilterSet ): type = django_filters.MultipleChoiceFilter( @@ -1198,7 +1199,7 @@ class PowerOutletFilterSet( class InterfaceFilterSet( ModularDeviceComponentFilterSet, NetBoxModelFilterSet, - CableTerminationFilterSet, + CabledObjectFilterSet, PathEndpointFilterSet ): # Override device and device_id filters from DeviceComponentFilterSet to match against any peer virtual chassis @@ -1326,7 +1327,7 @@ class InterfaceFilterSet( class FrontPortFilterSet( ModularDeviceComponentFilterSet, NetBoxModelFilterSet, - CableTerminationFilterSet + CabledObjectFilterSet ): type = django_filters.MultipleChoiceFilter( choices=PortTypeChoices, @@ -1341,7 +1342,7 @@ class FrontPortFilterSet( class RearPortFilterSet( ModularDeviceComponentFilterSet, NetBoxModelFilterSet, - CableTerminationFilterSet + CabledObjectFilterSet ): type = django_filters.MultipleChoiceFilter( choices=PortTypeChoices, @@ -1552,6 +1553,13 @@ class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): return queryset +class CableTerminationFilterSet(BaseFilterSet): + + class Meta: + model = CableTermination + fields = ['id', 'cable', 'cable_end', 'termination_type', 'termination_id'] + + class PowerPanelFilterSet(NetBoxModelFilterSet, ContactModelFilterSet): region_id = TreeNodeMultipleChoiceFilter( queryset=Region.objects.all(), @@ -1609,7 +1617,7 @@ class PowerPanelFilterSet(NetBoxModelFilterSet, ContactModelFilterSet): return queryset.filter(qs_filter) -class PowerFeedFilterSet(NetBoxModelFilterSet, CableTerminationFilterSet, PathEndpointFilterSet): +class PowerFeedFilterSet(NetBoxModelFilterSet, CabledObjectFilterSet, PathEndpointFilterSet): region_id = TreeNodeMultipleChoiceFilter( queryset=Region.objects.all(), field_name='power_panel__site__region', diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 8090258f4..0f57bb685 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -13,6 +13,7 @@ from dcim.fields import PathField from dcim.utils import decompile_path_node, flatten_path, object_to_path_node, path_node_to_object from netbox.models import NetBoxModel from utilities.fields import ColorField +from utilities.querysets import RestrictedQuerySet from utilities.utils import to_meters from wireless.models import WirelessLink from .devices import Device @@ -222,6 +223,8 @@ class CableTermination(models.Model): fk_field='termination_id' ) + objects = RestrictedQuerySet.as_manager() + class Meta: ordering = ['pk'] constraints = ( From 75eea50d71bd97c253a31e60267417d7f963613e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 16 May 2022 16:35:32 -0400 Subject: [PATCH 060/593] Order CableTerminations by cable, cable_end --- netbox/dcim/migrations/0154_cabletermination.py | 2 +- netbox/dcim/models/cables.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/migrations/0154_cabletermination.py b/netbox/dcim/migrations/0154_cabletermination.py index 5a3a335fe..88245d483 100644 --- a/netbox/dcim/migrations/0154_cabletermination.py +++ b/netbox/dcim/migrations/0154_cabletermination.py @@ -20,7 +20,7 @@ class Migration(migrations.Migration): ('termination_type', models.ForeignKey(limit_choices_to=models.Q(models.Q(models.Q(('app_label', 'circuits'), ('model__in', ('circuittermination',))), models.Q(('app_label', 'dcim'), ('model__in', ('consoleport', 'consoleserverport', 'frontport', 'interface', 'powerfeed', 'poweroutlet', 'powerport', 'rearport'))), _connector='OR')), on_delete=django.db.models.deletion.PROTECT, related_name='+', to='contenttypes.contenttype')), ], options={ - 'ordering': ['pk'], + 'ordering': ('cable', 'cable_end', 'pk'), }, ), migrations.AddConstraint( diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 0f57bb685..dd5599a1d 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -226,7 +226,7 @@ class CableTermination(models.Model): objects = RestrictedQuerySet.as_manager() class Meta: - ordering = ['pk'] + ordering = ('cable', 'cable_end', 'pk') constraints = ( models.UniqueConstraint( fields=('termination_type', 'termination_id'), From 922916ae998c710e7b3434eac18322f4483e3207 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 18 May 2022 12:56:16 -0400 Subject: [PATCH 061/593] Improve cable termination panel layout --- .../templates/dcim/inc/cable_termination.html | 18 ++++++------------ 1 file changed, 6 insertions(+), 12 deletions(-) diff --git a/netbox/templates/dcim/inc/cable_termination.html b/netbox/templates/dcim/inc/cable_termination.html index 7d5aef46d..a72878b48 100644 --- a/netbox/templates/dcim/inc/cable_termination.html +++ b/netbox/templates/dcim/inc/cable_termination.html @@ -2,26 +2,20 @@
      Device{{ termination.0.device|linkify }}{{ terminations.0.device|linkify }}
      Site{{ termination.0.device.site|linkify }}{{ terminations.0.device.site|linkify }}
      Rack{{ termination.0.device.rack|linkify }}{{ terminations.0.device.rack|linkify }}
      Type{{ termination.0|meta:"verbose_name"|capfirst }}{{ terminations.0|meta:"verbose_name"|capfirst }}
      Component(s)Name(s) - {% for term in termination %} + {% for term in terminations %} {{ term|linkify }}{% if not forloop.last %},{% endif %} {% endfor %}
      Provider{{ termination.0.circuit.provider|linkify }}{{ terminations.0.circuit.provider|linkify }}
      Circuit - {% for term in termination %} + {% for term in terminations %} {{ term.circuit|linkify }} ({{ term }}){% if not forloop.last %},{% endif %} {% endfor %}
      {% if terminations.0.device %} {# Device component #} + + + + - - + + - {% if terminations.0.device.rack %} - - - - - {% endif %} - - - - + + + + - - + + + + {% elif terminations.0.power_panel %} + {# Power feed #} + + + + + + + From a7d3e5e7f57e82ba624e2a94456ba86624f8b757 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 23 May 2022 12:59:05 -0400 Subject: [PATCH 066/593] Merge all cable creation URLs into a single view --- netbox/circuits/urls.py | 3 +- netbox/dcim/tables/template_code.py | 50 +++++++++---------- netbox/dcim/urls.py | 9 +--- netbox/dcim/views.py | 6 +-- .../circuits/inc/circuit_termination.html | 8 +-- netbox/templates/dcim/consoleport.html | 21 ++------ netbox/templates/dcim/consoleserverport.html | 21 ++------ netbox/templates/dcim/frontport.html | 12 ++--- netbox/templates/dcim/interface.html | 16 ++---- netbox/templates/dcim/powerfeed.html | 3 +- netbox/templates/dcim/poweroutlet.html | 2 +- netbox/templates/dcim/powerport.html | 4 +- netbox/templates/dcim/rearport.html | 8 +-- 13 files changed, 58 insertions(+), 105 deletions(-) diff --git a/netbox/circuits/urls.py b/netbox/circuits/urls.py index 323f588eb..5b15b29ac 100644 --- a/netbox/circuits/urls.py +++ b/netbox/circuits/urls.py @@ -1,6 +1,6 @@ from django.urls import path -from dcim.views import CableEditView, PathTraceView +from dcim.views import PathTraceView from netbox.views.generic import ObjectChangeLogView, ObjectJournalView from . import views from .models import * @@ -61,6 +61,5 @@ urlpatterns = [ path('circuit-terminations//edit/', views.CircuitTerminationEditView.as_view(), name='circuittermination_edit'), path('circuit-terminations//delete/', views.CircuitTerminationDeleteView.as_view(), name='circuittermination_delete'), path('circuit-terminations//trace/', PathTraceView.as_view(), name='circuittermination_trace', kwargs={'model': CircuitTermination}), - path('circuit-terminations/connect/', CableEditView.as_view(), name='circuittermination_connect', kwargs={'termination_a_type': CircuitTermination}), ] diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index b72b4738f..d26bc23ac 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -139,9 +139,9 @@ CONSOLEPORT_BUTTONS = """ {% else %} @@ -171,9 +171,9 @@ CONSOLESERVERPORT_BUTTONS = """ {% else %} @@ -203,8 +203,8 @@ POWERPORT_BUTTONS = """ {% else %} @@ -230,7 +230,7 @@ POWEROUTLET_BUTTONS = """ {% if not record.mark_connected %} - + {% else %} @@ -280,10 +280,10 @@ INTERFACE_BUTTONS = """ {% else %} @@ -319,12 +319,12 @@ FRONTPORT_BUTTONS = """ {% else %} @@ -356,12 +356,12 @@ REARPORT_BUTTONS = """ {% else %} diff --git a/netbox/dcim/urls.py b/netbox/dcim/urls.py index 8aa5f694a..dbbd8707a 100644 --- a/netbox/dcim/urls.py +++ b/netbox/dcim/urls.py @@ -294,7 +294,6 @@ urlpatterns = [ path('console-ports//delete/', views.ConsolePortDeleteView.as_view(), name='consoleport_delete'), path('console-ports//changelog/', ObjectChangeLogView.as_view(), name='consoleport_changelog', kwargs={'model': ConsolePort}), path('console-ports//trace/', views.PathTraceView.as_view(), name='consoleport_trace', kwargs={'model': ConsolePort}), - path('console-ports/connect/', views.CableEditView.as_view(), name='consoleport_connect', kwargs={'termination_a_type': ConsolePort}), path('devices/console-ports/add/', views.DeviceBulkAddConsolePortView.as_view(), name='device_bulk_add_consoleport'), # Console server ports @@ -310,7 +309,6 @@ urlpatterns = [ path('console-server-ports//delete/', views.ConsoleServerPortDeleteView.as_view(), name='consoleserverport_delete'), path('console-server-ports//changelog/', ObjectChangeLogView.as_view(), name='consoleserverport_changelog', kwargs={'model': ConsoleServerPort}), path('console-server-ports//trace/', views.PathTraceView.as_view(), name='consoleserverport_trace', kwargs={'model': ConsoleServerPort}), - path('console-server-ports/connect/', views.CableEditView.as_view(), name='consoleserverport_connect', kwargs={'termination_a_type': ConsoleServerPort}), path('devices/console-server-ports/add/', views.DeviceBulkAddConsoleServerPortView.as_view(), name='device_bulk_add_consoleserverport'), # Power ports @@ -326,7 +324,6 @@ urlpatterns = [ path('power-ports//delete/', views.PowerPortDeleteView.as_view(), name='powerport_delete'), path('power-ports//changelog/', ObjectChangeLogView.as_view(), name='powerport_changelog', kwargs={'model': PowerPort}), path('power-ports//trace/', views.PathTraceView.as_view(), name='powerport_trace', kwargs={'model': PowerPort}), - path('power-ports/connect/', views.CableEditView.as_view(), name='powerport_connect', kwargs={'termination_a_type': PowerPort}), path('devices/power-ports/add/', views.DeviceBulkAddPowerPortView.as_view(), name='device_bulk_add_powerport'), # Power outlets @@ -342,7 +339,6 @@ urlpatterns = [ path('power-outlets//delete/', views.PowerOutletDeleteView.as_view(), name='poweroutlet_delete'), path('power-outlets//changelog/', ObjectChangeLogView.as_view(), name='poweroutlet_changelog', kwargs={'model': PowerOutlet}), path('power-outlets//trace/', views.PathTraceView.as_view(), name='poweroutlet_trace', kwargs={'model': PowerOutlet}), - path('power-outlets/connect/', views.CableEditView.as_view(), name='poweroutlet_connect', kwargs={'termination_a_type': PowerOutlet}), path('devices/power-outlets/add/', views.DeviceBulkAddPowerOutletView.as_view(), name='device_bulk_add_poweroutlet'), # Interfaces @@ -358,7 +354,6 @@ urlpatterns = [ path('interfaces//delete/', views.InterfaceDeleteView.as_view(), name='interface_delete'), path('interfaces//changelog/', ObjectChangeLogView.as_view(), name='interface_changelog', kwargs={'model': Interface}), path('interfaces//trace/', views.PathTraceView.as_view(), name='interface_trace', kwargs={'model': Interface}), - path('interfaces/connect/', views.CableEditView.as_view(), name='interface_connect', kwargs={'termination_a_type': Interface}), path('devices/interfaces/add/', views.DeviceBulkAddInterfaceView.as_view(), name='device_bulk_add_interface'), # Front ports @@ -374,7 +369,6 @@ urlpatterns = [ path('front-ports//delete/', views.FrontPortDeleteView.as_view(), name='frontport_delete'), path('front-ports//changelog/', ObjectChangeLogView.as_view(), name='frontport_changelog', kwargs={'model': FrontPort}), path('front-ports//trace/', views.PathTraceView.as_view(), name='frontport_trace', kwargs={'model': FrontPort}), - path('front-ports/connect/', views.CableEditView.as_view(), name='frontport_connect', kwargs={'termination_a_type': FrontPort}), # path('devices/front-ports/add/', views.DeviceBulkAddFrontPortView.as_view(), name='device_bulk_add_frontport'), # Rear ports @@ -390,7 +384,6 @@ urlpatterns = [ path('rear-ports//delete/', views.RearPortDeleteView.as_view(), name='rearport_delete'), path('rear-ports//changelog/', ObjectChangeLogView.as_view(), name='rearport_changelog', kwargs={'model': RearPort}), path('rear-ports//trace/', views.PathTraceView.as_view(), name='rearport_trace', kwargs={'model': RearPort}), - path('rear-ports/connect/', views.CableEditView.as_view(), name='rearport_connect', kwargs={'termination_a_type': RearPort}), path('devices/rear-ports/add/', views.DeviceBulkAddRearPortView.as_view(), name='device_bulk_add_rearport'), # Module bays @@ -447,6 +440,7 @@ urlpatterns = [ # Cables path('cables/', views.CableListView.as_view(), name='cable_list'), + path('cables/add/', views.CableEditView.as_view(), name='cable_add'), path('cables/import/', views.CableBulkImportView.as_view(), name='cable_import'), path('cables/edit/', views.CableBulkEditView.as_view(), name='cable_bulk_edit'), path('cables/delete/', views.CableBulkDeleteView.as_view(), name='cable_bulk_delete'), @@ -500,6 +494,5 @@ urlpatterns = [ path('power-feeds//trace/', views.PathTraceView.as_view(), name='powerfeed_trace', kwargs={'model': PowerFeed}), path('power-feeds//changelog/', ObjectChangeLogView.as_view(), name='powerfeed_changelog', kwargs={'model': PowerFeed}), path('power-feeds//journal/', ObjectJournalView.as_view(), name='powerfeed_journal', kwargs={'model': PowerFeed}), - path('power-feeds/connect/', views.CableEditView.as_view(), name='powerfeed_connect', kwargs={'termination_a_type': PowerFeed}), ] diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 1f13e2dc8..d142eb99f 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -17,7 +17,7 @@ from extras.views import ObjectConfigContextView 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, restrict_form_fields +from utilities.forms import ConfirmationForm from utilities.paginator import EnhancedPaginator, get_paginate_count from utilities.permissions import get_permission_for_model from utilities.utils import count_related @@ -2824,8 +2824,8 @@ class CableEditView(generic.ObjectEditView): 'circuits.circuittermination': CircuitTermination, } - a_type = kwargs.pop('termination_a_type') - b_type = termination_types[request.GET.get('termination_b_type')] + a_type = termination_types.get(request.GET.get('a_terminations_type')) + b_type = termination_types.get(request.GET.get('b_terminations_type')) self.form = forms.get_cable_form(a_type, b_type) diff --git a/netbox/templates/circuits/inc/circuit_termination.html b/netbox/templates/circuits/inc/circuit_termination.html index 71732938e..6cfcac05c 100644 --- a/netbox/templates/circuits/inc/circuit_termination.html +++ b/netbox/templates/circuits/inc/circuit_termination.html @@ -70,10 +70,10 @@ Connect {% endif %} diff --git a/netbox/templates/dcim/consoleport.html b/netbox/templates/dcim/consoleport.html index b80f86dd4..f132a4ed8 100644 --- a/netbox/templates/dcim/consoleport.html +++ b/netbox/templates/dcim/consoleport.html @@ -111,28 +111,13 @@ diff --git a/netbox/templates/dcim/consoleserverport.html b/netbox/templates/dcim/consoleserverport.html index 2d863cd7d..f4da080e8 100644 --- a/netbox/templates/dcim/consoleserverport.html +++ b/netbox/templates/dcim/consoleserverport.html @@ -113,28 +113,13 @@ diff --git a/netbox/templates/dcim/frontport.html b/netbox/templates/dcim/frontport.html index 003c3c020..4cea7989b 100644 --- a/netbox/templates/dcim/frontport.html +++ b/netbox/templates/dcim/frontport.html @@ -105,22 +105,22 @@ diff --git a/netbox/templates/dcim/interface.html b/netbox/templates/dcim/interface.html index 708ea7370..bec52471a 100644 --- a/netbox/templates/dcim/interface.html +++ b/netbox/templates/dcim/interface.html @@ -251,24 +251,16 @@ diff --git a/netbox/templates/dcim/powerfeed.html b/netbox/templates/dcim/powerfeed.html index f8b1e3368..064e0031f 100644 --- a/netbox/templates/dcim/powerfeed.html +++ b/netbox/templates/dcim/powerfeed.html @@ -158,8 +158,7 @@ {% if not object.mark_connected and not object.cable %}
      {% if perms.dcim.add_cable %} - + Connect {% endif %} diff --git a/netbox/templates/dcim/poweroutlet.html b/netbox/templates/dcim/poweroutlet.html index 3cb4afa29..4fecb05a0 100644 --- a/netbox/templates/dcim/poweroutlet.html +++ b/netbox/templates/dcim/poweroutlet.html @@ -111,7 +111,7 @@
      Not Connected {% if perms.dcim.add_cable %} - + Connect {% endif %} diff --git a/netbox/templates/dcim/powerport.html b/netbox/templates/dcim/powerport.html index 9d2ad2ce4..6da35617d 100644 --- a/netbox/templates/dcim/powerport.html +++ b/netbox/templates/dcim/powerport.html @@ -117,10 +117,10 @@ diff --git a/netbox/templates/dcim/rearport.html b/netbox/templates/dcim/rearport.html index c9b9fb9cd..3caae49c3 100644 --- a/netbox/templates/dcim/rearport.html +++ b/netbox/templates/dcim/rearport.html @@ -101,16 +101,16 @@ From 4ec26aa6aa3399a7e0669d930f7139133b2f9c9a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 23 May 2022 13:52:39 -0400 Subject: [PATCH 067/593] Fix population of initial field selections when creating a cable --- netbox/dcim/forms/connections.py | 43 ++++++++++++++++++++++++++------ 1 file changed, 36 insertions(+), 7 deletions(-) diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index 10ccbb7d9..8b8b6e209 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -19,7 +19,7 @@ def get_cable_form(a_type, b_type): label='Region', required=False, initial_params={ - 'sites': '$termination_{cable_end}_site' + 'sites': f'$termination_{cable_end}_site' } ) attrs[f'termination_{cable_end}_sitegroup'] = DynamicModelChoiceField( @@ -27,7 +27,7 @@ def get_cable_form(a_type, b_type): label='Site group', required=False, initial_params={ - 'sites': '$termination_{cable_end}_site' + 'sites': f'$termination_{cable_end}_site' } ) attrs[f'termination_{cable_end}_site'] = DynamicModelChoiceField( @@ -35,8 +35,8 @@ def get_cable_form(a_type, b_type): label='Site', required=False, query_params={ - 'region_id': '$termination_{cable_end}_region', - 'group_id': '$termination_{cable_end}_sitegroup', + 'region_id': f'$termination_{cable_end}_region', + 'group_id': f'$termination_{cable_end}_sitegroup', } ) attrs[f'termination_{cable_end}_location'] = DynamicModelChoiceField( @@ -45,7 +45,7 @@ def get_cable_form(a_type, b_type): required=False, null_option='None', query_params={ - 'site_id': '$termination_{cable_end}_site' + 'site_id': f'$termination_{cable_end}_site' } ) @@ -57,15 +57,21 @@ def get_cable_form(a_type, b_type): label='Rack', required=False, null_option='None', + initial_params={ + 'devices': f'$termination_{cable_end}_device' + }, query_params={ - 'site_id': '$termination_{cable_end}_site', - 'location_id': '$termination_{cable_end}_location', + 'site_id': f'$termination_{cable_end}_site', + 'location_id': f'$termination_{cable_end}_location', } ) attrs[f'termination_{cable_end}_device'] = DynamicModelChoiceField( queryset=Device.objects.all(), label='Device', required=False, + initial_params={ + f'{term_cls._meta.model_name}s__in': f'${cable_end}_terminations' + }, query_params={ 'site_id': f'$termination_{cable_end}_site', 'location_id': f'$termination_{cable_end}_location', @@ -88,6 +94,9 @@ def get_cable_form(a_type, b_type): queryset=PowerPanel.objects.all(), label='Power Panel', required=False, + initial_params={ + 'powerfeeds__in': f'${cable_end}_terminations' + }, query_params={ 'site_id': f'$termination_{cable_end}_site', 'location_id': f'$termination_{cable_end}_location', @@ -108,11 +117,17 @@ def get_cable_form(a_type, b_type): attrs[f'termination_{cable_end}_provider'] = DynamicModelChoiceField( queryset=Provider.objects.all(), label='Provider', + initial_params={ + 'circuits': f'$termination_{cable_end}_circuit' + }, required=False ) attrs[f'termination_{cable_end}_circuit'] = DynamicModelChoiceField( queryset=Circuit.objects.all(), label='Circuit', + initial_params={ + 'terminations__in': f'${cable_end}_terminations' + }, query_params={ 'provider_id': f'$termination_{cable_end}_provider', 'site_id': f'$termination_{cable_end}_site', @@ -131,6 +146,20 @@ def get_cable_form(a_type, b_type): class _CableForm(CableForm, metaclass=FormMetaclass): + def __init__(self, *args, **kwargs): + + # TODO: Temporary hack to work around list handling limitations with utils.normalize_querydict() + for field_name in ('a_terminations', 'b_terminations'): + if field_name in kwargs['initial'] and type(kwargs['initial'][field_name]) is not list: + kwargs['initial'][field_name] = [kwargs['initial'][field_name]] + + super().__init__(*args, **kwargs) + + if self.instance and self.instance.pk: + # Initialize A/B terminations when modifying an existing Cable instance + self.initial['a_terminations'] = self.instance.get_a_terminations() + self.initial['b_terminations'] = self.instance.get_b_terminations() + def save(self, *args, **kwargs): # Set the A/B terminations on the Cable instance From 50c872c47c9064a020f80dd2c572b246278e48c9 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 23 May 2022 14:50:58 -0400 Subject: [PATCH 068/593] Clean up tests --- netbox/dcim/forms/connections.py | 2 +- netbox/dcim/graphql/types.py | 8 ++++++++ netbox/dcim/tests/test_models.py | 25 ------------------------- netbox/dcim/tests/test_views.py | 7 +++---- 4 files changed, 12 insertions(+), 30 deletions(-) diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index 8b8b6e209..d39288bd5 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -150,7 +150,7 @@ def get_cable_form(a_type, b_type): # TODO: Temporary hack to work around list handling limitations with utils.normalize_querydict() for field_name in ('a_terminations', 'b_terminations'): - if field_name in kwargs['initial'] and type(kwargs['initial'][field_name]) is not list: + if field_name in kwargs.get('initial', {}) and type(kwargs['initial'][field_name]) is not list: kwargs['initial'][field_name] = [kwargs['initial'][field_name]] super().__init__(*args, **kwargs) diff --git a/netbox/dcim/graphql/types.py b/netbox/dcim/graphql/types.py index d25a6bba6..824e41fc9 100644 --- a/netbox/dcim/graphql/types.py +++ b/netbox/dcim/graphql/types.py @@ -99,6 +99,14 @@ class CableType(NetBoxObjectType): return self.length_unit or None +class CableTerminationType(NetBoxObjectType): + + class Meta: + model = models.CableTermination + fields = '__all__' + filterset_class = filtersets.CableTerminationFilterSet + + class ConsolePortType(ComponentObjectType): class Meta: diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index d070efad9..16b8e1c48 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -521,14 +521,6 @@ class CableTestCase(TestCase): self.assertIsNone(interface2.cable) self.assertIsNone(interface2._link_peer) - def test_cabletermination_deletion(self): - """ - When a CableTermination object is deleted, its attached Cable (if any) must also be deleted. - """ - self.interface1.delete() - cable = Cable.objects.filter(pk=self.cable.pk).first() - self.assertIsNone(cable) - def test_cable_validates_compatible_types(self): """ The clean method should have a check to ensure only compatible port types can be connected by a cable @@ -538,14 +530,6 @@ class CableTestCase(TestCase): with self.assertRaises(ValidationError): cable.clean() - def test_cable_cannot_have_the_same_terminination_on_both_ends(self): - """ - A cable cannot be made with the same A and B side terminations - """ - cable = Cable(a_terminations=[self.interface1], b_terminations=[self.interface1]) - with self.assertRaises(ValidationError): - cable.clean() - def test_cable_front_port_cannot_connect_to_corresponding_rear_port(self): """ A cable cannot connect a front port to its corresponding rear port @@ -554,15 +538,6 @@ class CableTestCase(TestCase): with self.assertRaises(ValidationError): cable.clean() - def test_cable_cannot_terminate_to_an_existing_connection(self): - """ - Either side of a cable cannot be terminated when that side already has a connection - """ - # Try to create a cable with the same interface terminations - cable = Cable(a_terminations=[self.interface2], b_terminations=[self.interface1]) - with self.assertRaises(ValidationError): - cable.clean() - def test_cable_cannot_terminate_to_a_provider_network_circuittermination(self): """ Neither side of a cable can be terminated to a CircuitTermination which is attached to a ProviderNetwork diff --git a/netbox/dcim/tests/test_views.py b/netbox/dcim/tests/test_views.py index 389e23457..ac9bcbdc3 100644 --- a/netbox/dcim/tests/test_views.py +++ b/netbox/dcim/tests/test_views.py @@ -2631,11 +2631,10 @@ class CableTestCase( interface_ct = ContentType.objects.get_for_model(Interface) cls.form_data = { + # TODO: Revisit this limitation # Changing terminations not supported when editing an existing Cable - 'termination_a_type': interface_ct.pk, - 'termination_a_id': interfaces[0].pk, - 'termination_b_type': interface_ct.pk, - 'termination_b_id': interfaces[3].pk, + 'a_terminations': interfaces[0].pk, + 'b_terminations': interfaces[3].pk, 'type': CableTypeChoices.TYPE_CAT6, 'status': LinkStatusChoices.STATUS_PLANNED, 'label': 'Label', From 20eaa7d069b20bc8b123ef270ffd4ba3ea410105 Mon Sep 17 00:00:00 2001 From: kkthxbye <> Date: Tue, 24 May 2022 10:12:32 +0200 Subject: [PATCH 069/593] #9166 - Add UI Visibility setting for custom fields --- netbox/extras/api/serializers.py | 3 ++- netbox/extras/choices.py | 13 +++++++++++++ netbox/extras/filtersets.py | 4 +++- netbox/extras/forms/bulk_edit.py | 7 +++++++ netbox/extras/forms/bulk_import.py | 2 +- netbox/extras/forms/customfields.py | 7 +++++++ netbox/extras/forms/filtersets.py | 8 +++++++- netbox/extras/forms/models.py | 3 ++- .../0075_customfield_ui_visibility.py | 18 ++++++++++++++++++ netbox/extras/models/customfields.py | 6 ++++++ netbox/extras/tables/tables.py | 3 ++- netbox/extras/tests/test_views.py | 9 +++++---- netbox/netbox/models/features.py | 10 +++++++--- netbox/templates/extras/customfield.html | 4 ++++ 14 files changed, 84 insertions(+), 13 deletions(-) create mode 100644 netbox/extras/migrations/0075_customfield_ui_visibility.py diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index eed7f7603..1a26faec1 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -84,13 +84,14 @@ class CustomFieldSerializer(ValidatedModelSerializer): ) filter_logic = ChoiceField(choices=CustomFieldFilterLogicChoices, required=False) data_type = serializers.SerializerMethodField() + ui_visibility = ChoiceField(choices=CustomFieldVisibilityChoices, required=False) class Meta: model = CustomField fields = [ 'id', 'url', 'display', 'content_types', 'type', 'object_type', 'data_type', 'name', 'label', 'group_name', 'description', 'required', 'filter_logic', 'default', 'weight', 'validation_minimum', 'validation_maximum', - 'validation_regex', 'choices', 'created', 'last_updated', + 'validation_regex', 'choices', 'created', 'last_updated', 'ui_visibility', ] def get_data_type(self, obj): diff --git a/netbox/extras/choices.py b/netbox/extras/choices.py index f14368d3d..123fd2cd4 100644 --- a/netbox/extras/choices.py +++ b/netbox/extras/choices.py @@ -47,6 +47,19 @@ class CustomFieldFilterLogicChoices(ChoiceSet): ) +class CustomFieldVisibilityChoices(ChoiceSet): + + VISIBILITY_READ_WRITE = 'read-write' + VISIBILITY_READ_ONLY = 'read-only' + VISIBILITY_HIDDEN = 'hidden' + + CHOICES = ( + (VISIBILITY_READ_WRITE, 'Read/Write'), + (VISIBILITY_READ_ONLY, 'Read-only'), + (VISIBILITY_HIDDEN, 'Hidden'), + ) + + # # CustomLinks # diff --git a/netbox/extras/filtersets.py b/netbox/extras/filtersets.py index 467ae23af..ea74dfc82 100644 --- a/netbox/extras/filtersets.py +++ b/netbox/extras/filtersets.py @@ -62,7 +62,9 @@ class CustomFieldFilterSet(BaseFilterSet): class Meta: model = CustomField - fields = ['id', 'content_types', 'name', 'group_name', 'required', 'filter_logic', 'weight', 'description'] + fields = [ + 'id', 'content_types', 'name', 'group_name', 'required', 'filter_logic', 'weight', 'description', 'ui_visibility' + ] def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/extras/forms/bulk_edit.py b/netbox/extras/forms/bulk_edit.py index b722bd751..b1d8a6c21 100644 --- a/netbox/extras/forms/bulk_edit.py +++ b/netbox/extras/forms/bulk_edit.py @@ -37,6 +37,13 @@ class CustomFieldBulkEditForm(BulkEditForm): weight = forms.IntegerField( required=False ) + ui_visibility = forms.ChoiceField( + label="UI visibility", + choices=add_blank_choice(CustomFieldVisibilityChoices), + required=False, + initial='', + widget=StaticSelect() + ) nullable_fields = ('group_name', 'description',) diff --git a/netbox/extras/forms/bulk_import.py b/netbox/extras/forms/bulk_import.py index dabf2f811..c0483d36e 100644 --- a/netbox/extras/forms/bulk_import.py +++ b/netbox/extras/forms/bulk_import.py @@ -37,7 +37,7 @@ class CustomFieldCSVForm(CSVModelForm): model = CustomField fields = ( 'name', 'label', 'group_name', 'type', 'content_types', 'required', 'description', 'weight', 'filter_logic', - 'default', 'choices', 'weight', 'validation_minimum', 'validation_maximum', 'validation_regex', + 'default', 'choices', 'weight', 'validation_minimum', 'validation_maximum', 'validation_regex', 'ui_visibility', ) diff --git a/netbox/extras/forms/customfields.py b/netbox/extras/forms/customfields.py index bb8028eec..c4496c5f8 100644 --- a/netbox/extras/forms/customfields.py +++ b/netbox/extras/forms/customfields.py @@ -1,6 +1,7 @@ from django.contrib.contenttypes.models import ContentType from extras.models import * +from extras.choices import CustomFieldVisibilityChoices __all__ = ( 'CustomFieldsMixin', @@ -42,8 +43,14 @@ class CustomFieldsMixin: Append form fields for all CustomFields assigned to this object type. """ for customfield in self._get_custom_fields(self._get_content_type()): + if customfield.ui_visibility == CustomFieldVisibilityChoices.VISIBILITY_HIDDEN: + continue + field_name = f'cf_{customfield.name}' self.fields[field_name] = self._get_form_field(customfield) + if customfield.ui_visibility == CustomFieldVisibilityChoices.VISIBILITY_READ_ONLY: + self.fields[field_name].disabled = True + # Annotate the field in the list of CustomField form fields self.custom_fields[field_name] = customfield diff --git a/netbox/extras/forms/filtersets.py b/netbox/extras/forms/filtersets.py index 1710ecb89..cd59a9db1 100644 --- a/netbox/extras/forms/filtersets.py +++ b/netbox/extras/forms/filtersets.py @@ -32,7 +32,7 @@ __all__ = ( class CustomFieldFilterForm(FilterForm): fieldsets = ( (None, ('q',)), - ('Attributes', ('content_types', 'type', 'group_name', 'weight', 'required')), + ('Attributes', ('content_types', 'type', 'group_name', 'weight', 'required', 'ui_visibility')), ) content_types = ContentTypeMultipleChoiceField( queryset=ContentType.objects.all(), @@ -56,6 +56,12 @@ class CustomFieldFilterForm(FilterForm): choices=BOOLEAN_WITH_BLANK_CHOICES ) ) + ui_visibility = forms.ChoiceField( + choices=add_blank_choice(CustomFieldVisibilityChoices), + required=False, + label=_('UI Visibility'), + widget=StaticSelect() + ) class CustomLinkFilterForm(FilterForm): diff --git a/netbox/extras/forms/models.py b/netbox/extras/forms/models.py index b07853f86..16874c49e 100644 --- a/netbox/extras/forms/models.py +++ b/netbox/extras/forms/models.py @@ -41,7 +41,7 @@ class CustomFieldForm(BootstrapMixin, forms.ModelForm): fieldsets = ( ('Custom Field', ( - 'content_types', 'name', 'label', 'group_name', 'type', 'object_type', 'weight', 'required', 'description', + 'content_types', 'name', 'label', 'group_name', 'type', 'object_type', 'weight', 'required', 'description', 'ui_visibility', )), ('Behavior', ('filter_logic',)), ('Values', ('default', 'choices')), @@ -58,6 +58,7 @@ class CustomFieldForm(BootstrapMixin, forms.ModelForm): widgets = { 'type': StaticSelect(), 'filter_logic': StaticSelect(), + 'ui_visibility': StaticSelect(), } diff --git a/netbox/extras/migrations/0075_customfield_ui_visibility.py b/netbox/extras/migrations/0075_customfield_ui_visibility.py new file mode 100644 index 000000000..29ee65516 --- /dev/null +++ b/netbox/extras/migrations/0075_customfield_ui_visibility.py @@ -0,0 +1,18 @@ +# Generated by Django 4.0.4 on 2022-05-23 20:23 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('extras', '0074_customfield_group_name'), + ] + + operations = [ + migrations.AddField( + model_name='customfield', + name='ui_visibility', + field=models.CharField(default='read-write', max_length=50), + ), + ] diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index 55caa4a70..c48b6895c 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -136,6 +136,12 @@ class CustomField(ExportTemplatesMixin, WebhooksMixin, ChangeLoggedModel): null=True, help_text='Comma-separated list of available choices (for selection fields)' ) + ui_visibility = models.CharField( + max_length=50, + choices=CustomFieldVisibilityChoices, + default=CustomFieldVisibilityChoices.VISIBILITY_READ_WRITE, + help_text='Specifies the visibility of custom field in the UI.' + ) objects = CustomFieldManager() class Meta: diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py index 1a0f5d58a..d294fd231 100644 --- a/netbox/extras/tables/tables.py +++ b/netbox/extras/tables/tables.py @@ -28,12 +28,13 @@ class CustomFieldTable(NetBoxTable): ) content_types = columns.ContentTypesColumn() required = columns.BooleanColumn() + ui_visibility = columns.ChoiceFieldColumn(verbose_name="UI visibility") class Meta(NetBoxTable.Meta): model = CustomField fields = ( 'pk', 'id', 'name', 'content_types', 'label', 'type', 'group_name', 'required', 'weight', 'default', - 'description', 'filter_logic', 'choices', 'created', 'last_updated', + 'description', 'filter_logic', 'choices', 'created', 'last_updated', 'ui_visibility', ) default_columns = ('pk', 'name', 'content_types', 'label', 'group_name', 'type', 'required', 'description') diff --git a/netbox/extras/tests/test_views.py b/netbox/extras/tests/test_views.py index ea3a952d6..0a9d85e15 100644 --- a/netbox/extras/tests/test_views.py +++ b/netbox/extras/tests/test_views.py @@ -36,13 +36,14 @@ class CustomFieldTestCase(ViewTestCases.PrimaryObjectViewTestCase): 'default': None, 'weight': 200, 'required': True, + 'ui_visibility': CustomFieldVisibilityChoices.VISIBILITY_READ_WRITE, } cls.csv_data = ( - 'name,label,type,content_types,weight,filter_logic,choices,validation_minimum,validation_maximum,validation_regex', - 'field4,Field 4,text,dcim.site,100,exact,,,,[a-z]{3}', - 'field5,Field 5,integer,dcim.site,100,exact,,1,100,', - 'field6,Field 6,select,dcim.site,100,exact,"A,B,C",,,', + 'name,label,type,content_types,weight,filter_logic,choices,validation_minimum,validation_maximum,validation_regex,ui_visibility', + 'field4,Field 4,text,dcim.site,100,exact,,,,[a-z]{3},read-write', + 'field5,Field 5,integer,dcim.site,100,exact,,1,100,,read-write', + 'field6,Field 6,select,dcim.site,100,exact,"A,B,C",,,,read-write', ) cls.bulk_edit_data = { diff --git a/netbox/netbox/models/features.py b/netbox/netbox/models/features.py index 4bd1b0e9c..76b546192 100644 --- a/netbox/netbox/models/features.py +++ b/netbox/netbox/models/features.py @@ -9,7 +9,7 @@ from django.core.validators import ValidationError from django.db import models from taggit.managers import TaggableManager -from extras.choices import ObjectChangeActionChoices +from extras.choices import CustomFieldVisibilityChoices, ObjectChangeActionChoices from extras.utils import register_features from netbox.signals import post_clean from utilities.utils import serialize_object @@ -100,7 +100,7 @@ class CustomFieldsMixin(models.Model): """ return self.custom_field_data - def get_custom_fields(self): + def get_custom_fields(self, omit_hidden=False): """ Return a dictionary of custom fields for a single object in the form `{field: value}`. @@ -114,6 +114,10 @@ class CustomFieldsMixin(models.Model): data = {} for field in CustomField.objects.get_for_model(self): + # Skip fields that are hidden if 'omit_hidden' is set + if omit_hidden and field.ui_visibility == CustomFieldVisibilityChoices.VISIBILITY_HIDDEN: + continue + value = self.custom_field_data.get(field.name) data[field] = field.deserialize(value) @@ -124,7 +128,7 @@ class CustomFieldsMixin(models.Model): Return a dictionary of custom field/value mappings organized by group. """ grouped_custom_fields = defaultdict(dict) - for cf, value in self.get_custom_fields().items(): + for cf, value in self.get_custom_fields(omit_hidden=True).items(): grouped_custom_fields[cf.group_name][cf] = value return dict(grouped_custom_fields) diff --git a/netbox/templates/extras/customfield.html b/netbox/templates/extras/customfield.html index dc51d3e82..72dc2e4c3 100644 --- a/netbox/templates/extras/customfield.html +++ b/netbox/templates/extras/customfield.html @@ -42,6 +42,10 @@
      + + + +
      Site{{ terminations.0.device.site|linkify }}
      Device {{ terminations.0.device|linkify }}
      Site{{ terminations.0.device.site|linkify }}Rack{{ terminations.0.device.rack|linkify|placeholder }}
      Rack{{ terminations.0.device.rack|linkify }}
      Type {{ terminations.0|meta:"verbose_name"|capfirst }}
      Name(s) {% for term in terminations %} {{ term|linkify }}{% if not forloop.last %},{% endif %} From a909ceda84f030591ca4929dee2cfb77076e76f2 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 18 May 2022 15:49:52 -0400 Subject: [PATCH 062/593] Simplify assignment of new cable terminations --- netbox/dcim/forms/connections.py | 27 +++----------- netbox/dcim/models/cables.py | 64 +++++++++++++++++++++++++------- netbox/dcim/signals.py | 32 ++++++---------- 3 files changed, 67 insertions(+), 56 deletions(-) diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index 7058c01d6..66a9e9c6e 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -29,30 +29,13 @@ class BaseCableConnectionForm(TenancyForm, NetBoxModelForm): disabled_indicator='_occupied' ) - def save(self, commit=True): - instance = super().save(commit=commit) + def save(self, *args, **kwargs): - # Create CableTermination instances - terminations = [] - terminations.extend([ - CableTermination(cable=instance, cable_end='A', termination=termination) - for termination in self.cleaned_data['a_terminations'] - ]) - terminations.extend([ - CableTermination(cable=instance, cable_end='B', termination=termination) - for termination in self.cleaned_data['b_terminations'] - ]) + # Set the A/B terminations on the Cable instance + self.instance.a_terminations = self.cleaned_data['a_terminations'] + self.instance.b_terminations = self.cleaned_data['b_terminations'] - if commit: - for ct in terminations: - ct.save() - else: - instance._terminations = [ - *self.cleaned_data['a_terminations'], - *self.cleaned_data['b_terminations'], - ] - - return instance + return super().save(*args, **kwargs) class ConnectCableToDeviceForm(BaseCableConnectionForm): diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index dd5599a1d..42c298279 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -5,6 +5,7 @@ from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ValidationError from django.db import models from django.db.models import Sum +from django.dispatch import Signal from django.urls import reverse from dcim.choices import * @@ -27,6 +28,9 @@ __all__ = ( ) +trace_paths = Signal() + + # # Cables # @@ -107,20 +111,10 @@ class Cable(NetBoxModel): self._orig_status = self.status # Assign associated CableTerminations (if any) - terminations = [] - if a_terminations and type(a_terminations) is list: - terminations.extend([ - CableTermination(cable=self, cable_end='A', termination=t) for t in a_terminations - ]) - if b_terminations and type(b_terminations) is list: - terminations.extend([ - CableTermination(cable=self, cable_end='B', termination=t) for t in b_terminations - ]) - if terminations: - assert self.pk is None - self._terminations = terminations - else: - self._terminations = [] + if a_terminations is not None: + self.a_terminations = a_terminations + if b_terminations is not None: + self.b_terminations = b_terminations @classmethod def from_db(cls, db, field_names, values): @@ -164,6 +158,7 @@ class Cable(NetBoxModel): self.length_unit = '' def save(self, *args, **kwargs): + _created = self.pk is None # Store the given length (if any) in meters for use in database ordering if self.length and self.length_unit: @@ -183,6 +178,32 @@ class Cable(NetBoxModel): # Update the private pk used in __str__ in case this is a new object (i.e. just got its pk) self._pk = self.pk + # Retrieve existing A/B terminations for the Cable + a_terminations = {ct.termination: ct for ct in self.terminations.filter(cable_end='A')} + b_terminations = {ct.termination: ct for ct in self.terminations.filter(cable_end='B')} + + # Delete stale CableTerminations + if hasattr(self, 'a_terminations'): + for termination, ct in a_terminations.items(): + if termination not in self.a_terminations: + ct.delete() + if hasattr(self, 'b_terminations'): + for termination, ct in b_terminations.items(): + if termination not in self.b_terminations: + ct.delete() + + # Save new CableTerminations (if any) + if hasattr(self, 'a_terminations'): + for termination in self.a_terminations: + if termination not in a_terminations: + CableTermination(cable=self, cable_end='A', termination=termination).save() + if hasattr(self, 'b_terminations'): + for termination in self.b_terminations: + if termination not in b_terminations: + CableTermination(cable=self, cable_end='B', termination=termination).save() + + trace_paths.send(Cable, instance=self, created=_created) + def get_status_color(self): return LinkStatusChoices.colors.get(self.status) @@ -271,6 +292,21 @@ class CableTermination(models.Model): # f"Incompatible termination types: {self.termination_a_type} and {self.termination_b_type}" # ) + def save(self, *args, **kwargs): + super().save(*args, **kwargs) + + # Set the cable on the terminating object + termination_model = self.termination._meta.model + termination_model.objects.filter(pk=self.termination_id).update(cable=self.cable) + + def delete(self, *args, **kwargs): + + # Delete the cable association on the terminating object + termination_model = self.termination._meta.model + termination_model.objects.filter(pk=self.termination_id).update(cable=None) + + super().delete(*args, **kwargs) + class CablePath(models.Model): """ diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 48fb2f25c..9ea8dd9f8 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -1,12 +1,11 @@ -from collections import defaultdict import logging -from django.contrib.contenttypes.models import ContentType from django.db.models.signals import post_save, post_delete, pre_delete from django.dispatch import receiver from .choices import LinkStatusChoices from .models import Cable, CablePath, CableTermination, Device, PathEndpoint, PowerPanel, Rack, Location, VirtualChassis +from .models.cables import trace_paths from .utils import create_cablepath, rebuild_paths @@ -69,8 +68,7 @@ def clear_virtualchassis_members(instance, **kwargs): # Cables # - -@receiver(post_save, sender=Cable) +@receiver(trace_paths, sender=Cable) def update_connected_endpoints(instance, created, raw=False, **kwargs): """ When a Cable is saved, check for and update its two connected endpoints @@ -80,28 +78,22 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): logger.debug(f"Skipping endpoint updates for imported cable {instance}") return - # Save any new CableTerminations - CableTermination.objects.bulk_create([ - term for term in instance._terminations if not term.pk - ]) - - # Split terminations into A/B sets and save link assignments # TODO: Update link peers - _terms = defaultdict(list) - for t in instance._terminations: - if t.termination.cable != instance: - t.termination.cable = instance - t.termination.save() - _terms[t.cable_end].append(t.termination) # Create/update cable paths if created: - for terms in _terms.values(): + _terms = { + 'A': [t.termination for t in instance.terminations.filter(cable_end='A')], + 'B': [t.termination for t in instance.terminations.filter(cable_end='B')], + } + for nodes in _terms.values(): # Examine type of first termination to determine object type (all must be the same) - if isinstance(terms[0], PathEndpoint): - create_cablepath(terms) + if not nodes: + continue + if isinstance(nodes[0], PathEndpoint): + create_cablepath(nodes) else: - rebuild_paths(terms) + rebuild_paths(nodes) elif instance.status != instance._orig_status: # We currently don't support modifying either termination of an existing Cable. (This # may change in the future.) However, we do need to capture status changes and update From d155c39f5972acc433ce391f1b1414bf30fe41e6 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 18 May 2022 16:48:49 -0400 Subject: [PATCH 063/593] Update cable termination type/ID filters --- netbox/dcim/filtersets.py | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index 7da042253..a80062526 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -1499,10 +1499,18 @@ class VirtualChassisFilterSet(NetBoxModelFilterSet): class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): - # termination_a_type = ContentTypeFilter() - # termination_a_id = MultiValueNumberFilter() - # termination_b_type = ContentTypeFilter() - # termination_b_id = MultiValueNumberFilter() + termination_a_type = ContentTypeFilter( + field_name='terminations__termination_type' + ) + termination_a_id = MultiValueNumberFilter( + field_name='terminations__termination_id' + ) + termination_b_type = ContentTypeFilter( + field_name='terminations__termination_type' + ) + termination_b_id = MultiValueNumberFilter( + field_name='terminations__termination_id' + ) type = django_filters.MultipleChoiceFilter( choices=CableTypeChoices ) From 64146b8cb1fa39b7c7ea7dbab900546c46c8504e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 19 May 2022 16:13:22 -0400 Subject: [PATCH 064/593] Closes #8471: Add status field to Cluster --- docs/models/virtualization/cluster.md | 2 +- docs/release-notes/version-3.3.md | 3 +++ netbox/virtualization/api/serializers.py | 5 +++-- netbox/virtualization/choices.py | 22 +++++++++++++++++++ netbox/virtualization/filtersets.py | 4 ++++ netbox/virtualization/forms/bulk_edit.py | 8 ++++++- netbox/virtualization/forms/bulk_import.py | 6 ++++- netbox/virtualization/forms/filtersets.py | 6 ++++- netbox/virtualization/forms/models.py | 8 +++++-- .../migrations/0030_cluster_status.py | 18 +++++++++++++++ netbox/virtualization/models.py | 8 +++++++ netbox/virtualization/tables/clusters.py | 7 +++--- netbox/virtualization/tests/test_api.py | 11 +++++++--- .../virtualization/tests/test_filtersets.py | 10 ++++++--- netbox/virtualization/tests/test_views.py | 16 ++++++++------ 15 files changed, 110 insertions(+), 24 deletions(-) create mode 100644 netbox/virtualization/migrations/0030_cluster_status.py diff --git a/docs/models/virtualization/cluster.md b/docs/models/virtualization/cluster.md index 7fc9bfc06..3e3516cd6 100644 --- a/docs/models/virtualization/cluster.md +++ b/docs/models/virtualization/cluster.md @@ -1,5 +1,5 @@ # Clusters -A cluster is a logical grouping of physical resources within which virtual machines run. A cluster must be assigned a type (technological classification), and may optionally be assigned to a cluster group, site, and/or tenant. Each cluster must have a unique name within its assigned group and/or site, if any. +A cluster is a logical grouping of physical resources within which virtual machines run. A cluster must be assigned a type (technological classification) and operational status, and may optionally be assigned to a cluster group, site, and/or tenant. Each cluster must have a unique name within its assigned group and/or site, if any. Physical devices may be associated with clusters as hosts. This allows users to track on which host(s) a particular virtual machine may reside. However, NetBox does not support pinning a specific VM within a cluster to a particular host device. diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index c46fceea5..d1b6b4cda 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -9,6 +9,7 @@ ### Enhancements * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses +* [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results @@ -23,3 +24,5 @@ * ipam.IPAddress * The `nat_inside` field no longer requires a unique value * The `nat_outside` field has changed from a single IP address instance to a list of multiple IP addresses +* virtualization.Cluster + * Add required `status` field (default value: `active`) diff --git a/netbox/virtualization/api/serializers.py b/netbox/virtualization/api/serializers.py index afdf50b96..e127bd5fa 100644 --- a/netbox/virtualization/api/serializers.py +++ b/netbox/virtualization/api/serializers.py @@ -45,6 +45,7 @@ class ClusterSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='virtualization-api:cluster-detail') type = NestedClusterTypeSerializer() group = NestedClusterGroupSerializer(required=False, allow_null=True, default=None) + status = ChoiceField(choices=ClusterStatusChoices, required=False) tenant = NestedTenantSerializer(required=False, allow_null=True) site = NestedSiteSerializer(required=False, allow_null=True, default=None) device_count = serializers.IntegerField(read_only=True) @@ -53,8 +54,8 @@ class ClusterSerializer(NetBoxModelSerializer): class Meta: model = Cluster fields = [ - 'id', 'url', 'display', 'name', 'type', 'group', 'tenant', 'site', 'comments', 'tags', 'custom_fields', - 'created', 'last_updated', 'device_count', 'virtualmachine_count', + 'id', 'url', 'display', 'name', 'type', 'group', 'status', 'tenant', 'site', 'comments', 'tags', + 'custom_fields', 'created', 'last_updated', 'device_count', 'virtualmachine_count', ] diff --git a/netbox/virtualization/choices.py b/netbox/virtualization/choices.py index 693e53df6..2cf6357e1 100644 --- a/netbox/virtualization/choices.py +++ b/netbox/virtualization/choices.py @@ -1,6 +1,28 @@ from utilities.choices import ChoiceSet +# +# Clusters +# + +class ClusterStatusChoices(ChoiceSet): + key = 'Cluster.status' + + STATUS_PLANNED = 'planned' + STATUS_STAGING = 'staging' + STATUS_ACTIVE = 'active' + STATUS_DECOMMISSIONING = 'decommissioning' + STATUS_OFFLINE = 'offline' + + CHOICES = [ + (STATUS_PLANNED, 'Planned', 'cyan'), + (STATUS_STAGING, 'Staging', 'blue'), + (STATUS_ACTIVE, 'Active', 'green'), + (STATUS_DECOMMISSIONING, 'Decommissioning', 'yellow'), + (STATUS_OFFLINE, 'Offline', 'red'), + ] + + # # VirtualMachines # diff --git a/netbox/virtualization/filtersets.py b/netbox/virtualization/filtersets.py index 5a2aa8b42..63e3557a3 100644 --- a/netbox/virtualization/filtersets.py +++ b/netbox/virtualization/filtersets.py @@ -90,6 +90,10 @@ class ClusterFilterSet(NetBoxModelFilterSet, TenancyFilterSet, ContactModelFilte to_field_name='slug', label='Cluster type (slug)', ) + status = django_filters.MultipleChoiceFilter( + choices=ClusterStatusChoices, + null_value=None + ) class Meta: model = Cluster diff --git a/netbox/virtualization/forms/bulk_edit.py b/netbox/virtualization/forms/bulk_edit.py index d5d33df2a..e7369f53a 100644 --- a/netbox/virtualization/forms/bulk_edit.py +++ b/netbox/virtualization/forms/bulk_edit.py @@ -58,6 +58,12 @@ class ClusterBulkEditForm(NetBoxModelBulkEditForm): queryset=ClusterGroup.objects.all(), required=False ) + status = forms.ChoiceField( + choices=add_blank_choice(ClusterStatusChoices), + required=False, + initial='', + widget=StaticSelect() + ) tenant = DynamicModelChoiceField( queryset=Tenant.objects.all(), required=False @@ -85,7 +91,7 @@ class ClusterBulkEditForm(NetBoxModelBulkEditForm): model = Cluster fieldsets = ( - (None, ('type', 'group', 'tenant',)), + (None, ('type', 'group', 'status', 'tenant',)), ('Site', ('region', 'site_group', 'site',)), ) nullable_fields = ( diff --git a/netbox/virtualization/forms/bulk_import.py b/netbox/virtualization/forms/bulk_import.py index eab6fc9e7..ef688367e 100644 --- a/netbox/virtualization/forms/bulk_import.py +++ b/netbox/virtualization/forms/bulk_import.py @@ -44,6 +44,10 @@ class ClusterCSVForm(NetBoxModelCSVForm): required=False, help_text='Assigned cluster group' ) + status = CSVChoiceField( + choices=ClusterStatusChoices, + help_text='Operational status' + ) site = CSVModelChoiceField( queryset=Site.objects.all(), to_field_name='name', @@ -59,7 +63,7 @@ class ClusterCSVForm(NetBoxModelCSVForm): class Meta: model = Cluster - fields = ('name', 'type', 'group', 'site', 'comments') + fields = ('name', 'type', 'group', 'status', 'site', 'comments') class VirtualMachineCSVForm(NetBoxModelCSVForm): diff --git a/netbox/virtualization/forms/filtersets.py b/netbox/virtualization/forms/filtersets.py index 2f386e889..753f509f7 100644 --- a/netbox/virtualization/forms/filtersets.py +++ b/netbox/virtualization/forms/filtersets.py @@ -35,7 +35,7 @@ class ClusterFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelFi model = Cluster fieldsets = ( (None, ('q', 'tag')), - ('Attributes', ('group_id', 'type_id')), + ('Attributes', ('group_id', 'type_id', 'status')), ('Location', ('region_id', 'site_group_id', 'site_id')), ('Tenant', ('tenant_group_id', 'tenant_id')), ('Contacts', ('contact', 'contact_role')), @@ -50,6 +50,10 @@ class ClusterFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelFi required=False, label=_('Region') ) + status = MultipleChoiceField( + choices=ClusterStatusChoices, + required=False + ) site_group_id = DynamicModelMultipleChoiceField( queryset=SiteGroup.objects.all(), required=False, diff --git a/netbox/virtualization/forms/models.py b/netbox/virtualization/forms/models.py index 314b0bddf..a94cc3920 100644 --- a/netbox/virtualization/forms/models.py +++ b/netbox/virtualization/forms/models.py @@ -79,15 +79,19 @@ class ClusterForm(TenancyForm, NetBoxModelForm): comments = CommentField() fieldsets = ( - ('Cluster', ('name', 'type', 'group', 'region', 'site_group', 'site', 'tags')), + ('Cluster', ('name', 'type', 'group', 'status', 'tags')), + ('Site', ('region', 'site_group', 'site')), ('Tenancy', ('tenant_group', 'tenant')), ) class Meta: model = Cluster fields = ( - 'name', 'type', 'group', 'tenant', 'region', 'site_group', 'site', 'comments', 'tags', + 'name', 'type', 'group', 'status', 'tenant', 'region', 'site_group', 'site', 'comments', 'tags', ) + widgets = { + 'status': StaticSelect(), + } class ClusterAddDevicesForm(BootstrapMixin, forms.Form): diff --git a/netbox/virtualization/migrations/0030_cluster_status.py b/netbox/virtualization/migrations/0030_cluster_status.py new file mode 100644 index 000000000..e836bb914 --- /dev/null +++ b/netbox/virtualization/migrations/0030_cluster_status.py @@ -0,0 +1,18 @@ +# Generated by Django 4.0.4 on 2022-05-19 19:36 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('virtualization', '0029_created_datetimefield'), + ] + + operations = [ + migrations.AddField( + model_name='cluster', + name='status', + field=models.CharField(default='active', max_length=50), + ), + ] diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py index 586bb8a9e..afc450ddd 100644 --- a/netbox/virtualization/models.py +++ b/netbox/virtualization/models.py @@ -119,6 +119,11 @@ class Cluster(NetBoxModel): blank=True, null=True ) + status = models.CharField( + max_length=50, + choices=ClusterStatusChoices, + default=ClusterStatusChoices.STATUS_ACTIVE + ) tenant = models.ForeignKey( to='tenancy.Tenant', on_delete=models.PROTECT, @@ -165,6 +170,9 @@ class Cluster(NetBoxModel): def get_absolute_url(self): return reverse('virtualization:cluster', args=[self.pk]) + def get_status_color(self): + return ClusterStatusChoices.colors.get(self.status) + def clean(self): super().clean() diff --git a/netbox/virtualization/tables/clusters.py b/netbox/virtualization/tables/clusters.py index a0c98425a..dfcae052a 100644 --- a/netbox/virtualization/tables/clusters.py +++ b/netbox/virtualization/tables/clusters.py @@ -66,6 +66,7 @@ class ClusterTable(NetBoxTable): group = tables.Column( linkify=True ) + status = columns.ChoiceFieldColumn() tenant = tables.Column( linkify=True ) @@ -93,7 +94,7 @@ class ClusterTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Cluster fields = ( - 'pk', 'id', 'name', 'type', 'group', 'tenant', 'site', 'comments', 'device_count', 'vm_count', 'contacts', - 'tags', 'created', 'last_updated', + 'pk', 'id', 'name', 'type', 'group', 'status', 'tenant', 'site', 'comments', 'device_count', 'vm_count', + 'contacts', 'tags', 'created', 'last_updated', ) - default_columns = ('pk', 'name', 'type', 'group', 'tenant', 'site', 'device_count', 'vm_count') + default_columns = ('pk', 'name', 'type', 'group', 'status', 'tenant', 'site', 'device_count', 'vm_count') diff --git a/netbox/virtualization/tests/test_api.py b/netbox/virtualization/tests/test_api.py index f6c07fa54..4d559dc49 100644 --- a/netbox/virtualization/tests/test_api.py +++ b/netbox/virtualization/tests/test_api.py @@ -4,6 +4,7 @@ from rest_framework import status from dcim.choices import InterfaceModeChoices from ipam.models import VLAN, VRF from utilities.testing import APITestCase, APIViewTestCases +from virtualization.choices import * from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface @@ -85,6 +86,7 @@ class ClusterTest(APIViewTestCases.APIViewTestCase): model = Cluster brief_fields = ['display', 'id', 'name', 'url', 'virtualmachine_count'] bulk_update_data = { + 'status': 'offline', 'comments': 'New comment', } @@ -104,9 +106,9 @@ class ClusterTest(APIViewTestCases.APIViewTestCase): ClusterGroup.objects.bulk_create(cluster_groups) clusters = ( - Cluster(name='Cluster 1', type=cluster_types[0], group=cluster_groups[0]), - Cluster(name='Cluster 2', type=cluster_types[0], group=cluster_groups[0]), - Cluster(name='Cluster 3', type=cluster_types[0], group=cluster_groups[0]), + Cluster(name='Cluster 1', type=cluster_types[0], group=cluster_groups[0], status=ClusterStatusChoices.STATUS_PLANNED), + Cluster(name='Cluster 2', type=cluster_types[0], group=cluster_groups[0], status=ClusterStatusChoices.STATUS_PLANNED), + Cluster(name='Cluster 3', type=cluster_types[0], group=cluster_groups[0], status=ClusterStatusChoices.STATUS_PLANNED), ) Cluster.objects.bulk_create(clusters) @@ -115,16 +117,19 @@ class ClusterTest(APIViewTestCases.APIViewTestCase): 'name': 'Cluster 4', 'type': cluster_types[1].pk, 'group': cluster_groups[1].pk, + 'status': ClusterStatusChoices.STATUS_STAGING, }, { 'name': 'Cluster 5', 'type': cluster_types[1].pk, 'group': cluster_groups[1].pk, + 'status': ClusterStatusChoices.STATUS_STAGING, }, { 'name': 'Cluster 6', 'type': cluster_types[1].pk, 'group': cluster_groups[1].pk, + 'status': ClusterStatusChoices.STATUS_STAGING, }, ] diff --git a/netbox/virtualization/tests/test_filtersets.py b/netbox/virtualization/tests/test_filtersets.py index 9e264ac5c..8b4e79bed 100644 --- a/netbox/virtualization/tests/test_filtersets.py +++ b/netbox/virtualization/tests/test_filtersets.py @@ -123,9 +123,9 @@ class ClusterTestCase(TestCase, ChangeLoggedFilterSetTests): Tenant.objects.bulk_create(tenants) clusters = ( - Cluster(name='Cluster 1', type=cluster_types[0], group=cluster_groups[0], site=sites[0], tenant=tenants[0]), - Cluster(name='Cluster 2', type=cluster_types[1], group=cluster_groups[1], site=sites[1], tenant=tenants[1]), - Cluster(name='Cluster 3', type=cluster_types[2], group=cluster_groups[2], site=sites[2], tenant=tenants[2]), + Cluster(name='Cluster 1', type=cluster_types[0], group=cluster_groups[0], status=ClusterStatusChoices.STATUS_PLANNED, site=sites[0], tenant=tenants[0]), + Cluster(name='Cluster 2', type=cluster_types[1], group=cluster_groups[1], status=ClusterStatusChoices.STATUS_STAGING, site=sites[1], tenant=tenants[1]), + Cluster(name='Cluster 3', type=cluster_types[2], group=cluster_groups[2], status=ClusterStatusChoices.STATUS_ACTIVE, site=sites[2], tenant=tenants[2]), ) Cluster.objects.bulk_create(clusters) @@ -161,6 +161,10 @@ class ClusterTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'group': [groups[0].slug, groups[1].slug]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_status(self): + params = {'status': [ClusterStatusChoices.STATUS_PLANNED, ClusterStatusChoices.STATUS_STAGING]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_type(self): types = ClusterType.objects.all()[:2] params = {'type_id': [types[0].pk, types[1].pk]} diff --git a/netbox/virtualization/tests/test_views.py b/netbox/virtualization/tests/test_views.py index 8edc14f00..df90bfc37 100644 --- a/netbox/virtualization/tests/test_views.py +++ b/netbox/virtualization/tests/test_views.py @@ -101,9 +101,9 @@ class ClusterTestCase(ViewTestCases.PrimaryObjectViewTestCase): ClusterType.objects.bulk_create(clustertypes) Cluster.objects.bulk_create([ - Cluster(name='Cluster 1', group=clustergroups[0], type=clustertypes[0], site=sites[0]), - Cluster(name='Cluster 2', group=clustergroups[0], type=clustertypes[0], site=sites[0]), - Cluster(name='Cluster 3', group=clustergroups[0], type=clustertypes[0], site=sites[0]), + Cluster(name='Cluster 1', group=clustergroups[0], type=clustertypes[0], status=ClusterStatusChoices.STATUS_ACTIVE, site=sites[0]), + Cluster(name='Cluster 2', group=clustergroups[0], type=clustertypes[0], status=ClusterStatusChoices.STATUS_ACTIVE, site=sites[0]), + Cluster(name='Cluster 3', group=clustergroups[0], type=clustertypes[0], status=ClusterStatusChoices.STATUS_ACTIVE, site=sites[0]), ]) tags = create_tags('Alpha', 'Bravo', 'Charlie') @@ -112,6 +112,7 @@ class ClusterTestCase(ViewTestCases.PrimaryObjectViewTestCase): 'name': 'Cluster X', 'group': clustergroups[1].pk, 'type': clustertypes[1].pk, + 'status': ClusterStatusChoices.STATUS_OFFLINE, 'tenant': None, 'site': sites[1].pk, 'comments': 'Some comments', @@ -119,15 +120,16 @@ class ClusterTestCase(ViewTestCases.PrimaryObjectViewTestCase): } cls.csv_data = ( - "name,type", - "Cluster 4,Cluster Type 1", - "Cluster 5,Cluster Type 1", - "Cluster 6,Cluster Type 1", + "name,type,status", + "Cluster 4,Cluster Type 1,active", + "Cluster 5,Cluster Type 1,active", + "Cluster 6,Cluster Type 1,active", ) cls.bulk_edit_data = { 'group': clustergroups[1].pk, 'type': clustertypes[1].pk, + 'status': ClusterStatusChoices.STATUS_OFFLINE, 'tenant': None, 'site': sites[1].pk, 'comments': 'New comments', From 7b5ff4c1a5df701978d832c67e9a49c325c89b53 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 20 May 2022 16:53:23 -0400 Subject: [PATCH 065/593] Merge cable creation/edit views & forms --- netbox/circuits/urls.py | 4 +- netbox/dcim/forms/connections.py | 407 ++++++------------ netbox/dcim/urls.py | 16 +- netbox/dcim/views.py | 93 ++-- netbox/templates/dcim/cable_connect.html | 167 ------- netbox/templates/dcim/cable_edit.html | 126 +++++- netbox/templates/dcim/inc/cable_form.html | 27 -- .../templates/dcim/inc/cable_termination.html | 22 +- 8 files changed, 310 insertions(+), 552 deletions(-) delete mode 100644 netbox/templates/dcim/cable_connect.html delete mode 100644 netbox/templates/dcim/inc/cable_form.html diff --git a/netbox/circuits/urls.py b/netbox/circuits/urls.py index 894be27f3..323f588eb 100644 --- a/netbox/circuits/urls.py +++ b/netbox/circuits/urls.py @@ -1,6 +1,6 @@ from django.urls import path -from dcim.views import CableCreateView, PathTraceView +from dcim.views import CableEditView, PathTraceView from netbox.views.generic import ObjectChangeLogView, ObjectJournalView from . import views from .models import * @@ -61,6 +61,6 @@ urlpatterns = [ path('circuit-terminations//edit/', views.CircuitTerminationEditView.as_view(), name='circuittermination_edit'), path('circuit-terminations//delete/', views.CircuitTerminationDeleteView.as_view(), name='circuittermination_delete'), path('circuit-terminations//trace/', PathTraceView.as_view(), name='circuittermination_trace', kwargs={'model': CircuitTermination}), - path('circuit-terminations/connect/', CableCreateView.as_view(), name='circuittermination_connect', kwargs={'termination_a_type': CircuitTermination}), + path('circuit-terminations/connect/', CableEditView.as_view(), name='circuittermination_connect', kwargs={'termination_a_type': CircuitTermination}), ] diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index 66a9e9c6e..10ccbb7d9 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -1,305 +1,142 @@ +from django import forms + from circuits.models import Circuit, CircuitTermination, Provider from dcim.models import * -from netbox.forms import NetBoxModelForm -from tenancy.forms import TenancyForm -from utilities.forms import DynamicModelChoiceField, DynamicModelMultipleChoiceField, StaticSelect - -__all__ = ( - 'ConnectCableToCircuitTerminationForm', - 'ConnectCableToConsolePortForm', - 'ConnectCableToConsoleServerPortForm', - 'ConnectCableToFrontPortForm', - 'ConnectCableToInterfaceForm', - 'ConnectCableToPowerFeedForm', - 'ConnectCableToPowerPortForm', - 'ConnectCableToPowerOutletForm', - 'ConnectCableToRearPortForm', -) +from utilities.forms import DynamicModelChoiceField, DynamicModelMultipleChoiceField +from .models import CableForm -class BaseCableConnectionForm(TenancyForm, NetBoxModelForm): - a_terminations = DynamicModelMultipleChoiceField( - queryset=Interface.objects.all(), - label='Name', - disabled_indicator='_occupied' - ) - b_terminations = DynamicModelMultipleChoiceField( - queryset=Interface.objects.all(), - label='Name', - disabled_indicator='_occupied' - ) +def get_cable_form(a_type, b_type): - def save(self, *args, **kwargs): + class FormMetaclass(forms.models.ModelFormMetaclass): - # Set the A/B terminations on the Cable instance - self.instance.a_terminations = self.cleaned_data['a_terminations'] - self.instance.b_terminations = self.cleaned_data['b_terminations'] + def __new__(mcs, name, bases, attrs): - return super().save(*args, **kwargs) + for cable_end, term_cls in (('a', a_type), ('b', b_type)): + attrs[f'termination_{cable_end}_region'] = DynamicModelChoiceField( + queryset=Region.objects.all(), + label='Region', + required=False, + initial_params={ + 'sites': '$termination_{cable_end}_site' + } + ) + attrs[f'termination_{cable_end}_sitegroup'] = DynamicModelChoiceField( + queryset=SiteGroup.objects.all(), + label='Site group', + required=False, + initial_params={ + 'sites': '$termination_{cable_end}_site' + } + ) + attrs[f'termination_{cable_end}_site'] = DynamicModelChoiceField( + queryset=Site.objects.all(), + label='Site', + required=False, + query_params={ + 'region_id': '$termination_{cable_end}_region', + 'group_id': '$termination_{cable_end}_sitegroup', + } + ) + attrs[f'termination_{cable_end}_location'] = DynamicModelChoiceField( + queryset=Location.objects.all(), + label='Location', + required=False, + null_option='None', + query_params={ + 'site_id': '$termination_{cable_end}_site' + } + ) -class ConnectCableToDeviceForm(BaseCableConnectionForm): - """ - Base form for connecting a Cable to a Device component - """ - termination_b_region = DynamicModelChoiceField( - queryset=Region.objects.all(), - label='Region', - required=False, - initial_params={ - 'sites': '$termination_b_site' - } - ) - termination_b_sitegroup = DynamicModelChoiceField( - queryset=SiteGroup.objects.all(), - label='Site group', - required=False, - initial_params={ - 'sites': '$termination_b_site' - } - ) - termination_b_site = DynamicModelChoiceField( - queryset=Site.objects.all(), - label='Site', - required=False, - query_params={ - 'region_id': '$termination_b_region', - 'group_id': '$termination_b_sitegroup', - } - ) - termination_b_location = DynamicModelChoiceField( - queryset=Location.objects.all(), - label='Location', - required=False, - null_option='None', - query_params={ - 'site_id': '$termination_b_site' - } - ) - termination_b_rack = DynamicModelChoiceField( - queryset=Rack.objects.all(), - label='Rack', - required=False, - null_option='None', - query_params={ - 'site_id': '$termination_b_site', - 'location_id': '$termination_b_location', - } - ) - termination_b_device = DynamicModelChoiceField( - queryset=Device.objects.all(), - label='Device', - required=False, - query_params={ - 'site_id': '$termination_b_site', - 'location_id': '$termination_b_location', - 'rack_id': '$termination_b_rack', - } - ) + # Device component + if hasattr(term_cls, 'device'): - class Meta: - model = Cable - fields = [ - 'a_terminations', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', - 'termination_b_rack', 'termination_b_device', 'b_terminations', 'type', 'status', 'tenant_group', - 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', - ] - widgets = { - 'status': StaticSelect, - 'type': StaticSelect, - 'length_unit': StaticSelect, - } + attrs[f'termination_{cable_end}_rack'] = DynamicModelChoiceField( + queryset=Rack.objects.all(), + label='Rack', + required=False, + null_option='None', + query_params={ + 'site_id': '$termination_{cable_end}_site', + 'location_id': '$termination_{cable_end}_location', + } + ) + attrs[f'termination_{cable_end}_device'] = DynamicModelChoiceField( + queryset=Device.objects.all(), + label='Device', + required=False, + query_params={ + 'site_id': f'$termination_{cable_end}_site', + 'location_id': f'$termination_{cable_end}_location', + 'rack_id': f'$termination_{cable_end}_rack', + } + ) + attrs[f'{cable_end}_terminations'] = DynamicModelMultipleChoiceField( + queryset=term_cls.objects.all(), + label=term_cls._meta.verbose_name.title(), + disabled_indicator='_occupied', + query_params={ + 'device_id': f'termination_{cable_end}_device', + } + ) + # PowerFeed + elif term_cls == PowerFeed: -class ConnectCableToConsolePortForm(ConnectCableToDeviceForm): - b_terminations = DynamicModelMultipleChoiceField( - queryset=ConsolePort.objects.all(), - label='Name', - disabled_indicator='_occupied', - query_params={ - 'device_id': '$termination_b_device' - } - ) + attrs[f'termination_{cable_end}_powerpanel'] = DynamicModelChoiceField( + queryset=PowerPanel.objects.all(), + label='Power Panel', + required=False, + query_params={ + 'site_id': f'$termination_{cable_end}_site', + 'location_id': f'$termination_{cable_end}_location', + } + ) + attrs[f'{cable_end}_terminations'] = DynamicModelMultipleChoiceField( + queryset=term_cls.objects.all(), + label='Power Feed', + disabled_indicator='_occupied', + query_params={ + 'powerpanel_id': f'termination_{cable_end}_powerpanel', + } + ) + # CircuitTermination + elif term_cls == CircuitTermination: -class ConnectCableToConsoleServerPortForm(ConnectCableToDeviceForm): - b_terminations = DynamicModelMultipleChoiceField( - queryset=ConsoleServerPort.objects.all(), - label='Name', - disabled_indicator='_occupied', - query_params={ - 'device_id': '$termination_b_device' - } - ) + attrs[f'termination_{cable_end}_provider'] = DynamicModelChoiceField( + queryset=Provider.objects.all(), + label='Provider', + required=False + ) + attrs[f'termination_{cable_end}_circuit'] = DynamicModelChoiceField( + queryset=Circuit.objects.all(), + label='Circuit', + query_params={ + 'provider_id': f'$termination_{cable_end}_provider', + 'site_id': f'$termination_{cable_end}_site', + } + ) + attrs[f'{cable_end}_terminations'] = DynamicModelMultipleChoiceField( + queryset=term_cls.objects.all(), + label='Side', + disabled_indicator='_occupied', + query_params={ + 'circuit_id': f'termination_{cable_end}_circuit', + } + ) + return super().__new__(mcs, name, bases, attrs) -class ConnectCableToPowerPortForm(ConnectCableToDeviceForm): - b_terminations = DynamicModelMultipleChoiceField( - queryset=PowerPort.objects.all(), - label='Name', - disabled_indicator='_occupied', - query_params={ - 'device_id': '$termination_b_device' - } - ) + class _CableForm(CableForm, metaclass=FormMetaclass): + def save(self, *args, **kwargs): -class ConnectCableToPowerOutletForm(ConnectCableToDeviceForm): - b_terminations = DynamicModelMultipleChoiceField( - queryset=PowerOutlet.objects.all(), - label='Name', - disabled_indicator='_occupied', - query_params={ - 'device_id': '$termination_b_device' - } - ) + # Set the A/B terminations on the Cable instance + self.instance.a_terminations = self.cleaned_data['a_terminations'] + self.instance.b_terminations = self.cleaned_data['b_terminations'] + return super().save(*args, **kwargs) -class ConnectCableToInterfaceForm(ConnectCableToDeviceForm): - b_terminations = DynamicModelMultipleChoiceField( - queryset=Interface.objects.all(), - label='Name', - disabled_indicator='_occupied', - query_params={ - 'device_id': '$termination_b_device', - 'kind': 'physical', - } - ) - - -class ConnectCableToFrontPortForm(ConnectCableToDeviceForm): - b_terminations = DynamicModelMultipleChoiceField( - queryset=FrontPort.objects.all(), - label='Name', - disabled_indicator='_occupied', - query_params={ - 'device_id': '$termination_b_device' - } - ) - - -class ConnectCableToRearPortForm(ConnectCableToDeviceForm): - b_terminations = DynamicModelMultipleChoiceField( - queryset=RearPort.objects.all(), - label='Name', - disabled_indicator='_occupied', - query_params={ - 'device_id': '$termination_b_device' - } - ) - - -class ConnectCableToCircuitTerminationForm(BaseCableConnectionForm): - termination_b_provider = DynamicModelChoiceField( - queryset=Provider.objects.all(), - label='Provider', - required=False - ) - termination_b_region = DynamicModelChoiceField( - queryset=Region.objects.all(), - label='Region', - required=False, - initial_params={ - 'sites': '$termination_b_site' - } - ) - termination_b_sitegroup = DynamicModelChoiceField( - queryset=SiteGroup.objects.all(), - label='Site group', - required=False, - initial_params={ - 'sites': '$termination_b_site' - } - ) - termination_b_site = DynamicModelChoiceField( - queryset=Site.objects.all(), - label='Site', - required=False, - query_params={ - 'region_id': '$termination_b_region', - 'group_id': '$termination_b_sitegroup', - } - ) - termination_b_circuit = DynamicModelChoiceField( - queryset=Circuit.objects.all(), - label='Circuit', - query_params={ - 'provider_id': '$termination_b_provider', - 'site_id': '$termination_b_site', - } - ) - b_terminations = DynamicModelMultipleChoiceField( - queryset=CircuitTermination.objects.all(), - label='Side', - disabled_indicator='_occupied', - query_params={ - 'circuit_id': '$termination_b_circuit' - } - ) - - class Meta(ConnectCableToDeviceForm.Meta): - fields = [ - 'a_terminations', 'termination_b_provider', 'termination_b_region', 'termination_b_sitegroup', - 'termination_b_site', 'termination_b_circuit', 'b_terminations', 'type', 'status', 'tenant_group', - 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', - ] - - -class ConnectCableToPowerFeedForm(BaseCableConnectionForm): - termination_b_region = DynamicModelChoiceField( - queryset=Region.objects.all(), - label='Region', - required=False, - initial_params={ - 'sites': '$termination_b_site' - } - ) - termination_b_sitegroup = DynamicModelChoiceField( - queryset=SiteGroup.objects.all(), - label='Site group', - required=False, - initial_params={ - 'sites': '$termination_b_site' - } - ) - termination_b_site = DynamicModelChoiceField( - queryset=Site.objects.all(), - label='Site', - required=False, - query_params={ - 'region_id': '$termination_b_region', - 'group_id': '$termination_b_sitegroup', - } - ) - termination_b_location = DynamicModelChoiceField( - queryset=Location.objects.all(), - label='Location', - required=False, - query_params={ - 'site_id': '$termination_b_site' - } - ) - termination_b_powerpanel = DynamicModelChoiceField( - queryset=PowerPanel.objects.all(), - label='Power Panel', - required=False, - query_params={ - 'site_id': '$termination_b_site', - 'location_id': '$termination_b_location', - } - ) - b_terminations = DynamicModelMultipleChoiceField( - queryset=PowerFeed.objects.all(), - label='Name', - disabled_indicator='_occupied', - query_params={ - 'power_panel_id': '$termination_b_powerpanel' - } - ) - - class Meta(ConnectCableToDeviceForm.Meta): - fields = [ - 'a_terminations', 'termination_b_region', 'termination_b_sitegroup', 'termination_b_site', - 'termination_b_location', 'termination_b_powerpanel', 'b_terminations', 'type', 'status', 'tenant_group', - 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', - ] + return _CableForm diff --git a/netbox/dcim/urls.py b/netbox/dcim/urls.py index 0c04c734e..8aa5f694a 100644 --- a/netbox/dcim/urls.py +++ b/netbox/dcim/urls.py @@ -294,7 +294,7 @@ urlpatterns = [ path('console-ports//delete/', views.ConsolePortDeleteView.as_view(), name='consoleport_delete'), path('console-ports//changelog/', ObjectChangeLogView.as_view(), name='consoleport_changelog', kwargs={'model': ConsolePort}), path('console-ports//trace/', views.PathTraceView.as_view(), name='consoleport_trace', kwargs={'model': ConsolePort}), - path('console-ports/connect/', views.CableCreateView.as_view(), name='consoleport_connect', kwargs={'termination_a_type': ConsolePort}), + path('console-ports/connect/', views.CableEditView.as_view(), name='consoleport_connect', kwargs={'termination_a_type': ConsolePort}), path('devices/console-ports/add/', views.DeviceBulkAddConsolePortView.as_view(), name='device_bulk_add_consoleport'), # Console server ports @@ -310,7 +310,7 @@ urlpatterns = [ path('console-server-ports//delete/', views.ConsoleServerPortDeleteView.as_view(), name='consoleserverport_delete'), path('console-server-ports//changelog/', ObjectChangeLogView.as_view(), name='consoleserverport_changelog', kwargs={'model': ConsoleServerPort}), path('console-server-ports//trace/', views.PathTraceView.as_view(), name='consoleserverport_trace', kwargs={'model': ConsoleServerPort}), - path('console-server-ports/connect/', views.CableCreateView.as_view(), name='consoleserverport_connect', kwargs={'termination_a_type': ConsoleServerPort}), + path('console-server-ports/connect/', views.CableEditView.as_view(), name='consoleserverport_connect', kwargs={'termination_a_type': ConsoleServerPort}), path('devices/console-server-ports/add/', views.DeviceBulkAddConsoleServerPortView.as_view(), name='device_bulk_add_consoleserverport'), # Power ports @@ -326,7 +326,7 @@ urlpatterns = [ path('power-ports//delete/', views.PowerPortDeleteView.as_view(), name='powerport_delete'), path('power-ports//changelog/', ObjectChangeLogView.as_view(), name='powerport_changelog', kwargs={'model': PowerPort}), path('power-ports//trace/', views.PathTraceView.as_view(), name='powerport_trace', kwargs={'model': PowerPort}), - path('power-ports/connect/', views.CableCreateView.as_view(), name='powerport_connect', kwargs={'termination_a_type': PowerPort}), + path('power-ports/connect/', views.CableEditView.as_view(), name='powerport_connect', kwargs={'termination_a_type': PowerPort}), path('devices/power-ports/add/', views.DeviceBulkAddPowerPortView.as_view(), name='device_bulk_add_powerport'), # Power outlets @@ -342,7 +342,7 @@ urlpatterns = [ path('power-outlets//delete/', views.PowerOutletDeleteView.as_view(), name='poweroutlet_delete'), path('power-outlets//changelog/', ObjectChangeLogView.as_view(), name='poweroutlet_changelog', kwargs={'model': PowerOutlet}), path('power-outlets//trace/', views.PathTraceView.as_view(), name='poweroutlet_trace', kwargs={'model': PowerOutlet}), - path('power-outlets/connect/', views.CableCreateView.as_view(), name='poweroutlet_connect', kwargs={'termination_a_type': PowerOutlet}), + path('power-outlets/connect/', views.CableEditView.as_view(), name='poweroutlet_connect', kwargs={'termination_a_type': PowerOutlet}), path('devices/power-outlets/add/', views.DeviceBulkAddPowerOutletView.as_view(), name='device_bulk_add_poweroutlet'), # Interfaces @@ -358,7 +358,7 @@ urlpatterns = [ path('interfaces//delete/', views.InterfaceDeleteView.as_view(), name='interface_delete'), path('interfaces//changelog/', ObjectChangeLogView.as_view(), name='interface_changelog', kwargs={'model': Interface}), path('interfaces//trace/', views.PathTraceView.as_view(), name='interface_trace', kwargs={'model': Interface}), - path('interfaces/connect/', views.CableCreateView.as_view(), name='interface_connect', kwargs={'termination_a_type': Interface}), + path('interfaces/connect/', views.CableEditView.as_view(), name='interface_connect', kwargs={'termination_a_type': Interface}), path('devices/interfaces/add/', views.DeviceBulkAddInterfaceView.as_view(), name='device_bulk_add_interface'), # Front ports @@ -374,7 +374,7 @@ urlpatterns = [ path('front-ports//delete/', views.FrontPortDeleteView.as_view(), name='frontport_delete'), path('front-ports//changelog/', ObjectChangeLogView.as_view(), name='frontport_changelog', kwargs={'model': FrontPort}), path('front-ports//trace/', views.PathTraceView.as_view(), name='frontport_trace', kwargs={'model': FrontPort}), - path('front-ports/connect/', views.CableCreateView.as_view(), name='frontport_connect', kwargs={'termination_a_type': FrontPort}), + path('front-ports/connect/', views.CableEditView.as_view(), name='frontport_connect', kwargs={'termination_a_type': FrontPort}), # path('devices/front-ports/add/', views.DeviceBulkAddFrontPortView.as_view(), name='device_bulk_add_frontport'), # Rear ports @@ -390,7 +390,7 @@ urlpatterns = [ path('rear-ports//delete/', views.RearPortDeleteView.as_view(), name='rearport_delete'), path('rear-ports//changelog/', ObjectChangeLogView.as_view(), name='rearport_changelog', kwargs={'model': RearPort}), path('rear-ports//trace/', views.PathTraceView.as_view(), name='rearport_trace', kwargs={'model': RearPort}), - path('rear-ports/connect/', views.CableCreateView.as_view(), name='rearport_connect', kwargs={'termination_a_type': RearPort}), + path('rear-ports/connect/', views.CableEditView.as_view(), name='rearport_connect', kwargs={'termination_a_type': RearPort}), path('devices/rear-ports/add/', views.DeviceBulkAddRearPortView.as_view(), name='device_bulk_add_rearport'), # Module bays @@ -500,6 +500,6 @@ urlpatterns = [ path('power-feeds//trace/', views.PathTraceView.as_view(), name='powerfeed_trace', kwargs={'model': PowerFeed}), path('power-feeds//changelog/', ObjectChangeLogView.as_view(), name='powerfeed_changelog', kwargs={'model': PowerFeed}), path('power-feeds//journal/', ObjectJournalView.as_view(), name='powerfeed_journal', kwargs={'model': PowerFeed}), - path('power-feeds/connect/', views.CableCreateView.as_view(), name='powerfeed_connect', kwargs={'termination_a_type': PowerFeed}), + path('power-feeds/connect/', views.CableEditView.as_view(), name='powerfeed_connect', kwargs={'termination_a_type': PowerFeed}), ] diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 5c27f734e..1f13e2dc8 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -12,12 +12,12 @@ from django.utils.html import escape from django.utils.safestring import mark_safe from django.views.generic import View -from circuits.models import Circuit +from circuits.models import Circuit, CircuitTermination from extras.views import ObjectConfigContextView 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 +from utilities.forms import ConfirmationForm, restrict_form_fields from utilities.paginator import EnhancedPaginator, get_paginate_count from utilities.permissions import get_permission_for_model from utilities.utils import count_related @@ -2804,72 +2804,49 @@ class PathTraceView(generic.ObjectView): } -class CableCreateView(generic.ObjectEditView): +class CableEditView(generic.ObjectEditView): queryset = Cable.objects.all() - template_name = 'dcim/cable_connect.html' + template_name = 'dcim/cable_edit.html' def dispatch(self, request, *args, **kwargs): - # Set the form class based on the type of component being connected - self.form = { - 'dcim.consoleport': forms.ConnectCableToConsolePortForm, - 'dcim.consoleserverport': forms.ConnectCableToConsoleServerPortForm, - 'dcim.powerport': forms.ConnectCableToPowerPortForm, - 'dcim.poweroutlet': forms.ConnectCableToPowerOutletForm, - 'dcim.interface': forms.ConnectCableToInterfaceForm, - 'dcim.frontport': forms.ConnectCableToFrontPortForm, - 'dcim.rearport': forms.ConnectCableToRearPortForm, - 'dcim.powerfeed': forms.ConnectCableToPowerFeedForm, - 'circuits.circuittermination': forms.ConnectCableToCircuitTerminationForm, - }[request.GET.get('termination_b_type')] + # If creating a new Cable, initialize the form class using URL query params + if 'pk' not in kwargs: + termination_types = { + 'dcim.consoleport': ConsolePort, + 'dcim.consoleserverport': ConsoleServerPort, + 'dcim.powerport': PowerPort, + 'dcim.poweroutlet': PowerOutlet, + 'dcim.interface': Interface, + 'dcim.frontport': FrontPort, + 'dcim.rearport': RearPort, + 'dcim.powerfeed': PowerFeed, + 'circuits.circuittermination': CircuitTermination, + } + + a_type = kwargs.pop('termination_a_type') + b_type = termination_types[request.GET.get('termination_b_type')] + + self.form = forms.get_cable_form(a_type, b_type) return super().dispatch(request, *args, **kwargs) def get_object(self, **kwargs): - # Always return a new instance - return self.queryset.model() + """ + Hack into get_object() to set the form class when editing an existing Cable, since ObjectEditView + doesn't currently provide a hook for dynamic class resolution. + """ + obj = super().get_object(**kwargs) - def get(self, request, *args, **kwargs): - obj = self.get_object(**kwargs) - obj = self.alter_object(obj, request, args, kwargs) - initial_data = request.GET + if obj.pk: + # TODO: Optimize this logic + termination_a = obj.terminations.filter(cable_end='A').first() + a_type = termination_a.termination._meta.model if termination_a else None + termination_b = obj.terminations.filter(cable_end='B').first() + b_type = termination_b.termination._meta.model if termination_a else None + self.form = forms.get_cable_form(a_type, b_type) - app_label, model = request.GET.get('termination_b_type').split('.') - termination_b_type = ContentType.objects.get(app_label=app_label, model=model) - - # TODO - # # Set initial site and rack based on side A termination (if not already set) - # termination_a_site = getattr(obj.termination_a.parent_object, 'site', None) - # if 'termination_b_site' not in initial_data: - # initial_data['termination_b_site'] = termination_a_site - # if 'termination_b_rack' not in initial_data: - # initial_data['termination_b_rack'] = getattr(obj.termination_a.parent_object, 'rack', None) - form = self.form(instance=obj, initial=initial_data) - - # TODO Find a better way to infer the near-end parent object - termination_a = kwargs['termination_a_type'].objects.filter(pk=int(initial_data['a_terminations'])).first() - - # Set the queryset of termination A - form.fields['a_terminations'].queryset = kwargs['termination_a_type'].objects.all() - form.fields['a_terminations'].widget.add_query_params({ - 'device_id': termination_a.device_id, - }) - - return render(request, self.template_name, { - 'obj': obj, - 'obj_type': Cable._meta.verbose_name, - 'termination_a_type': kwargs['termination_a_type']._meta.model_name, - 'termination_a_parent': termination_a.parent_object, - 'termination_b_type': termination_b_type.name, - 'form': form, - 'return_url': self.get_return_url(request, obj), - }) - - -class CableEditView(generic.ObjectEditView): - queryset = Cable.objects.all() - form = forms.CableForm - template_name = 'dcim/cable_edit.html' + return obj class CableDeleteView(generic.ObjectDeleteView): diff --git a/netbox/templates/dcim/cable_connect.html b/netbox/templates/dcim/cable_connect.html deleted file mode 100644 index fdbc4cf97..000000000 --- a/netbox/templates/dcim/cable_connect.html +++ /dev/null @@ -1,167 +0,0 @@ -{% extends 'base/layout.html' %} -{% load static %} -{% load helpers %} -{% load form_helpers %} - -{% block title %}Connect Cable to {{ termination_b_type|bettertitle }}{% endblock %} - -{% block tabs %} - -{% endblock %} - -{% block content-wrapper %} -
      - {% render_errors form %} -
      - {% csrf_token %} - {% for field in form.hidden_fields %} - {{ field }} - {% endfor %} -
      -
      -
      -
      A Side
      -
      - {% if termination_a_type == 'circuit' %} - {# Circuit termination #} -
      - -
      - -
      -
      -
      - -
      - -
      -
      - {% else %} - {# Device component #} -
      - -
      - -
      -
      -
      - -
      - -
      -
      -
      - -
      - -
      -
      -
      - -
      - -
      -
      -
      - -
      - -
      -
      -
      - -
      - -
      -
      -
      - -
      - -
      -
      - {% endif %} - {% render_field form.a_terminations %} -
      -
      -
      -
      - -
      -
      -
      -
      B Side
      -
      - {% if tabs %} -
        - {% for url, link in tabs %} - - {% endfor %} -
      - {% endif %} - {% if 'termination_b_provider' in form.fields %} - {% render_field form.termination_b_provider %} - {% endif %} - {% if 'termination_b_region' in form.fields %} - {% render_field form.termination_b_region %} - {% endif %} - {% if 'termination_b_sitegroup' in form.fields %} - {% render_field form.termination_b_sitegroup %} - {% endif %} - {% if 'termination_b_site' in form.fields %} - {% render_field form.termination_b_site %} - {% endif %} - {% if 'termination_b_location' in form.fields %} - {% render_field form.termination_b_location %} - {% endif %} - {% if 'termination_b_rack' in form.fields %} - {% render_field form.termination_b_rack %} - {% endif %} - {% if 'termination_b_device' in form.fields %} - {% render_field form.termination_b_device %} - {% endif %} - {% if 'termination_b_type' in form.fields %} - {% render_field form.termination_b_type %} - {% endif %} - {% if 'termination_b_powerpanel' in form.fields %} - {% render_field form.termination_b_powerpanel %} - {% endif %} - {% if 'termination_b_circuit' in form.fields %} - {% render_field form.termination_b_circuit %} - {% endif %} -
      - -
      - -
      -
      - {% render_field form.b_terminations %} -
      -
      -
      -
      -
      -
      -
      -
      Cable
      -
      - {% include 'dcim/inc/cable_form.html' %} -
      -
      -
      -
      -
      -
      - Cancel - -
      -
      -
      -
      -{% endblock %} diff --git a/netbox/templates/dcim/cable_edit.html b/netbox/templates/dcim/cable_edit.html index 45f05faad..e2cef7601 100644 --- a/netbox/templates/dcim/cable_edit.html +++ b/netbox/templates/dcim/cable_edit.html @@ -1,5 +1,125 @@ -{% extends 'generic/object_edit.html' %} +{% extends 'base/layout.html' %} +{% load static %} +{% load helpers %} +{% load form_helpers %} -{% block form %} - {% include 'dcim/inc/cable_form.html' %} +{% block title %}Connect Cable{% endblock %} + +{% block tabs %} + +{% endblock %} + +{% block content-wrapper %} +
      + {% render_errors form %} +
      + {% csrf_token %} + {% for field in form.hidden_fields %} + {{ field }} + {% endfor %} +
      +
      +
      +
      A Side
      +
      + {% render_field form.termination_a_region %} + {% render_field form.termination_a_sitegroup %} + {% render_field form.termination_a_site %} + {% render_field form.termination_a_location %} + {% if 'termination_a_rack' in form.fields %} + {% render_field form.termination_a_rack %} + {% endif %} + {% if 'termination_a_device' in form.fields %} + {% render_field form.termination_a_device %} + {% endif %} + {% if 'termination_a_powerpanel' in form.fields %} + {% render_field form.termination_a_powerpanel %} + {% endif %} + {% if 'termination_a_provider' in form.fields %} + {% render_field form.termination_a_provider %} + {% endif %} + {% if 'termination_a_circuit' in form.fields %} + {% render_field form.termination_a_circuit %} + {% endif %} + {% render_field form.a_terminations %} +
      +
      +
      +
      + +
      +
      +
      +
      B Side
      +
      + {% render_field form.termination_b_region %} + {% render_field form.termination_b_sitegroup %} + {% render_field form.termination_b_site %} + {% render_field form.termination_b_location %} + {% if 'termination_b_rack' in form.fields %} + {% render_field form.termination_b_rack %} + {% endif %} + {% if 'termination_b_device' in form.fields %} + {% render_field form.termination_b_device %} + {% endif %} + {% if 'termination_b_powerpanel' in form.fields %} + {% render_field form.termination_b_powerpanel %} + {% endif %} + {% if 'termination_b_provider' in form.fields %} + {% render_field form.termination_b_provider %} + {% endif %} + {% if 'termination_b_circuit' in form.fields %} + {% render_field form.termination_b_circuit %} + {% endif %} + {% render_field form.b_terminations %} +
      +
      +
      +
      +
      +
      +
      +
      Cable
      +
      + {% render_field form.status %} + {% render_field form.type %} + {% render_field form.tenant_group %} + {% render_field form.tenant %} + {% render_field form.label %} + {% render_field form.color %} +
      + +
      + {{ form.length }} +
      +
      + {{ form.length_unit }} +
      +
      +
      + {% render_field form.tags %} + {% if form.custom_fields %} +
      +
      +
      Custom Fields
      +
      + {% render_custom_fields form %} +
      + {% endif %} +
      +
      +
      +
      +
      +
      + Cancel + +
      +
      +
      +
      {% endblock %} diff --git a/netbox/templates/dcim/inc/cable_form.html b/netbox/templates/dcim/inc/cable_form.html deleted file mode 100644 index 0f11ac3cb..000000000 --- a/netbox/templates/dcim/inc/cable_form.html +++ /dev/null @@ -1,27 +0,0 @@ -{% load form_helpers %} - -{% render_field form.status %} -{% render_field form.type %} -{% render_field form.tenant_group %} -{% render_field form.tenant %} -{% render_field form.label %} -{% render_field form.color %} -
      - -
      - {{ form.length }} -
      -
      - {{ form.length_unit }} -
      -
      -
      -{% render_field form.tags %} -{% if form.custom_fields %} -
      -
      -
      Custom Fields
      -
      - {% render_custom_fields form %} -
      -{% endif %} diff --git a/netbox/templates/dcim/inc/cable_termination.html b/netbox/templates/dcim/inc/cable_termination.html index a72878b48..9d1c43bdd 100644 --- a/netbox/templates/dcim/inc/cable_termination.html +++ b/netbox/templates/dcim/inc/cable_termination.html @@ -6,13 +6,31 @@       		Site {{ terminations.0.device.site|linkify }}
      Rack{{ terminations.0.device.rack|linkify|placeholder }}
      Device {{ terminations.0.device|linkify }}
      Rack{{ terminations.0.device.rack|linkify|placeholder }}{{ terminations.0|meta:"verbose_name"|capfirst }} + {% for term in terminations %} + {{ term|linkify }}{% if not forloop.last %},{% endif %} + {% endfor %} +
      Site{{ terminations.0.power_panel.site|linkify }}
      Power Panel{{ terminations.0.power_panel|linkify }}
      {{ terminations.0|meta:"verbose_name"|capfirst }}Weight {{ object.weight }}
      UI Visibility{{ object.get_ui_visibility_display }}
      From c14a2a0a392b2dc408e9d08ffc92db1ca0911d81 Mon Sep 17 00:00:00 2001 From: kkthxbye <> Date: Tue, 24 May 2022 10:27:29 +0200 Subject: [PATCH 070/593] Exclude hidden custom fields from tables --- netbox/netbox/tables/tables.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index 5ebb78865..66f5e1f7e 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -7,6 +7,7 @@ from django.db.models.fields.related import RelatedField from django_tables2.data import TableQuerysetData from extras.models import CustomField, CustomLink +from extras.choices import CustomFieldVisibilityChoices from netbox.tables import columns from utilities.paginator import EnhancedPaginator, get_paginate_count @@ -178,7 +179,10 @@ class NetBoxTable(BaseTable): # Add custom field & custom link columns content_type = ContentType.objects.get_for_model(self._meta.model) - custom_fields = CustomField.objects.filter(content_types=content_type) + custom_fields = CustomField.objects.filter( + content_types=content_type + ).exclude(ui_visibility=CustomFieldVisibilityChoices.VISIBILITY_HIDDEN) + extra_columns.extend([ (f'cf_{cf.name}', columns.CustomFieldColumn(cf)) for cf in custom_fields ]) From 6e7c5dcaede247b9e65a9b22cf372ef5df59dab4 Mon Sep 17 00:00:00 2001 From: kkthxbye <> Date: Tue, 24 May 2022 10:38:55 +0200 Subject: [PATCH 071/593] Remove whitespace from blank line --- netbox/netbox/tables/tables.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index 66f5e1f7e..38399b5fe 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -182,7 +182,7 @@ class NetBoxTable(BaseTable): custom_fields = CustomField.objects.filter( content_types=content_type ).exclude(ui_visibility=CustomFieldVisibilityChoices.VISIBILITY_HIDDEN) - + extra_columns.extend([ (f'cf_{cf.name}', columns.CustomFieldColumn(cf)) for cf in custom_fields ]) From 31024ce6724a4c93a21e4b9e0bc2c6eb564d7dd0 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 24 May 2022 16:39:05 -0400 Subject: [PATCH 072/593] Changelog & cleanup for #9166 --- docs/release-notes/version-3.3.md | 3 ++- netbox/extras/api/serializers.py | 4 ++-- netbox/extras/filtersets.py | 3 ++- netbox/extras/forms/bulk_import.py | 3 ++- netbox/extras/forms/customfields.py | 4 ++++ netbox/extras/forms/filtersets.py | 2 +- netbox/extras/forms/models.py | 4 ++-- netbox/extras/models/customfields.py | 3 ++- netbox/extras/tables/tables.py | 2 +- netbox/netbox/models/features.py | 2 +- netbox/templates/extras/customfield.html | 8 ++++---- 11 files changed, 23 insertions(+), 15 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index d1b6b4cda..cefab428e 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -12,6 +12,7 @@ * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results +* [#9166](https://github.com/netbox-community/netbox/issues/9166) - Add UI visibility toggle for custom fields ### Other Changes @@ -20,7 +21,7 @@ ### REST API Changes * extras.CustomField - * Added `group_name` field + * Added `group_name` and `ui_visibility` fields * ipam.IPAddress * The `nat_inside` field no longer requires a unique value * The `nat_outside` field has changed from a single IP address instance to a list of multiple IP addresses diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index 1a26faec1..cb317d6c7 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -90,8 +90,8 @@ class CustomFieldSerializer(ValidatedModelSerializer): model = CustomField fields = [ 'id', 'url', 'display', 'content_types', 'type', 'object_type', 'data_type', 'name', 'label', 'group_name', - 'description', 'required', 'filter_logic', 'default', 'weight', 'validation_minimum', 'validation_maximum', - 'validation_regex', 'choices', 'created', 'last_updated', 'ui_visibility', + 'description', 'required', 'filter_logic', 'ui_visibility', 'default', 'weight', 'validation_minimum', + 'validation_maximum', 'validation_regex', 'choices', 'created', 'last_updated', ] def get_data_type(self, obj): diff --git a/netbox/extras/filtersets.py b/netbox/extras/filtersets.py index ea74dfc82..b59e28018 100644 --- a/netbox/extras/filtersets.py +++ b/netbox/extras/filtersets.py @@ -63,7 +63,8 @@ class CustomFieldFilterSet(BaseFilterSet): class Meta: model = CustomField fields = [ - 'id', 'content_types', 'name', 'group_name', 'required', 'filter_logic', 'weight', 'description', 'ui_visibility' + 'id', 'content_types', 'name', 'group_name', 'required', 'filter_logic', 'ui_visibility', 'weight', + 'description', ] def search(self, queryset, name, value): diff --git a/netbox/extras/forms/bulk_import.py b/netbox/extras/forms/bulk_import.py index c0483d36e..95de7a2fe 100644 --- a/netbox/extras/forms/bulk_import.py +++ b/netbox/extras/forms/bulk_import.py @@ -37,7 +37,8 @@ class CustomFieldCSVForm(CSVModelForm): model = CustomField fields = ( 'name', 'label', 'group_name', 'type', 'content_types', 'required', 'description', 'weight', 'filter_logic', - 'default', 'choices', 'weight', 'validation_minimum', 'validation_maximum', 'validation_regex', 'ui_visibility', + 'default', 'choices', 'weight', 'validation_minimum', 'validation_maximum', 'validation_regex', + 'ui_visibility', ) diff --git a/netbox/extras/forms/customfields.py b/netbox/extras/forms/customfields.py index c4496c5f8..4cf8b5e0a 100644 --- a/netbox/extras/forms/customfields.py +++ b/netbox/extras/forms/customfields.py @@ -51,6 +51,10 @@ class CustomFieldsMixin: if customfield.ui_visibility == CustomFieldVisibilityChoices.VISIBILITY_READ_ONLY: self.fields[field_name].disabled = True + if self.fields[field_name].help_text: + self.fields[field_name].help_text += '
      ' + self.fields[field_name].help_text += ' ' \ + 'Field is set to read-only.' # Annotate the field in the list of CustomField form fields self.custom_fields[field_name] = customfield diff --git a/netbox/extras/forms/filtersets.py b/netbox/extras/forms/filtersets.py index cd59a9db1..aaeb45dbe 100644 --- a/netbox/extras/forms/filtersets.py +++ b/netbox/extras/forms/filtersets.py @@ -59,7 +59,7 @@ class CustomFieldFilterForm(FilterForm): ui_visibility = forms.ChoiceField( choices=add_blank_choice(CustomFieldVisibilityChoices), required=False, - label=_('UI Visibility'), + label=_('UI visibility'), widget=StaticSelect() ) diff --git a/netbox/extras/forms/models.py b/netbox/extras/forms/models.py index 16874c49e..ab423e2fb 100644 --- a/netbox/extras/forms/models.py +++ b/netbox/extras/forms/models.py @@ -41,9 +41,9 @@ class CustomFieldForm(BootstrapMixin, forms.ModelForm): fieldsets = ( ('Custom Field', ( - 'content_types', 'name', 'label', 'group_name', 'type', 'object_type', 'weight', 'required', 'description', 'ui_visibility', + 'content_types', 'name', 'label', 'group_name', 'type', 'object_type', 'weight', 'required', 'description', )), - ('Behavior', ('filter_logic',)), + ('Behavior', ('filter_logic', 'ui_visibility')), ('Values', ('default', 'choices')), ('Validation', ('validation_minimum', 'validation_maximum', 'validation_regex')), ) diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index c48b6895c..c91f96c15 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -140,7 +140,8 @@ class CustomField(ExportTemplatesMixin, WebhooksMixin, ChangeLoggedModel): max_length=50, choices=CustomFieldVisibilityChoices, default=CustomFieldVisibilityChoices.VISIBILITY_READ_WRITE, - help_text='Specifies the visibility of custom field in the UI.' + verbose_name='UI visibility', + help_text='Specifies the visibility of custom field in the UI' ) objects = CustomFieldManager() diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py index d294fd231..540034696 100644 --- a/netbox/extras/tables/tables.py +++ b/netbox/extras/tables/tables.py @@ -34,7 +34,7 @@ class CustomFieldTable(NetBoxTable): model = CustomField fields = ( 'pk', 'id', 'name', 'content_types', 'label', 'type', 'group_name', 'required', 'weight', 'default', - 'description', 'filter_logic', 'choices', 'created', 'last_updated', 'ui_visibility', + 'description', 'filter_logic', 'ui_visibility', 'choices', 'created', 'last_updated', ) default_columns = ('pk', 'name', 'content_types', 'label', 'group_name', 'type', 'required', 'description') diff --git a/netbox/netbox/models/features.py b/netbox/netbox/models/features.py index 76b546192..817da526b 100644 --- a/netbox/netbox/models/features.py +++ b/netbox/netbox/models/features.py @@ -125,7 +125,7 @@ class CustomFieldsMixin(models.Model): def get_custom_fields_by_group(self): """ - Return a dictionary of custom field/value mappings organized by group. + Return a dictionary of custom field/value mappings organized by group. Hidden fields are omitted. """ grouped_custom_fields = defaultdict(dict) for cf, value in self.get_custom_fields(omit_hidden=True).items(): diff --git a/netbox/templates/extras/customfield.html b/netbox/templates/extras/customfield.html index 72dc2e4c3..aca0b5012 100644 --- a/netbox/templates/extras/customfield.html +++ b/netbox/templates/extras/customfield.html @@ -42,6 +42,10 @@ Weight {{ object.weight }} + + Filter Logic + {{ object.get_filter_logic_display }} + UI Visibility {{ object.get_ui_visibility_display }} @@ -69,10 +73,6 @@ {% endif %} - - Filter Logic - {{ object.get_filter_logic_display }} - From b331f047afb197fb131bcc58cc1c18d0a5ceddee Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 25 May 2022 16:01:10 -0400 Subject: [PATCH 073/593] Closes #8222: Enable the assignment of a VM to a specific host device within a cluster --- docs/models/virtualization/virtualmachine.md | 2 +- docs/release-notes/version-3.3.md | 5 +++- .../virtualization/virtualmachine.html | 14 +++++---- netbox/utilities/testing/utils.py | 4 +-- netbox/virtualization/api/serializers.py | 17 ++++++----- netbox/virtualization/api/views.py | 2 +- netbox/virtualization/filtersets.py | 12 +++++++- netbox/virtualization/forms/bulk_edit.py | 13 +++++++-- netbox/virtualization/forms/bulk_import.py | 10 +++++-- netbox/virtualization/forms/filtersets.py | 9 ++++-- netbox/virtualization/forms/models.py | 13 +++++++-- .../migrations/0031_virtualmachine_device.py | 20 +++++++++++++ netbox/virtualization/models.py | 13 +++++++++ .../virtualization/tables/virtualmachines.py | 5 +++- netbox/virtualization/tests/test_api.py | 12 ++++++-- .../virtualization/tests/test_filtersets.py | 29 ++++++++++++++----- netbox/virtualization/tests/test_views.py | 23 ++++++++++----- 17 files changed, 155 insertions(+), 48 deletions(-) create mode 100644 netbox/virtualization/migrations/0031_virtualmachine_device.py diff --git a/docs/models/virtualization/virtualmachine.md b/docs/models/virtualization/virtualmachine.md index de9b5f214..b903ea131 100644 --- a/docs/models/virtualization/virtualmachine.md +++ b/docs/models/virtualization/virtualmachine.md @@ -1,6 +1,6 @@ # Virtual Machines -A virtual machine represents a virtual compute instance hosted within a cluster. Each VM must be assigned to exactly one cluster. +A virtual machine represents a virtual compute instance hosted within a cluster. Each VM must be assigned to exactly one cluster, and may optionally be assigned to a particular host device within that cluster. Like devices, each VM can be assigned a platform and/or functional role, and must have one of the following operational statuses assigned to it: diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index cefab428e..6f07ea87d 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -9,6 +9,7 @@ ### Enhancements * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses +* [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results @@ -26,4 +27,6 @@ * The `nat_inside` field no longer requires a unique value * The `nat_outside` field has changed from a single IP address instance to a list of multiple IP addresses * virtualization.Cluster - * Add required `status` field (default value: `active`) + * Added required `status` field (default value: `active`) +* virtualization.VirtualMachine + * Added `device` field diff --git a/netbox/templates/virtualization/virtualmachine.html b/netbox/templates/virtualization/virtualmachine.html index 0dec4968c..ac8409e09 100644 --- a/netbox/templates/virtualization/virtualmachine.html +++ b/netbox/templates/virtualization/virtualmachine.html @@ -78,9 +78,7 @@
      -
      - Cluster -
      +
      Cluster
      @@ -96,13 +94,17 @@ + + + +
      Cluster Type {{ object.cluster.type }}
      Device + {{ object.device|linkify|placeholder }} +
      -
      - Resources -
      +
      Resources
      diff --git a/netbox/utilities/testing/utils.py b/netbox/utilities/testing/utils.py index 466b5e22b..6157d342d 100644 --- a/netbox/utilities/testing/utils.py +++ b/netbox/utilities/testing/utils.py @@ -34,7 +34,7 @@ def post_data(data): return ret -def create_test_device(name): +def create_test_device(name, **attrs): """ Convenience method for creating a Device (e.g. for component testing). """ @@ -42,7 +42,7 @@ def create_test_device(name): manufacturer, _ = Manufacturer.objects.get_or_create(name='Manufacturer 1', slug='manufacturer-1') devicetype, _ = DeviceType.objects.get_or_create(model='Device Type 1', manufacturer=manufacturer) devicerole, _ = DeviceRole.objects.get_or_create(name='Device Role 1', slug='device-role-1') - device = Device.objects.create(name=name, site=site, device_type=devicetype, device_role=devicerole) + device = Device.objects.create(name=name, site=site, device_type=devicetype, device_role=devicerole, **attrs) return device diff --git a/netbox/virtualization/api/serializers.py b/netbox/virtualization/api/serializers.py index e127bd5fa..d12d9affd 100644 --- a/netbox/virtualization/api/serializers.py +++ b/netbox/virtualization/api/serializers.py @@ -1,7 +1,9 @@ from drf_yasg.utils import swagger_serializer_method from rest_framework import serializers -from dcim.api.nested_serializers import NestedDeviceRoleSerializer, NestedPlatformSerializer, NestedSiteSerializer +from dcim.api.nested_serializers import ( + NestedDeviceSerializer, NestedDeviceRoleSerializer, NestedPlatformSerializer, NestedSiteSerializer, +) from dcim.choices import InterfaceModeChoices from ipam.api.nested_serializers import NestedIPAddressSerializer, NestedVLANSerializer, NestedVRFSerializer from ipam.models import VLAN @@ -68,6 +70,7 @@ class VirtualMachineSerializer(NetBoxModelSerializer): status = ChoiceField(choices=VirtualMachineStatusChoices, required=False) site = NestedSiteSerializer(read_only=True) cluster = NestedClusterSerializer() + device = NestedDeviceSerializer(required=False, allow_null=True) role = NestedDeviceRoleSerializer(required=False, allow_null=True) tenant = NestedTenantSerializer(required=False, allow_null=True) platform = NestedPlatformSerializer(required=False, allow_null=True) @@ -78,9 +81,9 @@ class VirtualMachineSerializer(NetBoxModelSerializer): class Meta: model = VirtualMachine fields = [ - 'id', 'url', 'display', 'name', 'status', 'site', 'cluster', 'role', 'tenant', 'platform', 'primary_ip', - 'primary_ip4', 'primary_ip6', 'vcpus', 'memory', 'disk', 'comments', 'local_context_data', 'tags', - 'custom_fields', 'created', 'last_updated', + 'id', 'url', 'display', 'name', 'status', 'site', 'cluster', 'device', 'role', 'tenant', 'platform', + 'primary_ip', 'primary_ip4', 'primary_ip6', 'vcpus', 'memory', 'disk', 'comments', 'local_context_data', + 'tags', 'custom_fields', 'created', 'last_updated', ] validators = [] @@ -90,9 +93,9 @@ class VirtualMachineWithConfigContextSerializer(VirtualMachineSerializer): class Meta(VirtualMachineSerializer.Meta): fields = [ - 'id', 'url', 'display', 'name', 'status', 'site', 'cluster', 'role', 'tenant', 'platform', 'primary_ip', - 'primary_ip4', 'primary_ip6', 'vcpus', 'memory', 'disk', 'comments', 'local_context_data', 'tags', - 'custom_fields', 'config_context', 'created', 'last_updated', + 'id', 'url', 'display', 'name', 'status', 'site', 'cluster', 'device', 'role', 'tenant', 'platform', + 'primary_ip', 'primary_ip4', 'primary_ip6', 'vcpus', 'memory', 'disk', 'comments', 'local_context_data', + 'tags', 'custom_fields', 'config_context', 'created', 'last_updated', ] @swagger_serializer_method(serializer_or_field=serializers.DictField) diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index 665114881..d86241b4f 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -54,7 +54,7 @@ class ClusterViewSet(NetBoxModelViewSet): class VirtualMachineViewSet(ConfigContextQuerySetMixin, NetBoxModelViewSet): queryset = VirtualMachine.objects.prefetch_related( - 'cluster__site', 'role', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', 'tags' + 'cluster__site', 'device', 'role', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', 'tags' ) filterset_class = filtersets.VirtualMachineFilterSet diff --git a/netbox/virtualization/filtersets.py b/netbox/virtualization/filtersets.py index 63e3557a3..3e1d50da4 100644 --- a/netbox/virtualization/filtersets.py +++ b/netbox/virtualization/filtersets.py @@ -1,7 +1,7 @@ import django_filters from django.db.models import Q -from dcim.models import DeviceRole, Platform, Region, Site, SiteGroup +from dcim.models import Device, DeviceRole, Platform, Region, Site, SiteGroup from extras.filtersets import LocalConfigContextFilterSet from ipam.models import VRF from netbox.filtersets import OrganizationalModelFilterSet, NetBoxModelFilterSet @@ -150,6 +150,16 @@ class VirtualMachineFilterSet( to_field_name='name', label='Cluster', ) + device_id = django_filters.ModelMultipleChoiceFilter( + queryset=Device.objects.all(), + label='Device (ID)', + ) + device = django_filters.ModelMultipleChoiceFilter( + field_name='device__name', + queryset=Device.objects.all(), + to_field_name='name', + label='Device', + ) region_id = TreeNodeMultipleChoiceFilter( queryset=Region.objects.all(), field_name='cluster__site__region', diff --git a/netbox/virtualization/forms/bulk_edit.py b/netbox/virtualization/forms/bulk_edit.py index e7369f53a..67126d6c7 100644 --- a/netbox/virtualization/forms/bulk_edit.py +++ b/netbox/virtualization/forms/bulk_edit.py @@ -2,7 +2,7 @@ from django import forms from dcim.choices import InterfaceModeChoices from dcim.constants import INTERFACE_MTU_MAX, INTERFACE_MTU_MIN -from dcim.models import DeviceRole, Platform, Region, Site, SiteGroup +from dcim.models import Device, DeviceRole, Platform, Region, Site, SiteGroup from ipam.models import VLAN, VRF from netbox.forms import NetBoxModelBulkEditForm from tenancy.models import Tenant @@ -110,6 +110,13 @@ class VirtualMachineBulkEditForm(NetBoxModelBulkEditForm): queryset=Cluster.objects.all(), required=False ) + device = DynamicModelChoiceField( + queryset=Device.objects.all(), + required=False, + query_params={ + 'cluster_id': '$cluster' + } + ) role = DynamicModelChoiceField( queryset=DeviceRole.objects.filter( vm_role=True @@ -146,11 +153,11 @@ class VirtualMachineBulkEditForm(NetBoxModelBulkEditForm): model = VirtualMachine fieldsets = ( - (None, ('cluster', 'status', 'role', 'tenant', 'platform')), + (None, ('cluster', 'device', 'status', 'role', 'tenant', 'platform')), ('Resources', ('vcpus', 'memory', 'disk')) ) nullable_fields = ( - 'role', 'tenant', 'platform', 'vcpus', 'memory', 'disk', 'comments', + 'device', 'role', 'tenant', 'platform', 'vcpus', 'memory', 'disk', 'comments', ) diff --git a/netbox/virtualization/forms/bulk_import.py b/netbox/virtualization/forms/bulk_import.py index ef688367e..41f9b3773 100644 --- a/netbox/virtualization/forms/bulk_import.py +++ b/netbox/virtualization/forms/bulk_import.py @@ -1,5 +1,5 @@ from dcim.choices import InterfaceModeChoices -from dcim.models import DeviceRole, Platform, Site +from dcim.models import Device, DeviceRole, Platform, Site from ipam.models import VRF from netbox.forms import NetBoxModelCSVForm from tenancy.models import Tenant @@ -76,6 +76,12 @@ class VirtualMachineCSVForm(NetBoxModelCSVForm): to_field_name='name', help_text='Assigned cluster' ) + device = CSVModelChoiceField( + queryset=Device.objects.all(), + to_field_name='name', + required=False, + help_text='Assigned device within cluster' + ) role = CSVModelChoiceField( queryset=DeviceRole.objects.filter( vm_role=True @@ -100,7 +106,7 @@ class VirtualMachineCSVForm(NetBoxModelCSVForm): class Meta: model = VirtualMachine fields = ( - 'name', 'status', 'role', 'cluster', 'tenant', 'platform', 'vcpus', 'memory', 'disk', 'comments', + 'name', 'status', 'role', 'cluster', 'device', 'tenant', 'platform', 'vcpus', 'memory', 'disk', 'comments', ) diff --git a/netbox/virtualization/forms/filtersets.py b/netbox/virtualization/forms/filtersets.py index 753f509f7..b3da87f7a 100644 --- a/netbox/virtualization/forms/filtersets.py +++ b/netbox/virtualization/forms/filtersets.py @@ -1,7 +1,7 @@ from django import forms from django.utils.translation import gettext as _ -from dcim.models import DeviceRole, Platform, Region, Site, SiteGroup +from dcim.models import Device, DeviceRole, Platform, Region, Site, SiteGroup from extras.forms import LocalConfigContextFilterForm from ipam.models import VRF from netbox.forms import NetBoxModelFilterSetForm @@ -87,7 +87,7 @@ class VirtualMachineFilterForm( model = VirtualMachine fieldsets = ( (None, ('q', 'tag')), - ('Cluster', ('cluster_group_id', 'cluster_type_id', 'cluster_id')), + ('Cluster', ('cluster_group_id', 'cluster_type_id', 'cluster_id', 'device_id')), ('Location', ('region_id', 'site_group_id', 'site_id')), ('Attriubtes', ('status', 'role_id', 'platform_id', 'mac_address', 'has_primary_ip', 'local_context_data')), ('Tenant', ('tenant_group_id', 'tenant_id')), @@ -110,6 +110,11 @@ class VirtualMachineFilterForm( required=False, label=_('Cluster') ) + device_id = DynamicModelMultipleChoiceField( + queryset=Device.objects.all(), + required=False, + label=_('Device') + ) region_id = DynamicModelMultipleChoiceField( queryset=Region.objects.all(), required=False, diff --git a/netbox/virtualization/forms/models.py b/netbox/virtualization/forms/models.py index a94cc3920..dba12d64d 100644 --- a/netbox/virtualization/forms/models.py +++ b/netbox/virtualization/forms/models.py @@ -179,6 +179,13 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm): 'group_id': '$cluster_group' } ) + device = DynamicModelChoiceField( + queryset=Device.objects.all(), + required=False, + query_params={ + 'cluster_id': '$cluster' + } + ) role = DynamicModelChoiceField( queryset=DeviceRole.objects.all(), required=False, @@ -197,7 +204,7 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm): fieldsets = ( ('Virtual Machine', ('name', 'role', 'status', 'tags')), - ('Cluster', ('cluster_group', 'cluster')), + ('Cluster', ('cluster_group', 'cluster', 'device')), ('Tenancy', ('tenant_group', 'tenant')), ('Management', ('platform', 'primary_ip4', 'primary_ip6')), ('Resources', ('vcpus', 'memory', 'disk')), @@ -207,8 +214,8 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm): class Meta: model = VirtualMachine fields = [ - 'name', 'status', 'cluster_group', 'cluster', 'role', 'tenant_group', 'tenant', 'platform', 'primary_ip4', - 'primary_ip6', 'vcpus', 'memory', 'disk', 'comments', 'tags', 'local_context_data', + 'name', 'status', 'cluster_group', 'cluster', 'device', 'role', 'tenant_group', 'tenant', 'platform', + 'primary_ip4', 'primary_ip6', 'vcpus', 'memory', 'disk', 'comments', 'tags', 'local_context_data', ] help_texts = { 'local_context_data': "Local config context data overwrites all sources contexts in the final rendered " diff --git a/netbox/virtualization/migrations/0031_virtualmachine_device.py b/netbox/virtualization/migrations/0031_virtualmachine_device.py new file mode 100644 index 000000000..407d60e79 --- /dev/null +++ b/netbox/virtualization/migrations/0031_virtualmachine_device.py @@ -0,0 +1,20 @@ +# Generated by Django 4.0.4 on 2022-05-25 19:30 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0153_created_datetimefield'), + ('virtualization', '0030_cluster_status'), + ] + + operations = [ + migrations.AddField( + model_name='virtualmachine', + name='device', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='virtual_machines', to='dcim.device'), + ), + ] diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py index afc450ddd..51dbc9f43 100644 --- a/netbox/virtualization/models.py +++ b/netbox/virtualization/models.py @@ -200,6 +200,13 @@ class VirtualMachine(NetBoxModel, ConfigContextModel): on_delete=models.PROTECT, related_name='virtual_machines' ) + device = models.ForeignKey( + to='dcim.Device', + on_delete=models.PROTECT, + related_name='virtual_machines', + blank=True, + null=True + ) tenant = models.ForeignKey( to='tenancy.Tenant', on_delete=models.PROTECT, @@ -316,6 +323,12 @@ class VirtualMachine(NetBoxModel, ConfigContextModel): def clean(self): super().clean() + # Validate assigned cluster device + if self.device and self.device not in self.cluster.devices.all(): + raise ValidationError({ + 'device': f'The selected device ({self.device} is not assigned to this cluster ({self.cluster}).' + }) + # Validate primary IP addresses interfaces = self.interfaces.all() for field in ['primary_ip4', 'primary_ip6']: diff --git a/netbox/virtualization/tables/virtualmachines.py b/netbox/virtualization/tables/virtualmachines.py index 89dbdf901..80eb0b37f 100644 --- a/netbox/virtualization/tables/virtualmachines.py +++ b/netbox/virtualization/tables/virtualmachines.py @@ -33,6 +33,9 @@ class VirtualMachineTable(NetBoxTable): cluster = tables.Column( linkify=True ) + device = tables.Column( + linkify=True + ) role = columns.ColoredLabelColumn() tenant = TenantColumn() comments = columns.MarkdownColumn() @@ -56,7 +59,7 @@ class VirtualMachineTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = VirtualMachine fields = ( - 'pk', 'id', 'name', 'status', 'cluster', 'role', 'tenant', 'platform', 'vcpus', 'memory', 'disk', + 'pk', 'id', 'name', 'status', 'cluster', 'device', 'role', 'tenant', 'platform', 'vcpus', 'memory', 'disk', 'primary_ip4', 'primary_ip6', 'primary_ip', 'comments', 'tags', 'created', 'last_updated', ) default_columns = ( diff --git a/netbox/virtualization/tests/test_api.py b/netbox/virtualization/tests/test_api.py index 4d559dc49..887781e01 100644 --- a/netbox/virtualization/tests/test_api.py +++ b/netbox/virtualization/tests/test_api.py @@ -3,7 +3,7 @@ from rest_framework import status from dcim.choices import InterfaceModeChoices from ipam.models import VLAN, VRF -from utilities.testing import APITestCase, APIViewTestCases +from utilities.testing import APITestCase, APIViewTestCases, create_test_device from virtualization.choices import * from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface @@ -152,8 +152,15 @@ class VirtualMachineTest(APIViewTestCases.APIViewTestCase): ) Cluster.objects.bulk_create(clusters) + device1 = create_test_device('device1') + device1.cluster = clusters[0] + device1.save() + device2 = create_test_device('device2') + device2.cluster = clusters[1] + device2.save() + virtual_machines = ( - VirtualMachine(name='Virtual Machine 1', cluster=clusters[0], local_context_data={'A': 1}), + VirtualMachine(name='Virtual Machine 1', cluster=clusters[0], device=device1, local_context_data={'A': 1}), VirtualMachine(name='Virtual Machine 2', cluster=clusters[0], local_context_data={'B': 2}), VirtualMachine(name='Virtual Machine 3', cluster=clusters[0], local_context_data={'C': 3}), ) @@ -163,6 +170,7 @@ class VirtualMachineTest(APIViewTestCases.APIViewTestCase): { 'name': 'Virtual Machine 4', 'cluster': clusters[1].pk, + 'device': device2.pk, }, { 'name': 'Virtual Machine 5', diff --git a/netbox/virtualization/tests/test_filtersets.py b/netbox/virtualization/tests/test_filtersets.py index 8b4e79bed..3fd43d0c1 100644 --- a/netbox/virtualization/tests/test_filtersets.py +++ b/netbox/virtualization/tests/test_filtersets.py @@ -1,9 +1,9 @@ from django.test import TestCase -from dcim.models import DeviceRole, Platform, Region, Site, SiteGroup +from dcim.models import Device, DeviceRole, Platform, Region, Site, SiteGroup from ipam.models import IPAddress, VRF from tenancy.models import Tenant, TenantGroup -from utilities.testing import ChangeLoggedFilterSetTests +from utilities.testing import ChangeLoggedFilterSetTests, create_test_device from virtualization.choices import * from virtualization.filtersets import * from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface @@ -225,9 +225,9 @@ class VirtualMachineTestCase(TestCase, ChangeLoggedFilterSetTests): site_group.save() sites = ( - Site(name='Test Site 1', slug='test-site-1', region=regions[0], group=site_groups[0]), - Site(name='Test Site 2', slug='test-site-2', region=regions[1], group=site_groups[1]), - Site(name='Test Site 3', slug='test-site-3', region=regions[2], group=site_groups[2]), + Site(name='Site 1', slug='site-1', region=regions[0], group=site_groups[0]), + Site(name='Site 2', slug='site-2', region=regions[1], group=site_groups[1]), + Site(name='Site 3', slug='site-3', region=regions[2], group=site_groups[2]), ) Site.objects.bulk_create(sites) @@ -252,6 +252,12 @@ class VirtualMachineTestCase(TestCase, ChangeLoggedFilterSetTests): ) DeviceRole.objects.bulk_create(roles) + devices = ( + create_test_device('device1', cluster=clusters[0]), + create_test_device('device2', cluster=clusters[1]), + create_test_device('device3', cluster=clusters[2]), + ) + tenant_groups = ( TenantGroup(name='Tenant group 1', slug='tenant-group-1'), TenantGroup(name='Tenant group 2', slug='tenant-group-2'), @@ -268,9 +274,9 @@ class VirtualMachineTestCase(TestCase, ChangeLoggedFilterSetTests): Tenant.objects.bulk_create(tenants) vms = ( - VirtualMachine(name='Virtual Machine 1', cluster=clusters[0], platform=platforms[0], role=roles[0], tenant=tenants[0], status=VirtualMachineStatusChoices.STATUS_ACTIVE, vcpus=1, memory=1, disk=1, local_context_data={"foo": 123}), - VirtualMachine(name='Virtual Machine 2', cluster=clusters[1], platform=platforms[1], role=roles[1], tenant=tenants[1], status=VirtualMachineStatusChoices.STATUS_STAGED, vcpus=2, memory=2, disk=2), - VirtualMachine(name='Virtual Machine 3', cluster=clusters[2], platform=platforms[2], role=roles[2], tenant=tenants[2], status=VirtualMachineStatusChoices.STATUS_OFFLINE, vcpus=3, memory=3, disk=3), + VirtualMachine(name='Virtual Machine 1', cluster=clusters[0], device=devices[0], platform=platforms[0], role=roles[0], tenant=tenants[0], status=VirtualMachineStatusChoices.STATUS_ACTIVE, vcpus=1, memory=1, disk=1, local_context_data={"foo": 123}), + VirtualMachine(name='Virtual Machine 2', cluster=clusters[1], device=devices[1], platform=platforms[1], role=roles[1], tenant=tenants[1], status=VirtualMachineStatusChoices.STATUS_STAGED, vcpus=2, memory=2, disk=2), + VirtualMachine(name='Virtual Machine 3', cluster=clusters[2], device=devices[2], platform=platforms[2], role=roles[2], tenant=tenants[2], status=VirtualMachineStatusChoices.STATUS_OFFLINE, vcpus=3, memory=3, disk=3), ) VirtualMachine.objects.bulk_create(vms) @@ -331,6 +337,13 @@ class VirtualMachineTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'cluster': [clusters[0].name, clusters[1].name]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_device(self): + devices = Device.objects.all()[:2] + params = {'device_id': [devices[0].pk, devices[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'device': [devices[0].name, devices[1].name]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_region(self): regions = Region.objects.all()[:2] params = {'region_id': [regions[0].pk, regions[1].pk]} diff --git a/netbox/virtualization/tests/test_views.py b/netbox/virtualization/tests/test_views.py index df90bfc37..4b1d64de5 100644 --- a/netbox/virtualization/tests/test_views.py +++ b/netbox/virtualization/tests/test_views.py @@ -5,7 +5,7 @@ from netaddr import EUI from dcim.choices import InterfaceModeChoices from dcim.models import DeviceRole, Platform, Site from ipam.models import VLAN, VRF -from utilities.testing import ViewTestCases, create_tags +from utilities.testing import ViewTestCases, create_tags, create_test_device from virtualization.choices import * from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface @@ -176,16 +176,22 @@ class VirtualMachineTestCase(ViewTestCases.PrimaryObjectViewTestCase): ) Cluster.objects.bulk_create(clusters) + devices = ( + create_test_device('device1', cluster=clusters[0]), + create_test_device('device2', cluster=clusters[1]), + ) + VirtualMachine.objects.bulk_create([ - VirtualMachine(name='Virtual Machine 1', cluster=clusters[0], role=deviceroles[0], platform=platforms[0]), - VirtualMachine(name='Virtual Machine 2', cluster=clusters[0], role=deviceroles[0], platform=platforms[0]), - VirtualMachine(name='Virtual Machine 3', cluster=clusters[0], role=deviceroles[0], platform=platforms[0]), + VirtualMachine(name='Virtual Machine 1', cluster=clusters[0], device=devices[0], role=deviceroles[0], platform=platforms[0]), + VirtualMachine(name='Virtual Machine 2', cluster=clusters[0], device=devices[0], role=deviceroles[0], platform=platforms[0]), + VirtualMachine(name='Virtual Machine 3', cluster=clusters[0], device=devices[0], role=deviceroles[0], platform=platforms[0]), ]) tags = create_tags('Alpha', 'Bravo', 'Charlie') cls.form_data = { 'cluster': clusters[1].pk, + 'device': devices[1].pk, 'tenant': None, 'platform': platforms[1].pk, 'name': 'Virtual Machine X', @@ -202,14 +208,15 @@ class VirtualMachineTestCase(ViewTestCases.PrimaryObjectViewTestCase): } cls.csv_data = ( - "name,status,cluster", - "Virtual Machine 4,active,Cluster 1", - "Virtual Machine 5,active,Cluster 1", - "Virtual Machine 6,active,Cluster 1", + "name,status,cluster,device", + "Virtual Machine 4,active,Cluster 1,device1", + "Virtual Machine 5,active,Cluster 1,device1", + "Virtual Machine 6,active,Cluster 1,", ) cls.bulk_edit_data = { 'cluster': clusters[1].pk, + 'device': devices[1].pk, 'tenant': None, 'platform': platforms[1].pk, 'status': VirtualMachineStatusChoices.STATUS_STAGED, From db42589cca93fedb15757ad3a32e03afa0611a18 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 26 May 2022 14:59:49 -0400 Subject: [PATCH 074/593] Closes #5303: A virtual machine may be assigned to a site and/or cluster --- docs/models/virtualization/virtualmachine.md | 2 +- docs/release-notes/version-3.3.md | 3 ++ .../virtualization/virtualmachine.html | 8 +++- netbox/utilities/testing/utils.py | 5 ++- netbox/virtualization/api/serializers.py | 4 +- netbox/virtualization/api/views.py | 2 +- netbox/virtualization/filtersets.py | 11 +++-- netbox/virtualization/forms/bulk_edit.py | 19 ++++++--- netbox/virtualization/forms/bulk_import.py | 10 ++++- netbox/virtualization/forms/models.py | 13 ++++-- .../migrations/0031_virtualmachine_device.py | 20 ---------- .../0031_virtualmachine_site_device.py | 28 +++++++++++++ .../0032_virtualmachine_update_sites.py | 27 +++++++++++++ netbox/virtualization/models.py | 33 ++++++++++++--- .../virtualization/tables/virtualmachines.py | 9 +++-- netbox/virtualization/tests/test_api.py | 35 ++++++++++------ .../virtualization/tests/test_filtersets.py | 6 +-- netbox/virtualization/tests/test_models.py | 40 ++++++++++++++++--- netbox/virtualization/tests/test_views.py | 34 ++++++++++------ 19 files changed, 223 insertions(+), 86 deletions(-) delete mode 100644 netbox/virtualization/migrations/0031_virtualmachine_device.py create mode 100644 netbox/virtualization/migrations/0031_virtualmachine_site_device.py create mode 100644 netbox/virtualization/migrations/0032_virtualmachine_update_sites.py diff --git a/docs/models/virtualization/virtualmachine.md b/docs/models/virtualization/virtualmachine.md index b903ea131..4ddffb99a 100644 --- a/docs/models/virtualization/virtualmachine.md +++ b/docs/models/virtualization/virtualmachine.md @@ -1,6 +1,6 @@ # Virtual Machines -A virtual machine represents a virtual compute instance hosted within a cluster. Each VM must be assigned to exactly one cluster, and may optionally be assigned to a particular host device within that cluster. +A virtual machine represents a virtual compute instance hosted within a cluster. Each VM must be assigned to a site and/or cluster, and may optionally be assigned to a particular host device within a cluster. Like devices, each VM can be assigned a platform and/or functional role, and must have one of the following operational statuses assigned to it: diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 6f07ea87d..63fd9731f 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -9,6 +9,7 @@ ### Enhancements * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses +* [#5303](https://github.com/netbox-community/netbox/issues/5303) - A virtual machine may be assigned to a site and/or cluster * [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping @@ -30,3 +31,5 @@ * Added required `status` field (default value: `active`) * virtualization.VirtualMachine * Added `device` field + * The `site` field is now directly writable (rather than being inferred from the assigned cluster) + * The `cluster` field is now optional. A virtual machine must have a site and/or cluster assigned. diff --git a/netbox/templates/virtualization/virtualmachine.html b/netbox/templates/virtualization/virtualmachine.html index ac8409e09..2831a452a 100644 --- a/netbox/templates/virtualization/virtualmachine.html +++ b/netbox/templates/virtualization/virtualmachine.html @@ -81,13 +81,19 @@
      Cluster
      + + + + diff --git a/netbox/utilities/testing/utils.py b/netbox/utilities/testing/utils.py index 6157d342d..52ccd002d 100644 --- a/netbox/utilities/testing/utils.py +++ b/netbox/utilities/testing/utils.py @@ -34,11 +34,12 @@ def post_data(data): return ret -def create_test_device(name, **attrs): +def create_test_device(name, site=None, **attrs): """ Convenience method for creating a Device (e.g. for component testing). """ - site, _ = Site.objects.get_or_create(name='Site 1', slug='site-1') + if site is None: + site, _ = Site.objects.get_or_create(name='Site 1', slug='site-1') manufacturer, _ = Manufacturer.objects.get_or_create(name='Manufacturer 1', slug='manufacturer-1') devicetype, _ = DeviceType.objects.get_or_create(model='Device Type 1', manufacturer=manufacturer) devicerole, _ = DeviceRole.objects.get_or_create(name='Device Role 1', slug='device-role-1') diff --git a/netbox/virtualization/api/serializers.py b/netbox/virtualization/api/serializers.py index d12d9affd..bd01b5533 100644 --- a/netbox/virtualization/api/serializers.py +++ b/netbox/virtualization/api/serializers.py @@ -68,8 +68,8 @@ class ClusterSerializer(NetBoxModelSerializer): class VirtualMachineSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='virtualization-api:virtualmachine-detail') status = ChoiceField(choices=VirtualMachineStatusChoices, required=False) - site = NestedSiteSerializer(read_only=True) - cluster = NestedClusterSerializer() + site = NestedSiteSerializer(required=False, allow_null=True) + cluster = NestedClusterSerializer(required=False, allow_null=True) device = NestedDeviceSerializer(required=False, allow_null=True) role = NestedDeviceRoleSerializer(required=False, allow_null=True) tenant = NestedTenantSerializer(required=False, allow_null=True) diff --git a/netbox/virtualization/api/views.py b/netbox/virtualization/api/views.py index d86241b4f..d2a90ae34 100644 --- a/netbox/virtualization/api/views.py +++ b/netbox/virtualization/api/views.py @@ -54,7 +54,7 @@ class ClusterViewSet(NetBoxModelViewSet): class VirtualMachineViewSet(ConfigContextQuerySetMixin, NetBoxModelViewSet): queryset = VirtualMachine.objects.prefetch_related( - 'cluster__site', 'device', 'role', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', 'tags' + 'site', 'cluster', 'device', 'role', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', 'tags' ) filterset_class = filtersets.VirtualMachineFilterSet diff --git a/netbox/virtualization/filtersets.py b/netbox/virtualization/filtersets.py index 3e1d50da4..00d3e2313 100644 --- a/netbox/virtualization/filtersets.py +++ b/netbox/virtualization/filtersets.py @@ -162,37 +162,36 @@ class VirtualMachineFilterSet( ) region_id = TreeNodeMultipleChoiceFilter( queryset=Region.objects.all(), - field_name='cluster__site__region', + field_name='site__region', lookup_expr='in', label='Region (ID)', ) region = TreeNodeMultipleChoiceFilter( queryset=Region.objects.all(), - field_name='cluster__site__region', + field_name='site__region', lookup_expr='in', to_field_name='slug', label='Region (slug)', ) site_group_id = TreeNodeMultipleChoiceFilter( queryset=SiteGroup.objects.all(), - field_name='cluster__site__group', + field_name='site__group', lookup_expr='in', label='Site group (ID)', ) site_group = TreeNodeMultipleChoiceFilter( queryset=SiteGroup.objects.all(), - field_name='cluster__site__group', + field_name='site__group', lookup_expr='in', to_field_name='slug', label='Site group (slug)', ) site_id = django_filters.ModelMultipleChoiceFilter( - field_name='cluster__site', queryset=Site.objects.all(), label='Site (ID)', ) site = django_filters.ModelMultipleChoiceFilter( - field_name='cluster__site__slug', + field_name='site__slug', queryset=Site.objects.all(), to_field_name='slug', label='Site (slug)', diff --git a/netbox/virtualization/forms/bulk_edit.py b/netbox/virtualization/forms/bulk_edit.py index 67126d6c7..88dee3978 100644 --- a/netbox/virtualization/forms/bulk_edit.py +++ b/netbox/virtualization/forms/bulk_edit.py @@ -106,9 +106,16 @@ class VirtualMachineBulkEditForm(NetBoxModelBulkEditForm): initial='', widget=StaticSelect(), ) + site = DynamicModelChoiceField( + queryset=Site.objects.all(), + required=False + ) cluster = DynamicModelChoiceField( queryset=Cluster.objects.all(), - required=False + required=False, + query_params={ + 'site_id': '$site' + } ) device = DynamicModelChoiceField( queryset=Device.objects.all(), @@ -153,11 +160,11 @@ class VirtualMachineBulkEditForm(NetBoxModelBulkEditForm): model = VirtualMachine fieldsets = ( - (None, ('cluster', 'device', 'status', 'role', 'tenant', 'platform')), + (None, ('site', 'cluster', 'device', 'status', 'role', 'tenant', 'platform')), ('Resources', ('vcpus', 'memory', 'disk')) ) nullable_fields = ( - 'device', 'role', 'tenant', 'platform', 'vcpus', 'memory', 'disk', 'comments', + 'site', 'cluster', 'device', 'role', 'tenant', 'platform', 'vcpus', 'memory', 'disk', 'comments', ) @@ -236,8 +243,10 @@ class VMInterfaceBulkEditForm(NetBoxModelBulkEditForm): # See 5643 if 'pk' in self.initial: site = None - interfaces = VMInterface.objects.filter(pk__in=self.initial['pk']).prefetch_related( - 'virtual_machine__cluster__site' + interfaces = VMInterface.objects.filter( + pk__in=self.initial['pk'] + ).prefetch_related( + 'virtual_machine__site' ) # Check interface sites. First interface should set site, further interfaces will either continue the diff --git a/netbox/virtualization/forms/bulk_import.py b/netbox/virtualization/forms/bulk_import.py index 41f9b3773..2d7ee52e2 100644 --- a/netbox/virtualization/forms/bulk_import.py +++ b/netbox/virtualization/forms/bulk_import.py @@ -71,9 +71,16 @@ class VirtualMachineCSVForm(NetBoxModelCSVForm): choices=VirtualMachineStatusChoices, help_text='Operational status' ) + site = CSVModelChoiceField( + queryset=Site.objects.all(), + to_field_name='name', + required=False, + help_text='Assigned site' + ) cluster = CSVModelChoiceField( queryset=Cluster.objects.all(), to_field_name='name', + required=False, help_text='Assigned cluster' ) device = CSVModelChoiceField( @@ -106,7 +113,8 @@ class VirtualMachineCSVForm(NetBoxModelCSVForm): class Meta: model = VirtualMachine fields = ( - 'name', 'status', 'role', 'cluster', 'device', 'tenant', 'platform', 'vcpus', 'memory', 'disk', 'comments', + 'name', 'status', 'role', 'site', 'cluster', 'device', 'tenant', 'platform', 'vcpus', 'memory', 'disk', + 'comments', ) diff --git a/netbox/virtualization/forms/models.py b/netbox/virtualization/forms/models.py index dba12d64d..cfafd7e39 100644 --- a/netbox/virtualization/forms/models.py +++ b/netbox/virtualization/forms/models.py @@ -165,6 +165,9 @@ class ClusterRemoveDevicesForm(ConfirmationForm): class VirtualMachineForm(TenancyForm, NetBoxModelForm): + site = DynamicModelChoiceField( + queryset=Site.objects.all() + ) cluster_group = DynamicModelChoiceField( queryset=ClusterGroup.objects.all(), required=False, @@ -176,7 +179,8 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm): cluster = DynamicModelChoiceField( queryset=Cluster.objects.all(), query_params={ - 'group_id': '$cluster_group' + 'site_id': '$site', + 'group_id': '$cluster_group', } ) device = DynamicModelChoiceField( @@ -204,7 +208,7 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm): fieldsets = ( ('Virtual Machine', ('name', 'role', 'status', 'tags')), - ('Cluster', ('cluster_group', 'cluster', 'device')), + ('Cluster', ('site', 'cluster_group', 'cluster', 'device')), ('Tenancy', ('tenant_group', 'tenant')), ('Management', ('platform', 'primary_ip4', 'primary_ip6')), ('Resources', ('vcpus', 'memory', 'disk')), @@ -214,8 +218,9 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm): class Meta: model = VirtualMachine fields = [ - 'name', 'status', 'cluster_group', 'cluster', 'device', 'role', 'tenant_group', 'tenant', 'platform', - 'primary_ip4', 'primary_ip6', 'vcpus', 'memory', 'disk', 'comments', 'tags', 'local_context_data', + 'name', 'status', 'site', 'cluster_group', 'cluster', 'device', 'role', 'tenant_group', 'tenant', + 'platform', 'primary_ip4', 'primary_ip6', 'vcpus', 'memory', 'disk', 'comments', 'tags', + 'local_context_data', ] help_texts = { 'local_context_data': "Local config context data overwrites all sources contexts in the final rendered " diff --git a/netbox/virtualization/migrations/0031_virtualmachine_device.py b/netbox/virtualization/migrations/0031_virtualmachine_device.py deleted file mode 100644 index 407d60e79..000000000 --- a/netbox/virtualization/migrations/0031_virtualmachine_device.py +++ /dev/null @@ -1,20 +0,0 @@ -# Generated by Django 4.0.4 on 2022-05-25 19:30 - -from django.db import migrations, models -import django.db.models.deletion - - -class Migration(migrations.Migration): - - dependencies = [ - ('dcim', '0153_created_datetimefield'), - ('virtualization', '0030_cluster_status'), - ] - - operations = [ - migrations.AddField( - model_name='virtualmachine', - name='device', - field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='virtual_machines', to='dcim.device'), - ), - ] diff --git a/netbox/virtualization/migrations/0031_virtualmachine_site_device.py b/netbox/virtualization/migrations/0031_virtualmachine_site_device.py new file mode 100644 index 000000000..85ea24455 --- /dev/null +++ b/netbox/virtualization/migrations/0031_virtualmachine_site_device.py @@ -0,0 +1,28 @@ +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0153_created_datetimefield'), + ('virtualization', '0030_cluster_status'), + ] + + operations = [ + migrations.AddField( + model_name='virtualmachine', + name='site', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='virtual_machines', to='dcim.site'), + ), + migrations.AddField( + model_name='virtualmachine', + name='device', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='virtual_machines', to='dcim.device'), + ), + migrations.AlterField( + model_name='virtualmachine', + name='cluster', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='virtual_machines', to='virtualization.cluster'), + ), + ] diff --git a/netbox/virtualization/migrations/0032_virtualmachine_update_sites.py b/netbox/virtualization/migrations/0032_virtualmachine_update_sites.py new file mode 100644 index 000000000..e9c52bfde --- /dev/null +++ b/netbox/virtualization/migrations/0032_virtualmachine_update_sites.py @@ -0,0 +1,27 @@ +from django.db import migrations + + +def update_virtualmachines_site(apps, schema_editor): + """ + Automatically set the site for all virtual machines. + """ + VirtualMachine = apps.get_model('virtualization', 'VirtualMachine') + + virtual_machines = VirtualMachine.objects.filter(cluster__site__isnull=False) + for vm in virtual_machines: + vm.site = vm.cluster.site + VirtualMachine.objects.bulk_update(virtual_machines, ['site']) + + +class Migration(migrations.Migration): + + dependencies = [ + ('virtualization', '0031_virtualmachine_site_device'), + ] + + operations = [ + migrations.RunPython( + code=update_virtualmachines_site, + reverse_code=migrations.RunPython.noop + ), + ] diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py index 51dbc9f43..02560a962 100644 --- a/netbox/virtualization/models.py +++ b/netbox/virtualization/models.py @@ -195,10 +195,19 @@ class VirtualMachine(NetBoxModel, ConfigContextModel): """ A virtual machine which runs inside a Cluster. """ + site = models.ForeignKey( + to='dcim.Site', + on_delete=models.PROTECT, + related_name='virtual_machines', + blank=True, + null=True + ) cluster = models.ForeignKey( to='virtualization.Cluster', on_delete=models.PROTECT, - related_name='virtual_machines' + related_name='virtual_machines', + blank=True, + null=True ) device = models.ForeignKey( to='dcim.Device', @@ -291,7 +300,7 @@ class VirtualMachine(NetBoxModel, ConfigContextModel): objects = ConfigContextModelQuerySet.as_manager() clone_fields = [ - 'cluster', 'tenant', 'platform', 'status', 'role', 'vcpus', 'memory', 'disk', + 'site', 'cluster', 'device', 'tenant', 'platform', 'status', 'role', 'vcpus', 'memory', 'disk', ] class Meta: @@ -323,6 +332,22 @@ class VirtualMachine(NetBoxModel, ConfigContextModel): def clean(self): super().clean() + # Must be assigned to a site and/or cluster + if not self.site and not self.cluster: + raise ValidationError({ + 'cluster': f'A virtual machine must be assigned to a site and/or cluster.' + }) + + # Validate site for cluster & device + if self.cluster and self.cluster.site != self.site: + raise ValidationError({ + 'cluster': f'The selected cluster ({self.cluster} is not assigned to this site ({self.site}).' + }) + if self.device and self.device.site != self.site: + raise ValidationError({ + 'device': f'The selected device ({self.device} is not assigned to this site ({self.site}).' + }) + # Validate assigned cluster device if self.device and self.device not in self.cluster.devices.all(): raise ValidationError({ @@ -357,10 +382,6 @@ class VirtualMachine(NetBoxModel, ConfigContextModel): else: return None - @property - def site(self): - return self.cluster.site - # # Interfaces diff --git a/netbox/virtualization/tables/virtualmachines.py b/netbox/virtualization/tables/virtualmachines.py index 80eb0b37f..0fe2571b1 100644 --- a/netbox/virtualization/tables/virtualmachines.py +++ b/netbox/virtualization/tables/virtualmachines.py @@ -30,6 +30,9 @@ class VirtualMachineTable(NetBoxTable): linkify=True ) status = columns.ChoiceFieldColumn() + site = tables.Column( + linkify=True + ) cluster = tables.Column( linkify=True ) @@ -59,11 +62,11 @@ class VirtualMachineTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = VirtualMachine fields = ( - 'pk', 'id', 'name', 'status', 'cluster', 'device', 'role', 'tenant', 'platform', 'vcpus', 'memory', 'disk', - 'primary_ip4', 'primary_ip6', 'primary_ip', 'comments', 'tags', 'created', 'last_updated', + 'pk', 'id', 'name', 'status', 'site', 'cluster', 'device', 'role', 'tenant', 'platform', 'vcpus', 'memory', + 'disk', 'primary_ip4', 'primary_ip6', 'primary_ip', 'comments', 'tags', 'created', 'last_updated', ) default_columns = ( - 'pk', 'name', 'status', 'cluster', 'role', 'tenant', 'vcpus', 'memory', 'disk', 'primary_ip', + 'pk', 'name', 'status', 'site', 'cluster', 'role', 'tenant', 'vcpus', 'memory', 'disk', 'primary_ip', ) diff --git a/netbox/virtualization/tests/test_api.py b/netbox/virtualization/tests/test_api.py index 887781e01..b2ae68860 100644 --- a/netbox/virtualization/tests/test_api.py +++ b/netbox/virtualization/tests/test_api.py @@ -2,6 +2,7 @@ from django.urls import reverse from rest_framework import status from dcim.choices import InterfaceModeChoices +from dcim.models import Site from ipam.models import VLAN, VRF from utilities.testing import APITestCase, APIViewTestCases, create_test_device from virtualization.choices import * @@ -146,39 +147,49 @@ class VirtualMachineTest(APIViewTestCases.APIViewTestCase): clustertype = ClusterType.objects.create(name='Cluster Type 1', slug='cluster-type-1') clustergroup = ClusterGroup.objects.create(name='Cluster Group 1', slug='cluster-group-1') + sites = ( + Site(name='Site 1', slug='site-1'), + Site(name='Site 2', slug='site-2'), + Site(name='Site 3', slug='site-3'), + ) + Site.objects.bulk_create(sites) + clusters = ( - Cluster(name='Cluster 1', type=clustertype, group=clustergroup), - Cluster(name='Cluster 2', type=clustertype, group=clustergroup), + Cluster(name='Cluster 1', type=clustertype, site=sites[0], group=clustergroup), + Cluster(name='Cluster 2', type=clustertype, site=sites[1], group=clustergroup), + Cluster(name='Cluster 3', type=clustertype), ) Cluster.objects.bulk_create(clusters) - device1 = create_test_device('device1') - device1.cluster = clusters[0] - device1.save() - device2 = create_test_device('device2') - device2.cluster = clusters[1] - device2.save() + device1 = create_test_device('device1', site=sites[0], cluster=clusters[0]) + device2 = create_test_device('device2', site=sites[1], cluster=clusters[1]) virtual_machines = ( - VirtualMachine(name='Virtual Machine 1', cluster=clusters[0], device=device1, local_context_data={'A': 1}), - VirtualMachine(name='Virtual Machine 2', cluster=clusters[0], local_context_data={'B': 2}), - VirtualMachine(name='Virtual Machine 3', cluster=clusters[0], local_context_data={'C': 3}), + VirtualMachine(name='Virtual Machine 1', site=sites[0], cluster=clusters[0], device=device1, local_context_data={'A': 1}), + VirtualMachine(name='Virtual Machine 2', site=sites[0], cluster=clusters[0], local_context_data={'B': 2}), + VirtualMachine(name='Virtual Machine 3', site=sites[0], cluster=clusters[0], local_context_data={'C': 3}), ) VirtualMachine.objects.bulk_create(virtual_machines) cls.create_data = [ { 'name': 'Virtual Machine 4', + 'site': sites[1].pk, 'cluster': clusters[1].pk, 'device': device2.pk, }, { 'name': 'Virtual Machine 5', + 'site': sites[1].pk, 'cluster': clusters[1].pk, }, { 'name': 'Virtual Machine 6', - 'cluster': clusters[1].pk, + 'site': sites[1].pk, + }, + { + 'name': 'Virtual Machine 7', + 'cluster': clusters[2].pk, }, ] diff --git a/netbox/virtualization/tests/test_filtersets.py b/netbox/virtualization/tests/test_filtersets.py index 3fd43d0c1..d3ff12887 100644 --- a/netbox/virtualization/tests/test_filtersets.py +++ b/netbox/virtualization/tests/test_filtersets.py @@ -274,9 +274,9 @@ class VirtualMachineTestCase(TestCase, ChangeLoggedFilterSetTests): Tenant.objects.bulk_create(tenants) vms = ( - VirtualMachine(name='Virtual Machine 1', cluster=clusters[0], device=devices[0], platform=platforms[0], role=roles[0], tenant=tenants[0], status=VirtualMachineStatusChoices.STATUS_ACTIVE, vcpus=1, memory=1, disk=1, local_context_data={"foo": 123}), - VirtualMachine(name='Virtual Machine 2', cluster=clusters[1], device=devices[1], platform=platforms[1], role=roles[1], tenant=tenants[1], status=VirtualMachineStatusChoices.STATUS_STAGED, vcpus=2, memory=2, disk=2), - VirtualMachine(name='Virtual Machine 3', cluster=clusters[2], device=devices[2], platform=platforms[2], role=roles[2], tenant=tenants[2], status=VirtualMachineStatusChoices.STATUS_OFFLINE, vcpus=3, memory=3, disk=3), + VirtualMachine(name='Virtual Machine 1', site=sites[0], cluster=clusters[0], device=devices[0], platform=platforms[0], role=roles[0], tenant=tenants[0], status=VirtualMachineStatusChoices.STATUS_ACTIVE, vcpus=1, memory=1, disk=1, local_context_data={"foo": 123}), + VirtualMachine(name='Virtual Machine 2', site=sites[1], cluster=clusters[1], device=devices[1], platform=platforms[1], role=roles[1], tenant=tenants[1], status=VirtualMachineStatusChoices.STATUS_STAGED, vcpus=2, memory=2, disk=2), + VirtualMachine(name='Virtual Machine 3', site=sites[2], cluster=clusters[2], device=devices[2], platform=platforms[2], role=roles[2], tenant=tenants[2], status=VirtualMachineStatusChoices.STATUS_OFFLINE, vcpus=3, memory=3, disk=3), ) VirtualMachine.objects.bulk_create(vms) diff --git a/netbox/virtualization/tests/test_models.py b/netbox/virtualization/tests/test_models.py index 3b4d73a30..df5816efa 100644 --- a/netbox/virtualization/tests/test_models.py +++ b/netbox/virtualization/tests/test_models.py @@ -1,21 +1,19 @@ from django.core.exceptions import ValidationError from django.test import TestCase +from dcim.models import Site from virtualization.models import * from tenancy.models import Tenant class VirtualMachineTestCase(TestCase): - def setUp(self): - - cluster_type = ClusterType.objects.create(name='Test Cluster Type 1', slug='Test Cluster Type 1') - self.cluster = Cluster.objects.create(name='Test Cluster 1', type=cluster_type) - def test_vm_duplicate_name_per_cluster(self): + cluster_type = ClusterType.objects.create(name='Cluster Type 1', slug='cluster-type-1') + cluster = Cluster.objects.create(name='Cluster 1', type=cluster_type) vm1 = VirtualMachine( - cluster=self.cluster, + cluster=cluster, name='Test VM 1' ) vm1.save() @@ -43,3 +41,33 @@ class VirtualMachineTestCase(TestCase): # Two VMs assigned to the same Cluster and different Tenants should pass validation vm2.full_clean() vm2.save() + + def test_vm_mismatched_site_cluster(self): + cluster_type = ClusterType.objects.create(name='Cluster Type 1', slug='cluster-type-1') + + sites = ( + Site(name='Site 1', slug='site-1'), + Site(name='Site 2', slug='site-2'), + ) + Site.objects.bulk_create(sites) + + clusters = ( + Cluster(name='Cluster 1', type=cluster_type, site=sites[0]), + Cluster(name='Cluster 2', type=cluster_type, site=sites[1]), + Cluster(name='Cluster 3', type=cluster_type, site=None), + ) + Cluster.objects.bulk_create(clusters) + + # VM with site only should pass + VirtualMachine(name='vm1', site=sites[0]).full_clean() + + # VM with non-site cluster only should pass + VirtualMachine(name='vm1', cluster=clusters[2]).full_clean() + + # VM with mismatched site & cluster should fail + with self.assertRaises(ValidationError): + VirtualMachine(name='vm1', site=sites[0], cluster=clusters[1]).full_clean() + + # VM with cluster site but no direct site should fail + with self.assertRaises(ValidationError): + VirtualMachine(name='vm1', site=None, cluster=clusters[0]).full_clean() diff --git a/netbox/virtualization/tests/test_views.py b/netbox/virtualization/tests/test_views.py index 4b1d64de5..01d4394f3 100644 --- a/netbox/virtualization/tests/test_views.py +++ b/netbox/virtualization/tests/test_views.py @@ -168,23 +168,29 @@ class VirtualMachineTestCase(ViewTestCases.PrimaryObjectViewTestCase): ) Platform.objects.bulk_create(platforms) + sites = ( + Site(name='Site 1', slug='site-1'), + Site(name='Site 2', slug='site-2'), + ) + Site.objects.bulk_create(sites) + clustertype = ClusterType.objects.create(name='Cluster Type 1', slug='cluster-type-1') clusters = ( - Cluster(name='Cluster 1', type=clustertype), - Cluster(name='Cluster 2', type=clustertype), + Cluster(name='Cluster 1', type=clustertype, site=sites[0]), + Cluster(name='Cluster 2', type=clustertype, site=sites[1]), ) Cluster.objects.bulk_create(clusters) devices = ( - create_test_device('device1', cluster=clusters[0]), - create_test_device('device2', cluster=clusters[1]), + create_test_device('device1', site=sites[0], cluster=clusters[0]), + create_test_device('device2', site=sites[1], cluster=clusters[1]), ) VirtualMachine.objects.bulk_create([ - VirtualMachine(name='Virtual Machine 1', cluster=clusters[0], device=devices[0], role=deviceroles[0], platform=platforms[0]), - VirtualMachine(name='Virtual Machine 2', cluster=clusters[0], device=devices[0], role=deviceroles[0], platform=platforms[0]), - VirtualMachine(name='Virtual Machine 3', cluster=clusters[0], device=devices[0], role=deviceroles[0], platform=platforms[0]), + VirtualMachine(name='Virtual Machine 1', site=sites[0], cluster=clusters[0], device=devices[0], role=deviceroles[0], platform=platforms[0]), + VirtualMachine(name='Virtual Machine 2', site=sites[0], cluster=clusters[0], device=devices[0], role=deviceroles[0], platform=platforms[0]), + VirtualMachine(name='Virtual Machine 3', site=sites[0], cluster=clusters[0], device=devices[0], role=deviceroles[0], platform=platforms[0]), ]) tags = create_tags('Alpha', 'Bravo', 'Charlie') @@ -192,6 +198,7 @@ class VirtualMachineTestCase(ViewTestCases.PrimaryObjectViewTestCase): cls.form_data = { 'cluster': clusters[1].pk, 'device': devices[1].pk, + 'site': sites[1].pk, 'tenant': None, 'platform': platforms[1].pk, 'name': 'Virtual Machine X', @@ -208,13 +215,14 @@ class VirtualMachineTestCase(ViewTestCases.PrimaryObjectViewTestCase): } cls.csv_data = ( - "name,status,cluster,device", - "Virtual Machine 4,active,Cluster 1,device1", - "Virtual Machine 5,active,Cluster 1,device1", - "Virtual Machine 6,active,Cluster 1,", + "name,status,site,cluster,device", + "Virtual Machine 4,active,Site 1,Cluster 1,device1", + "Virtual Machine 5,active,Site 1,Cluster 1,device1", + "Virtual Machine 6,active,Site 1,Cluster 1,", ) cls.bulk_edit_data = { + 'site': sites[1].pk, 'cluster': clusters[1].pk, 'device': devices[1].pk, 'tenant': None, @@ -252,8 +260,8 @@ class VMInterfaceTestCase(ViewTestCases.DeviceComponentViewTestCase): clustertype = ClusterType.objects.create(name='Cluster Type 1', slug='cluster-type-1') cluster = Cluster.objects.create(name='Cluster 1', type=clustertype, site=site) virtualmachines = ( - VirtualMachine(name='Virtual Machine 1', cluster=cluster, role=devicerole), - VirtualMachine(name='Virtual Machine 2', cluster=cluster, role=devicerole), + VirtualMachine(name='Virtual Machine 1', site=site, cluster=cluster, role=devicerole), + VirtualMachine(name='Virtual Machine 2', site=site, cluster=cluster, role=devicerole), ) VirtualMachine.objects.bulk_create(virtualmachines) From 1bd39e6568c32fb2f95639ce705d1fb24a672d50 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 26 May 2022 16:01:20 -0400 Subject: [PATCH 075/593] Fix filtering cables by connected device/rack/site --- netbox/dcim/models/cables.py | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 42c298279..d52f53044 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -116,20 +116,6 @@ class Cable(NetBoxModel): if b_terminations is not None: self.b_terminations = b_terminations - @classmethod - def from_db(cls, db, field_names, values): - """ - Cache the original A and B terminations of existing Cable instances for later reference inside clean(). - """ - instance = super().from_db(db, field_names, values) - - # instance._orig_termination_a_type_id = instance.termination_a_type_id - # instance._orig_termination_a_ids = instance.termination_a_ids - # instance._orig_termination_b_type_id = instance.termination_b_type_id - # instance._orig_termination_b_ids = instance.termination_b_ids - - return instance - def __str__(self): pk = self.pk or self._pk return self.label or f'#{pk}' @@ -166,12 +152,11 @@ class Cable(NetBoxModel): else: self._abs_length = None - # TODO: Move to CableTermination - # # Store the parent Device for the A and B terminations (if applicable) to enable filtering - # if hasattr(self.termination_a[0], 'device'): - # self._termination_a_device = self.termination_a[0].device - # if hasattr(self.termination_b[0], 'device'): - # self._termination_b_device = self.termination_b[0].device + # Store the parent Device for the A and B terminations (if applicable) to enable filtering + if hasattr(self, 'a_terminations'): + self._termination_a_device = self.a_terminations[0].device + if hasattr(self, 'b_terminations'): + self._termination_b_device = self.b_terminations[0].device super().save(*args, **kwargs) From 6280398bc17211bbc5b321039144c1eb0461f4a9 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 26 May 2022 16:40:20 -0400 Subject: [PATCH 076/593] Clean up tests --- netbox/dcim/models/cables.py | 63 +++++++++++++++------- netbox/dcim/tests/test_models.py | 90 +++++++++++++++++++------------- 2 files changed, 98 insertions(+), 55 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index d52f53044..10acb2768 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -143,6 +143,50 @@ class Cable(NetBoxModel): elif self.length is None: self.length_unit = '' + a_terminations = [ + CableTermination(cable=self, cable_end='A', termination=t) for t in getattr(self, 'a_terminations', []) + ] + b_terminations = [ + CableTermination(cable=self, cable_end='B', termination=t) for t in getattr(self, 'b_terminations', []) + ] + + # Check that all termination objects for either end are of the same type + for terms in (a_terminations, b_terminations): + if terms and len(terms) > 1: + if not all(t.termination.parent_object == terms[0].termination.parent_object for t in terms[1:]): + raise ValidationError( + "All terminations on one end of a cable must belong to the same parent object." + ) + if not all(t.termination_type == terms[0].termination_type for t in terms[1:]): + raise ValidationError( + "Cannot connect different termination types to same end of cable." + ) + + # Check that termination types are compatible + if a_terminations and b_terminations: + a_type = a_terminations[0].termination_type.model + b_type = b_terminations[0].termination_type.model + if b_type not in COMPATIBLE_TERMINATION_TYPES.get(a_type): + raise ValidationError( + f"Incompatible termination types: {a_type} and {b_type}" + ) + + # Run clean() on any new CableTerminations + for cabletermination in [*a_terminations, *b_terminations]: + cabletermination.clean() + + # TODO + # # A front port cannot be connected to its corresponding rear port + # if ( + # type_a in ['frontport', 'rearport'] and + # type_b in ['frontport', 'rearport'] and + # ( + # getattr(self.termination_a, 'rear_port', None) == self.termination_b or + # getattr(self.termination_b, 'rear_port', None) == self.termination_a + # ) + # ): + # raise ValidationError("A front port cannot be connected to it corresponding rear port") + def save(self, *args, **kwargs): _created = self.pk is None @@ -258,25 +302,6 @@ class CableTermination(models.Model): 'termination': "Circuit terminations attached to a provider network may not be cabled." }) - # TODO - # # A front port cannot be connected to its corresponding rear port - # if ( - # type_a in ['frontport', 'rearport'] and - # type_b in ['frontport', 'rearport'] and - # ( - # getattr(self.termination_a, 'rear_port', None) == self.termination_b or - # getattr(self.termination_b, 'rear_port', None) == self.termination_a - # ) - # ): - # raise ValidationError("A front port cannot be connected to it corresponding rear port") - - # TODO - # # Check that termination types are compatible - # if type_b not in COMPATIBLE_TERMINATION_TYPES.get(type_a): - # raise ValidationError( - # f"Incompatible termination types: {self.termination_a_type} and {self.termination_b_type}" - # ) - def save(self, *args, **kwargs): super().save(*args, **kwargs) diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index 16b8e1c48..e3d775b23 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -521,22 +521,39 @@ class CableTestCase(TestCase): self.assertIsNone(interface2.cable) self.assertIsNone(interface2._link_peer) + def test_cable_validates_same_parent_object(self): + """ + The clean method should ensure that all terminations at either end of a Cable belong to the same parent object. + """ + cable = Cable(a_terminations=[self.interface1], b_terminations=[self.power_port1]) + with self.assertRaises(ValidationError): + cable.clean() + + def test_cable_validates_same_type(self): + """ + The clean method should ensure that all terminations at either end of a Cable are of the same type. + """ + cable = Cable(a_terminations=[self.front_port1, self.rear_port1], b_terminations=[self.interface1]) + with self.assertRaises(ValidationError): + cable.clean() + def test_cable_validates_compatible_types(self): """ The clean method should have a check to ensure only compatible port types can be connected by a cable """ # An interface cannot be connected to a power port - cable = Cable(a_terminations=[self.interface1], b_terminations=[self.power_port1]) + cable = Cable(a_terminations=[self.interface1, self.interface2], b_terminations=[self.interface3]) with self.assertRaises(ValidationError): cable.clean() - def test_cable_front_port_cannot_connect_to_corresponding_rear_port(self): - """ - A cable cannot connect a front port to its corresponding rear port - """ - cable = Cable(a_terminations=[self.front_port1], b_terminations=[self.rear_port1]) - with self.assertRaises(ValidationError): - cable.clean() + # TODO: Remove this? + # def test_cable_front_port_cannot_connect_to_corresponding_rear_port(self): + # """ + # A cable cannot connect a front port to its corresponding rear port + # """ + # cable = Cable(a_terminations=[self.front_port1], b_terminations=[self.rear_port1]) + # with self.assertRaises(ValidationError): + # cable.clean() def test_cable_cannot_terminate_to_a_provider_network_circuittermination(self): """ @@ -546,34 +563,35 @@ class CableTestCase(TestCase): with self.assertRaises(ValidationError): cable.clean() - def test_rearport_connections(self): - """ - Test various combinations of RearPort connections. - """ - # Connecting a single-position RearPort to a multi-position RearPort is ok - Cable(a_terminations=[self.rear_port1], b_terminations=[self.rear_port2]).full_clean() - - # Connecting a single-position RearPort to an Interface is ok - Cable(a_terminations=[self.rear_port1], b_terminations=[self.interface3]).full_clean() - - # Connecting a single-position RearPort to a CircuitTermination is ok - Cable(a_terminations=[self.rear_port1], b_terminations=[self.circuittermination1]).full_clean() - - # Connecting a multi-position RearPort to another RearPort with the same number of positions is ok - Cable(a_terminations=[self.rear_port3], b_terminations=[self.rear_port4]).full_clean() - - # Connecting a multi-position RearPort to an Interface is ok - Cable(a_terminations=[self.rear_port2], b_terminations=[self.interface3]).full_clean() - - # Connecting a multi-position RearPort to a CircuitTermination is ok - Cable(a_terminations=[self.rear_port2], b_terminations=[self.circuittermination1]).full_clean() - - # Connecting a two-position RearPort to a three-position RearPort is NOT ok - with self.assertRaises( - ValidationError, - msg='Connecting a 2-position RearPort to a 3-position RearPort should fail' - ): - Cable(a_terminations=[self.rear_port2], b_terminations=[self.rear_port3]).full_clean() + # TODO: Remove this? + # def test_rearport_connections(self): + # """ + # Test various combinations of RearPort connections. + # """ + # # Connecting a single-position RearPort to a multi-position RearPort is ok + # Cable(a_terminations=[self.rear_port1], b_terminations=[self.rear_port2]).full_clean() + # + # # Connecting a single-position RearPort to an Interface is ok + # Cable(a_terminations=[self.rear_port1], b_terminations=[self.interface3]).full_clean() + # + # # Connecting a single-position RearPort to a CircuitTermination is ok + # Cable(a_terminations=[self.rear_port1], b_terminations=[self.circuittermination1]).full_clean() + # + # # Connecting a multi-position RearPort to another RearPort with the same number of positions is ok + # Cable(a_terminations=[self.rear_port3], b_terminations=[self.rear_port4]).full_clean() + # + # # Connecting a multi-position RearPort to an Interface is ok + # Cable(a_terminations=[self.rear_port2], b_terminations=[self.interface3]).full_clean() + # + # # Connecting a multi-position RearPort to a CircuitTermination is ok + # Cable(a_terminations=[self.rear_port2], b_terminations=[self.circuittermination1]).full_clean() + # + # # Connecting a two-position RearPort to a three-position RearPort is NOT ok + # with self.assertRaises( + # ValidationError, + # msg='Connecting a 2-position RearPort to a 3-position RearPort should fail' + # ): + # Cable(a_terminations=[self.rear_port2], b_terminations=[self.rear_port3]).full_clean() def test_cable_cannot_terminate_to_a_virtual_interface(self): """ From 6d3cded57934327f3d4167069be41fde860ee7dd Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Fri, 27 May 2022 20:41:50 +0200 Subject: [PATCH 077/593] Make sure initial data is passed as array for DynamicModelChoiceFields --- netbox/utilities/forms/fields/dynamic.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/netbox/utilities/forms/fields/dynamic.py b/netbox/utilities/forms/fields/dynamic.py index f83fc6a7c..dc3bab9fc 100644 --- a/netbox/utilities/forms/fields/dynamic.py +++ b/netbox/utilities/forms/fields/dynamic.py @@ -88,7 +88,12 @@ class DynamicModelChoiceMixin: # Modify the QuerySet of the field before we return it. Limit choices to any data already bound: Options # will be populated on-demand via the APISelect widget. data = bound_field.value() + if data: + # When the field is multiple choice pass the data as a list if it's not already + if isinstance(bound_field.field, DynamicModelMultipleChoiceField) and not type(data) is list: + data = [data] + field_name = getattr(self, 'to_field_name') or 'pk' filter = self.filter(field_name=field_name) try: From fe899d9d7cdb458298b92c2f46792adaf211851d Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Sat, 28 May 2022 11:29:18 +0200 Subject: [PATCH 078/593] Iterate base classes when searching for ScriptVariables --- netbox/extras/scripts.py | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py index 4332d72f7..29fab5be8 100644 --- a/netbox/extras/scripts.py +++ b/netbox/extras/scripts.py @@ -306,9 +306,16 @@ class BaseScript: @classmethod def _get_vars(cls): vars = {} - for name, attr in cls.__dict__.items(): - if name not in vars and issubclass(attr.__class__, ScriptVariable): - vars[name] = attr + + # Iterate all base classes looking for ScriptVariables + for base_class in inspect.getmro(cls): + # When object is reached there's no reason to continue + if base_class is object: + break + + for name, attr in base_class.__dict__.items(): + if name not in vars and issubclass(attr.__class__, ScriptVariable): + vars[name] = attr # Order variables according to field_order field_order = getattr(cls.Meta, 'field_order', None) From a0a87fc4c09e3e19d573925dbdf6f07370edfec0 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 31 May 2022 09:14:23 -0400 Subject: [PATCH 079/593] Changelog for #9420, #9430 --- 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 c5b224359..3a46e060f 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -17,6 +17,8 @@ * [#9094](https://github.com/netbox-community/netbox/issues/9094) - Fix partial address search within Prefix and Aggregate filters * [#9358](https://github.com/netbox-community/netbox/issues/9358) - Annotate circuit count for providers list under ASN view * [#9387](https://github.com/netbox-community/netbox/issues/9387) - Ensure ActionsColumn `extra_buttons` are always displayed +* [#9420](https://github.com/netbox-community/netbox/issues/9420) - Fix custom script class inheritance +* [#9430](https://github.com/netbox-community/netbox/issues/9430) - Fix passing of initial form data for DynamicModelChoiceFields --- From 998a392bd3f67ee13c01cb099a189cc09c797385 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 31 May 2022 11:37:30 -0400 Subject: [PATCH 080/593] Fixes #9425: Fix bulk import for object and multi-object custom fields --- docs/release-notes/version-3.2.md | 1 + netbox/extras/forms/bulk_import.py | 11 +++++++++-- netbox/extras/tests/test_views.py | 9 +++++---- 3 files changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 3a46e060f..8fdfafdb7 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -18,6 +18,7 @@ * [#9358](https://github.com/netbox-community/netbox/issues/9358) - Annotate circuit count for providers list under ASN view * [#9387](https://github.com/netbox-community/netbox/issues/9387) - Ensure ActionsColumn `extra_buttons` are always displayed * [#9420](https://github.com/netbox-community/netbox/issues/9420) - Fix custom script class inheritance +* [#9425](https://github.com/netbox-community/netbox/issues/9425) - Fix bulk import for object and multi-object custom fields * [#9430](https://github.com/netbox-community/netbox/issues/9430) - Fix passing of initial form data for DynamicModelChoiceFields diff --git a/netbox/extras/forms/bulk_import.py b/netbox/extras/forms/bulk_import.py index fa6d8af55..878b83c7c 100644 --- a/netbox/extras/forms/bulk_import.py +++ b/netbox/extras/forms/bulk_import.py @@ -27,6 +27,12 @@ class CustomFieldCSVForm(CSVModelForm): choices=CustomFieldTypeChoices, help_text='Field data type (e.g. text, integer, etc.)' ) + object_type = CSVContentTypeField( + queryset=ContentType.objects.all(), + limit_choices_to=FeatureQuery('custom_fields'), + required=False, + help_text="Object type (for object or multi-object fields)" + ) choices = SimpleArrayField( base_field=forms.CharField(), required=False, @@ -36,8 +42,9 @@ class CustomFieldCSVForm(CSVModelForm): class Meta: model = CustomField fields = ( - 'name', 'label', 'type', 'content_types', 'required', 'description', 'weight', 'filter_logic', 'default', - 'choices', 'weight', 'validation_minimum', 'validation_maximum', 'validation_regex', + 'name', 'label', 'type', 'content_types', 'object_type', 'required', 'description', 'weight', + 'filter_logic', 'default', 'choices', 'weight', 'validation_minimum', 'validation_maximum', + 'validation_regex', ) diff --git a/netbox/extras/tests/test_views.py b/netbox/extras/tests/test_views.py index ea3a952d6..1cfc4b3cc 100644 --- a/netbox/extras/tests/test_views.py +++ b/netbox/extras/tests/test_views.py @@ -39,10 +39,11 @@ class CustomFieldTestCase(ViewTestCases.PrimaryObjectViewTestCase): } cls.csv_data = ( - 'name,label,type,content_types,weight,filter_logic,choices,validation_minimum,validation_maximum,validation_regex', - 'field4,Field 4,text,dcim.site,100,exact,,,,[a-z]{3}', - 'field5,Field 5,integer,dcim.site,100,exact,,1,100,', - 'field6,Field 6,select,dcim.site,100,exact,"A,B,C",,,', + 'name,label,type,content_types,object_type,weight,filter_logic,choices,validation_minimum,validation_maximum,validation_regex', + 'field4,Field 4,text,dcim.site,,100,exact,,,,[a-z]{3}', + 'field5,Field 5,integer,dcim.site,,100,exact,,1,100,', + 'field6,Field 6,select,dcim.site,,100,exact,"A,B,C",,,', + 'field7,Field 7,object,dcim.site,dcim.region,100,exact,,,,', ) cls.bulk_edit_data = { From 5838a9f3a00b32900ce8ef62fa0936fd18cf0636 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 31 May 2022 12:01:33 -0400 Subject: [PATCH 081/593] Closes #9451: Add export_raw argument for TemplateColumn --- docs/plugins/development/tables.md | 3 ++- docs/release-notes/version-3.2.md | 1 + netbox/netbox/tables/columns.py | 13 +++++++++++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/plugins/development/tables.md b/docs/plugins/development/tables.md index 77e258def..6dccb4ee2 100644 --- a/docs/plugins/development/tables.md +++ b/docs/plugins/development/tables.md @@ -85,4 +85,5 @@ The table column classes listed below are supported for use in plugins. These cl ::: netbox.tables.TemplateColumn selection: - members: false + members: + - __init__ diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 8fdfafdb7..b4efda4dc 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -11,6 +11,7 @@ * [#9277](https://github.com/netbox-community/netbox/issues/9277) - Introduce `CSRF_COOKIE_NAME` configuration parameter * [#9347](https://github.com/netbox-community/netbox/issues/9347) - Include services in global search * [#9379](https://github.com/netbox-community/netbox/issues/9379) - Redirect to virtual chassis view after adding a member device +* [#9451](https://github.com/netbox-community/netbox/issues/9451) - Add `export_raw` argument for TemplateColumn ### Bug Fixes diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index 0c26e541e..e82e8a1ea 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -90,6 +90,15 @@ class TemplateColumn(tables.TemplateColumn): """ PLACEHOLDER = mark_safe('—') + def __init__(self, export_raw=False, **kwargs): + """ + Args: + export_raw: If true, data export returns the raw field value rather than the rendered template. (Default: + False) + """ + super().__init__(**kwargs) + self.export_raw = export_raw + def render(self, *args, **kwargs): ret = super().render(*args, **kwargs) if not ret.strip(): @@ -97,6 +106,10 @@ class TemplateColumn(tables.TemplateColumn): return ret def value(self, **kwargs): + if self.export_raw: + # Skip template rendering and export raw value + return kwargs.get('value') + ret = super().value(**kwargs) if ret == self.PLACEHOLDER: return '' From f1d0d8e57a4fc14f501b0b6502e3eb8b3f9ef9cc Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 31 May 2022 12:23:22 -0400 Subject: [PATCH 082/593] Fixes #9407: Clean up display of prefixes values when exporting prefixes list --- docs/release-notes/version-3.2.md | 1 + netbox/ipam/tables/ip.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index b4efda4dc..e4594cd6c 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -18,6 +18,7 @@ * [#9094](https://github.com/netbox-community/netbox/issues/9094) - Fix partial address search within Prefix and Aggregate filters * [#9358](https://github.com/netbox-community/netbox/issues/9358) - Annotate circuit count for providers list under ASN view * [#9387](https://github.com/netbox-community/netbox/issues/9387) - Ensure ActionsColumn `extra_buttons` are always displayed +* [#9407](https://github.com/netbox-community/netbox/issues/9407) - Clean up display of prefixes values when exporting prefixes list * [#9420](https://github.com/netbox-community/netbox/issues/9420) - Fix custom script class inheritance * [#9425](https://github.com/netbox-community/netbox/issues/9425) - Fix bulk import for object and multi-object custom fields * [#9430](https://github.com/netbox-community/netbox/issues/9430) - Fix passing of initial form data for DynamicModelChoiceFields diff --git a/netbox/ipam/tables/ip.py b/netbox/ipam/tables/ip.py index 475ad787e..558631585 100644 --- a/netbox/ipam/tables/ip.py +++ b/netbox/ipam/tables/ip.py @@ -226,8 +226,9 @@ class PrefixUtilizationColumn(columns.UtilizationColumn): class PrefixTable(NetBoxTable): - prefix = tables.TemplateColumn( + prefix = columns.TemplateColumn( template_code=PREFIX_LINK, + export_raw=True, attrs={'td': {'class': 'text-nowrap'}} ) prefix_flat = tables.TemplateColumn( From 201b9f635eb0127d241341d5784e01775e887b09 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 31 May 2022 13:26:25 -0400 Subject: [PATCH 083/593] Fixes #9402: Fix custom field population when creating a virtual chassis --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/forms/object_create.py | 2 ++ 2 files changed, 3 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index e4594cd6c..b38b95ba8 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -18,6 +18,7 @@ * [#9094](https://github.com/netbox-community/netbox/issues/9094) - Fix partial address search within Prefix and Aggregate filters * [#9358](https://github.com/netbox-community/netbox/issues/9358) - Annotate circuit count for providers list under ASN view * [#9387](https://github.com/netbox-community/netbox/issues/9387) - Ensure ActionsColumn `extra_buttons` are always displayed +* [#9402](https://github.com/netbox-community/netbox/issues/9402) - Fix custom field population when creating a virtual chassis * [#9407](https://github.com/netbox-community/netbox/issues/9407) - Clean up display of prefixes values when exporting prefixes list * [#9420](https://github.com/netbox-community/netbox/issues/9420) - Fix custom script class inheritance * [#9425](https://github.com/netbox-community/netbox/issues/9425) - Fix bulk import for object and multi-object custom fields diff --git a/netbox/dcim/forms/object_create.py b/netbox/dcim/forms/object_create.py index e3e9c1179..8c9ddab19 100644 --- a/netbox/dcim/forms/object_create.py +++ b/netbox/dcim/forms/object_create.py @@ -256,6 +256,8 @@ class VirtualChassisCreateForm(NetBoxModelForm): ] def clean(self): + super().clean() + if self.cleaned_data['members'] and self.cleaned_data['initial_position'] is None: raise forms.ValidationError({ 'initial_position': "A position must be specified for the first VC member." From b0a56a71bb037e883eddca8234caabf8e93e7f5b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 31 May 2022 13:37:14 -0400 Subject: [PATCH 084/593] Fixes #9291: Improve data validation for MultiObjectVar script fields --- docs/release-notes/version-3.2.md | 1 + netbox/utilities/forms/fields/dynamic.py | 9 +++++---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index b38b95ba8..90c2143d2 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -16,6 +16,7 @@ ### Bug Fixes * [#9094](https://github.com/netbox-community/netbox/issues/9094) - Fix partial address search within Prefix and Aggregate filters +* [#9291](https://github.com/netbox-community/netbox/issues/9291) - Improve data validation for MultiObjectVar script fields * [#9358](https://github.com/netbox-community/netbox/issues/9358) - Annotate circuit count for providers list under ASN view * [#9387](https://github.com/netbox-community/netbox/issues/9387) - Ensure ActionsColumn `extra_buttons` are always displayed * [#9402](https://github.com/netbox-community/netbox/issues/9402) - Fix custom field population when creating a virtual chassis diff --git a/netbox/utilities/forms/fields/dynamic.py b/netbox/utilities/forms/fields/dynamic.py index dc3bab9fc..68e71610c 100644 --- a/netbox/utilities/forms/fields/dynamic.py +++ b/netbox/utilities/forms/fields/dynamic.py @@ -135,11 +135,12 @@ class DynamicModelMultipleChoiceField(DynamicModelChoiceMixin, forms.ModelMultip widget = widgets.APISelectMultiple def clean(self, value): - """ - When null option is enabled and "None" is sent as part of a form to be submitted, it is sent as the - string 'null'. This will check for that condition and gracefully handle the conversion to a NoneType. - """ + value = value or [] + + # When null option is enabled and "None" is sent as part of a form to be submitted, it is sent as the + # string 'null'. This will check for that condition and gracefully handle the conversion to a NoneType. if self.null_option is not None and settings.FILTERS_NULL_CHOICE_VALUE in value: value = [v for v in value if v != settings.FILTERS_NULL_CHOICE_VALUE] return [None, *value] + return super().clean(value) From 6c035eb13dee9d75bcd58e7346047f06325006bf Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 31 May 2022 15:08:33 -0400 Subject: [PATCH 085/593] Release v3.2.4 --- .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 df5ac6e81..a9af9c653 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.3 + placeholder: v3.2.4 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 422b87f52..1fff99f1d 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.3 + placeholder: v3.2.4 validations: required: true - type: dropdown diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 90c2143d2..fa533a475 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.4 (FUTURE) +## v3.2.4 (2022-05-31) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 524557db6..bd351a0a1 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.4-dev' +VERSION = '3.2.4' # Hostname HOSTNAME = platform.node() diff --git a/requirements.txt b/requirements.txt index 0a15fcf20..293a33542 100644 --- a/requirements.txt +++ b/requirements.txt @@ -18,10 +18,10 @@ gunicorn==20.1.0 Jinja2==3.1.2 Markdown==3.3.7 markdown-include==0.6.0 -mkdocs-material==8.2.14 -mkdocstrings[python-legacy]==0.18.1 +mkdocs-material==8.2.16 +mkdocstrings[python-legacy]==0.19.0 netaddr==0.8.0 -Pillow==9.1.0 +Pillow==9.1.1 psycopg2-binary==2.9.3 PyYAML==6.0 sentry-sdk==1.5.12 From 3fbf1f7e71801487abd3524797298d82dca4db4f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 31 May 2022 15:31:22 -0400 Subject: [PATCH 086/593] PRVB --- docs/release-notes/version-3.2.md | 5 ++++- netbox/netbox/settings.py | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index fa533a475..ea5e580b8 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.5 (FUTURE) + +--- + ## v3.2.4 (2022-05-31) ### Enhancements @@ -25,7 +29,6 @@ * [#9425](https://github.com/netbox-community/netbox/issues/9425) - Fix bulk import for object and multi-object custom fields * [#9430](https://github.com/netbox-community/netbox/issues/9430) - Fix passing of initial form data for DynamicModelChoiceFields - --- ## v3.2.3 (2022-05-12) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index bd351a0a1..16c2b8b6e 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.4' +VERSION = '3.2.5-dev' # Hostname HOSTNAME = platform.node() From 6befd2155a181e8d7aef9f436b0c18f7d73a4779 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 1 Jun 2022 11:38:31 -0400 Subject: [PATCH 087/593] Clean up tests --- netbox/dcim/models/cables.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 10acb2768..a1d9d3ea9 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -198,9 +198,9 @@ class Cable(NetBoxModel): # Store the parent Device for the A and B terminations (if applicable) to enable filtering if hasattr(self, 'a_terminations'): - self._termination_a_device = self.a_terminations[0].device + self._termination_a_device = getattr(self.a_terminations[0], 'device', None) if hasattr(self, 'b_terminations'): - self._termination_b_device = self.b_terminations[0].device + self._termination_b_device = getattr(self.b_terminations[0], 'device', None) super().save(*args, **kwargs) From 3362bc3106095748d83aa908fa65f79e42c57717 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 1 Jun 2022 16:48:56 -0400 Subject: [PATCH 088/593] Remove link peer fields from cable termination models --- netbox/circuits/api/serializers.py | 2 +- netbox/circuits/api/views.py | 2 +- netbox/circuits/filtersets.py | 2 +- .../migrations/0036_new_cabling_models.py | 16 +++ .../migrations/0037_cabling_cleanup.py | 20 +++ netbox/dcim/api/serializers.py | 52 +++++--- netbox/dcim/api/views.py | 18 +-- netbox/dcim/choices.py | 3 +- netbox/dcim/filtersets.py | 18 +-- .../dcim/migrations/0154_cabletermination.py | 30 ----- .../migrations/0154_new_cabling_models.py | 91 +++++++++++++ .../0155_populate_cable_terminations.py | 2 +- .../0156_cable_remove_terminations.py | 37 ----- ...e_path.py => 0156_populate_cable_paths.py} | 2 +- netbox/dcim/migrations/0157_cablepath.py | 28 ---- .../migrations/0157_populate_cable_ends.py | 42 ++++++ .../dcim/migrations/0158_cabling_cleanup.py | 126 ++++++++++++++++++ ...159_cablepath_remove_origin_destination.py | 33 ----- netbox/dcim/models/cables.py | 5 +- netbox/dcim/models/device_components.py | 39 +++--- netbox/dcim/signals.py | 2 +- netbox/dcim/tests/test_models.py | 12 +- .../circuits/inc/circuit_termination.html | 9 +- netbox/wireless/signals.py | 14 +- 24 files changed, 389 insertions(+), 216 deletions(-) create mode 100644 netbox/circuits/migrations/0036_new_cabling_models.py create mode 100644 netbox/circuits/migrations/0037_cabling_cleanup.py delete mode 100644 netbox/dcim/migrations/0154_cabletermination.py create mode 100644 netbox/dcim/migrations/0154_new_cabling_models.py delete mode 100644 netbox/dcim/migrations/0156_cable_remove_terminations.py rename netbox/dcim/migrations/{0158_cablepath_populate_path.py => 0156_populate_cable_paths.py} (96%) delete mode 100644 netbox/dcim/migrations/0157_cablepath.py create mode 100644 netbox/dcim/migrations/0157_populate_cable_ends.py create mode 100644 netbox/dcim/migrations/0158_cabling_cleanup.py delete mode 100644 netbox/dcim/migrations/0159_cablepath_remove_origin_destination.py diff --git a/netbox/circuits/api/serializers.py b/netbox/circuits/api/serializers.py index 19570f067..eac411261 100644 --- a/netbox/circuits/api/serializers.py +++ b/netbox/circuits/api/serializers.py @@ -109,6 +109,6 @@ class CircuitTerminationSerializer(ValidatedModelSerializer, LinkTerminationSeri model = CircuitTermination fields = [ 'id', 'url', 'display', 'circuit', 'term_side', 'site', 'provider_network', 'port_speed', 'upstream_speed', - 'xconnect_id', 'pp_info', 'description', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', + 'xconnect_id', 'pp_info', 'description', 'mark_connected', 'cable', 'link_peers', 'link_peers_type', '_occupied', 'created', 'last_updated', ] diff --git a/netbox/circuits/api/views.py b/netbox/circuits/api/views.py index 3573c05e3..f5f3f0fab 100644 --- a/netbox/circuits/api/views.py +++ b/netbox/circuits/api/views.py @@ -58,7 +58,7 @@ class CircuitViewSet(NetBoxModelViewSet): class CircuitTerminationViewSet(PassThroughPortMixin, NetBoxModelViewSet): queryset = CircuitTermination.objects.prefetch_related( - 'circuit', 'site', 'provider_network', 'cable' + 'circuit', 'site', 'provider_network', 'cable__terminations' ) serializer_class = serializers.CircuitTerminationSerializer filterset_class = filtersets.CircuitTerminationFilterSet diff --git a/netbox/circuits/filtersets.py b/netbox/circuits/filtersets.py index 2087d90d2..4985d0529 100644 --- a/netbox/circuits/filtersets.py +++ b/netbox/circuits/filtersets.py @@ -224,7 +224,7 @@ class CircuitTerminationFilterSet(ChangeLoggedModelFilterSet, CabledObjectFilter class Meta: model = CircuitTermination - fields = ['id', 'term_side', 'port_speed', 'upstream_speed', 'xconnect_id', 'description'] + fields = ['id', 'term_side', 'port_speed', 'upstream_speed', 'xconnect_id', 'description', 'cable_end'] def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/circuits/migrations/0036_new_cabling_models.py b/netbox/circuits/migrations/0036_new_cabling_models.py new file mode 100644 index 000000000..7e5a89093 --- /dev/null +++ b/netbox/circuits/migrations/0036_new_cabling_models.py @@ -0,0 +1,16 @@ +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('circuits', '0035_provider_asns'), + ] + + operations = [ + migrations.AddField( + model_name='circuittermination', + name='cable_end', + field=models.CharField(blank=True, max_length=1), + ), + ] diff --git a/netbox/circuits/migrations/0037_cabling_cleanup.py b/netbox/circuits/migrations/0037_cabling_cleanup.py new file mode 100644 index 000000000..a7f550749 --- /dev/null +++ b/netbox/circuits/migrations/0037_cabling_cleanup.py @@ -0,0 +1,20 @@ +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('circuits', '0036_new_cabling_models'), + ('dcim', '0157_populate_cable_ends'), + ] + + operations = [ + migrations.RemoveField( + model_name='circuittermination', + name='_link_peer_id', + ), + migrations.RemoveField( + model_name='circuittermination', + name='_link_peer_type', + ), + ] diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 53f5d1327..fe7c0ba2f 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -27,25 +27,37 @@ from .nested_serializers import * class LinkTerminationSerializer(serializers.ModelSerializer): - link_peer_type = serializers.SerializerMethodField(read_only=True) - link_peer = serializers.SerializerMethodField(read_only=True) + link_peers_type = serializers.SerializerMethodField(read_only=True) + link_peers = serializers.SerializerMethodField(read_only=True) _occupied = serializers.SerializerMethodField(read_only=True) - def get_link_peer_type(self, obj): - if obj._link_peer is not None: - return f'{obj._link_peer._meta.app_label}.{obj._link_peer._meta.model_name}' + def get_link_peers_type(self, obj): + """ + Return the type of the peer link terminations, or None. + """ + if not obj.cable: + return None + + if obj.link_peers: + return f'{obj.link_peers[0]._meta.app_label}.{obj.link_peers[0]._meta.model_name}' + return None - @swagger_serializer_method(serializer_or_field=serializers.DictField) - def get_link_peer(self, obj): + @swagger_serializer_method(serializer_or_field=serializers.ListField) + def get_link_peers(self, obj): """ Return the appropriate serializer for the link termination model. """ - if obj._link_peer is not None: - serializer = get_serializer_for_model(obj._link_peer, prefix='Nested') + if not obj.cable: + return [] + + # Return serialized peer termination objects + if obj.link_peers: + serializer = get_serializer_for_model(obj.link_peers[0], prefix='Nested') context = {'request': self.context['request']} - return serializer(obj._link_peer, context=context).data - return None + return serializer(obj.link_peers, context=context, many=True).data + + return [] @swagger_serializer_method(serializer_or_field=serializers.BooleanField) def get__occupied(self, obj): @@ -96,7 +108,7 @@ class ConnectedEndpointsSerializer(serializers.ModelSerializer): if endpoints: return f'{endpoints[0]._meta.app_label}.{endpoints[0]._meta.model_name}' - @swagger_serializer_method(serializer_or_field=serializers.DictField) + @swagger_serializer_method(serializer_or_field=serializers.ListField) def get_connected_endpoints(self, obj): """ Return the appropriate serializer for the type of connected object. @@ -715,7 +727,7 @@ class ConsoleServerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializ model = ConsoleServerPort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'speed', 'description', - 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoints', 'connected_endpoints_type', + 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] @@ -743,7 +755,7 @@ class ConsolePortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Co model = ConsolePort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'speed', 'description', - 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoints', 'connected_endpoints_type', + 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] @@ -777,7 +789,7 @@ class PowerOutletSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Co model = PowerOutlet fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'power_port', 'feed_leg', - 'description', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoints', + 'description', 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] @@ -801,7 +813,7 @@ class PowerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn model = PowerPort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'maximum_draw', 'allocated_draw', - 'description', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'connected_endpoints', + 'description', 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] @@ -847,7 +859,7 @@ class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'enabled', 'parent', 'bridge', 'lag', 'mtu', 'mac_address', 'speed', 'duplex', 'wwn', 'mgmt_only', 'description', 'mode', 'rf_role', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'untagged_vlan', 'tagged_vlans', 'mark_connected', - 'cable', 'wireless_link', 'link_peer', 'link_peer_type', 'wireless_lans', 'vrf', 'connected_endpoints', + 'cable', 'wireless_link', 'link_peers', 'link_peers_type', 'wireless_lans', 'vrf', 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', 'count_ipaddresses', 'count_fhrp_groups', '_occupied', ] @@ -880,7 +892,7 @@ class RearPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer): model = RearPort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'color', 'positions', 'description', - 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'tags', 'custom_fields', 'created', + 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] @@ -911,7 +923,7 @@ class FrontPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer): model = FrontPort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'color', 'rear_port', - 'rear_port_position', 'description', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', 'tags', + 'rear_port_position', 'description', 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] @@ -1193,7 +1205,7 @@ class PowerFeedSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn model = PowerFeed fields = [ 'id', 'url', 'display', 'power_panel', 'rack', 'name', 'status', 'type', 'supply', 'phase', 'voltage', - 'amperage', 'max_utilization', 'comments', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', + 'amperage', 'max_utilization', 'comments', 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 363523819..ef549caa6 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -546,7 +546,7 @@ class ModuleViewSet(NetBoxModelViewSet): class ConsolePortViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = ConsolePort.objects.prefetch_related( - 'device', 'module__module_bay', '_path', 'cable', '_link_peer', 'tags' + 'device', 'module__module_bay', '_path', 'cable__terminations', 'tags' ) serializer_class = serializers.ConsolePortSerializer filterset_class = filtersets.ConsolePortFilterSet @@ -555,7 +555,7 @@ class ConsolePortViewSet(PathEndpointMixin, NetBoxModelViewSet): class ConsoleServerPortViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = ConsoleServerPort.objects.prefetch_related( - 'device', 'module__module_bay', '_path', 'cable', '_link_peer', 'tags' + 'device', 'module__module_bay', '_path', 'cable__terminations', 'tags' ) serializer_class = serializers.ConsoleServerPortSerializer filterset_class = filtersets.ConsoleServerPortFilterSet @@ -564,7 +564,7 @@ class ConsoleServerPortViewSet(PathEndpointMixin, NetBoxModelViewSet): class PowerPortViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = PowerPort.objects.prefetch_related( - 'device', 'module__module_bay', '_path', 'cable', '_link_peer', 'tags' + 'device', 'module__module_bay', '_path', 'cable__terminations', 'tags' ) serializer_class = serializers.PowerPortSerializer filterset_class = filtersets.PowerPortFilterSet @@ -573,7 +573,7 @@ class PowerPortViewSet(PathEndpointMixin, NetBoxModelViewSet): class PowerOutletViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = PowerOutlet.objects.prefetch_related( - 'device', 'module__module_bay', '_path', 'cable', '_link_peer', 'tags' + 'device', 'module__module_bay', '_path', 'cable__terminations', 'tags' ) serializer_class = serializers.PowerOutletSerializer filterset_class = filtersets.PowerOutletFilterSet @@ -582,8 +582,8 @@ class PowerOutletViewSet(PathEndpointMixin, NetBoxModelViewSet): class InterfaceViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = Interface.objects.prefetch_related( - 'device', 'module__module_bay', 'parent', 'bridge', 'lag', '_path', 'cable', '_link_peer', - 'wireless_lans', 'untagged_vlan', 'tagged_vlans', 'vrf', 'ip_addresses', 'fhrp_group_assignments', 'tags' + 'device', 'module__module_bay', 'parent', 'bridge', 'lag', '_path', 'cable__terminations', 'wireless_lans', + 'untagged_vlan', 'tagged_vlans', 'vrf', 'ip_addresses', 'fhrp_group_assignments', 'tags' ) serializer_class = serializers.InterfaceSerializer filterset_class = filtersets.InterfaceFilterSet @@ -592,7 +592,7 @@ class InterfaceViewSet(PathEndpointMixin, NetBoxModelViewSet): class FrontPortViewSet(PassThroughPortMixin, NetBoxModelViewSet): queryset = FrontPort.objects.prefetch_related( - 'device__device_type__manufacturer', 'module__module_bay', 'rear_port', 'cable', 'tags' + 'device__device_type__manufacturer', 'module__module_bay', 'rear_port', 'cable__terminations', 'tags' ) serializer_class = serializers.FrontPortSerializer filterset_class = filtersets.FrontPortFilterSet @@ -601,7 +601,7 @@ class FrontPortViewSet(PassThroughPortMixin, NetBoxModelViewSet): class RearPortViewSet(PassThroughPortMixin, NetBoxModelViewSet): queryset = RearPort.objects.prefetch_related( - 'device__device_type__manufacturer', 'module__module_bay', 'cable', 'tags' + 'device__device_type__manufacturer', 'module__module_bay', 'cable__terminations', 'tags' ) serializer_class = serializers.RearPortSerializer filterset_class = filtersets.RearPortFilterSet @@ -691,7 +691,7 @@ class PowerPanelViewSet(NetBoxModelViewSet): class PowerFeedViewSet(PathEndpointMixin, NetBoxModelViewSet): queryset = PowerFeed.objects.prefetch_related( - 'power_panel', 'rack', '_path', 'cable', '_link_peer', 'tags' + 'power_panel', 'rack', '_path', 'cable__terminations', 'tags' ) serializer_class = serializers.PowerFeedSerializer filterset_class = filtersets.PowerFeedFilterSet diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index 5a351bb23..4b0dd6c48 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -1226,7 +1226,8 @@ class CableEndChoices(ChoiceSet): CHOICES = ( (SIDE_A, 'A'), - (SIDE_B, 'B') + (SIDE_B, 'B'), + ('', ''), ) diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index a80062526..6bb95a981 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -1141,7 +1141,7 @@ class ConsolePortFilterSet( class Meta: model = ConsolePort - fields = ['id', 'name', 'label', 'description'] + fields = ['id', 'name', 'label', 'description', 'cable_end'] class ConsoleServerPortFilterSet( @@ -1157,7 +1157,7 @@ class ConsoleServerPortFilterSet( class Meta: model = ConsoleServerPort - fields = ['id', 'name', 'label', 'description'] + fields = ['id', 'name', 'label', 'description', 'cable_end'] class PowerPortFilterSet( @@ -1173,7 +1173,7 @@ class PowerPortFilterSet( class Meta: model = PowerPort - fields = ['id', 'name', 'label', 'maximum_draw', 'allocated_draw', 'description'] + fields = ['id', 'name', 'label', 'maximum_draw', 'allocated_draw', 'description', 'cable_end'] class PowerOutletFilterSet( @@ -1193,7 +1193,7 @@ class PowerOutletFilterSet( class Meta: model = PowerOutlet - fields = ['id', 'name', 'label', 'feed_leg', 'description'] + fields = ['id', 'name', 'label', 'feed_leg', 'description', 'cable_end'] class InterfaceFilterSet( @@ -1273,7 +1273,7 @@ class InterfaceFilterSet( model = Interface fields = [ 'id', 'name', 'label', 'type', 'enabled', 'mtu', 'mgmt_only', 'mode', 'rf_role', 'rf_channel', - 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'description', + 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'description', 'cable_end', ] def filter_device(self, queryset, name, value): @@ -1336,7 +1336,7 @@ class FrontPortFilterSet( class Meta: model = FrontPort - fields = ['id', 'name', 'label', 'type', 'color', 'description'] + fields = ['id', 'name', 'label', 'type', 'color', 'description', 'cable_end'] class RearPortFilterSet( @@ -1351,7 +1351,7 @@ class RearPortFilterSet( class Meta: model = RearPort - fields = ['id', 'name', 'label', 'type', 'color', 'positions', 'description'] + fields = ['id', 'name', 'label', 'type', 'color', 'positions', 'description', 'cable_end'] class ModuleBayFilterSet(DeviceComponentFilterSet, NetBoxModelFilterSet): @@ -1679,7 +1679,9 @@ class PowerFeedFilterSet(NetBoxModelFilterSet, CabledObjectFilterSet, PathEndpoi class Meta: model = PowerFeed - fields = ['id', 'name', 'status', 'type', 'supply', 'phase', 'voltage', 'amperage', 'max_utilization'] + fields = [ + 'id', 'name', 'status', 'type', 'supply', 'phase', 'voltage', 'amperage', 'max_utilization', 'cable_end', + ] def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/dcim/migrations/0154_cabletermination.py b/netbox/dcim/migrations/0154_cabletermination.py deleted file mode 100644 index 88245d483..000000000 --- a/netbox/dcim/migrations/0154_cabletermination.py +++ /dev/null @@ -1,30 +0,0 @@ -from django.db import migrations, models -import django.db.models.deletion - - -class Migration(migrations.Migration): - - dependencies = [ - ('contenttypes', '0002_remove_content_type_name'), - ('dcim', '0153_created_datetimefield'), - ] - - operations = [ - migrations.CreateModel( - name='CableTermination', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), - ('cable_end', models.CharField(max_length=1)), - ('termination_id', models.PositiveBigIntegerField()), - ('cable', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='terminations', to='dcim.cable')), - ('termination_type', models.ForeignKey(limit_choices_to=models.Q(models.Q(models.Q(('app_label', 'circuits'), ('model__in', ('circuittermination',))), models.Q(('app_label', 'dcim'), ('model__in', ('consoleport', 'consoleserverport', 'frontport', 'interface', 'powerfeed', 'poweroutlet', 'powerport', 'rearport'))), _connector='OR')), on_delete=django.db.models.deletion.PROTECT, related_name='+', to='contenttypes.contenttype')), - ], - options={ - 'ordering': ('cable', 'cable_end', 'pk'), - }, - ), - migrations.AddConstraint( - model_name='cabletermination', - constraint=models.UniqueConstraint(fields=('termination_type', 'termination_id'), name='unique_termination'), - ), - ] diff --git a/netbox/dcim/migrations/0154_new_cabling_models.py b/netbox/dcim/migrations/0154_new_cabling_models.py new file mode 100644 index 000000000..6d8bd9ab6 --- /dev/null +++ b/netbox/dcim/migrations/0154_new_cabling_models.py @@ -0,0 +1,91 @@ +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('contenttypes', '0002_remove_content_type_name'), + ('dcim', '0153_created_datetimefield'), + ] + + operations = [ + + # Create CableTermination model + migrations.CreateModel( + name='CableTermination', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), + ('cable_end', models.CharField(max_length=1)), + ('termination_id', models.PositiveBigIntegerField()), + ('cable', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='terminations', to='dcim.cable')), + ('termination_type', models.ForeignKey(limit_choices_to=models.Q(models.Q(models.Q(('app_label', 'circuits'), ('model__in', ('circuittermination',))), models.Q(('app_label', 'dcim'), ('model__in', ('consoleport', 'consoleserverport', 'frontport', 'interface', 'powerfeed', 'poweroutlet', 'powerport', 'rearport'))), _connector='OR')), on_delete=django.db.models.deletion.PROTECT, related_name='+', to='contenttypes.contenttype')), + ], + options={ + 'ordering': ('cable', 'cable_end', 'pk'), + }, + ), + migrations.AddConstraint( + model_name='cabletermination', + constraint=models.UniqueConstraint(fields=('termination_type', 'termination_id'), name='unique_termination'), + ), + + # Update CablePath model + migrations.RenameField( + model_name='cablepath', + old_name='path', + new_name='_nodes', + ), + migrations.AddField( + model_name='cablepath', + name='path', + field=models.JSONField(default=list), + ), + migrations.AddField( + model_name='cablepath', + name='is_complete', + field=models.BooleanField(default=False), + ), + + # Add cable_end field to cable termination models + migrations.AddField( + model_name='consoleport', + name='cable_end', + field=models.CharField(blank=True, max_length=1), + ), + migrations.AddField( + model_name='consoleserverport', + name='cable_end', + field=models.CharField(blank=True, max_length=1), + ), + migrations.AddField( + model_name='frontport', + name='cable_end', + field=models.CharField(blank=True, max_length=1), + ), + migrations.AddField( + model_name='interface', + name='cable_end', + field=models.CharField(blank=True, max_length=1), + ), + migrations.AddField( + model_name='powerfeed', + name='cable_end', + field=models.CharField(blank=True, max_length=1), + ), + migrations.AddField( + model_name='poweroutlet', + name='cable_end', + field=models.CharField(blank=True, max_length=1), + ), + migrations.AddField( + model_name='powerport', + name='cable_end', + field=models.CharField(blank=True, max_length=1), + ), + migrations.AddField( + model_name='rearport', + name='cable_end', + field=models.CharField(blank=True, max_length=1), + ), + ] diff --git a/netbox/dcim/migrations/0155_populate_cable_terminations.py b/netbox/dcim/migrations/0155_populate_cable_terminations.py index c570f240b..64d0caf6c 100644 --- a/netbox/dcim/migrations/0155_populate_cable_terminations.py +++ b/netbox/dcim/migrations/0155_populate_cable_terminations.py @@ -40,7 +40,7 @@ def populate_cable_terminations(apps, schema_editor): class Migration(migrations.Migration): dependencies = [ - ('dcim', '0154_cabletermination'), + ('dcim', '0154_new_cabling_models'), ] operations = [ diff --git a/netbox/dcim/migrations/0156_cable_remove_terminations.py b/netbox/dcim/migrations/0156_cable_remove_terminations.py deleted file mode 100644 index 268224717..000000000 --- a/netbox/dcim/migrations/0156_cable_remove_terminations.py +++ /dev/null @@ -1,37 +0,0 @@ -# Generated by Django 4.0.4 on 2022-04-29 14:05 - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('dcim', '0155_populate_cable_terminations'), - ] - - operations = [ - migrations.AlterModelOptions( - name='cable', - options={'ordering': ('pk',)}, - ), - migrations.AlterUniqueTogether( - name='cable', - unique_together=set(), - ), - migrations.RemoveField( - model_name='cable', - name='termination_a_id', - ), - migrations.RemoveField( - model_name='cable', - name='termination_a_type', - ), - migrations.RemoveField( - model_name='cable', - name='termination_b_id', - ), - migrations.RemoveField( - model_name='cable', - name='termination_b_type', - ), - ] diff --git a/netbox/dcim/migrations/0158_cablepath_populate_path.py b/netbox/dcim/migrations/0156_populate_cable_paths.py similarity index 96% rename from netbox/dcim/migrations/0158_cablepath_populate_path.py rename to netbox/dcim/migrations/0156_populate_cable_paths.py index 47113513f..efc0ab514 100644 --- a/netbox/dcim/migrations/0158_cablepath_populate_path.py +++ b/netbox/dcim/migrations/0156_populate_cable_paths.py @@ -39,7 +39,7 @@ def populate_cable_paths(apps, schema_editor): class Migration(migrations.Migration): dependencies = [ - ('dcim', '0157_cablepath'), + ('dcim', '0155_populate_cable_terminations'), ] operations = [ diff --git a/netbox/dcim/migrations/0157_cablepath.py b/netbox/dcim/migrations/0157_cablepath.py deleted file mode 100644 index a40f6a10e..000000000 --- a/netbox/dcim/migrations/0157_cablepath.py +++ /dev/null @@ -1,28 +0,0 @@ -import dcim.fields -import django.contrib.postgres.fields -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('dcim', '0156_cable_remove_terminations'), - ] - - operations = [ - migrations.RenameField( - model_name='cablepath', - old_name='path', - new_name='_nodes', - ), - migrations.AddField( - model_name='cablepath', - name='path', - field=models.JSONField(default=list), - ), - migrations.AddField( - model_name='cablepath', - name='is_complete', - field=models.BooleanField(default=False), - ), - ] diff --git a/netbox/dcim/migrations/0157_populate_cable_ends.py b/netbox/dcim/migrations/0157_populate_cable_ends.py new file mode 100644 index 000000000..3bff31a1d --- /dev/null +++ b/netbox/dcim/migrations/0157_populate_cable_ends.py @@ -0,0 +1,42 @@ +from django.db import migrations + + +def populate_cable_terminations(apps, schema_editor): + Cable = apps.get_model('dcim', 'Cable') + ContentType = apps.get_model('contenttypes', 'ContentType') + + cable_termination_models = ( + apps.get_model('dcim', 'ConsolePort'), + apps.get_model('dcim', 'ConsoleServerPort'), + apps.get_model('dcim', 'PowerPort'), + apps.get_model('dcim', 'PowerOutlet'), + apps.get_model('dcim', 'Interface'), + apps.get_model('dcim', 'FrontPort'), + apps.get_model('dcim', 'RearPort'), + apps.get_model('dcim', 'PowerFeed'), + apps.get_model('circuits', 'CircuitTermination'), + ) + + for model in cable_termination_models: + ct = ContentType.objects.get_for_model(model) + model.objects.filter( + id__in=Cable.objects.filter(termination_a_type=ct).values_list('termination_a_id', flat=True) + ).update(cable_end='A') + model.objects.filter( + id__in=Cable.objects.filter(termination_b_type=ct).values_list('termination_b_id', flat=True) + ).update(cable_end='B') + + +class Migration(migrations.Migration): + + dependencies = [ + ('circuits', '0036_new_cabling_models'), + ('dcim', '0156_populate_cable_paths'), + ] + + operations = [ + migrations.RunPython( + code=populate_cable_terminations, + reverse_code=migrations.RunPython.noop + ), + ] diff --git a/netbox/dcim/migrations/0158_cabling_cleanup.py b/netbox/dcim/migrations/0158_cabling_cleanup.py new file mode 100644 index 000000000..51c4b6a42 --- /dev/null +++ b/netbox/dcim/migrations/0158_cabling_cleanup.py @@ -0,0 +1,126 @@ +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0157_populate_cable_ends'), + ] + + operations = [ + + # Remove old fields from Cable + migrations.AlterModelOptions( + name='cable', + options={'ordering': ('pk',)}, + ), + migrations.AlterUniqueTogether( + name='cable', + unique_together=set(), + ), + migrations.RemoveField( + model_name='cable', + name='termination_a_id', + ), + migrations.RemoveField( + model_name='cable', + name='termination_a_type', + ), + migrations.RemoveField( + model_name='cable', + name='termination_b_id', + ), + migrations.RemoveField( + model_name='cable', + name='termination_b_type', + ), + + # Remove old fields from CablePath + migrations.AlterUniqueTogether( + name='cablepath', + unique_together=set(), + ), + migrations.RemoveField( + model_name='cablepath', + name='destination_id', + ), + migrations.RemoveField( + model_name='cablepath', + name='destination_type', + ), + migrations.RemoveField( + model_name='cablepath', + name='origin_id', + ), + migrations.RemoveField( + model_name='cablepath', + name='origin_type', + ), + + # Remove link peer type/ID fields from cable termination models + migrations.RemoveField( + model_name='consoleport', + name='_link_peer_id', + ), + migrations.RemoveField( + model_name='consoleport', + name='_link_peer_type', + ), + migrations.RemoveField( + model_name='consoleserverport', + name='_link_peer_id', + ), + migrations.RemoveField( + model_name='consoleserverport', + name='_link_peer_type', + ), + migrations.RemoveField( + model_name='frontport', + name='_link_peer_id', + ), + migrations.RemoveField( + model_name='frontport', + name='_link_peer_type', + ), + migrations.RemoveField( + model_name='interface', + name='_link_peer_id', + ), + migrations.RemoveField( + model_name='interface', + name='_link_peer_type', + ), + migrations.RemoveField( + model_name='powerfeed', + name='_link_peer_id', + ), + migrations.RemoveField( + model_name='powerfeed', + name='_link_peer_type', + ), + migrations.RemoveField( + model_name='poweroutlet', + name='_link_peer_id', + ), + migrations.RemoveField( + model_name='poweroutlet', + name='_link_peer_type', + ), + migrations.RemoveField( + model_name='powerport', + name='_link_peer_id', + ), + migrations.RemoveField( + model_name='powerport', + name='_link_peer_type', + ), + migrations.RemoveField( + model_name='rearport', + name='_link_peer_id', + ), + migrations.RemoveField( + model_name='rearport', + name='_link_peer_type', + ), + + ] diff --git a/netbox/dcim/migrations/0159_cablepath_remove_origin_destination.py b/netbox/dcim/migrations/0159_cablepath_remove_origin_destination.py deleted file mode 100644 index 12d585bf0..000000000 --- a/netbox/dcim/migrations/0159_cablepath_remove_origin_destination.py +++ /dev/null @@ -1,33 +0,0 @@ -# Generated by Django 4.0.4 on 2022-05-03 14:50 - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('dcim', '0158_cablepath_populate_path'), - ] - - operations = [ - migrations.AlterUniqueTogether( - name='cablepath', - unique_together=set(), - ), - migrations.RemoveField( - model_name='cablepath', - name='destination_id', - ), - migrations.RemoveField( - model_name='cablepath', - name='destination_type', - ), - migrations.RemoveField( - model_name='cablepath', - name='origin_id', - ), - migrations.RemoveField( - model_name='cablepath', - name='origin_type', - ), - ] diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index a1d9d3ea9..32250b8bd 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -307,7 +307,10 @@ class CableTermination(models.Model): # Set the cable on the terminating object termination_model = self.termination._meta.model - termination_model.objects.filter(pk=self.termination_id).update(cable=self.cable) + termination_model.objects.filter(pk=self.termination_id).update( + cable=self.cable, + cable_end=self.cable_end + ) def delete(self, *args, **kwargs): diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 9bc444203..895614f32 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -1,6 +1,6 @@ from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation from django.contrib.contenttypes.models import ContentType -from django.core.exceptions import ObjectDoesNotExist, ValidationError +from django.core.exceptions import ValidationError from django.core.validators import MaxValueValidator, MinValueValidator from django.db import models from django.db.models import Sum @@ -105,12 +105,7 @@ class ModularComponentModel(ComponentModel): class LinkTermination(models.Model): """ - An abstract model inherited by all models to which a Cable, WirelessLink, or other such link can terminate. Examples - include most device components, CircuitTerminations, and PowerFeeds. The `cable` and `wireless_link` fields - reference the attached Cable or WirelessLink instance, respectively. - - `_link_peer` is a GenericForeignKey used to cache the far-end LinkTermination on the local instance; this is a - shortcut to referencing `instance.link.termination_b`, for example. + An abstract model inherited by all models to which a Cable can terminate. """ cable = models.ForeignKey( to='dcim.Cable', @@ -119,20 +114,10 @@ class LinkTermination(models.Model): blank=True, null=True ) - _link_peer_type = models.ForeignKey( - to=ContentType, - on_delete=models.SET_NULL, - related_name='+', + cable_end = models.CharField( + max_length=1, blank=True, - null=True - ) - _link_peer_id = models.PositiveBigIntegerField( - blank=True, - null=True - ) - _link_peer = GenericForeignKey( - ct_field='_link_peer_type', - fk_field='_link_peer_id' + choices=CableEndChoices ) mark_connected = models.BooleanField( default=False, @@ -145,13 +130,23 @@ class LinkTermination(models.Model): def clean(self): super().clean() + if self.cable and not self.cable_end: + raise ValidationError({ + "cable_end": "Must specify cable end (A or B) when attaching a cable." + }) + if self.mark_connected and self.cable_id: raise ValidationError({ "mark_connected": "Cannot mark as connected with a cable attached." }) - def get_link_peer(self): - return self._link_peer + @property + def link_peers(self): + # TODO: Support WirelessLinks + if not self.cable: + return [] + peer_terminations = self.cable.terminations.exclude(cable_end=self.cable_end).prefetch_related('termination') + return [ct.termination for ct in peer_terminations] @property def _occupied(self): diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 9ea8dd9f8..9d249a93e 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -132,4 +132,4 @@ def nullify_connected_endpoints(instance, **kwargs): Disassociate the Cable from the termination object. """ model = instance.termination_type.model_class() - model.objects.filter(pk=instance.termination_id).update(_link_peer_type=None, _link_peer_id=None) + model.objects.filter(pk=instance.termination_id).update(cable=None, cable_end='') diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index e3d775b23..84347c4f2 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -503,8 +503,12 @@ class CableTestCase(TestCase): """ self.interface1.refresh_from_db() self.interface2.refresh_from_db() - self.assertEqual(self.interface1._link_peer, self.interface2) - self.assertEqual(self.interface2._link_peer, self.interface1) + self.assertEqual(self.interface1.cable, self.cable) + self.assertEqual(self.interface2.cable, self.cable) + self.assertEqual(self.interface1.cable_end, 'A') + self.assertEqual(self.interface2.cable_end, 'B') + self.assertEqual(self.interface1.link_peers, [self.interface2]) + self.assertEqual(self.interface2.link_peers, [self.interface1]) def test_cable_deletion(self): """ @@ -516,10 +520,10 @@ class CableTestCase(TestCase): self.assertNotEqual(str(self.cable), '#None') interface1 = Interface.objects.get(pk=self.interface1.pk) self.assertIsNone(interface1.cable) - self.assertIsNone(interface1._link_peer) + self.assertListEqual(interface1.link_peers, []) interface2 = Interface.objects.get(pk=self.interface2.pk) self.assertIsNone(interface2.cable) - self.assertIsNone(interface2._link_peer) + self.assertListEqual(interface2.link_peers, []) def test_cable_validates_same_parent_object(self): """ diff --git a/netbox/templates/circuits/inc/circuit_termination.html b/netbox/templates/circuits/inc/circuit_termination.html index 6cfcac05c..0614dc49e 100644 --- a/netbox/templates/circuits/inc/circuit_termination.html +++ b/netbox/templates/circuits/inc/circuit_termination.html @@ -44,16 +44,15 @@ Marked as connected {% elif termination.cable %} - {{ termination.cable }} - {% with peer=termination.get_link_peer %} - to + {{ termination.cable }} to + {% for peer in termination.link_peers %} {% if peer.device %} {{ peer.device|linkify }}
      {% elif peer.circuit %} {{ peer.circuit|linkify }}
      {% endif %} - {{ peer|linkify }} - {% endwith %} + {{ peer|linkify }}{% if not forloop.last %},{% endif %} + {% endfor %}
      Trace diff --git a/netbox/wireless/signals.py b/netbox/wireless/signals.py index 015428807..ff7b1229c 100644 --- a/netbox/wireless/signals.py +++ b/netbox/wireless/signals.py @@ -25,12 +25,10 @@ def update_connected_interfaces(instance, created, raw=False, **kwargs): if instance.interface_a.wireless_link != instance: logger.debug(f"Updating interface A for wireless link {instance}") instance.interface_a.wireless_link = instance - instance.interface_a._link_peer = instance.interface_b instance.interface_a.save() if instance.interface_b.cable != instance: logger.debug(f"Updating interface B for wireless link {instance}") instance.interface_b.wireless_link = instance - instance.interface_b._link_peer = instance.interface_a instance.interface_b.save() # Create/update cable paths @@ -48,18 +46,10 @@ def nullify_connected_interfaces(instance, **kwargs): if instance.interface_a is not None: logger.debug(f"Nullifying interface A for wireless link {instance}") - Interface.objects.filter(pk=instance.interface_a.pk).update( - wireless_link=None, - _link_peer_type=None, - _link_peer_id=None - ) + Interface.objects.filter(pk=instance.interface_a.pk).update(wireless_link=None) if instance.interface_b is not None: logger.debug(f"Nullifying interface B for wireless link {instance}") - Interface.objects.filter(pk=instance.interface_b.pk).update( - wireless_link=None, - _link_peer_type=None, - _link_peer_id=None - ) + Interface.objects.filter(pk=instance.interface_b.pk).update(wireless_link=None) # Delete and retrace any dependent cable paths for cablepath in CablePath.objects.filter(_nodes__contains=instance): From cf7a0913191fa0379e4f11de9736c688c0627447 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 2 Jun 2022 08:28:27 -0400 Subject: [PATCH 089/593] Refactor SVG module --- netbox/dcim/svg/__init__.py | 2 + netbox/dcim/{svg.py => svg/cables.py} | 254 ------------------------- netbox/dcim/svg/racks.py | 263 ++++++++++++++++++++++++++ 3 files changed, 265 insertions(+), 254 deletions(-) create mode 100644 netbox/dcim/svg/__init__.py rename netbox/dcim/{svg.py => svg/cables.py} (53%) create mode 100644 netbox/dcim/svg/racks.py diff --git a/netbox/dcim/svg/__init__.py b/netbox/dcim/svg/__init__.py new file mode 100644 index 000000000..21e27d495 --- /dev/null +++ b/netbox/dcim/svg/__init__.py @@ -0,0 +1,2 @@ +from .cables import * +from .racks import * diff --git a/netbox/dcim/svg.py b/netbox/dcim/svg/cables.py similarity index 53% rename from netbox/dcim/svg.py rename to netbox/dcim/svg/cables.py index 7cd0fa417..9214f2cb8 100644 --- a/netbox/dcim/svg.py +++ b/netbox/dcim/svg/cables.py @@ -4,269 +4,15 @@ from svgwrite.shapes import Line, Rect from svgwrite.text import Text from django.conf import settings -from django.urls import reverse -from django.utils.http import urlencode from utilities.utils import foreground_color -from .choices import DeviceFaceChoices -from .constants import RACK_ELEVATION_BORDER_WIDTH __all__ = ( 'CableTraceSVG', - 'RackElevationSVG', ) -def get_device_name(device): - if device.virtual_chassis: - return f'{device.virtual_chassis.name}:{device.vc_position}' - elif device.name: - return device.name - else: - return str(device.device_type) - - -class RackElevationSVG: - """ - Use this class to render a rack elevation as an SVG image. - - :param rack: A NetBox Rack instance - :param user: User instance. If specified, only devices viewable by this user will be fully displayed. - :param include_images: If true, the SVG document will embed front/rear device face images, where available - :param base_url: Base URL for links within the SVG document. If none, links will be relative. - """ - def __init__(self, rack, user=None, include_images=True, base_url=None): - self.rack = rack - self.include_images = include_images - if base_url is not None: - self.base_url = base_url.rstrip('/') - else: - self.base_url = '' - - # Determine the subset of devices within this rack that are viewable by the user, if any - permitted_devices = self.rack.devices - if user is not None: - permitted_devices = permitted_devices.restrict(user, 'view') - self.permitted_device_ids = permitted_devices.values_list('pk', flat=True) - - @staticmethod - def _get_device_description(device): - return '{} ({}) — {} {} ({}U) {} {}'.format( - device.name, - device.device_role, - device.device_type.manufacturer.name, - device.device_type.model, - device.device_type.u_height, - device.asset_tag or '', - device.serial or '' - ) - - @staticmethod - def _add_gradient(drawing, id_, color): - gradient = drawing.linearGradient( - start=(0, 0), - end=(0, 25), - spreadMethod='repeat', - id_=id_, - gradientTransform='rotate(45, 0, 0)', - gradientUnits='userSpaceOnUse' - ) - gradient.add_stop_color(offset='0%', color='#f7f7f7') - gradient.add_stop_color(offset='50%', color='#f7f7f7') - gradient.add_stop_color(offset='50%', color=color) - gradient.add_stop_color(offset='100%', color=color) - drawing.defs.add(gradient) - - @staticmethod - def _setup_drawing(width, height): - drawing = svgwrite.Drawing(size=(width, height)) - - # add the stylesheet - with open('{}/rack_elevation.css'.format(settings.STATIC_ROOT)) as css_file: - drawing.defs.add(drawing.style(css_file.read())) - - # add gradients - RackElevationSVG._add_gradient(drawing, 'reserved', '#c7c7ff') - RackElevationSVG._add_gradient(drawing, 'occupied', '#d7d7d7') - RackElevationSVG._add_gradient(drawing, 'blocked', '#ffc0c0') - - return drawing - - def _draw_device_front(self, drawing, device, start, end, text): - name = get_device_name(device) - if device.devicebay_count: - name += ' ({}/{})'.format(device.get_children().count(), device.devicebay_count) - - color = device.device_role.color - link = drawing.add( - drawing.a( - href='{}{}'.format(self.base_url, reverse('dcim:device', kwargs={'pk': device.pk})), - target='_top', - fill='black' - ) - ) - link.set_desc(self._get_device_description(device)) - link.add(drawing.rect(start, end, style='fill: #{}'.format(color), class_='slot')) - hex_color = '#{}'.format(foreground_color(color)) - link.add(drawing.text(str(name), insert=text, fill=hex_color)) - - # Embed front device type image if one exists - if self.include_images and device.device_type.front_image: - image = drawing.image( - href=device.device_type.front_image.url, - insert=start, - size=end, - class_='device-image' - ) - image.fit(scale='slice') - link.add(image) - link.add(drawing.text(str(name), insert=text, stroke='black', - stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) - link.add(drawing.text(str(name), insert=text, fill='white', class_='device-image-label')) - - def _draw_device_rear(self, drawing, device, start, end, text): - link = drawing.add( - drawing.a( - href='{}{}'.format(self.base_url, reverse('dcim:device', kwargs={'pk': device.pk})), - target='_top', - fill='black' - ) - ) - link.set_desc(self._get_device_description(device)) - link.add(drawing.rect(start, end, class_="slot blocked")) - link.add(drawing.text(get_device_name(device), insert=text)) - - # Embed rear device type image if one exists - if self.include_images and device.device_type.rear_image: - image = drawing.image( - href=device.device_type.rear_image.url, - insert=start, - size=end, - class_='device-image' - ) - image.fit(scale='slice') - link.add(image) - link.add(drawing.text(get_device_name(device), insert=text, stroke='black', - stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) - link.add(drawing.text(get_device_name(device), insert=text, fill='white', class_='device-image-label')) - - @staticmethod - def _draw_empty(drawing, rack, start, end, text, id_, face_id, class_, reservation): - link_url = '{}?{}'.format( - reverse('dcim:device_add'), - urlencode({ - 'site': rack.site.pk, - 'location': rack.location.pk if rack.location else '', - 'rack': rack.pk, - 'face': face_id, - 'position': id_ - }) - ) - link = drawing.add( - drawing.a(href=link_url, target='_top') - ) - if reservation: - link.set_desc('{} — {} · {}'.format( - reservation.description, reservation.user, reservation.created - )) - link.add(drawing.rect(start, end, class_=class_)) - link.add(drawing.text("add device", insert=text, class_='add-device')) - - def merge_elevations(self, face): - elevation = self.rack.get_rack_units(face=face, expand_devices=False) - if face == DeviceFaceChoices.FACE_REAR: - other_face = DeviceFaceChoices.FACE_FRONT - else: - other_face = DeviceFaceChoices.FACE_REAR - other = self.rack.get_rack_units(face=other_face) - - unit_cursor = 0 - for u in elevation: - o = other[unit_cursor] - if not u['device'] and o['device'] and o['device'].device_type.is_full_depth: - u['device'] = o['device'] - u['height'] = 1 - unit_cursor += u.get('height', 1) - - return elevation - - def render(self, face, unit_width, unit_height, legend_width): - """ - Return an SVG document representing a rack elevation. - """ - drawing = self._setup_drawing( - unit_width + legend_width + RACK_ELEVATION_BORDER_WIDTH * 2, - unit_height * self.rack.u_height + RACK_ELEVATION_BORDER_WIDTH * 2 - ) - reserved_units = self.rack.get_reserved_units() - - unit_cursor = 0 - for ru in range(0, self.rack.u_height): - start_y = ru * unit_height - position_coordinates = (legend_width / 2, start_y + unit_height / 2 + RACK_ELEVATION_BORDER_WIDTH) - unit = ru + 1 if self.rack.desc_units else self.rack.u_height - ru - drawing.add( - drawing.text(str(unit), position_coordinates, class_="unit") - ) - - for unit in self.merge_elevations(face): - - # Loop through all units in the elevation - device = unit['device'] - height = unit.get('height', 1) - - # Setup drawing coordinates - x_offset = legend_width + RACK_ELEVATION_BORDER_WIDTH - y_offset = unit_cursor * unit_height + RACK_ELEVATION_BORDER_WIDTH - end_y = unit_height * height - start_cordinates = (x_offset, y_offset) - end_cordinates = (unit_width, end_y) - text_cordinates = (x_offset + (unit_width / 2), y_offset + end_y / 2) - - # Draw the device - if device and device.face == face and device.pk in self.permitted_device_ids: - self._draw_device_front(drawing, device, start_cordinates, end_cordinates, text_cordinates) - elif device and device.device_type.is_full_depth and device.pk in self.permitted_device_ids: - self._draw_device_rear(drawing, device, start_cordinates, end_cordinates, text_cordinates) - elif device: - # Devices which the user does not have permission to view are rendered only as unavailable space - drawing.add(drawing.rect(start_cordinates, end_cordinates, class_='blocked')) - else: - # Draw shallow devices, reservations, or empty units - class_ = 'slot' - reservation = reserved_units.get(unit["id"]) - if device: - class_ += ' occupied' - if reservation: - class_ += ' reserved' - self._draw_empty( - drawing, - self.rack, - start_cordinates, - end_cordinates, - text_cordinates, - unit["id"], - face, - class_, - reservation - ) - - unit_cursor += height - - # Wrap the drawing with a border - border_width = RACK_ELEVATION_BORDER_WIDTH - border_offset = RACK_ELEVATION_BORDER_WIDTH / 2 - frame = drawing.rect( - insert=(legend_width + border_offset, border_offset), - size=(unit_width + border_width, self.rack.u_height * unit_height + border_width), - class_='rack' - ) - drawing.add(frame) - - return drawing - - OFFSET = 0.5 PADDING = 10 LINE_HEIGHT = 20 diff --git a/netbox/dcim/svg/racks.py b/netbox/dcim/svg/racks.py new file mode 100644 index 000000000..841adb323 --- /dev/null +++ b/netbox/dcim/svg/racks.py @@ -0,0 +1,263 @@ +import svgwrite + +from django.conf import settings +from django.urls import reverse +from django.utils.http import urlencode + +from utilities.utils import foreground_color +from dcim.choices import DeviceFaceChoices +from dcim.constants import RACK_ELEVATION_BORDER_WIDTH + + +__all__ = ( + 'RackElevationSVG', +) + + +def get_device_name(device): + if device.virtual_chassis: + return f'{device.virtual_chassis.name}:{device.vc_position}' + elif device.name: + return device.name + else: + return str(device.device_type) + + +class RackElevationSVG: + """ + Use this class to render a rack elevation as an SVG image. + + :param rack: A NetBox Rack instance + :param user: User instance. If specified, only devices viewable by this user will be fully displayed. + :param include_images: If true, the SVG document will embed front/rear device face images, where available + :param base_url: Base URL for links within the SVG document. If none, links will be relative. + """ + def __init__(self, rack, user=None, include_images=True, base_url=None): + self.rack = rack + self.include_images = include_images + if base_url is not None: + self.base_url = base_url.rstrip('/') + else: + self.base_url = '' + + # Determine the subset of devices within this rack that are viewable by the user, if any + permitted_devices = self.rack.devices + if user is not None: + permitted_devices = permitted_devices.restrict(user, 'view') + self.permitted_device_ids = permitted_devices.values_list('pk', flat=True) + + @staticmethod + def _get_device_description(device): + return '{} ({}) — {} {} ({}U) {} {}'.format( + device.name, + device.device_role, + device.device_type.manufacturer.name, + device.device_type.model, + device.device_type.u_height, + device.asset_tag or '', + device.serial or '' + ) + + @staticmethod + def _add_gradient(drawing, id_, color): + gradient = drawing.linearGradient( + start=(0, 0), + end=(0, 25), + spreadMethod='repeat', + id_=id_, + gradientTransform='rotate(45, 0, 0)', + gradientUnits='userSpaceOnUse' + ) + gradient.add_stop_color(offset='0%', color='#f7f7f7') + gradient.add_stop_color(offset='50%', color='#f7f7f7') + gradient.add_stop_color(offset='50%', color=color) + gradient.add_stop_color(offset='100%', color=color) + drawing.defs.add(gradient) + + @staticmethod + def _setup_drawing(width, height): + drawing = svgwrite.Drawing(size=(width, height)) + + # add the stylesheet + with open('{}/rack_elevation.css'.format(settings.STATIC_ROOT)) as css_file: + drawing.defs.add(drawing.style(css_file.read())) + + # add gradients + RackElevationSVG._add_gradient(drawing, 'reserved', '#c7c7ff') + RackElevationSVG._add_gradient(drawing, 'occupied', '#d7d7d7') + RackElevationSVG._add_gradient(drawing, 'blocked', '#ffc0c0') + + return drawing + + def _draw_device_front(self, drawing, device, start, end, text): + name = get_device_name(device) + if device.devicebay_count: + name += ' ({}/{})'.format(device.get_children().count(), device.devicebay_count) + + color = device.device_role.color + link = drawing.add( + drawing.a( + href='{}{}'.format(self.base_url, reverse('dcim:device', kwargs={'pk': device.pk})), + target='_top', + fill='black' + ) + ) + link.set_desc(self._get_device_description(device)) + link.add(drawing.rect(start, end, style='fill: #{}'.format(color), class_='slot')) + hex_color = '#{}'.format(foreground_color(color)) + link.add(drawing.text(str(name), insert=text, fill=hex_color)) + + # Embed front device type image if one exists + if self.include_images and device.device_type.front_image: + image = drawing.image( + href=device.device_type.front_image.url, + insert=start, + size=end, + class_='device-image' + ) + image.fit(scale='slice') + link.add(image) + link.add(drawing.text(str(name), insert=text, stroke='black', + stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) + link.add(drawing.text(str(name), insert=text, fill='white', class_='device-image-label')) + + def _draw_device_rear(self, drawing, device, start, end, text): + link = drawing.add( + drawing.a( + href='{}{}'.format(self.base_url, reverse('dcim:device', kwargs={'pk': device.pk})), + target='_top', + fill='black' + ) + ) + link.set_desc(self._get_device_description(device)) + link.add(drawing.rect(start, end, class_="slot blocked")) + link.add(drawing.text(get_device_name(device), insert=text)) + + # Embed rear device type image if one exists + if self.include_images and device.device_type.rear_image: + image = drawing.image( + href=device.device_type.rear_image.url, + insert=start, + size=end, + class_='device-image' + ) + image.fit(scale='slice') + link.add(image) + link.add(drawing.text(get_device_name(device), insert=text, stroke='black', + stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) + link.add(drawing.text(get_device_name(device), insert=text, fill='white', class_='device-image-label')) + + @staticmethod + def _draw_empty(drawing, rack, start, end, text, id_, face_id, class_, reservation): + link_url = '{}?{}'.format( + reverse('dcim:device_add'), + urlencode({ + 'site': rack.site.pk, + 'location': rack.location.pk if rack.location else '', + 'rack': rack.pk, + 'face': face_id, + 'position': id_ + }) + ) + link = drawing.add( + drawing.a(href=link_url, target='_top') + ) + if reservation: + link.set_desc('{} — {} · {}'.format( + reservation.description, reservation.user, reservation.created + )) + link.add(drawing.rect(start, end, class_=class_)) + link.add(drawing.text("add device", insert=text, class_='add-device')) + + def merge_elevations(self, face): + elevation = self.rack.get_rack_units(face=face, expand_devices=False) + if face == DeviceFaceChoices.FACE_REAR: + other_face = DeviceFaceChoices.FACE_FRONT + else: + other_face = DeviceFaceChoices.FACE_REAR + other = self.rack.get_rack_units(face=other_face) + + unit_cursor = 0 + for u in elevation: + o = other[unit_cursor] + if not u['device'] and o['device'] and o['device'].device_type.is_full_depth: + u['device'] = o['device'] + u['height'] = 1 + unit_cursor += u.get('height', 1) + + return elevation + + def render(self, face, unit_width, unit_height, legend_width): + """ + Return an SVG document representing a rack elevation. + """ + drawing = self._setup_drawing( + unit_width + legend_width + RACK_ELEVATION_BORDER_WIDTH * 2, + unit_height * self.rack.u_height + RACK_ELEVATION_BORDER_WIDTH * 2 + ) + reserved_units = self.rack.get_reserved_units() + + unit_cursor = 0 + for ru in range(0, self.rack.u_height): + start_y = ru * unit_height + position_coordinates = (legend_width / 2, start_y + unit_height / 2 + RACK_ELEVATION_BORDER_WIDTH) + unit = ru + 1 if self.rack.desc_units else self.rack.u_height - ru + drawing.add( + drawing.text(str(unit), position_coordinates, class_="unit") + ) + + for unit in self.merge_elevations(face): + + # Loop through all units in the elevation + device = unit['device'] + height = unit.get('height', 1) + + # Setup drawing coordinates + x_offset = legend_width + RACK_ELEVATION_BORDER_WIDTH + y_offset = unit_cursor * unit_height + RACK_ELEVATION_BORDER_WIDTH + end_y = unit_height * height + start_cordinates = (x_offset, y_offset) + end_cordinates = (unit_width, end_y) + text_cordinates = (x_offset + (unit_width / 2), y_offset + end_y / 2) + + # Draw the device + if device and device.face == face and device.pk in self.permitted_device_ids: + self._draw_device_front(drawing, device, start_cordinates, end_cordinates, text_cordinates) + elif device and device.device_type.is_full_depth and device.pk in self.permitted_device_ids: + self._draw_device_rear(drawing, device, start_cordinates, end_cordinates, text_cordinates) + elif device: + # Devices which the user does not have permission to view are rendered only as unavailable space + drawing.add(drawing.rect(start_cordinates, end_cordinates, class_='blocked')) + else: + # Draw shallow devices, reservations, or empty units + class_ = 'slot' + reservation = reserved_units.get(unit["id"]) + if device: + class_ += ' occupied' + if reservation: + class_ += ' reserved' + self._draw_empty( + drawing, + self.rack, + start_cordinates, + end_cordinates, + text_cordinates, + unit["id"], + face, + class_, + reservation + ) + + unit_cursor += height + + # Wrap the drawing with a border + border_width = RACK_ELEVATION_BORDER_WIDTH + border_offset = RACK_ELEVATION_BORDER_WIDTH / 2 + frame = drawing.rect( + insert=(legend_width + border_offset, border_offset), + size=(unit_width + border_width, self.rack.u_height * unit_height + border_width), + class_='rack' + ) + drawing.add(frame) + + return drawing From bab6fb0de24d568371c8a55bcb22768b2d60f515 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 2 Jun 2022 11:07:26 -0400 Subject: [PATCH 090/593] Update SVG trace rendering to support multiple terminations per cable end --- netbox/dcim/svg/cables.py | 142 +++++++++++++++++++++----------------- 1 file changed, 77 insertions(+), 65 deletions(-) diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py index 9214f2cb8..6613e9cca 100644 --- a/netbox/dcim/svg/cables.py +++ b/netbox/dcim/svg/cables.py @@ -17,6 +17,8 @@ OFFSET = 0.5 PADDING = 10 LINE_HEIGHT = 20 +TERMINATION_WIDTH = 80 + class CableTraceSVG: """ @@ -35,6 +37,11 @@ class CableTraceSVG: # Center edges on pixels to render sharp borders self.cursor = OFFSET + # Prep elements lists + self.parent_objects = [] + self.terminations = [] + self.connectors = [] + @property def center(self): return self.width / 2 @@ -79,49 +86,75 @@ class CableTraceSVG: # Other parent object return 'e0e0e0' - def _draw_box(self, width, color, url, labels, y_indent=0, padding_multiplier=1, radius=10): + def _draw_box( + self, + x, + width, + color, + url, + labels, + reset_cursor=False, + radius=10 + ): """ Return an SVG Link element containing a Rect and one or more text labels representing a parent object or cable termination point. + :param x: X axis position :param width: Box width :param color: Box fill color :param url: Hyperlink URL :param labels: Iterable of text labels - :param y_indent: Vertical indent (for overlapping other boxes) (default: 0) - :param padding_multiplier: Add extra vertical padding (default: 1) :param radius: Box corner radius (default: 10) """ - self.cursor -= y_indent + _orig_cursor = self.cursor # Create a hyperlink link = Hyperlink(href=f'{self.base_url}{url}', target='_blank') # Add the box - position = ( - OFFSET + (self.width - width) / 2, - self.cursor - ) - height = PADDING * padding_multiplier \ + position = (x + OFFSET, self.cursor) + height = PADDING \ + LINE_HEIGHT * len(labels) \ - + PADDING * padding_multiplier + + PADDING box = Rect(position, (width - 2, height), rx=radius, class_='parent-object', style=f'fill: #{color}') link.add(box) - self.cursor += PADDING * padding_multiplier + self.cursor += PADDING # Add text label(s) for i, label in enumerate(labels): self.cursor += LINE_HEIGHT - text_coords = (self.center, self.cursor - LINE_HEIGHT / 2) + text_coords = (x + width / 2, self.cursor - LINE_HEIGHT / 2) text_color = f'#{foreground_color(color, dark="303030")}' text = Text(label, insert=text_coords, fill=text_color, class_='bold' if not i else []) link.add(text) - self.cursor += PADDING * padding_multiplier + if reset_cursor: + self.cursor = _orig_cursor + else: + self.cursor += PADDING return link - def _draw_cable(self, color, url, labels): + def draw_terminations(self, terminations): + """ + Draw a row of terminating objects (e.g. interfaces) belonging to the same parent object, all of which + are attached to the same end of a cable. + """ + x = self.width / 2 - len(terminations) * TERMINATION_WIDTH / 2 + for i, term in enumerate(terminations): + t = self._draw_box( + x=x + i * TERMINATION_WIDTH, + width=TERMINATION_WIDTH, + color=self._get_color(term), + url=term.get_absolute_url(), + labels=self._get_labels(term), + radius=5, + reset_cursor=bool(i + 1 != len(terminations)) + ) + self.terminations.append(t) + + def draw_cable(self, color, url, labels): """ Return an SVG group containing a line element and text labels representing a Cable. @@ -159,7 +192,7 @@ class CableTraceSVG: return group - def _draw_wirelesslink(self, url, labels): + def draw_wirelesslink(self, url, labels): """ Draw a line with labels representing a WirelessLink. @@ -192,7 +225,7 @@ class CableTraceSVG: return group - def _draw_attachment(self): + def draw_attachment(self): """ Return an SVG group containing a line element and "Attachment" label. """ @@ -217,40 +250,27 @@ class CableTraceSVG: traced_path = self.origin.trace() - # Prep elements list - parent_objects = [] - terminations = [] - connectors = [] - - # Iterate through each (term, cable, term) segment in the path + # Iterate through each (terms, cable, terms) segment in the path for i, segment in enumerate(traced_path): - near_end, connector, far_end = segment + near_ends, connector, far_ends = segment # Near end parent if i == 0: # If this is the first segment, draw the originating termination's parent object parent_object = self._draw_box( + x=0, width=self.width, - color=self._get_color(near_end.parent_object), - url=near_end.parent_object.get_absolute_url(), - labels=self._get_labels(near_end.parent_object), - padding_multiplier=2 + color=self._get_color(near_ends[0].parent_object), + url=near_ends[0].parent_object.get_absolute_url(), + labels=self._get_labels(near_ends[0].parent_object) ) - parent_objects.append(parent_object) + self.parent_objects.append(parent_object) # Near end termination - if near_end is not None: - termination = self._draw_box( - width=self.width * .8, - color=self._get_color(near_end), - url=near_end.get_absolute_url(), - labels=self._get_labels(near_end), - y_indent=PADDING, - radius=5 - ) - terminations.append(termination) + self.draw_terminations(near_ends) # Connector (a Cable or WirelessLink) + connector = connector[0] # Remove Cable from list if connector is not None: # Cable @@ -263,12 +283,12 @@ class CableTraceSVG: connector_labels.append(connector.get_type_display()) if connector.length and connector.length_unit: connector_labels.append(f'{connector.length} {connector.get_length_unit_display()}') - cable = self._draw_cable( + cable = self.draw_cable( color=connector.color or '000000', url=connector.get_absolute_url(), labels=connector_labels ) - connectors.append(cable) + self.connectors.append(cable) # WirelessLink elif type(connector) is WirelessLink: @@ -278,48 +298,40 @@ class CableTraceSVG: ] if connector.ssid: connector_labels.append(connector.ssid) - wirelesslink = self._draw_wirelesslink( + wirelesslink = self.draw_wirelesslink( url=connector.get_absolute_url(), labels=connector_labels ) - connectors.append(wirelesslink) + self.connectors.append(wirelesslink) # Far end termination - termination = self._draw_box( - width=self.width * .8, - color=self._get_color(far_end), - url=far_end.get_absolute_url(), - labels=self._get_labels(far_end), - radius=5 - ) - terminations.append(termination) + self.draw_terminations(far_ends) # Far end parent parent_object = self._draw_box( + x=0, width=self.width, - color=self._get_color(far_end.parent_object), - url=far_end.parent_object.get_absolute_url(), - labels=self._get_labels(far_end.parent_object), - y_indent=PADDING, - padding_multiplier=2 + color=self._get_color(far_ends[0].parent_object), + url=far_ends[0].parent_object.get_absolute_url(), + labels=self._get_labels(far_ends[0].parent_object), ) - parent_objects.append(parent_object) + self.parent_objects.append(parent_object) - elif far_end: + elif far_ends: # Attachment - attachment = self._draw_attachment() - connectors.append(attachment) + attachment = self.draw_attachment() + self.connectors.append(attachment) # ProviderNetwork parent_object = self._draw_box( + x=0, width=self.width, - color=self._get_color(far_end), - url=far_end.get_absolute_url(), - labels=self._get_labels(far_end), - padding_multiplier=2 + color=self._get_color(far_ends[0]), + url=far_ends[0].get_absolute_url(), + labels=self._get_labels(far_ends[0]) ) - parent_objects.append(parent_object) + self.parent_objects.append(parent_object) # Determine drawing size self.drawing = svgwrite.Drawing( @@ -331,7 +343,7 @@ class CableTraceSVG: self.drawing.defs.add(self.drawing.style(css_file.read())) # Add elements to the drawing in order of depth (Z axis) - for element in connectors + parent_objects + terminations: + for element in self.connectors + self.parent_objects + self.terminations: self.drawing.add(element) return self.drawing From 537383e0713645564ba2949e37dc2cbf41eb3317 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 2 Jun 2022 12:40:31 -0400 Subject: [PATCH 091/593] Add cable topology tests --- netbox/dcim/tests/test_cablepaths.py | 406 ++++++++++++++++++++++----- 1 file changed, 328 insertions(+), 78 deletions(-) diff --git a/netbox/dcim/tests/test_cablepaths.py b/netbox/dcim/tests/test_cablepaths.py index 9f0b1a43c..a810f3975 100644 --- a/netbox/dcim/tests/test_cablepaths.py +++ b/netbox/dcim/tests/test_cablepaths.py @@ -370,7 +370,65 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface1, path1) self.assertPathIsNotSet(interface2) - def test_202_multiple_paths_via_pass_through(self): + def test_202_single_path_via_pass_through_with_breakouts(self): + """ + [IF1] --C1-- [FP1] [RP1] --C2-- [IF3] + [IF2] [IF4] + """ + interface1 = Interface.objects.create(device=self.device, name='Interface 1') + interface2 = Interface.objects.create(device=self.device, name='Interface 2') + interface3 = Interface.objects.create(device=self.device, name='Interface 3') + interface4 = Interface.objects.create(device=self.device, name='Interface 4') + rearport1 = RearPort.objects.create(device=self.device, name='Rear Port 1', positions=1) + frontport1 = FrontPort.objects.create( + device=self.device, name='Front Port 1', rear_port=rearport1, rear_port_position=1 + ) + + # Create cable 1 + cable1 = Cable( + a_terminations=[interface1, interface2], + b_terminations=[frontport1] + ) + cable1.save() + self.assertPathExists( + ([interface1, interface2], cable1, frontport1, rearport1), + is_complete=False + ) + self.assertEqual(CablePath.objects.count(), 1) + + # Create cable 2 + cable2 = Cable( + a_terminations=[rearport1], + b_terminations=[interface3, interface4] + ) + cable2.save() + self.assertPathExists( + ([interface1, interface2], cable1, frontport1, rearport1, cable2, [interface3, interface4]), + is_complete=True, + is_active=True + ) + self.assertPathExists( + ([interface3, interface4], cable2, rearport1, frontport1, cable1, [interface1, interface2]), + is_complete=True, + is_active=True + ) + self.assertEqual(CablePath.objects.count(), 2) + + # Delete cable 2 + cable2.delete() + path1 = self.assertPathExists( + ([interface1, interface2], cable1, frontport1, rearport1), + is_complete=False + ) + self.assertEqual(CablePath.objects.count(), 1) + interface1.refresh_from_db() + interface2.refresh_from_db() + self.assertPathIsSet(interface1, path1) + self.assertPathIsSet(interface2, path1) + self.assertPathIsNotSet(interface3) + self.assertPathIsNotSet(interface4) + + def test_203_multiple_paths_via_pass_through(self): """ [IF1] --C1-- [FP1:1] [RP1] --C3-- [RP2] [FP2:1] --C4-- [IF3] [IF2] --C2-- [FP1:2] [FP2:2] --C5-- [IF4] @@ -479,7 +537,130 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface3, path3) self.assertPathIsSet(interface4, path4) - def test_203_multiple_paths_via_nested_pass_throughs(self): + def test_204_multiple_paths_via_pass_through_with_breakouts(self): + """ + [IF1] --C1-- [FP1:1] [RP1] --C3-- [RP2] [FP2:1] --C4-- [IF4] + [IF2] [IF5] + [IF3] --C2-- [FP1:2] [FP2:2] --C5-- [IF6] + [IF4] [IF7] + """ + interface1 = Interface.objects.create(device=self.device, name='Interface 1') + interface2 = Interface.objects.create(device=self.device, name='Interface 2') + interface3 = Interface.objects.create(device=self.device, name='Interface 3') + interface4 = Interface.objects.create(device=self.device, name='Interface 4') + interface5 = Interface.objects.create(device=self.device, name='Interface 5') + interface6 = Interface.objects.create(device=self.device, name='Interface 6') + interface7 = Interface.objects.create(device=self.device, name='Interface 7') + interface8 = Interface.objects.create(device=self.device, name='Interface 8') + rearport1 = RearPort.objects.create(device=self.device, name='Rear Port 1', positions=4) + rearport2 = RearPort.objects.create(device=self.device, name='Rear Port 2', positions=4) + frontport1_1 = FrontPort.objects.create( + device=self.device, name='Front Port 1:1', rear_port=rearport1, rear_port_position=1 + ) + frontport1_2 = FrontPort.objects.create( + device=self.device, name='Front Port 1:2', rear_port=rearport1, rear_port_position=2 + ) + frontport2_1 = FrontPort.objects.create( + device=self.device, name='Front Port 2:1', rear_port=rearport2, rear_port_position=1 + ) + frontport2_2 = FrontPort.objects.create( + device=self.device, name='Front Port 2:2', rear_port=rearport2, rear_port_position=2 + ) + + # Create cables 1-2 + cable1 = Cable( + a_terminations=[interface1, interface2], + b_terminations=[frontport1_1] + ) + cable1.save() + cable2 = Cable( + a_terminations=[interface3, interface4], + b_terminations=[frontport1_2] + ) + cable2.save() + self.assertPathExists( + ([interface1, interface2], cable1, frontport1_1, rearport1), + is_complete=False + ) + self.assertPathExists( + ([interface3, interface4], cable2, frontport1_2, rearport1), + is_complete=False + ) + self.assertEqual(CablePath.objects.count(), 2) + + # Create cable 3 + cable3 = Cable( + a_terminations=[rearport1], + b_terminations=[rearport2] + ) + cable3.save() + self.assertPathExists( + ([interface1, interface2], cable1, frontport1_1, rearport1, cable3, rearport2, frontport2_1), + is_complete=False + ) + self.assertPathExists( + ([interface3, interface4], cable2, frontport1_2, rearport1, cable3, rearport2, frontport2_2), + is_complete=False + ) + self.assertEqual(CablePath.objects.count(), 2) + + # Create cables 4-5 + cable4 = Cable( + a_terminations=[frontport2_1], + b_terminations=[interface5, interface6] + ) + cable4.save() + cable5 = Cable( + a_terminations=[frontport2_2], + b_terminations=[interface7, interface8] + ) + cable5.save() + path1 = self.assertPathExists( + ([interface1, interface2], cable1, frontport1_1, rearport1, cable3, rearport2, frontport2_1, cable4, [interface5, interface6]), + is_complete=True, + is_active=True + ) + path2 = self.assertPathExists( + ([interface3, interface4], cable2, frontport1_2, rearport1, cable3, rearport2, frontport2_2, cable5, [interface7, interface8]), + is_complete=True, + is_active=True + ) + path3 = self.assertPathExists( + ([interface5, interface6], cable4, frontport2_1, rearport2, cable3, rearport1, frontport1_1, cable1, [interface1, interface2]), + is_complete=True, + is_active=True + ) + path4 = self.assertPathExists( + ([interface7, interface8], cable5, frontport2_2, rearport2, cable3, rearport1, frontport1_2, cable2, [interface3, interface4]), + is_complete=True, + is_active=True + ) + self.assertEqual(CablePath.objects.count(), 4) + + # Delete cable 3 + cable3.delete() + + # Check for four partial paths; one from each interface + self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 4) + self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) + interface1.refresh_from_db() + interface2.refresh_from_db() + interface3.refresh_from_db() + interface4.refresh_from_db() + interface5.refresh_from_db() + interface6.refresh_from_db() + interface7.refresh_from_db() + interface8.refresh_from_db() + self.assertPathIsSet(interface1, path1) + self.assertPathIsSet(interface2, path1) + self.assertPathIsSet(interface3, path2) + self.assertPathIsSet(interface4, path2) + self.assertPathIsSet(interface5, path3) + self.assertPathIsSet(interface6, path3) + self.assertPathIsSet(interface7, path4) + self.assertPathIsSet(interface8, path4) + + def test_205_multiple_paths_via_nested_pass_throughs(self): """ [IF1] --C1-- [FP1:1] [RP1] --C3-- [FP2] [RP2] --C4-- [RP3] [FP3] --C5-- [RP4] [FP4:1] --C6-- [IF3] [IF2] --C2-- [FP1:2] [FP4:2] --C7-- [IF4] @@ -594,7 +775,7 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 4) self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) - def test_204_multiple_paths_via_multiple_pass_throughs(self): + def test_206_multiple_paths_via_multiple_pass_throughs(self): """ [IF1] --C1-- [FP1:1] [RP1] --C3-- [RP2] [FP2:1] --C4-- [FP3:1] [RP3] --C6-- [RP4] [FP4:1] --C7-- [IF3] [IF2] --C2-- [FP1:2] [FP2:1] --C5-- [FP3:1] [FP4:2] --C8-- [IF4] @@ -721,7 +902,7 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 2) self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 2) - def test_205_multiple_paths_via_patched_pass_throughs(self): + def test_207_multiple_paths_via_patched_pass_throughs(self): """ [IF1] --C1-- [FP1:1] [RP1] --C3-- [FP2] [RP2] --C4-- [RP3] [FP3:1] --C5-- [IF3] [IF2] --C2-- [FP1:2] [FP3:2] --C6-- [IF4] @@ -824,7 +1005,7 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 4) self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) - def test_206_unidirectional_split_paths(self): + def test_208_unidirectional_split_paths(self): """ [IF1] --C1-- [RP1] [FP1:1] --C2-- [IF2] [FP1:2] --C3-- [IF3] @@ -890,7 +1071,7 @@ class CablePathTestCase(TestCase): ) self.assertEqual(CablePath.objects.count(), 2) - def test_207_rearport_without_frontport(self): + def test_209_rearport_without_frontport(self): """ [IF1] --C1-- [FP1] [RP1] --C2-- [RP2] """ @@ -918,7 +1099,7 @@ class CablePathTestCase(TestCase): ) self.assertEqual(CablePath.objects.count(), 1) - def test_208_circuittermination(self): + def test_210_interface_to_circuittermination(self): """ [IF1] --C1-- [CT1] """ @@ -945,7 +1126,7 @@ class CablePathTestCase(TestCase): interface1.refresh_from_db() self.assertPathIsNotSet(interface1) - def test_209_circuit_to_interface(self): + def test_211_interface_to_interface_via_circuit(self): """ [IF1] --C1-- [CT1] [CT2] --C2-- [IF2] """ @@ -1007,7 +1188,76 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface1, path1) self.assertPathIsNotSet(interface2) - def test_210_circuit_to_site(self): + def test_212_interface_to_interface_via_circuit_with_breakouts(self): + """ + [IF1] --C1-- [CT1] [CT2] --C2-- [IF3] + [IF2] [IF4] + """ + interface1 = Interface.objects.create(device=self.device, name='Interface 1') + interface2 = Interface.objects.create(device=self.device, name='Interface 2') + interface3 = Interface.objects.create(device=self.device, name='Interface 3') + interface4 = Interface.objects.create(device=self.device, name='Interface 4') + circuittermination1 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='A') + + # Create cable 1 + cable1 = Cable( + a_terminations=[interface1, interface2], + b_terminations=[circuittermination1] + ) + cable1.save() + + # Check for partial path from interface1 + self.assertPathExists( + ([interface1, interface2], cable1, circuittermination1), + is_complete=False + ) + + # Create CT2 + circuittermination2 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='Z') + + # Check for partial path to site + self.assertPathExists( + ([interface1, interface2], cable1, circuittermination1, circuittermination2, self.site), + is_active=True + ) + + # Create cable 2 + cable2 = Cable( + a_terminations=[circuittermination2], + b_terminations=[interface3, interface4] + ) + cable2.save() + + # Check for complete path in each direction + self.assertPathExists( + ([interface1, interface2], cable1, circuittermination1, circuittermination2, cable2, [interface3, interface4]), + is_complete=True, + is_active=True + ) + self.assertPathExists( + ([interface3, interface4], cable2, circuittermination2, circuittermination1, cable1, [interface1, interface2]), + is_complete=True, + is_active=True + ) + self.assertEqual(CablePath.objects.count(), 2) + + # Delete cable 2 + cable2.delete() + path1 = self.assertPathExists( + ([interface1, interface2], cable1, circuittermination1, circuittermination2, self.site), + is_active=True + ) + self.assertEqual(CablePath.objects.count(), 1) + interface1.refresh_from_db() + interface2.refresh_from_db() + interface3.refresh_from_db() + interface4.refresh_from_db() + self.assertPathIsSet(interface1, path1) + self.assertPathIsSet(interface2, path1) + self.assertPathIsNotSet(interface3) + self.assertPathIsNotSet(interface4) + + def test_213_interface_to_site_via_circuit(self): """ [IF1] --C1-- [CT1] [CT2] --> [Site2] """ @@ -1034,7 +1284,7 @@ class CablePathTestCase(TestCase): interface1.refresh_from_db() self.assertPathIsNotSet(interface1) - def test_211_circuit_to_providernetwork(self): + def test_214_interface_to_providernetwork_via_circuit(self): """ [IF1] --C1-- [CT1] [CT2] --> [PN1] """ @@ -1061,7 +1311,7 @@ class CablePathTestCase(TestCase): interface1.refresh_from_db() self.assertPathIsNotSet(interface1) - def test_212_multiple_paths_via_circuit(self): + def test_215_multiple_paths_via_circuit(self): """ [IF1] --C1-- [FP1:1] [RP1] --C3-- [CT1] [CT2] --C4-- [RP2] [FP2:1] --C5-- [IF3] [IF2] --C2-- [FP1:2] [FP2:2] --C6-- [IF4] @@ -1160,7 +1410,71 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.filter(is_complete=False).count(), 4) self.assertEqual(CablePath.objects.filter(is_complete=True).count(), 0) - def test_250_interface_to_interface_via_rear_ports(self): + def test_216_interface_to_interface_via_multiple_circuits(self): + """ + [IF1] --C1-- [CT1] [CT2] --C2-- [CT3] [CT4] --C3-- [IF2] + """ + interface1 = Interface.objects.create(device=self.device, name='Interface 1') + interface2 = Interface.objects.create(device=self.device, name='Interface 2') + circuit2 = Circuit.objects.create(provider=self.circuit.provider, type=self.circuit.type, cid='Circuit 2') + circuittermination1 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='A') + circuittermination2 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='Z') + circuittermination3 = CircuitTermination.objects.create(circuit=circuit2, site=self.site, term_side='A') + circuittermination4 = CircuitTermination.objects.create(circuit=circuit2, site=self.site, term_side='Z') + + # Create cables + cable1 = Cable( + a_terminations=[interface1], + b_terminations=[circuittermination1] + ) + cable1.save() + cable2 = Cable( + a_terminations=[circuittermination2], + b_terminations=[circuittermination3] + ) + cable2.save() + cable3 = Cable( + a_terminations=[circuittermination4], + b_terminations=[interface2] + ) + cable3.save() + + # Check for paths + self.assertPathExists( + ( + interface1, cable1, circuittermination1, circuittermination2, cable2, circuittermination3, + circuittermination4, cable3, interface2, + ), + is_complete=True, + is_active=True + ) + self.assertPathExists( + ( + interface2, cable3, circuittermination4, circuittermination3, cable2, circuittermination2, + circuittermination1, cable1, interface1, + ), + is_complete=True, + is_active=True + ) + self.assertEqual(CablePath.objects.count(), 2) + + # Delete cable 2 + cable2.delete() + path1 = self.assertPathExists( + (interface1, cable1, circuittermination1, circuittermination2, self.site), + is_active=True + ) + path2 = self.assertPathExists( + (interface2, cable3, circuittermination4, circuittermination3, self.site), + is_active=True + ) + self.assertEqual(CablePath.objects.count(), 2) + interface1.refresh_from_db() + interface2.refresh_from_db() + self.assertPathIsSet(interface1, path1) + self.assertPathIsSet(interface2, path2) + + def test_217_interface_to_interface_via_rear_ports(self): """ [IF1] --C1-- [FP1] [RP1] --C2-- [RP3] [FP3] --C3-- [IF2] [FP2] [RP2] [RP4] [FP4] @@ -1238,7 +1552,7 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface1, path1) self.assertPathIsSet(interface2, path2) - def test_251_interfaces_to_interfaces_via_multiposition_rear_ports(self): + def test_218_interfaces_to_interfaces_via_multiposition_rear_ports(self): """ [IF1] --C1-- [FP1:1] [RP1] --C3-- [RP2] [FP2:1] --C4-- [IF3] [FP1:2] [FP2:2] @@ -1361,73 +1675,9 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface3, path3) self.assertPathIsSet(interface4, path4) - def test_213_multiple_circuits_to_interface(self): - """ - [IF1] --C1-- [CT1] [CT2] --C2-- [CT3] [CT4] --C3-- [IF2] - """ - interface1 = Interface.objects.create(device=self.device, name='Interface 1') - interface2 = Interface.objects.create(device=self.device, name='Interface 2') - circuit2 = Circuit.objects.create(provider=self.circuit.provider, type=self.circuit.type, cid='Circuit 2') - circuittermination1 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='A') - circuittermination2 = CircuitTermination.objects.create(circuit=self.circuit, site=self.site, term_side='Z') - circuittermination3 = CircuitTermination.objects.create(circuit=circuit2, site=self.site, term_side='A') - circuittermination4 = CircuitTermination.objects.create(circuit=circuit2, site=self.site, term_side='Z') - - # Create cables - cable1 = Cable( - a_terminations=[interface1], - b_terminations=[circuittermination1] - ) - cable1.save() - cable2 = Cable( - a_terminations=[circuittermination2], - b_terminations=[circuittermination3] - ) - cable2.save() - cable3 = Cable( - a_terminations=[circuittermination4], - b_terminations=[interface2] - ) - cable3.save() - - # Check for paths - self.assertPathExists( - ( - interface1, cable1, circuittermination1, circuittermination2, cable2, circuittermination3, - circuittermination4, cable3, interface2, - ), - is_complete=True, - is_active=True - ) - self.assertPathExists( - ( - interface2, cable3, circuittermination4, circuittermination3, cable2, circuittermination2, - circuittermination1, cable1, interface1, - ), - is_complete=True, - is_active=True - ) - self.assertEqual(CablePath.objects.count(), 2) - - # Delete cable 2 - cable2.delete() - path1 = self.assertPathExists( - (interface1, cable1, circuittermination1, circuittermination2, self.site), - is_active=True - ) - path2 = self.assertPathExists( - (interface2, cable3, circuittermination4, circuittermination3, self.site), - is_active=True - ) - self.assertEqual(CablePath.objects.count(), 2) - interface1.refresh_from_db() - interface2.refresh_from_db() - self.assertPathIsSet(interface1, path1) - self.assertPathIsSet(interface2, path2) - def test_301_create_path_via_existing_cable(self): """ - [IF1] --C1-- [FP1] [RP2] --C2-- [RP2] [FP2] --C3-- [IF2] + [IF1] --C1-- [FP1] [RP1] --C2-- [RP2] [FP2] --C3-- [IF2] """ interface1 = Interface.objects.create(device=self.device, name='Interface 1') interface2 = Interface.objects.create(device=self.device, name='Interface 2') From e2eb7fdfb5283e859c7d0ba5960858cf5bfe7629 Mon Sep 17 00:00:00 2001 From: kkthxbye <> Date: Fri, 3 Jun 2022 13:03:58 +0200 Subject: [PATCH 092/593] Clear webhook queue on script failure --- netbox/extras/management/commands/runscript.py | 5 +++-- netbox/extras/scripts.py | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/netbox/extras/management/commands/runscript.py b/netbox/extras/management/commands/runscript.py index 12188619f..2296ce1ff 100644 --- a/netbox/extras/management/commands/runscript.py +++ b/netbox/extras/management/commands/runscript.py @@ -14,6 +14,7 @@ from extras.choices import JobResultStatusChoices from extras.context_managers import change_logging from extras.models import JobResult from extras.scripts import get_script +from extras.signals import clear_webhooks from utilities.exceptions import AbortTransaction from utilities.utils import NetBoxFakeRequest @@ -49,7 +50,7 @@ class Command(BaseCommand): except AbortTransaction: script.log_info("Database changes have been reverted automatically.") - + clear_webhooks.send(request) except Exception as e: stacktrace = traceback.format_exc() script.log_failure( @@ -58,7 +59,7 @@ class Command(BaseCommand): script.log_info("Database changes have been reverted due to error.") logger.error(f"Exception raised during script execution: {e}") job_result.set_status(JobResultStatusChoices.STATUS_ERRORED) - + clear_webhooks.send(request) finally: job_result.data = ScriptOutputSerializer(script).data job_result.save() diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py index 4332d72f7..e36cbb5a8 100644 --- a/netbox/extras/scripts.py +++ b/netbox/extras/scripts.py @@ -17,6 +17,7 @@ from django.utils.functional import classproperty from extras.api.serializers import ScriptOutputSerializer from extras.choices import JobResultStatusChoices, LogLevelChoices +from extras.signals import clear_webhooks from ipam.formfields import IPAddressFormField, IPNetworkFormField from ipam.validators import MaxPrefixLengthValidator, MinPrefixLengthValidator, prefix_validator from utilities.exceptions import AbortTransaction @@ -458,7 +459,7 @@ def run_script(data, request, commit=True, *args, **kwargs): except AbortTransaction: script.log_info("Database changes have been reverted automatically.") - + clear_webhooks.send(request) except Exception as e: stacktrace = traceback.format_exc() script.log_failure( @@ -467,7 +468,7 @@ def run_script(data, request, commit=True, *args, **kwargs): script.log_info("Database changes have been reverted due to error.") logger.error(f"Exception raised during script execution: {e}") job_result.set_status(JobResultStatusChoices.STATUS_ERRORED) - + clear_webhooks.send(request) finally: job_result.data = ScriptOutputSerializer(script).data job_result.save() From 0b0a646f872d3aff41e7c56212e8746f0de21f8f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 3 Jun 2022 14:15:28 -0400 Subject: [PATCH 093/593] Clean up cable termination changes --- netbox/dcim/forms/connections.py | 4 +-- netbox/dcim/models/cables.py | 2 +- netbox/dcim/signals.py | 39 ++++++++++------------------ netbox/dcim/tests/test_cablepaths.py | 1 + 4 files changed, 17 insertions(+), 29 deletions(-) diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index d39288bd5..f7bfa6431 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -83,7 +83,7 @@ def get_cable_form(a_type, b_type): label=term_cls._meta.verbose_name.title(), disabled_indicator='_occupied', query_params={ - 'device_id': f'termination_{cable_end}_device', + 'device_id': f'$termination_{cable_end}_device', } ) @@ -107,7 +107,7 @@ def get_cable_form(a_type, b_type): label='Power Feed', disabled_indicator='_occupied', query_params={ - 'powerpanel_id': f'termination_{cable_end}_powerpanel', + 'powerpanel_id': f'$termination_{cable_end}_powerpanel', } ) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 32250b8bd..55b1512d0 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -316,7 +316,7 @@ class CableTermination(models.Model): # Delete the cable association on the terminating object termination_model = self.termination._meta.model - termination_model.objects.filter(pk=self.termination_id).update(cable=None) + termination_model.objects.filter(pk=self.termination_id).update(cable=None, cable_end='', _path=None) super().delete(*args, **kwargs) diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 9d249a93e..cb6b32de3 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -71,22 +71,23 @@ def clear_virtualchassis_members(instance, **kwargs): @receiver(trace_paths, sender=Cable) def update_connected_endpoints(instance, created, raw=False, **kwargs): """ - When a Cable is saved, check for and update its two connected endpoints + When a Cable is saved with new terminations, retrace any affected cable paths. """ logger = logging.getLogger('netbox.dcim.cable') if raw: logger.debug(f"Skipping endpoint updates for imported cable {instance}") return - # TODO: Update link peers - - # Create/update cable paths - if created: - _terms = { - 'A': [t.termination for t in instance.terminations.filter(cable_end='A')], - 'B': [t.termination for t in instance.terminations.filter(cable_end='B')], - } - for nodes in _terms.values(): + # Update cable paths if new terminations have been set + if hasattr(instance, 'a_terminations') or hasattr(instance, 'b_terminations'): + a_terminations = [] + b_terminations = [] + for t in instance.terminations.all(): + if t.cable_end == 'A': + a_terminations.append(t.termination) + else: + b_terminations.append(t.termination) + for nodes in [a_terminations, b_terminations]: # Examine type of first termination to determine object type (all must be the same) if not nodes: continue @@ -94,29 +95,15 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): create_cablepath(nodes) else: rebuild_paths(nodes) + + # Update status of CablePaths if Cable status has been changed elif instance.status != instance._orig_status: - # We currently don't support modifying either termination of an existing Cable. (This - # may change in the future.) However, we do need to capture status changes and update - # any CablePaths accordingly. if instance.status != LinkStatusChoices.STATUS_CONNECTED: CablePath.objects.filter(_nodes__contains=instance).update(is_active=False) else: rebuild_paths([instance]) -# @receiver(post_save, sender=CableTermination) -# def cache_cable_on_endpoints(instance, created, raw=False, **kwargs): -# if not raw: -# model = instance.termination_type.model_class() -# model.objects.filter(pk=instance.termination_id).update(cable=instance.cable) -# -# -# @receiver(post_delete, sender=CableTermination) -# def clear_cable_on_endpoints(instance, **kwargs): -# model = instance.termination_type.model_class() -# model.objects.filter(pk=instance.termination_id).update(cable=None) - - @receiver(post_delete, sender=Cable) def retrace_cable_paths(instance, **kwargs): """ diff --git a/netbox/dcim/tests/test_cablepaths.py b/netbox/dcim/tests/test_cablepaths.py index a810f3975..6d158bb10 100644 --- a/netbox/dcim/tests/test_cablepaths.py +++ b/netbox/dcim/tests/test_cablepaths.py @@ -1754,6 +1754,7 @@ class CablePathTestCase(TestCase): self.assertEqual(CablePath.objects.count(), 2) # Change cable 2's status to "planned" + cable2 = Cable.objects.get(pk=cable2.pk) # Rebuild object to ditch A/B terminations set earlier cable2.status = LinkStatusChoices.STATUS_PLANNED cable2.save() self.assertPathExists( From bb2d21abdd552e028392f685a0f0d68710d2961f Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Sun, 5 Jun 2022 10:31:21 +0200 Subject: [PATCH 094/593] Make the Service and ServiceTemplate tables sortable by ports --- netbox/ipam/tables/services.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/netbox/ipam/tables/services.py b/netbox/ipam/tables/services.py index 8c81a28c2..58d0a9aff 100644 --- a/netbox/ipam/tables/services.py +++ b/netbox/ipam/tables/services.py @@ -14,7 +14,8 @@ class ServiceTemplateTable(NetBoxTable): linkify=True ) ports = tables.Column( - accessor=tables.A('port_list') + accessor=tables.A('port_list'), + order_by=tables.A('ports'), ) tags = columns.TagColumn( url_name='ipam:servicetemplate_list' @@ -35,7 +36,8 @@ class ServiceTable(NetBoxTable): order_by=('device', 'virtual_machine') ) ports = tables.Column( - accessor=tables.A('port_list') + accessor=tables.A('port_list'), + order_by=tables.A('ports'), ) tags = columns.TagColumn( url_name='ipam:service_list' From 9f4e565b8e1c25ab142305700bbc1d4254d727f2 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Mon, 6 Jun 2022 16:28:33 +0200 Subject: [PATCH 095/593] List services listening on all IPs in IPAddressView --- netbox/ipam/views.py | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 84f6db6d5..a01f2d052 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -7,12 +7,12 @@ from django.urls import reverse from circuits.models import Provider, Circuit from circuits.tables import ProviderTable from dcim.filtersets import InterfaceFilterSet -from dcim.models import Interface, Site +from dcim.models import Interface, Site, Device from dcim.tables import SiteTable from netbox.views import generic from utilities.utils import count_related from virtualization.filtersets import VMInterfaceFilterSet -from virtualization.models import VMInterface +from virtualization.models import VMInterface, VirtualMachine from . import filtersets, forms, tables from .constants import * from .models import * @@ -676,7 +676,19 @@ class IPAddressView(generic.ObjectView): related_ips_table = tables.IPAddressTable(related_ips, orderable=False) related_ips_table.configure(request) - services = Service.objects.restrict(request.user, 'view').filter(ipaddresses=instance) + # Find services belonging to the IP + service_filter = Q(ipaddresses=instance) + + # Find services listening on all IPs on the assigned device/vm + if instance.assigned_object and instance.assigned_object.parent_object: + parent_object = instance.assigned_object.parent_object + + if isinstance(parent_object, VirtualMachine): + service_filter |= (Q(virtual_machine=parent_object) & Q(ipaddresses=None)) + elif isinstance(parent_object, Device): + service_filter |= (Q(device=parent_object) & Q(ipaddresses=None)) + + services = Service.objects.restrict(request.user, 'view').filter(service_filter) return { 'parent_prefixes_table': parent_prefixes_table, From 15080aad6662e63846e1fe9c0e9fc42b95ee4d58 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 7 Jun 2022 08:51:53 -0400 Subject: [PATCH 096/593] Changelog for #9480, #9484 --- docs/release-notes/version-3.2.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index ea5e580b8..baab085ce 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,6 +2,11 @@ ## v3.2.5 (FUTURE) +### Bug Fixes + +* [#9480](https://github.com/netbox-community/netbox/issues/9480) - Fix sorting services & service templates by port numbers +* [#9484](https://github.com/netbox-community/netbox/issues/9484) - Include services listening on "all IPs" under IP address view + --- ## v3.2.4 (2022-05-31) From 1b8350fe48323c2e5961e1b2add65948b54094b6 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 7 Jun 2022 09:59:59 -0400 Subject: [PATCH 097/593] Add warning against bumping stale issues --- .github/workflows/stale.yml | 5 ++++- CONTRIBUTING.md | 6 +++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 7390ec1df..57666417a 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -27,7 +27,10 @@ jobs: This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened - issues may receive direct feedback. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md). + issues may receive direct feedback. **Do not** attempt to circumvent this + process by "bumping" the issue; doing so will result in its immediate closure + and you may be barred from participating in any future discussions. Please see + our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md). stale-pr-label: 'pending closure' stale-pr-message: > This PR has been automatically marked as stale because it has not had diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c01adf4c9..1b4733cbe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -160,9 +160,9 @@ to aid in issue management. It is natural that some new issues get more attention than others. The stale bot helps bring renewed attention to potentially valuable issues that may have -been overlooked. **Do not** comment on an issue that has been marked stale in -an effort to circumvent the bot: Doing so will not remove the stale label. -(Stale labels can be removed only by maintainers.) +been overlooked. **Do not** comment on a stale issue merely to "bump" it in an +effort to circumvent the bot: This will result in the immediate closure of the +issue, and you may be barred from participating in future discussions. ## Maintainer Guidance From 6ed2dbf17288a5e5939c7156189c34a730cb912c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 7 Jun 2022 10:06:19 -0400 Subject: [PATCH 098/593] Fixes #9486: Fix redirect URL when adding device components from the module view --- docs/release-notes/version-3.2.md | 1 + netbox/templates/dcim/module.html | 14 +++++++------- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index baab085ce..3ffc33e71 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -6,6 +6,7 @@ * [#9480](https://github.com/netbox-community/netbox/issues/9480) - Fix sorting services & service templates by port numbers * [#9484](https://github.com/netbox-community/netbox/issues/9484) - Include services listening on "all IPs" under IP address view +* [#9486](https://github.com/netbox-community/netbox/issues/9486) - Fix redirect URL when adding device components from the module view --- diff --git a/netbox/templates/dcim/module.html b/netbox/templates/dcim/module.html index 130cd046f..f2dac38f2 100644 --- a/netbox/templates/dcim/module.html +++ b/netbox/templates/dcim/module.html @@ -18,25 +18,25 @@
      From 8a4c808be5d99447e7bafbbdbf54001a188f881d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 7 Jun 2022 11:00:14 -0400 Subject: [PATCH 099/593] Closes #8882: Support filtering IP addresses by multiple parent prefixes --- docs/release-notes/version-3.2.md | 4 ++++ netbox/ipam/filtersets.py | 16 +++++++++------- netbox/ipam/tests/test_filtersets.py | 6 ++---- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 3ffc33e71..4534c35c1 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,6 +2,10 @@ ## v3.2.5 (FUTURE) +### Enhancements + +* [#8882](https://github.com/netbox-community/netbox/issues/8882) - Support filtering IP addresses by multiple parent prefixes + ### Bug Fixes * [#9480](https://github.com/netbox-community/netbox/issues/9480) - Fix sorting services & service templates by port numbers diff --git a/netbox/ipam/filtersets.py b/netbox/ipam/filtersets.py index a445022ca..d9cf6eefc 100644 --- a/netbox/ipam/filtersets.py +++ b/netbox/ipam/filtersets.py @@ -464,7 +464,7 @@ class IPAddressFilterSet(NetBoxModelFilterSet, TenancyFilterSet): field_name='address', lookup_expr='family' ) - parent = django_filters.CharFilter( + parent = MultiValueCharFilter( method='search_by_parent', label='Parent prefix', ) @@ -571,14 +571,16 @@ class IPAddressFilterSet(NetBoxModelFilterSet, TenancyFilterSet): return queryset.filter(qs_filter) def search_by_parent(self, queryset, name, value): - value = value.strip() if not value: return queryset - try: - query = str(netaddr.IPNetwork(value.strip()).cidr) - return queryset.filter(address__net_host_contained=query) - except (AddrFormatError, ValueError): - return queryset.none() + q = Q() + for prefix in value: + try: + query = str(netaddr.IPNetwork(prefix.strip()).cidr) + q |= Q(address__net_host_contained=query) + except (AddrFormatError, ValueError): + return queryset.none() + return queryset.filter(q) def filter_address(self, queryset, name, value): try: diff --git a/netbox/ipam/tests/test_filtersets.py b/netbox/ipam/tests/test_filtersets.py index 198f9d62d..d98fe889e 100644 --- a/netbox/ipam/tests/test_filtersets.py +++ b/netbox/ipam/tests/test_filtersets.py @@ -823,10 +823,8 @@ class IPAddressTestCase(TestCase, ChangeLoggedFilterSetTests): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_parent(self): - params = {'parent': '10.0.0.0/24'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) - params = {'parent': '2001:db8::/64'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) + params = {'parent': ['10.0.0.0/30', '2001:db8::/126']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 8) def test_filter_address(self): # Check IPv4 and IPv6, with and without a mask From 36c65b7b22566517b8d3abb7856f0b1d18402a3a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 7 Jun 2022 11:12:40 -0400 Subject: [PATCH 100/593] Closes #8893: Include count of IP ranges under tenant view --- docs/release-notes/version-3.2.md | 1 + netbox/templates/tenancy/tenant.html | 4 ++++ netbox/tenancy/views.py | 5 +++-- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 4534c35c1..3d1f86bec 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -5,6 +5,7 @@ ### Enhancements * [#8882](https://github.com/netbox-community/netbox/issues/8882) - Support filtering IP addresses by multiple parent prefixes +* [#8893](https://github.com/netbox-community/netbox/issues/8893) - Include count of IP ranges under tenant view ### Bug Fixes diff --git a/netbox/templates/tenancy/tenant.html b/netbox/templates/tenancy/tenant.html index e4c1db006..52c13e1aa 100644 --- a/netbox/templates/tenancy/tenant.html +++ b/netbox/templates/tenancy/tenant.html @@ -77,6 +77,10 @@

      {{ stats.prefix_count }}

      Prefixes

      +
      +

      {{ stats.iprange_count }}

      +

      IP Ranges

      +

      {{ stats.ipaddress_count }}

      IP addresses

      diff --git a/netbox/tenancy/views.py b/netbox/tenancy/views.py index 58ad98e8f..f6f95b123 100644 --- a/netbox/tenancy/views.py +++ b/netbox/tenancy/views.py @@ -3,7 +3,7 @@ from django.shortcuts import get_object_or_404 from circuits.models import Circuit from dcim.models import Cable, Device, Location, Rack, RackReservation, Site -from ipam.models import Aggregate, IPAddress, Prefix, VLAN, VRF, ASN +from ipam.models import Aggregate, IPAddress, IPRange, Prefix, VLAN, VRF, ASN from netbox.views import generic from utilities.utils import count_related from virtualization.models import VirtualMachine, Cluster @@ -104,8 +104,9 @@ class TenantView(generic.ObjectView): 'location_count': Location.objects.restrict(request.user, 'view').filter(tenant=instance).count(), 'device_count': Device.objects.restrict(request.user, 'view').filter(tenant=instance).count(), 'vrf_count': VRF.objects.restrict(request.user, 'view').filter(tenant=instance).count(), - 'prefix_count': Prefix.objects.restrict(request.user, 'view').filter(tenant=instance).count(), 'aggregate_count': Aggregate.objects.restrict(request.user, 'view').filter(tenant=instance).count(), + 'prefix_count': Prefix.objects.restrict(request.user, 'view').filter(tenant=instance).count(), + 'iprange_count': IPRange.objects.restrict(request.user, 'view').filter(tenant=instance).count(), 'ipaddress_count': IPAddress.objects.restrict(request.user, 'view').filter(tenant=instance).count(), 'vlan_count': VLAN.objects.restrict(request.user, 'view').filter(tenant=instance).count(), 'circuit_count': Circuit.objects.restrict(request.user, 'view').filter(tenant=instance).count(), From ecba9699edd342f12eba64d4a9b6f2f124f06fc4 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 7 Jun 2022 14:56:46 -0400 Subject: [PATCH 101/593] Introduce Node class for SVG boxes --- netbox/dcim/svg/cables.py | 152 ++++++++++++++++++-------------------- 1 file changed, 73 insertions(+), 79 deletions(-) diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py index 6613e9cca..ebdbb6e30 100644 --- a/netbox/dcim/svg/cables.py +++ b/netbox/dcim/svg/cables.py @@ -20,6 +20,52 @@ LINE_HEIGHT = 20 TERMINATION_WIDTH = 80 +class Node(Hyperlink): + """ + Create a node to be represented in the SVG document as a rectangular box with a hyperlink. + + Arguments: + position: (x, y) coordinates of the box's top left corner + width: Box width + url: Hyperlink URL + color: Box fill color (RRGGBB format) + labels: An iterable of text strings. Each label will render on a new line within the box. + radius: Box corner radius, for rounded corners (default: 10) + """ + + def __init__(self, position, width, url, color, labels, radius=10, **extra): + super(Node, self).__init__(href=url, target='_blank', **extra) + + x, y = position + + # Add the box + dimensions = (width - 2, PADDING + LINE_HEIGHT * len(labels) + PADDING) + box = Rect((x + OFFSET, y), dimensions, rx=radius, class_='parent-object', style=f'fill: #{color}') + self.add(box) + + cursor = y + PADDING + + # Add text label(s) + for i, label in enumerate(labels): + cursor += LINE_HEIGHT + text_coords = (x + width / 2, cursor - LINE_HEIGHT / 2) + text_color = f'#{foreground_color(color, dark="303030")}' + text = Text(label, insert=text_coords, fill=text_color, class_='bold' if not i else []) + self.add(text) + + @property + def box(self): + return self.elements[0] if self.elements else None + + @property + def top_center(self): + return self.box['x'] + self.box['width'] / 2, self.box['y'] + + @property + def bottom_center(self): + return self.box['x'] + self.box['width'] / 2, self.box['y'] + self.box['height'] + + class CableTraceSVG: """ Generate a graphical representation of a CablePath in SVG format. @@ -86,73 +132,42 @@ class CableTraceSVG: # Other parent object return 'e0e0e0' - def _draw_box( - self, - x, - width, - color, - url, - labels, - reset_cursor=False, - radius=10 - ): - """ - Return an SVG Link element containing a Rect and one or more text labels representing a - parent object or cable termination point. - - :param x: X axis position - :param width: Box width - :param color: Box fill color - :param url: Hyperlink URL - :param labels: Iterable of text labels - :param radius: Box corner radius (default: 10) - """ - _orig_cursor = self.cursor - - # Create a hyperlink - link = Hyperlink(href=f'{self.base_url}{url}', target='_blank') - - # Add the box - position = (x + OFFSET, self.cursor) - height = PADDING \ - + LINE_HEIGHT * len(labels) \ - + PADDING - box = Rect(position, (width - 2, height), rx=radius, class_='parent-object', style=f'fill: #{color}') - link.add(box) - self.cursor += PADDING - - # Add text label(s) - for i, label in enumerate(labels): - self.cursor += LINE_HEIGHT - text_coords = (x + width / 2, self.cursor - LINE_HEIGHT / 2) - text_color = f'#{foreground_color(color, dark="303030")}' - text = Text(label, insert=text_coords, fill=text_color, class_='bold' if not i else []) - link.add(text) - - if reset_cursor: - self.cursor = _orig_cursor - else: - self.cursor += PADDING - - return link + def draw_parent_object(self, obj): + node = Node( + position=(0, self.cursor), + width=self.width, + url=obj.get_absolute_url(), + color=self._get_color(obj), + labels=self._get_labels(obj) + ) + self.parent_objects.append(node) + self.cursor += node.box['height'] def draw_terminations(self, terminations): """ Draw a row of terminating objects (e.g. interfaces) belonging to the same parent object, all of which are attached to the same end of a cable. """ + nodes = [] + nodes_height = 0 x = self.width / 2 - len(terminations) * TERMINATION_WIDTH / 2 + for i, term in enumerate(terminations): - t = self._draw_box( - x=x + i * TERMINATION_WIDTH, + node = Node( + position=(x + i * TERMINATION_WIDTH, self.cursor), width=TERMINATION_WIDTH, - color=self._get_color(term), url=term.get_absolute_url(), + color=self._get_color(term), labels=self._get_labels(term), - radius=5, - reset_cursor=bool(i + 1 != len(terminations)) + radius=5 ) - self.terminations.append(t) + nodes_height = max(nodes_height, node.box['height']) + nodes.append(node) + + self.cursor += nodes_height + self.terminations.extend(nodes) + + return nodes def draw_cable(self, color, url, labels): """ @@ -257,14 +272,7 @@ class CableTraceSVG: # Near end parent if i == 0: # If this is the first segment, draw the originating termination's parent object - parent_object = self._draw_box( - x=0, - width=self.width, - color=self._get_color(near_ends[0].parent_object), - url=near_ends[0].parent_object.get_absolute_url(), - labels=self._get_labels(near_ends[0].parent_object) - ) - self.parent_objects.append(parent_object) + self.draw_parent_object(near_ends[0].parent_object) # Near end termination self.draw_terminations(near_ends) @@ -308,14 +316,7 @@ class CableTraceSVG: self.draw_terminations(far_ends) # Far end parent - parent_object = self._draw_box( - x=0, - width=self.width, - color=self._get_color(far_ends[0].parent_object), - url=far_ends[0].parent_object.get_absolute_url(), - labels=self._get_labels(far_ends[0].parent_object), - ) - self.parent_objects.append(parent_object) + self.draw_parent_object(far_ends[0].parent_object) elif far_ends: @@ -324,14 +325,7 @@ class CableTraceSVG: self.connectors.append(attachment) # ProviderNetwork - parent_object = self._draw_box( - x=0, - width=self.width, - color=self._get_color(far_ends[0]), - url=far_ends[0].get_absolute_url(), - labels=self._get_labels(far_ends[0]) - ) - self.parent_objects.append(parent_object) + self.draw_parent_object(far_ends[0]) # Determine drawing size self.drawing = svgwrite.Drawing( From 8d92ec20076eb9842dcce38fcd1793efddefa422 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 7 Jun 2022 16:43:22 -0400 Subject: [PATCH 102/593] Add support for cable fan-outs --- netbox/dcim/svg/cables.py | 184 +++++++++++++++++++++++--------------- 1 file changed, 110 insertions(+), 74 deletions(-) diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py index ebdbb6e30..34a171e00 100644 --- a/netbox/dcim/svg/cables.py +++ b/netbox/dcim/svg/cables.py @@ -16,8 +16,8 @@ __all__ = ( OFFSET = 0.5 PADDING = 10 LINE_HEIGHT = 20 - -TERMINATION_WIDTH = 80 +FANOUT_HEIGHT = 25 +TERMINATION_WIDTH = 100 class Node(Hyperlink): @@ -66,6 +66,47 @@ class Node(Hyperlink): return self.box['x'] + self.box['width'] / 2, self.box['y'] + self.box['height'] +class Connector(Group): + """ + Return an SVG group containing a line element and text labels representing a Cable. + + Arguments: + color: Cable (line) color + url: Hyperlink URL + labels: Iterable of text labels + """ + + def __init__(self, start, url, color, labels=[], **extra): + super().__init__(class_='connector', **extra) + + self.start = start + self.height = PADDING * 2 + LINE_HEIGHT * len(labels) + PADDING * 2 + self.end = (start[0], start[1] + self.height) + self.color = color or '000000' + + # Draw a "shadow" line to give the cable a border + cable_shadow = Line(start=self.start, end=self.end, class_='cable-shadow') + self.add(cable_shadow) + + # Draw the cable + cable = Line(start=self.start, end=self.end, style=f'stroke: #{self.color}') + self.add(cable) + + # Add link + link = Hyperlink(href=url, target='_blank') + + # Add text label(s) + cursor = start[1] + cursor += PADDING * 2 + for i, label in enumerate(labels): + cursor += LINE_HEIGHT + text_coords = (start[0] + PADDING * 2, cursor - LINE_HEIGHT / 2) + text = Text(label, insert=text_coords, class_='bold' if not i else []) + link.add(text) + + self.add(link) + + class CableTraceSVG: """ Generate a graphical representation of a CablePath in SVG format. @@ -136,13 +177,15 @@ class CableTraceSVG: node = Node( position=(0, self.cursor), width=self.width, - url=obj.get_absolute_url(), + url=f'{self.base_url}{obj.get_absolute_url()}', color=self._get_color(obj), labels=self._get_labels(obj) ) self.parent_objects.append(node) self.cursor += node.box['height'] + return node + def draw_terminations(self, terminations): """ Draw a row of terminating objects (e.g. interfaces) belonging to the same parent object, all of which @@ -156,7 +199,7 @@ class CableTraceSVG: node = Node( position=(x + i * TERMINATION_WIDTH, self.cursor), width=TERMINATION_WIDTH, - url=term.get_absolute_url(), + url=f'{self.base_url}{term.get_absolute_url()}', color=self._get_color(term), labels=self._get_labels(term), radius=5 @@ -169,53 +212,51 @@ class CableTraceSVG: return nodes - def draw_cable(self, color, url, labels): - """ - Return an SVG group containing a line element and text labels representing a Cable. + def draw_fanin(self, node, connector): + self.connectors.extend(( + Line(start=node.bottom_center, end=connector.start, class_='cable-shadow'), + Line(start=node.bottom_center, end=connector.start, style=f'stroke: #{connector.color}'), + )) - :param color: Cable (line) color - :param url: Hyperlink URL - :param labels: Iterable of text labels - """ - group = Group(class_='connector') + def draw_fanout(self, node, connector): + self.connectors.extend(( + Line(start=connector.end, end=node.top_center, class_='cable-shadow'), + Line(start=connector.end, end=node.top_center, style=f'stroke: #{connector.color}') + )) - # Draw a "shadow" line to give the cable a border - start = (OFFSET + self.center, self.cursor) - height = PADDING * 2 + LINE_HEIGHT * len(labels) + PADDING * 2 - end = (start[0], start[1] + height) - cable_shadow = Line(start=start, end=end, class_='cable-shadow') - group.add(cable_shadow) + def draw_cable(self, cable): + labels = [ + f'Cable {cable}', + cable.get_status_display() + ] + if cable.type: + labels.append(cable.get_type_display()) + if cable.length and cable.length_unit: + labels.append(f'{cable.length} {cable.get_length_unit_display()}') + connector = Connector( + start=(self.center + OFFSET, self.cursor), + color=cable.color or '000000', + url=f'{self.base_url}{cable.get_absolute_url()}', + labels=labels + ) - # Draw the cable - cable = Line(start=start, end=end, style=f'stroke: #{color}') - group.add(cable) + self.cursor += connector.height - self.cursor += PADDING * 2 + return connector - # Add link - link = Hyperlink(href=f'{self.base_url}{url}', target='_blank') - - # Add text label(s) - for i, label in enumerate(labels): - self.cursor += LINE_HEIGHT - text_coords = (self.center + PADDING * 2, self.cursor - LINE_HEIGHT / 2) - text = Text(label, insert=text_coords, class_='bold' if not i else []) - link.add(text) - - group.add(link) - self.cursor += PADDING * 2 - - return group - - def draw_wirelesslink(self, url, labels): + def draw_wirelesslink(self, wirelesslink): """ Draw a line with labels representing a WirelessLink. - - :param url: Hyperlink URL - :param labels: Iterable of text labels """ group = Group(class_='connector') + labels = [ + f'Wireless link {wirelesslink}', + wirelesslink.get_status_display() + ] + if wirelesslink.ssid: + labels.append(wirelesslink.ssid) + # Draw the wireless link start = (OFFSET + self.center, self.cursor) height = PADDING * 2 + LINE_HEIGHT * len(labels) + PADDING * 2 @@ -226,7 +267,7 @@ class CableTraceSVG: self.cursor += PADDING * 2 # Add link - link = Hyperlink(href=f'{self.base_url}{url}', target='_blank') + link = Hyperlink(href=f'{self.base_url}{wirelesslink.get_absolute_url()}', target='_blank') # Add text label(s) for i, label in enumerate(labels): @@ -267,53 +308,48 @@ class CableTraceSVG: # Iterate through each (terms, cable, terms) segment in the path for i, segment in enumerate(traced_path): - near_ends, connector, far_ends = segment + near_ends, link, far_ends = segment # Near end parent if i == 0: # If this is the first segment, draw the originating termination's parent object self.draw_parent_object(near_ends[0].parent_object) - # Near end termination - self.draw_terminations(near_ends) + # Near end termination(s) + terminations = self.draw_terminations(near_ends) # Connector (a Cable or WirelessLink) - connector = connector[0] # Remove Cable from list - if connector is not None: + link = link[0] # Remove Cable from list + if link is not None: # Cable - if type(connector) is Cable: - connector_labels = [ - f'Cable {connector}', - connector.get_status_display() - ] - if connector.type: - connector_labels.append(connector.get_type_display()) - if connector.length and connector.length_unit: - connector_labels.append(f'{connector.length} {connector.get_length_unit_display()}') - cable = self.draw_cable( - color=connector.color or '000000', - url=connector.get_absolute_url(), - labels=connector_labels - ) + if type(link) is Cable: + + # Account for fan-ins height + if len(near_ends) > 1: + self.cursor += FANOUT_HEIGHT + + cable = self.draw_cable(link) self.connectors.append(cable) + # Draw fan-ins + if len(near_ends) > 1: + for term in terminations: + self.draw_fanin(term, cable) + # WirelessLink - elif type(connector) is WirelessLink: - connector_labels = [ - f'Wireless link {connector}', - connector.get_status_display() - ] - if connector.ssid: - connector_labels.append(connector.ssid) - wirelesslink = self.draw_wirelesslink( - url=connector.get_absolute_url(), - labels=connector_labels - ) + elif type(link) is WirelessLink: + wirelesslink = self.draw_wirelesslink(link) self.connectors.append(wirelesslink) - # Far end termination - self.draw_terminations(far_ends) + # Far end termination(s) + if len(far_ends) > 1: + self.cursor += FANOUT_HEIGHT + terminations = self.draw_terminations(far_ends) + for term in terminations: + self.draw_fanout(term, cable) + else: + self.draw_terminations(far_ends) # Far end parent self.draw_parent_object(far_ends[0].parent_object) From 180adb42a391e288787dcb13022ebebae193b79e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 8 Jun 2022 16:29:26 -0400 Subject: [PATCH 103/593] Use polylines to draw cable fanouts --- netbox/dcim/svg/cables.py | 23 +++++++++++++----- netbox/project-static/dist/cable_trace.css | Bin 1133 -> 1169 bytes netbox/project-static/styles/cable-trace.scss | 6 ++++- 3 files changed, 22 insertions(+), 7 deletions(-) diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py index 34a171e00..3a9b47b54 100644 --- a/netbox/dcim/svg/cables.py +++ b/netbox/dcim/svg/cables.py @@ -1,6 +1,6 @@ import svgwrite from svgwrite.container import Group, Hyperlink -from svgwrite.shapes import Line, Rect +from svgwrite.shapes import Line, Polyline, Rect from svgwrite.text import Text from django.conf import settings @@ -16,7 +16,8 @@ __all__ = ( OFFSET = 0.5 PADDING = 10 LINE_HEIGHT = 20 -FANOUT_HEIGHT = 25 +FANOUT_HEIGHT = 35 +FANOUT_LEG_HEIGHT = 15 TERMINATION_WIDTH = 100 @@ -213,15 +214,25 @@ class CableTraceSVG: return nodes def draw_fanin(self, node, connector): + points = ( + node.bottom_center, + (node.bottom_center[0], node.bottom_center[1] + FANOUT_LEG_HEIGHT), + connector.start, + ) self.connectors.extend(( - Line(start=node.bottom_center, end=connector.start, class_='cable-shadow'), - Line(start=node.bottom_center, end=connector.start, style=f'stroke: #{connector.color}'), + Polyline(points=points, class_='cable-shadow'), + Polyline(points=points, style=f'stroke: #{connector.color}'), )) def draw_fanout(self, node, connector): + points = ( + connector.end, + (node.top_center[0], node.top_center[1] - FANOUT_LEG_HEIGHT), + node.top_center, + ) self.connectors.extend(( - Line(start=connector.end, end=node.top_center, class_='cable-shadow'), - Line(start=connector.end, end=node.top_center, style=f'stroke: #{connector.color}') + Polyline(points=points, class_='cable-shadow'), + Polyline(points=points, style=f'stroke: #{connector.color}'), )) def draw_cable(self, cable): diff --git a/netbox/project-static/dist/cable_trace.css b/netbox/project-static/dist/cable_trace.css index 50622f1284d056b81de5e643b27c1fa1d8487cdc..ff431f4ad848f1fe4c93892c9cbe87e608d78d34 100644 GIT binary patch delta 52 zcmaFMF_CjaKC?zaeokdhW?pJ_T4qj;RbGBxs&#QmQGRx+Zh2-(NrshaK}BtGS-QgH HV&-1}A7~W0 delta 16 XcmbQp`IcitJ~K;BW?t&#>CC?XG${s! diff --git a/netbox/project-static/styles/cable-trace.scss b/netbox/project-static/styles/cable-trace.scss index 51d94d38a..59c67ad4d 100644 --- a/netbox/project-static/styles/cable-trace.scss +++ b/netbox/project-static/styles/cable-trace.scss @@ -55,7 +55,11 @@ svg { line { stroke-width: 5px; } - line.cable-shadow { + polyline { + fill: none; + stroke-width: 5px; + } + .cable-shadow { stroke: var(--nbx-trace-cable-shadow); stroke-width: 7px; } From c81c3d11eda8fc0659acfabab042bc6065b43051 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 9 Jun 2022 10:20:44 -0400 Subject: [PATCH 104/593] Fixes #9495: Correct link to contacts in contact groups table column --- docs/release-notes/version-3.2.md | 1 + netbox/tenancy/tables/contacts.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 3d1f86bec..339081902 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -12,6 +12,7 @@ * [#9480](https://github.com/netbox-community/netbox/issues/9480) - Fix sorting services & service templates by port numbers * [#9484](https://github.com/netbox-community/netbox/issues/9484) - Include services listening on "all IPs" under IP address view * [#9486](https://github.com/netbox-community/netbox/issues/9486) - Fix redirect URL when adding device components from the module view +* [#9495](https://github.com/netbox-community/netbox/issues/9495) - Correct link to contacts in contact groups table column --- diff --git a/netbox/tenancy/tables/contacts.py b/netbox/tenancy/tables/contacts.py index 17abc5a5b..234dc2ad7 100644 --- a/netbox/tenancy/tables/contacts.py +++ b/netbox/tenancy/tables/contacts.py @@ -18,7 +18,7 @@ class ContactGroupTable(NetBoxTable): ) contact_count = columns.LinkedCountColumn( viewname='tenancy:contact_list', - url_params={'role_id': 'pk'}, + url_params={'group_id': 'pk'}, verbose_name='Contacts' ) tags = columns.TagColumn( From 87b3be26a0f471f59b70af9f25b314722c76c7c9 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 9 Jun 2022 11:48:32 -0400 Subject: [PATCH 105/593] Closes #9434: Enabled django-rich test runner for more user-friendly output --- base_requirements.txt | 6 +++++- docs/release-notes/version-3.3.md | 1 + netbox/netbox/settings.py | 2 ++ requirements.txt | 1 + 4 files changed, 9 insertions(+), 1 deletion(-) diff --git a/base_requirements.txt b/base_requirements.txt index 6bb537a6a..10e8af3ba 100644 --- a/base_requirements.txt +++ b/base_requirements.txt @@ -30,10 +30,14 @@ django-pglocks # https://github.com/korfuri/django-prometheus django-prometheus -# Django chaching backend using Redis +# Django caching backend using Redis # https://github.com/jazzband/django-redis django-redis +# Django extensions for Rich (terminal text rendering) +# https://github.com/adamchainz/django-rich +django-rich + # Django integration for RQ (Reqis queuing) # https://github.com/rq/django-rq django-rq diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 63fd9731f..514a92e88 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -19,6 +19,7 @@ ### Other Changes * [#9261](https://github.com/netbox-community/netbox/issues/9261) - `NetBoxTable` no longer automatically clears pre-existing calls to `prefetch_related()` on its queryset +* [#9434](https://github.com/netbox-community/netbox/issues/9434) - Enabled `django-rich` test runner for more user-friendly output ### REST API Changes diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index fd3730e2c..f9f4728a9 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -423,6 +423,8 @@ LOGIN_REDIRECT_URL = f'/{BASE_PATH}' DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField' +TEST_RUNNER = "django_rich.test.RichRunner" + # Exclude potentially sensitive models from wildcard view exemption. These may still be exempted # by specifying the model individually in the EXEMPT_VIEW_PERMISSIONS configuration parameter. EXEMPT_EXCLUDE_MODELS = ( diff --git a/requirements.txt b/requirements.txt index 293a33542..d6ea22e7d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,6 +7,7 @@ django-mptt==0.13.4 django-pglocks==1.0.4 django-prometheus==2.2.0 django-redis==5.2.0 +django-rich-1.4.0 django-rq==2.5.1 django-tables2==2.4.1 django-taggit==2.1.0 From 9b51c2a0b2189c10c4ecfd10505a7f11558f5219 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 9 Jun 2022 12:45:48 -0400 Subject: [PATCH 106/593] Fix typo --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index d6ea22e7d..1def8e23e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,7 +7,7 @@ django-mptt==0.13.4 django-pglocks==1.0.4 django-prometheus==2.2.0 django-redis==5.2.0 -django-rich-1.4.0 +django-rich==1.4.0 django-rq==2.5.1 django-tables2==2.4.1 django-taggit==2.1.0 From d1aa820856f0b80adffe8ea79f9a460589013fe3 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Fri, 10 Jun 2022 23:13:49 +0200 Subject: [PATCH 107/593] Add configuration option JINJA2_FILTERS --- docs/configuration/optional-settings.md | 14 ++++++++++++++ netbox/netbox/settings.py | 1 + netbox/utilities/utils.py | 5 ++++- 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index 670cf524b..0a7c7b6e0 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -255,6 +255,20 @@ HTTP_PROXIES = { --- +## JINJA2_FILTERS + +Default: `{}` + +A dictionary of custom jinja2 filters with the key being the filter name and the value being a callable. For more information see the [jinja2 documentation](https://jinja.palletsprojects.com/en/3.1.x/api/#custom-filters). For example: + +```python +JINJA2_FILTERS = { + 'uppercase': uppercase, +} +``` + +--- + ## INTERNAL_IPS Default: `('127.0.0.1', '::1')` diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 16c2b8b6e..f30dea4d7 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -96,6 +96,7 @@ EXEMPT_VIEW_PERMISSIONS = getattr(configuration, 'EXEMPT_VIEW_PERMISSIONS', []) FIELD_CHOICES = getattr(configuration, 'FIELD_CHOICES', {}) HTTP_PROXIES = getattr(configuration, 'HTTP_PROXIES', None) INTERNAL_IPS = getattr(configuration, 'INTERNAL_IPS', ('127.0.0.1', '::1')) +JINJA2_FILTERS = getattr(configuration, 'JINJA2_FILTERS', {}) LOGGING = getattr(configuration, 'LOGGING', {}) LOGIN_PERSISTENCE = getattr(configuration, 'LOGIN_PERSISTENCE', False) LOGIN_REQUIRED = getattr(configuration, 'LOGIN_REQUIRED', False) diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index 7b37c0b70..bc6d928ed 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -14,6 +14,7 @@ from mptt.models import MPTTModel from dcim.choices import CableLengthUnitChoices from extras.plugins import PluginConfig from extras.utils import is_taggable +from netbox.config import get_config from utilities.constants import HTTP_REQUEST_META_SAFE_COPY @@ -257,7 +258,9 @@ def render_jinja2(template_code, context): """ Render a Jinja2 template with the provided context. Return the rendered content. """ - return SandboxedEnvironment().from_string(source=template_code).render(**context) + environment = SandboxedEnvironment() + environment.filters.update(get_config().JINJA2_FILTERS) + return environment.from_string(source=template_code).render(**context) def prepare_cloned_fields(instance): From f13b090b5ca8cadc064b2985418b397267f64d9c Mon Sep 17 00:00:00 2001 From: kkthxbye <> Date: Mon, 13 Jun 2022 07:56:31 +0200 Subject: [PATCH 108/593] Add distinct to Site search to prevent duplicates when search matches ASN --- netbox/dcim/filtersets.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index d57d0a59b..f052a8be9 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -163,7 +163,7 @@ class SiteFilterSet(NetBoxModelFilterSet, TenancyFilterSet, ContactModelFilterSe qs_filter |= Q(asns__asn=int(value.strip())) except ValueError: pass - return queryset.filter(qs_filter) + return queryset.filter(qs_filter).distinct() class LocationFilterSet(TenancyFilterSet, ContactModelFilterSet, OrganizationalModelFilterSet): From 8ef74192ec78596788f425ac76bb162510569ea3 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Mon, 13 Jun 2022 20:45:08 +0200 Subject: [PATCH 109/593] Implement a custom paginator for DeviceViewSet Running count on the annotated query for loading config_context is slow. The custom paginator removes the annotation before getting the count. --- netbox/dcim/api/views.py | 2 ++ netbox/netbox/api/pagination.py | 18 +++++++++++++++++- 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index e99ef333a..c4c25f654 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -19,6 +19,7 @@ from ipam.models import Prefix, VLAN from netbox.api.authentication import IsAuthenticatedOrLoginNotRequired from netbox.api.exceptions import ServiceUnavailable from netbox.api.metadata import ContentTypeMetadata +from netbox.api.pagination import StripCountAnnotationsPaginator from netbox.api.viewsets import NetBoxModelViewSet from netbox.config import get_config from utilities.api import get_serializer_for_model @@ -392,6 +393,7 @@ class DeviceViewSet(ConfigContextQuerySetMixin, NetBoxModelViewSet): 'virtual_chassis__master', 'primary_ip4__nat_outside', 'primary_ip6__nat_outside', 'tags', ) filterset_class = filtersets.DeviceFilterSet + pagination_class = StripCountAnnotationsPaginator def get_serializer_class(self): """ diff --git a/netbox/netbox/api/pagination.py b/netbox/netbox/api/pagination.py index d89e32124..5ecade264 100644 --- a/netbox/netbox/api/pagination.py +++ b/netbox/netbox/api/pagination.py @@ -16,7 +16,7 @@ class OptionalLimitOffsetPagination(LimitOffsetPagination): def paginate_queryset(self, queryset, request, view=None): if isinstance(queryset, QuerySet): - self.count = queryset.count() + self.count = self.get_queryset_count(queryset) else: # We're dealing with an iterable, not a QuerySet self.count = len(queryset) @@ -52,6 +52,9 @@ class OptionalLimitOffsetPagination(LimitOffsetPagination): return self.default_limit + def get_queryset_count(self, queryset): + return queryset.count() + def get_next_link(self): # Pagination has been disabled @@ -67,3 +70,16 @@ class OptionalLimitOffsetPagination(LimitOffsetPagination): return None return super().get_previous_link() + + +class StripCountAnnotationsPaginator(OptionalLimitOffsetPagination): + """ + Strips the annotations on the queryset before getting the count + to optimize pagination of complex queries. + """ + def get_queryset_count(self, queryset): + # Clone the queryset to avoid messing up the actual query + cloned_queryset = queryset.all() + cloned_queryset.query.annotations.clear() + + return cloned_queryset.count() From 29a5fb041ff6b1b82d23f110b5008f84b3f954d2 Mon Sep 17 00:00:00 2001 From: Craig Pund Date: Mon, 13 Jun 2022 17:04:25 -0400 Subject: [PATCH 110/593] add fields for virtual chassis to device_edit form --- netbox/templates/dcim/device_edit.html | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/netbox/templates/dcim/device_edit.html b/netbox/templates/dcim/device_edit.html index 7cbb224c9..38125e83c 100644 --- a/netbox/templates/dcim/device_edit.html +++ b/netbox/templates/dcim/device_edit.html @@ -86,6 +86,15 @@ {% render_field form.tenant %}
      +
      +
      +
      Virtual Chassis
      +
      + {% render_field form.virtual_chassis %} + {% render_field form.vc_position %} + {% render_field form.vc_priority %} +
      + {% if form.custom_fields %}
      From 6876c9878e1e0965b61a341fd63083fc514c4540 Mon Sep 17 00:00:00 2001 From: Craig Pund Date: Mon, 13 Jun 2022 17:06:08 -0400 Subject: [PATCH 111/593] added field definitions for device form --- netbox/dcim/forms/models.py | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/netbox/dcim/forms/models.py b/netbox/dcim/forms/models.py index 179893219..2c905cc5c 100644 --- a/netbox/dcim/forms/models.py +++ b/netbox/dcim/forms/models.py @@ -521,13 +521,26 @@ class DeviceForm(TenancyForm, NetBoxModelForm): required=False, label='' ) + virtual_chassis = DynamicModelChoiceField( + queryset=VirtualChassis.objects.all(), + required=False + ) + vc_position = forms.IntegerField( + required=False, + help_text="The position in the virtual chassis this device is identified by" + ) + vc_priority = forms.IntegerField( + required=False, + help_text="The priority of the device in the virtual chassis" + ) class Meta: model = Device fields = [ 'name', 'device_role', 'device_type', 'serial', 'asset_tag', 'region', 'site_group', 'site', 'rack', 'location', 'position', 'face', 'status', 'airflow', 'platform', 'primary_ip4', 'primary_ip6', - 'cluster_group', 'cluster', 'tenant_group', 'tenant', 'comments', 'tags', 'local_context_data' + 'cluster_group', 'cluster', 'tenant_group', 'tenant', 'virtual_chassis', 'vc_position', 'vc_priority', + 'comments', 'tags', 'local_context_data' ] help_texts = { 'device_role': "The function this device serves", From 86c35a403a6e8656780be359e7b6acc7f8dc2231 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 13 Jun 2022 19:05:16 -0400 Subject: [PATCH 112/593] Changelog for #9501, #9512 --- docs/configuration/optional-settings.md | 5 ++++- docs/release-notes/version-3.2.md | 2 ++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index 0a7c7b6e0..3b1c848a7 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -259,9 +259,12 @@ HTTP_PROXIES = { Default: `{}` -A dictionary of custom jinja2 filters with the key being the filter name and the value being a callable. For more information see the [jinja2 documentation](https://jinja.palletsprojects.com/en/3.1.x/api/#custom-filters). For example: +A dictionary of custom jinja2 filters with the key being the filter name and the value being a callable. For more information see the [Jinja2 documentation](https://jinja.palletsprojects.com/en/3.1.x/api/#custom-filters). For example: ```python +def uppercase(x): + return str(x).upper() + JINJA2_FILTERS = { 'uppercase': uppercase, } diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 339081902..93ca4a840 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -6,6 +6,7 @@ * [#8882](https://github.com/netbox-community/netbox/issues/8882) - Support filtering IP addresses by multiple parent prefixes * [#8893](https://github.com/netbox-community/netbox/issues/8893) - Include count of IP ranges under tenant view +* [#9501](https://github.com/netbox-community/netbox/issues/9501) - Add support for custom Jinja2 filters ### Bug Fixes @@ -13,6 +14,7 @@ * [#9484](https://github.com/netbox-community/netbox/issues/9484) - Include services listening on "all IPs" under IP address view * [#9486](https://github.com/netbox-community/netbox/issues/9486) - Fix redirect URL when adding device components from the module view * [#9495](https://github.com/netbox-community/netbox/issues/9495) - Correct link to contacts in contact groups table column +* [#9512](https://github.com/netbox-community/netbox/issues/9512) - Fix duplicate site results when searching by ASN --- From 83fdfaa0eb836cdcf9bb6d78c138a274aa54cb1c Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Mon, 13 Jun 2022 19:14:29 -0400 Subject: [PATCH 113/593] Fixes #9524: Correct order of VLAN fields under VM interface creation form --- docs/release-notes/version-3.2.md | 1 + netbox/virtualization/forms/models.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 93ca4a840..05d798e54 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -15,6 +15,7 @@ * [#9486](https://github.com/netbox-community/netbox/issues/9486) - Fix redirect URL when adding device components from the module view * [#9495](https://github.com/netbox-community/netbox/issues/9495) - Correct link to contacts in contact groups table column * [#9512](https://github.com/netbox-community/netbox/issues/9512) - Fix duplicate site results when searching by ASN +* [#9524](https://github.com/netbox-community/netbox/issues/9524) - Correct order of VLAN fields under VM interface creation form --- diff --git a/netbox/virtualization/forms/models.py b/netbox/virtualization/forms/models.py index 314b0bddf..d2ebe5345 100644 --- a/netbox/virtualization/forms/models.py +++ b/netbox/virtualization/forms/models.py @@ -307,7 +307,7 @@ class VMInterfaceForm(InterfaceCommonForm, NetBoxModelForm): model = VMInterface fields = [ 'virtual_machine', 'name', 'parent', 'bridge', 'enabled', 'mac_address', 'mtu', 'description', 'mode', - 'untagged_vlan', 'tagged_vlans', 'vrf', 'tags', + 'vlan_group', 'untagged_vlan', 'tagged_vlans', 'vrf', 'tags', ] widgets = { 'virtual_machine': forms.HiddenInput(), From e8b970608eda6b6d1f8596cbcd457492f372d73d Mon Sep 17 00:00:00 2001 From: Kim Johansson Date: Wed, 15 Jun 2022 22:33:21 +0200 Subject: [PATCH 114/593] Replace None in templates with placeholder filter To be consistent, all uses of — or None is replaced with the placeholder filter. Fixes #9537 --- .../circuits/circuit_terminations_swap.html | 4 ++-- .../templates/circuits/inc/circuit_termination.html | 2 +- netbox/templates/circuits/provider.html | 2 +- netbox/templates/dcim/cable.html | 4 ++-- netbox/templates/dcim/device.html | 12 ++++++------ netbox/templates/dcim/devicerole.html | 2 +- netbox/templates/dcim/devicetype.html | 4 ++-- netbox/templates/dcim/interface.html | 8 ++++---- netbox/templates/dcim/powerfeed.html | 2 +- netbox/templates/dcim/rack.html | 8 ++++---- netbox/templates/dcim/site.html | 10 +++++----- netbox/templates/dcim/virtualchassis_edit.html | 2 +- netbox/templates/extras/customfield.html | 4 ++-- netbox/templates/extras/htmx/report_result.html | 2 +- netbox/templates/generic/bulk_import.html | 4 ++-- netbox/templates/inc/panels/custom_fields.html | 2 +- netbox/templates/ipam/ipaddress.html | 6 +++--- netbox/templates/ipam/prefix.html | 8 ++++---- netbox/templates/ipam/role.html | 4 ++-- netbox/templates/ipam/service.html | 2 +- netbox/templates/ipam/vlan.html | 4 ++-- netbox/templates/tenancy/contact.html | 4 ++-- netbox/templates/users/profile.html | 2 +- netbox/templates/virtualization/virtualmachine.html | 8 ++++---- .../wireless/inc/wirelesslink_interface.html | 4 ++-- 25 files changed, 57 insertions(+), 57 deletions(-) diff --git a/netbox/templates/circuits/circuit_terminations_swap.html b/netbox/templates/circuits/circuit_terminations_swap.html index 27eebb3d8..b2b30d635 100644 --- a/netbox/templates/circuits/circuit_terminations_swap.html +++ b/netbox/templates/circuits/circuit_terminations_swap.html @@ -10,7 +10,7 @@ {% if termination_a %} {{ termination_a.site }} {% if termination_a.interface %}- {{ termination_a.interface.device }} {{ termination_a.interface }}{% endif %} {% else %} - None + {{ ''|placeholder }} {% endif %}
    • @@ -18,7 +18,7 @@ {% if termination_z %} {{ termination_z.site }} {% if termination_z.interface %}- {{ termination_z.interface.device }} {{ termination_z.interface }}{% endif %} {% else %} - None + {{ ''|placeholder }} {% endif %}
      • diff --git a/netbox/templates/circuits/inc/circuit_termination.html b/netbox/templates/circuits/inc/circuit_termination.html index fdb01e803..b673cd4a3 100644 --- a/netbox/templates/circuits/inc/circuit_termination.html +++ b/netbox/templates/circuits/inc/circuit_termination.html @@ -94,7 +94,7 @@ {% elif termination.port_speed %} {{ termination.port_speed|humanize_speed }} {% else %} - — + {{ ''|placeholder }} {% endif %}
      diff --git a/netbox/templates/circuits/provider.html b/netbox/templates/circuits/provider.html index 1bf63f2d5..60bf8cfbc 100644 --- a/netbox/templates/circuits/provider.html +++ b/netbox/templates/circuits/provider.html @@ -50,7 +50,7 @@ {% if object.portal_url %} {{ object.portal_url }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/dcim/cable.html b/netbox/templates/dcim/cable.html index f1cf986e6..cd171cbb3 100644 --- a/netbox/templates/dcim/cable.html +++ b/netbox/templates/dcim/cable.html @@ -40,7 +40,7 @@ {% if object.color %}   {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -50,7 +50,7 @@ {% if object.length %} {{ object.length|floatformat }} {{ object.get_length_unit_display }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/dcim/device.html b/netbox/templates/dcim/device.html index d075a801d..d3d6f03dc 100644 --- a/netbox/templates/dcim/device.html +++ b/netbox/templates/dcim/device.html @@ -23,7 +23,7 @@ {% endfor %} {{ object.site.region|linkify }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -40,7 +40,7 @@ {% endfor %} {{ object.location|linkify }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -50,7 +50,7 @@ {% if object.rack %} {{ object.rack }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -69,7 +69,7 @@ {% elif object.rack and object.device_type.u_height %} Not racked {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -180,7 +180,7 @@ (NAT: {{ object.primary_ip4.nat_outside.address.ip|linkify }}) {% endif %} {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -195,7 +195,7 @@ (NAT: {{ object.primary_ip6.nat_outside.address.ip|linkify }}) {% endif %} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/dcim/devicerole.html b/netbox/templates/dcim/devicerole.html index 288101c08..610c53071 100644 --- a/netbox/templates/dcim/devicerole.html +++ b/netbox/templates/dcim/devicerole.html @@ -54,7 +54,7 @@ {% if object.vm_role %} {{ virtualmachine_count }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/dcim/devicetype.html b/netbox/templates/dcim/devicetype.html index e717a48aa..bb3ec9d2e 100644 --- a/netbox/templates/dcim/devicetype.html +++ b/netbox/templates/dcim/devicetype.html @@ -55,7 +55,7 @@ {{ object.front_image.name }} {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -67,7 +67,7 @@ {{ object.rear_image.name }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/dcim/interface.html b/netbox/templates/dcim/interface.html index 358922730..c4cb8b72f 100644 --- a/netbox/templates/dcim/interface.html +++ b/netbox/templates/dcim/interface.html @@ -321,7 +321,7 @@ {% if object.rf_channel_frequency %} {{ object.rf_channel_frequency|simplify_decimal }} MHz {% else %} - — + {{ ''|placeholder }} {% endif %} {% if peer %} @@ -329,7 +329,7 @@ {% if peer.rf_channel_frequency %} {{ peer.rf_channel_frequency|simplify_decimal }} MHz {% else %} - — + {{ ''|placeholder }} {% endif %} {% endif %} @@ -340,7 +340,7 @@ {% if object.rf_channel_width %} {{ object.rf_channel_width|simplify_decimal }} MHz {% else %} - — + {{ ''|placeholder }} {% endif %} {% if peer %} @@ -348,7 +348,7 @@ {% if peer.rf_channel_width %} {{ peer.rf_channel_width|simplify_decimal }} MHz {% else %} - — + {{ ''|placeholder }} {% endif %} {% endif %} diff --git a/netbox/templates/dcim/powerfeed.html b/netbox/templates/dcim/powerfeed.html index 777af5563..ed1f9a1cd 100644 --- a/netbox/templates/dcim/powerfeed.html +++ b/netbox/templates/dcim/powerfeed.html @@ -44,7 +44,7 @@ {% if object.connected_endpoint %} {{ object.connected_endpoint.device|linkify }} ({{ object.connected_endpoint }}) {% else %} - None + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/dcim/rack.html b/netbox/templates/dcim/rack.html index 6574e9b74..42f6a8e99 100644 --- a/netbox/templates/dcim/rack.html +++ b/netbox/templates/dcim/rack.html @@ -53,7 +53,7 @@ {% endfor %} {{ object.location|linkify }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -115,7 +115,7 @@ {% if object.type %} {{ object.get_type_display }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -133,7 +133,7 @@ {% if object.outer_width %} {{ object.outer_width }} {{ object.get_outer_unit_display }} {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -143,7 +143,7 @@ {% if object.outer_depth %} {{ object.outer_depth }} {{ object.get_outer_unit_display }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/dcim/site.html b/netbox/templates/dcim/site.html index c15cab468..ab04ea018 100644 --- a/netbox/templates/dcim/site.html +++ b/netbox/templates/dcim/site.html @@ -34,7 +34,7 @@ {% endfor %} {{ object.region|linkify }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -47,7 +47,7 @@ {% endfor %} {{ object.group|linkify }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -79,7 +79,7 @@ {{ object.time_zone }} (UTC {{ object.time_zone|tzoffset }})
      Site time: {% timezone object.time_zone %}{% annotated_now %}{% endtimezone %} {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -94,7 +94,7 @@ {{ object.physical_address|linebreaksbr }} {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -113,7 +113,7 @@ {{ object.latitude }}, {{ object.longitude }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/dcim/virtualchassis_edit.html b/netbox/templates/dcim/virtualchassis_edit.html index 327f20531..275391c61 100644 --- a/netbox/templates/dcim/virtualchassis_edit.html +++ b/netbox/templates/dcim/virtualchassis_edit.html @@ -57,7 +57,7 @@ {% if device.rack %} {{ device.rack }} / {{ device.position }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/extras/customfield.html b/netbox/templates/extras/customfield.html index e8c3df460..a5618c6db 100644 --- a/netbox/templates/extras/customfield.html +++ b/netbox/templates/extras/customfield.html @@ -57,7 +57,7 @@ {% if object.choices %} {{ object.choices|join:", " }} {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -105,7 +105,7 @@ {% if object.validation_regex %} {{ object.validation_regex }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/extras/htmx/report_result.html b/netbox/templates/extras/htmx/report_result.html index 9b3e9db5f..c20bf5fe2 100644 --- a/netbox/templates/extras/htmx/report_result.html +++ b/netbox/templates/extras/htmx/report_result.html @@ -57,7 +57,7 @@ {% elif obj %} {{ obj }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/generic/bulk_import.html b/netbox/templates/generic/bulk_import.html index 43e078826..1a85c3a21 100644 --- a/netbox/templates/generic/bulk_import.html +++ b/netbox/templates/generic/bulk_import.html @@ -76,14 +76,14 @@ Context: {% if field.required %} {% checkmark True true="Required" %} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/ipam/ipaddress.html b/netbox/templates/ipam/ipaddress.html index ab47c11af..d1d49e7cc 100644 --- a/netbox/templates/ipam/ipaddress.html +++ b/netbox/templates/ipam/ipaddress.html @@ -52,7 +52,7 @@ {% if object.role %} {{ object.get_role_display }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -73,7 +73,7 @@ {% endif %} {{ object.assigned_object|linkify }} {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -86,7 +86,7 @@ ({{ object.nat_inside.assigned_object.parent_object|linkify }}) {% endif %} {% else %} - None + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/ipam/prefix.html b/netbox/templates/ipam/prefix.html index e2ba76a82..a47566ff7 100644 --- a/netbox/templates/ipam/prefix.html +++ b/netbox/templates/ipam/prefix.html @@ -39,7 +39,7 @@ {% if aggregate %} {{ aggregate.prefix }} ({{ aggregate.rir }}) {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -52,7 +52,7 @@ {% endif %} {{ object.site|linkify }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -65,7 +65,7 @@ {% endif %} {{ object.vlan|linkify }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -138,7 +138,7 @@ {{ first_available_ip }} {% endif %} {% else %} - None + {{ ''|placeholder }} {% endif %} {% endwith %} diff --git a/netbox/templates/ipam/role.html b/netbox/templates/ipam/role.html index 49570099d..a6ef2c6d4 100644 --- a/netbox/templates/ipam/role.html +++ b/netbox/templates/ipam/role.html @@ -45,7 +45,7 @@ {% if ipranges_count %} {{ ipranges_count }} {% else %} - — + {{ ''|placeholder }} {% endif %} {% endwith %} @@ -57,7 +57,7 @@ {% if vlans_count %} {{ vlans_count }} {% else %} - — + {{ ''|placeholder }} {% endif %} {% endwith %} diff --git a/netbox/templates/ipam/service.html b/netbox/templates/ipam/service.html index 71ea20fa5..47ae70dc9 100644 --- a/netbox/templates/ipam/service.html +++ b/netbox/templates/ipam/service.html @@ -44,7 +44,7 @@ {% for ipaddress in object.ipaddresses.all %} {{ ipaddress|linkify }}
      {% empty %} - None + {{ ''|placeholder }} {% endfor %} diff --git a/netbox/templates/ipam/vlan.html b/netbox/templates/ipam/vlan.html index f74149ad6..fd0ba36a3 100644 --- a/netbox/templates/ipam/vlan.html +++ b/netbox/templates/ipam/vlan.html @@ -21,7 +21,7 @@ {% endif %} {{ object.site|linkify }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -56,7 +56,7 @@ {% if object.role %} {{ object.role }} {% else %} - None + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/tenancy/contact.html b/netbox/templates/tenancy/contact.html index f55e87895..8e71628e9 100644 --- a/netbox/templates/tenancy/contact.html +++ b/netbox/templates/tenancy/contact.html @@ -35,7 +35,7 @@ {% if object.phone %} {{ object.phone }} {% else %} - None + {{ ''|placeholder }} {% endif %} @@ -45,7 +45,7 @@ {% if object.email %} {{ object.email }} {% else %} - None + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/users/profile.html b/netbox/templates/users/profile.html index 112603126..913784c94 100644 --- a/netbox/templates/users/profile.html +++ b/netbox/templates/users/profile.html @@ -21,7 +21,7 @@ {% if request.user.first_name or request.user.last_name %} {{ request.user.first_name }} {{ request.user.last_name }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/virtualization/virtualmachine.html b/netbox/templates/virtualization/virtualmachine.html index 0dec4968c..61f9aa61a 100644 --- a/netbox/templates/virtualization/virtualmachine.html +++ b/netbox/templates/virtualization/virtualmachine.html @@ -49,7 +49,7 @@ (NAT: {{ object.primary_ip4.nat_outside.address.ip }}) {% endif %} {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -64,7 +64,7 @@ (NAT: {{ object.primary_ip6.nat_outside.address.ip }}) {% endif %} {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -115,7 +115,7 @@ {% if object.memory %} {{ object.memory|humanize_megabytes }} {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -125,7 +125,7 @@ {% if object.disk %} {{ object.disk }} GB {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/wireless/inc/wirelesslink_interface.html b/netbox/templates/wireless/inc/wirelesslink_interface.html index db4f84f0a..7732816a7 100644 --- a/netbox/templates/wireless/inc/wirelesslink_interface.html +++ b/netbox/templates/wireless/inc/wirelesslink_interface.html @@ -33,7 +33,7 @@ {% if interface.rf_channel_frequency %} {{ interface.rf_channel_frequency|simplify_decimal }} MHz {% else %} - — + {{ ''|placeholder }} {% endif %} @@ -43,7 +43,7 @@ {% if interface.rf_channel_width %} {{ interface.rf_channel_width|simplify_decimal }} MHz {% else %} - — + {{ ''|placeholder }} {% endif %} From cf76d5c46af8a68a7d29497ef28d43ae2ab83966 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Thu, 16 Jun 2022 22:26:37 +0200 Subject: [PATCH 115/593] Move markdown documentation to docs --- docs/reference/markdown.md | 353 ++++++++++++++++++++++++ mkdocs.yml | 1 + netbox/utilities/forms/fields/fields.py | 6 +- 3 files changed, 357 insertions(+), 3 deletions(-) create mode 100644 docs/reference/markdown.md diff --git a/docs/reference/markdown.md b/docs/reference/markdown.md new file mode 100644 index 000000000..896d5dcf7 --- /dev/null +++ b/docs/reference/markdown.md @@ -0,0 +1,353 @@ +--- +hide: + - toc +--- + +# Markdown + +NetBox supports markdown rendering for certain text fields. + +## Syntax + +##### Table of Contents +[Headers](#headers) +[Emphasis](#emphasis) +[Lists](#lists) +[Links](#links) +[Images](#images) +[Code Blocks](#code) +[Tables](#tables) +[Blockquotes](#blockquotes) +[Inline HTML](#html) +[Horizontal Rule](#hr) +[Line Breaks](#lines) + + + +## Headers + +```no-highlight +# H1 +## H2 +### H3 +#### H4 +##### H5 +###### H6 + +Alternatively, for H1 and H2, an underline-ish style: + +Alt-H1 +====== + +Alt-H2 +------ +``` + +# H1 +## H2 +### H3 +#### H4 +##### H5 +###### H6 + + + +## Emphasis + +```no-highlight +Emphasis, aka italics, with *asterisks* or _underscores_. + +Strong emphasis, aka bold, with **asterisks** or __underscores__. + +Combined emphasis with **asterisks and _underscores_**. + +Strikethrough uses two tildes. ~~Scratch this.~~ +``` + +Emphasis, aka italics, with *asterisks* or _underscores_. + +Strong emphasis, aka bold, with **asterisks** or __underscores__. + +Combined emphasis with **asterisks and _underscores_**. + +Strikethrough uses two tildes. ~~Scratch this.~~ + + + + +## Lists + +(In this example, leading and trailing spaces are shown with with dots: ⋅) + +```no-highlight +1. First ordered list item +2. Another item +⋅⋅* Unordered sub-list. +1. Actual numbers don't matter, just that it's a number +⋅⋅1. Ordered sub-list +4. And another item. + +⋅⋅⋅You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown). + +⋅⋅⋅To have a line break without a paragraph, you will need to use two trailing spaces.⋅⋅ +⋅⋅⋅Note that this line is separate, but within the same paragraph.⋅⋅ +⋅⋅⋅(This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.) + +* Unordered list can use asterisks +- Or minuses ++ Or pluses +``` + +1. First ordered list item +2. Another item + * Unordered sub-list. +1. Actual numbers don't matter, just that it's a number + 1. Ordered sub-list +4. And another item. + + You can have properly indented paragraphs within list items. Notice the blank line above, and the leading spaces (at least one, but we'll use three here to also align the raw Markdown). + + To have a line break without a paragraph, you will need to use two trailing spaces. + Note that this line is separate, but within the same paragraph. + (This is contrary to the typical GFM line break behaviour, where trailing spaces are not required.) + +* Unordered list can use asterisks +- Or minuses ++ Or pluses + + + +## Links + +There are two ways to create links. + +```no-highlight +[I'm an inline-style link](https://www.google.com) + +[I'm an inline-style link with title](https://www.google.com "Google's Homepage") + +[I'm a reference-style link][Arbitrary case-insensitive reference text] + +[You can use numbers for reference-style link definitions][1] + +Or leave it empty and use the [link text itself]. + +URLs and URLs in angle brackets will automatically get turned into links. +http://www.example.com or and sometimes +example.com (but not on Github, for example). + +Some text to show that the reference links can follow later. + +[arbitrary case-insensitive reference text]: https://www.mozilla.org +[1]: http://slashdot.org +[link text itself]: http://www.reddit.com +``` + +[I'm an inline-style link](https://www.google.com) + +[I'm an inline-style link with title](https://www.google.com "Google's Homepage") + +[I'm a reference-style link][Arbitrary case-insensitive reference text] + +[You can use numbers for reference-style link definitions][1] + +Or leave it empty and use the [link text itself]. + +URLs and URLs in angle brackets will automatically get turned into links. +http://www.example.com or and sometimes +example.com (but not on Github, for example). + +Some text to show that the reference links can follow later. + +[arbitrary case-insensitive reference text]: https://www.mozilla.org +[1]: http://slashdot.org +[link text itself]: http://www.reddit.com + + + +## Images + +``` +Here's the Netbox logo (hover to see the title text): + +Inline-style: +![alt text](/static/netbox_logo.png "Logo Title Text 1") + +Reference-style: +![alt text][logo] + +[logo]: /static/netbox_logo.png "Logo Title Text 2" +``` + +Here's the Netbox logo (hover to see the title text): + +Inline-style: +![alt text](/static/netbox_logo.png "Logo Title Text 1") + +Reference-style: +![alt text][logo] + +[logo]: /static/netbox_logo.png "Logo Title Text 2" + + + +## Code blocks + +``` +Inline `code` has `back-ticks around` it. +``` + +Inline `code` has `back-ticks around` it. + +Blocks of code are fenced by lines with three back-ticks ``` + +```` +``` +var s = "Code block"; +alert(s); +``` +```` + +``` +var s = "Code block"; +alert(s); +``` + + + +## Tables + +```no-highlight +Colons can be used to align columns. + +| Tables | Are | Cool | +| ------------- |:-------------:| -----:| +| col 3 is | right-aligned | $1600 | +| col 2 is | centered | $12 | +| zebra stripes | are neat | $1 | + +There must be at least 3 dashes separating each header cell. +The outer pipes (|) are optional, and you don't need to make the +raw Markdown line up prettily. You can also use inline Markdown. + +Markdown | Less | Pretty +--- | --- | --- +*Still* | `renders` | **nicely** +1 | 2 | 3 +``` + +Colons can be used to align columns. + +| Tables | Are | Cool | +| ------------- |:-------------:| -----:| +| col 3 is | right-aligned | $1600 | +| col 2 is | centered | $12 | +| zebra stripes | are neat | $1 | + +There must be at least 3 dashes separating each header cell. The outer pipes (|) are optional, and you don't need to make the raw Markdown line up prettily. You can also use inline Markdown. + +Markdown | Less | Pretty +--- | --- | --- +*Still* | `renders` | **nicely** +1 | 2 | 3 + + + +## Blockquotes + +```no-highlight +> Blockquotes are very handy in email to emulate reply text. +> This line is part of the same quote. + +Quote break. + +> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote. +``` + +> Blockquotes are very handy in email to emulate reply text. +> This line is part of the same quote. + +Quote break. + +> This is a very long line that will still be quoted properly when it wraps. Oh boy let's keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can *put* **Markdown** into a blockquote. + + + +## Inline HTML + +You can also use raw HTML in your Markdown, and it'll mostly work pretty well. + +```no-highlight +
      +
      Definition list
      +
      Is something people use sometimes.
      + +
      Markdown in HTML
      +
      Does *not* work **very** well. Use HTML tags.
      +
      +``` + +
      +
      Definition list
      +
      Is something people use sometimes.
      + +
      Markdown in HTML
      +
      Does *not* work **very** well. Use HTML tags.
      +
      + + + +## Horizontal Rule + +``` +Three or more... + +--- + +Hyphens + +*** + +Asterisks + +___ + +Underscores +``` + +Three or more... + +--- + +Hyphens + +*** + +Asterisks + +___ + +Underscores + + + +## Line Breaks + + +``` +Here's a line for us to start with. + +This line is separated from the one above by two newlines, so it will be a *separate paragraph*. + +This line is also a separate paragraph, but... +This line is only separated by a single newline, so it's a separate line in the *same paragraph*. +``` + +Here's a line for us to start with. + +This line is separated from the one above by two newlines, so it will be a *separate paragraph*. + +This line is also begins a separate paragraph, but... +This line is only separated by a single newline, so it's a separate line in the *same paragraph*. + +Based on [Markdown-Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) by [adam-p](https://github.com/adam-p) licensed under [CC-BY](https://creativecommons.org/licenses/by/3.0/) \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 5c973e0d6..507b25627 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -136,6 +136,7 @@ nav: - Overview: 'graphql-api/overview.md' - Reference: - Conditions: 'reference/conditions.md' + - Markdown: 'reference/markdown.md' - Development: - Introduction: 'development/index.md' - Getting Started: 'development/getting-started.md' diff --git a/netbox/utilities/forms/fields/fields.py b/netbox/utilities/forms/fields/fields.py index 0d09d2ac7..9168189a1 100644 --- a/netbox/utilities/forms/fields/fields.py +++ b/netbox/utilities/forms/fields/fields.py @@ -3,6 +3,7 @@ import json from django import forms from django.db.models import Count from django.forms.fields import JSONField as _JSONField, InvalidJSONInput +from django.templatetags.static import static from netaddr import AddrFormatError, EUI from utilities.forms import widgets @@ -26,10 +27,9 @@ class CommentField(forms.CharField): A textarea with support for Markdown rendering. Exists mostly just to add a standard `help_text`. """ widget = forms.Textarea - # TODO: Port Markdown cheat sheet to internal documentation - help_text = """ + help_text = f""" - + Markdown syntax is supported """ From c04b4bbbfaab83f566bdd287b4b7b3b58752da99 Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Fri, 17 Jun 2022 14:45:56 +0200 Subject: [PATCH 116/593] Add last_used to Token model and update when used --- netbox/netbox/api/authentication.py | 5 +++++ netbox/users/admin/__init__.py | 2 +- .../users/migrations/0003_token_last_used.py | 18 ++++++++++++++++++ netbox/users/models.py | 4 ++++ 4 files changed, 28 insertions(+), 1 deletion(-) create mode 100644 netbox/users/migrations/0003_token_last_used.py diff --git a/netbox/netbox/api/authentication.py b/netbox/netbox/api/authentication.py index 5e177bfcb..f40141de4 100644 --- a/netbox/netbox/api/authentication.py +++ b/netbox/netbox/api/authentication.py @@ -1,4 +1,5 @@ from django.conf import settings +from django.utils import timezone from rest_framework import authentication, exceptions from rest_framework.permissions import BasePermission, DjangoObjectPermissions, SAFE_METHODS @@ -18,6 +19,10 @@ class TokenAuthentication(authentication.TokenAuthentication): except model.DoesNotExist: raise exceptions.AuthenticationFailed("Invalid token") + # Update last used. + token.last_used = timezone.now() + token.save() + # Enforce the Token's expiration time, if one has been set. if token.is_expired: raise exceptions.AuthenticationFailed("Token expired") diff --git a/netbox/users/admin/__init__.py b/netbox/users/admin/__init__.py index 1b163ed06..320c28df2 100644 --- a/netbox/users/admin/__init__.py +++ b/netbox/users/admin/__init__.py @@ -58,7 +58,7 @@ class UserAdmin(UserAdmin_): class TokenAdmin(admin.ModelAdmin): form = forms.TokenAdminForm list_display = [ - 'key', 'user', 'created', 'expires', 'write_enabled', 'description' + 'key', 'user', 'created', 'expires', 'last_used', 'write_enabled', 'description' ] diff --git a/netbox/users/migrations/0003_token_last_used.py b/netbox/users/migrations/0003_token_last_used.py new file mode 100644 index 000000000..cc014e59c --- /dev/null +++ b/netbox/users/migrations/0003_token_last_used.py @@ -0,0 +1,18 @@ +# Generated by Django 4.0.4 on 2022-06-16 15:26 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('users', '0002_standardize_id_fields'), + ] + + operations = [ + migrations.AddField( + model_name='token', + name='last_used', + field=models.DateTimeField(blank=True, null=True), + ), + ] diff --git a/netbox/users/models.py b/netbox/users/models.py index 23068442e..a0055914b 100644 --- a/netbox/users/models.py +++ b/netbox/users/models.py @@ -203,6 +203,10 @@ class Token(models.Model): blank=True, null=True ) + last_used = models.DateTimeField( + blank=True, + null=True + ) key = models.CharField( max_length=40, unique=True, From 5d4575ed258e8ccfa55a14648e6b0eb688cfd8e4 Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Fri, 17 Jun 2022 14:57:19 +0200 Subject: [PATCH 117/593] Only update every 60 seconds --- netbox/netbox/api/authentication.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/netbox/netbox/api/authentication.py b/netbox/netbox/api/authentication.py index f40141de4..3f223cf98 100644 --- a/netbox/netbox/api/authentication.py +++ b/netbox/netbox/api/authentication.py @@ -19,9 +19,11 @@ class TokenAuthentication(authentication.TokenAuthentication): except model.DoesNotExist: raise exceptions.AuthenticationFailed("Invalid token") - # Update last used. - token.last_used = timezone.now() - token.save() + # Update last used, but only once a minute. This reduces the write load on the db + timediff = timezone.now() - token.last_used + if timediff.total_seconds() > 60: + token.last_used = timezone.now() + token.save() # Enforce the Token's expiration time, if one has been set. if token.is_expired: From 5d868168a51e2a5864352c8518798eebe12d98ba Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Fri, 17 Jun 2022 14:58:20 +0200 Subject: [PATCH 118/593] Rename timediff to lasted_used_diff --- netbox/netbox/api/authentication.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/netbox/api/authentication.py b/netbox/netbox/api/authentication.py index 3f223cf98..fce9036aa 100644 --- a/netbox/netbox/api/authentication.py +++ b/netbox/netbox/api/authentication.py @@ -20,8 +20,8 @@ class TokenAuthentication(authentication.TokenAuthentication): raise exceptions.AuthenticationFailed("Invalid token") # Update last used, but only once a minute. This reduces the write load on the db - timediff = timezone.now() - token.last_used - if timediff.total_seconds() > 60: + last_used_diff = timezone.now() - token.last_used + if last_used_diff.total_seconds() > 60: token.last_used = timezone.now() token.save() From d32bbd06cf4ee86392724cdf4f3b66b05d2d96df Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Fri, 17 Jun 2022 15:52:12 +0200 Subject: [PATCH 119/593] Fix last_used=None error --- netbox/netbox/api/authentication.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/netbox/netbox/api/authentication.py b/netbox/netbox/api/authentication.py index fce9036aa..39008f366 100644 --- a/netbox/netbox/api/authentication.py +++ b/netbox/netbox/api/authentication.py @@ -20,8 +20,7 @@ class TokenAuthentication(authentication.TokenAuthentication): raise exceptions.AuthenticationFailed("Invalid token") # Update last used, but only once a minute. This reduces the write load on the db - last_used_diff = timezone.now() - token.last_used - if last_used_diff.total_seconds() > 60: + if not token.last_used or (timezone.now() - token.last_used).total_seconds() > 60: token.last_used = timezone.now() token.save() From 896ebf01b1dbc60dc68e3036940793ec28ebadab Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 17 Jun 2022 14:04:57 -0400 Subject: [PATCH 120/593] Changelog for #8704, #9533, #9374, #9466, #9537 --- docs/release-notes/version-3.2.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 05d798e54..93021320f 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -4,18 +4,23 @@ ### Enhancements +* [#8704](https://github.com/netbox-community/netbox/issues/8704) - Shift-click to select multiple objects in a list * [#8882](https://github.com/netbox-community/netbox/issues/8882) - Support filtering IP addresses by multiple parent prefixes * [#8893](https://github.com/netbox-community/netbox/issues/8893) - Include count of IP ranges under tenant view * [#9501](https://github.com/netbox-community/netbox/issues/9501) - Add support for custom Jinja2 filters +* [#9533](https://github.com/netbox-community/netbox/issues/9533) - Move Markdown reference to local documentation ### Bug Fixes +* [#9374](https://github.com/netbox-community/netbox/issues/9374) - Improve performance when retrieving devices/VMs with config context data +* [#9466](https://github.com/netbox-community/netbox/issues/9466) - Avoid sending webhooks after script/report failure * [#9480](https://github.com/netbox-community/netbox/issues/9480) - Fix sorting services & service templates by port numbers * [#9484](https://github.com/netbox-community/netbox/issues/9484) - Include services listening on "all IPs" under IP address view * [#9486](https://github.com/netbox-community/netbox/issues/9486) - Fix redirect URL when adding device components from the module view * [#9495](https://github.com/netbox-community/netbox/issues/9495) - Correct link to contacts in contact groups table column * [#9512](https://github.com/netbox-community/netbox/issues/9512) - Fix duplicate site results when searching by ASN * [#9524](https://github.com/netbox-community/netbox/issues/9524) - Correct order of VLAN fields under VM interface creation form +* [#9537](https://github.com/netbox-community/netbox/issues/9537) - Ensure consistent use of placeholder tag throughout UI --- From 2815eca260acba39486f1c027ff09ef543834e11 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 17 Jun 2022 14:36:55 -0400 Subject: [PATCH 121/593] Fixes #9503: Hyperlinks in ack elevation SVGs must always use absolute URLs --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/svg.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 93021320f..e69843198 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -18,6 +18,7 @@ * [#9484](https://github.com/netbox-community/netbox/issues/9484) - Include services listening on "all IPs" under IP address view * [#9486](https://github.com/netbox-community/netbox/issues/9486) - Fix redirect URL when adding device components from the module view * [#9495](https://github.com/netbox-community/netbox/issues/9495) - Correct link to contacts in contact groups table column +* [#9503](https://github.com/netbox-community/netbox/issues/9503) - Hyperlinks in ack elevation SVGs must always use absolute URLs * [#9512](https://github.com/netbox-community/netbox/issues/9512) - Fix duplicate site results when searching by ASN * [#9524](https://github.com/netbox-community/netbox/issues/9524) - Correct order of VLAN fields under VM interface creation form * [#9537](https://github.com/netbox-community/netbox/issues/9537) - Ensure consistent use of placeholder tag throughout UI diff --git a/netbox/dcim/svg.py b/netbox/dcim/svg.py index 7cd0fa417..1de68ec36 100644 --- a/netbox/dcim/svg.py +++ b/netbox/dcim/svg.py @@ -114,7 +114,7 @@ class RackElevationSVG: # Embed front device type image if one exists if self.include_images and device.device_type.front_image: image = drawing.image( - href=device.device_type.front_image.url, + href='{}{}'.format(self.base_url, device.device_type.front_image.url), insert=start, size=end, class_='device-image' @@ -140,7 +140,7 @@ class RackElevationSVG: # Embed rear device type image if one exists if self.include_images and device.device_type.rear_image: image = drawing.image( - href=device.device_type.rear_image.url, + href='{}{}'.format(self.base_url, device.device_type.rear_image.url), insert=start, size=end, class_='device-image' @@ -151,9 +151,9 @@ class RackElevationSVG: stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) link.add(drawing.text(get_device_name(device), insert=text, fill='white', class_='device-image-label')) - @staticmethod - def _draw_empty(drawing, rack, start, end, text, id_, face_id, class_, reservation): - link_url = '{}?{}'.format( + def _draw_empty(self, drawing, rack, start, end, text, id_, face_id, class_, reservation): + link_url = '{}{}?{}'.format( + self.base_url, reverse('dcim:device_add'), urlencode({ 'site': rack.site.pk, From 92a6523bf38babdfc4380bf900849f5cb4500e38 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 17 Jun 2022 14:40:37 -0400 Subject: [PATCH 122/593] Fixes #9549: Fix device counts for rack list under rack role view --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/views.py | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index e69843198..4e96145e0 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -22,6 +22,7 @@ * [#9512](https://github.com/netbox-community/netbox/issues/9512) - Fix duplicate site results when searching by ASN * [#9524](https://github.com/netbox-community/netbox/issues/9524) - Correct order of VLAN fields under VM interface creation form * [#9537](https://github.com/netbox-community/netbox/issues/9537) - Ensure consistent use of placeholder tag throughout UI +* [#9549](https://github.com/netbox-community/netbox/issues/9549) - Fix device counts for rack list under rack role view --- diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 57e8b1c79..35a1056b2 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -510,8 +510,8 @@ class RackRoleView(generic.ObjectView): queryset = RackRole.objects.all() def get_extra_context(self, request, instance): - racks = Rack.objects.restrict(request.user, 'view').filter( - role=instance + racks = Rack.objects.restrict(request.user, 'view').filter(role=instance).annotate( + device_count=count_related(Device, 'rack') ) racks_table = tables.RackTable(racks, user=request.user, exclude=( From e6018cd38fd3d186e52bc926e2891f412ca4bb66 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 17 Jun 2022 14:51:45 -0400 Subject: [PATCH 123/593] Closes #9534: Add VLAN group selector to interface bulk edit forms --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/forms/bulk_edit.py | 31 +++++++++++++++++++----- netbox/virtualization/forms/bulk_edit.py | 21 +++++++++++++--- 3 files changed, 43 insertions(+), 10 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 4e96145e0..40715c8d3 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -9,6 +9,7 @@ * [#8893](https://github.com/netbox-community/netbox/issues/8893) - Include count of IP ranges under tenant view * [#9501](https://github.com/netbox-community/netbox/issues/9501) - Add support for custom Jinja2 filters * [#9533](https://github.com/netbox-community/netbox/issues/9533) - Move Markdown reference to local documentation +* [#9534](https://github.com/netbox-community/netbox/issues/9534) - Add VLAN group selector to interface bulk edit forms ### Bug Fixes diff --git a/netbox/dcim/forms/bulk_edit.py b/netbox/dcim/forms/bulk_edit.py index 9e4f5e400..231d01ddd 100644 --- a/netbox/dcim/forms/bulk_edit.py +++ b/netbox/dcim/forms/bulk_edit.py @@ -6,7 +6,7 @@ from timezone_field import TimeZoneFormField from dcim.choices import * from dcim.constants import * from dcim.models import * -from ipam.models import ASN, VLAN, VRF +from ipam.models import ASN, VLAN, VLANGroup, VRF from netbox.forms import NetBoxModelBulkEditForm from tenancy.models import Tenant from utilities.forms import ( @@ -1067,13 +1067,32 @@ class InterfaceBulkEditForm( required=False, widget=BulkEditNullBooleanSelect ) + mode = forms.ChoiceField( + choices=add_blank_choice(InterfaceModeChoices), + required=False, + initial='', + widget=StaticSelect() + ) + vlan_group = DynamicModelChoiceField( + queryset=VLANGroup.objects.all(), + required=False, + label='VLAN group' + ) untagged_vlan = DynamicModelChoiceField( queryset=VLAN.objects.all(), - required=False + required=False, + query_params={ + 'group_id': '$vlan_group', + }, + label='Untagged VLAN' ) tagged_vlans = DynamicModelMultipleChoiceField( queryset=VLAN.objects.all(), - required=False + required=False, + query_params={ + 'group_id': '$vlan_group', + }, + label='Tagged VLANs' ) vrf = DynamicModelChoiceField( queryset=VRF.objects.all(), @@ -1087,13 +1106,13 @@ class InterfaceBulkEditForm( ('Addressing', ('vrf', 'mac_address', 'wwn')), ('Operation', ('mtu', 'tx_power', 'enabled', 'mgmt_only', 'mark_connected')), ('Related Interfaces', ('parent', 'bridge', 'lag')), - ('802.1Q Switching', ('mode', 'untagged_vlan', 'tagged_vlans')), + ('802.1Q Switching', ('mode', 'vlan_group', 'untagged_vlan', 'tagged_vlans')), ('Wireless', ('rf_role', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width')), ) nullable_fields = ( 'module', 'label', 'parent', 'bridge', 'lag', 'speed', 'duplex', 'mac_address', 'wwn', 'mtu', 'description', - 'mode', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'untagged_vlan', 'tagged_vlans', - 'vrf', + 'mode', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'vlan_group', 'untagged_vlan', + 'tagged_vlans', 'vrf', ) def __init__(self, *args, **kwargs): diff --git a/netbox/virtualization/forms/bulk_edit.py b/netbox/virtualization/forms/bulk_edit.py index d5d33df2a..4894d78cf 100644 --- a/netbox/virtualization/forms/bulk_edit.py +++ b/netbox/virtualization/forms/bulk_edit.py @@ -3,7 +3,7 @@ from django import forms from dcim.choices import InterfaceModeChoices from dcim.constants import INTERFACE_MTU_MAX, INTERFACE_MTU_MIN from dcim.models import DeviceRole, Platform, Region, Site, SiteGroup -from ipam.models import VLAN, VRF +from ipam.models import VLAN, VLANGroup, VRF from netbox.forms import NetBoxModelBulkEditForm from tenancy.models import Tenant from utilities.forms import ( @@ -182,13 +182,26 @@ class VMInterfaceBulkEditForm(NetBoxModelBulkEditForm): required=False, widget=StaticSelect() ) + vlan_group = DynamicModelChoiceField( + queryset=VLANGroup.objects.all(), + required=False, + label='VLAN group' + ) untagged_vlan = DynamicModelChoiceField( queryset=VLAN.objects.all(), - required=False + required=False, + query_params={ + 'group_id': '$vlan_group', + }, + label='Untagged VLAN' ) tagged_vlans = DynamicModelMultipleChoiceField( queryset=VLAN.objects.all(), - required=False + required=False, + query_params={ + 'group_id': '$vlan_group', + }, + label='Tagged VLANs' ) vrf = DynamicModelChoiceField( queryset=VRF.objects.all(), @@ -200,7 +213,7 @@ class VMInterfaceBulkEditForm(NetBoxModelBulkEditForm): fieldsets = ( (None, ('mtu', 'enabled', 'vrf', 'description')), ('Related Interfaces', ('parent', 'bridge')), - ('802.1Q Switching', ('mode', 'untagged_vlan', 'tagged_vlans')), + ('802.1Q Switching', ('mode', 'vlan_group', 'untagged_vlan', 'tagged_vlans')), ) nullable_fields = ( 'parent', 'bridge', 'mtu', 'vrf', 'description', From a6e285316aa2a873c642081442edf1ebce815b68 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Fri, 17 Jun 2022 22:53:51 +0200 Subject: [PATCH 124/593] Don't close select field when multiple select --- netbox/project-static/dist/netbox.js | Bin 376088 -> 376144 bytes netbox/project-static/dist/netbox.js.map | Bin 345522 -> 345564 bytes .../src/select/api/apiSelect.ts | 5 +++++ 3 files changed, 5 insertions(+) diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index ce02d4bbb227926941d2adc3ae38e721d48ce21b..bc0cabef08f2cab679e475fe18741c4e97ee187e 100644 GIT binary patch delta 60 zcmbR7OYFigv4$4L7N!>F7M3lnkK81a5{pyya!YecG7EB2)zmafGBS(xigPk^r!$(c QiZa_O8g9Ss#%fyz0LEk$X#fBK delta 25 hcmcccOKiq3v4$4L7N!>F7M3lnkKDFPxwD#;0RWK~3C#ci diff --git a/netbox/project-static/dist/netbox.js.map b/netbox/project-static/dist/netbox.js.map index e21571e0c84f1680154cb438612199fef77a0f4e..26bb1c514297c61a2e7d50a8863067ed8656e455 100644 GIT binary patch delta 101 zcmdngEqbS0w4sHug{g&k3ybc`Glu|1!MHP;dVu00d@ diff --git a/netbox/project-static/src/select/api/apiSelect.ts b/netbox/project-static/src/select/api/apiSelect.ts index 88b35a0e9..f5b605d58 100644 --- a/netbox/project-static/src/select/api/apiSelect.ts +++ b/netbox/project-static/src/select/api/apiSelect.ts @@ -205,6 +205,11 @@ export class APISelect { onChange: () => this.handleSlimChange(), }); + // Don't close on select if multiple select + if (this.base.multiple) { + this.slim.config.closeOnSelect = false; + } + // Initialize API query properties. this.getStaticParams(); this.getDynamicParams(); From 7c79c90cd2403d15f30a74a97892c5237ea213d4 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Fri, 17 Jun 2022 23:16:57 +0200 Subject: [PATCH 125/593] Sanitize HTML after rendering markdown --- base_requirements.txt | 4 +++ .../templatetags/builtins/filters.py | 19 ++++-------- netbox/utilities/utils.py | 31 +++++++++++++++++++ requirements.txt | 1 + 4 files changed, 42 insertions(+), 13 deletions(-) diff --git a/base_requirements.txt b/base_requirements.txt index 6bb537a6a..68fca9851 100644 --- a/base_requirements.txt +++ b/base_requirements.txt @@ -125,3 +125,7 @@ tablib # Timezone data (required by django-timezone-field on Python 3.9+) # https://github.com/python/tzdata tzdata + +# HTML sanitizer +# https://github.com/mozilla/bleach +bleach \ No newline at end of file diff --git a/netbox/utilities/templatetags/builtins/filters.py b/netbox/utilities/templatetags/builtins/filters.py index 44ad5ac47..738dc0e00 100644 --- a/netbox/utilities/templatetags/builtins/filters.py +++ b/netbox/utilities/templatetags/builtins/filters.py @@ -11,7 +11,7 @@ from markdown import markdown from netbox.config import get_config from utilities.markdown import StrikethroughExtension -from utilities.utils import foreground_color +from utilities.utils import clean_html, foreground_color register = template.Library() @@ -144,18 +144,6 @@ def render_markdown(value): {{ md_source_text|markdown }} """ - schemes = '|'.join(get_config().ALLOWED_URL_SCHEMES) - - # Strip HTML tags - value = strip_tags(value) - - # Sanitize Markdown links - pattern = fr'\[([^\]]+)\]\(\s*(?!({schemes})).*:(.+)\)' - value = re.sub(pattern, '[\\1](\\3)', value, flags=re.IGNORECASE) - - # Sanitize Markdown reference links - pattern = fr'\[([^\]]+)\]:\s*(?!({schemes}))\w*:(.+)' - value = re.sub(pattern, '[\\1]: \\3', value, flags=re.IGNORECASE) # Render Markdown html = markdown(value, extensions=['def_list', 'fenced_code', 'tables', StrikethroughExtension()]) @@ -164,6 +152,11 @@ def render_markdown(value): if html: html = f'
      {html}
      ' + schemes = get_config().ALLOWED_URL_SCHEMES + + # Sanitize HTML + html = clean_html(html, schemes) + return mark_safe(html) diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index bc6d928ed..2b939471c 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -4,6 +4,7 @@ from collections import OrderedDict from decimal import Decimal from itertools import count, groupby +import bleach from django.core.serializers import serialize from django.db.models import Count, OuterRef, Subquery from django.db.models.functions import Coalesce @@ -385,3 +386,33 @@ def copy_safe_request(request): 'path': request.path, 'id': getattr(request, 'id', None), # UUID assigned by middleware }) + + +def clean_html(html, schemes): + """ + Sanitizes HTML based on a whitelist of allowed tags and attributes. + Also takes a list of allowed URI schemes. + """ + + ALLOWED_TAGS = [ + "div", "pre", "code", "blockquote", "del", + "hr", "h1", "h2", "h3", "h4", "h5", "h6", + "ul", "ol", "li", "p", "br", + "strong", "em", "a", "b", "i", "img", + "table", "thead", "tbody", "tr", "th", "td", + "dl", "dt", "dd", + ] + + ALLOWED_ATTRIBUTES = { + "div": ['class'], + "h1": ["id"], "h2": ["id"], "h3": ["id"], "h4": ["id"], "h5": ["id"], "h6": ["id"], + "a": ["href", "title"], + "img": ["src", "title", "alt"], + } + + return bleach.clean( + html, + tags=ALLOWED_TAGS, + attributes=ALLOWED_ATTRIBUTES, + protocols=schemes + ) diff --git a/requirements.txt b/requirements.txt index 293a33542..dbe7d70c2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ +bleach==5.0.0 Django==4.0.4 django-cors-headers==3.12.0 django-debug-toolbar==3.2.4 From 3d785d836d1cc9f9e84ec305b80669e22d47ef19 Mon Sep 17 00:00:00 2001 From: Hunter Johnston Date: Sat, 18 Jun 2022 23:05:18 -0400 Subject: [PATCH 126/593] Implemented feature #9525 --- netbox/netbox/tables/tables.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index 8c5fb039c..b2bf6e967 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -165,7 +165,14 @@ class NetBoxTable(BaseTable): linkify=True, verbose_name='ID' ) - actions = columns.ActionsColumn() + actions = columns.ActionsColumn( + extra_buttons=""" + + + + + """ + ) exempt_columns = ('pk', 'actions') From b1ec703ba9dd254b8a7edd5f0c294de56323e495 Mon Sep 17 00:00:00 2001 From: Hunter Johnston Date: Sat, 18 Jun 2022 23:08:06 -0400 Subject: [PATCH 127/593] Implemented feature #9525 --- netbox/netbox/tables/tables.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index b2bf6e967..de73bf6fe 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -167,10 +167,7 @@ class NetBoxTable(BaseTable): ) actions = columns.ActionsColumn( extra_buttons=""" - - - - + """ ) From f8221340af52b776e6dd972897bc6d491cb0775a Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Sun, 19 Jun 2022 12:40:52 +0200 Subject: [PATCH 128/593] Disable token last_used update when in Maint mode --- netbox/netbox/api/authentication.py | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/netbox/netbox/api/authentication.py b/netbox/netbox/api/authentication.py index 39008f366..e98376899 100644 --- a/netbox/netbox/api/authentication.py +++ b/netbox/netbox/api/authentication.py @@ -1,8 +1,11 @@ +import logging + from django.conf import settings from django.utils import timezone from rest_framework import authentication, exceptions from rest_framework.permissions import BasePermission, DjangoObjectPermissions, SAFE_METHODS +from netbox.config import get_config from users.models import Token @@ -20,9 +23,15 @@ class TokenAuthentication(authentication.TokenAuthentication): raise exceptions.AuthenticationFailed("Invalid token") # Update last used, but only once a minute. This reduces the write load on the db - if not token.last_used or (timezone.now() - token.last_used).total_seconds() > 60: - token.last_used = timezone.now() - token.save() + if not token.last_used or (timezone.now() - token.last_used).total_seconds() > 6: + # If maintenance mode is enabled, assume the database is read-only, and disable updating the token's + # last_used time upon authentication. + if get_config().MAINTENANCE_MODE: + logger = logging.getLogger('netbox.auth.login') + logger.warning("Maintenance mode enabled: disabling update of token's last used timestamp") + else: + token.last_used = timezone.now() + token.save() # Enforce the Token's expiration time, if one has been set. if token.is_expired: From ae342a0506c627e3b23196ce49940b60b94f54f5 Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Sun, 19 Jun 2022 12:41:44 +0200 Subject: [PATCH 129/593] Correct delay time from 6 to 60 seconds --- netbox/netbox/api/authentication.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/api/authentication.py b/netbox/netbox/api/authentication.py index e98376899..847bcbfd9 100644 --- a/netbox/netbox/api/authentication.py +++ b/netbox/netbox/api/authentication.py @@ -23,7 +23,7 @@ class TokenAuthentication(authentication.TokenAuthentication): raise exceptions.AuthenticationFailed("Invalid token") # Update last used, but only once a minute. This reduces the write load on the db - if not token.last_used or (timezone.now() - token.last_used).total_seconds() > 6: + if not token.last_used or (timezone.now() - token.last_used).total_seconds() > 60: # If maintenance mode is enabled, assume the database is read-only, and disable updating the token's # last_used time upon authentication. if get_config().MAINTENANCE_MODE: From 81cea9b9d9b86b945052d58c83341e189a58abb3 Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Sun, 19 Jun 2022 13:03:03 +0200 Subject: [PATCH 130/593] Show LastUsed in /user/api-tokens/ --- netbox/templates/users/api_tokens.html | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/netbox/templates/users/api_tokens.html b/netbox/templates/users/api_tokens.html index 01ffec23a..a019cbd1f 100644 --- a/netbox/templates/users/api_tokens.html +++ b/netbox/templates/users/api_tokens.html @@ -22,11 +22,11 @@
      -
      +
      Created
      {{ token.created|annotated_date }}
      -
      +
      Expires
      {% if token.expires %} {{ token.expires|annotated_date }} @@ -34,7 +34,15 @@ Never {% endif %}
      -
      +
      + Last Used
      + {% if token.last_used %} + {{ token.last_used|annotated_date }} + {% else %} + Never + {% endif %} +
      +
      Create/Edit/Delete Operations
      {% if token.write_enabled %} Enabled From ff2ccfd6707b895be5fbeb602dc969700eda17c3 Mon Sep 17 00:00:00 2001 From: Hunter Johnston Date: Sun, 19 Jun 2022 19:12:52 -0400 Subject: [PATCH 131/593] Closes #9525: Added split button functionality to ActionsColumn --- netbox/netbox/tables/columns.py | 43 ++++++++++++++++++++++++++------- netbox/netbox/tables/tables.py | 6 +---- 2 files changed, 35 insertions(+), 14 deletions(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index e82e8a1ea..9067b13f2 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -175,6 +175,7 @@ class ActionsColumn(tables.Column): :param actions: The ordered list of dropdown menu items to include :param extra_buttons: A Django template string which renders additional buttons preceding the actions dropdown + :param split_actions: When True, converts the actions dropdown menu into a split button with first action as the direct button link and icon (default: True) """ attrs = {'td': {'class': 'text-end text-nowrap noprint'}} empty_values = () @@ -184,10 +185,11 @@ class ActionsColumn(tables.Column): 'changelog': ActionsItem('Changelog', 'history'), } - def __init__(self, *args, actions=('edit', 'delete', 'changelog'), extra_buttons='', **kwargs): + def __init__(self, *args, actions=('edit', 'delete', 'changelog'), extra_buttons='', split_actions=True, **kwargs): super().__init__(*args, **kwargs) self.extra_buttons = extra_buttons + self.split_actions = split_actions # Determine which actions to enable self.actions = { @@ -210,19 +212,42 @@ class ActionsColumn(tables.Column): # Compile actions menu links = [] user = getattr(request, 'user', AnonymousUser()) - for action, attrs in self.actions.items(): + for idx, (action, attrs) in enumerate(self.actions.items()): permission = f'{model._meta.app_label}.{attrs.permission}_{model._meta.model_name}' if attrs.permission is None or user.has_perm(permission): url = reverse(get_viewname(model, action), kwargs={'pk': record.pk}) - links.append( - f'
    • ' - f' {attrs.title}
      • ' - ) + + # If only a single action exists, render a regular button + if len(self.actions.items()) == 1: + html += ( + f'' + f'' + ) + + # Creates split button for the first action with direct link and icon + elif self.split_actions and idx == 0: + html += ( + f'' + f'' + f'' + ) + + # Creates standard action dropdown menu items + else: + links.append( + f'
    • ' + f' {attrs.title}
      • ' + ) + + # Create the actions dropdown menu if links: + dropdown_icon = '' if self.split_actions else '' + dropdown_class = '' if self.split_actions else '' html += ( - f'' - f'' - f'' + f'{dropdown_class}' + f'' + f'{dropdown_icon}' + f'' f'
        {"".join(links)}
      ' ) diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index de73bf6fe..8c5fb039c 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -165,11 +165,7 @@ class NetBoxTable(BaseTable): linkify=True, verbose_name='ID' ) - actions = columns.ActionsColumn( - extra_buttons=""" - - """ - ) + actions = columns.ActionsColumn() exempt_columns = ('pk', 'actions') From 65683d0df1bfb9da5ab904937acfe1ba84302e3d Mon Sep 17 00:00:00 2001 From: Hunter Johnston Date: Sun, 19 Jun 2022 20:00:15 -0400 Subject: [PATCH 132/593] Closes #9417: Pre-populate manufacturer when adding modules to devices --- netbox/dcim/tables/template_code.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index 92739c6ed..7124c2b1f 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -385,7 +385,7 @@ MODULEBAY_BUTTONS = """ {% else %} - + {% endif %} From e7620b0dd08b1f9ce16874a10e0e0accbf5a9284 Mon Sep 17 00:00:00 2001 From: Hunter Johnston Date: Sun, 19 Jun 2022 22:10:01 -0400 Subject: [PATCH 133/593] Closes #9517: Linkify Power Port on Power Outlet Object View --- netbox/templates/dcim/poweroutlet.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/templates/dcim/poweroutlet.html b/netbox/templates/dcim/poweroutlet.html index 6408bc759..c312bee03 100644 --- a/netbox/templates/dcim/poweroutlet.html +++ b/netbox/templates/dcim/poweroutlet.html @@ -44,7 +44,7 @@
      - + From 10cb4f359a837eeca167b34e8a672a2c632a8902 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 20 Jun 2022 08:06:49 -0400 Subject: [PATCH 134/593] Changelog for #9417, #9517, #9525 --- docs/release-notes/version-3.2.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 40715c8d3..66a9cdf66 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -7,7 +7,10 @@ * [#8704](https://github.com/netbox-community/netbox/issues/8704) - Shift-click to select multiple objects in a list * [#8882](https://github.com/netbox-community/netbox/issues/8882) - Support filtering IP addresses by multiple parent prefixes * [#8893](https://github.com/netbox-community/netbox/issues/8893) - Include count of IP ranges under tenant view +* [#9417](https://github.com/netbox-community/netbox/issues/9417) - Initialize manufacturer selection when inserting a new module * [#9501](https://github.com/netbox-community/netbox/issues/9501) - Add support for custom Jinja2 filters +* [#9517](https://github.com/netbox-community/netbox/issues/9517) - Linkify related power port on power outlet view +* [#9525](https://github.com/netbox-community/netbox/issues/9525) - Provide one-click edit link for objects in tables * [#9533](https://github.com/netbox-community/netbox/issues/9533) - Move Markdown reference to local documentation * [#9534](https://github.com/netbox-community/netbox/issues/9534) - Add VLAN group selector to interface bulk edit forms From 903a3e1a9c162953389797d48106f8e2b7e1400f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 20 Jun 2022 08:34:05 -0400 Subject: [PATCH 135/593] Changelog for #8944, #9108, #9556 --- docs/release-notes/version-3.2.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 66a9cdf66..a491f4524 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -13,9 +13,12 @@ * [#9525](https://github.com/netbox-community/netbox/issues/9525) - Provide one-click edit link for objects in tables * [#9533](https://github.com/netbox-community/netbox/issues/9533) - Move Markdown reference to local documentation * [#9534](https://github.com/netbox-community/netbox/issues/9534) - Add VLAN group selector to interface bulk edit forms +* [#9556](https://github.com/netbox-community/netbox/issues/9556) - Leave dropdown open upon selection for multi-select fields ### Bug Fixes +* [#8944](https://github.com/netbox-community/netbox/issues/8944) - Fix rendering of Markdown links with colons +* [#9108](https://github.com/netbox-community/netbox/issues/9108) - Fix rendering of bracketed Markdown links * [#9374](https://github.com/netbox-community/netbox/issues/9374) - Improve performance when retrieving devices/VMs with config context data * [#9466](https://github.com/netbox-community/netbox/issues/9466) - Avoid sending webhooks after script/report failure * [#9480](https://github.com/netbox-community/netbox/issues/9480) - Fix sorting services & service templates by port numbers From d691ea92d09be00b6390caef1c9aff9705b411ce Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 20 Jun 2022 09:44:59 -0400 Subject: [PATCH 136/593] #9525: Add button colors --- netbox/netbox/tables/columns.py | 58 ++++++++++++++++++--------------- 1 file changed, 32 insertions(+), 26 deletions(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index 9067b13f2..7da241566 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -166,6 +166,7 @@ class ActionsItem: title: str icon: str permission: Optional[str] = None + css_class: Optional[str] = 'secondary' class ActionsColumn(tables.Column): @@ -175,13 +176,14 @@ class ActionsColumn(tables.Column): :param actions: The ordered list of dropdown menu items to include :param extra_buttons: A Django template string which renders additional buttons preceding the actions dropdown - :param split_actions: When True, converts the actions dropdown menu into a split button with first action as the direct button link and icon (default: True) + :param split_actions: When True, converts the actions dropdown menu into a split button with first action as the + direct button link and icon (default: True) """ attrs = {'td': {'class': 'text-end text-nowrap noprint'}} empty_values = () actions = { - 'edit': ActionsItem('Edit', 'pencil', 'change'), - 'delete': ActionsItem('Delete', 'trash-can-outline', 'delete'), + 'edit': ActionsItem('Edit', 'pencil', 'change', 'warning'), + 'delete': ActionsItem('Delete', 'trash-can-outline', 'delete', 'danger'), 'changelog': ActionsItem('Changelog', 'history'), } @@ -210,45 +212,49 @@ class ActionsColumn(tables.Column): html = '' # Compile actions menu - links = [] + button = None + dropdown_class = 'secondary' + dropdown_links = [] user = getattr(request, 'user', AnonymousUser()) for idx, (action, attrs) in enumerate(self.actions.items()): permission = f'{model._meta.app_label}.{attrs.permission}_{model._meta.model_name}' if attrs.permission is None or user.has_perm(permission): url = reverse(get_viewname(model, action), kwargs={'pk': record.pk}) - # If only a single action exists, render a regular button - if len(self.actions.items()) == 1: - html += ( - f'' + # Render a separate button if a) only one action exists, or b) if split_actions is True + if len(self.actions) == 1 or (self.split_actions and idx == 0): + dropdown_class = attrs.css_class + button = ( + f'' f'' ) - # Creates split button for the first action with direct link and icon - elif self.split_actions and idx == 0: - html += ( - f'' - f'' - f'' - ) - - # Creates standard action dropdown menu items + # Add dropdown menu items else: - links.append( + dropdown_links.append( f'
    • ' f' {attrs.title}
      • ' ) # Create the actions dropdown menu - if links: - dropdown_icon = '' if self.split_actions else '' - dropdown_class = '' if self.split_actions else '' + if button and dropdown_links: html += ( - f'{dropdown_class}' - f'' - f'{dropdown_icon}' - f'' - f'
        {"".join(links)}
      ' + f'' + f' {button}' + f' ' + f' ' + f'
        {"".join(dropdown_links)}
      ' + f'      ' + ) + elif button: + html += button + elif dropdown_links: + html += ( + f'' + f' ' + f' ' + f'
        {"".join(dropdown_links)}
      ' + f'      ' ) # Render any extra buttons from template code From 8074ca95bd279169dc8283fdc4e2621fd02eab9a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 20 Jun 2022 11:17:15 -0400 Subject: [PATCH 137/593] Closes #9453: Disable default loggers when running tests --- netbox/netbox/configuration_testing.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/netbox/netbox/configuration_testing.py b/netbox/netbox/configuration_testing.py index 59529b80c..621671f04 100644 --- a/netbox/netbox/configuration_testing.py +++ b/netbox/netbox/configuration_testing.py @@ -36,3 +36,8 @@ REDIS = { } SECRET_KEY = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789' + +LOGGING = { + 'version': 1, + 'disable_existing_loggers': True +} From 7ba268946a5678477cd22ae05cfe8e3f4ccd8950 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 20 Jun 2022 11:22:36 -0400 Subject: [PATCH 138/593] Release v3.2.5 --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 2 +- base_requirements.txt | 3 ++- docs/release-notes/version-3.2.md | 2 +- netbox/netbox/settings.py | 2 +- requirements.txt | 12 ++++++------ 6 files changed, 12 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index a9af9c653..3b87a49e4 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.4 + placeholder: v3.2.5 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 1fff99f1d..1fc0268ab 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.4 + placeholder: v3.2.5 validations: required: true - type: dropdown diff --git a/base_requirements.txt b/base_requirements.txt index 68fca9851..98d3f78c2 100644 --- a/base_requirements.txt +++ b/base_requirements.txt @@ -44,7 +44,8 @@ django-tables2 # User-defined tags for objects # https://github.com/alex/django-taggit -django-taggit +# Will evaluate v3.0 during NetBox v3.3 beta +django-taggit>=2.1.0,<3.0 # A Django field for representing time zones # https://github.com/mfogel/django-timezone-field/ diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index a491f4524..bb5182702 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.5 (FUTURE) +## v3.2.5 (2022-06-20) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index f30dea4d7..f86f3a8f2 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.5-dev' +VERSION = '3.2.5' # Hostname HOSTNAME = platform.node() diff --git a/requirements.txt b/requirements.txt index dbe7d70c2..1fdace4f0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,8 @@ bleach==5.0.0 -Django==4.0.4 -django-cors-headers==3.12.0 -django-debug-toolbar==3.2.4 -django-filter==21.1 +Django==4.0.5 +django-cors-headers==3.13.0 +django-debug-toolbar==3.4.0 +django-filter==22.1 django-graphiql-debug-toolbar==0.2.0 django-mptt==0.13.4 django-pglocks==1.0.4 @@ -19,7 +19,7 @@ gunicorn==20.1.0 Jinja2==3.1.2 Markdown==3.3.7 markdown-include==0.6.0 -mkdocs-material==8.2.16 +mkdocs-material==8.3.6 mkdocstrings[python-legacy]==0.19.0 netaddr==0.8.0 Pillow==9.1.1 @@ -27,7 +27,7 @@ psycopg2-binary==2.9.3 PyYAML==6.0 sentry-sdk==1.5.12 social-auth-app-django==5.0.0 -social-auth-core==4.2.0 +social-auth-core==4.3.0 svgwrite==1.4.2 tablib==3.2.1 tzdata==2022.1 From 575e2c443bf19e427c1f229f97eaa8a16d141e61 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 20 Jun 2022 11:38:49 -0400 Subject: [PATCH 139/593] PRVB --- docs/release-notes/version-3.2.md | 6 +++++- netbox/netbox/settings.py | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index bb5182702..059fc8924 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.6 (FUTURE) + +--- + ## v3.2.5 (2022-06-20) ### Enhancements @@ -25,7 +29,7 @@ * [#9484](https://github.com/netbox-community/netbox/issues/9484) - Include services listening on "all IPs" under IP address view * [#9486](https://github.com/netbox-community/netbox/issues/9486) - Fix redirect URL when adding device components from the module view * [#9495](https://github.com/netbox-community/netbox/issues/9495) - Correct link to contacts in contact groups table column -* [#9503](https://github.com/netbox-community/netbox/issues/9503) - Hyperlinks in ack elevation SVGs must always use absolute URLs +* [#9503](https://github.com/netbox-community/netbox/issues/9503) - Hyperlinks in rack elevation SVGs must always use absolute URLs * [#9512](https://github.com/netbox-community/netbox/issues/9512) - Fix duplicate site results when searching by ASN * [#9524](https://github.com/netbox-community/netbox/issues/9524) - Correct order of VLAN fields under VM interface creation form * [#9537](https://github.com/netbox-community/netbox/issues/9537) - Ensure consistent use of placeholder tag throughout UI diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index f86f3a8f2..b2e1eca6c 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.5' +VERSION = '3.2.6-dev' # Hostname HOSTNAME = platform.node() From 84f056171286d18c1c14a2fc9d28155a7dcf169a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 9 Jun 2022 17:27:58 -0400 Subject: [PATCH 140/593] Initial work on half-height RUs --- docs/release-notes/version-3.3.md | 11 ++ netbox/dcim/api/serializers.py | 24 ++- netbox/dcim/forms/models.py | 2 +- .../migrations/0154_half_height_rack_units.py | 23 +++ netbox/dcim/models/devices.py | 12 +- netbox/dcim/models/racks.py | 56 +++--- netbox/dcim/svg.py | 175 ++++++++++-------- netbox/dcim/tests/test_api.py | 8 +- netbox/dcim/tests/test_models.py | 31 +++- netbox/utilities/forms/utils.py | 1 - netbox/utilities/utils.py | 16 ++ 11 files changed, 232 insertions(+), 127 deletions(-) create mode 100644 netbox/dcim/migrations/0154_half_height_rack_units.py diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 514a92e88..229509b9c 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -4,8 +4,13 @@ ### Breaking Changes +* Device position and rack unit values are now reported as decimals (e.g. `1.0` or `1.5`) to support modeling half-height rack units. * The `nat_outside` relation on the IP address model now returns a list of zero or more related IP addresses, rather than a single instance (or None). +### New Features + +#### Half-Height Rack Units ([#51](https://github.com/netbox-community/netbox/issues/51)) + ### Enhancements * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses @@ -23,6 +28,12 @@ ### REST API Changes +* dcim.Device + * The `position` field has been changed from an integer to a decimal +* dcim.DeviceType + * The `u_height` field has been changed from an integer to a decimal +* dcim.Rack + * The `elevation` endpoint now includes half-height rack units, and utilizes decimal values for the ID and name of each unit * extras.CustomField * Added `group_name` and `ui_visibility` fields * ipam.IPAddress diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 7fcab6ba3..ba7f661b5 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -1,3 +1,5 @@ +import decimal + from django.contrib.contenttypes.models import ContentType from drf_yasg.utils import swagger_serializer_method from rest_framework import serializers @@ -201,7 +203,11 @@ class RackUnitSerializer(serializers.Serializer): """ A rack unit is an abstraction formed by the set (rack, position, face); it does not exist as a row in the database. """ - id = serializers.IntegerField(read_only=True) + id = serializers.DecimalField( + max_digits=4, + decimal_places=1, + read_only=True + ) name = serializers.CharField(read_only=True) face = ChoiceField(choices=DeviceFaceChoices, read_only=True) device = NestedDeviceSerializer(read_only=True) @@ -283,6 +289,13 @@ class ManufacturerSerializer(NetBoxModelSerializer): class DeviceTypeSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:devicetype-detail') manufacturer = NestedManufacturerSerializer() + u_height = serializers.DecimalField( + max_digits=4, + decimal_places=1, + label='Position (U)', + min_value=decimal.Decimal(0.5), + default=1.0 + ) subdevice_role = ChoiceField(choices=SubdeviceRoleChoices, allow_blank=True, required=False) airflow = ChoiceField(choices=DeviceAirflowChoices, allow_blank=True, required=False) device_count = serializers.IntegerField(read_only=True) @@ -589,7 +602,14 @@ class DeviceSerializer(NetBoxModelSerializer): location = NestedLocationSerializer(required=False, allow_null=True, default=None) rack = NestedRackSerializer(required=False, allow_null=True, default=None) face = ChoiceField(choices=DeviceFaceChoices, allow_blank=True, default='') - position = serializers.IntegerField(allow_null=True, label='Position (U)', min_value=1, default=None) + position = serializers.DecimalField( + max_digits=4, + decimal_places=1, + allow_null=True, + label='Position (U)', + min_value=decimal.Decimal(0.5), + default=None + ) status = ChoiceField(choices=DeviceStatusChoices, required=False) airflow = ChoiceField(choices=DeviceAirflowChoices, allow_blank=True, required=False) primary_ip = NestedIPAddressSerializer(read_only=True) diff --git a/netbox/dcim/forms/models.py b/netbox/dcim/forms/models.py index 179893219..fe461b061 100644 --- a/netbox/dcim/forms/models.py +++ b/netbox/dcim/forms/models.py @@ -467,7 +467,7 @@ class DeviceForm(TenancyForm, NetBoxModelForm): 'location_id': '$location', } ) - position = forms.IntegerField( + position = forms.DecimalField( required=False, help_text="The lowest-numbered unit occupied by the device", widget=APISelect( diff --git a/netbox/dcim/migrations/0154_half_height_rack_units.py b/netbox/dcim/migrations/0154_half_height_rack_units.py new file mode 100644 index 000000000..dd21fddcf --- /dev/null +++ b/netbox/dcim/migrations/0154_half_height_rack_units.py @@ -0,0 +1,23 @@ +import django.contrib.postgres.fields +import django.core.validators +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0153_created_datetimefield'), + ] + + operations = [ + migrations.AlterField( + model_name='devicetype', + name='u_height', + field=models.DecimalField(decimal_places=1, default=1.0, max_digits=4), + ), + migrations.AlterField( + model_name='device', + name='position', + field=models.DecimalField(blank=True, decimal_places=1, max_digits=4, null=True, validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(99.5)]), + ), + ] diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index e88af2d05..14147f388 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -99,8 +99,10 @@ class DeviceType(NetBoxModel): blank=True, help_text='Discrete part number (optional)' ) - u_height = models.PositiveSmallIntegerField( - default=1, + u_height = models.DecimalField( + max_digits=4, + decimal_places=1, + default=1.0, verbose_name='Height (U)' ) is_full_depth = models.BooleanField( @@ -654,10 +656,12 @@ class Device(NetBoxModel, ConfigContextModel): blank=True, null=True ) - position = models.PositiveSmallIntegerField( + position = models.DecimalField( + max_digits=4, + decimal_places=1, blank=True, null=True, - validators=[MinValueValidator(1)], + validators=[MinValueValidator(1), MaxValueValidator(99.5)], verbose_name='Position (U)', help_text='The lowest-numbered unit occupied by the device' ) diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index 81d699b11..f963fb396 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -1,4 +1,4 @@ -from collections import OrderedDict +import decimal from django.contrib.auth.models import User from django.contrib.contenttypes.fields import GenericRelation @@ -13,11 +13,10 @@ from django.urls import reverse from dcim.choices import * from dcim.constants import * from dcim.svg import RackElevationSVG -from netbox.config import get_config from netbox.models import OrganizationalModel, NetBoxModel from utilities.choices import ColorChoices from utilities.fields import ColorField, NaturalOrderingField -from utilities.utils import array_to_string +from utilities.utils import array_to_string, drange from .device_components import PowerOutlet, PowerPort from .devices import Device from .power import PowerFeed @@ -242,10 +241,13 @@ class Rack(NetBoxModel): @property def units(self): + """ + Return a list of unit numbers, top to bottom. + """ + max_position = self.u_height + decimal.Decimal(0.5) if self.desc_units: - return range(1, self.u_height + 1) - else: - return reversed(range(1, self.u_height + 1)) + drange(0.5, max_position, 0.5) + return drange(max_position, 0.5, -0.5) def get_status_color(self): return RackStatusChoices.colors.get(self.status) @@ -263,12 +265,12 @@ class Rack(NetBoxModel): reference to the device. When False, only the bottom most unit for a device is included and that unit contains a height attribute for the device """ - - elevation = OrderedDict() + elevation = {} for u in self.units: + u_name = f'U{u}'.split('.')[0] if not u % 1 else f'U{u}' elevation[u] = { 'id': u, - 'name': f'U{u}', + 'name': u_name, 'face': face, 'device': None, 'occupied': False @@ -278,7 +280,7 @@ class Rack(NetBoxModel): if self.pk: # Retrieve all devices installed within the rack - queryset = Device.objects.prefetch_related( + devices = Device.objects.prefetch_related( 'device_type', 'device_type__manufacturer', 'device_role' @@ -299,9 +301,9 @@ class Rack(NetBoxModel): if user is not None: permitted_device_ids = self.devices.restrict(user, 'view').values_list('pk', flat=True) - for device in queryset: + for device in devices: if expand_devices: - for u in range(device.position, device.position + device.device_type.u_height): + for u in drange(device.position, device.position + device.device_type.u_height, 0.5): if user is None or device.pk in permitted_device_ids: elevation[u]['device'] = device elevation[u]['occupied'] = True @@ -310,8 +312,6 @@ class Rack(NetBoxModel): elevation[device.position]['device'] = device elevation[device.position]['occupied'] = True elevation[device.position]['height'] = device.device_type.u_height - for u in range(device.position + 1, device.position + device.device_type.u_height): - elevation.pop(u, None) return [u for u in elevation.values()] @@ -331,12 +331,12 @@ class Rack(NetBoxModel): devices = devices.exclude(pk__in=exclude) # Initialize the rack unit skeleton - units = list(range(1, self.u_height + 1)) + units = list(self.units) # Remove units consumed by installed devices for d in devices: if rack_face is None or d.face == rack_face or d.device_type.is_full_depth: - for u in range(d.position, d.position + d.device_type.u_height): + for u in drange(d.position, d.position + d.device_type.u_height, 0.5): try: units.remove(u) except ValueError: @@ -346,7 +346,7 @@ class Rack(NetBoxModel): # Remove units without enough space above them to accommodate a device of the specified height available_units = [] for u in units: - if set(range(u, u + u_height)).issubset(units): + if set(drange(u, u + u_height, 0.5)).issubset(units): available_units.append(u) return list(reversed(available_units)) @@ -356,9 +356,9 @@ class Rack(NetBoxModel): Return a dictionary mapping all reserved units within the rack to their reservation. """ reserved_units = {} - for r in self.reservations.all(): - for u in r.units: - reserved_units[u] = r + for reservation in self.reservations.all(): + for u in reservation.units: + reserved_units[u] = reservation return reserved_units def get_elevation_svg( @@ -384,13 +384,17 @@ class Rack(NetBoxModel): :param include_images: Embed front/rear device images where available :param base_url: Base URL for links and images. If none, URLs will be relative. """ - elevation = RackElevationSVG(self, user=user, include_images=include_images, base_url=base_url) - if unit_width is None or unit_height is None: - config = get_config() - unit_width = unit_width or config.RACK_ELEVATION_DEFAULT_UNIT_WIDTH - unit_height = unit_height or config.RACK_ELEVATION_DEFAULT_UNIT_HEIGHT + elevation = RackElevationSVG( + self, + unit_width=unit_width, + unit_height=unit_height, + legend_width=legend_width, + user=user, + include_images=include_images, + base_url=base_url + ) - return elevation.render(face, unit_width, unit_height, legend_width) + return elevation.render(face) def get_0u_devices(self): return self.devices.filter(position=0) diff --git a/netbox/dcim/svg.py b/netbox/dcim/svg.py index 1de68ec36..dfb788e38 100644 --- a/netbox/dcim/svg.py +++ b/netbox/dcim/svg.py @@ -1,3 +1,4 @@ +import decimal import svgwrite from svgwrite.container import Group, Hyperlink from svgwrite.shapes import Line, Rect @@ -7,6 +8,7 @@ from django.conf import settings from django.urls import reverse from django.utils.http import urlencode +from netbox.config import get_config from utilities.utils import foreground_color from .choices import DeviceFaceChoices from .constants import RACK_ELEVATION_BORDER_WIDTH @@ -36,13 +38,17 @@ class RackElevationSVG: :param include_images: If true, the SVG document will embed front/rear device face images, where available :param base_url: Base URL for links within the SVG document. If none, links will be relative. """ - def __init__(self, rack, user=None, include_images=True, base_url=None): + def __init__(self, rack, unit_height=None, unit_width=None, legend_width=None, user=None, include_images=True, + base_url=None): self.rack = rack self.include_images = include_images - if base_url is not None: - self.base_url = base_url.rstrip('/') - else: - self.base_url = '' + self.base_url = base_url.rstrip('/') if base_url is not None else '' + + # Set drawing dimensions + config = get_config() + self.unit_width = unit_width or config.RACK_ELEVATION_DEFAULT_UNIT_WIDTH + self.unit_height = unit_height or config.RACK_ELEVATION_DEFAULT_UNIT_HEIGHT + self.legend_width = legend_width or config.RACK_ELEVATION_LEGEND_WIDTH_DEFAULT # Determine the subset of devices within this rack that are viewable by the user, if any permitted_devices = self.rack.devices @@ -78,15 +84,16 @@ class RackElevationSVG: gradient.add_stop_color(offset='100%', color=color) drawing.defs.add(gradient) - @staticmethod - def _setup_drawing(width, height): + def _setup_drawing(self): + width = self.unit_width + self.legend_width + RACK_ELEVATION_BORDER_WIDTH * 2 + height = self.unit_height * self.rack.u_height + RACK_ELEVATION_BORDER_WIDTH * 2 drawing = svgwrite.Drawing(size=(width, height)) - # add the stylesheet + # Add the stylesheet with open('{}/rack_elevation.css'.format(settings.STATIC_ROOT)) as css_file: drawing.defs.add(drawing.style(css_file.read())) - # add gradients + # Add gradients RackElevationSVG._add_gradient(drawing, 'reserved', '#c7c7ff') RackElevationSVG._add_gradient(drawing, 'occupied', '#d7d7d7') RackElevationSVG._add_gradient(drawing, 'blocked', '#ffc0c0') @@ -151,7 +158,7 @@ class RackElevationSVG: stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) link.add(drawing.text(get_device_name(device), insert=text, fill='white', class_='device-image-label')) - def _draw_empty(self, drawing, rack, start, end, text, id_, face_id, class_, reservation): + def _draw_empty(self, drawing, rack, start, end, text, unit, face_id, class_, reservation): link_url = '{}{}?{}'.format( self.base_url, reverse('dcim:device_add'), @@ -160,7 +167,7 @@ class RackElevationSVG: 'location': rack.location.pk if rack.location else '', 'rack': rack.pk, 'face': face_id, - 'position': id_ + 'position': unit }) ) link = drawing.add( @@ -173,98 +180,108 @@ class RackElevationSVG: link.add(drawing.rect(start, end, class_=class_)) link.add(drawing.text("add device", insert=text, class_='add-device')) - def merge_elevations(self, face): - elevation = self.rack.get_rack_units(face=face, expand_devices=False) - if face == DeviceFaceChoices.FACE_REAR: - other_face = DeviceFaceChoices.FACE_FRONT - else: - other_face = DeviceFaceChoices.FACE_REAR - other = self.rack.get_rack_units(face=other_face) - - unit_cursor = 0 - for u in elevation: - o = other[unit_cursor] - if not u['device'] and o['device'] and o['device'].device_type.is_full_depth: - u['device'] = o['device'] - u['height'] = 1 - unit_cursor += u.get('height', 1) - - return elevation - - def render(self, face, unit_width, unit_height, legend_width): + def draw_legend(self): """ - Return an SVG document representing a rack elevation. + Draw the rack unit labels along the lefthand side of the elevation. """ - drawing = self._setup_drawing( - unit_width + legend_width + RACK_ELEVATION_BORDER_WIDTH * 2, - unit_height * self.rack.u_height + RACK_ELEVATION_BORDER_WIDTH * 2 - ) - reserved_units = self.rack.get_reserved_units() - - unit_cursor = 0 for ru in range(0, self.rack.u_height): - start_y = ru * unit_height - position_coordinates = (legend_width / 2, start_y + unit_height / 2 + RACK_ELEVATION_BORDER_WIDTH) + start_y = ru * self.unit_height + position_coordinates = (self.legend_width / 2, start_y + self.unit_height / 2 + RACK_ELEVATION_BORDER_WIDTH) unit = ru + 1 if self.rack.desc_units else self.rack.u_height - ru - drawing.add( - drawing.text(str(unit), position_coordinates, class_="unit") + self.drawing.add( + Text(str(unit), position_coordinates, class_="unit") ) - for unit in self.merge_elevations(face): + def draw_face(self, face, opposite=False): + """ + Draw any occupied rack units for the specified rack face. + """ + for unit in self.rack.get_rack_units(face=face, expand_devices=False): # Loop through all units in the elevation device = unit['device'] - height = unit.get('height', 1) + height = unit.get('height', decimal.Decimal(1.0)) # Setup drawing coordinates - x_offset = legend_width + RACK_ELEVATION_BORDER_WIDTH - y_offset = unit_cursor * unit_height + RACK_ELEVATION_BORDER_WIDTH - end_y = unit_height * height + x_offset = self.legend_width + RACK_ELEVATION_BORDER_WIDTH + if self.rack.desc_units: + y_offset = int(unit['id'] * self.unit_height) + RACK_ELEVATION_BORDER_WIDTH + else: + y_offset = self.drawing['height'] - int(unit['id'] * self.unit_height) - RACK_ELEVATION_BORDER_WIDTH + + end_y = int(self.unit_height * height) start_cordinates = (x_offset, y_offset) - end_cordinates = (unit_width, end_y) - text_cordinates = (x_offset + (unit_width / 2), y_offset + end_y / 2) + size = (self.unit_width, end_y) + text_cordinates = (x_offset + (self.unit_width / 2), y_offset + end_y / 2) # Draw the device - if device and device.face == face and device.pk in self.permitted_device_ids: - self._draw_device_front(drawing, device, start_cordinates, end_cordinates, text_cordinates) - elif device and device.device_type.is_full_depth and device.pk in self.permitted_device_ids: - self._draw_device_rear(drawing, device, start_cordinates, end_cordinates, text_cordinates) + if device and device.pk in self.permitted_device_ids: + print(device) + print(f' {start_cordinates}') + print(f' {size}') + + if device.face == face and not opposite: + self._draw_device_front(self.drawing, device, start_cordinates, size, text_cordinates) + else: + self._draw_device_rear(self.drawing, device, start_cordinates, size, text_cordinates) + elif device: # Devices which the user does not have permission to view are rendered only as unavailable space - drawing.add(drawing.rect(start_cordinates, end_cordinates, class_='blocked')) - else: - # Draw shallow devices, reservations, or empty units - class_ = 'slot' - reservation = reserved_units.get(unit["id"]) - if device: - class_ += ' occupied' - if reservation: - class_ += ' reserved' - self._draw_empty( - drawing, - self.rack, - start_cordinates, - end_cordinates, - text_cordinates, - unit["id"], - face, - class_, - reservation - ) + self.drawing.add(Rect(start_cordinates, size, class_='blocked')) - unit_cursor += height + # else: + # # Draw shallow devices, reservations, or empty units + # class_ = 'slot' + # # reservation = reserved_units.get(unit["id"]) + # reservation = None + # if device: + # class_ += ' occupied' + # if reservation: + # class_ += ' reserved' + # self._draw_empty( + # self.drawing, + # self.rack, + # start_cordinates, + # end_cordinates, + # text_cordinates, + # unit["id"], + # face, + # class_, + # reservation + # ) + + def render(self, face): + """ + Return an SVG document representing a rack elevation. + """ + + # Initialize the drawing + self.drawing = self._setup_drawing() + + # reserved_units = self.rack.get_reserved_units() + + # Draw the unit legend + self.draw_legend() + + # Draw the opposite rack face first, then the near face + if face == DeviceFaceChoices.FACE_REAR: + opposite_face = DeviceFaceChoices.FACE_FRONT + else: + opposite_face = DeviceFaceChoices.FACE_REAR + # self.draw_face(opposite_face, opposite=True) + self.draw_face(face) # Wrap the drawing with a border border_width = RACK_ELEVATION_BORDER_WIDTH border_offset = RACK_ELEVATION_BORDER_WIDTH / 2 - frame = drawing.rect( - insert=(legend_width + border_offset, border_offset), - size=(unit_width + border_width, self.rack.u_height * unit_height + border_width), + frame = Rect( + insert=(self.legend_width + border_offset, border_offset), + size=(self.unit_width + border_width, self.rack.u_height * self.unit_height + border_width), class_='rack' ) - drawing.add(frame) + self.drawing.add(frame) - return drawing + return self.drawing OFFSET = 0.5 diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index 22537abe0..a6631208b 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -327,15 +327,15 @@ class RackTest(APIViewTestCases.APIViewTestCase): # Retrieve all units response = self.client.get(url, **self.header) - self.assertEqual(response.data['count'], 42) + self.assertEqual(response.data['count'], 84) # Search for specific units response = self.client.get(f'{url}?q=3', **self.header) - self.assertEqual(response.data['count'], 13) + self.assertEqual(response.data['count'], 26) response = self.client.get(f'{url}?q=U3', **self.header) - self.assertEqual(response.data['count'], 11) + self.assertEqual(response.data['count'], 22) response = self.client.get(f'{url}?q=U10', **self.header) - self.assertEqual(response.data['count'], 1) + self.assertEqual(response.data['count'], 2) def test_get_rack_elevation_svg(self): """ diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index 8566f969b..eefef3fb4 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -1,3 +1,5 @@ +import decimal + from django.core.exceptions import ValidationError from django.test import TestCase @@ -5,6 +7,7 @@ from circuits.models import * from dcim.choices import * from dcim.models import * from tenancy.models import Tenant +from utilities.utils import drange class LocationTestCase(TestCase): @@ -183,26 +186,34 @@ class RackTestCase(TestCase): device_role=DeviceRole.objects.get(slug='switch'), site=self.site1, rack=self.rack, - position=10, + position=10.0, face=DeviceFaceChoices.FACE_REAR, ) device1.save() # Validate rack height - self.assertEqual(list(self.rack.units), list(reversed(range(1, 43)))) + self.assertEqual(list(self.rack.units), list(drange(42.5, 0.5, -0.5))) # Validate inventory (front face) - rack1_inventory_front = self.rack.get_rack_units(face=DeviceFaceChoices.FACE_FRONT) - self.assertEqual(rack1_inventory_front[-10]['device'], device1) - del(rack1_inventory_front[-10]) - for u in rack1_inventory_front: + rack1_inventory_front = { + u['id']: u for u in self.rack.get_rack_units(face=DeviceFaceChoices.FACE_FRONT) + } + self.assertEqual(rack1_inventory_front[10.0]['device'], device1) + self.assertEqual(rack1_inventory_front[10.5]['device'], device1) + del(rack1_inventory_front[10.0]) + del(rack1_inventory_front[10.5]) + for u in rack1_inventory_front.values(): self.assertIsNone(u['device']) # Validate inventory (rear face) - rack1_inventory_rear = self.rack.get_rack_units(face=DeviceFaceChoices.FACE_REAR) - self.assertEqual(rack1_inventory_rear[-10]['device'], device1) - del(rack1_inventory_rear[-10]) - for u in rack1_inventory_rear: + rack1_inventory_rear = { + u['id']: u for u in self.rack.get_rack_units(face=DeviceFaceChoices.FACE_REAR) + } + self.assertEqual(rack1_inventory_rear[10.0]['device'], device1) + self.assertEqual(rack1_inventory_rear[10.5]['device'], device1) + del(rack1_inventory_rear[10.0]) + del(rack1_inventory_rear[10.5]) + for u in rack1_inventory_rear.values(): self.assertIsNone(u['device']) def test_mount_zero_ru(self): diff --git a/netbox/utilities/forms/utils.py b/netbox/utilities/forms/utils.py index 9a4b011e0..a6f037e0b 100644 --- a/netbox/utilities/forms/utils.py +++ b/netbox/utilities/forms/utils.py @@ -1,7 +1,6 @@ import re from django import forms -from django.conf import settings from django.forms.models import fields_for_model from utilities.choices import unpack_grouped_choices diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index 2b939471c..6a1b560e1 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -1,4 +1,5 @@ import datetime +import decimal import json from collections import OrderedDict from decimal import Decimal @@ -226,6 +227,21 @@ def deepmerge(original, new): return merged +def drange(start, end, step=decimal.Decimal(1)): + """ + Decimal-compatible implementation of Python's range() + """ + start, end, step = decimal.Decimal(start), decimal.Decimal(end), decimal.Decimal(step) + if start < end: + while start < end: + yield start + start += step + else: + while start > end: + yield start + start += step + + def to_meters(length, unit): """ Convert the given length to meters. From 0c915f7de9612c7485da3713cc6d63f368698a5d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Sun, 19 Jun 2022 14:54:18 -0400 Subject: [PATCH 141/593] Clean up rack elevation rendering --- netbox/dcim/svg.py | 167 ++++++++++++++++++++++----------------------- 1 file changed, 83 insertions(+), 84 deletions(-) diff --git a/netbox/dcim/svg.py b/netbox/dcim/svg.py index dfb788e38..95db476ad 100644 --- a/netbox/dcim/svg.py +++ b/netbox/dcim/svg.py @@ -94,18 +94,34 @@ class RackElevationSVG: drawing.defs.add(drawing.style(css_file.read())) # Add gradients - RackElevationSVG._add_gradient(drawing, 'reserved', '#c7c7ff') RackElevationSVG._add_gradient(drawing, 'occupied', '#d7d7d7') RackElevationSVG._add_gradient(drawing, 'blocked', '#ffc0c0') return drawing - def _draw_device_front(self, drawing, device, start, end, text): + def _get_device_coords(self, position, height): + """ + Return the X, Y coordinates of the top left corner for a device in the specified rack unit. + """ + x = self.legend_width + RACK_ELEVATION_BORDER_WIDTH + y = RACK_ELEVATION_BORDER_WIDTH + if self.rack.desc_units: + y += int((position - 1) * self.unit_height) + else: + y += int((self.rack.u_height - position + 1) * self.unit_height) - int(height * self.unit_height) + + return x, y + + def _draw_device_front(self, drawing, device, start, size): + text_coords = ( + start[0] + size[0] / 2, + start[1] + size[1] / 2 + ) name = get_device_name(device) if device.devicebay_count: name += ' ({}/{})'.format(device.get_children().count(), device.devicebay_count) - color = device.device_role.color + link = drawing.add( drawing.a( href='{}{}'.format(self.base_url, reverse('dcim:device', kwargs={'pk': device.pk})), @@ -114,25 +130,30 @@ class RackElevationSVG: ) ) link.set_desc(self._get_device_description(device)) - link.add(drawing.rect(start, end, style='fill: #{}'.format(color), class_='slot')) + link.add(drawing.rect(start, size, style='fill: #{}'.format(color), class_='slot')) hex_color = '#{}'.format(foreground_color(color)) - link.add(drawing.text(str(name), insert=text, fill=hex_color)) + link.add(drawing.text(str(name), insert=text_coords, fill=hex_color)) # Embed front device type image if one exists if self.include_images and device.device_type.front_image: image = drawing.image( href='{}{}'.format(self.base_url, device.device_type.front_image.url), insert=start, - size=end, + size=size, class_='device-image' ) image.fit(scale='slice') link.add(image) - link.add(drawing.text(str(name), insert=text, stroke='black', + link.add(drawing.text(str(name), insert=text_coords, stroke='black', stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) - link.add(drawing.text(str(name), insert=text, fill='white', class_='device-image-label')) + link.add(drawing.text(str(name), insert=text_coords, fill='white', class_='device-image-label')) + + def _draw_device_rear(self, drawing, device, start, size): + text_coords = ( + start[0] + size[0] / 2, + start[1] + size[1] / 2 + ) - def _draw_device_rear(self, drawing, device, start, end, text): link = drawing.add( drawing.a( href='{}{}'.format(self.base_url, reverse('dcim:device', kwargs={'pk': device.pk})), @@ -141,57 +162,76 @@ class RackElevationSVG: ) ) link.set_desc(self._get_device_description(device)) - link.add(drawing.rect(start, end, class_="slot blocked")) - link.add(drawing.text(get_device_name(device), insert=text)) + link.add(drawing.rect(start, size, class_="slot blocked")) + link.add(drawing.text(get_device_name(device), insert=text_coords)) # Embed rear device type image if one exists if self.include_images and device.device_type.rear_image: image = drawing.image( href='{}{}'.format(self.base_url, device.device_type.rear_image.url), insert=start, - size=end, + size=size, class_='device-image' ) image.fit(scale='slice') link.add(image) - link.add(drawing.text(get_device_name(device), insert=text, stroke='black', + link.add(Text(get_device_name(device), insert=text_coords, stroke='black', stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) - link.add(drawing.text(get_device_name(device), insert=text, fill='white', class_='device-image-label')) + link.add(Text(get_device_name(device), insert=text_coords, fill='white', class_='device-image-label')) - def _draw_empty(self, drawing, rack, start, end, text, unit, face_id, class_, reservation): - link_url = '{}{}?{}'.format( - self.base_url, - reverse('dcim:device_add'), - urlencode({ - 'site': rack.site.pk, - 'location': rack.location.pk if rack.location else '', - 'rack': rack.pk, - 'face': face_id, - 'position': unit - }) + def draw_border(self): + """ + Draw a border around the collection of rack units. + """ + border_width = RACK_ELEVATION_BORDER_WIDTH + border_offset = RACK_ELEVATION_BORDER_WIDTH / 2 + frame = Rect( + insert=(self.legend_width + border_offset, border_offset), + size=(self.unit_width + border_width, self.rack.u_height * self.unit_height + border_width), + class_='rack' ) - link = drawing.add( - drawing.a(href=link_url, target='_top') - ) - if reservation: - link.set_desc('{} — {} · {}'.format( - reservation.description, reservation.user, reservation.created - )) - link.add(drawing.rect(start, end, class_=class_)) - link.add(drawing.text("add device", insert=text, class_='add-device')) + self.drawing.add(frame) def draw_legend(self): """ Draw the rack unit labels along the lefthand side of the elevation. """ for ru in range(0, self.rack.u_height): - start_y = ru * self.unit_height + start_y = ru * self.unit_height + RACK_ELEVATION_BORDER_WIDTH position_coordinates = (self.legend_width / 2, start_y + self.unit_height / 2 + RACK_ELEVATION_BORDER_WIDTH) unit = ru + 1 if self.rack.desc_units else self.rack.u_height - ru self.drawing.add( - Text(str(unit), position_coordinates, class_="unit") + Text(str(unit), position_coordinates, class_='unit') ) + def draw_background(self, face): + """ + Draw the rack unit placeholders which form the "background" of the rack elevation. + """ + x_offset = RACK_ELEVATION_BORDER_WIDTH + self.legend_width + url_string = '{}?{}&position={{}}'.format( + reverse('dcim:device_add'), + urlencode({ + 'site': self.rack.site.pk, + 'location': self.rack.location.pk if self.rack.location else '', + 'rack': self.rack.pk, + 'face': face, + }) + ) + + for ru in range(0, self.rack.u_height): + y_offset = RACK_ELEVATION_BORDER_WIDTH + ru * self.unit_height + text_coords = ( + x_offset + self.unit_width / 2, + y_offset + self.unit_height / 2 + ) + + link = Hyperlink(href=url_string.format(ru), target='_blank') + link.add(Rect((x_offset, y_offset), (self.unit_width, self.unit_height), class_='slot')) + link.add(self.drawing.text('add device', insert=text_coords, class_='add-device')) + + self.drawing.add(link) + def draw_face(self, face, opposite=False): """ Draw any occupied rack units for the specified rack face. @@ -202,54 +242,21 @@ class RackElevationSVG: device = unit['device'] height = unit.get('height', decimal.Decimal(1.0)) - # Setup drawing coordinates - x_offset = self.legend_width + RACK_ELEVATION_BORDER_WIDTH - if self.rack.desc_units: - y_offset = int(unit['id'] * self.unit_height) + RACK_ELEVATION_BORDER_WIDTH - else: - y_offset = self.drawing['height'] - int(unit['id'] * self.unit_height) - RACK_ELEVATION_BORDER_WIDTH - + start_cordinates = self._get_device_coords(unit['id'], height) end_y = int(self.unit_height * height) - start_cordinates = (x_offset, y_offset) size = (self.unit_width, end_y) - text_cordinates = (x_offset + (self.unit_width / 2), y_offset + end_y / 2) # Draw the device if device and device.pk in self.permitted_device_ids: - print(device) - print(f' {start_cordinates}') - print(f' {size}') - if device.face == face and not opposite: - self._draw_device_front(self.drawing, device, start_cordinates, size, text_cordinates) + self._draw_device_front(self.drawing, device, start_cordinates, size) else: - self._draw_device_rear(self.drawing, device, start_cordinates, size, text_cordinates) + self._draw_device_rear(self.drawing, device, start_cordinates, size) elif device: # Devices which the user does not have permission to view are rendered only as unavailable space self.drawing.add(Rect(start_cordinates, size, class_='blocked')) - # else: - # # Draw shallow devices, reservations, or empty units - # class_ = 'slot' - # # reservation = reserved_units.get(unit["id"]) - # reservation = None - # if device: - # class_ += ' occupied' - # if reservation: - # class_ += ' reserved' - # self._draw_empty( - # self.drawing, - # self.rack, - # start_cordinates, - # end_cordinates, - # text_cordinates, - # unit["id"], - # face, - # class_, - # reservation - # ) - def render(self, face): """ Return an SVG document representing a rack elevation. @@ -258,10 +265,9 @@ class RackElevationSVG: # Initialize the drawing self.drawing = self._setup_drawing() - # reserved_units = self.rack.get_reserved_units() - - # Draw the unit legend + # Draw the empty rack & legend self.draw_legend() + self.draw_background(face) # Draw the opposite rack face first, then the near face if face == DeviceFaceChoices.FACE_REAR: @@ -271,15 +277,8 @@ class RackElevationSVG: # self.draw_face(opposite_face, opposite=True) self.draw_face(face) - # Wrap the drawing with a border - border_width = RACK_ELEVATION_BORDER_WIDTH - border_offset = RACK_ELEVATION_BORDER_WIDTH / 2 - frame = Rect( - insert=(self.legend_width + border_offset, border_offset), - size=(self.unit_width + border_width, self.rack.u_height * self.unit_height + border_width), - class_='rack' - ) - self.drawing.add(frame) + # Draw the rack border last + self.draw_border() return self.drawing From ae129485583afe89c9bfa51d301f10de3a96a37d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Sun, 19 Jun 2022 16:00:39 -0400 Subject: [PATCH 142/593] Refactor device rendering methods --- netbox/dcim/svg.py | 153 ++++++++++++++++++++++----------------------- 1 file changed, 75 insertions(+), 78 deletions(-) diff --git a/netbox/dcim/svg.py b/netbox/dcim/svg.py index 95db476ad..0986e94d3 100644 --- a/netbox/dcim/svg.py +++ b/netbox/dcim/svg.py @@ -1,6 +1,8 @@ import decimal import svgwrite from svgwrite.container import Group, Hyperlink +from svgwrite.image import Image +from svgwrite.gradients import LinearGradient from svgwrite.shapes import Line, Rect from svgwrite.text import Text @@ -22,11 +24,27 @@ __all__ = ( def get_device_name(device): if device.virtual_chassis: - return f'{device.virtual_chassis.name}:{device.vc_position}' + name = f'{device.virtual_chassis.name}:{device.vc_position}' elif device.name: - return device.name + name = device.name else: - return str(device.device_type) + name = str(device.device_type) + if device.devicebay_count: + name += ' ({}/{})'.format(device.get_children().count(), device.devicebay_count) + + return name + + +def get_device_description(device): + return '{} ({}) — {} {} ({}U) {} {}'.format( + device.name, + device.device_role, + device.device_type.manufacturer.name, + device.device_type.model, + device.device_type.u_height, + device.asset_tag or '', + device.serial or '' + ) class RackElevationSVG: @@ -56,21 +74,9 @@ class RackElevationSVG: permitted_devices = permitted_devices.restrict(user, 'view') self.permitted_device_ids = permitted_devices.values_list('pk', flat=True) - @staticmethod - def _get_device_description(device): - return '{} ({}) — {} {} ({}U) {} {}'.format( - device.name, - device.device_role, - device.device_type.manufacturer.name, - device.device_type.model, - device.device_type.u_height, - device.asset_tag or '', - device.serial or '' - ) - @staticmethod def _add_gradient(drawing, id_, color): - gradient = drawing.linearGradient( + gradient = LinearGradient( start=(0, 0), end=(0, 25), spreadMethod='repeat', @@ -82,6 +88,7 @@ class RackElevationSVG: gradient.add_stop_color(offset='50%', color='#f7f7f7') gradient.add_stop_color(offset='50%', color=color) gradient.add_stop_color(offset='100%', color=color) + drawing.defs.add(gradient) def _setup_drawing(self): @@ -90,7 +97,7 @@ class RackElevationSVG: drawing = svgwrite.Drawing(size=(width, height)) # Add the stylesheet - with open('{}/rack_elevation.css'.format(settings.STATIC_ROOT)) as css_file: + with open(f'{settings.STATIC_ROOT}/rack_elevation.css') as css_file: drawing.defs.add(drawing.style(css_file.read())) # Add gradients @@ -112,72 +119,60 @@ class RackElevationSVG: return x, y - def _draw_device_front(self, drawing, device, start, size): - text_coords = ( - start[0] + size[0] / 2, - start[1] + size[1] / 2 - ) + def _draw_device(self, device, coords, size, color=None, image=None): name = get_device_name(device) - if device.devicebay_count: - name += ' ({}/{})'.format(device.get_children().count(), device.devicebay_count) - color = device.device_role.color - - link = drawing.add( - drawing.a( - href='{}{}'.format(self.base_url, reverse('dcim:device', kwargs={'pk': device.pk})), - target='_top', - fill='black' - ) - ) - link.set_desc(self._get_device_description(device)) - link.add(drawing.rect(start, size, style='fill: #{}'.format(color), class_='slot')) - hex_color = '#{}'.format(foreground_color(color)) - link.add(drawing.text(str(name), insert=text_coords, fill=hex_color)) - - # Embed front device type image if one exists - if self.include_images and device.device_type.front_image: - image = drawing.image( - href='{}{}'.format(self.base_url, device.device_type.front_image.url), - insert=start, - size=size, - class_='device-image' - ) - image.fit(scale='slice') - link.add(image) - link.add(drawing.text(str(name), insert=text_coords, stroke='black', - stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) - link.add(drawing.text(str(name), insert=text_coords, fill='white', class_='device-image-label')) - - def _draw_device_rear(self, drawing, device, start, size): + description = get_device_description(device) text_coords = ( - start[0] + size[0] / 2, - start[1] + size[1] / 2 + coords[0] + size[0] / 2, + coords[1] + size[1] / 2 ) + text_color = f'#{foreground_color(color)}' if color else '#000000' - link = drawing.add( - drawing.a( - href='{}{}'.format(self.base_url, reverse('dcim:device', kwargs={'pk': device.pk})), - target='_top', - fill='black' - ) + # Create hyperlink element + link = Hyperlink( + href='{}{}'.format( + self.base_url, + reverse('dcim:device', kwargs={'pk': device.pk}) + ), + target='_blank', ) - link.set_desc(self._get_device_description(device)) - link.add(drawing.rect(start, size, class_="slot blocked")) - link.add(drawing.text(get_device_name(device), insert=text_coords)) + link.set_desc(description) + if color: + link.add(Rect(coords, size, style=f'fill: #{color}', class_='slot')) + else: + link.add(Rect(coords, size, class_='slot blocked')) + link.add(Text(name, insert=text_coords, fill=text_color)) - # Embed rear device type image if one exists - if self.include_images and device.device_type.rear_image: - image = drawing.image( - href='{}{}'.format(self.base_url, device.device_type.rear_image.url), - insert=start, + # Embed device type image if provided + if self.include_images and image: + image = Image( + href='{}{}'.format(self.base_url, image.url), + insert=coords, size=size, class_='device-image' ) image.fit(scale='slice') link.add(image) - link.add(Text(get_device_name(device), insert=text_coords, stroke='black', + link.add(Text(name, insert=text_coords, stroke='black', stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) - link.add(Text(get_device_name(device), insert=text_coords, fill='white', class_='device-image-label')) + link.add(Text(name, insert=text_coords, fill='white', class_='device-image-label')) + + self.drawing.add(link) + + def draw_device_front(self, device, coords, size): + """ + Draw the front (mounted) face of a device. + """ + color = device.device_role.color + image = device.device_type.front_image + self._draw_device(device, coords, size, color=color, image=image) + + def draw_device_rear(self, device, coords, size): + """ + Draw the rear (opposite) face of a device. + """ + image = device.device_type.rear_image + self._draw_device(device, coords, size, image=image) def draw_border(self): """ @@ -228,7 +223,7 @@ class RackElevationSVG: link = Hyperlink(href=url_string.format(ru), target='_blank') link.add(Rect((x_offset, y_offset), (self.unit_width, self.unit_height), class_='slot')) - link.add(self.drawing.text('add device', insert=text_coords, class_='add-device')) + link.add(Text('add device', insert=text_coords, class_='add-device')) self.drawing.add(link) @@ -242,20 +237,22 @@ class RackElevationSVG: device = unit['device'] height = unit.get('height', decimal.Decimal(1.0)) - start_cordinates = self._get_device_coords(unit['id'], height) - end_y = int(self.unit_height * height) - size = (self.unit_width, end_y) + device_coords = self._get_device_coords(unit['id'], height) + device_size = ( + self.unit_width, + int(self.unit_height * height) + ) # Draw the device if device and device.pk in self.permitted_device_ids: if device.face == face and not opposite: - self._draw_device_front(self.drawing, device, start_cordinates, size) + self.draw_device_front(device, device_coords, device_size) else: - self._draw_device_rear(self.drawing, device, start_cordinates, size) + self.draw_device_rear(device, device_coords, device_size) elif device: # Devices which the user does not have permission to view are rendered only as unavailable space - self.drawing.add(Rect(start_cordinates, size, class_='blocked')) + self.drawing.add(Rect(device_coords, device_size, class_='blocked')) def render(self, face): """ From 278891c262a49ef29079e2b4af186af265567555 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Sun, 19 Jun 2022 16:14:51 -0400 Subject: [PATCH 143/593] Fix rack utilization calculation --- netbox/dcim/models/racks.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index f963fb396..12cc4dd38 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -405,6 +405,7 @@ class Rack(NetBoxModel): as utilized. """ # Determine unoccupied units + total_units = len(list(self.units)) available_units = self.get_available_units() # Remove reserved units @@ -412,8 +413,8 @@ class Rack(NetBoxModel): if u in available_units: available_units.remove(u) - occupied_unit_count = self.u_height - len(available_units) - percentage = float(occupied_unit_count) / self.u_height * 100 + occupied_unit_count = total_units - len(available_units) + percentage = float(occupied_unit_count) / total_units * 100 return percentage From 0d6d68c62fac1072b78ebfd91863b5405beb61a6 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Sun, 19 Jun 2022 21:28:57 -0400 Subject: [PATCH 144/593] Fix YAML representation of decimal values --- netbox/dcim/models/devices.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index 14147f388..43b84974b 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -168,7 +168,7 @@ class DeviceType(NetBoxModel): ('model', self.model), ('slug', self.slug), ('part_number', self.part_number), - ('u_height', self.u_height), + ('u_height', float(self.u_height)), ('is_full_depth', self.is_full_depth), ('subdevice_role', self.subdevice_role), ('airflow', self.airflow), From 4ced0bed13a86b2f87788ed104944c5c1752e737 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 20 Jun 2022 12:37:56 -0400 Subject: [PATCH 145/593] Clean up rack model tests --- netbox/dcim/tests/test_models.py | 166 ++++++++++++------------------- 1 file changed, 63 insertions(+), 103 deletions(-) diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index eefef3fb4..da54fc98d 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -1,5 +1,3 @@ -import decimal - from django.core.exceptions import ValidationError from django.test import TestCase @@ -77,126 +75,90 @@ class RackTestCase(TestCase): def setUp(self): - self.site1 = Site.objects.create( - name='TestSite1', - slug='test-site-1' + sites = ( + Site(name='Site 1', slug='site-1'), + Site(name='Site 2', slug='site-2'), ) - self.site2 = Site.objects.create( - name='TestSite2', - slug='test-site-2' + Site.objects.bulk_create(sites) + + locations = ( + Location(name='Location 1', slug='location-1', site=sites[0]), + Location(name='Location 2', slug='location-2', site=sites[1]), ) - self.location1 = Location.objects.create( - name='TestGroup1', - slug='test-group-1', - site=self.site1 - ) - self.location2 = Location.objects.create( - name='TestGroup2', - slug='test-group-2', - site=self.site2 - ) - self.rack = Rack.objects.create( - name='TestRack1', + for location in locations: + location.save() + + Rack.objects.create( + name='Rack 1', facility_id='A101', - site=self.site1, - location=self.location1, + site=sites[0], + location=locations[0], u_height=42 ) - self.manufacturer = Manufacturer.objects.create( - name='Acme', - slug='acme' + + manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1') + device_types = ( + DeviceType(manufacturer=manufacturer, model='Device Type 1', slug='device-type-1', u_height=1), + DeviceType(manufacturer=manufacturer, model='Device Type 2', slug='device-type-2', u_height=0), ) + DeviceType.objects.bulk_create(device_types) - self.device_type = { - 'ff2048': DeviceType.objects.create( - manufacturer=self.manufacturer, - model='FrameForwarder 2048', - slug='ff2048' - ), - 'cc5000': DeviceType.objects.create( - manufacturer=self.manufacturer, - model='CurrentCatapult 5000', - slug='cc5000', - u_height=0 - ), - } - self.role = { - 'Server': DeviceRole.objects.create( - name='Server', - slug='server', - ), - 'Switch': DeviceRole.objects.create( - name='Switch', - slug='switch', - ), - 'Console Server': DeviceRole.objects.create( - name='Console Server', - slug='console-server', - ), - 'PDU': DeviceRole.objects.create( - name='PDU', - slug='pdu', - ), - - } + DeviceRole.objects.create(name='Device Role 1', slug='device-role-1') def test_rack_device_outside_height(self): - - rack1 = Rack( - name='TestRack2', - facility_id='A102', - site=self.site1, - u_height=42 - ) - rack1.save() + site = Site.objects.first() + rack = Rack.objects.first() device1 = Device( - name='TestSwitch1', - device_type=DeviceType.objects.get(manufacturer__slug='acme', slug='ff2048'), - device_role=DeviceRole.objects.get(slug='switch'), - site=self.site1, - rack=rack1, + name='Device 1', + device_type=DeviceType.objects.first(), + device_role=DeviceRole.objects.first(), + site=site, + rack=rack, position=43, face=DeviceFaceChoices.FACE_FRONT, ) device1.save() with self.assertRaises(ValidationError): - rack1.clean() + rack.clean() def test_location_site(self): + site1 = Site.objects.get(name='Site 1') + location2 = Location.objects.get(name='Location 2') - rack_invalid_location = Rack( - name='TestRack2', - facility_id='A102', - site=self.site1, - u_height=42, - location=self.location2 + rack2 = Rack( + name='Rack 2', + site=site1, + location=location2, + u_height=42 ) - rack_invalid_location.save() + rack2.save() with self.assertRaises(ValidationError): - rack_invalid_location.clean() + rack2.clean() def test_mount_single_device(self): + site = Site.objects.first() + rack = Rack.objects.first() device1 = Device( name='TestSwitch1', - device_type=DeviceType.objects.get(manufacturer__slug='acme', slug='ff2048'), - device_role=DeviceRole.objects.get(slug='switch'), - site=self.site1, - rack=self.rack, + device_type=DeviceType.objects.first(), + device_role=DeviceRole.objects.first(), + site=site, + rack=rack, position=10.0, face=DeviceFaceChoices.FACE_REAR, ) device1.save() # Validate rack height - self.assertEqual(list(self.rack.units), list(drange(42.5, 0.5, -0.5))) + self.assertEqual(list(rack.units), list(drange(42.5, 0.5, -0.5))) # Validate inventory (front face) rack1_inventory_front = { - u['id']: u for u in self.rack.get_rack_units(face=DeviceFaceChoices.FACE_FRONT) + u['id']: u for u in rack.get_rack_units(face=DeviceFaceChoices.FACE_FRONT) } self.assertEqual(rack1_inventory_front[10.0]['device'], device1) self.assertEqual(rack1_inventory_front[10.5]['device'], device1) @@ -207,7 +169,7 @@ class RackTestCase(TestCase): # Validate inventory (rear face) rack1_inventory_rear = { - u['id']: u for u in self.rack.get_rack_units(face=DeviceFaceChoices.FACE_REAR) + u['id']: u for u in rack.get_rack_units(face=DeviceFaceChoices.FACE_REAR) } self.assertEqual(rack1_inventory_rear[10.0]['device'], device1) self.assertEqual(rack1_inventory_rear[10.5]['device'], device1) @@ -217,16 +179,17 @@ class RackTestCase(TestCase): self.assertIsNone(u['device']) def test_mount_zero_ru(self): - pdu = Device.objects.create( + site = Site.objects.first() + rack = Rack.objects.first() + + device = Device.objects.create( name='TestPDU', - device_role=self.role.get('PDU'), - device_type=self.device_type.get('cc5000'), - site=self.site1, - rack=self.rack, - position=None, - face='', + device_role=DeviceRole.objects.first(), + device_type=DeviceType.objects.first(), + site=site, + rack=rack ) - self.assertTrue(pdu) + self.assertTrue(device) def test_change_rack_site(self): """ @@ -235,19 +198,16 @@ class RackTestCase(TestCase): site_a = Site.objects.create(name='Site A', slug='site-a') site_b = Site.objects.create(name='Site B', slug='site-b') - manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1') - device_type = DeviceType.objects.create( - manufacturer=manufacturer, model='Device Type 1', slug='device-type-1' - ) - device_role = DeviceRole.objects.create( - name='Device Role 1', slug='device-role-1', color='ff0000' - ) - # Create Rack1 in Site A rack1 = Rack.objects.create(site=site_a, name='Rack 1') # Create Device1 in Rack1 - device1 = Device.objects.create(site=site_a, rack=rack1, device_type=device_type, device_role=device_role) + device1 = Device.objects.create( + site=site_a, + rack=rack1, + device_type=DeviceType.objects.first(), + device_role=DeviceRole.objects.first() + ) # Move Rack1 to Site B rack1.site = site_b From 103729c0855aad2f45fcaa2cf680799236f3e201 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 20 Jun 2022 13:57:37 -0400 Subject: [PATCH 146/593] Add test for 0.5U devices --- netbox/dcim/tests/test_models.py | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index da54fc98d..98d57801d 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -100,6 +100,7 @@ class RackTestCase(TestCase): device_types = ( DeviceType(manufacturer=manufacturer, model='Device Type 1', slug='device-type-1', u_height=1), DeviceType(manufacturer=manufacturer, model='Device Type 2', slug='device-type-2', u_height=0), + DeviceType(manufacturer=manufacturer, model='Device Type 3', slug='device-type-3', u_height=0.5), ) DeviceType.objects.bulk_create(device_types) @@ -179,17 +180,37 @@ class RackTestCase(TestCase): self.assertIsNone(u['device']) def test_mount_zero_ru(self): + """ + Check that a 0RU device can be mounted in a rack with no face/position. + """ site = Site.objects.first() rack = Rack.objects.first() - device = Device.objects.create( - name='TestPDU', + Device( + name='Device 1', device_role=DeviceRole.objects.first(), device_type=DeviceType.objects.first(), site=site, rack=rack - ) - self.assertTrue(device) + ).save() + + def test_mount_half_u_devices(self): + """ + Check that two 0.5U devices can be mounted in the same rack unit. + """ + rack = Rack.objects.first() + attrs = { + 'device_type': DeviceType.objects.get(u_height=0.5), + 'device_role': DeviceRole.objects.first(), + 'site': Site.objects.first(), + 'rack': rack, + 'face': DeviceFaceChoices.FACE_FRONT, + } + + Device(name='Device 1', position=1, **attrs).save() + Device(name='Device 2', position=1.5, **attrs).save() + + self.assertEqual(len(rack.get_available_units()), rack.u_height * 2 - 3) def test_change_rack_site(self): """ From 64080e808ee3b5c0c1b0217180518dc018c80f8e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 20 Jun 2022 14:30:25 -0400 Subject: [PATCH 147/593] Refactor dcim.svg module --- netbox/dcim/svg/__init__.py | 2 + netbox/dcim/{svg.py => svg/cables.py} | 272 +------------------------ netbox/dcim/svg/racks.py | 279 ++++++++++++++++++++++++++ 3 files changed, 283 insertions(+), 270 deletions(-) create mode 100644 netbox/dcim/svg/__init__.py rename netbox/dcim/{svg.py => svg/cables.py} (54%) create mode 100644 netbox/dcim/svg/racks.py diff --git a/netbox/dcim/svg/__init__.py b/netbox/dcim/svg/__init__.py new file mode 100644 index 000000000..21e27d495 --- /dev/null +++ b/netbox/dcim/svg/__init__.py @@ -0,0 +1,2 @@ +from .cables import * +from .racks import * diff --git a/netbox/dcim/svg.py b/netbox/dcim/svg/cables.py similarity index 54% rename from netbox/dcim/svg.py rename to netbox/dcim/svg/cables.py index 0986e94d3..eb0d2aca1 100644 --- a/netbox/dcim/svg.py +++ b/netbox/dcim/svg/cables.py @@ -1,285 +1,17 @@ -import decimal import svgwrite + +from django.conf import settings from svgwrite.container import Group, Hyperlink -from svgwrite.image import Image -from svgwrite.gradients import LinearGradient from svgwrite.shapes import Line, Rect from svgwrite.text import Text -from django.conf import settings -from django.urls import reverse -from django.utils.http import urlencode - -from netbox.config import get_config from utilities.utils import foreground_color -from .choices import DeviceFaceChoices -from .constants import RACK_ELEVATION_BORDER_WIDTH - __all__ = ( 'CableTraceSVG', - 'RackElevationSVG', ) -def get_device_name(device): - if device.virtual_chassis: - name = f'{device.virtual_chassis.name}:{device.vc_position}' - elif device.name: - name = device.name - else: - name = str(device.device_type) - if device.devicebay_count: - name += ' ({}/{})'.format(device.get_children().count(), device.devicebay_count) - - return name - - -def get_device_description(device): - return '{} ({}) — {} {} ({}U) {} {}'.format( - device.name, - device.device_role, - device.device_type.manufacturer.name, - device.device_type.model, - device.device_type.u_height, - device.asset_tag or '', - device.serial or '' - ) - - -class RackElevationSVG: - """ - Use this class to render a rack elevation as an SVG image. - - :param rack: A NetBox Rack instance - :param user: User instance. If specified, only devices viewable by this user will be fully displayed. - :param include_images: If true, the SVG document will embed front/rear device face images, where available - :param base_url: Base URL for links within the SVG document. If none, links will be relative. - """ - def __init__(self, rack, unit_height=None, unit_width=None, legend_width=None, user=None, include_images=True, - base_url=None): - self.rack = rack - self.include_images = include_images - self.base_url = base_url.rstrip('/') if base_url is not None else '' - - # Set drawing dimensions - config = get_config() - self.unit_width = unit_width or config.RACK_ELEVATION_DEFAULT_UNIT_WIDTH - self.unit_height = unit_height or config.RACK_ELEVATION_DEFAULT_UNIT_HEIGHT - self.legend_width = legend_width or config.RACK_ELEVATION_LEGEND_WIDTH_DEFAULT - - # Determine the subset of devices within this rack that are viewable by the user, if any - permitted_devices = self.rack.devices - if user is not None: - permitted_devices = permitted_devices.restrict(user, 'view') - self.permitted_device_ids = permitted_devices.values_list('pk', flat=True) - - @staticmethod - def _add_gradient(drawing, id_, color): - gradient = LinearGradient( - start=(0, 0), - end=(0, 25), - spreadMethod='repeat', - id_=id_, - gradientTransform='rotate(45, 0, 0)', - gradientUnits='userSpaceOnUse' - ) - gradient.add_stop_color(offset='0%', color='#f7f7f7') - gradient.add_stop_color(offset='50%', color='#f7f7f7') - gradient.add_stop_color(offset='50%', color=color) - gradient.add_stop_color(offset='100%', color=color) - - drawing.defs.add(gradient) - - def _setup_drawing(self): - width = self.unit_width + self.legend_width + RACK_ELEVATION_BORDER_WIDTH * 2 - height = self.unit_height * self.rack.u_height + RACK_ELEVATION_BORDER_WIDTH * 2 - drawing = svgwrite.Drawing(size=(width, height)) - - # Add the stylesheet - with open(f'{settings.STATIC_ROOT}/rack_elevation.css') as css_file: - drawing.defs.add(drawing.style(css_file.read())) - - # Add gradients - RackElevationSVG._add_gradient(drawing, 'occupied', '#d7d7d7') - RackElevationSVG._add_gradient(drawing, 'blocked', '#ffc0c0') - - return drawing - - def _get_device_coords(self, position, height): - """ - Return the X, Y coordinates of the top left corner for a device in the specified rack unit. - """ - x = self.legend_width + RACK_ELEVATION_BORDER_WIDTH - y = RACK_ELEVATION_BORDER_WIDTH - if self.rack.desc_units: - y += int((position - 1) * self.unit_height) - else: - y += int((self.rack.u_height - position + 1) * self.unit_height) - int(height * self.unit_height) - - return x, y - - def _draw_device(self, device, coords, size, color=None, image=None): - name = get_device_name(device) - description = get_device_description(device) - text_coords = ( - coords[0] + size[0] / 2, - coords[1] + size[1] / 2 - ) - text_color = f'#{foreground_color(color)}' if color else '#000000' - - # Create hyperlink element - link = Hyperlink( - href='{}{}'.format( - self.base_url, - reverse('dcim:device', kwargs={'pk': device.pk}) - ), - target='_blank', - ) - link.set_desc(description) - if color: - link.add(Rect(coords, size, style=f'fill: #{color}', class_='slot')) - else: - link.add(Rect(coords, size, class_='slot blocked')) - link.add(Text(name, insert=text_coords, fill=text_color)) - - # Embed device type image if provided - if self.include_images and image: - image = Image( - href='{}{}'.format(self.base_url, image.url), - insert=coords, - size=size, - class_='device-image' - ) - image.fit(scale='slice') - link.add(image) - link.add(Text(name, insert=text_coords, stroke='black', - stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) - link.add(Text(name, insert=text_coords, fill='white', class_='device-image-label')) - - self.drawing.add(link) - - def draw_device_front(self, device, coords, size): - """ - Draw the front (mounted) face of a device. - """ - color = device.device_role.color - image = device.device_type.front_image - self._draw_device(device, coords, size, color=color, image=image) - - def draw_device_rear(self, device, coords, size): - """ - Draw the rear (opposite) face of a device. - """ - image = device.device_type.rear_image - self._draw_device(device, coords, size, image=image) - - def draw_border(self): - """ - Draw a border around the collection of rack units. - """ - border_width = RACK_ELEVATION_BORDER_WIDTH - border_offset = RACK_ELEVATION_BORDER_WIDTH / 2 - frame = Rect( - insert=(self.legend_width + border_offset, border_offset), - size=(self.unit_width + border_width, self.rack.u_height * self.unit_height + border_width), - class_='rack' - ) - self.drawing.add(frame) - - def draw_legend(self): - """ - Draw the rack unit labels along the lefthand side of the elevation. - """ - for ru in range(0, self.rack.u_height): - start_y = ru * self.unit_height + RACK_ELEVATION_BORDER_WIDTH - position_coordinates = (self.legend_width / 2, start_y + self.unit_height / 2 + RACK_ELEVATION_BORDER_WIDTH) - unit = ru + 1 if self.rack.desc_units else self.rack.u_height - ru - self.drawing.add( - Text(str(unit), position_coordinates, class_='unit') - ) - - def draw_background(self, face): - """ - Draw the rack unit placeholders which form the "background" of the rack elevation. - """ - x_offset = RACK_ELEVATION_BORDER_WIDTH + self.legend_width - url_string = '{}?{}&position={{}}'.format( - reverse('dcim:device_add'), - urlencode({ - 'site': self.rack.site.pk, - 'location': self.rack.location.pk if self.rack.location else '', - 'rack': self.rack.pk, - 'face': face, - }) - ) - - for ru in range(0, self.rack.u_height): - y_offset = RACK_ELEVATION_BORDER_WIDTH + ru * self.unit_height - text_coords = ( - x_offset + self.unit_width / 2, - y_offset + self.unit_height / 2 - ) - - link = Hyperlink(href=url_string.format(ru), target='_blank') - link.add(Rect((x_offset, y_offset), (self.unit_width, self.unit_height), class_='slot')) - link.add(Text('add device', insert=text_coords, class_='add-device')) - - self.drawing.add(link) - - def draw_face(self, face, opposite=False): - """ - Draw any occupied rack units for the specified rack face. - """ - for unit in self.rack.get_rack_units(face=face, expand_devices=False): - - # Loop through all units in the elevation - device = unit['device'] - height = unit.get('height', decimal.Decimal(1.0)) - - device_coords = self._get_device_coords(unit['id'], height) - device_size = ( - self.unit_width, - int(self.unit_height * height) - ) - - # Draw the device - if device and device.pk in self.permitted_device_ids: - if device.face == face and not opposite: - self.draw_device_front(device, device_coords, device_size) - else: - self.draw_device_rear(device, device_coords, device_size) - - elif device: - # Devices which the user does not have permission to view are rendered only as unavailable space - self.drawing.add(Rect(device_coords, device_size, class_='blocked')) - - def render(self, face): - """ - Return an SVG document representing a rack elevation. - """ - - # Initialize the drawing - self.drawing = self._setup_drawing() - - # Draw the empty rack & legend - self.draw_legend() - self.draw_background(face) - - # Draw the opposite rack face first, then the near face - if face == DeviceFaceChoices.FACE_REAR: - opposite_face = DeviceFaceChoices.FACE_FRONT - else: - opposite_face = DeviceFaceChoices.FACE_REAR - # self.draw_face(opposite_face, opposite=True) - self.draw_face(face) - - # Draw the rack border last - self.draw_border() - - return self.drawing - - OFFSET = 0.5 PADDING = 10 LINE_HEIGHT = 20 diff --git a/netbox/dcim/svg/racks.py b/netbox/dcim/svg/racks.py new file mode 100644 index 000000000..4d518adf1 --- /dev/null +++ b/netbox/dcim/svg/racks.py @@ -0,0 +1,279 @@ +import decimal +import svgwrite +from svgwrite.container import Hyperlink +from svgwrite.image import Image +from svgwrite.gradients import LinearGradient +from svgwrite.shapes import Rect +from svgwrite.text import Text + +from django.conf import settings +from django.urls import reverse +from django.utils.http import urlencode + +from netbox.config import get_config +from utilities.utils import foreground_color +from dcim.choices import DeviceFaceChoices +from dcim.constants import RACK_ELEVATION_BORDER_WIDTH + + +__all__ = ( + 'RackElevationSVG', +) + + +def get_device_name(device): + if device.virtual_chassis: + name = f'{device.virtual_chassis.name}:{device.vc_position}' + elif device.name: + name = device.name + else: + name = str(device.device_type) + if device.devicebay_count: + name += ' ({}/{})'.format(device.get_children().count(), device.devicebay_count) + + return name + + +def get_device_description(device): + return '{} ({}) — {} {} ({}U) {} {}'.format( + device.name, + device.device_role, + device.device_type.manufacturer.name, + device.device_type.model, + device.device_type.u_height, + device.asset_tag or '', + device.serial or '' + ) + + +class RackElevationSVG: + """ + Use this class to render a rack elevation as an SVG image. + + :param rack: A NetBox Rack instance + :param user: User instance. If specified, only devices viewable by this user will be fully displayed. + :param include_images: If true, the SVG document will embed front/rear device face images, where available + :param base_url: Base URL for links within the SVG document. If none, links will be relative. + """ + def __init__(self, rack, unit_height=None, unit_width=None, legend_width=None, user=None, include_images=True, + base_url=None): + self.rack = rack + self.include_images = include_images + self.base_url = base_url.rstrip('/') if base_url is not None else '' + + # Set drawing dimensions + config = get_config() + self.unit_width = unit_width or config.RACK_ELEVATION_DEFAULT_UNIT_WIDTH + self.unit_height = unit_height or config.RACK_ELEVATION_DEFAULT_UNIT_HEIGHT + self.legend_width = legend_width or config.RACK_ELEVATION_LEGEND_WIDTH_DEFAULT + + # Determine the subset of devices within this rack that are viewable by the user, if any + permitted_devices = self.rack.devices + if user is not None: + permitted_devices = permitted_devices.restrict(user, 'view') + self.permitted_device_ids = permitted_devices.values_list('pk', flat=True) + + @staticmethod + def _add_gradient(drawing, id_, color): + gradient = LinearGradient( + start=(0, 0), + end=(0, 25), + spreadMethod='repeat', + id_=id_, + gradientTransform='rotate(45, 0, 0)', + gradientUnits='userSpaceOnUse' + ) + gradient.add_stop_color(offset='0%', color='#f7f7f7') + gradient.add_stop_color(offset='50%', color='#f7f7f7') + gradient.add_stop_color(offset='50%', color=color) + gradient.add_stop_color(offset='100%', color=color) + + drawing.defs.add(gradient) + + def _setup_drawing(self): + width = self.unit_width + self.legend_width + RACK_ELEVATION_BORDER_WIDTH * 2 + height = self.unit_height * self.rack.u_height + RACK_ELEVATION_BORDER_WIDTH * 2 + drawing = svgwrite.Drawing(size=(width, height)) + + # Add the stylesheet + with open(f'{settings.STATIC_ROOT}/rack_elevation.css') as css_file: + drawing.defs.add(drawing.style(css_file.read())) + + # Add gradients + RackElevationSVG._add_gradient(drawing, 'occupied', '#d7d7d7') + RackElevationSVG._add_gradient(drawing, 'blocked', '#ffc0c0') + + return drawing + + def _get_device_coords(self, position, height): + """ + Return the X, Y coordinates of the top left corner for a device in the specified rack unit. + """ + x = self.legend_width + RACK_ELEVATION_BORDER_WIDTH + y = RACK_ELEVATION_BORDER_WIDTH + if self.rack.desc_units: + y += int((position - 1) * self.unit_height) + else: + y += int((self.rack.u_height - position + 1) * self.unit_height) - int(height * self.unit_height) + + return x, y + + def _draw_device(self, device, coords, size, color=None, image=None): + name = get_device_name(device) + description = get_device_description(device) + text_coords = ( + coords[0] + size[0] / 2, + coords[1] + size[1] / 2 + ) + text_color = f'#{foreground_color(color)}' if color else '#000000' + + # Create hyperlink element + link = Hyperlink( + href='{}{}'.format( + self.base_url, + reverse('dcim:device', kwargs={'pk': device.pk}) + ), + target='_blank', + ) + link.set_desc(description) + if color: + link.add(Rect(coords, size, style=f'fill: #{color}', class_='slot')) + else: + link.add(Rect(coords, size, class_='slot blocked')) + link.add(Text(name, insert=text_coords, fill=text_color)) + + # Embed device type image if provided + if self.include_images and image: + image = Image( + href='{}{}'.format(self.base_url, image.url), + insert=coords, + size=size, + class_='device-image' + ) + image.fit(scale='slice') + link.add(image) + link.add(Text(name, insert=text_coords, stroke='black', + stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) + link.add(Text(name, insert=text_coords, fill='white', class_='device-image-label')) + + self.drawing.add(link) + + def draw_device_front(self, device, coords, size): + """ + Draw the front (mounted) face of a device. + """ + color = device.device_role.color + image = device.device_type.front_image + self._draw_device(device, coords, size, color=color, image=image) + + def draw_device_rear(self, device, coords, size): + """ + Draw the rear (opposite) face of a device. + """ + image = device.device_type.rear_image + self._draw_device(device, coords, size, image=image) + + def draw_border(self): + """ + Draw a border around the collection of rack units. + """ + border_width = RACK_ELEVATION_BORDER_WIDTH + border_offset = RACK_ELEVATION_BORDER_WIDTH / 2 + frame = Rect( + insert=(self.legend_width + border_offset, border_offset), + size=(self.unit_width + border_width, self.rack.u_height * self.unit_height + border_width), + class_='rack' + ) + self.drawing.add(frame) + + def draw_legend(self): + """ + Draw the rack unit labels along the lefthand side of the elevation. + """ + for ru in range(0, self.rack.u_height): + start_y = ru * self.unit_height + RACK_ELEVATION_BORDER_WIDTH + position_coordinates = (self.legend_width / 2, start_y + self.unit_height / 2 + RACK_ELEVATION_BORDER_WIDTH) + unit = ru + 1 if self.rack.desc_units else self.rack.u_height - ru + self.drawing.add( + Text(str(unit), position_coordinates, class_='unit') + ) + + def draw_background(self, face): + """ + Draw the rack unit placeholders which form the "background" of the rack elevation. + """ + x_offset = RACK_ELEVATION_BORDER_WIDTH + self.legend_width + url_string = '{}?{}&position={{}}'.format( + reverse('dcim:device_add'), + urlencode({ + 'site': self.rack.site.pk, + 'location': self.rack.location.pk if self.rack.location else '', + 'rack': self.rack.pk, + 'face': face, + }) + ) + + for ru in range(0, self.rack.u_height): + y_offset = RACK_ELEVATION_BORDER_WIDTH + ru * self.unit_height + text_coords = ( + x_offset + self.unit_width / 2, + y_offset + self.unit_height / 2 + ) + + link = Hyperlink(href=url_string.format(ru), target='_blank') + link.add(Rect((x_offset, y_offset), (self.unit_width, self.unit_height), class_='slot')) + link.add(Text('add device', insert=text_coords, class_='add-device')) + + self.drawing.add(link) + + def draw_face(self, face, opposite=False): + """ + Draw any occupied rack units for the specified rack face. + """ + for unit in self.rack.get_rack_units(face=face, expand_devices=False): + + # Loop through all units in the elevation + device = unit['device'] + height = unit.get('height', decimal.Decimal(1.0)) + + device_coords = self._get_device_coords(unit['id'], height) + device_size = ( + self.unit_width, + int(self.unit_height * height) + ) + + # Draw the device + if device and device.pk in self.permitted_device_ids: + if device.face == face and not opposite: + self.draw_device_front(device, device_coords, device_size) + else: + self.draw_device_rear(device, device_coords, device_size) + + elif device: + # Devices which the user does not have permission to view are rendered only as unavailable space + self.drawing.add(Rect(device_coords, device_size, class_='blocked')) + + def render(self, face): + """ + Return an SVG document representing a rack elevation. + """ + + # Initialize the drawing + self.drawing = self._setup_drawing() + + # Draw the empty rack & legend + self.draw_legend() + self.draw_background(face) + + # Draw the opposite rack face first, then the near face + if face == DeviceFaceChoices.FACE_REAR: + opposite_face = DeviceFaceChoices.FACE_FRONT + else: + opposite_face = DeviceFaceChoices.FACE_REAR + # self.draw_face(opposite_face, opposite=True) + self.draw_face(face) + + # Draw the rack border last + self.draw_border() + + return self.drawing From 52178f78d1b22478aeee567dddeab511c8cc2e3a Mon Sep 17 00:00:00 2001 From: Hunter Johnston Date: Tue, 21 Jun 2022 12:58:41 -0400 Subject: [PATCH 148/593] Closes #7702: Add Powerfeed Defaults to User Configurations --- netbox/dcim/urls.py | 2 +- netbox/dcim/views.py | 12 ++++++++++++ netbox/extras/admin.py | 3 +++ netbox/netbox/config/parameters.py | 25 +++++++++++++++++++++++++ 4 files changed, 41 insertions(+), 1 deletion(-) diff --git a/netbox/dcim/urls.py b/netbox/dcim/urls.py index c5cd0fa65..82ea3fec0 100644 --- a/netbox/dcim/urls.py +++ b/netbox/dcim/urls.py @@ -489,7 +489,7 @@ urlpatterns = [ # Power feeds path('power-feeds/', views.PowerFeedListView.as_view(), name='powerfeed_list'), - path('power-feeds/add/', views.PowerFeedEditView.as_view(), name='powerfeed_add'), + path('power-feeds/add/', views.PowerFeedCreateView.as_view(), name='powerfeed_add'), path('power-feeds/import/', views.PowerFeedBulkImportView.as_view(), name='powerfeed_import'), path('power-feeds/edit/', views.PowerFeedBulkEditView.as_view(), name='powerfeed_bulk_edit'), path('power-feeds/disconnect/', views.PowerFeedBulkDisconnectView.as_view(), name='powerfeed_bulk_disconnect'), diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 35a1056b2..0716f595e 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -16,6 +16,7 @@ from circuits.models import Circuit from extras.views import ObjectConfigContextView from ipam.models import ASN, IPAddress, Prefix, Service, VLAN, VLANGroup from ipam.tables import AssignedIPAddressesTable, InterfaceVLANTable +from netbox.config import ConfigItem from netbox.views import generic from utilities.forms import ConfirmationForm from utilities.paginator import EnhancedPaginator, get_paginate_count @@ -3253,6 +3254,17 @@ class PowerFeedView(generic.ObjectView): queryset = PowerFeed.objects.prefetch_related('power_panel', 'rack') +class PowerFeedCreateView(generic.ObjectEditView): + queryset = PowerFeed.objects.all() + form = forms.PowerFeedForm + + def alter_object(self, obj, request, args, kwargs): + obj.voltage = ConfigItem('POWERFEED_DEFAULT_VOLTAGE') + obj.amperage = ConfigItem('POWERFEED_DEFAULT_AMPERAGE') + obj.max_utilization = ConfigItem('POWERFEED_DEFAULT_MAX_UTILIZATION') + return obj + + class PowerFeedEditView(generic.ObjectEditView): queryset = PowerFeed.objects.all() form = forms.PowerFeedForm diff --git a/netbox/extras/admin.py b/netbox/extras/admin.py index 28902c323..01011b276 100644 --- a/netbox/extras/admin.py +++ b/netbox/extras/admin.py @@ -15,6 +15,9 @@ class ConfigRevisionAdmin(admin.ModelAdmin): ('Rack Elevations', { 'fields': ('RACK_ELEVATION_DEFAULT_UNIT_HEIGHT', 'RACK_ELEVATION_DEFAULT_UNIT_WIDTH'), }), + ('Power', { + 'fields': ('POWERFEED_DEFAULT_VOLTAGE', 'POWERFEED_DEFAULT_AMPERAGE', 'POWERFEED_DEFAULT_MAX_UTILIZATION') + }), ('IPAM', { 'fields': ('ENFORCE_GLOBAL_UNIQUE', 'PREFER_IPV4'), }), diff --git a/netbox/netbox/config/parameters.py b/netbox/netbox/config/parameters.py index 68c96b38a..e2295888f 100644 --- a/netbox/netbox/config/parameters.py +++ b/netbox/netbox/config/parameters.py @@ -82,6 +82,31 @@ PARAMS = ( field=forms.IntegerField ), + # Power + ConfigParam( + name='POWERFEED_DEFAULT_VOLTAGE', + label='Powerfeed voltage', + default=120, + description="Default voltage for powerfeeds", + field=forms.IntegerField + ), + + ConfigParam( + name='POWERFEED_DEFAULT_AMPERAGE', + label='Powerfeed amperage', + default=15, + description="Default amperage for powerfeeds", + field=forms.IntegerField + ), + + ConfigParam( + name='POWERFEED_DEFAULT_MAX_UTILIZATION', + label='Powerfeed max utilization', + default=80, + description="Default max utilization for powerfeeds", + field=forms.IntegerField + ), + # Security ConfigParam( name='ALLOWED_URL_SCHEMES', From 9c214622a119b990491b72402d58b8c2272d3974 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 21 Jun 2022 16:30:27 -0400 Subject: [PATCH 149/593] Closes #4350: Illustrate reservations vertically alongside rack elevations --- docs/release-notes/version-3.3.md | 1 + netbox/dcim/api/serializers.py | 5 +- netbox/dcim/constants.py | 3 +- netbox/dcim/models/racks.py | 5 +- netbox/dcim/svg/racks.py | 45 +++++++++++++----- netbox/project-static/dist/rack_elevation.css | Bin 1511 -> 1423 bytes .../project-static/styles/rack-elevation.scss | 16 ++----- netbox/utilities/utils.py | 24 +++++++++- 8 files changed, 71 insertions(+), 28 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 229509b9c..fc8c24f4c 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -14,6 +14,7 @@ ### Enhancements * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses +* [#4350](https://github.com/netbox-community/netbox/issues/4350) - Illustrate reservations vertically alongside rack elevations * [#5303](https://github.com/netbox-community/netbox/issues/5303) - A virtual machine may be assigned to a site and/or cluster * [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index ba7f661b5..401c9a901 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -252,7 +252,10 @@ class RackElevationDetailFilterSerializer(serializers.Serializer): default=ConfigItem('RACK_ELEVATION_DEFAULT_UNIT_HEIGHT') ) legend_width = serializers.IntegerField( - default=RACK_ELEVATION_LEGEND_WIDTH_DEFAULT + default=RACK_ELEVATION_DEFAULT_LEGEND_WIDTH + ) + margin_width = serializers.IntegerField( + default=RACK_ELEVATION_DEFAULT_MARGIN_WIDTH ) exclude = serializers.IntegerField( required=False, diff --git a/netbox/dcim/constants.py b/netbox/dcim/constants.py index 38bf16f0b..68bbd1dbe 100644 --- a/netbox/dcim/constants.py +++ b/netbox/dcim/constants.py @@ -13,7 +13,8 @@ DEVICETYPE_IMAGE_FORMATS = 'image/bmp,image/gif,image/jpeg,image/png,image/tiff, RACK_U_HEIGHT_DEFAULT = 42 RACK_ELEVATION_BORDER_WIDTH = 2 -RACK_ELEVATION_LEGEND_WIDTH_DEFAULT = 30 +RACK_ELEVATION_DEFAULT_LEGEND_WIDTH = 30 +RACK_ELEVATION_DEFAULT_MARGIN_WIDTH = 15 # diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index 12cc4dd38..39e01cae3 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -367,7 +367,8 @@ class Rack(NetBoxModel): user=None, unit_width=None, unit_height=None, - legend_width=RACK_ELEVATION_LEGEND_WIDTH_DEFAULT, + legend_width=RACK_ELEVATION_DEFAULT_LEGEND_WIDTH, + margin_width=RACK_ELEVATION_DEFAULT_MARGIN_WIDTH, include_images=True, base_url=None ): @@ -381,6 +382,7 @@ class Rack(NetBoxModel): :param unit_height: Height of each rack unit for the rendered drawing. Note this is not the total height of the elevation :param legend_width: Width of the unit legend, in pixels + :param margin_width: Width of the rigth-hand margin, in pixels :param include_images: Embed front/rear device images where available :param base_url: Base URL for links and images. If none, URLs will be relative. """ @@ -389,6 +391,7 @@ class Rack(NetBoxModel): unit_width=unit_width, unit_height=unit_height, legend_width=legend_width, + margin_width=margin_width, user=user, include_images=include_images, base_url=base_url diff --git a/netbox/dcim/svg/racks.py b/netbox/dcim/svg/racks.py index 4d518adf1..b344aad0a 100644 --- a/netbox/dcim/svg/racks.py +++ b/netbox/dcim/svg/racks.py @@ -11,7 +11,7 @@ from django.urls import reverse from django.utils.http import urlencode from netbox.config import get_config -from utilities.utils import foreground_color +from utilities.utils import foreground_color, array_to_ranges from dcim.choices import DeviceFaceChoices from dcim.constants import RACK_ELEVATION_BORDER_WIDTH @@ -55,8 +55,8 @@ class RackElevationSVG: :param include_images: If true, the SVG document will embed front/rear device face images, where available :param base_url: Base URL for links within the SVG document. If none, links will be relative. """ - def __init__(self, rack, unit_height=None, unit_width=None, legend_width=None, user=None, include_images=True, - base_url=None): + def __init__(self, rack, unit_height=None, unit_width=None, legend_width=None, margin_width=None, user=None, + include_images=True, base_url=None): self.rack = rack self.include_images = include_images self.base_url = base_url.rstrip('/') if base_url is not None else '' @@ -65,7 +65,8 @@ class RackElevationSVG: config = get_config() self.unit_width = unit_width or config.RACK_ELEVATION_DEFAULT_UNIT_WIDTH self.unit_height = unit_height or config.RACK_ELEVATION_DEFAULT_UNIT_HEIGHT - self.legend_width = legend_width or config.RACK_ELEVATION_LEGEND_WIDTH_DEFAULT + self.legend_width = legend_width or config.RACK_ELEVATION_DEFAULT_LEGEND_WIDTH + self.margin_width = margin_width or config.RACK_ELEVATION_DEFAULT_MARGIN_WIDTH # Determine the subset of devices within this rack that are viewable by the user, if any permitted_devices = self.rack.devices @@ -91,7 +92,7 @@ class RackElevationSVG: drawing.defs.add(gradient) def _setup_drawing(self): - width = self.unit_width + self.legend_width + RACK_ELEVATION_BORDER_WIDTH * 2 + width = self.unit_width + self.legend_width + self.margin_width + RACK_ELEVATION_BORDER_WIDTH * 2 height = self.unit_height * self.rack.u_height + RACK_ELEVATION_BORDER_WIDTH * 2 drawing = svgwrite.Drawing(size=(width, height)) @@ -100,6 +101,7 @@ class RackElevationSVG: drawing.defs.add(drawing.style(css_file.read())) # Add gradients + RackElevationSVG._add_gradient(drawing, 'reserved', '#b0b0ff') RackElevationSVG._add_gradient(drawing, 'occupied', '#d7d7d7') RackElevationSVG._add_gradient(drawing, 'blocked', '#ffc0c0') @@ -198,6 +200,29 @@ class RackElevationSVG: Text(str(unit), position_coordinates, class_='unit') ) + def draw_margin(self): + """ + Draw any rack reservations in the right-hand margin alongside the rack elevation. + """ + for reservation in self.rack.reservations.all(): + for segment in array_to_ranges(reservation.units): + u_height = 1 if len(segment) == 1 else segment[1] + 1 - segment[0] + coords = self._get_device_coords(segment[0], u_height) + coords = (coords[0] + self.unit_width + RACK_ELEVATION_BORDER_WIDTH * 2, coords[1]) + size = ( + self.margin_width, + u_height * self.unit_height + ) + link = Hyperlink( + href='{}{}'.format(self.base_url, reservation.get_absolute_url()), + target='_blank' + ) + link.set_desc(f'Reservation #{reservation.pk}: {reservation.description}') + link.add( + Rect(coords, size, class_='reservation') + ) + self.drawing.add(link) + def draw_background(self, face): """ Draw the rack unit placeholders which form the "background" of the rack elevation. @@ -261,16 +286,12 @@ class RackElevationSVG: # Initialize the drawing self.drawing = self._setup_drawing() - # Draw the empty rack & legend + # Draw the empty rack, legend, and margin self.draw_legend() self.draw_background(face) + self.draw_margin() - # Draw the opposite rack face first, then the near face - if face == DeviceFaceChoices.FACE_REAR: - opposite_face = DeviceFaceChoices.FACE_FRONT - else: - opposite_face = DeviceFaceChoices.FACE_REAR - # self.draw_face(opposite_face, opposite=True) + # Draw the rack face self.draw_face(face) # Draw the rack border last diff --git a/netbox/project-static/dist/rack_elevation.css b/netbox/project-static/dist/rack_elevation.css index 4f9361489cf7fe2a5553150afc12f6de625c9072..bfeed4150cf8f390dbb586e2e698af26ad196f89 100644 GIT binary patch delta 57 zcmaFP-Os&YDa&L{*1fvLW$6lfMXAN9MP-R4nfZCq$vKI|#j(|CnK?ODrA0X!$`Hxa I6wO*L0D|5Xxc~qF delta 114 zcmeC@e$KsNDN9&UYH?~&S!#+^Mt)gpQFL-nVsUY-wq9aNif&43S!Qx-by{Xlj+L^3 nfkAC?S-OH=aZY}T9!wWhy$-s}WI [(0, 2), (10,), (14, 16)]" + """ + group = ( + list(x) for _, x in groupby(sorted(array), lambda x, c=count(): next(c) - x) + ) + return [ + (g[0], g[-1])[:len(g)] for g in group + ] + + def array_to_string(array): """ Generate an efficient, human-friendly string from a set of integers. Intended for use with ArrayField. For example: [0, 1, 2, 10, 14, 15, 16] => "0-2, 10, 14-16" """ - group = (list(x) for _, x in groupby(sorted(array), lambda x, c=count(): next(c) - x)) - return ', '.join('-'.join(map(str, (g[0], g[-1])[:len(g)])) for g in group) + ret = [] + ranges = array_to_ranges(array) + for value in ranges: + if len(value) == 1: + ret.append(str(value[0])) + else: + ret.append(f'{value[0]}-{value[1]}') + return ', '.join(ret) def content_type_name(ct): From 4587b83d8581ef4c945328c964764658837d784d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 21 Jun 2022 21:22:24 -0400 Subject: [PATCH 150/593] Closes #1099: Add PoE mode & type for interfaces --- docs/models/dcim/interface.md | 4 + docs/release-notes/version-3.3.md | 4 + netbox/dcim/api/serializers.py | 10 +- netbox/dcim/choices.py | 45 +++++++ netbox/dcim/filtersets.py | 10 +- netbox/dcim/forms/bulk_create.py | 7 +- netbox/dcim/forms/bulk_edit.py | 17 ++- netbox/dcim/forms/bulk_import.py | 16 ++- netbox/dcim/forms/filtersets.py | 9 ++ netbox/dcim/forms/models.py | 9 +- netbox/dcim/graphql/types.py | 6 + .../0155_interface_poe_mode_type.py | 23 ++++ netbox/dcim/models/device_components.py | 32 ++++- netbox/dcim/tables/devices.py | 8 +- netbox/dcim/tests/test_api.py | 2 + netbox/dcim/tests/test_filtersets.py | 119 ++++++++++++++++-- netbox/dcim/tests/test_views.py | 14 ++- netbox/templates/dcim/interface.html | 8 ++ 18 files changed, 310 insertions(+), 33 deletions(-) create mode 100644 netbox/dcim/migrations/0155_interface_poe_mode_type.py diff --git a/docs/models/dcim/interface.md b/docs/models/dcim/interface.md index 7fa52fa9f..e3237c2ee 100644 --- a/docs/models/dcim/interface.md +++ b/docs/models/dcim/interface.md @@ -11,6 +11,10 @@ Interfaces may be physical or virtual in nature, but only physical interfaces ma Physical interfaces may be arranged into a link aggregation group (LAG) and associated with a parent LAG (virtual) interface. LAG interfaces can be recursively nested to model bonding of trunk groups. Like all virtual interfaces, LAG interfaces cannot be connected physically. +### Power over Ethernet (PoE) + +Physical interfaces can be assigned a PoE mode to indicate PoE capability: power supplying equipment (PSE) or powered device (PD). Additionally, a PoE mode may be specified. This can be one of the listed IEEE 802.3 standards, or a passive setting (24 or 48 volts across two or four pairs). + ### Wireless Interfaces Wireless interfaces may additionally track the following attributes: diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index fc8c24f4c..801e45b51 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -11,6 +11,8 @@ #### Half-Height Rack Units ([#51](https://github.com/netbox-community/netbox/issues/51)) +#### PoE Interface Attributes ([#1099](https://github.com/netbox-community/netbox/issues/1099)) + ### Enhancements * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses @@ -33,6 +35,8 @@ * The `position` field has been changed from an integer to a decimal * dcim.DeviceType * The `u_height` field has been changed from an integer to a decimal +* dcim.Interface + * Added the option `poe_mode` and `poe_type` fields * dcim.Rack * The `elevation` endpoint now includes half-height rack units, and utilizes decimal values for the ID and name of each unit * extras.CustomField diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 401c9a901..f3d223d4c 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -812,6 +812,8 @@ class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn duplex = ChoiceField(choices=InterfaceDuplexChoices, required=False, allow_blank=True) rf_role = ChoiceField(choices=WirelessRoleChoices, required=False, allow_blank=True) rf_channel = ChoiceField(choices=WirelessChannelChoices, required=False, allow_blank=True) + poe_mode = ChoiceField(choices=InterfacePoEModeChoices, required=False, allow_blank=True) + poe_type = ChoiceField(choices=InterfacePoETypeChoices, required=False, allow_blank=True) untagged_vlan = NestedVLANSerializer(required=False, allow_null=True) tagged_vlans = SerializedPKRelatedField( queryset=VLAN.objects.all(), @@ -836,10 +838,10 @@ class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'enabled', 'parent', 'bridge', 'lag', 'mtu', 'mac_address', 'speed', 'duplex', 'wwn', 'mgmt_only', 'description', 'mode', 'rf_role', 'rf_channel', - 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'untagged_vlan', 'tagged_vlans', 'mark_connected', - 'cable', 'wireless_link', 'link_peer', 'link_peer_type', 'wireless_lans', 'vrf', 'connected_endpoint', - 'connected_endpoint_type', 'connected_endpoint_reachable', 'tags', 'custom_fields', 'created', - 'last_updated', 'count_ipaddresses', 'count_fhrp_groups', '_occupied', + 'poe_mode', 'poe_type', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'untagged_vlan', + 'tagged_vlans', 'mark_connected', 'cable', 'wireless_link', 'link_peer', 'link_peer_type', 'wireless_lans', + 'vrf', 'connected_endpoint', 'connected_endpoint_type', 'connected_endpoint_reachable', 'tags', + 'custom_fields', 'created', 'last_updated', 'count_ipaddresses', 'count_fhrp_groups', '_occupied', ] def validate(self, data): diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index 2e96f9c67..44ec3fb88 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -1003,6 +1003,51 @@ class InterfaceModeChoices(ChoiceSet): ) +class InterfacePoEModeChoices(ChoiceSet): + + MODE_PD = 'pd' + MODE_PSE = 'pse' + + CHOICES = ( + (MODE_PD, 'Powered device (PD)'), + (MODE_PSE, 'Power sourcing equipment (PSE)'), + ) + + +class InterfacePoETypeChoices(ChoiceSet): + + TYPE_1_8023AF = 'type1-ieee802.3af' + TYPE_2_8023AT = 'type2-ieee802.3at' + TYPE_3_8023BT = 'type3-ieee802.3bt' + TYPE_4_8023BT = 'type4-ieee802.3bt' + + PASSIVE_24V_2PAIR = 'passive-24v-2pair' + PASSIVE_24V_4PAIR = 'passive-24v-4pair' + PASSIVE_48V_2PAIR = 'passive-48v-2pair' + PASSIVE_48V_4PAIR = 'passive-48v-4pair' + + CHOICES = ( + ( + 'IEEE Standard', + ( + (TYPE_1_8023AF, '802.3af (Type 1)'), + (TYPE_2_8023AT, '802.3at (Type 2)'), + (TYPE_3_8023BT, '802.3bt (Type 3)'), + (TYPE_4_8023BT, '802.3bt (Type 4)'), + ) + ), + ( + 'Passive', + ( + (PASSIVE_24V_2PAIR, 'Passive 24V (2-pair)'), + (PASSIVE_24V_4PAIR, 'Passive 24V (4-pair)'), + (PASSIVE_48V_2PAIR, 'Passive 48V (2-pair)'), + (PASSIVE_48V_2PAIR, 'Passive 48V (4-pair)'), + ) + ), + ) + + # # FrontPorts/RearPorts # diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index f052a8be9..7c2d02bb3 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -1238,6 +1238,12 @@ class InterfaceFilterSet( ) mac_address = MultiValueMACAddressFilter() wwn = MultiValueWWNFilter() + poe_mode = django_filters.MultipleChoiceFilter( + choices=InterfacePoEModeChoices + ) + poe_type = django_filters.MultipleChoiceFilter( + choices=InterfacePoETypeChoices + ) vlan_id = django_filters.CharFilter( method='filter_vlan_id', label='Assigned VLAN' @@ -1271,8 +1277,8 @@ class InterfaceFilterSet( class Meta: model = Interface fields = [ - 'id', 'name', 'label', 'type', 'enabled', 'mtu', 'mgmt_only', 'mode', 'rf_role', 'rf_channel', - 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'description', + 'id', 'name', 'label', 'type', 'enabled', 'mtu', 'mgmt_only', 'poe_mode', 'poe_type', 'mode', 'rf_role', + 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'description', ] def filter_device(self, queryset, name, value): diff --git a/netbox/dcim/forms/bulk_create.py b/netbox/dcim/forms/bulk_create.py index 314a7a75f..43b852928 100644 --- a/netbox/dcim/forms/bulk_create.py +++ b/netbox/dcim/forms/bulk_create.py @@ -72,12 +72,15 @@ class PowerOutletBulkCreateForm( class InterfaceBulkCreateForm( - form_from_model(Interface, ['type', 'enabled', 'speed', 'duplex', 'mtu', 'mgmt_only', 'mark_connected']), + form_from_model(Interface, [ + 'type', 'enabled', 'speed', 'duplex', 'mtu', 'mgmt_only', 'mark_connected', 'poe_mode', 'poe_type', + ]), DeviceBulkAddComponentForm ): model = Interface field_order = ( - 'name_pattern', 'label_pattern', 'type', 'enabled', 'speed', 'duplex', 'mtu', 'mgmt_only', 'mark_connected', 'description', 'tags', + 'name_pattern', 'label_pattern', 'type', 'enabled', 'speed', 'duplex', 'mtu', 'mgmt_only', 'poe_mode', + 'poe_type', 'mark_connected', 'description', 'tags', ) diff --git a/netbox/dcim/forms/bulk_edit.py b/netbox/dcim/forms/bulk_edit.py index 231d01ddd..88f043c32 100644 --- a/netbox/dcim/forms/bulk_edit.py +++ b/netbox/dcim/forms/bulk_edit.py @@ -1063,6 +1063,18 @@ class InterfaceBulkEditForm( widget=BulkEditNullBooleanSelect, label='Management only' ) + poe_mode = forms.ChoiceField( + choices=add_blank_choice(InterfacePoEModeChoices), + required=False, + initial='', + widget=StaticSelect() + ) + poe_type = forms.ChoiceField( + choices=add_blank_choice(InterfacePoETypeChoices), + required=False, + initial='', + widget=StaticSelect() + ) mark_connected = forms.NullBooleanField( required=False, widget=BulkEditNullBooleanSelect @@ -1105,14 +1117,15 @@ class InterfaceBulkEditForm( (None, ('module', 'type', 'label', 'speed', 'duplex', 'description')), ('Addressing', ('vrf', 'mac_address', 'wwn')), ('Operation', ('mtu', 'tx_power', 'enabled', 'mgmt_only', 'mark_connected')), + ('PoE', ('poe_mode', 'poe_type')), ('Related Interfaces', ('parent', 'bridge', 'lag')), ('802.1Q Switching', ('mode', 'vlan_group', 'untagged_vlan', 'tagged_vlans')), ('Wireless', ('rf_role', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width')), ) nullable_fields = ( 'module', 'label', 'parent', 'bridge', 'lag', 'speed', 'duplex', 'mac_address', 'wwn', 'mtu', 'description', - 'mode', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'vlan_group', 'untagged_vlan', - 'tagged_vlans', 'vrf', + 'poe_mode', 'poe_type', 'mode', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', + 'vlan_group', 'untagged_vlan', 'tagged_vlans', 'vrf', ) def __init__(self, *args, **kwargs): diff --git a/netbox/dcim/forms/bulk_import.py b/netbox/dcim/forms/bulk_import.py index b28c16fad..292f58785 100644 --- a/netbox/dcim/forms/bulk_import.py +++ b/netbox/dcim/forms/bulk_import.py @@ -622,6 +622,16 @@ class InterfaceCSVForm(NetBoxModelCSVForm): choices=InterfaceDuplexChoices, required=False ) + poe_mode = CSVChoiceField( + choices=InterfacePoEModeChoices, + required=False, + help_text='PoE mode' + ) + poe_type = CSVChoiceField( + choices=InterfacePoETypeChoices, + required=False, + help_text='PoE type' + ) mode = CSVChoiceField( choices=InterfaceModeChoices, required=False, @@ -642,9 +652,9 @@ class InterfaceCSVForm(NetBoxModelCSVForm): class Meta: model = Interface fields = ( - 'device', 'name', 'label', 'parent', 'bridge', 'lag', 'type', 'speed', 'duplex', 'enabled', 'mark_connected', 'mac_address', - 'wwn', 'mtu', 'mgmt_only', 'description', 'mode', 'vrf', 'rf_role', 'rf_channel', 'rf_channel_frequency', - 'rf_channel_width', 'tx_power', + 'device', 'name', 'label', 'parent', 'bridge', 'lag', 'type', 'speed', 'duplex', 'enabled', + 'mark_connected', 'mac_address', 'wwn', 'mtu', 'mgmt_only', 'description', 'poe_mode', 'poe_type', 'mode', + 'vrf', 'rf_role', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', ) def __init__(self, data=None, *args, **kwargs): diff --git a/netbox/dcim/forms/filtersets.py b/netbox/dcim/forms/filtersets.py index 1535e5718..bdef32ec3 100644 --- a/netbox/dcim/forms/filtersets.py +++ b/netbox/dcim/forms/filtersets.py @@ -969,6 +969,7 @@ class InterfaceFilterForm(DeviceComponentFilterForm): (None, ('q', 'tag')), ('Attributes', ('name', 'label', 'kind', 'type', 'speed', 'duplex', 'enabled', 'mgmt_only')), ('Addressing', ('vrf_id', 'mac_address', 'wwn')), + ('PoE', ('poe_mode', 'poe_type')), ('Wireless', ('rf_role', 'rf_channel', 'rf_channel_width', 'tx_power')), ('Device', ('region_id', 'site_group_id', 'site_id', 'location_id', 'virtual_chassis_id', 'device_id')), ) @@ -1009,6 +1010,14 @@ class InterfaceFilterForm(DeviceComponentFilterForm): required=False, label='WWN' ) + poe_mode = MultipleChoiceField( + choices=InterfacePoEModeChoices, + required=False + ) + poe_type = MultipleChoiceField( + choices=InterfacePoEModeChoices, + required=False + ) rf_role = MultipleChoiceField( choices=WirelessRoleChoices, required=False, diff --git a/netbox/dcim/forms/models.py b/netbox/dcim/forms/models.py index fe461b061..c58500198 100644 --- a/netbox/dcim/forms/models.py +++ b/netbox/dcim/forms/models.py @@ -1314,6 +1314,7 @@ class InterfaceForm(InterfaceCommonForm, NetBoxModelForm): ('Addressing', ('vrf', 'mac_address', 'wwn')), ('Operation', ('mtu', 'tx_power', 'enabled', 'mgmt_only', 'mark_connected')), ('Related Interfaces', ('parent', 'bridge', 'lag')), + ('PoE', ('poe_mode', 'poe_type')), ('802.1Q Switching', ('mode', 'vlan_group', 'untagged_vlan', 'tagged_vlans')), ('Wireless', ( 'rf_role', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'wireless_lan_group', 'wireless_lans', @@ -1324,14 +1325,16 @@ class InterfaceForm(InterfaceCommonForm, NetBoxModelForm): model = Interface fields = [ 'device', 'module', 'name', 'label', 'type', 'speed', 'duplex', 'enabled', 'parent', 'bridge', 'lag', - 'mac_address', 'wwn', 'mtu', 'mgmt_only', 'mark_connected', 'description', 'mode', 'rf_role', 'rf_channel', - 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'wireless_lans', 'untagged_vlan', 'tagged_vlans', - 'vrf', 'tags', + 'mac_address', 'wwn', 'mtu', 'mgmt_only', 'mark_connected', 'description', 'poe_mode', 'poe_type', 'mode', + 'rf_role', 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'wireless_lans', + 'untagged_vlan', 'tagged_vlans', 'vrf', 'tags', ] widgets = { 'device': forms.HiddenInput(), 'type': StaticSelect(), 'speed': SelectSpeedWidget(), + 'poe_mode': StaticSelect(), + 'poe_type': StaticSelect(), 'duplex': StaticSelect(), 'mode': StaticSelect(), 'rf_role': StaticSelect(), diff --git a/netbox/dcim/graphql/types.py b/netbox/dcim/graphql/types.py index d25a6bba6..17d6bc646 100644 --- a/netbox/dcim/graphql/types.py +++ b/netbox/dcim/graphql/types.py @@ -226,6 +226,12 @@ class InterfaceType(IPAddressesMixin, ComponentObjectType): exclude = ('_path',) filterset_class = filtersets.InterfaceFilterSet + def resolve_poe_mode(self, info): + return self.poe_mode or None + + def resolve_poe_type(self, info): + return self.poe_type or None + def resolve_mode(self, info): return self.mode or None diff --git a/netbox/dcim/migrations/0155_interface_poe_mode_type.py b/netbox/dcim/migrations/0155_interface_poe_mode_type.py new file mode 100644 index 000000000..0615d5d7e --- /dev/null +++ b/netbox/dcim/migrations/0155_interface_poe_mode_type.py @@ -0,0 +1,23 @@ +# Generated by Django 4.0.5 on 2022-06-22 00:36 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0154_half_height_rack_units'), + ] + + operations = [ + migrations.AddField( + model_name='interface', + name='poe_mode', + field=models.CharField(blank=True, max_length=50), + ), + migrations.AddField( + model_name='interface', + name='poe_type', + field=models.CharField(blank=True, max_length=50), + ), + ] diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 9a0609c12..f49db08ab 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -590,6 +590,18 @@ class Interface(ModularComponentModel, BaseInterface, LinkTermination, PathEndpo validators=(MaxValueValidator(127),), verbose_name='Transmit power (dBm)' ) + poe_mode = models.CharField( + max_length=50, + choices=InterfacePoEModeChoices, + blank=True, + verbose_name='PoE mode' + ) + poe_type = models.CharField( + max_length=50, + choices=InterfacePoETypeChoices, + blank=True, + verbose_name='PoE type' + ) wireless_link = models.ForeignKey( to='wireless.WirelessLink', on_delete=models.SET_NULL, @@ -638,7 +650,7 @@ class Interface(ModularComponentModel, BaseInterface, LinkTermination, PathEndpo related_query_name='+' ) - clone_fields = ['device', 'parent', 'bridge', 'lag', 'type', 'mgmt_only'] + clone_fields = ['device', 'parent', 'bridge', 'lag', 'type', 'mgmt_only', 'poe_mode', 'poe_type'] class Meta: ordering = ('device', CollateAsChar('_name')) @@ -726,6 +738,24 @@ class Interface(ModularComponentModel, BaseInterface, LinkTermination, PathEndpo f"of virtual chassis {self.device.virtual_chassis}." }) + # PoE validation + + # Only physical interfaces may have a PoE mode/type assigned + if self.poe_mode and self.is_virtual: + raise ValidationError({ + 'poe_mode': "Virtual interfaces cannot have a PoE mode." + }) + if self.poe_type and self.is_virtual: + raise ValidationError({ + 'poe_type': "Virtual interfaces cannot have a PoE type." + }) + + # An interface with a PoE type set must also specify a mode + if self.poe_type and not self.poe_mode: + raise ValidationError({ + 'poe_type': "Must specify PoE mode when designating a PoE type." + }) + # Wireless validation # RF role & channel may only be set for wireless interfaces diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index 0f015b7f3..b3dd700cb 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -520,10 +520,10 @@ class InterfaceTable(ModularDeviceComponentTable, BaseInterfaceTable, PathEndpoi model = Interface fields = ( 'pk', 'id', 'name', 'device', 'module_bay', 'module', 'label', 'enabled', 'type', 'mgmt_only', 'mtu', - 'speed', 'duplex', 'mode', 'mac_address', 'wwn', 'rf_role', 'rf_channel', 'rf_channel_frequency', - 'rf_channel_width', 'tx_power', 'description', 'mark_connected', 'cable', 'cable_color', 'wireless_link', - 'wireless_lans', 'link_peer', 'connection', 'tags', 'vrf', 'ip_addresses', 'fhrp_groups', 'untagged_vlan', - 'tagged_vlans', 'created', 'last_updated', + 'speed', 'duplex', 'mode', 'mac_address', 'wwn', 'poe_mode', 'poe_type', 'rf_role', 'rf_channel', + 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'description', 'mark_connected', 'cable', + 'cable_color', 'wireless_link', 'wireless_lans', 'link_peer', 'connection', 'tags', 'vrf', 'ip_addresses', + 'fhrp_groups', 'untagged_vlan', 'tagged_vlans', 'created', 'last_updated', ) default_columns = ('pk', 'name', 'device', 'label', 'enabled', 'type', 'description') diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index a6631208b..a61b44f91 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -1507,6 +1507,8 @@ class InterfaceTest(Mixins.ComponentTraceMixin, APIViewTestCases.APIViewTestCase 'speed': 1000000, 'duplex': 'full', 'vrf': vrfs[0].pk, + 'poe_mode': InterfacePoEModeChoices.MODE_PD, + 'poe_type': InterfacePoETypeChoices.TYPE_1_8023AF, 'tagged_vlans': [vlans[0].pk, vlans[1].pk], 'untagged_vlan': vlans[2].pk, }, diff --git a/netbox/dcim/tests/test_filtersets.py b/netbox/dcim/tests/test_filtersets.py index 273ee6570..f7d4c4e0a 100644 --- a/netbox/dcim/tests/test_filtersets.py +++ b/netbox/dcim/tests/test_filtersets.py @@ -2540,14 +2540,109 @@ class InterfaceTestCase(TestCase, ChangeLoggedFilterSetTests): Device.objects.filter(pk=devices[1].pk).update(virtual_chassis=virtual_chassis, vc_position=2, vc_priority=2) interfaces = ( - Interface(device=devices[0], module=modules[0], name='Interface 1', label='A', type=InterfaceTypeChoices.TYPE_1GE_SFP, enabled=True, mgmt_only=True, mtu=100, mode=InterfaceModeChoices.MODE_ACCESS, mac_address='00-00-00-00-00-01', description='First', vrf=vrfs[0], speed=1000000, duplex='half'), - Interface(device=devices[1], module=modules[1], name='Interface 2', label='B', type=InterfaceTypeChoices.TYPE_1GE_GBIC, enabled=True, mgmt_only=True, mtu=200, mode=InterfaceModeChoices.MODE_TAGGED, mac_address='00-00-00-00-00-02', description='Second', vrf=vrfs[1], speed=1000000, duplex='full'), - Interface(device=devices[2], module=modules[2], name='Interface 3', label='C', type=InterfaceTypeChoices.TYPE_1GE_FIXED, enabled=False, mgmt_only=False, mtu=300, mode=InterfaceModeChoices.MODE_TAGGED_ALL, mac_address='00-00-00-00-00-03', description='Third', vrf=vrfs[2], speed=100000, duplex='half'), - Interface(device=devices[3], name='Interface 4', label='D', type=InterfaceTypeChoices.TYPE_OTHER, enabled=True, mgmt_only=True, tx_power=40, speed=100000, duplex='full'), - Interface(device=devices[3], name='Interface 5', label='E', type=InterfaceTypeChoices.TYPE_OTHER, enabled=True, mgmt_only=True, tx_power=40), - Interface(device=devices[3], name='Interface 6', label='F', type=InterfaceTypeChoices.TYPE_OTHER, enabled=False, mgmt_only=False, tx_power=40), - Interface(device=devices[3], name='Interface 7', type=InterfaceTypeChoices.TYPE_80211AC, rf_role=WirelessRoleChoices.ROLE_AP, rf_channel=WirelessChannelChoices.CHANNEL_24G_1, rf_channel_frequency=2412, rf_channel_width=22), - Interface(device=devices[3], name='Interface 8', type=InterfaceTypeChoices.TYPE_80211AC, rf_role=WirelessRoleChoices.ROLE_STATION, rf_channel=WirelessChannelChoices.CHANNEL_5G_32, rf_channel_frequency=5160, rf_channel_width=20), + Interface( + device=devices[0], + module=modules[0], + name='Interface 1', + label='A', + type=InterfaceTypeChoices.TYPE_1GE_SFP, + enabled=True, + mgmt_only=True, + mtu=100, + mode=InterfaceModeChoices.MODE_ACCESS, + mac_address='00-00-00-00-00-01', + description='First', + vrf=vrfs[0], + speed=1000000, + duplex='half', + poe_mode=InterfacePoEModeChoices.MODE_PSE, + poe_type=InterfacePoETypeChoices.TYPE_1_8023AF + ), + Interface( + device=devices[1], + module=modules[1], + name='Interface 2', + label='B', + type=InterfaceTypeChoices.TYPE_1GE_GBIC, + enabled=True, + mgmt_only=True, + mtu=200, + mode=InterfaceModeChoices.MODE_TAGGED, + mac_address='00-00-00-00-00-02', + description='Second', + vrf=vrfs[1], + speed=1000000, + duplex='full', + poe_mode=InterfacePoEModeChoices.MODE_PD, + poe_type=InterfacePoETypeChoices.TYPE_1_8023AF + ), + Interface( + device=devices[2], + module=modules[2], + name='Interface 3', + label='C', + type=InterfaceTypeChoices.TYPE_1GE_FIXED, + enabled=False, + mgmt_only=False, + mtu=300, + mode=InterfaceModeChoices.MODE_TAGGED_ALL, + mac_address='00-00-00-00-00-03', + description='Third', + vrf=vrfs[2], + speed=100000, + duplex='half', + poe_mode=InterfacePoEModeChoices.MODE_PSE, + poe_type=InterfacePoETypeChoices.TYPE_2_8023AT + ), + Interface( + device=devices[3], + name='Interface 4', + label='D', + type=InterfaceTypeChoices.TYPE_OTHER, + enabled=True, + mgmt_only=True, + tx_power=40, + speed=100000, + duplex='full', + poe_mode=InterfacePoEModeChoices.MODE_PD, + poe_type=InterfacePoETypeChoices.TYPE_2_8023AT + ), + Interface( + device=devices[3], + name='Interface 5', + label='E', + type=InterfaceTypeChoices.TYPE_OTHER, + enabled=True, + mgmt_only=True, + tx_power=40 + ), + Interface( + device=devices[3], + name='Interface 6', + label='F', + type=InterfaceTypeChoices.TYPE_OTHER, + enabled=False, + mgmt_only=False, + tx_power=40 + ), + Interface( + device=devices[3], + name='Interface 7', + type=InterfaceTypeChoices.TYPE_80211AC, + rf_role=WirelessRoleChoices.ROLE_AP, + rf_channel=WirelessChannelChoices.CHANNEL_24G_1, + rf_channel_frequency=2412, + rf_channel_width=22 + ), + Interface( + device=devices[3], + name='Interface 8', + type=InterfaceTypeChoices.TYPE_80211AC, + rf_role=WirelessRoleChoices.ROLE_STATION, + rf_channel=WirelessChannelChoices.CHANNEL_5G_32, + rf_channel_frequency=5160, + rf_channel_width=20 + ), ) Interface.objects.bulk_create(interfaces) @@ -2594,6 +2689,14 @@ class InterfaceTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'mgmt_only': 'false'} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) + def test_poe_mode(self): + params = {'poe_mode': [InterfacePoEModeChoices.MODE_PD, InterfacePoEModeChoices.MODE_PSE]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) + + def test_poe_type(self): + params = {'poe_type': [InterfacePoETypeChoices.TYPE_1_8023AF, InterfacePoETypeChoices.TYPE_2_8023AT]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) + def test_mode(self): params = {'mode': InterfaceModeChoices.MODE_ACCESS} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) diff --git a/netbox/dcim/tests/test_views.py b/netbox/dcim/tests/test_views.py index e17f94682..9cce21a21 100644 --- a/netbox/dcim/tests/test_views.py +++ b/netbox/dcim/tests/test_views.py @@ -2204,6 +2204,8 @@ class InterfaceTestCase(ViewTestCases.DeviceComponentViewTestCase): 'description': 'A front port', 'mode': InterfaceModeChoices.MODE_TAGGED, 'tx_power': 10, + 'poe_mode': InterfacePoEModeChoices.MODE_PSE, + 'poe_type': InterfacePoETypeChoices.TYPE_1_8023AF, 'untagged_vlan': vlans[0].pk, 'tagged_vlans': [v.pk for v in vlans[1:4]], 'wireless_lans': [wireless_lans[0].pk, wireless_lans[1].pk], @@ -2225,6 +2227,8 @@ class InterfaceTestCase(ViewTestCases.DeviceComponentViewTestCase): 'duplex': 'half', 'mgmt_only': True, 'description': 'A front port', + 'poe_mode': InterfacePoEModeChoices.MODE_PSE, + 'poe_type': InterfacePoETypeChoices.TYPE_1_8023AF, 'mode': InterfaceModeChoices.MODE_TAGGED, 'untagged_vlan': vlans[0].pk, 'tagged_vlans': [v.pk for v in vlans[1:4]], @@ -2244,6 +2248,8 @@ class InterfaceTestCase(ViewTestCases.DeviceComponentViewTestCase): 'duplex': 'full', 'mgmt_only': True, 'description': 'New description', + 'poe_mode': InterfacePoEModeChoices.MODE_PD, + 'poe_type': InterfacePoETypeChoices.TYPE_2_8023AT, 'mode': InterfaceModeChoices.MODE_TAGGED, 'tx_power': 10, 'untagged_vlan': vlans[0].pk, @@ -2252,10 +2258,10 @@ class InterfaceTestCase(ViewTestCases.DeviceComponentViewTestCase): } cls.csv_data = ( - f"device,name,type,vrf.pk", - f"Device 1,Interface 4,1000base-t,{vrfs[0].pk}", - f"Device 1,Interface 5,1000base-t,{vrfs[0].pk}", - f"Device 1,Interface 6,1000base-t,{vrfs[0].pk}", + f"device,name,type,vrf.pk,poe_mode,poe_type", + f"Device 1,Interface 4,1000base-t,{vrfs[0].pk},pse,type1-ieee802.3af", + f"Device 1,Interface 5,1000base-t,{vrfs[0].pk},pse,type1-ieee802.3af", + f"Device 1,Interface 6,1000base-t,{vrfs[0].pk},pse,type1-ieee802.3af", ) @override_settings(EXEMPT_VIEW_PERMISSIONS=['*']) diff --git a/netbox/templates/dcim/interface.html b/netbox/templates/dcim/interface.html index c4cb8b72f..e98750518 100644 --- a/netbox/templates/dcim/interface.html +++ b/netbox/templates/dcim/interface.html @@ -69,6 +69,14 @@       + + + + + + + + From e4aa933d57ce8b7a5328962f021429545f21ce97 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 22 Jun 2022 13:33:19 -0400 Subject: [PATCH 151/593] Closes #7744: Add status field to Location --- docs/models/dcim/location.md | 3 +-- docs/release-notes/version-3.3.md | 5 ++++- netbox/dcim/api/serializers.py | 5 +++-- netbox/dcim/choices.py | 22 +++++++++++++++++++ netbox/dcim/filtersets.py | 6 ++++- netbox/dcim/forms/bulk_edit.py | 8 ++++++- netbox/dcim/forms/bulk_import.py | 6 ++++- netbox/dcim/forms/filtersets.py | 6 ++++- netbox/dcim/forms/models.py | 8 +++++-- .../dcim/migrations/0156_location_status.py | 18 +++++++++++++++ netbox/dcim/models/sites.py | 10 ++++++++- netbox/dcim/tables/sites.py | 7 +++--- netbox/dcim/tests/test_api.py | 13 ++++++----- netbox/dcim/tests/test_filtersets.py | 10 ++++++--- netbox/dcim/tests/test_views.py | 15 +++++++------ netbox/templates/dcim/location.html | 4 ++++ 16 files changed, 116 insertions(+), 30 deletions(-) create mode 100644 netbox/dcim/migrations/0156_location_status.py diff --git a/docs/models/dcim/location.md b/docs/models/dcim/location.md index 901a68acf..fb72c218d 100644 --- a/docs/models/dcim/location.md +++ b/docs/models/dcim/location.md @@ -2,5 +2,4 @@ Racks and devices can be grouped by location within a site. A location may represent a floor, room, cage, or similar organizational unit. Locations can be nested to form a hierarchy. For example, you may have floors within a site, and rooms within a floor. -Each location must have a name that is unique within its parent site and location, if any. - +Each location must have a name that is unique within its parent site and location, if any, and must be assigned an operational status. (The set of available statuses is configurable.) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 801e45b51..6b825bd45 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -18,6 +18,7 @@ * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses * [#4350](https://github.com/netbox-community/netbox/issues/4350) - Illustrate reservations vertically alongside rack elevations * [#5303](https://github.com/netbox-community/netbox/issues/5303) - A virtual machine may be assigned to a site and/or cluster +* [#7744](https://github.com/netbox-community/netbox/issues/7744) - Add `status` field to Location * [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping @@ -36,7 +37,9 @@ * dcim.DeviceType * The `u_height` field has been changed from an integer to a decimal * dcim.Interface - * Added the option `poe_mode` and `poe_type` fields + * Added the optional `poe_mode` and `poe_type` fields +* dcim.Location + * Added required `status` field (default value: `active`) * dcim.Rack * The `elevation` endpoint now includes half-height rack units, and utilizes decimal values for the ID and name of each unit * extras.CustomField diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index f3d223d4c..8ac2aa738 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -151,6 +151,7 @@ class LocationSerializer(NestedGroupModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:location-detail') site = NestedSiteSerializer() parent = NestedLocationSerializer(required=False, allow_null=True) + status = ChoiceField(choices=LocationStatusChoices, required=False) tenant = NestedTenantSerializer(required=False, allow_null=True) rack_count = serializers.IntegerField(read_only=True) device_count = serializers.IntegerField(read_only=True) @@ -158,8 +159,8 @@ class LocationSerializer(NestedGroupModelSerializer): class Meta: model = Location fields = [ - 'id', 'url', 'display', 'name', 'slug', 'site', 'parent', 'tenant', 'description', 'tags', 'custom_fields', - 'created', 'last_updated', 'rack_count', 'device_count', '_depth', + 'id', 'url', 'display', 'name', 'slug', 'site', 'parent', 'status', 'tenant', 'description', 'tags', + 'custom_fields', 'created', 'last_updated', 'rack_count', 'device_count', '_depth', ] diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index 44ec3fb88..94c8b255f 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -23,6 +23,28 @@ class SiteStatusChoices(ChoiceSet): ] +# +# Locations +# + +class LocationStatusChoices(ChoiceSet): + key = 'Location.status' + + STATUS_PLANNED = 'planned' + STATUS_STAGING = 'staging' + STATUS_ACTIVE = 'active' + STATUS_DECOMMISSIONING = 'decommissioning' + STATUS_RETIRED = 'retired' + + CHOICES = [ + (STATUS_PLANNED, 'Planned', 'cyan'), + (STATUS_STAGING, 'Staging', 'blue'), + (STATUS_ACTIVE, 'Active', 'green'), + (STATUS_DECOMMISSIONING, 'Decommissioning', 'yellow'), + (STATUS_RETIRED, 'Retired', 'red'), + ] + + # # Racks # diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index 7c2d02bb3..628bd58f6 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -216,10 +216,14 @@ class LocationFilterSet(TenancyFilterSet, ContactModelFilterSet, OrganizationalM to_field_name='slug', label='Location (slug)', ) + status = django_filters.MultipleChoiceFilter( + choices=LocationStatusChoices, + null_value=None + ) class Meta: model = Location - fields = ['id', 'name', 'slug', 'description'] + fields = ['id', 'name', 'slug', 'status', 'description'] def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/dcim/forms/bulk_edit.py b/netbox/dcim/forms/bulk_edit.py index 88f043c32..b4ab226ae 100644 --- a/netbox/dcim/forms/bulk_edit.py +++ b/netbox/dcim/forms/bulk_edit.py @@ -158,6 +158,12 @@ class LocationBulkEditForm(NetBoxModelBulkEditForm): 'site_id': '$site' } ) + status = forms.ChoiceField( + choices=add_blank_choice(LocationStatusChoices), + required=False, + initial='', + widget=StaticSelect() + ) tenant = DynamicModelChoiceField( queryset=Tenant.objects.all(), required=False @@ -169,7 +175,7 @@ class LocationBulkEditForm(NetBoxModelBulkEditForm): model = Location fieldsets = ( - (None, ('site', 'parent', 'tenant', 'description')), + (None, ('site', 'parent', 'status', 'tenant', 'description')), ) nullable_fields = ('parent', 'tenant', 'description') diff --git a/netbox/dcim/forms/bulk_import.py b/netbox/dcim/forms/bulk_import.py index 292f58785..d6ec0f6f4 100644 --- a/netbox/dcim/forms/bulk_import.py +++ b/netbox/dcim/forms/bulk_import.py @@ -124,6 +124,10 @@ class LocationCSVForm(NetBoxModelCSVForm): 'invalid_choice': 'Location not found.', } ) + status = CSVChoiceField( + choices=LocationStatusChoices, + help_text='Operational status' + ) tenant = CSVModelChoiceField( queryset=Tenant.objects.all(), required=False, @@ -133,7 +137,7 @@ class LocationCSVForm(NetBoxModelCSVForm): class Meta: model = Location - fields = ('site', 'parent', 'name', 'slug', 'tenant', 'description') + fields = ('site', 'parent', 'name', 'slug', 'status', 'tenant', 'description') class RackRoleCSVForm(NetBoxModelCSVForm): diff --git a/netbox/dcim/forms/filtersets.py b/netbox/dcim/forms/filtersets.py index bdef32ec3..d9bc79fb5 100644 --- a/netbox/dcim/forms/filtersets.py +++ b/netbox/dcim/forms/filtersets.py @@ -166,7 +166,7 @@ class LocationFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelF model = Location fieldsets = ( (None, ('q', 'tag')), - ('Parent', ('region_id', 'site_group_id', 'site_id', 'parent_id')), + ('Attributes', ('region_id', 'site_group_id', 'site_id', 'parent_id', 'status')), ('Tenant', ('tenant_group_id', 'tenant_id')), ('Contacts', ('contact', 'contact_role', 'contact_group')), ) @@ -198,6 +198,10 @@ class LocationFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelF }, label=_('Parent') ) + status = MultipleChoiceField( + choices=LocationStatusChoices, + required=False + ) tag = TagFilterField(model) diff --git a/netbox/dcim/forms/models.py b/netbox/dcim/forms/models.py index c58500198..7aa2a8584 100644 --- a/netbox/dcim/forms/models.py +++ b/netbox/dcim/forms/models.py @@ -194,7 +194,7 @@ class LocationForm(TenancyForm, NetBoxModelForm): fieldsets = ( ('Location', ( - 'region', 'site_group', 'site', 'parent', 'name', 'slug', 'description', 'tags', + 'region', 'site_group', 'site', 'parent', 'name', 'slug', 'status', 'description', 'tags', )), ('Tenancy', ('tenant_group', 'tenant')), ) @@ -202,8 +202,12 @@ class LocationForm(TenancyForm, NetBoxModelForm): class Meta: model = Location fields = ( - 'region', 'site_group', 'site', 'parent', 'name', 'slug', 'description', 'tenant_group', 'tenant', 'tags', + 'region', 'site_group', 'site', 'parent', 'name', 'slug', 'status', 'description', 'tenant_group', 'tenant', + 'tags', ) + widgets = { + 'status': StaticSelect(), + } class RackRoleForm(NetBoxModelForm): diff --git a/netbox/dcim/migrations/0156_location_status.py b/netbox/dcim/migrations/0156_location_status.py new file mode 100644 index 000000000..b20273755 --- /dev/null +++ b/netbox/dcim/migrations/0156_location_status.py @@ -0,0 +1,18 @@ +# Generated by Django 4.0.5 on 2022-06-22 17:10 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0155_interface_poe_mode_type'), + ] + + operations = [ + migrations.AddField( + model_name='location', + name='status', + field=models.CharField(default='active', max_length=50), + ), + ] diff --git a/netbox/dcim/models/sites.py b/netbox/dcim/models/sites.py index d02bd0932..9b7ffdcf4 100644 --- a/netbox/dcim/models/sites.py +++ b/netbox/dcim/models/sites.py @@ -341,6 +341,11 @@ class Location(NestedGroupModel): null=True, db_index=True ) + status = models.CharField( + max_length=50, + choices=LocationStatusChoices, + default=LocationStatusChoices.STATUS_ACTIVE + ) tenant = models.ForeignKey( to='tenancy.Tenant', on_delete=models.PROTECT, @@ -367,7 +372,7 @@ class Location(NestedGroupModel): to='extras.ImageAttachment' ) - clone_fields = ['site', 'parent', 'tenant', 'description'] + clone_fields = ['site', 'parent', 'status', 'tenant', 'description'] class Meta: ordering = ['site', 'name'] @@ -409,6 +414,9 @@ class Location(NestedGroupModel): def get_absolute_url(self): return reverse('dcim:location', args=[self.pk]) + def get_status_color(self): + return LocationStatusChoices.colors.get(self.status) + def clean(self): super().clean() diff --git a/netbox/dcim/tables/sites.py b/netbox/dcim/tables/sites.py index fa3c73e12..83db99aec 100644 --- a/netbox/dcim/tables/sites.py +++ b/netbox/dcim/tables/sites.py @@ -126,6 +126,7 @@ class LocationTable(NetBoxTable): site = tables.Column( linkify=True ) + status = columns.ChoiceFieldColumn() tenant = TenantColumn() rack_count = columns.LinkedCountColumn( viewname='dcim:rack_list', @@ -150,7 +151,7 @@ class LocationTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Location fields = ( - 'pk', 'id', 'name', 'site', 'tenant', 'rack_count', 'device_count', 'description', 'slug', 'contacts', - 'tags', 'actions', 'created', 'last_updated', + 'pk', 'id', 'name', 'site', 'status', 'tenant', 'rack_count', 'device_count', 'description', 'slug', + 'contacts', 'tags', 'actions', 'created', 'last_updated', ) - default_columns = ('pk', 'name', 'site', 'tenant', 'rack_count', 'device_count', 'description') + default_columns = ('pk', 'name', 'site', 'status', 'tenant', 'rack_count', 'device_count', 'description') diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index a61b44f91..436f43b6f 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -197,13 +197,13 @@ class LocationTest(APIViewTestCases.APIViewTestCase): Site.objects.bulk_create(sites) parent_locations = ( - Location.objects.create(site=sites[0], name='Parent Location 1', slug='parent-location-1'), - Location.objects.create(site=sites[1], name='Parent Location 2', slug='parent-location-2'), + Location.objects.create(site=sites[0], name='Parent Location 1', slug='parent-location-1', status=LocationStatusChoices.STATUS_ACTIVE), + Location.objects.create(site=sites[1], name='Parent Location 2', slug='parent-location-2', status=LocationStatusChoices.STATUS_ACTIVE), ) - Location.objects.create(site=sites[0], name='Location 1', slug='location-1', parent=parent_locations[0]) - Location.objects.create(site=sites[0], name='Location 2', slug='location-2', parent=parent_locations[0]) - Location.objects.create(site=sites[0], name='Location 3', slug='location-3', parent=parent_locations[0]) + Location.objects.create(site=sites[0], name='Location 1', slug='location-1', parent=parent_locations[0], status=LocationStatusChoices.STATUS_ACTIVE) + Location.objects.create(site=sites[0], name='Location 2', slug='location-2', parent=parent_locations[0], status=LocationStatusChoices.STATUS_ACTIVE) + Location.objects.create(site=sites[0], name='Location 3', slug='location-3', parent=parent_locations[0], status=LocationStatusChoices.STATUS_ACTIVE) cls.create_data = [ { @@ -211,18 +211,21 @@ class LocationTest(APIViewTestCases.APIViewTestCase): 'slug': 'test-location-4', 'site': sites[1].pk, 'parent': parent_locations[1].pk, + 'status': LocationStatusChoices.STATUS_PLANNED, }, { 'name': 'Test Location 5', 'slug': 'test-location-5', 'site': sites[1].pk, 'parent': parent_locations[1].pk, + 'status': LocationStatusChoices.STATUS_PLANNED, }, { 'name': 'Test Location 6', 'slug': 'test-location-6', 'site': sites[1].pk, 'parent': parent_locations[1].pk, + 'status': LocationStatusChoices.STATUS_PLANNED, }, ] diff --git a/netbox/dcim/tests/test_filtersets.py b/netbox/dcim/tests/test_filtersets.py index f7d4c4e0a..9df75f4c0 100644 --- a/netbox/dcim/tests/test_filtersets.py +++ b/netbox/dcim/tests/test_filtersets.py @@ -265,9 +265,9 @@ class LocationTestCase(TestCase, ChangeLoggedFilterSetTests): location.save() locations = ( - Location(name='Location 1', slug='location-1', site=sites[0], parent=parent_locations[0], description='A'), - Location(name='Location 2', slug='location-2', site=sites[1], parent=parent_locations[1], description='B'), - Location(name='Location 3', slug='location-3', site=sites[2], parent=parent_locations[2], description='C'), + Location(name='Location 1', slug='location-1', site=sites[0], parent=parent_locations[0], status=LocationStatusChoices.STATUS_PLANNED, description='A'), + Location(name='Location 2', slug='location-2', site=sites[1], parent=parent_locations[1], status=LocationStatusChoices.STATUS_STAGING, description='B'), + Location(name='Location 3', slug='location-3', site=sites[2], parent=parent_locations[2], status=LocationStatusChoices.STATUS_DECOMMISSIONING, description='C'), ) for location in locations: location.save() @@ -280,6 +280,10 @@ class LocationTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'slug': ['location-1', 'location-2']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_status(self): + params = {'status': [LocationStatusChoices.STATUS_PLANNED, LocationStatusChoices.STATUS_STAGING]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_description(self): params = {'description': ['A', 'B']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) diff --git a/netbox/dcim/tests/test_views.py b/netbox/dcim/tests/test_views.py index 9cce21a21..748bf24c8 100644 --- a/netbox/dcim/tests/test_views.py +++ b/netbox/dcim/tests/test_views.py @@ -175,9 +175,9 @@ class LocationTestCase(ViewTestCases.OrganizationalObjectViewTestCase): tenant = Tenant.objects.create(name='Tenant 1', slug='tenant-1') locations = ( - Location(name='Location 1', slug='location-1', site=site, tenant=tenant), - Location(name='Location 2', slug='location-2', site=site, tenant=tenant), - Location(name='Location 3', slug='location-3', site=site, tenant=tenant), + Location(name='Location 1', slug='location-1', site=site, status=LocationStatusChoices.STATUS_ACTIVE, tenant=tenant), + Location(name='Location 2', slug='location-2', site=site, status=LocationStatusChoices.STATUS_ACTIVE, tenant=tenant), + Location(name='Location 3', slug='location-3', site=site, status=LocationStatusChoices.STATUS_ACTIVE, tenant=tenant), ) for location in locations: location.save() @@ -188,16 +188,17 @@ class LocationTestCase(ViewTestCases.OrganizationalObjectViewTestCase): 'name': 'Location X', 'slug': 'location-x', 'site': site.pk, + 'status': LocationStatusChoices.STATUS_PLANNED, 'tenant': tenant.pk, 'description': 'A new location', 'tags': [t.pk for t in tags], } cls.csv_data = ( - "site,tenant,name,slug,description", - "Site 1,Tenant 1,Location 4,location-4,Fourth location", - "Site 1,Tenant 1,Location 5,location-5,Fifth location", - "Site 1,Tenant 1,Location 6,location-6,Sixth location", + "site,tenant,name,slug,status,description", + "Site 1,Tenant 1,Location 4,location-4,planned,Fourth location", + "Site 1,Tenant 1,Location 5,location-5,planned,Fifth location", + "Site 1,Tenant 1,Location 6,location-6,planned,Sixth location", ) cls.bulk_edit_data = { diff --git a/netbox/templates/dcim/location.html b/netbox/templates/dcim/location.html index b2b2bc4cd..f0335036f 100644 --- a/netbox/templates/dcim/location.html +++ b/netbox/templates/dcim/location.html @@ -43,6 +43,10 @@ + + + + + + + + From 379880cd8431da6cc39753a8b3a7c8bfcd8f9cc1 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 22 Jun 2022 16:10:48 -0400 Subject: [PATCH 153/593] Closes #9582: Enable assigning config contexts based on device location --- docs/models/extras/configcontext.md | 2 + docs/release-notes/version-3.3.md | 3 ++ netbox/extras/api/serializers.py | 16 +++++-- netbox/extras/api/views.py | 2 +- netbox/extras/filtersets.py | 13 ++++- netbox/extras/forms/filtersets.py | 9 +++- netbox/extras/forms/models.py | 21 ++++++-- .../0076_configcontext_locations.py | 19 ++++++++ netbox/extras/models/configcontexts.py | 12 +++-- netbox/extras/querysets.py | 5 +- netbox/extras/tables/tables.py | 5 +- netbox/extras/tests/test_filtersets.py | 30 +++++++++--- netbox/extras/tests/test_models.py | 48 +++++++++++-------- netbox/extras/views.py | 2 +- .../templates/extras/configcontext_edit.html | 37 -------------- 15 files changed, 138 insertions(+), 86 deletions(-) create mode 100644 netbox/extras/migrations/0076_configcontext_locations.py delete mode 100644 netbox/templates/extras/configcontext_edit.html diff --git a/docs/models/extras/configcontext.md b/docs/models/extras/configcontext.md index bb4a22e0d..08b5f4fd5 100644 --- a/docs/models/extras/configcontext.md +++ b/docs/models/extras/configcontext.md @@ -5,9 +5,11 @@ Sometimes it is desirable to associate additional data with a group of devices o * Region * Site group * Site +* Location (devices only) * Device type (devices only) * Role * Platform +* Cluster type (VMs only) * Cluster group (VMs only) * Cluster (VMs only) * Tenant group diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 66cfd2e66..2a2d4f683 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -25,6 +25,7 @@ * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results * [#9166](https://github.com/netbox-community/netbox/issues/9166) - Add UI visibility toggle for custom fields +* [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location ### Other Changes @@ -45,6 +46,8 @@ * Added required `status` field (default value: `active`) * dcim.Rack * The `elevation` endpoint now includes half-height rack units, and utilizes decimal values for the ID and name of each unit +* extras.ConfigContext + * Added the `locations` many-to-many field to track the assignment of ConfigContexts to Locations * extras.CustomField * Added `group_name` and `ui_visibility` fields * ipam.IPAddress diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index cb317d6c7..2060e3e86 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -5,10 +5,10 @@ from drf_yasg.utils import swagger_serializer_method from rest_framework import serializers from dcim.api.nested_serializers import ( - NestedDeviceRoleSerializer, NestedDeviceTypeSerializer, NestedPlatformSerializer, NestedRegionSerializer, - NestedSiteSerializer, NestedSiteGroupSerializer, + NestedDeviceRoleSerializer, NestedDeviceTypeSerializer, NestedLocationSerializer, NestedPlatformSerializer, + NestedRegionSerializer, NestedSiteSerializer, NestedSiteGroupSerializer, ) -from dcim.models import DeviceRole, DeviceType, Platform, Region, Site, SiteGroup +from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site, SiteGroup from extras.choices import * from extras.models import * from extras.utils import FeatureQuery @@ -272,6 +272,12 @@ class ConfigContextSerializer(ValidatedModelSerializer): required=False, many=True ) + locations = SerializedPKRelatedField( + queryset=Location.objects.all(), + serializer=NestedLocationSerializer, + required=False, + many=True + ) device_types = SerializedPKRelatedField( queryset=DeviceType.objects.all(), serializer=NestedDeviceTypeSerializer, @@ -331,8 +337,8 @@ class ConfigContextSerializer(ValidatedModelSerializer): model = ConfigContext fields = [ 'id', 'url', 'display', 'name', 'weight', 'description', 'is_active', 'regions', 'site_groups', 'sites', - 'device_types', 'roles', 'platforms', 'cluster_types', 'cluster_groups', 'clusters', 'tenant_groups', - 'tenants', 'tags', 'data', 'created', 'last_updated', + 'locations', 'device_types', 'roles', 'platforms', 'cluster_types', 'cluster_groups', 'clusters', + 'tenant_groups', 'tenants', 'tags', 'data', 'created', 'last_updated', ] diff --git a/netbox/extras/api/views.py b/netbox/extras/api/views.py index 688f3c7ab..82c68c86d 100644 --- a/netbox/extras/api/views.py +++ b/netbox/extras/api/views.py @@ -138,7 +138,7 @@ class JournalEntryViewSet(NetBoxModelViewSet): class ConfigContextViewSet(NetBoxModelViewSet): queryset = ConfigContext.objects.prefetch_related( - 'regions', 'site_groups', 'sites', 'roles', 'platforms', 'tenant_groups', 'tenants', + 'regions', 'site_groups', 'sites', 'locations', 'roles', 'platforms', 'tenant_groups', 'tenants', ) serializer_class = serializers.ConfigContextSerializer filterset_class = filtersets.ConfigContextFilterSet diff --git a/netbox/extras/filtersets.py b/netbox/extras/filtersets.py index b59e28018..cca197c73 100644 --- a/netbox/extras/filtersets.py +++ b/netbox/extras/filtersets.py @@ -3,7 +3,7 @@ from django.contrib.auth.models import User from django.contrib.contenttypes.models import ContentType from django.db.models import Q -from dcim.models import DeviceRole, DeviceType, Platform, Region, Site, SiteGroup +from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site, SiteGroup from netbox.filtersets import BaseFilterSet, ChangeLoggedModelFilterSet, NetBoxModelFilterSet from tenancy.models import Tenant, TenantGroup from utilities.filters import ContentTypeFilter, MultiValueCharFilter, MultiValueNumberFilter @@ -255,6 +255,17 @@ class ConfigContextFilterSet(ChangeLoggedModelFilterSet): to_field_name='slug', label='Site (slug)', ) + location_id = django_filters.ModelMultipleChoiceFilter( + field_name='locations', + queryset=Location.objects.all(), + label='Location', + ) + location = django_filters.ModelMultipleChoiceFilter( + field_name='locations__slug', + queryset=Location.objects.all(), + to_field_name='slug', + label='Location (slug)', + ) device_type_id = django_filters.ModelMultipleChoiceFilter( field_name='device_types', queryset=DeviceType.objects.all(), diff --git a/netbox/extras/forms/filtersets.py b/netbox/extras/forms/filtersets.py index aaeb45dbe..56f48f96b 100644 --- a/netbox/extras/forms/filtersets.py +++ b/netbox/extras/forms/filtersets.py @@ -3,7 +3,7 @@ from django.contrib.auth.models import User from django.contrib.contenttypes.models import ContentType from django.utils.translation import gettext as _ -from dcim.models import DeviceRole, DeviceType, Platform, Region, Site, SiteGroup +from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site, SiteGroup from extras.choices import * from extras.models import * from extras.utils import FeatureQuery @@ -170,7 +170,7 @@ class TagFilterForm(FilterForm): class ConfigContextFilterForm(FilterForm): fieldsets = ( (None, ('q', 'tag_id')), - ('Location', ('region_id', 'site_group_id', 'site_id')), + ('Location', ('region_id', 'site_group_id', 'site_id', 'location_id')), ('Device', ('device_type_id', 'platform_id', 'role_id')), ('Cluster', ('cluster_type_id', 'cluster_group_id', 'cluster_id')), ('Tenant', ('tenant_group_id', 'tenant_id')) @@ -190,6 +190,11 @@ class ConfigContextFilterForm(FilterForm): required=False, label=_('Sites') ) + location_id = DynamicModelMultipleChoiceField( + queryset=Location.objects.all(), + required=False, + label=_('Locations') + ) device_type_id = DynamicModelMultipleChoiceField( queryset=DeviceType.objects.all(), required=False, diff --git a/netbox/extras/forms/models.py b/netbox/extras/forms/models.py index ab423e2fb..1ef723e93 100644 --- a/netbox/extras/forms/models.py +++ b/netbox/extras/forms/models.py @@ -1,7 +1,7 @@ from django import forms from django.contrib.contenttypes.models import ContentType -from dcim.models import DeviceRole, DeviceType, Platform, Region, Site, SiteGroup +from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site, SiteGroup from extras.choices import * from extras.models import * from extras.utils import FeatureQuery @@ -166,6 +166,10 @@ class ConfigContextForm(BootstrapMixin, forms.ModelForm): queryset=Site.objects.all(), required=False ) + locations = DynamicModelMultipleChoiceField( + queryset=Location.objects.all(), + required=False + ) device_types = DynamicModelMultipleChoiceField( queryset=DeviceType.objects.all(), required=False @@ -202,15 +206,22 @@ class ConfigContextForm(BootstrapMixin, forms.ModelForm): queryset=Tag.objects.all(), required=False ) - data = JSONField( - label='' + data = JSONField() + + fieldsets = ( + ('Config Context', ('name', 'weight', 'description', 'data', 'is_active')), + ('Assignment', ( + 'regions', 'site_groups', 'sites', 'locations', 'device_types', 'roles', 'platforms', 'cluster_types', + 'cluster_groups', 'clusters', 'tenant_groups', 'tenants', 'tags', + )), ) class Meta: model = ConfigContext fields = ( - 'name', 'weight', 'description', 'is_active', 'regions', 'site_groups', 'sites', 'roles', 'device_types', - 'platforms', 'cluster_types', 'cluster_groups', 'clusters', 'tenant_groups', 'tenants', 'tags', 'data', + 'name', 'weight', 'description', 'data', 'is_active', 'regions', 'site_groups', 'sites', 'locations', + 'roles', 'device_types', 'platforms', 'cluster_types', 'cluster_groups', 'clusters', 'tenant_groups', + 'tenants', 'tags', ) diff --git a/netbox/extras/migrations/0076_configcontext_locations.py b/netbox/extras/migrations/0076_configcontext_locations.py new file mode 100644 index 000000000..f9b3a664b --- /dev/null +++ b/netbox/extras/migrations/0076_configcontext_locations.py @@ -0,0 +1,19 @@ +# Generated by Django 4.0.5 on 2022-06-22 19:13 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('dcim', '0156_location_status'), + ('extras', '0075_customfield_ui_visibility'), + ] + + operations = [ + migrations.AddField( + model_name='configcontext', + name='locations', + field=models.ManyToManyField(blank=True, related_name='+', to='dcim.location'), + ), + ] diff --git a/netbox/extras/models/configcontexts.py b/netbox/extras/models/configcontexts.py index 0dc5d57db..30fb07069 100644 --- a/netbox/extras/models/configcontexts.py +++ b/netbox/extras/models/configcontexts.py @@ -1,5 +1,3 @@ -from collections import OrderedDict - from django.core.validators import ValidationError from django.db import models from django.urls import reverse @@ -55,6 +53,11 @@ class ConfigContext(WebhooksMixin, ChangeLoggedModel): related_name='+', blank=True ) + locations = models.ManyToManyField( + to='dcim.Location', + related_name='+', + blank=True + ) device_types = models.ManyToManyField( to='dcim.DeviceType', related_name='+', @@ -138,11 +141,10 @@ class ConfigContextModel(models.Model): def get_config_context(self): """ + Compile all config data, overwriting lower-weight values with higher-weight values where a collision occurs. Return the rendered configuration context for a device or VM. """ - - # Compile all config data, overwriting lower-weight values with higher-weight values where a collision occurs - data = OrderedDict() + data = {} if not hasattr(self, 'config_context_data'): # The annotation is not available, so we fall back to manually querying for the config context objects diff --git a/netbox/extras/querysets.py b/netbox/extras/querysets.py index 21727d3d4..2b97af0fb 100644 --- a/netbox/extras/querysets.py +++ b/netbox/extras/querysets.py @@ -19,8 +19,9 @@ class ConfigContextQuerySet(RestrictedQuerySet): # `device_role` for Device; `role` for VirtualMachine role = getattr(obj, 'device_role', None) or obj.role - # Device type assignment is relevant only for Devices + # Device type and location assignment is relevant only for Devices device_type = getattr(obj, 'device_type', None) + location = getattr(obj, 'location', None) # Get assigned cluster, group, and type (if any) cluster = getattr(obj, 'cluster', None) @@ -42,6 +43,7 @@ class ConfigContextQuerySet(RestrictedQuerySet): Q(regions__in=regions) | Q(regions=None), Q(site_groups__in=sitegroups) | Q(site_groups=None), Q(sites=obj.site) | Q(sites=None), + Q(locations=location) | Q(locations=None), Q(device_types=device_type) | Q(device_types=None), Q(roles=role) | Q(roles=None), Q(platforms=obj.platform) | Q(platforms=None), @@ -114,6 +116,7 @@ class ConfigContextModelQuerySet(RestrictedQuerySet): ) if self.model._meta.model_name == 'device': + base_query.add((Q(locations=OuterRef('location')) | Q(locations=None)), Q.AND) base_query.add((Q(device_types=OuterRef('device_type')) | Q(device_types=None)), Q.AND) base_query.add((Q(roles=OuterRef('device_role')) | Q(roles=None)), Q.AND) base_query.add((Q(sites=OuterRef('site')) | Q(sites=None)), Q.AND) diff --git a/netbox/extras/tables/tables.py b/netbox/extras/tables/tables.py index 540034696..2fa13f98a 100644 --- a/netbox/extras/tables/tables.py +++ b/netbox/extras/tables/tables.py @@ -167,8 +167,9 @@ class ConfigContextTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = ConfigContext fields = ( - 'pk', 'id', 'name', 'weight', 'is_active', 'description', 'regions', 'sites', 'roles', 'platforms', - 'cluster_types', 'cluster_groups', 'clusters', 'tenant_groups', 'tenants', 'created', 'last_updated', + 'pk', 'id', 'name', 'weight', 'is_active', 'description', 'regions', 'sites', 'locations', 'roles', + 'platforms', 'cluster_types', 'cluster_groups', 'clusters', 'tenant_groups', 'tenants', 'created', + 'last_updated', ) default_columns = ('pk', 'name', 'weight', 'is_active', 'description') diff --git a/netbox/extras/tests/test_filtersets.py b/netbox/extras/tests/test_filtersets.py index bdb8de9db..a88ed9418 100644 --- a/netbox/extras/tests/test_filtersets.py +++ b/netbox/extras/tests/test_filtersets.py @@ -6,7 +6,7 @@ from django.contrib.contenttypes.models import ContentType from django.test import TestCase from circuits.models import Provider -from dcim.models import DeviceRole, DeviceType, Manufacturer, Platform, Rack, Region, Site, SiteGroup +from dcim.models import DeviceRole, DeviceType, Location, Manufacturer, Platform, Rack, Region, Site, SiteGroup from extras.choices import JournalEntryKindChoices, ObjectChangeActionChoices from extras.filtersets import * from extras.models import * @@ -368,9 +368,9 @@ class ConfigContextTestCase(TestCase, ChangeLoggedFilterSetTests): def setUpTestData(cls): regions = ( - Region(name='Test Region 1', slug='test-region-1'), - Region(name='Test Region 2', slug='test-region-2'), - Region(name='Test Region 3', slug='test-region-3'), + Region(name='Region 1', slug='region-1'), + Region(name='Region 2', slug='region-2'), + Region(name='Region 3', slug='region-3'), ) for r in regions: r.save() @@ -384,12 +384,20 @@ class ConfigContextTestCase(TestCase, ChangeLoggedFilterSetTests): site_group.save() sites = ( - Site(name='Test Site 1', slug='test-site-1'), - Site(name='Test Site 2', slug='test-site-2'), - Site(name='Test Site 3', slug='test-site-3'), + Site(name='Site 1', slug='site-1'), + Site(name='Site 2', slug='site-2'), + Site(name='Site 3', slug='site-3'), ) Site.objects.bulk_create(sites) + locations = ( + Location(name='Location 1', slug='location-1', site=sites[0]), + Location(name='Location 2', slug='location-2', site=sites[1]), + Location(name='Location 3', slug='location-3', site=sites[2]), + ) + for location in locations: + location.save() + manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1') device_types = ( DeviceType(manufacturer=manufacturer, model='Device Type 1', slug='device-type-1'), @@ -460,6 +468,7 @@ class ConfigContextTestCase(TestCase, ChangeLoggedFilterSetTests): c.regions.set([regions[i]]) c.site_groups.set([site_groups[i]]) c.sites.set([sites[i]]) + c.locations.set([locations[i]]) c.device_types.set([device_types[i]]) c.roles.set([device_roles[i]]) c.platforms.set([platforms[i]]) @@ -501,6 +510,13 @@ class ConfigContextTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'site': [sites[0].slug, sites[1].slug]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_location(self): + locations = Location.objects.all()[:2] + params = {'location_id': [locations[0].pk, locations[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'location': [locations[0].slug, locations[1].slug]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_device_type(self): device_types = DeviceType.objects.all()[:2] params = {'device_type_id': [device_types[0].pk, device_types[1].pk]} diff --git a/netbox/extras/tests/test_models.py b/netbox/extras/tests/test_models.py index 17138d42b..4929690e7 100644 --- a/netbox/extras/tests/test_models.py +++ b/netbox/extras/tests/test_models.py @@ -1,6 +1,6 @@ from django.test import TestCase -from dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Platform, Region, Site, SiteGroup +from dcim.models import Device, DeviceRole, DeviceType, Location, Manufacturer, Platform, Region, Site, SiteGroup from extras.models import ConfigContext, Tag from tenancy.models import Tenant, TenantGroup from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine @@ -29,7 +29,8 @@ class ConfigContextTest(TestCase): self.devicerole = DeviceRole.objects.create(name='Device Role 1', slug='device-role-1') self.region = Region.objects.create(name="Region") self.sitegroup = SiteGroup.objects.create(name="Site Group") - self.site = Site.objects.create(name='Site-1', slug='site-1', region=self.region, group=self.sitegroup) + self.site = Site.objects.create(name='Site 1', slug='site-1', region=self.region, group=self.sitegroup) + self.location = Location.objects.create(name='Location 1', slug='location-1', site=self.site) self.platform = Platform.objects.create(name="Platform") self.tenantgroup = TenantGroup.objects.create(name="Tenant Group") self.tenant = Tenant.objects.create(name="Tenant", group=self.tenantgroup) @@ -40,7 +41,8 @@ class ConfigContextTest(TestCase): name='Device 1', device_type=self.devicetype, device_role=self.devicerole, - site=self.site + site=self.site, + location=self.location ) def test_higher_weight_wins(self): @@ -144,15 +146,6 @@ class ConfigContextTest(TestCase): self.assertEqual(self.device.get_config_context(), annotated_queryset[0].get_config_context()) def test_annotation_same_as_get_for_object_device_relations(self): - - site_context = ConfigContext.objects.create( - name="site", - weight=100, - data={ - "site": 1 - } - ) - site_context.sites.add(self.site) region_context = ConfigContext.objects.create( name="region", weight=100, @@ -169,6 +162,22 @@ class ConfigContextTest(TestCase): } ) sitegroup_context.site_groups.add(self.sitegroup) + site_context = ConfigContext.objects.create( + name="site", + weight=100, + data={ + "site": 1 + } + ) + site_context.sites.add(self.site) + location_context = ConfigContext.objects.create( + name="location", + weight=100, + data={ + "location": 1 + } + ) + location_context.locations.add(self.location) platform_context = ConfigContext.objects.create( name="platform", weight=100, @@ -205,6 +214,7 @@ class ConfigContextTest(TestCase): device = Device.objects.create( name="Device 2", site=self.site, + location=self.location, tenant=self.tenant, platform=self.platform, device_role=self.devicerole, @@ -220,13 +230,6 @@ class ConfigContextTest(TestCase): cluster_group = ClusterGroup.objects.create(name="Cluster Group") cluster = Cluster.objects.create(name="Cluster", group=cluster_group, type=cluster_type) - site_context = ConfigContext.objects.create( - name="site", - weight=100, - data={"site": 1} - ) - site_context.sites.add(self.site) - region_context = ConfigContext.objects.create( name="region", weight=100, @@ -241,6 +244,13 @@ class ConfigContextTest(TestCase): ) sitegroup_context.site_groups.add(self.sitegroup) + site_context = ConfigContext.objects.create( + name="site", + weight=100, + data={"site": 1} + ) + site_context.sites.add(self.site) + platform_context = ConfigContext.objects.create( name="platform", weight=100, diff --git a/netbox/extras/views.py b/netbox/extras/views.py index 9825d10de..bb99536c3 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -281,6 +281,7 @@ class ConfigContextView(generic.ObjectView): ('Regions', instance.regions.all), ('Site Groups', instance.site_groups.all), ('Sites', instance.sites.all), + ('Locations', instance.locations.all), ('Device Types', instance.device_types.all), ('Roles', instance.roles.all), ('Platforms', instance.platforms.all), @@ -311,7 +312,6 @@ class ConfigContextView(generic.ObjectView): class ConfigContextEditView(generic.ObjectEditView): queryset = ConfigContext.objects.all() form = forms.ConfigContextForm - template_name = 'extras/configcontext_edit.html' class ConfigContextBulkEditView(generic.BulkEditView): diff --git a/netbox/templates/extras/configcontext_edit.html b/netbox/templates/extras/configcontext_edit.html deleted file mode 100644 index 7b37a69c6..000000000 --- a/netbox/templates/extras/configcontext_edit.html +++ /dev/null @@ -1,37 +0,0 @@ -{% extends 'generic/object_edit.html' %} -{% load form_helpers %} - -{% block form %} -
      -
      Config Context
      -
      - {% render_field form.name %} - {% render_field form.weight %} - {% render_field form.description %} - {% render_field form.is_active %} -
      -
      -
      -
      Assignment
      -
      - {% render_field form.regions %} - {% render_field form.site_groups %} - {% render_field form.sites %} - {% render_field form.device_types %} - {% render_field form.roles %} - {% render_field form.platforms %} - {% render_field form.cluster_types %} - {% render_field form.cluster_groups %} - {% render_field form.clusters %} - {% render_field form.tenant_groups %} - {% render_field form.tenants %} - {% render_field form.tags %} -
      -
      -
      -
      Data
      -
      - {% render_field form.data %} -
      -
      -{% endblock %} From a38a880e67d78eba52f19cc4c2613e9399939c2f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 22 Jun 2022 17:01:07 -0400 Subject: [PATCH 154/593] Refactor source IP resolution logic --- docs/release-notes/version-3.3.md | 2 +- netbox/netbox/api/authentication.py | 40 +++++++++++++---------------- netbox/users/api/serializers.py | 5 +++- netbox/users/forms.py | 5 ++-- netbox/users/models.py | 15 +++++------ netbox/utilities/request.py | 27 +++++++++++++++++++ 6 files changed, 59 insertions(+), 35 deletions(-) create mode 100644 netbox/utilities/request.py diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 6e2f28730..f9a229aef 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -21,10 +21,10 @@ * [#7120](https://github.com/netbox-community/netbox/issues/7120) - Add `termination_date` field to Circuit * [#7744](https://github.com/netbox-community/netbox/issues/7744) - Add `status` field to Location * [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster +* [#8233](https://github.com/netbox-community/netbox/issues/8233) - Restrict API token access by source IP * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results -* [#8233](https://github.com/netbox-community/netbox/issues/8233) - Restrict API key access by source IP * [#9166](https://github.com/netbox-community/netbox/issues/9166) - Add UI visibility toggle for custom fields * [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location diff --git a/netbox/netbox/api/authentication.py b/netbox/netbox/api/authentication.py index 2f86a1da2..ea66dc5a6 100644 --- a/netbox/netbox/api/authentication.py +++ b/netbox/netbox/api/authentication.py @@ -1,41 +1,37 @@ from django.conf import settings -from django.core.exceptions import ValidationError from rest_framework import authentication, exceptions from rest_framework.permissions import BasePermission, DjangoObjectPermissions, SAFE_METHODS from users.models import Token +from utilities.request import get_client_ip class TokenAuthentication(authentication.TokenAuthentication): """ - A custom authentication scheme which enforces Token expiration times. + A custom authentication scheme which enforces Token expiration times and source IP restrictions. """ model = Token def authenticate(self, request): - authenticationresult = super().authenticate(request) - if authenticationresult: - token_user, token = authenticationresult + result = super().authenticate(request) - # Verify source IP is allowed + if result: + token = result[1] + + # Enforce source IP restrictions (if any) set on the token if token.allowed_ips: - # Replace 'HTTP_X_REAL_IP' with the settings variable choosen in #8867 - if 'HTTP_X_REAL_IP' in request.META: - clientip = request.META['HTTP_X_REAL_IP'].split(",")[0].strip() - http_header = 'HTTP_X_REAL_IP' - elif 'REMOTE_ADDR' in request.META: - clientip = request.META['REMOTE_ADDR'] - http_header = 'REMOTE_ADDR' - else: - raise exceptions.AuthenticationFailed(f"A HTTP header containing the SourceIP (HTTP_X_REAL_IP, REMOTE_ADDR) is missing from the request.") + client_ip = get_client_ip(request) + if client_ip is None: + raise exceptions.AuthenticationFailed( + "Client IP address could not be determined for validation. Check that the HTTP server is " + "correctly configured to pass the required header(s)." + ) + if not token.validate_client_ip(client_ip): + raise exceptions.AuthenticationFailed( + f"Source IP {client_ip} is not permitted to authenticate using this token." + ) - try: - if not token.validate_client_ip(clientip): - raise exceptions.AuthenticationFailed(f"Source IP {clientip} is not allowed to use this token.") - except ValidationError as ValidationErrorInfo: - raise exceptions.ValidationError(f"The value in the HTTP Header {http_header} has a ValidationError: {ValidationErrorInfo.message}") - - return authenticationresult + return result def authenticate_credentials(self, key): model = self.get_model() diff --git a/netbox/users/api/serializers.py b/netbox/users/api/serializers.py index b48a14d5c..2a40e45ac 100644 --- a/netbox/users/api/serializers.py +++ b/netbox/users/api/serializers.py @@ -67,7 +67,10 @@ class TokenSerializer(ValidatedModelSerializer): class Meta: model = Token - fields = ('id', 'url', 'display', 'user', 'created', 'expires', 'key', 'write_enabled', 'description', 'allowed_ips') + fields = ( + 'id', 'url', 'display', 'user', 'created', 'expires', 'key', 'write_enabled', 'description', + 'allowed_ips', + ) def to_internal_value(self, data): if 'key' not in data: diff --git a/netbox/users/forms.py b/netbox/users/forms.py index 9720f92b7..8692eb050 100644 --- a/netbox/users/forms.py +++ b/netbox/users/forms.py @@ -101,11 +101,12 @@ class TokenForm(BootstrapMixin, forms.ModelForm): required=False, help_text="If no key is provided, one will be generated automatically." ) - allowed_ips = SimpleArrayField( base_field=IPNetworkFormField(), required=False, - help_text='Allowed IPv4/IPv6 networks from where the token can be used. Leave blank for no restrictions. Ex: "10.1.1.0/24, 192.168.10.16/32, 2001:DB8:1::/64"', + label='Allowed IPs', + help_text='Allowed IPv4/IPv6 networks from where the token can be used. Leave blank for no restrictions. ' + 'Ex: "10.1.1.0/24, 192.168.10.16/32, 2001:DB8:1::/64"', ) class Meta: diff --git a/netbox/users/models.py b/netbox/users/models.py index 5372353c0..222b088d6 100644 --- a/netbox/users/models.py +++ b/netbox/users/models.py @@ -223,7 +223,9 @@ class Token(models.Model): base_field=IPNetworkField(), blank=True, null=True, - help_text='Allowed IPv4/IPv6 networks from where the token can be used. Leave blank for no restrictions. Ex: "10.1.1.0/24, 192.168.10.16/32, 2001:DB8:1::/64"', + verbose_name='Allowed IPs', + help_text='Allowed IPv4/IPv6 networks from where the token can be used. Leave blank for no restrictions. ' + 'Ex: "10.1.1.0/24, 192.168.10.16/32, 2001:DB8:1::/64"', ) class Meta: @@ -249,20 +251,15 @@ class Token(models.Model): return False return True - def validate_client_ip(self, raw_ip_address): + def validate_client_ip(self, client_ip): """ - Checks that an IP address falls within the allowed IPs. + Validate the API client IP address against the source IP restrictions (if any) set on the token. """ if not self.allowed_ips: return True - try: - ip_address = ipaddress.ip_address(raw_ip_address) - except ValueError as e: - raise ValidationError(str(e)) - for ip_network in self.allowed_ips: - if ip_address in ipaddress.ip_network(ip_network): + if client_ip in ipaddress.ip_network(ip_network): return True return False diff --git a/netbox/utilities/request.py b/netbox/utilities/request.py new file mode 100644 index 000000000..0fac59d38 --- /dev/null +++ b/netbox/utilities/request.py @@ -0,0 +1,27 @@ +import ipaddress + +__all__ = ( + 'get_client_ip', +) + + +def get_client_ip(request, additional_headers=()): + """ + Return the client (source) IP address of the given request. + """ + HTTP_HEADERS = ( + 'HTTP_X_REAL_IP', + 'HTTP_X_FORWARDED_FOR', + 'REMOTE_ADDR', + *additional_headers + ) + for header in HTTP_HEADERS: + if header in request.META: + client_ip = request.META[header].split(',')[0] + try: + return ipaddress.ip_address(client_ip) + except ValueError: + raise ValueError(f"Invalid IP address set for {header}: {client_ip}") + + # Could not determine the client IP address from request headers + return None From e3b7bba84ff15ce0c1f512e5348cd13db89ecb0c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 22 Jun 2022 21:10:18 -0400 Subject: [PATCH 155/593] Add token authentication tests --- netbox/netbox/tests/test_authentication.py | 67 +++++++++++++++++++++- 1 file changed, 66 insertions(+), 1 deletion(-) diff --git a/netbox/netbox/tests/test_authentication.py b/netbox/netbox/tests/test_authentication.py index 7fc12b4fd..6597684fb 100644 --- a/netbox/netbox/tests/test_authentication.py +++ b/netbox/netbox/tests/test_authentication.py @@ -1,3 +1,5 @@ +import datetime + from django.conf import settings from django.contrib.auth.models import Group, User from django.contrib.contenttypes.models import ContentType @@ -8,10 +10,73 @@ from netaddr import IPNetwork from rest_framework.test import APIClient from dcim.models import Site -from ipam.choices import PrefixStatusChoices from ipam.models import Prefix from users.models import ObjectPermission, Token from utilities.testing import TestCase +from utilities.testing.api import APITestCase + + +class TokenAuthenticationTestCase(APITestCase): + + @override_settings(LOGIN_REQUIRED=True, EXEMPT_VIEW_PERMISSIONS=['*']) + def test_token_authentication(self): + url = reverse('dcim-api:site-list') + + # Request without a token should return a 403 + response = self.client.get(url) + self.assertEqual(response.status_code, 403) + + # Valid token should return a 200 + token = Token.objects.create(user=self.user) + response = self.client.get(url, HTTP_AUTHORIZATION=f'Token {token.key}') + self.assertEqual(response.status_code, 200) + + @override_settings(LOGIN_REQUIRED=True, EXEMPT_VIEW_PERMISSIONS=['*']) + def test_token_expiration(self): + url = reverse('dcim-api:site-list') + + # Request without a non-expired token should succeed + token = Token.objects.create(user=self.user) + response = self.client.get(url, HTTP_AUTHORIZATION=f'Token {token.key}') + self.assertEqual(response.status_code, 200) + + # Request with an expired token should fail + token.expires = datetime.datetime(2020, 1, 1, tzinfo=datetime.timezone.utc) + token.save() + response = self.client.get(url, HTTP_AUTHORIZATION=f'Token {token.key}') + self.assertEqual(response.status_code, 403) + + @override_settings(LOGIN_REQUIRED=True, EXEMPT_VIEW_PERMISSIONS=['*']) + def test_token_write_enabled(self): + url = reverse('dcim-api:site-list') + data = { + 'name': 'Site 1', + 'slug': 'site-1', + } + + # Request with a write-disabled token should fail + token = Token.objects.create(user=self.user, write_enabled=False) + response = self.client.post(url, data, format='json', HTTP_AUTHORIZATION=f'Token {token.key}') + self.assertEqual(response.status_code, 403) + + # Request with a write-enabled token should succeed + token.write_enabled = True + token.save() + response = self.client.post(url, data, format='json', HTTP_AUTHORIZATION=f'Token {token.key}') + self.assertEqual(response.status_code, 403) + + @override_settings(LOGIN_REQUIRED=True, EXEMPT_VIEW_PERMISSIONS=['*']) + def test_token_allowed_ips(self): + url = reverse('dcim-api:site-list') + + # Request from a non-allowed client IP should fail + token = Token.objects.create(user=self.user, allowed_ips=['192.0.2.0/24']) + response = self.client.get(url, HTTP_AUTHORIZATION=f'Token {token.key}', REMOTE_ADDR='127.0.0.1') + self.assertEqual(response.status_code, 403) + + # Request with an expired token should fail + response = self.client.get(url, HTTP_AUTHORIZATION=f'Token {token.key}', REMOTE_ADDR='192.0.2.1') + self.assertEqual(response.status_code, 200) class ExternalAuthenticationTestCase(TestCase): From 3c15419bd0e10a153713707655798d1ac22f194f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 22 Jun 2022 21:51:43 -0400 Subject: [PATCH 156/593] Introduce IPNetworkSerializer to serialize allowed token IPs --- docs/release-notes/version-3.3.md | 3 ++- netbox/netbox/api/__init__.py | 3 ++- netbox/netbox/api/fields.py | 21 +++++++++++++++++++-- netbox/users/api/serializers.py | 3 ++- netbox/users/models.py | 6 ++---- netbox/utilities/request.py | 4 ++-- 6 files changed, 29 insertions(+), 11 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index f9a229aef..81125451e 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -13,6 +13,8 @@ #### PoE Interface Attributes ([#1099](https://github.com/netbox-community/netbox/issues/1099)) +#### Restrict API Tokens by Client IP ([#8233](https://github.com/netbox-community/netbox/issues/8233)) + ### Enhancements * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses @@ -21,7 +23,6 @@ * [#7120](https://github.com/netbox-community/netbox/issues/7120) - Add `termination_date` field to Circuit * [#7744](https://github.com/netbox-community/netbox/issues/7744) - Add `status` field to Location * [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster -* [#8233](https://github.com/netbox-community/netbox/issues/8233) - Restrict API token access by source IP * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results diff --git a/netbox/netbox/api/__init__.py b/netbox/netbox/api/__init__.py index 1eaa7d1c4..231ab55e6 100644 --- a/netbox/netbox/api/__init__.py +++ b/netbox/netbox/api/__init__.py @@ -1,4 +1,4 @@ -from .fields import ChoiceField, ContentTypeField, SerializedPKRelatedField +from .fields import * from .routers import NetBoxRouter from .serializers import BulkOperationSerializer, ValidatedModelSerializer, WritableNestedSerializer @@ -7,6 +7,7 @@ __all__ = ( 'BulkOperationSerializer', 'ChoiceField', 'ContentTypeField', + 'IPNetworkSerializer', 'NetBoxRouter', 'SerializedPKRelatedField', 'ValidatedModelSerializer', diff --git a/netbox/netbox/api/fields.py b/netbox/netbox/api/fields.py index d73cbcac2..1f3c40dc2 100644 --- a/netbox/netbox/api/fields.py +++ b/netbox/netbox/api/fields.py @@ -1,12 +1,18 @@ from collections import OrderedDict -import pytz -from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ObjectDoesNotExist +from netaddr import IPNetwork from rest_framework import serializers from rest_framework.exceptions import ValidationError from rest_framework.relations import PrimaryKeyRelatedField, RelatedField +__all__ = ( + 'ChoiceField', + 'ContentTypeField', + 'IPNetworkSerializer', + 'SerializedPKRelatedField', +) + class ChoiceField(serializers.Field): """ @@ -104,6 +110,17 @@ class ContentTypeField(RelatedField): return f"{obj.app_label}.{obj.model}" +class IPNetworkSerializer(serializers.Serializer): + """ + Representation of an IP network value (e.g. 192.0.2.0/24). + """ + def to_representation(self, instance): + return str(instance) + + def to_internal_value(self, value): + return IPNetwork(value) + + class SerializedPKRelatedField(PrimaryKeyRelatedField): """ Extends PrimaryKeyRelatedField to return a serialized object on read. This is useful for representing related diff --git a/netbox/users/api/serializers.py b/netbox/users/api/serializers.py index 2a40e45ac..e5ed1bb34 100644 --- a/netbox/users/api/serializers.py +++ b/netbox/users/api/serializers.py @@ -2,7 +2,7 @@ from django.contrib.auth.models import Group, User from django.contrib.contenttypes.models import ContentType from rest_framework import serializers -from netbox.api import ContentTypeField, SerializedPKRelatedField, ValidatedModelSerializer +from netbox.api import ContentTypeField, IPNetworkSerializer, SerializedPKRelatedField, ValidatedModelSerializer from users.models import ObjectPermission, Token from .nested_serializers import * @@ -64,6 +64,7 @@ class TokenSerializer(ValidatedModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='users-api:token-detail') key = serializers.CharField(min_length=40, max_length=40, allow_blank=True, required=False) user = NestedUserSerializer() + allowed_ips = serializers.ListField(child=IPNetworkSerializer()) class Meta: model = Token diff --git a/netbox/users/models.py b/netbox/users/models.py index 222b088d6..704516c71 100644 --- a/netbox/users/models.py +++ b/netbox/users/models.py @@ -4,12 +4,12 @@ import os from django.contrib.auth.models import Group, User from django.contrib.contenttypes.models import ContentType from django.contrib.postgres.fields import ArrayField -from django.core.exceptions import ValidationError from django.core.validators import MinLengthValidator from django.db import models from django.db.models.signals import post_save from django.dispatch import receiver from django.utils import timezone +from netaddr import IPNetwork from ipam.fields import IPNetworkField from netbox.config import get_config @@ -17,8 +17,6 @@ from utilities.querysets import RestrictedQuerySet from utilities.utils import flatten_dict from .constants import * -import ipaddress - __all__ = ( 'ObjectPermission', 'Token', @@ -259,7 +257,7 @@ class Token(models.Model): return True for ip_network in self.allowed_ips: - if client_ip in ipaddress.ip_network(ip_network): + if client_ip in IPNetwork(ip_network): return True return False diff --git a/netbox/utilities/request.py b/netbox/utilities/request.py index 0fac59d38..3b8e1edde 100644 --- a/netbox/utilities/request.py +++ b/netbox/utilities/request.py @@ -1,4 +1,4 @@ -import ipaddress +from netaddr import IPAddress __all__ = ( 'get_client_ip', @@ -19,7 +19,7 @@ def get_client_ip(request, additional_headers=()): if header in request.META: client_ip = request.META[header].split(',')[0] try: - return ipaddress.ip_address(client_ip) + return IPAddress(client_ip) except ValueError: raise ValueError(f"Invalid IP address set for {header}: {client_ip}") From d4db656940e98b597644106707b4d94a3628e895 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 23 Jun 2022 08:09:39 -0400 Subject: [PATCH 157/593] Allowed IPs should be optional on Token --- netbox/users/api/serializers.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/netbox/users/api/serializers.py b/netbox/users/api/serializers.py index e5ed1bb34..177cce39c 100644 --- a/netbox/users/api/serializers.py +++ b/netbox/users/api/serializers.py @@ -64,7 +64,12 @@ class TokenSerializer(ValidatedModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='users-api:token-detail') key = serializers.CharField(min_length=40, max_length=40, allow_blank=True, required=False) user = NestedUserSerializer() - allowed_ips = serializers.ListField(child=IPNetworkSerializer()) + allowed_ips = serializers.ListField( + child=IPNetworkSerializer(), + required=False, + allow_empty=True, + default=[] + ) class Meta: model = Token From 7e4b34560f47ef9f8189600ccd4377cb4fc7566c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 23 Jun 2022 08:12:36 -0400 Subject: [PATCH 158/593] Update token model docs --- docs/models/users/token.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/models/users/token.md b/docs/models/users/token.md index d98b51369..367444477 100644 --- a/docs/models/users/token.md +++ b/docs/models/users/token.md @@ -9,4 +9,4 @@ Each token contains a 160-bit key represented as 40 hexadecimal characters. When By default, a token can be used to perform all actions via the API that a user would be permitted to do via the web UI. Deselecting the "write enabled" option will restrict API requests made with the token to read operations (e.g. GET) only. -Additionally, a token can be set to expire at a specific time. This can be useful if an external client needs to be granted temporary access to NetBox. +Additionally, a token can be set to expire at a specific time. This can be useful if an external client needs to be granted temporary access to NetBox. Tokens can also be restricted by IP range: If defined, authentication for API clients connecting from an IP address outside these ranges will fail. From dc05e62ce030419509149634d29586f536956e91 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 23 Jun 2022 12:09:00 -0400 Subject: [PATCH 159/593] Documentation & clenaup for #9536 --- docs/release-notes/version-3.3.md | 4 ++++ docs/rest-api/authentication.md | 5 +++++ netbox/netbox/api/authentication.py | 7 +++---- netbox/netbox/tests/test_authentication.py | 4 ++++ netbox/users/api/serializers.py | 2 +- ....py => 0003_token_allowed_ips_last_used.py} | 9 ++++++--- .../users/migrations/0003_token_last_used.py | 18 ------------------ 7 files changed, 23 insertions(+), 26 deletions(-) rename netbox/users/migrations/{0003_token_allowed_ips.py => 0003_token_allowed_ips_last_used.py} (68%) delete mode 100644 netbox/users/migrations/0003_token_last_used.py diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 81125451e..f76cab4e2 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -27,6 +27,7 @@ * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results * [#9166](https://github.com/netbox-community/netbox/issues/9166) - Add UI visibility toggle for custom fields +* [#9536](https://github.com/netbox-community/netbox/issues/9536) - Track API token usage times * [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location ### Other Changes @@ -55,6 +56,9 @@ * ipam.IPAddress * The `nat_inside` field no longer requires a unique value * The `nat_outside` field has changed from a single IP address instance to a list of multiple IP addresses +* users.Token + * Added the `allowed_ips` array field + * Added the read-only `last_used` datetime field * virtualization.Cluster * Added required `status` field (default value: `active`) * virtualization.VirtualMachine diff --git a/docs/rest-api/authentication.md b/docs/rest-api/authentication.md index 11b8cd6bf..18b6bc4f8 100644 --- a/docs/rest-api/authentication.md +++ b/docs/rest-api/authentication.md @@ -29,6 +29,11 @@ $ curl https://netbox/api/dcim/sites/ } ``` +When a token is used to authenticate a request, its `last_updated` time updated to the current time if its last use was recorded more than 60 seconds ago (or was never recorded). This allows users to determine which tokens have been active recently. + +!!! note + The "last used" time for tokens will not be updated while maintenance mode is enabled. + ## Initial Token Provisioning Ideally, each user should provision his or her own REST API token(s) via the web UI. However, you may encounter where a token must be created by a user via the REST API itself. NetBox provides a special endpoint to provision tokens using a valid username and password combination. diff --git a/netbox/netbox/api/authentication.py b/netbox/netbox/api/authentication.py index 1b7def3a3..b8607a0bb 100644 --- a/netbox/netbox/api/authentication.py +++ b/netbox/netbox/api/authentication.py @@ -44,16 +44,15 @@ class TokenAuthentication(authentication.TokenAuthentication): except model.DoesNotExist: raise exceptions.AuthenticationFailed("Invalid token") - # Update last used, but only once a minute. This reduces the write load on the db + # Update last used, but only once per minute at most. This reduces write load on the database if not token.last_used or (timezone.now() - token.last_used).total_seconds() > 60: # If maintenance mode is enabled, assume the database is read-only, and disable updating the token's # last_used time upon authentication. if get_config().MAINTENANCE_MODE: logger = logging.getLogger('netbox.auth.login') - logger.warning("Maintenance mode enabled: disabling update of token's last used timestamp") + logger.debug("Maintenance mode enabled: Disabling update of token's last used timestamp") else: - token.last_used = timezone.now() - token.save() + Token.objects.filter(pk=token.pk).update(last_used=timezone.now()) # Enforce the Token's expiration time, if one has been set. if token.is_expired: diff --git a/netbox/netbox/tests/test_authentication.py b/netbox/netbox/tests/test_authentication.py index 6597684fb..ef4554b4b 100644 --- a/netbox/netbox/tests/test_authentication.py +++ b/netbox/netbox/tests/test_authentication.py @@ -31,6 +31,10 @@ class TokenAuthenticationTestCase(APITestCase): response = self.client.get(url, HTTP_AUTHORIZATION=f'Token {token.key}') self.assertEqual(response.status_code, 200) + # Check that the token's last_used time has been updated + token.refresh_from_db() + self.assertIsNotNone(token.last_used) + @override_settings(LOGIN_REQUIRED=True, EXEMPT_VIEW_PERMISSIONS=['*']) def test_token_expiration(self): url = reverse('dcim-api:site-list') diff --git a/netbox/users/api/serializers.py b/netbox/users/api/serializers.py index 177cce39c..d05f6c7da 100644 --- a/netbox/users/api/serializers.py +++ b/netbox/users/api/serializers.py @@ -74,7 +74,7 @@ class TokenSerializer(ValidatedModelSerializer): class Meta: model = Token fields = ( - 'id', 'url', 'display', 'user', 'created', 'expires', 'key', 'write_enabled', 'description', + 'id', 'url', 'display', 'user', 'created', 'expires', 'last_used', 'key', 'write_enabled', 'description', 'allowed_ips', ) diff --git a/netbox/users/migrations/0003_token_allowed_ips.py b/netbox/users/migrations/0003_token_allowed_ips_last_used.py similarity index 68% rename from netbox/users/migrations/0003_token_allowed_ips.py rename to netbox/users/migrations/0003_token_allowed_ips_last_used.py index f4eaa9f96..946226f75 100644 --- a/netbox/users/migrations/0003_token_allowed_ips.py +++ b/netbox/users/migrations/0003_token_allowed_ips_last_used.py @@ -1,7 +1,5 @@ -# Generated by Django 3.2.12 on 2022-04-19 12:37 - import django.contrib.postgres.fields -from django.db import migrations +from django.db import migrations, models import ipam.fields @@ -17,4 +15,9 @@ class Migration(migrations.Migration): name='allowed_ips', field=django.contrib.postgres.fields.ArrayField(base_field=ipam.fields.IPNetworkField(), blank=True, null=True, size=None), ), + migrations.AddField( + model_name='token', + name='last_used', + field=models.DateTimeField(blank=True, null=True), + ), ] diff --git a/netbox/users/migrations/0003_token_last_used.py b/netbox/users/migrations/0003_token_last_used.py deleted file mode 100644 index cc014e59c..000000000 --- a/netbox/users/migrations/0003_token_last_used.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 4.0.4 on 2022-06-16 15:26 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('users', '0002_standardize_id_fields'), - ] - - operations = [ - migrations.AddField( - model_name='token', - name='last_used', - field=models.DateTimeField(blank=True, null=True), - ), - ] From 6cb8b9110ebf2d6ff5a41485ad7a1c29cb89008c Mon Sep 17 00:00:00 2001 From: Hunter Johnston <64506580+huntabyte@users.noreply.github.com> Date: Thu, 23 Jun 2022 13:28:36 -0400 Subject: [PATCH 160/593] Closes #9396: Query modules by module bay & display installed_modules for module_bay REST API endpoint (#9574) * Closes #9396 - Added ability to query modules by module bay & installed_modules for module bay REST API endpoint * Closes #9396 - Added ability to query modules by module bay & installed_modules for module bay REST API endpoint * Closes #9396 - Added ability to query modules by module bay & installed_modules for module bay REST API endpoint --- netbox/dcim/api/nested_serializers.py | 9 +++++++++ netbox/dcim/api/serializers.py | 4 ++-- netbox/dcim/api/views.py | 2 +- netbox/dcim/filtersets.py | 6 ++++++ netbox/dcim/tests/test_filtersets.py | 5 +++++ 5 files changed, 23 insertions(+), 3 deletions(-) diff --git a/netbox/dcim/api/nested_serializers.py b/netbox/dcim/api/nested_serializers.py index 0ec0e07e0..1be8bb9dc 100644 --- a/netbox/dcim/api/nested_serializers.py +++ b/netbox/dcim/api/nested_serializers.py @@ -5,6 +5,7 @@ from netbox.api.serializers import BaseModelSerializer, WritableNestedSerializer __all__ = [ 'ComponentNestedModuleSerializer', + 'ModuleBayNestedModuleSerializer', 'NestedCableSerializer', 'NestedConsolePortSerializer', 'NestedConsolePortTemplateSerializer', @@ -281,6 +282,14 @@ class ModuleNestedModuleBaySerializer(WritableNestedSerializer): fields = ['id', 'url', 'display', 'name'] +class ModuleBayNestedModuleSerializer(WritableNestedSerializer): + url = serializers.HyperlinkedIdentityField(view_name='dcim-api:module-detail') + + class Meta: + model = models.Module + fields = ['id', 'url', 'display', 'serial'] + + class ComponentNestedModuleSerializer(WritableNestedSerializer): """ Used by device component serializers. diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 7fcab6ba3..c2cb846a9 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -886,12 +886,12 @@ class FrontPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer): class ModuleBaySerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:modulebay-detail') device = NestedDeviceSerializer() - # installed_module = NestedModuleSerializer(required=False, allow_null=True) + installed_module = ModuleBayNestedModuleSerializer(required=False, allow_null=True) class Meta: model = ModuleBay fields = [ - 'id', 'url', 'display', 'device', 'name', 'label', 'position', 'description', 'tags', 'custom_fields', + 'id', 'url', 'display', 'device', 'name', 'installed_module', 'label', 'position', 'description', 'tags', 'custom_fields', 'created', 'last_updated', ] diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index c4c25f654..3fa652a9b 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -611,7 +611,7 @@ class RearPortViewSet(PassThroughPortMixin, NetBoxModelViewSet): class ModuleBayViewSet(NetBoxModelViewSet): - queryset = ModuleBay.objects.prefetch_related('tags') + queryset = ModuleBay.objects.prefetch_related('tags', 'installed_module') serializer_class = serializers.ModuleBaySerializer filterset_class = filtersets.ModuleBayFilterSet brief_prefetch_fields = ['device'] diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index f052a8be9..4b4201578 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -992,6 +992,12 @@ class ModuleFilterSet(NetBoxModelFilterSet): to_field_name='model', label='Module type (model)', ) + module_bay_id = django_filters.ModelMultipleChoiceFilter( + field_name='module_bay', + queryset=ModuleBay.objects.all(), + to_field_name='id', + label='Module Bay (ID)' + ) device_id = django_filters.ModelMultipleChoiceFilter( queryset=Device.objects.all(), label='Device (ID)', diff --git a/netbox/dcim/tests/test_filtersets.py b/netbox/dcim/tests/test_filtersets.py index 273ee6570..47aa9368c 100644 --- a/netbox/dcim/tests/test_filtersets.py +++ b/netbox/dcim/tests/test_filtersets.py @@ -1849,6 +1849,11 @@ class ModuleTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'module_type': [module_types[0].model, module_types[1].model]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) + def test_module_bay(self): + module_bays = ModuleBay.objects.all()[:2] + params = {'module_bay_id': [module_bays[0].pk, module_bays[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_device(self): device_types = Device.objects.all()[:2] params = {'device_id': [device_types[0].pk, device_types[1].pk]} From afec53cea3873dac9ea970bf70431bde0a399a66 Mon Sep 17 00:00:00 2001 From: Hunter Johnston <64506580+huntabyte@users.noreply.github.com> Date: Thu, 23 Jun 2022 14:11:59 -0400 Subject: [PATCH 161/593] Fixes #9575: Add exception handling to services (#9586) --- netbox/ipam/views.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index a01f2d052..6bcdc4c64 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -680,13 +680,16 @@ class IPAddressView(generic.ObjectView): service_filter = Q(ipaddresses=instance) # Find services listening on all IPs on the assigned device/vm - if instance.assigned_object and instance.assigned_object.parent_object: - parent_object = instance.assigned_object.parent_object + try: + if instance.assigned_object and instance.assigned_object.parent_object: + parent_object = instance.assigned_object.parent_object - if isinstance(parent_object, VirtualMachine): - service_filter |= (Q(virtual_machine=parent_object) & Q(ipaddresses=None)) - elif isinstance(parent_object, Device): - service_filter |= (Q(device=parent_object) & Q(ipaddresses=None)) + if isinstance(parent_object, VirtualMachine): + service_filter |= (Q(virtual_machine=parent_object) & Q(ipaddresses=None)) + elif isinstance(parent_object, Device): + service_filter |= (Q(device=parent_object) & Q(ipaddresses=None)) + except AttributeError: + pass services = Service.objects.restrict(request.user, 'view').filter(service_filter) From d55e3c352a3e8c3ac7d2d3639b85a509272f9d0e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 23 Jun 2022 14:14:02 -0400 Subject: [PATCH 162/593] Changelog for #9396, #9575, #9597 --- docs/release-notes/version-3.2.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 059fc8924..c87200147 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,6 +2,15 @@ ## v3.2.6 (FUTURE) +### Enhancements + +* [#9396](https://github.com/netbox-community/netbox/issues/9396) - Allow filtering modules by bay ID + +### Bug Fixes + +* [#9575](https://github.com/netbox-community/netbox/issues/9575) - Fix AttributeError exception for FHRP group with an IP address assigned +* [#9597](https://github.com/netbox-community/netbox/issues/9597) - Include `installed_module` in module bay REST API serializer + --- ## v3.2.5 (2022-06-20) From db807ab4a6f5d0ff9ff84ae39b5f18688bb19a1a Mon Sep 17 00:00:00 2001 From: Hunter Johnston <64506580+huntabyte@users.noreply.github.com> Date: Thu, 23 Jun 2022 14:16:09 -0400 Subject: [PATCH 163/593] Closes #7702: Add power feed defaults to user configurations --- netbox/dcim/models/power.py | 7 ++++--- netbox/dcim/urls.py | 2 +- netbox/dcim/views.py | 12 ------------ 3 files changed, 5 insertions(+), 16 deletions(-) diff --git a/netbox/dcim/models/power.py b/netbox/dcim/models/power.py index 08f89e3b0..5316951c6 100644 --- a/netbox/dcim/models/power.py +++ b/netbox/dcim/models/power.py @@ -6,6 +6,7 @@ from django.urls import reverse from dcim.choices import * from dcim.constants import * +from netbox.config import ConfigItem from netbox.models import NetBoxModel from utilities.validators import ExclusionValidator from .device_components import LinkTermination, PathEndpoint @@ -105,16 +106,16 @@ class PowerFeed(NetBoxModel, PathEndpoint, LinkTermination): default=PowerFeedPhaseChoices.PHASE_SINGLE ) voltage = models.SmallIntegerField( - default=POWERFEED_VOLTAGE_DEFAULT, + default=ConfigItem('POWERFEED_DEFAULT_VOLTAGE') validators=[ExclusionValidator([0])] ) amperage = models.PositiveSmallIntegerField( validators=[MinValueValidator(1)], - default=POWERFEED_AMPERAGE_DEFAULT + default=ConfigItem('POWERFEED_DEFAULT_AMPERAGE') ) max_utilization = models.PositiveSmallIntegerField( validators=[MinValueValidator(1), MaxValueValidator(100)], - default=POWERFEED_MAX_UTILIZATION_DEFAULT, + default=ConfigItem('POWERFEED_DEFAULT_MAX_UTILIZATION') help_text="Maximum permissible draw (percentage)" ) available_power = models.PositiveIntegerField( diff --git a/netbox/dcim/urls.py b/netbox/dcim/urls.py index 82ea3fec0..c5cd0fa65 100644 --- a/netbox/dcim/urls.py +++ b/netbox/dcim/urls.py @@ -489,7 +489,7 @@ urlpatterns = [ # Power feeds path('power-feeds/', views.PowerFeedListView.as_view(), name='powerfeed_list'), - path('power-feeds/add/', views.PowerFeedCreateView.as_view(), name='powerfeed_add'), + path('power-feeds/add/', views.PowerFeedEditView.as_view(), name='powerfeed_add'), path('power-feeds/import/', views.PowerFeedBulkImportView.as_view(), name='powerfeed_import'), path('power-feeds/edit/', views.PowerFeedBulkEditView.as_view(), name='powerfeed_bulk_edit'), path('power-feeds/disconnect/', views.PowerFeedBulkDisconnectView.as_view(), name='powerfeed_bulk_disconnect'), diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 0716f595e..35a1056b2 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -16,7 +16,6 @@ from circuits.models import Circuit from extras.views import ObjectConfigContextView from ipam.models import ASN, IPAddress, Prefix, Service, VLAN, VLANGroup from ipam.tables import AssignedIPAddressesTable, InterfaceVLANTable -from netbox.config import ConfigItem from netbox.views import generic from utilities.forms import ConfirmationForm from utilities.paginator import EnhancedPaginator, get_paginate_count @@ -3254,17 +3253,6 @@ class PowerFeedView(generic.ObjectView): queryset = PowerFeed.objects.prefetch_related('power_panel', 'rack') -class PowerFeedCreateView(generic.ObjectEditView): - queryset = PowerFeed.objects.all() - form = forms.PowerFeedForm - - def alter_object(self, obj, request, args, kwargs): - obj.voltage = ConfigItem('POWERFEED_DEFAULT_VOLTAGE') - obj.amperage = ConfigItem('POWERFEED_DEFAULT_AMPERAGE') - obj.max_utilization = ConfigItem('POWERFEED_DEFAULT_MAX_UTILIZATION') - return obj - - class PowerFeedEditView(generic.ObjectEditView): queryset = PowerFeed.objects.all() form = forms.PowerFeedForm From c330282919f7903315abc0263c9d3f5d22321fa2 Mon Sep 17 00:00:00 2001 From: Hunter Johnston <64506580+huntabyte@users.noreply.github.com> Date: Thu, 23 Jun 2022 14:56:24 -0400 Subject: [PATCH 164/593] Fix syntax error --- netbox/dcim/models/power.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/models/power.py b/netbox/dcim/models/power.py index 5316951c6..5978d86bd 100644 --- a/netbox/dcim/models/power.py +++ b/netbox/dcim/models/power.py @@ -106,7 +106,7 @@ class PowerFeed(NetBoxModel, PathEndpoint, LinkTermination): default=PowerFeedPhaseChoices.PHASE_SINGLE ) voltage = models.SmallIntegerField( - default=ConfigItem('POWERFEED_DEFAULT_VOLTAGE') + default=ConfigItem('POWERFEED_DEFAULT_VOLTAGE'), validators=[ExclusionValidator([0])] ) amperage = models.PositiveSmallIntegerField( @@ -115,7 +115,7 @@ class PowerFeed(NetBoxModel, PathEndpoint, LinkTermination): ) max_utilization = models.PositiveSmallIntegerField( validators=[MinValueValidator(1), MaxValueValidator(100)], - default=ConfigItem('POWERFEED_DEFAULT_MAX_UTILIZATION') + default=ConfigItem('POWERFEED_DEFAULT_MAX_UTILIZATION'), help_text="Maximum permissible draw (percentage)" ) available_power = models.PositiveIntegerField( From f9d81fd36232e9bf3f60a215d2c6a405b9b342fb Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 23 Jun 2022 15:21:10 -0400 Subject: [PATCH 165/593] Closes #9414: Add clone() method to NetBoxModel for copying instance attributes --- docs/plugins/development/models.md | 18 ++++++++++++ docs/release-notes/version-3.3.md | 4 +++ netbox/netbox/models/__init__.py | 20 +++++++++++++ netbox/netbox/views/generic/object_views.py | 6 ++-- netbox/templates/generic/object.html | 2 +- netbox/utilities/utils.py | 32 +++++++++------------ 6 files changed, 60 insertions(+), 22 deletions(-) diff --git a/docs/plugins/development/models.md b/docs/plugins/development/models.md index 0e1fec6e5..43e3cad9a 100644 --- a/docs/plugins/development/models.md +++ b/docs/plugins/development/models.md @@ -49,6 +49,24 @@ class MyModel(NetBoxModel): ... ``` +### The `clone()` Method + +!!! info + This method was introduced in NetBox v3.3. + +The `NetBoxModel` class includes a `clone()` method to be used for gathering attriubtes which can be used to create a "cloned" instance. This is used primarily for form initialization, e.g. when using the "clone" button in the NetBox UI. By default, this method will replicate any fields listed in the model's `clone_fields` list, if defined. + +Plugin models can leverage this method by defining `clone_fields` as a list of field names to be replicated, or override this method to replace or extend its content: + +```python +class MyModel(NetBoxModel): + + def clone(self): + attrs = super().clone() + attrs['extra-value'] = 123 + return attrs +``` + ### Enabling Features Individually If you prefer instead to enable only a subset of these features for a plugin model, NetBox provides a discrete "mix-in" class for each feature. You can subclass each of these individually when defining your model. (Your model will also need to inherit from Django's built-in `Model` class.) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index f76cab4e2..e9125fea0 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -30,6 +30,10 @@ * [#9536](https://github.com/netbox-community/netbox/issues/9536) - Track API token usage times * [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location +### Plugins API + +* [#9414](https://github.com/netbox-community/netbox/issues/9414) - Add `clone()` method to NetBoxModel for copying instance attributes + ### Other Changes * [#9261](https://github.com/netbox-community/netbox/issues/9261) - `NetBoxTable` no longer automatically clears pre-existing calls to `prefetch_related()` on its queryset diff --git a/netbox/netbox/models/__init__.py b/netbox/netbox/models/__init__.py index b3bfe06c0..2fe3503b7 100644 --- a/netbox/netbox/models/__init__.py +++ b/netbox/netbox/models/__init__.py @@ -2,6 +2,7 @@ from django.core.validators import ValidationError from django.db import models from mptt.models import MPTTModel, TreeForeignKey +from extras.utils import is_taggable from utilities.mptt import TreeManager from utilities.querysets import RestrictedQuerySet from netbox.models.features import * @@ -52,6 +53,25 @@ class NetBoxModel(NetBoxFeatureSet, models.Model): class Meta: abstract = True + def clone(self): + """ + Return a dictionary of attributes suitable for creating a copy of the current instance. This is used for pre- + populating an object creation form in the UI. + """ + attrs = {} + + for field_name in getattr(self, 'clone_fields', []): + field = self._meta.get_field(field_name) + field_value = field.value_from_object(self) + if field_value not in (None, ''): + attrs[field_name] = field_value + + # Include tags (if applicable) + if is_taggable(self): + attrs['tags'] = [tag.pk for tag in self.tags.all()] + + return attrs + class NestedGroupModel(NetBoxFeatureSet, MPTTModel): """ diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index 4ebfe71cc..88abfa48f 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -394,11 +394,11 @@ class ObjectEditView(GetReturnURLMixin, BaseObjectView): if '_addanother' in request.POST: redirect_url = request.path - # If the object has clone_fields, pre-populate a new instance of the form + # If cloning is supported, pre-populate a new instance of the form params = prepare_cloned_fields(obj) - if 'return_url' in request.GET: - params['return_url'] = request.GET.get('return_url') if params: + if 'return_url' in request.GET: + params['return_url'] = request.GET.get('return_url') redirect_url += f"?{params.urlencode()}" return redirect(redirect_url) diff --git a/netbox/templates/generic/object.html b/netbox/templates/generic/object.html index 451c530e1..ef95ccdc0 100644 --- a/netbox/templates/generic/object.html +++ b/netbox/templates/generic/object.html @@ -59,7 +59,7 @@ Context: {# Extra buttons #} {% block extra_controls %}{% endblock %} - {% if object.clone_fields and request.user|can_add:object %} + {% if request.user|can_add:object %} {% clone_button object %} {% endif %} {% if request.user|can_change:object %} diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index 97ab165fe..731b67e43 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -282,26 +282,22 @@ def render_jinja2(template_code, context): def prepare_cloned_fields(instance): """ - Compile an object's `clone_fields` list into a string of URL query parameters. Tags are automatically cloned where - applicable. + Generate a QueryDict comprising attributes from an object's clone() method. """ + # Generate the clone attributes from the instance + if not hasattr(instance, 'clone'): + return None + attrs = instance.clone() + + # Prepare querydict parameters params = [] - for field_name in getattr(instance, 'clone_fields', []): - field = instance._meta.get_field(field_name) - field_value = field.value_from_object(instance) - - # Pass False as null for boolean fields - if field_value is False: - params.append((field_name, '')) - - # Omit empty values - elif field_value not in (None, ''): - params.append((field_name, field_value)) - - # Copy tags - if is_taggable(instance): - for tag in instance.tags.all(): - params.append(('tags', tag.pk)) + for key, value in attrs.items(): + if type(value) in (list, tuple): + params.extend([(key, v) for v in value]) + elif value not in (False, None): + params.append((key, value)) + else: + params.append((key, '')) # Return a QueryDict with the parameters return QueryDict('&'.join([f'{k}={v}' for k, v in params]), mutable=True) From b77013c859d91f5bbd4da64eb28094886280d70f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 23 Jun 2022 17:26:20 -0400 Subject: [PATCH 166/593] Docs & cleanup for #7702 --- docs/configuration/dynamic-settings.md | 48 +++++++++++++++++++------- docs/release-notes/version-3.2.md | 1 + netbox/dcim/constants.py | 9 ----- 3 files changed, 37 insertions(+), 21 deletions(-) diff --git a/docs/configuration/dynamic-settings.md b/docs/configuration/dynamic-settings.md index 2fa046fcf..d376dc5c4 100644 --- a/docs/configuration/dynamic-settings.md +++ b/docs/configuration/dynamic-settings.md @@ -43,18 +43,6 @@ changes in the database indefinitely. --- -## JOBRESULT_RETENTION - -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. - -!!! 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: @@ -110,6 +98,18 @@ Setting this to False will disable the GraphQL API. --- +## JOBRESULT_RETENTION + +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. + +!!! warning + If enabling indefinite job results retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity. + +--- + ## MAINTENANCE_MODE Default: False @@ -185,6 +185,30 @@ The default maximum number of objects to display per page within each list of ob --- +## POWERFEED_DEFAULT_AMPERAGE + +Default: 15 + +The default value for the `amperage` field when creating new power feeds. + +--- + +## POWERFEED_DEFAULT_MAX_UTILIZATION + +Default: 80 + +The default value (percentage) for the `max_utilization` field when creating new power feeds. + +--- + +## POWERFEED_DEFAULT_VOLTAGE + +Default: 120 + +The default value for the `voltage` field when creating new power feeds. + +--- + ## PREFER_IPV4 Default: False diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index c87200147..719ceb7e1 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -4,6 +4,7 @@ ### Enhancements +* [#7702](https://github.com/netbox-community/netbox/issues/7702) - Enable dynamic configuration for default powerfeed attributes * [#9396](https://github.com/netbox-community/netbox/issues/9396) - Allow filtering modules by bay ID ### Bug Fixes diff --git a/netbox/dcim/constants.py b/netbox/dcim/constants.py index 38bf16f0b..155f19c88 100644 --- a/netbox/dcim/constants.py +++ b/netbox/dcim/constants.py @@ -49,15 +49,6 @@ WIRELESS_IFACE_TYPES = [ NONCONNECTABLE_IFACE_TYPES = VIRTUAL_IFACE_TYPES + WIRELESS_IFACE_TYPES -# -# Power feeds -# - -POWERFEED_VOLTAGE_DEFAULT = 120 -POWERFEED_AMPERAGE_DEFAULT = 20 -POWERFEED_MAX_UTILIZATION_DEFAULT = 80 # Percentage - - # # Device components # From 4315c4697cc3ade4901c0a9bb9bef6720027252e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 23 Jun 2022 17:44:19 -0400 Subject: [PATCH 167/593] Ignore default field values which reference ConfigItems when calculating migrations --- netbox/dcim/migrations/0001_squashed.py | 6 +++--- netbox/utilities/management/commands/__init__.py | 7 +++++++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/netbox/dcim/migrations/0001_squashed.py b/netbox/dcim/migrations/0001_squashed.py index bb99d199f..374d3bf45 100644 --- a/netbox/dcim/migrations/0001_squashed.py +++ b/netbox/dcim/migrations/0001_squashed.py @@ -386,9 +386,9 @@ class Migration(migrations.Migration): ('type', models.CharField(default='primary', max_length=50)), ('supply', models.CharField(default='ac', max_length=50)), ('phase', models.CharField(default='single-phase', max_length=50)), - ('voltage', models.SmallIntegerField(default=120, validators=[utilities.validators.ExclusionValidator([0])])), - ('amperage', models.PositiveSmallIntegerField(default=20, validators=[django.core.validators.MinValueValidator(1)])), - ('max_utilization', models.PositiveSmallIntegerField(default=80, validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(100)])), + ('voltage', models.SmallIntegerField(validators=[utilities.validators.ExclusionValidator([0])])), + ('amperage', models.PositiveSmallIntegerField(validators=[django.core.validators.MinValueValidator(1)])), + ('max_utilization', models.PositiveSmallIntegerField(validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(100)])), ('available_power', models.PositiveIntegerField(default=0, editable=False)), ('comments', models.TextField(blank=True)), ], diff --git a/netbox/utilities/management/commands/__init__.py b/netbox/utilities/management/commands/__init__.py index bdd4face6..2c261b0d3 100644 --- a/netbox/utilities/management/commands/__init__.py +++ b/netbox/utilities/management/commands/__init__.py @@ -1,6 +1,8 @@ from django.db import models from timezone_field import TimeZoneField +from netbox.config import ConfigItem + SKIP_FIELDS = ( TimeZoneField, @@ -26,4 +28,9 @@ def custom_deconstruct(field): for attr in EXEMPT_ATTRS: kwargs.pop(attr, None) + # Ignore any field defaults which reference a ConfigItem + kwargs = { + k: v for k, v in kwargs.items() if not isinstance(v, ConfigItem) + } + return name, path, args, kwargs From d8b40056b52d6c12c1e37160f0e86f0730658d89 Mon Sep 17 00:00:00 2001 From: Hunter Johnston Date: Thu, 23 Jun 2022 20:54:26 -0400 Subject: [PATCH 168/593] Fixes #8854: Remote auth default groups added to new remote auth users --- netbox/netbox/authentication.py | 25 +++++++++++++++++++++++++ netbox/netbox/settings.py | 13 +++++++++++++ 2 files changed, 38 insertions(+) diff --git a/netbox/netbox/authentication.py b/netbox/netbox/authentication.py index a13e8d192..208378872 100644 --- a/netbox/netbox/authentication.py +++ b/netbox/netbox/authentication.py @@ -1,5 +1,7 @@ import logging from collections import defaultdict +import requests +from rich import print from django.conf import settings from django.contrib.auth import get_user_model @@ -348,3 +350,26 @@ class LDAPBackend: ldap.set_option(ldap.OPT_X_TLS_REQUIRE_CERT, ldap.OPT_X_TLS_NEVER) return obj + + +# Custom Social Auth Pipeline Handlers +def user_default_groups_handler(backend, user, response, *args, **kwargs): + """ + Custom pipeline handler which adds remote auth users to the default group specified in the + configuration file. + """ + logger = logging.getLogger('netbox.auth.user_default_groups_handler') + if settings.REMOTE_AUTH_DEFAULT_GROUPS: + # Assign default groups to the user + group_list = [] + for name in settings.REMOTE_AUTH_DEFAULT_GROUPS: + try: + group_list.append(Group.objects.get(name=name)) + except Group.DoesNotExist: + logging.error( + f"Could not assign group {name} to remotely-authenticated user {user}: Group not found") + if group_list: + user.groups.add(*group_list) + else: + user.groups.clear() + logger.debug(f"Stripping user {user} from Groups") diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index b2e1eca6c..c0df42a2b 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -483,6 +483,19 @@ for param in dir(configuration): SOCIAL_AUTH_JSONFIELD_ENABLED = True +SOCIAL_AUTH_PIPELINE = ( + 'social_core.pipeline.social_auth.social_details', + 'social_core.pipeline.social_auth.social_uid', + 'social_core.pipeline.social_auth.social_user', + 'social_core.pipeline.user.get_username', + 'social_core.pipeline.social_auth.associate_by_email', + 'social_core.pipeline.user.create_user', + 'social_core.pipeline.social_auth.associate_user', + 'netbox.authentication.user_default_groups_handler', + 'social_core.pipeline.social_auth.load_extra_data', + 'social_core.pipeline.user.user_details', +) + # # Django Prometheus From 9b91c2a88665f3621c05ae81f52ab2a8fed60c7f Mon Sep 17 00:00:00 2001 From: Hunter Johnston <64506580+huntabyte@users.noreply.github.com> Date: Thu, 23 Jun 2022 23:29:14 -0400 Subject: [PATCH 169/593] syntax: Removed dev imports --- netbox/netbox/authentication.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/netbox/netbox/authentication.py b/netbox/netbox/authentication.py index 208378872..00fb3ee66 100644 --- a/netbox/netbox/authentication.py +++ b/netbox/netbox/authentication.py @@ -1,7 +1,5 @@ import logging from collections import defaultdict -import requests -from rich import print from django.conf import settings from django.contrib.auth import get_user_model From fc02e15fb10049df56ad0371ffb206abc15ff2a8 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 24 Jun 2022 11:04:38 -0400 Subject: [PATCH 170/593] Closes #4434: Enable highlighting devices within rack elevations --- docs/release-notes/version-3.3.md | 1 + netbox/dcim/api/views.py | 11 +++- netbox/dcim/models/racks.py | 6 +- netbox/dcim/svg/racks.py | 57 ++++++++++++------ netbox/dcim/views.py | 6 ++ netbox/project-static/dist/rack_elevation.css | Bin 1423 -> 1496 bytes .../project-static/styles/rack-elevation.scss | 7 +++ netbox/templates/dcim/device.html | 5 ++ netbox/templates/dcim/inc/rack_elevation.html | 4 +- netbox/templates/dcim/rack.html | 4 +- 10 files changed, 76 insertions(+), 25 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index e9125fea0..8deee0370 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -19,6 +19,7 @@ * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses * [#4350](https://github.com/netbox-community/netbox/issues/4350) - Illustrate reservations vertically alongside rack elevations +* [#4434](https://github.com/netbox-community/netbox/issues/4434) - Enable highlighting devices within rack elevations * [#5303](https://github.com/netbox-community/netbox/issues/5303) - A virtual machine may be assigned to a site and/or cluster * [#7120](https://github.com/netbox-community/netbox/issues/7120) - Add `termination_date` field to Circuit * [#7744](https://github.com/netbox-community/netbox/issues/7744) - Add `status` field to Location diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index c4c25f654..fdf53053e 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -215,6 +215,14 @@ class RackViewSet(NetBoxModelViewSet): data = serializer.validated_data if data['render'] == 'svg': + # Determine attributes for highlighting devices (if any) + highlight_params = [] + for param in request.GET.getlist('highlight'): + try: + highlight_params.append(param.split(':', 1)) + except ValueError: + pass + # Render and return the elevation as an SVG drawing with the correct content type drawing = rack.get_elevation_svg( face=data['face'], @@ -223,7 +231,8 @@ class RackViewSet(NetBoxModelViewSet): unit_height=data['unit_height'], legend_width=data['legend_width'], include_images=data['include_images'], - base_url=request.build_absolute_uri('/') + base_url=request.build_absolute_uri('/'), + highlight_params=highlight_params ) return HttpResponse(drawing.tostring(), content_type='image/svg+xml') diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index 39e01cae3..31fbb71de 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -370,7 +370,8 @@ class Rack(NetBoxModel): legend_width=RACK_ELEVATION_DEFAULT_LEGEND_WIDTH, margin_width=RACK_ELEVATION_DEFAULT_MARGIN_WIDTH, include_images=True, - base_url=None + base_url=None, + highlight_params=None ): """ Return an SVG of the rack elevation @@ -394,7 +395,8 @@ class Rack(NetBoxModel): margin_width=margin_width, user=user, include_images=include_images, - base_url=base_url + base_url=base_url, + highlight_params=highlight_params ) return elevation.render(face) diff --git a/netbox/dcim/svg/racks.py b/netbox/dcim/svg/racks.py index b344aad0a..920bd662f 100644 --- a/netbox/dcim/svg/racks.py +++ b/netbox/dcim/svg/racks.py @@ -7,12 +7,13 @@ from svgwrite.shapes import Rect from svgwrite.text import Text from django.conf import settings +from django.core.exceptions import FieldError +from django.db.models import Q from django.urls import reverse from django.utils.http import urlencode from netbox.config import get_config from utilities.utils import foreground_color, array_to_ranges -from dcim.choices import DeviceFaceChoices from dcim.constants import RACK_ELEVATION_BORDER_WIDTH @@ -51,12 +52,17 @@ class RackElevationSVG: Use this class to render a rack elevation as an SVG image. :param rack: A NetBox Rack instance + :param unit_width: Rendered unit width, in pixels + :param unit_height: Rendered unit height, in pixels + :param legend_width: Legend width, in pixels (where the unit labels appear) + :param margin_width: Margin width, in pixels (where reservations appear) :param user: User instance. If specified, only devices viewable by this user will be fully displayed. :param include_images: If true, the SVG document will embed front/rear device face images, where available :param base_url: Base URL for links within the SVG document. If none, links will be relative. + :param highlight_params: Iterable of two-tuples which identifies attributes of devices to highlight """ def __init__(self, rack, unit_height=None, unit_width=None, legend_width=None, margin_width=None, user=None, - include_images=True, base_url=None): + include_images=True, base_url=None, highlight_params=None): self.rack = rack self.include_images = include_images self.base_url = base_url.rstrip('/') if base_url is not None else '' @@ -74,6 +80,17 @@ class RackElevationSVG: permitted_devices = permitted_devices.restrict(user, 'view') self.permitted_device_ids = permitted_devices.values_list('pk', flat=True) + # Determine device(s) to highlight within the elevation (if any) + self.highlight_devices = [] + if highlight_params: + q = Q() + for k, v in highlight_params: + q |= Q(**{k: v}) + try: + self.highlight_devices = permitted_devices.filter(q) + except FieldError: + pass + @staticmethod def _add_gradient(drawing, id_, color): gradient = LinearGradient( @@ -123,40 +140,44 @@ class RackElevationSVG: def _draw_device(self, device, coords, size, color=None, image=None): name = get_device_name(device) description = get_device_description(device) + text_color = f'#{foreground_color(color)}' if color else '#000000' text_coords = ( coords[0] + size[0] / 2, coords[1] + size[1] / 2 ) - text_color = f'#{foreground_color(color)}' if color else '#000000' + + # Determine whether highlighting is in use, and if so, whether to shade this device + is_shaded = self.highlight_devices and device not in self.highlight_devices + css_extra = ' shaded' if is_shaded else '' # Create hyperlink element - link = Hyperlink( - href='{}{}'.format( - self.base_url, - reverse('dcim:device', kwargs={'pk': device.pk}) - ), - target='_blank', - ) + link = Hyperlink(href=f'{self.base_url}{device.get_absolute_url()}', target='_blank') link.set_desc(description) + + # Add rect element to hyperlink if color: - link.add(Rect(coords, size, style=f'fill: #{color}', class_='slot')) + link.add(Rect(coords, size, style=f'fill: #{color}', class_=f'slot{css_extra}')) else: - link.add(Rect(coords, size, class_='slot blocked')) - link.add(Text(name, insert=text_coords, fill=text_color)) + link.add(Rect(coords, size, class_=f'slot blocked{css_extra}')) + link.add(Text(name, insert=text_coords, fill=text_color, class_=f'label{css_extra}')) # Embed device type image if provided if self.include_images and image: image = Image( - href='{}{}'.format(self.base_url, image.url), + href=f'{self.base_url}{image.url}', insert=coords, size=size, - class_='device-image' + class_=f'device-image{css_extra}' ) image.fit(scale='slice') link.add(image) - link.add(Text(name, insert=text_coords, stroke='black', - stroke_width='0.2em', stroke_linejoin='round', class_='device-image-label')) - link.add(Text(name, insert=text_coords, fill='white', class_='device-image-label')) + link.add( + Text(name, insert=text_coords, stroke='black', stroke_width='0.2em', stroke_linejoin='round', + class_=f'device-image-label{css_extra}') + ) + link.add( + Text(name, insert=text_coords, fill='white', class_=f'device-image-label{css_extra}') + ) self.drawing.add(link) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 35a1056b2..8e8ffbd82 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -639,6 +639,11 @@ class RackView(generic.ObjectView): device_count = Device.objects.restrict(request.user, 'view').filter(rack=instance).count() + # Determine any additional parameters to pass when embedding the rack elevations + svg_extra = '&'.join([ + f'highlight=id:{pk}' for pk in request.GET.getlist('device') + ]) + return { 'device_count': device_count, 'reservations': reservations, @@ -646,6 +651,7 @@ class RackView(generic.ObjectView): 'nonracked_devices': nonracked_devices, 'next_rack': next_rack, 'prev_rack': prev_rack, + 'svg_extra': svg_extra, } diff --git a/netbox/project-static/dist/rack_elevation.css b/netbox/project-static/dist/rack_elevation.css index bfeed4150cf8f390dbb586e2e698af26ad196f89..229ea2f9797530fc766c7500a2a31dff4d586244 100644 GIT binary patch delta 81 zcmeC@zQMi0k=dmvHMvBuI3qD7HASbmEL|ZpH!(dGDo~wYkeHlVQfXyms#*(@EJ>|^ QDTd3L8mMlzVGd>j0Ll&>GXMYp delta 12 Tcmcb?-Os(jk$H0$vmX-x9z_HK diff --git a/netbox/project-static/styles/rack-elevation.scss b/netbox/project-static/styles/rack-elevation.scss index bc02995dd..8d6bdddb9 100644 --- a/netbox/project-static/styles/rack-elevation.scss +++ b/netbox/project-static/styles/rack-elevation.scss @@ -48,6 +48,13 @@ svg { visibility: hidden; } + rect.shaded, image.shaded { + opacity: 25%; + } + text.shaded { + opacity: 50%; + } + // Rack elevation container. .rack { fill: none; diff --git a/netbox/templates/dcim/device.html b/netbox/templates/dcim/device.html index d3d6f03dc..2ee1e1154 100644 --- a/netbox/templates/dcim/device.html +++ b/netbox/templates/dcim/device.html @@ -49,6 +49,11 @@       + + + + diff --git a/netbox/tenancy/views.py b/netbox/tenancy/views.py index f6f95b123..07a25b5a4 100644 --- a/netbox/tenancy/views.py +++ b/netbox/tenancy/views.py @@ -7,6 +7,7 @@ from ipam.models import Aggregate, IPAddress, IPRange, Prefix, VLAN, VRF, ASN from netbox.views import generic from utilities.utils import count_related from virtualization.models import VirtualMachine, Cluster +from wireless.models import WirelessLAN, WirelessLink from . import filtersets, forms, tables from .models import * @@ -114,6 +115,8 @@ class TenantView(generic.ObjectView): 'cluster_count': Cluster.objects.restrict(request.user, 'view').filter(tenant=instance).count(), 'cable_count': Cable.objects.restrict(request.user, 'view').filter(tenant=instance).count(), 'asn_count': ASN.objects.restrict(request.user, 'view').filter(tenant=instance).count(), + 'wirelesslan_count': WirelessLAN.objects.restrict(request.user, 'view').filter(tenant=instance).count(), + 'wirelesslink_count': WirelessLink.objects.restrict(request.user, 'view').filter(tenant=instance).count(), } return { diff --git a/netbox/wireless/api/serializers.py b/netbox/wireless/api/serializers.py index 4a6abe94d..49d512e51 100644 --- a/netbox/wireless/api/serializers.py +++ b/netbox/wireless/api/serializers.py @@ -5,6 +5,7 @@ from dcim.api.serializers import NestedInterfaceSerializer from ipam.api.serializers import NestedVLANSerializer from netbox.api import ChoiceField from netbox.api.serializers import NestedGroupModelSerializer, NetBoxModelSerializer +from tenancy.api.nested_serializers import NestedTenantSerializer from wireless.choices import * from wireless.models import * from .nested_serializers import * @@ -33,14 +34,15 @@ class WirelessLANSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='wireless-api:wirelesslan-detail') group = NestedWirelessLANGroupSerializer(required=False, allow_null=True) vlan = NestedVLANSerializer(required=False, allow_null=True) + tenant = NestedTenantSerializer(required=False, allow_null=True) auth_type = ChoiceField(choices=WirelessAuthTypeChoices, required=False, allow_blank=True) auth_cipher = ChoiceField(choices=WirelessAuthCipherChoices, required=False, allow_blank=True) class Meta: model = WirelessLAN fields = [ - 'id', 'url', 'display', 'ssid', 'description', 'group', 'vlan', 'auth_type', 'auth_cipher', 'auth_psk', - 'description', 'tags', 'custom_fields', 'created', 'last_updated', + 'id', 'url', 'display', 'ssid', 'description', 'group', 'vlan', 'tenant', 'auth_type', 'auth_cipher', + 'auth_psk', 'description', 'tags', 'custom_fields', 'created', 'last_updated', ] @@ -49,12 +51,13 @@ class WirelessLinkSerializer(NetBoxModelSerializer): status = ChoiceField(choices=LinkStatusChoices, required=False) interface_a = NestedInterfaceSerializer() interface_b = NestedInterfaceSerializer() + tenant = NestedTenantSerializer(required=False, allow_null=True) auth_type = ChoiceField(choices=WirelessAuthTypeChoices, required=False, allow_blank=True) auth_cipher = ChoiceField(choices=WirelessAuthCipherChoices, required=False, allow_blank=True) class Meta: model = WirelessLink fields = [ - 'id', 'url', 'display', 'interface_a', 'interface_b', 'ssid', 'status', 'description', 'auth_type', + 'id', 'url', 'display', 'interface_a', 'interface_b', 'ssid', 'status', 'tenant', 'auth_type', 'auth_cipher', 'auth_psk', 'description', 'tags', 'custom_fields', 'created', 'last_updated', ] diff --git a/netbox/wireless/api/views.py b/netbox/wireless/api/views.py index 77a766c50..1103cec37 100644 --- a/netbox/wireless/api/views.py +++ b/netbox/wireless/api/views.py @@ -27,12 +27,12 @@ class WirelessLANGroupViewSet(NetBoxModelViewSet): class WirelessLANViewSet(NetBoxModelViewSet): - queryset = WirelessLAN.objects.prefetch_related('vlan', 'tags') + queryset = WirelessLAN.objects.prefetch_related('vlan', 'tenant', 'tags') serializer_class = serializers.WirelessLANSerializer filterset_class = filtersets.WirelessLANFilterSet class WirelessLinkViewSet(NetBoxModelViewSet): - queryset = WirelessLink.objects.prefetch_related('interface_a', 'interface_b', 'tags') + queryset = WirelessLink.objects.prefetch_related('interface_a', 'interface_b', 'tenant', 'tags') serializer_class = serializers.WirelessLinkSerializer filterset_class = filtersets.WirelessLinkFilterSet diff --git a/netbox/wireless/filtersets.py b/netbox/wireless/filtersets.py index 7b0be857b..60c4f935b 100644 --- a/netbox/wireless/filtersets.py +++ b/netbox/wireless/filtersets.py @@ -4,6 +4,7 @@ from django.db.models import Q from dcim.choices import LinkStatusChoices from ipam.models import VLAN from netbox.filtersets import OrganizationalModelFilterSet, NetBoxModelFilterSet +from tenancy.filtersets import TenancyFilterSet from utilities.filters import MultiValueNumberFilter, TreeNodeMultipleChoiceFilter from .choices import * from .models import * @@ -30,7 +31,7 @@ class WirelessLANGroupFilterSet(OrganizationalModelFilterSet): fields = ['id', 'name', 'slug', 'description'] -class WirelessLANFilterSet(NetBoxModelFilterSet): +class WirelessLANFilterSet(NetBoxModelFilterSet, TenancyFilterSet): group_id = TreeNodeMultipleChoiceFilter( queryset=WirelessLANGroup.objects.all(), field_name='group', @@ -66,7 +67,7 @@ class WirelessLANFilterSet(NetBoxModelFilterSet): return queryset.filter(qs_filter) -class WirelessLinkFilterSet(NetBoxModelFilterSet): +class WirelessLinkFilterSet(NetBoxModelFilterSet, TenancyFilterSet): interface_a_id = MultiValueNumberFilter() interface_b_id = MultiValueNumberFilter() status = django_filters.MultipleChoiceFilter( diff --git a/netbox/wireless/forms/bulk_edit.py b/netbox/wireless/forms/bulk_edit.py index 8a472e164..639a1ed1b 100644 --- a/netbox/wireless/forms/bulk_edit.py +++ b/netbox/wireless/forms/bulk_edit.py @@ -3,6 +3,7 @@ from django import forms from dcim.choices import LinkStatusChoices from ipam.models import VLAN from netbox.forms import NetBoxModelBulkEditForm +from tenancy.models import Tenant from utilities.forms import add_blank_choice, DynamicModelChoiceField from wireless.choices import * from wireless.constants import SSID_MAX_LENGTH @@ -47,6 +48,10 @@ class WirelessLANBulkEditForm(NetBoxModelBulkEditForm): required=False, label='SSID' ) + tenant = DynamicModelChoiceField( + queryset=Tenant.objects.all(), + required=False + ) description = forms.CharField( required=False ) @@ -65,11 +70,11 @@ class WirelessLANBulkEditForm(NetBoxModelBulkEditForm): model = WirelessLAN fieldsets = ( - (None, ('group', 'vlan', 'ssid', 'description')), + (None, ('group', 'ssid', 'vlan', 'tenant', 'description')), ('Authentication', ('auth_type', 'auth_cipher', 'auth_psk')), ) nullable_fields = ( - 'ssid', 'group', 'vlan', 'description', 'auth_type', 'auth_cipher', 'auth_psk', + 'ssid', 'group', 'vlan', 'tenant', 'description', 'auth_type', 'auth_cipher', 'auth_psk', ) @@ -83,6 +88,10 @@ class WirelessLinkBulkEditForm(NetBoxModelBulkEditForm): choices=add_blank_choice(LinkStatusChoices), required=False ) + tenant = DynamicModelChoiceField( + queryset=Tenant.objects.all(), + required=False + ) description = forms.CharField( required=False ) @@ -101,9 +110,9 @@ class WirelessLinkBulkEditForm(NetBoxModelBulkEditForm): model = WirelessLink fieldsets = ( - (None, ('ssid', 'status', 'description')), + (None, ('ssid', 'status', 'tenant', 'description')), ('Authentication', ('auth_type', 'auth_cipher', 'auth_psk')) ) nullable_fields = ( - 'ssid', 'description', 'auth_type', 'auth_cipher', 'auth_psk', + 'ssid', 'tenant', 'description', 'auth_type', 'auth_cipher', 'auth_psk', ) diff --git a/netbox/wireless/forms/bulk_import.py b/netbox/wireless/forms/bulk_import.py index 4b8acb385..6a1ca4f36 100644 --- a/netbox/wireless/forms/bulk_import.py +++ b/netbox/wireless/forms/bulk_import.py @@ -2,6 +2,7 @@ from dcim.choices import LinkStatusChoices from dcim.models import Interface from ipam.models import VLAN from netbox.forms import NetBoxModelCSVForm +from tenancy.models import Tenant from utilities.forms import CSVChoiceField, CSVModelChoiceField, SlugField from wireless.choices import * from wireless.models import * @@ -40,6 +41,12 @@ class WirelessLANCSVForm(NetBoxModelCSVForm): to_field_name='name', help_text='Bridged VLAN' ) + tenant = CSVModelChoiceField( + queryset=Tenant.objects.all(), + required=False, + to_field_name='name', + help_text='Assigned tenant' + ) auth_type = CSVChoiceField( choices=WirelessAuthTypeChoices, required=False, @@ -53,7 +60,7 @@ class WirelessLANCSVForm(NetBoxModelCSVForm): class Meta: model = WirelessLAN - fields = ('ssid', 'group', 'description', 'vlan', 'auth_type', 'auth_cipher', 'auth_psk') + fields = ('ssid', 'group', 'vlan', 'tenant', 'description', 'auth_type', 'auth_cipher', 'auth_psk') class WirelessLinkCSVForm(NetBoxModelCSVForm): @@ -67,6 +74,12 @@ class WirelessLinkCSVForm(NetBoxModelCSVForm): interface_b = CSVModelChoiceField( queryset=Interface.objects.all() ) + tenant = CSVModelChoiceField( + queryset=Tenant.objects.all(), + required=False, + to_field_name='name', + help_text='Assigned tenant' + ) auth_type = CSVChoiceField( choices=WirelessAuthTypeChoices, required=False, @@ -80,4 +93,6 @@ class WirelessLinkCSVForm(NetBoxModelCSVForm): class Meta: model = WirelessLink - fields = ('interface_a', 'interface_b', 'ssid', 'description', 'auth_type', 'auth_cipher', 'auth_psk') + fields = ( + 'interface_a', 'interface_b', 'ssid', 'tenant', 'description', 'auth_type', 'auth_cipher', 'auth_psk', + ) diff --git a/netbox/wireless/forms/filtersets.py b/netbox/wireless/forms/filtersets.py index 8dcb48673..9e8808e17 100644 --- a/netbox/wireless/forms/filtersets.py +++ b/netbox/wireless/forms/filtersets.py @@ -3,6 +3,7 @@ from django.utils.translation import gettext as _ from dcim.choices import LinkStatusChoices from netbox.forms import NetBoxModelFilterSetForm +from tenancy.forms import TenancyFilterForm from utilities.forms import add_blank_choice, DynamicModelMultipleChoiceField, StaticSelect, TagFilterField from wireless.choices import * from wireless.models import * @@ -24,11 +25,12 @@ class WirelessLANGroupFilterForm(NetBoxModelFilterSetForm): tag = TagFilterField(model) -class WirelessLANFilterForm(NetBoxModelFilterSetForm): +class WirelessLANFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): model = WirelessLAN fieldsets = ( (None, ('q', 'tag')), ('Attributes', ('ssid', 'group_id',)), + ('Tenant', ('tenant_group_id', 'tenant_id')), ('Authentication', ('auth_type', 'auth_cipher', 'auth_psk')), ) ssid = forms.CharField( @@ -57,8 +59,14 @@ class WirelessLANFilterForm(NetBoxModelFilterSetForm): tag = TagFilterField(model) -class WirelessLinkFilterForm(NetBoxModelFilterSetForm): +class WirelessLinkFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): model = WirelessLink + fieldsets = ( + (None, ('q', 'tag')), + ('Attributes', ('ssid', 'status',)), + ('Tenant', ('tenant_group_id', 'tenant_id')), + ('Authentication', ('auth_type', 'auth_cipher', 'auth_psk')), + ) ssid = forms.CharField( required=False, label='SSID' diff --git a/netbox/wireless/forms/models.py b/netbox/wireless/forms/models.py index d1012ba59..bcffcf896 100644 --- a/netbox/wireless/forms/models.py +++ b/netbox/wireless/forms/models.py @@ -1,6 +1,7 @@ from dcim.models import Device, Interface, Location, Region, Site, SiteGroup from ipam.models import VLAN, VLANGroup from netbox.forms import NetBoxModelForm +from tenancy.forms import TenancyForm from utilities.forms import DynamicModelChoiceField, SlugField, StaticSelect from wireless.models import * @@ -25,7 +26,7 @@ class WirelessLANGroupForm(NetBoxModelForm): ] -class WirelessLANForm(NetBoxModelForm): +class WirelessLANForm(TenancyForm, NetBoxModelForm): group = DynamicModelChoiceField( queryset=WirelessLANGroup.objects.all(), required=False @@ -79,14 +80,15 @@ class WirelessLANForm(NetBoxModelForm): fieldsets = ( ('Wireless LAN', ('ssid', 'group', 'description', 'tags')), ('VLAN', ('region', 'site_group', 'site', 'vlan_group', 'vlan',)), + ('Tenancy', ('tenant_group', 'tenant')), ('Authentication', ('auth_type', 'auth_cipher', 'auth_psk')), ) 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', 'tenant_group', + 'tenant', 'auth_type', 'auth_cipher', 'auth_psk', 'tags', ] widgets = { 'auth_type': StaticSelect, @@ -94,7 +96,7 @@ class WirelessLANForm(NetBoxModelForm): } -class WirelessLinkForm(NetBoxModelForm): +class WirelessLinkForm(TenancyForm, NetBoxModelForm): site_a = DynamicModelChoiceField( queryset=Site.objects.all(), required=False, @@ -180,6 +182,7 @@ class WirelessLinkForm(NetBoxModelForm): ('Side A', ('site_a', 'location_a', 'device_a', 'interface_a')), ('Side B', ('site_b', 'location_b', 'device_b', 'interface_b')), ('Link', ('status', 'ssid', 'description', 'tags')), + ('Tenancy', ('tenant_group', 'tenant')), ('Authentication', ('auth_type', 'auth_cipher', 'auth_psk')), ) @@ -187,7 +190,7 @@ class WirelessLinkForm(NetBoxModelForm): model = WirelessLink fields = [ 'site_a', 'location_a', 'device_a', 'interface_a', 'site_b', 'location_b', 'device_b', 'interface_b', - 'status', 'ssid', 'description', 'auth_type', 'auth_cipher', 'auth_psk', 'tags', + 'status', 'ssid', 'tenant_group', 'tenant', 'description', 'auth_type', 'auth_cipher', 'auth_psk', 'tags', ] widgets = { 'status': StaticSelect, diff --git a/netbox/wireless/migrations/0004_wireless_tenancy.py b/netbox/wireless/migrations/0004_wireless_tenancy.py new file mode 100644 index 000000000..aa5837b0a --- /dev/null +++ b/netbox/wireless/migrations/0004_wireless_tenancy.py @@ -0,0 +1,25 @@ +# Generated by Django 4.0.5 on 2022-06-27 13:44 + +from django.db import migrations, models +import django.db.models.deletion + + +class Migration(migrations.Migration): + + dependencies = [ + ('tenancy', '0007_contact_link'), + ('wireless', '0003_created_datetimefield'), + ] + + operations = [ + migrations.AddField( + model_name='wirelesslan', + name='tenant', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='wireless_lans', to='tenancy.tenant'), + ), + migrations.AddField( + model_name='wirelesslink', + name='tenant', + field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='wireless_links', to='tenancy.tenant'), + ), + ] diff --git a/netbox/wireless/models.py b/netbox/wireless/models.py index 0543e5621..dd3945d50 100644 --- a/netbox/wireless/models.py +++ b/netbox/wireless/models.py @@ -101,6 +101,13 @@ class WirelessLAN(WirelessAuthenticationBase, NetBoxModel): null=True, verbose_name='VLAN' ) + tenant = models.ForeignKey( + to='tenancy.Tenant', + on_delete=models.PROTECT, + related_name='wireless_lans', + blank=True, + null=True + ) description = models.CharField( max_length=200, blank=True @@ -143,6 +150,13 @@ class WirelessLink(WirelessAuthenticationBase, NetBoxModel): choices=LinkStatusChoices, default=LinkStatusChoices.STATUS_CONNECTED ) + tenant = models.ForeignKey( + to='tenancy.Tenant', + on_delete=models.PROTECT, + related_name='wireless_links', + blank=True, + null=True + ) description = models.CharField( max_length=200, blank=True diff --git a/netbox/wireless/tables/wirelesslan.py b/netbox/wireless/tables/wirelesslan.py index 9955d4ac4..fc791d730 100644 --- a/netbox/wireless/tables/wirelesslan.py +++ b/netbox/wireless/tables/wirelesslan.py @@ -2,6 +2,7 @@ import django_tables2 as tables from dcim.models import Interface from netbox.tables import NetBoxTable, columns +from tenancy.tables import TenantColumn from wireless.models import * __all__ = ( @@ -39,6 +40,7 @@ class WirelessLANTable(NetBoxTable): group = tables.Column( linkify=True ) + tenant = TenantColumn() interface_count = tables.Column( verbose_name='Interfaces' ) @@ -49,8 +51,8 @@ class WirelessLANTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = WirelessLAN fields = ( - 'pk', 'ssid', 'group', 'description', 'vlan', 'interface_count', 'auth_type', 'auth_cipher', 'auth_psk', - 'tags', 'created', 'last_updated', + 'pk', 'ssid', 'group', 'tenant', 'description', 'vlan', 'interface_count', 'auth_type', 'auth_cipher', + 'auth_psk', 'tags', 'created', 'last_updated', ) default_columns = ('pk', 'ssid', 'group', 'description', 'vlan', 'auth_type', 'interface_count') diff --git a/netbox/wireless/tables/wirelesslink.py b/netbox/wireless/tables/wirelesslink.py index 72037c4d9..6a45a21ae 100644 --- a/netbox/wireless/tables/wirelesslink.py +++ b/netbox/wireless/tables/wirelesslink.py @@ -1,6 +1,7 @@ import django_tables2 as tables from netbox.tables import NetBoxTable, columns +from tenancy.tables import TenantColumn from wireless.models import * __all__ = ( @@ -28,6 +29,7 @@ class WirelessLinkTable(NetBoxTable): interface_b = tables.Column( linkify=True ) + tenant = TenantColumn() tags = columns.TagColumn( url_name='wireless:wirelesslink_list' ) @@ -35,7 +37,7 @@ class WirelessLinkTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = WirelessLink fields = ( - 'pk', 'id', 'status', 'device_a', 'interface_a', 'device_b', 'interface_b', 'ssid', 'description', + 'pk', 'id', 'status', 'device_a', 'interface_a', 'device_b', 'interface_b', 'ssid', 'tenant', 'description', 'auth_type', 'auth_cipher', 'auth_psk', 'tags', 'created', 'last_updated', ) default_columns = ( diff --git a/netbox/wireless/tests/test_api.py b/netbox/wireless/tests/test_api.py index 917b7b320..9ef552eb7 100644 --- a/netbox/wireless/tests/test_api.py +++ b/netbox/wireless/tests/test_api.py @@ -1,10 +1,11 @@ from django.urls import reverse -from wireless.choices import * -from wireless.models import * from dcim.choices import InterfaceTypeChoices from dcim.models import Interface +from tenancy.models import Tenant from utilities.testing import APITestCase, APIViewTestCases, create_test_device +from wireless.choices import * +from wireless.models import * class AppTest(APITestCase): @@ -52,6 +53,12 @@ class WirelessLANTest(APIViewTestCases.APIViewTestCase): @classmethod def setUpTestData(cls): + tenants = ( + Tenant(name='Tenant 1', slug='tenant-1'), + Tenant(name='Tenant 2', slug='tenant-2'), + ) + Tenant.objects.bulk_create(tenants) + groups = ( WirelessLANGroup(name='Group 1', slug='group-1'), WirelessLANGroup(name='Group 2', slug='group-2'), @@ -71,21 +78,25 @@ class WirelessLANTest(APIViewTestCases.APIViewTestCase): { 'ssid': 'WLAN4', 'group': groups[0].pk, + 'tenant': tenants[0].pk, 'auth_type': WirelessAuthTypeChoices.TYPE_OPEN, }, { 'ssid': 'WLAN5', 'group': groups[1].pk, + 'tenant': tenants[0].pk, 'auth_type': WirelessAuthTypeChoices.TYPE_WPA_PERSONAL, }, { 'ssid': 'WLAN6', + 'tenant': tenants[0].pk, 'auth_type': WirelessAuthTypeChoices.TYPE_WPA_ENTERPRISE, }, ] cls.bulk_update_data = { 'group': groups[2].pk, + 'tenant': tenants[1].pk, 'description': 'New description', 'auth_type': WirelessAuthTypeChoices.TYPE_WPA_PERSONAL, 'auth_cipher': WirelessAuthCipherChoices.CIPHER_AES, @@ -115,10 +126,16 @@ class WirelessLinkTest(APIViewTestCases.APIViewTestCase): ] Interface.objects.bulk_create(interfaces) + tenants = ( + Tenant(name='Tenant 1', slug='tenant-1'), + Tenant(name='Tenant 2', slug='tenant-2'), + ) + Tenant.objects.bulk_create(tenants) + wireless_links = ( - WirelessLink(ssid='LINK1', interface_a=interfaces[0], interface_b=interfaces[1]), - WirelessLink(ssid='LINK2', interface_a=interfaces[2], interface_b=interfaces[3]), - WirelessLink(ssid='LINK3', interface_a=interfaces[4], interface_b=interfaces[5]), + WirelessLink(ssid='LINK1', interface_a=interfaces[0], interface_b=interfaces[1], tenant=tenants[0]), + WirelessLink(ssid='LINK2', interface_a=interfaces[2], interface_b=interfaces[3], tenant=tenants[0]), + WirelessLink(ssid='LINK3', interface_a=interfaces[4], interface_b=interfaces[5], tenant=tenants[0]), ) WirelessLink.objects.bulk_create(wireless_links) @@ -127,15 +144,18 @@ class WirelessLinkTest(APIViewTestCases.APIViewTestCase): 'interface_a': interfaces[6].pk, 'interface_b': interfaces[7].pk, 'ssid': 'LINK4', + 'tenant': tenants[1].pk, }, { 'interface_a': interfaces[8].pk, 'interface_b': interfaces[9].pk, 'ssid': 'LINK5', + 'tenant': tenants[1].pk, }, { 'interface_a': interfaces[10].pk, 'interface_b': interfaces[11].pk, 'ssid': 'LINK6', + 'tenant': tenants[1].pk, }, ] diff --git a/netbox/wireless/tests/test_filtersets.py b/netbox/wireless/tests/test_filtersets.py index 5fee4fbf4..ffe919c32 100644 --- a/netbox/wireless/tests/test_filtersets.py +++ b/netbox/wireless/tests/test_filtersets.py @@ -3,6 +3,7 @@ from django.test import TestCase from dcim.choices import InterfaceTypeChoices, LinkStatusChoices from dcim.models import Interface from ipam.models import VLAN +from tenancy.models import Tenant from wireless.choices import * from wireless.filtersets import * from wireless.models import * @@ -43,10 +44,6 @@ class WirelessLANGroupTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'slug': ['wireless-lan-group-1', 'wireless-lan-group-2']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) - def test_description(self): - params = {'description': ['A', 'B']} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) - def test_parent(self): parent_groups = WirelessLANGroup.objects.filter(parent__isnull=True)[:2] params = {'parent_id': [parent_groups[0].pk, parent_groups[1].pk]} @@ -81,10 +78,17 @@ class WirelessLANTestCase(TestCase, ChangeLoggedFilterSetTests): ) VLAN.objects.bulk_create(vlans) + tenants = ( + Tenant(name='Tenant 1', slug='tenant-1'), + Tenant(name='Tenant 2', slug='tenant-2'), + Tenant(name='Tenant 3', slug='tenant-3'), + ) + Tenant.objects.bulk_create(tenants) + wireless_lans = ( - WirelessLAN(ssid='WLAN1', group=groups[0], vlan=vlans[0], auth_type=WirelessAuthTypeChoices.TYPE_OPEN, auth_cipher=WirelessAuthCipherChoices.CIPHER_AUTO, auth_psk='PSK1'), - WirelessLAN(ssid='WLAN2', group=groups[1], vlan=vlans[1], auth_type=WirelessAuthTypeChoices.TYPE_WEP, auth_cipher=WirelessAuthCipherChoices.CIPHER_TKIP, auth_psk='PSK2'), - WirelessLAN(ssid='WLAN3', group=groups[2], vlan=vlans[2], auth_type=WirelessAuthTypeChoices.TYPE_WPA_PERSONAL, auth_cipher=WirelessAuthCipherChoices.CIPHER_AES, auth_psk='PSK3'), + WirelessLAN(ssid='WLAN1', group=groups[0], vlan=vlans[0], tenant=tenants[0], auth_type=WirelessAuthTypeChoices.TYPE_OPEN, auth_cipher=WirelessAuthCipherChoices.CIPHER_AUTO, auth_psk='PSK1'), + WirelessLAN(ssid='WLAN2', group=groups[1], vlan=vlans[1], tenant=tenants[1], auth_type=WirelessAuthTypeChoices.TYPE_WEP, auth_cipher=WirelessAuthCipherChoices.CIPHER_TKIP, auth_psk='PSK2'), + WirelessLAN(ssid='WLAN3', group=groups[2], vlan=vlans[2], tenant=tenants[2], auth_type=WirelessAuthTypeChoices.TYPE_WPA_PERSONAL, auth_cipher=WirelessAuthCipherChoices.CIPHER_AES, auth_psk='PSK3'), ) WirelessLAN.objects.bulk_create(wireless_lans) @@ -116,6 +120,13 @@ class WirelessLANTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'auth_psk': ['PSK1', 'PSK2']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_tenant(self): + tenants = Tenant.objects.all()[:2] + params = {'tenant_id': [tenants[0].pk, tenants[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'tenant': [tenants[0].slug, tenants[1].slug]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + class WirelessLinkTestCase(TestCase, ChangeLoggedFilterSetTests): queryset = WirelessLink.objects.all() @@ -124,6 +135,13 @@ class WirelessLinkTestCase(TestCase, ChangeLoggedFilterSetTests): @classmethod def setUpTestData(cls): + tenants = ( + Tenant(name='Tenant 1', slug='tenant-1'), + Tenant(name='Tenant 2', slug='tenant-2'), + Tenant(name='Tenant 3', slug='tenant-3'), + ) + Tenant.objects.bulk_create(tenants) + devices = ( create_test_device('device1'), create_test_device('device2'), @@ -152,6 +170,7 @@ class WirelessLinkTestCase(TestCase, ChangeLoggedFilterSetTests): auth_type=WirelessAuthTypeChoices.TYPE_OPEN, auth_cipher=WirelessAuthCipherChoices.CIPHER_AUTO, auth_psk='PSK1', + tenant=tenants[0], description='foobar1' ).save() WirelessLink( @@ -162,6 +181,7 @@ class WirelessLinkTestCase(TestCase, ChangeLoggedFilterSetTests): auth_type=WirelessAuthTypeChoices.TYPE_WEP, auth_cipher=WirelessAuthCipherChoices.CIPHER_TKIP, auth_psk='PSK2', + tenant=tenants[1], description='foobar2' ).save() WirelessLink( @@ -171,7 +191,8 @@ class WirelessLinkTestCase(TestCase, ChangeLoggedFilterSetTests): status=LinkStatusChoices.STATUS_DECOMMISSIONING, auth_type=WirelessAuthTypeChoices.TYPE_WPA_PERSONAL, auth_cipher=WirelessAuthCipherChoices.CIPHER_AES, - auth_psk='PSK3' + auth_psk='PSK3', + tenant=tenants[2], ).save() WirelessLink( interface_a=interfaces[5], @@ -202,3 +223,10 @@ class WirelessLinkTestCase(TestCase, ChangeLoggedFilterSetTests): def test_description(self): params = {'description': ['foobar1', 'foobar2']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_tenant(self): + tenants = Tenant.objects.all()[:2] + params = {'tenant_id': [tenants[0].pk, tenants[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'tenant': [tenants[0].slug, tenants[1].slug]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) diff --git a/netbox/wireless/tests/test_views.py b/netbox/wireless/tests/test_views.py index 4141af6d6..7dea17d15 100644 --- a/netbox/wireless/tests/test_views.py +++ b/netbox/wireless/tests/test_views.py @@ -2,6 +2,7 @@ from wireless.choices import * from wireless.models import * from dcim.choices import InterfaceTypeChoices, LinkStatusChoices from dcim.models import Interface +from tenancy.models import Tenant from utilities.testing import ViewTestCases, create_tags, create_test_device @@ -47,6 +48,13 @@ class WirelessLANTestCase(ViewTestCases.PrimaryObjectViewTestCase): @classmethod def setUpTestData(cls): + tenants = ( + Tenant(name='Tenant 1', slug='tenant-1'), + Tenant(name='Tenant 2', slug='tenant-2'), + Tenant(name='Tenant 3', slug='tenant-3'), + ) + Tenant.objects.bulk_create(tenants) + groups = ( WirelessLANGroup(name='Wireless LAN Group 1', slug='wireless-lan-group-1'), WirelessLANGroup(name='Wireless LAN Group 2', slug='wireless-lan-group-2'), @@ -55,9 +63,9 @@ class WirelessLANTestCase(ViewTestCases.PrimaryObjectViewTestCase): group.save() WirelessLAN.objects.bulk_create([ - WirelessLAN(group=groups[0], ssid='WLAN1'), - WirelessLAN(group=groups[0], ssid='WLAN2'), - WirelessLAN(group=groups[0], ssid='WLAN3'), + WirelessLAN(group=groups[0], ssid='WLAN1', tenant=tenants[0]), + WirelessLAN(group=groups[0], ssid='WLAN2', tenant=tenants[0]), + WirelessLAN(group=groups[0], ssid='WLAN3', tenant=tenants[0]), ]) tags = create_tags('Alpha', 'Bravo', 'Charlie') @@ -65,14 +73,15 @@ class WirelessLANTestCase(ViewTestCases.PrimaryObjectViewTestCase): cls.form_data = { 'ssid': 'WLAN2', 'group': groups[1].pk, + 'tenant': tenants[1].pk, 'tags': [t.pk for t in tags], } cls.csv_data = ( - "group,ssid", - "Wireless LAN Group 2,WLAN4", - "Wireless LAN Group 2,WLAN5", - "Wireless LAN Group 2,WLAN6", + f"group,ssid,tenant", + f"Wireless LAN Group 2,WLAN4,{tenants[0].name}", + f"Wireless LAN Group 2,WLAN5,{tenants[1].name}", + f"Wireless LAN Group 2,WLAN6,{tenants[2].name}", ) cls.bulk_edit_data = { @@ -85,6 +94,14 @@ class WirelessLinkTestCase(ViewTestCases.PrimaryObjectViewTestCase): @classmethod def setUpTestData(cls): + + tenants = ( + Tenant(name='Tenant 1', slug='tenant-1'), + Tenant(name='Tenant 2', slug='tenant-2'), + Tenant(name='Tenant 3', slug='tenant-3'), + ) + Tenant.objects.bulk_create(tenants) + device = create_test_device('test-device') interfaces = [ Interface( @@ -98,9 +115,9 @@ class WirelessLinkTestCase(ViewTestCases.PrimaryObjectViewTestCase): ] Interface.objects.bulk_create(interfaces) - WirelessLink(interface_a=interfaces[0], interface_b=interfaces[1], ssid='LINK1').save() - WirelessLink(interface_a=interfaces[2], interface_b=interfaces[3], ssid='LINK2').save() - WirelessLink(interface_a=interfaces[4], interface_b=interfaces[5], ssid='LINK3').save() + WirelessLink(interface_a=interfaces[0], interface_b=interfaces[1], ssid='LINK1', tenant=tenants[0]).save() + WirelessLink(interface_a=interfaces[2], interface_b=interfaces[3], ssid='LINK2', tenant=tenants[0]).save() + WirelessLink(interface_a=interfaces[4], interface_b=interfaces[5], ssid='LINK3', tenant=tenants[0]).save() tags = create_tags('Alpha', 'Bravo', 'Charlie') @@ -108,14 +125,15 @@ class WirelessLinkTestCase(ViewTestCases.PrimaryObjectViewTestCase): 'interface_a': interfaces[6].pk, 'interface_b': interfaces[7].pk, 'status': LinkStatusChoices.STATUS_PLANNED, + 'tenant': tenants[1].pk, 'tags': [t.pk for t in tags], } cls.csv_data = ( - "interface_a,interface_b,status", - f"{interfaces[6].pk},{interfaces[7].pk},connected", - f"{interfaces[8].pk},{interfaces[9].pk},connected", - f"{interfaces[10].pk},{interfaces[11].pk},connected", + f"interface_a,interface_b,status,tenant", + f"{interfaces[6].pk},{interfaces[7].pk},connected,{tenants[0].name}", + f"{interfaces[8].pk},{interfaces[9].pk},connected,{tenants[1].name}", + f"{interfaces[10].pk},{interfaces[11].pk},connected,{tenants[2].name}", ) cls.bulk_edit_data = { From fcd1daaf798d62023f999c3e09e035f7b3f47c8f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 27 Jun 2022 14:34:08 -0400 Subject: [PATCH 173/593] Update power utilization calculations for new cabling model --- netbox/dcim/models/device_components.py | 57 ++++++++++++++++--------- netbox/dcim/models/racks.py | 22 +++++----- 2 files changed, 49 insertions(+), 30 deletions(-) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index d329f547c..c41192688 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -3,7 +3,7 @@ from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ValidationError from django.core.validators import MaxValueValidator, MinValueValidator from django.db import models -from django.db.models import Sum +from django.db.models import Q, Sum from django.urls import reverse from mptt.models import MPTTModel, TreeForeignKey @@ -156,6 +156,12 @@ class LinkTermination(models.Model): def parent_object(self): raise NotImplementedError(f"{self.__class__.__name__} models must declare a parent_object property") + @property + def opposite_cable_end(self): + if not self.cable_end: + return None + return CableEndChoices.SIDE_A if self.cable_end == CableEndChoices.SIDE_B else CableEndChoices.SIDE_B + @property def link(self): """ @@ -333,36 +339,49 @@ class PowerPort(ModularComponentModel, LinkTermination, PathEndpoint): 'allocated_draw': f"Allocated draw cannot exceed the maximum draw ({self.maximum_draw}W)." }) + def get_downstream_powerports(self, leg=None): + """ + Return a queryset of all PowerPorts connected via cable to a child PowerOutlet. + """ + poweroutlets = self.poweroutlets.filter(cable__isnull=False) + if leg: + poweroutlets = poweroutlets.filter(feed_leg=leg) + if not poweroutlets: + return PowerPort.objects.none() + + q = Q() + for poweroutlet in poweroutlets: + q |= Q( + cable=poweroutlet.cable, + cable_end=poweroutlet.opposite_cable_end + ) + + return PowerPort.objects.filter(q) + def get_power_draw(self): """ Return the allocated and maximum power draw (in VA) and child PowerOutlet count for this PowerPort. """ + from dcim.models import PowerFeed + # Calculate aggregate draw of all child power outlets if no numbers have been defined manually if self.allocated_draw is None and self.maximum_draw is None: - poweroutlet_ct = ContentType.objects.get_for_model(PowerOutlet) - outlet_ids = PowerOutlet.objects.filter(power_port=self).values_list('pk', flat=True) - utilization = PowerPort.objects.filter( - _link_peer_type=poweroutlet_ct, - _link_peer_id__in=outlet_ids - ).aggregate( + utilization = self.get_downstream_powerports().aggregate( maximum_draw_total=Sum('maximum_draw'), allocated_draw_total=Sum('allocated_draw'), ) ret = { 'allocated': utilization['allocated_draw_total'] or 0, 'maximum': utilization['maximum_draw_total'] or 0, - 'outlet_count': len(outlet_ids), + 'outlet_count': self.poweroutlets.count(), 'legs': [], } - # Calculate per-leg aggregates for three-phase feeds - if getattr(self._link_peer, 'phase', None) == PowerFeedPhaseChoices.PHASE_3PHASE: + # Calculate per-leg aggregates for three-phase power feeds + if len(self.link_peers) == 1 and isinstance(self.link_peers[0], PowerFeed) and \ + self.link_peers[0].phase == PowerFeedPhaseChoices.PHASE_3PHASE: for leg, leg_name in PowerOutletFeedLegChoices: - outlet_ids = PowerOutlet.objects.filter(power_port=self, feed_leg=leg).values_list('pk', flat=True) - utilization = PowerPort.objects.filter( - _link_peer_type=poweroutlet_ct, - _link_peer_id__in=outlet_ids - ).aggregate( + utilization = self.get_downstream_powerports(leg=leg).aggregate( maximum_draw_total=Sum('maximum_draw'), allocated_draw_total=Sum('allocated_draw'), ) @@ -370,7 +389,7 @@ class PowerPort(ModularComponentModel, LinkTermination, PathEndpoint): 'name': leg_name, 'allocated': utilization['allocated_draw_total'] or 0, 'maximum': utilization['maximum_draw_total'] or 0, - 'outlet_count': len(outlet_ids), + 'outlet_count': self.poweroutlets.filter(feed_leg=leg).count(), }) return ret @@ -379,7 +398,7 @@ class PowerPort(ModularComponentModel, LinkTermination, PathEndpoint): return { 'allocated': self.allocated_draw or 0, 'maximum': self.maximum_draw or 0, - 'outlet_count': PowerOutlet.objects.filter(power_port=self).count(), + 'outlet_count': self.poweroutlets.count(), 'legs': [], } @@ -422,9 +441,7 @@ class PowerOutlet(ModularComponentModel, LinkTermination, PathEndpoint): # Validate power port assignment if self.power_port and self.power_port.device != self.device: - raise ValidationError( - "Parent power port ({}) must belong to the same device".format(self.power_port) - ) + raise ValidationError(f"Parent power port ({self.power_port}) must belong to the same device") # diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index 31fbb71de..22b134785 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -429,20 +429,22 @@ class Rack(NetBoxModel): """ powerfeeds = PowerFeed.objects.filter(rack=self) available_power_total = sum(pf.available_power for pf in powerfeeds) + print(f'available_power_total: {available_power_total}') if not available_power_total: return 0 - pf_powerports = PowerPort.objects.filter( - _link_peer_type=ContentType.objects.get_for_model(PowerFeed), - _link_peer_id__in=powerfeeds.values_list('id', flat=True) - ) - poweroutlets = PowerOutlet.objects.filter(power_port_id__in=pf_powerports) - allocated_draw_total = PowerPort.objects.filter( - _link_peer_type=ContentType.objects.get_for_model(PowerOutlet), - _link_peer_id__in=poweroutlets.values_list('id', flat=True) - ).aggregate(Sum('allocated_draw'))['allocated_draw__sum'] or 0 + powerports = [] + for powerfeed in powerfeeds: + powerports.extend([ + peer for peer in powerfeed.link_peers if isinstance(peer, PowerPort) + ]) - return int(allocated_draw_total / available_power_total * 100) + allocated_draw = 0 + for powerport in powerports: + allocated_draw += powerport.get_power_draw()['allocated'] + print(f'allocated_draw: {allocated_draw}') + + return int(allocated_draw / available_power_total * 100) class RackReservation(NetBoxModel): From 7622d90c1de981e78d63f31b52505e0dd6689cd4 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 27 Jun 2022 15:22:09 -0400 Subject: [PATCH 174/593] Extend cable tracing to support terminations to different parent objects --- netbox/dcim/models/cables.py | 3 +-- netbox/dcim/svg/cables.py | 45 +++++++++++++++++++----------------- 2 files changed, 25 insertions(+), 23 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 55b1512d0..f13c77d15 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -444,9 +444,8 @@ class CablePath(models.Model): while terminations: - # Terminations must all be of the same type and belong to the same parent + # Terminations must all be of the same type assert all(isinstance(t, type(terminations[0])) for t in terminations[1:]) - assert all(t.parent_object == terminations[0].parent_object for t in terminations[1:]) # Step 1: Record the near-end termination object(s) path.append([ diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py index 3a9b47b54..d26bc5ff5 100644 --- a/netbox/dcim/svg/cables.py +++ b/netbox/dcim/svg/cables.py @@ -18,7 +18,6 @@ PADDING = 10 LINE_HEIGHT = 20 FANOUT_HEIGHT = 35 FANOUT_LEG_HEIGHT = 15 -TERMINATION_WIDTH = 100 class Node(Hyperlink): @@ -174,32 +173,35 @@ class CableTraceSVG: # Other parent object return 'e0e0e0' - def draw_parent_object(self, obj): - node = Node( - position=(0, self.cursor), - width=self.width, - url=f'{self.base_url}{obj.get_absolute_url()}', - color=self._get_color(obj), - labels=self._get_labels(obj) - ) - self.parent_objects.append(node) - self.cursor += node.box['height'] - - return node + def draw_parent_objects(self, obj_list): + """ + Draw a set of parent objects. + """ + width = self.width / len(obj_list) + for i, obj in enumerate(obj_list): + node = Node( + position=(i * width, self.cursor), + width=width, + url=f'{self.base_url}{obj.get_absolute_url()}', + color=self._get_color(obj), + labels=self._get_labels(obj) + ) + self.parent_objects.append(node) + if i + 1 == len(obj_list): + self.cursor += node.box['height'] def draw_terminations(self, terminations): """ - Draw a row of terminating objects (e.g. interfaces) belonging to the same parent object, all of which - are attached to the same end of a cable. + Draw a row of terminating objects (e.g. interfaces), all of which are attached to the same end of a cable. """ nodes = [] nodes_height = 0 - x = self.width / 2 - len(terminations) * TERMINATION_WIDTH / 2 + width = self.width / len(terminations) for i, term in enumerate(terminations): node = Node( - position=(x + i * TERMINATION_WIDTH, self.cursor), - width=TERMINATION_WIDTH, + position=(i * width, self.cursor), + width=width, url=f'{self.base_url}{term.get_absolute_url()}', color=self._get_color(term), labels=self._get_labels(term), @@ -324,7 +326,7 @@ class CableTraceSVG: # Near end parent if i == 0: # If this is the first segment, draw the originating termination's parent object - self.draw_parent_object(near_ends[0].parent_object) + self.draw_parent_objects(set(end.parent_object for end in near_ends)) # Near end termination(s) terminations = self.draw_terminations(near_ends) @@ -363,7 +365,8 @@ class CableTraceSVG: self.draw_terminations(far_ends) # Far end parent - self.draw_parent_object(far_ends[0].parent_object) + parent_objects = set(end.parent_object for end in far_ends) + self.draw_parent_objects(parent_objects) elif far_ends: @@ -372,7 +375,7 @@ class CableTraceSVG: self.connectors.append(attachment) # ProviderNetwork - self.draw_parent_object(far_ends[0]) + self.draw_parent_objects(set(end.parent_object for end in far_ends)) # Determine drawing size self.drawing = svgwrite.Drawing( From 9d35a9d9128f40c09687c50283f06c535329688e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 27 Jun 2022 15:28:03 -0400 Subject: [PATCH 175/593] Fix bug with path padding --- netbox/dcim/models/device_components.py | 4 ++-- netbox/dcim/models/racks.py | 2 -- netbox/dcim/svg/cables.py | 6 +++--- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index c41192688..c2cd31a2a 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -205,14 +205,14 @@ class PathEndpoint(models.Model): while (len(path)) % 3: # Pad to ensure we have complete three-tuples (e.g. for paths that end at a non-connected FrontPort) # by inserting empty entries immediately prior to the path's destination node(s) - path.insert(-1, [None]) + path.append([]) # TODO: Add bridging support # # Check for bridge interface to continue the trace # origin = getattr(origin._path.destination, 'bridge', None) origin = None - # Return the path as a list of three-tuples (A termination, cable, B termination) + # Return the path as a list of three-tuples (A termination(s), cable(s), B termination(s)) return list(zip(*[iter(path)] * 3)) def get_trace_svg(self, base_url=None, width=None): diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index 22b134785..3bbf38b6a 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -429,7 +429,6 @@ class Rack(NetBoxModel): """ powerfeeds = PowerFeed.objects.filter(rack=self) available_power_total = sum(pf.available_power for pf in powerfeeds) - print(f'available_power_total: {available_power_total}') if not available_power_total: return 0 @@ -442,7 +441,6 @@ class Rack(NetBoxModel): allocated_draw = 0 for powerport in powerports: allocated_draw += powerport.get_power_draw()['allocated'] - print(f'allocated_draw: {allocated_draw}') return int(allocated_draw / available_power_total * 100) diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py index d26bc5ff5..b9d7c42ed 100644 --- a/netbox/dcim/svg/cables.py +++ b/netbox/dcim/svg/cables.py @@ -321,7 +321,7 @@ class CableTraceSVG: # Iterate through each (terms, cable, terms) segment in the path for i, segment in enumerate(traced_path): - near_ends, link, far_ends = segment + near_ends, links, far_ends = segment # Near end parent if i == 0: @@ -332,8 +332,8 @@ class CableTraceSVG: terminations = self.draw_terminations(near_ends) # Connector (a Cable or WirelessLink) - link = link[0] # Remove Cable from list - if link is not None: + if links: + link = links[0] # Remove Cable from list # Cable if type(link) is Cable: From 8bbc59226153cb2ce7308fdf069385e1f6ff50a2 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 27 Jun 2022 15:53:34 -0400 Subject: [PATCH 176/593] Add SVG rendering to cable path tests --- netbox/dcim/api/views.py | 5 +++-- netbox/dcim/constants.py | 2 ++ netbox/dcim/models/device_components.py | 7 ++----- netbox/dcim/svg/cables.py | 3 ++- netbox/dcim/tests/test_cablepaths.py | 18 ++++++++++++++++++ 5 files changed, 27 insertions(+), 8 deletions(-) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 4a528b647..4df89d55d 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -13,6 +13,7 @@ from rest_framework.viewsets import ViewSet from circuits.models import Circuit from dcim import filtersets +from dcim.constants import CABLE_TRACE_SVG_DEFAULT_WIDTH from dcim.models import * from extras.api.views import ConfigContextQuerySetMixin from ipam.models import Prefix, VLAN @@ -54,9 +55,9 @@ class PathEndpointMixin(object): if request.GET.get('render', None) == 'svg': # Render SVG try: - width = min(int(request.GET.get('width')), 1600) + width = int(request.GET.get('width', CABLE_TRACE_SVG_DEFAULT_WIDTH)) except (ValueError, TypeError): - width = None + width = CABLE_TRACE_SVG_DEFAULT_WIDTH drawing = obj.get_trace_svg( base_url=request.build_absolute_uri('/'), width=width diff --git a/netbox/dcim/constants.py b/netbox/dcim/constants.py index 68bbd1dbe..aa921ccc6 100644 --- a/netbox/dcim/constants.py +++ b/netbox/dcim/constants.py @@ -94,6 +94,8 @@ MODULAR_COMPONENT_MODELS = Q( # Cabling and connections # +CABLE_TRACE_SVG_DEFAULT_WIDTH = 400 + # Cable endpoint types CABLE_TERMINATION_MODELS = Q( Q(app_label='circuits', model__in=( diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index c2cd31a2a..72be19b10 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -215,11 +215,8 @@ class PathEndpoint(models.Model): # Return the path as a list of three-tuples (A termination(s), cable(s), B termination(s)) return list(zip(*[iter(path)] * 3)) - def get_trace_svg(self, base_url=None, width=None): - if width is not None: - trace = CableTraceSVG(self, base_url=base_url, width=width) - else: - trace = CableTraceSVG(self, base_url=base_url) + def get_trace_svg(self, base_url=None, width=CABLE_TRACE_SVG_DEFAULT_WIDTH): + trace = CableTraceSVG(self, base_url=base_url, width=width) return trace.render() @property diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py index b9d7c42ed..f9c614b67 100644 --- a/netbox/dcim/svg/cables.py +++ b/netbox/dcim/svg/cables.py @@ -5,6 +5,7 @@ from svgwrite.text import Text from django.conf import settings +from dcim.constants import CABLE_TRACE_SVG_DEFAULT_WIDTH from utilities.utils import foreground_color @@ -115,7 +116,7 @@ class CableTraceSVG: :param width: Width of the generated image (in pixels) :param base_url: Base URL for links within the SVG document. If none, links will be relative. """ - def __init__(self, origin, width=400, base_url=None): + def __init__(self, origin, width=CABLE_TRACE_SVG_DEFAULT_WIDTH, base_url=None): self.origin = origin self.width = width self.base_url = base_url.rstrip('/') if base_url is not None else '' diff --git a/netbox/dcim/tests/test_cablepaths.py b/netbox/dcim/tests/test_cablepaths.py index 6d158bb10..e5b441c51 100644 --- a/netbox/dcim/tests/test_cablepaths.py +++ b/netbox/dcim/tests/test_cablepaths.py @@ -106,6 +106,9 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface1, path1) self.assertPathIsSet(interface2, path2) + # Test SVG generation + interface1.get_trace_svg() + # Delete cable 1 cable1.delete() @@ -142,6 +145,9 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(consoleport1, path1) self.assertPathIsSet(consoleserverport1, path2) + # Test SVG generation + consoleport1.get_trace_svg() + # Delete cable 1 cable1.delete() @@ -178,6 +184,9 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(powerport1, path1) self.assertPathIsSet(poweroutlet1, path2) + # Test SVG generation + powerport1.get_trace_svg() + # Delete cable 1 cable1.delete() @@ -214,6 +223,9 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(powerport1, path1) self.assertPathIsSet(powerfeed1, path2) + # Test SVG generation + powerport1.get_trace_svg() + # Delete cable 1 cable1.delete() @@ -254,6 +266,9 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface2, path2) self.assertPathIsSet(interface3, path2) + # Test SVG generation + interface1.get_trace_svg() + # Delete cable 1 cable1.delete() @@ -303,6 +318,9 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface3, path2) self.assertPathIsSet(interface4, path2) + # Test SVG generation + interface1.get_trace_svg() + # Delete cable 1 cable1.delete() From 03d6e25dea40647f270bb99abbfb59415e08bfd5 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 27 Jun 2022 16:40:40 -0400 Subject: [PATCH 177/593] Remove obsolete validation logic --- netbox/dcim/models/cables.py | 27 -------------------- netbox/dcim/tests/test_models.py | 43 ++------------------------------ 2 files changed, 2 insertions(+), 68 deletions(-) diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index f13c77d15..8f31c77f2 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -126,17 +126,6 @@ class Cable(NetBoxModel): def clean(self): super().clean() - # TODO: Is this validation still necessary? - # # Check that two connected RearPorts have the same number of positions (if both are >1) - # if isinstance(self.termination_a, RearPort) and isinstance(self.termination_b, RearPort): - # if self.termination_a.positions > 1 and self.termination_b.positions > 1: - # if self.termination_a.positions != self.termination_b.positions: - # raise ValidationError( - # f"{self.termination_a} has {self.termination_a.positions} position(s) but " - # f"{self.termination_b} has {self.termination_b.positions}. " - # f"Both terminations must have the same number of positions (if greater than one)." - # ) - # Validate length and length_unit if self.length is not None and not self.length_unit: raise ValidationError("Must specify a unit when setting a cable length") @@ -153,10 +142,6 @@ class Cable(NetBoxModel): # Check that all termination objects for either end are of the same type for terms in (a_terminations, b_terminations): if terms and len(terms) > 1: - if not all(t.termination.parent_object == terms[0].termination.parent_object for t in terms[1:]): - raise ValidationError( - "All terminations on one end of a cable must belong to the same parent object." - ) if not all(t.termination_type == terms[0].termination_type for t in terms[1:]): raise ValidationError( "Cannot connect different termination types to same end of cable." @@ -175,18 +160,6 @@ class Cable(NetBoxModel): for cabletermination in [*a_terminations, *b_terminations]: cabletermination.clean() - # TODO - # # A front port cannot be connected to its corresponding rear port - # if ( - # type_a in ['frontport', 'rearport'] and - # type_b in ['frontport', 'rearport'] and - # ( - # getattr(self.termination_a, 'rear_port', None) == self.termination_b or - # getattr(self.termination_b, 'rear_port', None) == self.termination_a - # ) - # ): - # raise ValidationError("A front port cannot be connected to it corresponding rear port") - def save(self, *args, **kwargs): _created = self.pk is None diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index 84a5fc1a1..d97823e7c 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -537,20 +537,11 @@ class CableTestCase(TestCase): """ The clean method should have a check to ensure only compatible port types can be connected by a cable """ - # An interface cannot be connected to a power port - cable = Cable(a_terminations=[self.interface1, self.interface2], b_terminations=[self.interface3]) + # An interface cannot be connected to a power port, for example + cable = Cable(a_terminations=[self.interface1], b_terminations=[self.power_port1]) with self.assertRaises(ValidationError): cable.clean() - # TODO: Remove this? - # def test_cable_front_port_cannot_connect_to_corresponding_rear_port(self): - # """ - # A cable cannot connect a front port to its corresponding rear port - # """ - # cable = Cable(a_terminations=[self.front_port1], b_terminations=[self.rear_port1]) - # with self.assertRaises(ValidationError): - # cable.clean() - def test_cable_cannot_terminate_to_a_provider_network_circuittermination(self): """ Neither side of a cable can be terminated to a CircuitTermination which is attached to a ProviderNetwork @@ -559,36 +550,6 @@ class CableTestCase(TestCase): with self.assertRaises(ValidationError): cable.clean() - # TODO: Remove this? - # def test_rearport_connections(self): - # """ - # Test various combinations of RearPort connections. - # """ - # # Connecting a single-position RearPort to a multi-position RearPort is ok - # Cable(a_terminations=[self.rear_port1], b_terminations=[self.rear_port2]).full_clean() - # - # # Connecting a single-position RearPort to an Interface is ok - # Cable(a_terminations=[self.rear_port1], b_terminations=[self.interface3]).full_clean() - # - # # Connecting a single-position RearPort to a CircuitTermination is ok - # Cable(a_terminations=[self.rear_port1], b_terminations=[self.circuittermination1]).full_clean() - # - # # Connecting a multi-position RearPort to another RearPort with the same number of positions is ok - # Cable(a_terminations=[self.rear_port3], b_terminations=[self.rear_port4]).full_clean() - # - # # Connecting a multi-position RearPort to an Interface is ok - # Cable(a_terminations=[self.rear_port2], b_terminations=[self.interface3]).full_clean() - # - # # Connecting a multi-position RearPort to a CircuitTermination is ok - # Cable(a_terminations=[self.rear_port2], b_terminations=[self.circuittermination1]).full_clean() - # - # # Connecting a two-position RearPort to a three-position RearPort is NOT ok - # with self.assertRaises( - # ValidationError, - # msg='Connecting a 2-position RearPort to a 3-position RearPort should fail' - # ): - # Cable(a_terminations=[self.rear_port2], b_terminations=[self.rear_port3]).full_clean() - def test_cable_cannot_terminate_to_a_virtual_interface(self): """ A cable cannot terminate to a virtual interface From 03f1584d3aadf5bd37c31e439a75a1b2bd064db3 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Mon, 27 Jun 2022 23:24:50 -0500 Subject: [PATCH 178/593] L2VPN Clean Tree --- netbox/dcim/models/device_components.py | 5 + netbox/ipam/api/nested_serializers.py | 27 ++++ netbox/ipam/api/serializers.py | 58 +++++++++ netbox/ipam/api/urls.py | 4 + netbox/ipam/api/views.py | 13 ++ netbox/ipam/choices.py | 50 ++++++++ netbox/ipam/constants.py | 6 + netbox/ipam/filtersets.py | 65 ++++++++++ netbox/ipam/forms/bulk_edit.py | 18 +++ netbox/ipam/forms/bulk_import.py | 74 +++++++++++ netbox/ipam/forms/filtersets.py | 29 +++++ netbox/ipam/forms/models.py | 96 +++++++++++++++ netbox/ipam/models/__init__.py | 3 + netbox/ipam/models/l2vpn.py | 116 ++++++++++++++++++ netbox/ipam/models/vlans.py | 9 +- netbox/ipam/tables/__init__.py | 1 + netbox/ipam/tables/l2vpn.py | 38 ++++++ netbox/ipam/tests/test_api.py | 93 ++++++++++++++ netbox/ipam/tests/test_filtersets.py | 101 +++++++++++++++ netbox/ipam/tests/test_models.py | 10 ++ netbox/ipam/tests/test_views.py | 10 ++ netbox/ipam/urls.py | 21 ++++ netbox/ipam/views.py | 96 +++++++++++++++ netbox/netbox/navigation_menu.py | 7 ++ netbox/templates/ipam/l2vpn.html | 111 +++++++++++++++++ netbox/templates/ipam/l2vpntermination.html | 31 +++++ .../templates/ipam/l2vpntermination_edit.html | 39 ++++++ 27 files changed, 1130 insertions(+), 1 deletion(-) create mode 100644 netbox/ipam/models/l2vpn.py create mode 100644 netbox/ipam/tables/l2vpn.py create mode 100644 netbox/templates/ipam/l2vpn.html create mode 100644 netbox/templates/ipam/l2vpntermination.html create mode 100644 netbox/templates/ipam/l2vpntermination_edit.html diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index f49db08ab..4d19a2d8d 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -649,6 +649,11 @@ class Interface(ModularComponentModel, BaseInterface, LinkTermination, PathEndpo object_id_field='interface_id', related_query_name='+' ) + l2vpn = GenericRelation( + to='ipam.L2VPNTermination', + content_type_field='assigned_object_type', + object_id_field='assigned_object_id', + ) clone_fields = ['device', 'parent', 'bridge', 'lag', 'type', 'mgmt_only', 'poe_mode', 'poe_type'] diff --git a/netbox/ipam/api/nested_serializers.py b/netbox/ipam/api/nested_serializers.py index 5f9e09049..8316cb992 100644 --- a/netbox/ipam/api/nested_serializers.py +++ b/netbox/ipam/api/nested_serializers.py @@ -1,6 +1,7 @@ from rest_framework import serializers from ipam import models +from ipam.models.l2vpn import L2VPNTermination, L2VPN from netbox.api import WritableNestedSerializer __all__ = [ @@ -190,3 +191,29 @@ class NestedServiceSerializer(WritableNestedSerializer): class Meta: model = models.Service fields = ['id', 'url', 'display', 'name', 'protocol', 'ports'] + +# +# Virtual Circuits +# + + +class NestedL2VPNSerializer(WritableNestedSerializer): + url = serializers.HyperlinkedIdentityField(view_name='ipam-api:l2vpn-detail') + + class Meta: + model = L2VPN + fields = [ + 'id', 'url', 'display', 'name', 'type' + ] + + +class NestedL2VPNTerminationSerializer(WritableNestedSerializer): + url = serializers.HyperlinkedIdentityField(view_name='ipam-api:l2vpn_termination-detail') + l2vpn = NestedL2VPNSerializer() + + class Meta: + model = L2VPNTermination + fields = [ + 'id', 'url', 'display', 'l2vpn', 'assigned_object' + ] + diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index ea5c37f91..a51043e27 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -19,6 +19,9 @@ from .nested_serializers import * # # ASNs # +from .nested_serializers import NestedL2VPNSerializer +from ..models.l2vpn import L2VPNTermination, L2VPN + class ASNSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='ipam-api:asn-detail') @@ -433,3 +436,58 @@ class ServiceSerializer(NetBoxModelSerializer): 'id', 'url', 'display', 'device', 'virtual_machine', 'name', 'ports', 'protocol', 'ipaddresses', 'description', 'tags', 'custom_fields', 'created', 'last_updated', ] + +# +# Virtual Circuits +# + + +class L2VPNSerializer(NetBoxModelSerializer): + url = serializers.HyperlinkedIdentityField(view_name='ipam-api:l2vpn-detail') + type = ChoiceField(choices=L2VPNTypeChoices, required=False) + import_targets = SerializedPKRelatedField( + queryset=RouteTarget.objects.all(), + serializer=NestedRouteTargetSerializer, + required=False, + many=True + ) + export_targets = SerializedPKRelatedField( + queryset=RouteTarget.objects.all(), + serializer=NestedRouteTargetSerializer, + required=False, + many=True + ) + tenant = NestedTenantSerializer(required=False, allow_null=True) + + class Meta: + model = L2VPN + fields = [ + 'id', 'url', 'display', 'identifier', 'name', 'slug', 'type', 'import_targets', 'export_targets', + 'description', 'tenant', + # Extra Fields + 'tags', 'custom_fields', 'created', 'last_updated' + ] + + +class L2VPNTerminationSerializer(NetBoxModelSerializer): + url = serializers.HyperlinkedIdentityField(view_name='ipam-api:l2vpntermination-detail') + l2vpn = NestedL2VPNSerializer() + assigned_object_type = ContentTypeField( + queryset=ContentType.objects.all() + ) + assigned_object = serializers.SerializerMethodField(read_only=True) + + class Meta: + model = L2VPNTermination + fields = [ + 'id', 'url', 'display', 'l2vpn', 'assigned_object_type', 'assigned_object_id', + 'assigned_object', + # Extra Fields + 'tags', 'custom_fields', 'created', 'last_updated' + ] + + @swagger_serializer_method(serializer_or_field=serializers.DictField) + def get_assigned_object(self, instance): + serializer = get_serializer_for_model(instance.assigned_object, prefix='Nested') + context = {'request': self.context['request']} + return serializer(instance.assigned_object, context=context).data diff --git a/netbox/ipam/api/urls.py b/netbox/ipam/api/urls.py index 99e039eff..b588b6974 100644 --- a/netbox/ipam/api/urls.py +++ b/netbox/ipam/api/urls.py @@ -45,6 +45,10 @@ router.register('vlans', views.VLANViewSet) router.register('service-templates', views.ServiceTemplateViewSet) router.register('services', views.ServiceViewSet) +# L2VPN +router.register('l2vpn', views.L2VPNViewSet) +router.register('l2vpn-termination', views.L2VPNTerminationViewSet) + app_name = 'ipam-api' urlpatterns = [ diff --git a/netbox/ipam/api/views.py b/netbox/ipam/api/views.py index dcddec580..36a6f02b6 100644 --- a/netbox/ipam/api/views.py +++ b/netbox/ipam/api/views.py @@ -18,6 +18,7 @@ from netbox.config import get_config from utilities.constants import ADVISORY_LOCK_KEYS from utilities.utils import count_related from . import serializers +from ..models.l2vpn import L2VPN, L2VPNTermination class IPAMRootView(APIRootView): @@ -157,6 +158,18 @@ class ServiceViewSet(NetBoxModelViewSet): filterset_class = filtersets.ServiceFilterSet +class L2VPNViewSet(NetBoxModelViewSet): + queryset = L2VPN.objects + serializer_class = serializers.L2VPNSerializer + filterset_class = filtersets.L2VPNFilterSet + + +class L2VPNTerminationViewSet(NetBoxModelViewSet): + queryset = L2VPNTermination.objects + serializer_class = serializers.L2VPNTerminationSerializer + filterset_class = filtersets.L2VPNTerminationFilterSet + + # # Views # diff --git a/netbox/ipam/choices.py b/netbox/ipam/choices.py index a364d3c6a..a867b05bc 100644 --- a/netbox/ipam/choices.py +++ b/netbox/ipam/choices.py @@ -170,3 +170,53 @@ class ServiceProtocolChoices(ChoiceSet): (PROTOCOL_UDP, 'UDP'), (PROTOCOL_SCTP, 'SCTP'), ) + + +class L2VPNTypeChoices(ChoiceSet): + TYPE_VPLS = 'vpls' + TYPE_VPWS = 'vpws' + TYPE_EPL = 'epl' + TYPE_EVPL = 'evpl' + TYPE_EPLAN = 'ep-lan' + TYPE_EVPLAN = 'evp-lan' + TYPE_EPTREE = 'ep-tree' + TYPE_EVPTREE = 'evp-tree' + TYPE_VXLAN = 'vxlan' + TYPE_VXLAN_EVPN = 'vxlan-evpn' + TYPE_MPLS_EVPN = 'mpls-evpn' + TYPE_PBB_EVPN = 'pbb-evpn' + + CHOICES = ( + ('VPLS', ( + (TYPE_VPWS, 'VPWS'), + (TYPE_VPLS, 'VPLS'), + )), + ('E-Line', ( + (TYPE_EPL, 'EPL'), + (TYPE_EVPL, 'EVPL'), + )), + ('E-LAN', ( + (TYPE_EPLAN, 'Ethernet Private LAN'), + (TYPE_EVPLAN, 'Ethernet Virtual Private LAN'), + )), + ('E-Tree', ( + (TYPE_EPTREE, 'Ethernet Private Tree'), + (TYPE_EVPTREE, 'Ethernet Virtual Private Tree'), + )), + ('VXLAN', ( + (TYPE_VXLAN, 'VXLAN'), + (TYPE_VXLAN_EVPN, 'VXLAN-EVPN'), + )), + ('L2VPN E-VPN', ( + (TYPE_MPLS_EVPN, 'MPLS EVPN'), + (TYPE_PBB_EVPN, 'PBB EVPN'), + )) + + ) + + P2P = ( + TYPE_VPWS, + TYPE_EPL, + TYPE_EPLAN, + TYPE_EPTREE + ) diff --git a/netbox/ipam/constants.py b/netbox/ipam/constants.py index ab88dfc1a..cb121515d 100644 --- a/netbox/ipam/constants.py +++ b/netbox/ipam/constants.py @@ -90,3 +90,9 @@ VLANGROUP_SCOPE_TYPES = ( # 16-bit port number SERVICE_PORT_MIN = 1 SERVICE_PORT_MAX = 65535 + +L2VPN_ASSIGNMENT_MODELS = Q( + Q(app_label='dcim', model='interface') | + Q(app_label='ipam', model='vlan') | + Q(app_label='virtualization', model='vminterface') +) diff --git a/netbox/ipam/filtersets.py b/netbox/ipam/filtersets.py index d9cf6eefc..03189a7cb 100644 --- a/netbox/ipam/filtersets.py +++ b/netbox/ipam/filtersets.py @@ -23,6 +23,8 @@ __all__ = ( 'FHRPGroupFilterSet', 'IPAddressFilterSet', 'IPRangeFilterSet', + 'L2VPNFilterSet', + 'L2VPNTerminationFilterSet', 'PrefixFilterSet', 'RIRFilterSet', 'RoleFilterSet', @@ -922,3 +924,66 @@ class ServiceFilterSet(NetBoxModelFilterSet): return queryset qs_filter = Q(name__icontains=value) | Q(description__icontains=value) return queryset.filter(qs_filter) + + +# +# L2VPN +# + + +class L2VPNFilterSet(NetBoxModelFilterSet, TenancyFilterSet): + import_target_id = django_filters.ModelMultipleChoiceFilter( + field_name='import_targets', + queryset=RouteTarget.objects.all(), + label='Import target', + ) + import_target = django_filters.ModelMultipleChoiceFilter( + field_name='import_targets__name', + queryset=RouteTarget.objects.all(), + to_field_name='name', + label='Import target (name)', + ) + export_target_id = django_filters.ModelMultipleChoiceFilter( + field_name='export_targets', + queryset=RouteTarget.objects.all(), + label='Export target', + ) + export_target = django_filters.ModelMultipleChoiceFilter( + field_name='export_targets__name', + queryset=RouteTarget.objects.all(), + to_field_name='name', + label='Export target (name)', + ) + + class Meta: + model = L2VPN + fields = ['identifier', 'name', 'type', 'description'] + + def search(self, queryset, name, value): + if not value.strip(): + return queryset + qs_filter = Q(identifier=value) | Q(name__icontains=value) | Q(description__icontains=value) + return queryset.filter(qs_filter) + + +class L2VPNTerminationFilterSet(NetBoxModelFilterSet): + l2vpn_id = django_filters.ModelMultipleChoiceFilter( + queryset=L2VPN.objects.all(), + label='L2VPN (ID)', + ) + l2vpn = django_filters.ModelMultipleChoiceFilter( + field_name='l2vpn__name', + queryset=L2VPN.objects.all(), + to_field_name='name', + label='L2VPN (name)', + ) + + class Meta: + model = L2VPNTermination + fields = ['l2vpn'] + + def search(self, queryset, name, value): + if not value.strip(): + return queryset + qs_filter = Q(l2vpn__name__icontains=value) + return queryset.filter(qs_filter) diff --git a/netbox/ipam/forms/bulk_edit.py b/netbox/ipam/forms/bulk_edit.py index 66b4ba0fc..bbfa5bf9f 100644 --- a/netbox/ipam/forms/bulk_edit.py +++ b/netbox/ipam/forms/bulk_edit.py @@ -18,6 +18,7 @@ __all__ = ( 'FHRPGroupBulkEditForm', 'IPAddressBulkEditForm', 'IPRangeBulkEditForm', + 'L2VPNBulkEditForm', 'PrefixBulkEditForm', 'RIRBulkEditForm', 'RoleBulkEditForm', @@ -440,3 +441,20 @@ class ServiceTemplateBulkEditForm(NetBoxModelBulkEditForm): class ServiceBulkEditForm(ServiceTemplateBulkEditForm): model = Service + + +class L2VPNBulkEditForm(NetBoxModelBulkEditForm): + tenant = DynamicModelChoiceField( + queryset=Tenant.objects.all(), + required=False + ) + description = forms.CharField( + max_length=100, + required=False + ) + + model = L2VPN + fieldsets = ( + (None, ('tenant', 'description')), + ) + nullable_fields = ('tenant', 'description',) diff --git a/netbox/ipam/forms/bulk_import.py b/netbox/ipam/forms/bulk_import.py index 17da242a0..5b94f6c8e 100644 --- a/netbox/ipam/forms/bulk_import.py +++ b/netbox/ipam/forms/bulk_import.py @@ -1,5 +1,6 @@ from django import forms from django.contrib.contenttypes.models import ContentType +from django.core.exceptions import ValidationError from dcim.models import Device, Interface, Site from ipam.choices import * @@ -16,6 +17,8 @@ __all__ = ( 'FHRPGroupCSVForm', 'IPAddressCSVForm', 'IPRangeCSVForm', + 'L2VPNCSVForm', + 'L2VPNTerminationCSVForm', 'PrefixCSVForm', 'RIRCSVForm', 'RoleCSVForm', @@ -425,3 +428,74 @@ class ServiceCSVForm(NetBoxModelCSVForm): class Meta: model = Service fields = ('device', 'virtual_machine', 'name', 'protocol', 'ports', 'description') + + +class L2VPNCSVForm(NetBoxModelCSVForm): + tenant = CSVModelChoiceField( + queryset=Tenant.objects.all(), + required=False, + to_field_name='name', + ) + type = CSVChoiceField( + choices=L2VPNTypeChoices, + help_text='IP protocol' + ) + + class Meta: + model = L2VPN + fields = ('identifier', 'name', 'slug', 'type', 'description') + + +class L2VPNTerminationCSVForm(NetBoxModelCSVForm): + l2vpn = CSVModelChoiceField( + queryset=L2VPN.objects.all(), + required=True, + to_field_name='name', + label='L2VPN', + ) + + device = CSVModelChoiceField( + queryset=Device.objects.all(), + required=False, + to_field_name='name', + help_text='Required if assigned to a interface' + ) + + interface = CSVModelChoiceField( + queryset=Interface.objects.all(), + required=False, + to_field_name='name', + help_text='Required if not assigned to a vlan' + ) + + vlan = CSVModelChoiceField( + queryset=VLAN.objects.all(), + required=False, + to_field_name='name', + help_text='Required if not assigned to a interface' + ) + + class Meta: + model = L2VPNTermination + fields = ('l2vpn', 'device', 'interface', 'vlan') + + def __init__(self, data=None, *args, **kwargs): + super().__init__(data, *args, **kwargs) + if data: + # Limit interface queryset by assigned device + if data.get('device'): + self.fields['interface'].queryset = Interface.objects.filter( + **{f"device__{self.fields['device'].to_field_name}": data['device']} + ) + + def clean(self): + super().clean() + + if not (self.cleaned_data.get('interface') or self.cleaned_data.get('vlan')): + raise ValidationError('You must have either a interface or a VLAN') + + if self.cleaned_data.get('interface') and self.cleaned_data.get('vlan'): + raise ValidationError('Cannot assign both a interface and vlan') + + # Set Assigned Object + self.instance.assigned_object = self.cleaned_data.get('interface') or self.cleaned_data.get('vlan') diff --git a/netbox/ipam/forms/filtersets.py b/netbox/ipam/forms/filtersets.py index bbd6bb97b..1cb936ca3 100644 --- a/netbox/ipam/forms/filtersets.py +++ b/netbox/ipam/forms/filtersets.py @@ -19,6 +19,8 @@ __all__ = ( 'FHRPGroupFilterForm', 'IPAddressFilterForm', 'IPRangeFilterForm', + 'L2VPNFilterForm', + 'L2VPNTerminationFilterForm', 'PrefixFilterForm', 'RIRFilterForm', 'RoleFilterForm', @@ -463,3 +465,30 @@ class ServiceTemplateFilterForm(NetBoxModelFilterSetForm): class ServiceFilterForm(ServiceTemplateFilterForm): model = Service + + +class L2VPNFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): + model = L2VPN + fieldsets = ( + (None, ('type', )), + ('Tenant', ('tenant_group_id', 'tenant_id')), + ) + type = forms.ChoiceField( + choices=add_blank_choice(L2VPNTypeChoices), + required=False, + widget=StaticSelect() + ) + + +class L2VPNTerminationFilterForm(NetBoxModelFilterSetForm): + model = L2VPNTermination + fieldsets = ( + (None, ('l2vpn', )), + ) + l2vpn = DynamicModelChoiceField( + queryset=L2VPN.objects.all(), + required=True, + query_params={}, + label='L2VPN', + fetch_trigger='open' + ) diff --git a/netbox/ipam/forms/models.py b/netbox/ipam/forms/models.py index e86abc672..7ef47ed2f 100644 --- a/netbox/ipam/forms/models.py +++ b/netbox/ipam/forms/models.py @@ -1,5 +1,6 @@ from django import forms from django.contrib.contenttypes.models import ContentType +from django.core.exceptions import ValidationError from dcim.models import Device, Interface, Location, Rack, Region, Site, SiteGroup from extras.models import Tag @@ -8,8 +9,10 @@ from ipam.constants import * from ipam.formfields import IPNetworkFormField from ipam.models import * from ipam.models import ASN +from ipam.models.l2vpn import L2VPN, L2VPNTermination from netbox.forms import NetBoxModelForm from tenancy.forms import TenancyForm +from tenancy.models import Tenant from utilities.exceptions import PermissionsViolation from utilities.forms import ( add_blank_choice, BootstrapMixin, ContentTypeChoiceField, DatePicker, DynamicModelChoiceField, @@ -26,6 +29,8 @@ __all__ = ( 'IPAddressBulkAddForm', 'IPAddressForm', 'IPRangeForm', + 'L2VPNForm', + 'L2VPNTerminationForm', 'PrefixForm', 'RIRForm', 'RoleForm', @@ -861,3 +866,94 @@ class ServiceCreateForm(ServiceForm): self.cleaned_data['description'] = service_template.description elif not all(self.cleaned_data[f] for f in ('name', 'protocol', 'ports')): raise forms.ValidationError("Must specify name, protocol, and port(s) if not using a service template.") + + +# +# L2VPN +# + + +class L2VPNForm(TenancyForm, NetBoxModelForm): + slug = SlugField() + import_targets = DynamicModelMultipleChoiceField( + queryset=RouteTarget.objects.all(), + required=False + ) + export_targets = DynamicModelMultipleChoiceField( + queryset=RouteTarget.objects.all(), + required=False + ) + + fieldsets = ( + ('L2VPN', ('name', 'slug', 'type', 'identifier', 'description', 'tags')), + ('Route Targets', ('import_targets', 'export_targets')), + ('Tenancy', ('tenant_group', 'tenant')), + ) + + class Meta: + model = L2VPN + fields = ( + 'name', 'slug', 'type', 'identifier', 'description', 'import_targets', 'export_targets', 'tenant', 'tags' + ) + + +class L2VPNTerminationForm(NetBoxModelForm): + l2vpn = DynamicModelChoiceField( + queryset=L2VPN.objects.all(), + required=True, + query_params={}, + label='L2VPN', + fetch_trigger='open' + ) + + device = DynamicModelChoiceField( + queryset=Device.objects.all(), + required=False, + query_params={} + ) + + vlan = DynamicModelChoiceField( + queryset=VLAN.objects.all(), + required=False, + query_params={ + 'available_on_device': '$device' + } + ) + + interface = DynamicModelChoiceField( + queryset=Interface.objects.all(), + required=False, + query_params={ + 'device_id': '$device' + } + ) + + class Meta: + model = L2VPNTermination + fields = ('l2vpn', ) + + def __init__(self, *args, **kwargs): + instance = kwargs.get('instance') + initial = kwargs.get('initial', {}).copy() + + if instance: + if type(instance.assigned_object) is Interface: + initial['device'] = instance.assigned_object.parent + initial['interface'] = instance.assigned_object + elif type(instance.assigned_object) is VLAN: + initial['vlan'] = instance.assigned_object + kwargs['initial'] = initial + + super().__init__(*args, **kwargs) + + def clean(self): + super().clean() + + if not (self.cleaned_data.get('interface') or self.cleaned_data.get('vlan')): + raise ValidationError('You must have either a interface or a VLAN') + + if self.cleaned_data.get('interface') and self.cleaned_data.get('vlan'): + raise ValidationError('Cannot assign both a interface and vlan') + + obj = self.cleaned_data.get('interface') or self.cleaned_data.get('vlan') + self.instance.assigned_object = obj diff --git a/netbox/ipam/models/__init__.py b/netbox/ipam/models/__init__.py index ce09c482a..d13ee9076 100644 --- a/netbox/ipam/models/__init__.py +++ b/netbox/ipam/models/__init__.py @@ -2,6 +2,7 @@ from .fhrp import * from .vrfs import * from .ip import * +from .l2vpn import * from .services import * from .vlans import * @@ -12,6 +13,8 @@ __all__ = ( 'IPRange', 'FHRPGroup', 'FHRPGroupAssignment', + 'L2VPN', + 'L2VPNTermination', 'Prefix', 'RIR', 'Role', diff --git a/netbox/ipam/models/l2vpn.py b/netbox/ipam/models/l2vpn.py new file mode 100644 index 000000000..b086fa109 --- /dev/null +++ b/netbox/ipam/models/l2vpn.py @@ -0,0 +1,116 @@ +from django.contrib.contenttypes.fields import GenericRelation, GenericForeignKey +from django.contrib.contenttypes.models import ContentType +from django.core.exceptions import ValidationError +from django.db import models +from django.urls import reverse + +from ipam.choices import L2VPNTypeChoices +from ipam.constants import L2VPN_ASSIGNMENT_MODELS +from netbox.models import NetBoxModel + + +class L2VPN(NetBoxModel): + name = models.CharField( + max_length=100, + unique=True + ) + slug = models.SlugField() + type = models.CharField(max_length=50, choices=L2VPNTypeChoices) + identifier = models.BigIntegerField( + null=True, + blank=True, + unique=True + ) + import_targets = models.ManyToManyField( + to='ipam.RouteTarget', + related_name='importing_l2vpns', + blank=True, + ) + export_targets = models.ManyToManyField( + to='ipam.RouteTarget', + related_name='exporting_l2vpns', + blank=True + ) + description = models.TextField(null=True, blank=True) + tenant = models.ForeignKey( + to='tenancy.Tenant', + on_delete=models.SET_NULL, + related_name='l2vpns', + blank=True, + null=True + ) + contacts = GenericRelation( + to='tenancy.ContactAssignment' + ) + + class Meta: + ordering = ('identifier', 'name') + verbose_name = 'L2VPN' + + def __str__(self): + if self.identifier: + return f'{self.name} ({self.identifier})' + return f'{self.name}' + + def get_absolute_url(self): + return reverse('ipam:l2vpn', args=[self.pk]) + + +class L2VPNTermination(NetBoxModel): + l2vpn = models.ForeignKey( + to='ipam.L2VPN', + on_delete=models.CASCADE, + related_name='terminations', + blank=False, + null=False + ) + + assigned_object_type = models.ForeignKey( + to=ContentType, + limit_choices_to=L2VPN_ASSIGNMENT_MODELS, + on_delete=models.PROTECT, + related_name='+', + blank=True, + null=True + ) + assigned_object_id = models.PositiveBigIntegerField( + blank=True, + null=True + ) + assigned_object = GenericForeignKey( + ct_field='assigned_object_type', + fk_field='assigned_object_id' + ) + + class Meta: + ordering = ('l2vpn',) + verbose_name = 'L2VPN Termination' + + constraints = ( + models.UniqueConstraint( + fields=('assigned_object_type', 'assigned_object_id'), + name='ipam_l2vpntermination_assigned_object' + ), + ) + + def __str__(self): + if self.pk is not None: + return f'{self.assigned_object} <> {self.l2vpn}' + return '' + + def get_absolute_url(self): + return reverse('ipam:l2vpntermination', args=[self.pk]) + + def clean(self): + # Only check is assigned_object is set + if self.assigned_object: + obj_id = self.assigned_object.pk + obj_type = ContentType.objects.get_for_model(self.assigned_object) + if L2VPNTermination.objects.filter(assigned_object_id=obj_id, assigned_object_type=obj_type).\ + exclude(pk=self.pk).count() > 0: + raise ValidationError(f'L2VPN Termination already assigned ({self.assigned_object})') + + # Only check if L2VPN is set and is of type P2P + if self.l2vpn and self.l2vpn.type in L2VPNTypeChoices.P2P: + if L2VPNTermination.objects.filter(l2vpn=self.l2vpn).exclude(pk=self.pk).count() >= 2: + raise ValidationError(f'P2P Type L2VPNs can only have 2 terminations; first delete a termination') diff --git a/netbox/ipam/models/vlans.py b/netbox/ipam/models/vlans.py index 7643a2617..3a7969405 100644 --- a/netbox/ipam/models/vlans.py +++ b/netbox/ipam/models/vlans.py @@ -1,4 +1,4 @@ -from django.contrib.contenttypes.fields import GenericForeignKey +from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ValidationError from django.core.validators import MaxValueValidator, MinValueValidator @@ -8,6 +8,7 @@ from django.urls import reverse from dcim.models import Interface from ipam.choices import * from ipam.constants import * +from ipam.models import L2VPNTermination from ipam.querysets import VLANQuerySet from netbox.models import OrganizationalModel, NetBoxModel from virtualization.models import VMInterface @@ -173,6 +174,12 @@ class VLAN(NetBoxModel): blank=True ) + l2vpn = GenericRelation( + to='ipam.L2VPNTermination', + content_type_field='assigned_object_type', + object_id_field='assigned_object_id', + ) + objects = VLANQuerySet.as_manager() clone_fields = [ diff --git a/netbox/ipam/tables/__init__.py b/netbox/ipam/tables/__init__.py index 6f429e27d..3bde78af0 100644 --- a/netbox/ipam/tables/__init__.py +++ b/netbox/ipam/tables/__init__.py @@ -1,5 +1,6 @@ from .fhrp import * from .ip import * +from .l2vpn import * from .services import * from .vlans import * from .vrfs import * diff --git a/netbox/ipam/tables/l2vpn.py b/netbox/ipam/tables/l2vpn.py new file mode 100644 index 000000000..551f692bb --- /dev/null +++ b/netbox/ipam/tables/l2vpn.py @@ -0,0 +1,38 @@ +import django_tables2 as tables + +from ipam.models import * +from ipam.models.l2vpn import L2VPN, L2VPNTermination +from netbox.tables import NetBoxTable, columns + +__all__ = ( + 'L2VPNTable', + 'L2VPNTerminationTable', +) + + +class L2VPNTable(NetBoxTable): + pk = columns.ToggleColumn() + name = tables.Column( + linkify=True + ) + + class Meta(NetBoxTable.Meta): + model = L2VPN + fields = ('pk', 'name', 'description', 'slug', 'type', 'tenant', 'actions') + default_columns = ('pk', 'name', 'description', 'actions') + + +class L2VPNTerminationTable(NetBoxTable): + pk = columns.ToggleColumn() + assigned_object_type = columns.ContentTypeColumn( + verbose_name='Object Type' + ) + assigned_object = tables.Column( + linkify=True, + orderable=False + ) + + class Meta(NetBoxTable.Meta): + model = L2VPNTermination + fields = ('pk', 'l2vpn', 'assigned_object_type', 'assigned_object', 'actions') + default_columns = ('pk', 'l2vpn', 'assigned_object_type', 'assigned_object', 'actions') diff --git a/netbox/ipam/tests/test_api.py b/netbox/ipam/tests/test_api.py index d99de6d20..0e93bd43e 100644 --- a/netbox/ipam/tests/test_api.py +++ b/netbox/ipam/tests/test_api.py @@ -914,3 +914,96 @@ class ServiceTest(APIViewTestCases.APIViewTestCase): 'ports': [6], }, ] + + +class L2VPNTest(APIViewTestCases.APIViewTestCase): + model = L2VPN + brief_fields = ['display', 'id', 'identifier', 'name', 'slug', 'type', 'url'] + create_data = [ + { + 'name': 'L2VPN 4', + 'slug': 'l2vpn-4', + 'type': 'vxlan', + 'identifier': 33343344 + }, + { + 'name': 'L2VPN 5', + 'slug': 'l2vpn-5', + 'type': 'vxlan', + 'identifier': 33343345 + }, + { + 'name': 'L2VPN 6', + 'slug': 'l2vpn-6', + 'type': 'vpws', + 'identifier': 33343346 + }, + ] + bulk_update_data = { + 'description': 'New description', + } + + @classmethod + def setUpTestData(cls): + + l2vpns = ( + L2VPN(name='L2VPN 1', type='vxlan', identifier=650001), + L2VPN(name='L2VPN 2', type='vpws', identifier=650002), + L2VPN(name='L2VPN 3', type='vpls'), # No RD + ) + L2VPN.objects.bulk_create(l2vpns) + + +class L2VPNTerminationTest(APIViewTestCases.APIViewTestCase): + model = L2VPNTermination + brief_fields = ['display', 'id', 'l2vpn', 'assigned_object', 'assigned_object_id', 'assigned_object_type', 'url'] + + @classmethod + def setUpTestData(cls): + + vlans = ( + VLAN(name='VLAN 1', vid=650001), + VLAN(name='VLAN 2', vid=650002), + VLAN(name='VLAN 3', vid=650003), + VLAN(name='VLAN 4', vid=650004), + VLAN(name='VLAN 5', vid=650005), + VLAN(name='VLAN 6', vid=650006), + VLAN(name='VLAN 7', vid=650007) + ) + + VLAN.objects.bulk_create(vlans) + + l2vpns = ( + L2VPN(name='L2VPN 1', type='vxlan', identifier=650001), + L2VPN(name='L2VPN 2', type='vpws', identifier=650002), + L2VPN(name='L2VPN 3', type='vpls'), # No RD + ) + L2VPN.objects.bulk_create(l2vpns) + + l2vpnterminations = ( + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[0]), + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[1]), + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[2]) + ) + + cls.create_data = [ + { + 'l2vpn': l2vpns[0], + 'assigned_object_type': 'ipam.vlan', + 'assigned_object_id': vlans[3], + }, + { + 'l2vpn': l2vpns[0], + 'assigned_object_type': 'ipam.vlan', + 'assigned_object_id': vlans[4], + }, + { + 'l2vpn': l2vpns[0], + 'assigned_object_type': 'ipam.vlan', + 'assigned_object_id': vlans[5], + }, + ] + + cls.bulk_update_data = { + 'l2vpn': l2vpns[2] + } diff --git a/netbox/ipam/tests/test_filtersets.py b/netbox/ipam/tests/test_filtersets.py index d98fe889e..c5cffc7dc 100644 --- a/netbox/ipam/tests/test_filtersets.py +++ b/netbox/ipam/tests/test_filtersets.py @@ -1463,3 +1463,104 @@ class ServiceTestCase(TestCase, ChangeLoggedFilterSetTests): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) params = {'virtual_machine': [vms[0].name, vms[1].name]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + +class L2VPNTest(TestCase, ChangeLoggedFilterSetTests): + # TODO: L2VPN Tests + queryset = L2VPN.objects.all() + filterset = L2VPNFilterSet + + @classmethod + def setUpTestData(cls): + + l2vpns = ( + L2VPN(name='L2VPN 1', type='vxlan', identifier=650001), + L2VPN(name='L2VPN 2', type='vpws', identifier=650002), + L2VPN(name='L2VPN 3', type='vpls'), # No RD + ) + L2VPN.objects.bulk_create(l2vpns) + + def test_created(self): + from datetime import date, date + pk_list = self.queryset.values_list('pk', flat=True)[:2] + print(pk_list) + self.queryset.filter(pk__in=pk_list).update(created=datetime(2021, 1, 1, 0, 0, 0, tzinfo=timezone.utc)) + params = {'created': '2021-01-01T00:00:00'} + fs = self.filterset({}, self.queryset).qs.all() + for res in fs: + print(f'{res.name}:{res.created}') + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + +class L2VPNTerminationTest(TestCase, ChangeLoggedFilterSetTests): + # TODO: L2VPN Termination Tests + queryset = L2VPNTermination.objects.all() + filterset = L2VPNTerminationFilterSet + + @classmethod + def setUpTestData(cls): + + site = Site.objects.create(name='Site 1') + manufacturer = Manufacturer.objects.create(name='Manufacturer 1') + device_type = DeviceType.objects.create(model='Device Type 1', manufacturer=manufacturer) + device_role = DeviceRole.objects.create(name='Switch') + device = Device.objects.create( + name='Device 1', + site=site, + device_type=device_type, + device_role=device_role, + status='active' + ) + interfaces = Interface.objects.bulk_create( + Interface(name='GigabitEthernet1/0/1', device=device, type='1000baset'), + Interface(name='GigabitEthernet1/0/2', device=device, type='1000baset'), + Interface(name='GigabitEthernet1/0/3', device=device, type='1000baset'), + Interface(name='GigabitEthernet1/0/4', device=device, type='1000baset'), + Interface(name='GigabitEthernet1/0/5', device=device, type='1000baset'), + ) + + vlans = ( + VLAN(name='VLAN 1', vid=650001), + VLAN(name='VLAN 2', vid=650002), + VLAN(name='VLAN 3', vid=650003), + VLAN(name='VLAN 4', vid=650004), + VLAN(name='VLAN 5', vid=650005), + VLAN(name='VLAN 6', vid=650006), + VLAN(name='VLAN 7', vid=650007) + ) + + VLAN.objects.bulk_create(vlans) + + l2vpns = ( + L2VPN(name='L2VPN 1', type='vxlan', identifier=650001), + L2VPN(name='L2VPN 2', type='vpws', identifier=650002), + L2VPN(name='L2VPN 3', type='vpls'), # No RD + ) + L2VPN.objects.bulk_create(l2vpns) + + l2vpnterminations = ( + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[0]), + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[1]), + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[2]) + ) + + def test_l2vpns(self): + l2vpns = L2VPN.objects.all()[:2] + params = {'l2vpn_id': [l2vpns[0].pk, l2vpns[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'l2vpn': ['L2VPN 1', 'L2VPN 2']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_interfaces(self): + interfaces = Interface.objects.all()[:2] + params = {'interface_id': [interfaces[0].pk, interfaces[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'interface': ['Interface 1', 'Interface 2']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_vlans(self): + vlans = VLAN.objects.all()[:2] + params = {'vlan_id': [vlans[0].pk, vlans[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'vlan': ['VLAN 1', 'VLAN 2']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) diff --git a/netbox/ipam/tests/test_models.py b/netbox/ipam/tests/test_models.py index 09bc95799..ce4643516 100644 --- a/netbox/ipam/tests/test_models.py +++ b/netbox/ipam/tests/test_models.py @@ -538,3 +538,13 @@ class TestVLANGroup(TestCase): VLAN.objects.create(name='VLAN 104', vid=104, group=vlangroup) self.assertEqual(vlangroup.get_next_available_vid(), 105) + + +class TestL2VPN(TestCase): + # TODO: L2VPN Tests + pass + + +class TestL2VPNTermination(TestCase): + # TODO: L2VPN Termination Tests + pass diff --git a/netbox/ipam/tests/test_views.py b/netbox/ipam/tests/test_views.py index 672cfbe08..8d1b9bd1b 100644 --- a/netbox/ipam/tests/test_views.py +++ b/netbox/ipam/tests/test_views.py @@ -746,3 +746,13 @@ class ServiceTestCase(ViewTestCases.PrimaryObjectViewTestCase): self.assertEqual(instance.protocol, service_template.protocol) self.assertEqual(instance.ports, service_template.ports) self.assertEqual(instance.description, service_template.description) + + +class L2VPNTestCase(ViewTestCases.PrimaryObjectViewTestCase): + # TODO: L2VPN Tests + pass + + +class L2VPNTerminationTestCase(ViewTestCases.PrimaryObjectViewTestCase): + # TODO: L2VPN Termination Tests + pass diff --git a/netbox/ipam/urls.py b/netbox/ipam/urls.py index 3c7ed2d1f..65a6b55ad 100644 --- a/netbox/ipam/urls.py +++ b/netbox/ipam/urls.py @@ -186,4 +186,25 @@ urlpatterns = [ path('services//changelog/', ObjectChangeLogView.as_view(), name='service_changelog', kwargs={'model': Service}), path('services//journal/', ObjectJournalView.as_view(), name='service_journal', kwargs={'model': Service}), + # L2VPN + path('l2vpn/', views.L2VPNListView.as_view(), name='l2vpn_list'), + path('l2vpn/add/', views.L2VPNEditView.as_view(), name='l2vpn_add'), + path('l2vpn/import/', views.L2VPNBulkImportView.as_view(), name='l2vpn_import'), + path('l2vpn/edit/', views.L2VPNBulkEditView.as_view(), name='l2vpn_bulk_edit'), + path('l2vpn/delete/', views.L2VPNBulkDeleteView.as_view(), name='l2vpn_bulk_delete'), + path('l2vpn//', views.L2VPNView.as_view(), name='l2vpn'), + path('l2vpn//edit/', views.L2VPNEditView.as_view(), name='l2vpn_edit'), + path('l2vpn//delete/', views.L2VPNDeleteView.as_view(), name='l2vpn_delete'), + path('l2vpn//changelog/', ObjectChangeLogView.as_view(), name='l2vpn_changelog', kwargs={'model': L2VPN}), + path('l2vpn//journal/', ObjectJournalView.as_view(), name='l2vpn_journal', kwargs={'model': L2VPN}), + + path('l2vpn-termination/', views.L2VPNTerminationListView.as_view(), name='l2vpntermination_list'), + path('l2vpn-termination/add/', views.L2VPNTerminationEditView.as_view(), name='l2vpntermination_add'), + path('l2vpn-termination/import/', views.L2VPNTerminationBulkImportView.as_view(), name='l2vpntermination_import'), + path('l2vpn-termination/delete/', views.L2VPNTerminationBulkDeleteView.as_view(), name='l2vpntermination_bulk_delete'), + path('l2vpn-termination//', views.L2VPNTerminationView.as_view(), name='l2vpntermination'), + path('l2vpn-termination//edit/', views.L2VPNTerminationEditView.as_view(), name='l2vpntermination_edit'), + path('l2vpn-termination//delete/', views.L2VPNTerminationDeleteView.as_view(), name='l2vpntermination_delete'), + path('l2vpn-termination//changelog/', ObjectChangeLogView.as_view(), name='l2vpntermination_changelog', kwargs={'model': L2VPNTermination}), + path('l2vpn-termination//journal/', ObjectJournalView.as_view(), name='l2vpntermination_journal', kwargs={'model': L2VPNTermination}), ] diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 6682fc920..77539434c 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -17,6 +17,7 @@ from . import filtersets, forms, tables from .constants import * from .models import * from .models import ASN +from .tables.l2vpn import L2VPNTable, L2VPNTerminationTable from .utils import add_requested_prefixes, add_available_ipaddresses, add_available_vlans @@ -1140,6 +1141,101 @@ class ServiceBulkEditView(generic.BulkEditView): queryset = Service.objects.prefetch_related('device', 'virtual_machine') filterset = filtersets.ServiceFilterSet table = tables.ServiceTable + + +# L2VPN + + +class L2VPNListView(generic.ObjectListView): + queryset = L2VPN.objects.all() + table = L2VPNTable + filterset = filtersets.L2VPNFilterSet + filterset_form = forms.L2VPNFilterForm + + +class L2VPNView(generic.ObjectView): + queryset = L2VPN.objects.all() + + def get_extra_context(self, request, instance): + terminations = L2VPNTermination.objects.restrict(request.user, 'view').filter(l2vpn=instance) + terminations_table = tables.L2VPNTerminationTable(terminations, user=request.user, exclude=('l2vpn', )) + terminations_table.configure(request) + + import_targets_table = tables.RouteTargetTable( + instance.import_targets.prefetch_related('tenant'), + orderable=False + ) + export_targets_table = tables.RouteTargetTable( + instance.export_targets.prefetch_related('tenant'), + orderable=False + ) + + return { + 'terminations_table': terminations_table, + 'import_targets_table': import_targets_table, + 'export_targets_table': export_targets_table, + } + + +class L2VPNEditView(generic.ObjectEditView): + queryset = L2VPN.objects.all() + form = forms.L2VPNForm + + +class L2VPNDeleteView(generic.ObjectDeleteView): + queryset = L2VPN.objects.all() + + +class L2VPNBulkImportView(generic.BulkImportView): + queryset = L2VPN.objects.all() + model_form = forms.L2VPNCSVForm + table = tables.L2VPNTable + + +class L2VPNBulkEditView(generic.BulkEditView): + queryset = L2VPN.objects.all() + filterset = filtersets.L2VPNFilterSet + table = tables.L2VPNTable + form = forms.L2VPNBulkEditForm + + +class L2VPNBulkDeleteView(generic.BulkDeleteView): + queryset = L2VPN.objects.all() + filterset = filtersets.L2VPNFilterSet + table = tables.L2VPNTable + + +class L2VPNTerminationListView(generic.ObjectListView): + queryset = L2VPNTermination.objects.all() + table = L2VPNTerminationTable + filterset = filtersets.L2VPNTerminationFilterSet + filterset_form = forms.L2VPNTerminationFilterForm + + +class L2VPNTerminationView(generic.ObjectView): + queryset = L2VPNTermination.objects.all() + + +class L2VPNTerminationEditView(generic.ObjectEditView): + queryset = L2VPNTermination.objects.all() + form = forms.L2VPNTerminationForm + template_name = 'ipam/l2vpntermination_edit.html' + + +class L2VPNTerminationDeleteView(generic.ObjectDeleteView): + queryset = L2VPNTermination.objects.all() + + +class L2VPNTerminationBulkImportView(generic.BulkImportView): + queryset = L2VPNTermination.objects.all() + model_form = forms.L2VPNTerminationCSVForm + table = tables.L2VPNTerminationTable + + +class L2VPNTerminationBulkDeleteView(generic.BulkDeleteView): + queryset = L2VPNTermination.objects.all() + filterset = filtersets.L2VPNTerminationFilterSet + table = tables.L2VPNTerminationTable form = forms.ServiceBulkEditForm diff --git a/netbox/netbox/navigation_menu.py b/netbox/netbox/navigation_menu.py index 9a55c263e..f2245f68b 100644 --- a/netbox/netbox/navigation_menu.py +++ b/netbox/netbox/navigation_menu.py @@ -260,6 +260,13 @@ IPAM_MENU = Menu( get_model_item('ipam', 'vlangroup', 'VLAN Groups'), ), ), + MenuGroup( + label='L2VPNs', + items=( + get_model_item('ipam', 'l2vpn', 'L2VPN'), + get_model_item('ipam', 'l2vpntermination', 'Terminations'), + ), + ), MenuGroup( label='Other', items=( diff --git a/netbox/templates/ipam/l2vpn.html b/netbox/templates/ipam/l2vpn.html new file mode 100644 index 000000000..59cc6234b --- /dev/null +++ b/netbox/templates/ipam/l2vpn.html @@ -0,0 +1,111 @@ +{% extends 'generic/object.html' %} +{% load helpers %} +{% load plugins %} +{% load render_table from django_tables2 %} + +{% block content %} +
      +
      +
      +
      + L2VPN Attributes +
      +
      +
      Site + {{ object.site|linkify|placeholder }} +
      Cluster {% if object.cluster.group %} {{ object.cluster.group|linkify }} / {% endif %} - {{ object.cluster|linkify }} + {{ object.cluster|linkify|placeholder }}
      {{ device.serial|placeholder }}
      {{ message|markdown }} {% if field.to_field_name %} {{ field.to_field_name }} {% else %} - — + {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/inc/panels/custom_fields.html b/netbox/templates/inc/panels/custom_fields.html index 32e586d3a..6d23c81aa 100644 --- a/netbox/templates/inc/panels/custom_fields.html +++ b/netbox/templates/inc/panels/custom_fields.html @@ -37,7 +37,7 @@ {% elif field.required %} Not defined {% else %} - — + {{ ''|placeholder }} {% endif %}
      Power Port{{ object.power_port }}{{ object.power_port|linkify|placeholder }}
      Feed LegDescription {{ object.description|placeholder }}
      PoE Mode{{ object.get_poe_mode_display|placeholder }}
      PoE Mode{{ object.get_poe_type_display|placeholder }}
      802.1Q Mode {{ object.get_mode_display|placeholder }}Parent {{ object.parent|linkify|placeholder }}
      Status{% badge object.get_status_display bg_color=object.get_status_color %}
      Tenant From 341615668baeee010c0ca8c3faf735cad7068f4a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 22 Jun 2022 15:09:50 -0400 Subject: [PATCH 152/593] Closes #7120: Add termination_date field to Circuit --- docs/models/circuits/circuit.md | 2 +- docs/release-notes/version-3.3.md | 3 +++ netbox/circuits/api/serializers.py | 6 +++--- netbox/circuits/filtersets.py | 2 +- netbox/circuits/forms/bulk_edit.py | 14 ++++++++++++-- netbox/circuits/forms/bulk_import.py | 3 ++- netbox/circuits/forms/filtersets.py | 12 ++++++++++-- netbox/circuits/forms/models.py | 8 +++++--- .../0036_circuit_termination_date.py | 18 ++++++++++++++++++ netbox/circuits/models/circuits.py | 9 +++++++-- netbox/circuits/tables/circuits.py | 2 +- netbox/circuits/tests/test_filtersets.py | 16 ++++++++++------ netbox/circuits/tests/test_views.py | 1 + netbox/templates/circuits/circuit.html | 4 ++++ 14 files changed, 78 insertions(+), 22 deletions(-) create mode 100644 netbox/circuits/migrations/0036_circuit_termination_date.py diff --git a/docs/models/circuits/circuit.md b/docs/models/circuits/circuit.md index 9421f94fb..3aaa4e99f 100644 --- a/docs/models/circuits/circuit.md +++ b/docs/models/circuits/circuit.md @@ -13,7 +13,7 @@ Each circuit is also assigned one of the following operational statuses: * Deprovisioning * Decommissioned -Circuits also have optional fields for annotating their installation date and commit rate, and may be assigned to NetBox tenants. +Circuits also have optional fields for annotating their installation and termination dates and commit rate, and may be assigned to NetBox tenants. !!! note NetBox currently models only physical circuits: those which have exactly two endpoints. It is common to layer virtualized constructs (_virtual circuits_) such as MPLS or EVPN tunnels on top of these, however NetBox does not yet support virtual circuit modeling. diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 6b825bd45..66cfd2e66 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -18,6 +18,7 @@ * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses * [#4350](https://github.com/netbox-community/netbox/issues/4350) - Illustrate reservations vertically alongside rack elevations * [#5303](https://github.com/netbox-community/netbox/issues/5303) - A virtual machine may be assigned to a site and/or cluster +* [#7120](https://github.com/netbox-community/netbox/issues/7120) - Add `termination_date` field to Circuit * [#7744](https://github.com/netbox-community/netbox/issues/7744) - Add `status` field to Location * [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster @@ -32,6 +33,8 @@ ### REST API Changes +* circuits.Circuit + * Added optional `termination_date` field * dcim.Device * The `position` field has been changed from an integer to a decimal * dcim.DeviceType diff --git a/netbox/circuits/api/serializers.py b/netbox/circuits/api/serializers.py index 19570f067..2bb3cd266 100644 --- a/netbox/circuits/api/serializers.py +++ b/netbox/circuits/api/serializers.py @@ -92,9 +92,9 @@ class CircuitSerializer(NetBoxModelSerializer): class Meta: model = Circuit fields = [ - 'id', 'url', 'display', 'cid', 'provider', 'type', 'status', 'tenant', 'install_date', 'commit_rate', - 'description', 'termination_a', 'termination_z', 'comments', 'tags', 'custom_fields', 'created', - 'last_updated', + 'id', 'url', 'display', 'cid', 'provider', 'type', 'status', 'tenant', 'install_date', 'termination_date', + 'commit_rate', 'description', 'termination_a', 'termination_z', 'comments', 'tags', 'custom_fields', + 'created', 'last_updated', ] diff --git a/netbox/circuits/filtersets.py b/netbox/circuits/filtersets.py index b7fa100a8..67a0d1b02 100644 --- a/netbox/circuits/filtersets.py +++ b/netbox/circuits/filtersets.py @@ -183,7 +183,7 @@ class CircuitFilterSet(NetBoxModelFilterSet, TenancyFilterSet, ContactModelFilte class Meta: model = Circuit - fields = ['id', 'cid', 'description', 'install_date', 'commit_rate'] + fields = ['id', 'cid', 'description', 'install_date', 'termination_date', 'commit_rate'] def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/circuits/forms/bulk_edit.py b/netbox/circuits/forms/bulk_edit.py index 6e283219a..b6ba42afb 100644 --- a/netbox/circuits/forms/bulk_edit.py +++ b/netbox/circuits/forms/bulk_edit.py @@ -7,7 +7,7 @@ from ipam.models import ASN from netbox.forms import NetBoxModelBulkEditForm from tenancy.models import Tenant from utilities.forms import ( - add_blank_choice, CommentField, DynamicModelChoiceField, DynamicModelMultipleChoiceField, SmallTextarea, + add_blank_choice, CommentField, DatePicker, DynamicModelChoiceField, DynamicModelMultipleChoiceField, SmallTextarea, StaticSelect, ) @@ -122,6 +122,14 @@ class CircuitBulkEditForm(NetBoxModelBulkEditForm): queryset=Tenant.objects.all(), required=False ) + install_date = forms.DateField( + required=False, + widget=DatePicker() + ) + termination_date = forms.DateField( + required=False, + widget=DatePicker() + ) commit_rate = forms.IntegerField( required=False, label='Commit rate (Kbps)' @@ -137,7 +145,9 @@ class CircuitBulkEditForm(NetBoxModelBulkEditForm): model = Circuit fieldsets = ( - (None, ('type', 'provider', 'status', 'tenant', 'commit_rate', 'description')), + ('Circuit', ('provider', 'type', 'status', 'description')), + ('Service Parameters', ('install_date', 'termination_date', 'commit_rate')), + ('Tenancy', ('tenant',)), ) nullable_fields = ( 'tenant', 'commit_rate', 'description', 'comments', diff --git a/netbox/circuits/forms/bulk_import.py b/netbox/circuits/forms/bulk_import.py index 6da79f75c..cc2d0409a 100644 --- a/netbox/circuits/forms/bulk_import.py +++ b/netbox/circuits/forms/bulk_import.py @@ -72,5 +72,6 @@ class CircuitCSVForm(NetBoxModelCSVForm): class Meta: model = Circuit fields = [ - 'cid', 'provider', 'type', 'status', 'tenant', 'install_date', 'commit_rate', 'description', 'comments', + 'cid', 'provider', 'type', 'status', 'tenant', 'install_date', 'termination_date', 'commit_rate', + 'description', 'comments', ] diff --git a/netbox/circuits/forms/filtersets.py b/netbox/circuits/forms/filtersets.py index 46d3824bb..29410ffdf 100644 --- a/netbox/circuits/forms/filtersets.py +++ b/netbox/circuits/forms/filtersets.py @@ -7,7 +7,7 @@ from dcim.models import Region, Site, SiteGroup from ipam.models import ASN from netbox.forms import NetBoxModelFilterSetForm from tenancy.forms import TenancyFilterForm, ContactModelFilterForm -from utilities.forms import DynamicModelMultipleChoiceField, MultipleChoiceField, TagFilterField +from utilities.forms import DatePicker, DynamicModelMultipleChoiceField, MultipleChoiceField, TagFilterField __all__ = ( 'CircuitFilterForm', @@ -84,7 +84,7 @@ class CircuitFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelFi fieldsets = ( (None, ('q', 'tag')), ('Provider', ('provider_id', 'provider_network_id')), - ('Attributes', ('type_id', 'status', 'commit_rate')), + ('Attributes', ('type_id', 'status', 'install_date', 'termination_date', 'commit_rate')), ('Location', ('region_id', 'site_group_id', 'site_id')), ('Tenant', ('tenant_group_id', 'tenant_id')), ('Contacts', ('contact', 'contact_role', 'contact_group')), @@ -130,6 +130,14 @@ class CircuitFilterForm(TenancyFilterForm, ContactModelFilterForm, NetBoxModelFi }, label=_('Site') ) + install_date = forms.DateField( + required=False, + widget=DatePicker + ) + termination_date = forms.DateField( + required=False, + widget=DatePicker + ) commit_rate = forms.IntegerField( required=False, min_value=0, diff --git a/netbox/circuits/forms/models.py b/netbox/circuits/forms/models.py index 8fd5fb92d..907c39586 100644 --- a/netbox/circuits/forms/models.py +++ b/netbox/circuits/forms/models.py @@ -93,15 +93,16 @@ class CircuitForm(TenancyForm, NetBoxModelForm): comments = CommentField() fieldsets = ( - ('Circuit', ('provider', 'cid', 'type', 'status', 'install_date', 'commit_rate', 'description', 'tags')), + ('Circuit', ('provider', 'cid', 'type', 'status', 'description', 'tags')), + ('Service Parameters', ('install_date', 'termination_date', 'commit_rate')), ('Tenancy', ('tenant_group', 'tenant')), ) class Meta: model = Circuit fields = [ - 'cid', 'type', 'provider', 'status', 'install_date', 'commit_rate', 'description', 'tenant_group', 'tenant', - 'comments', 'tags', + 'cid', 'type', 'provider', 'status', 'install_date', 'termination_date', 'commit_rate', 'description', + 'tenant_group', 'tenant', 'comments', 'tags', ] help_texts = { 'cid': "Unique circuit ID", @@ -110,6 +111,7 @@ class CircuitForm(TenancyForm, NetBoxModelForm): widgets = { 'status': StaticSelect(), 'install_date': DatePicker(), + 'termination_date': DatePicker(), 'commit_rate': SelectSpeedWidget(), } diff --git a/netbox/circuits/migrations/0036_circuit_termination_date.py b/netbox/circuits/migrations/0036_circuit_termination_date.py new file mode 100644 index 000000000..0a8adfbe6 --- /dev/null +++ b/netbox/circuits/migrations/0036_circuit_termination_date.py @@ -0,0 +1,18 @@ +# Generated by Django 4.0.5 on 2022-06-22 18:51 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('circuits', '0035_provider_asns'), + ] + + operations = [ + migrations.AddField( + model_name='circuit', + name='termination_date', + field=models.DateField(blank=True, null=True), + ), + ] diff --git a/netbox/circuits/models/circuits.py b/netbox/circuits/models/circuits.py index 02ba5209d..5df6f1b85 100644 --- a/netbox/circuits/models/circuits.py +++ b/netbox/circuits/models/circuits.py @@ -78,7 +78,12 @@ class Circuit(NetBoxModel): install_date = models.DateField( blank=True, null=True, - verbose_name='Date installed' + verbose_name='Installed' + ) + termination_date = models.DateField( + blank=True, + null=True, + verbose_name='Terminates' ) commit_rate = models.PositiveIntegerField( blank=True, @@ -119,7 +124,7 @@ class Circuit(NetBoxModel): ) clone_fields = [ - 'provider', 'type', 'status', 'tenant', 'install_date', 'commit_rate', 'description', + 'provider', 'type', 'status', 'tenant', 'install_date', 'termination_date', 'commit_rate', 'description', ] class Meta: diff --git a/netbox/circuits/tables/circuits.py b/netbox/circuits/tables/circuits.py index 40f8918ae..8b59700ee 100644 --- a/netbox/circuits/tables/circuits.py +++ b/netbox/circuits/tables/circuits.py @@ -70,7 +70,7 @@ class CircuitTable(NetBoxTable): model = Circuit fields = ( 'pk', 'id', 'cid', 'provider', 'type', 'status', 'tenant', 'termination_a', 'termination_z', 'install_date', - 'commit_rate', 'description', 'comments', 'contacts', 'tags', 'created', 'last_updated', + 'termination_date', 'commit_rate', 'description', 'comments', 'contacts', 'tags', 'created', 'last_updated', ) default_columns = ( 'pk', 'cid', 'provider', 'type', 'status', 'tenant', 'termination_a', 'termination_z', 'description', diff --git a/netbox/circuits/tests/test_filtersets.py b/netbox/circuits/tests/test_filtersets.py index 205236712..28e0a3fe3 100644 --- a/netbox/circuits/tests/test_filtersets.py +++ b/netbox/circuits/tests/test_filtersets.py @@ -208,12 +208,12 @@ class CircuitTestCase(TestCase, ChangeLoggedFilterSetTests): ProviderNetwork.objects.bulk_create(provider_networks) circuits = ( - Circuit(provider=providers[0], tenant=tenants[0], type=circuit_types[0], cid='Test Circuit 1', install_date='2020-01-01', commit_rate=1000, status=CircuitStatusChoices.STATUS_ACTIVE, description='foobar1'), - Circuit(provider=providers[0], tenant=tenants[0], type=circuit_types[0], cid='Test Circuit 2', install_date='2020-01-02', commit_rate=2000, status=CircuitStatusChoices.STATUS_ACTIVE, description='foobar2'), - Circuit(provider=providers[0], tenant=tenants[1], type=circuit_types[0], cid='Test Circuit 3', install_date='2020-01-03', commit_rate=3000, status=CircuitStatusChoices.STATUS_PLANNED), - Circuit(provider=providers[1], tenant=tenants[1], type=circuit_types[1], cid='Test Circuit 4', install_date='2020-01-04', commit_rate=4000, status=CircuitStatusChoices.STATUS_PLANNED), - Circuit(provider=providers[1], tenant=tenants[2], type=circuit_types[1], cid='Test Circuit 5', install_date='2020-01-05', commit_rate=5000, status=CircuitStatusChoices.STATUS_OFFLINE), - Circuit(provider=providers[1], tenant=tenants[2], type=circuit_types[1], cid='Test Circuit 6', install_date='2020-01-06', commit_rate=6000, status=CircuitStatusChoices.STATUS_OFFLINE), + Circuit(provider=providers[0], tenant=tenants[0], type=circuit_types[0], cid='Test Circuit 1', install_date='2020-01-01', termination_date='2021-01-01', commit_rate=1000, status=CircuitStatusChoices.STATUS_ACTIVE, description='foobar1'), + Circuit(provider=providers[0], tenant=tenants[0], type=circuit_types[0], cid='Test Circuit 2', install_date='2020-01-02', termination_date='2021-01-02', commit_rate=2000, status=CircuitStatusChoices.STATUS_ACTIVE, description='foobar2'), + Circuit(provider=providers[0], tenant=tenants[1], type=circuit_types[0], cid='Test Circuit 3', install_date='2020-01-03', termination_date='2021-01-03', commit_rate=3000, status=CircuitStatusChoices.STATUS_PLANNED), + Circuit(provider=providers[1], tenant=tenants[1], type=circuit_types[1], cid='Test Circuit 4', install_date='2020-01-04', termination_date='2021-01-04', commit_rate=4000, status=CircuitStatusChoices.STATUS_PLANNED), + Circuit(provider=providers[1], tenant=tenants[2], type=circuit_types[1], cid='Test Circuit 5', install_date='2020-01-05', termination_date='2021-01-05', commit_rate=5000, status=CircuitStatusChoices.STATUS_OFFLINE), + Circuit(provider=providers[1], tenant=tenants[2], type=circuit_types[1], cid='Test Circuit 6', install_date='2020-01-06', termination_date='2021-01-06', commit_rate=6000, status=CircuitStatusChoices.STATUS_OFFLINE), ) Circuit.objects.bulk_create(circuits) @@ -235,6 +235,10 @@ class CircuitTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'install_date': ['2020-01-01', '2020-01-02']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_termination_date(self): + params = {'termination_date': ['2021-01-01', '2021-01-02']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_commit_rate(self): params = {'commit_rate': ['1000', '2000']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) diff --git a/netbox/circuits/tests/test_views.py b/netbox/circuits/tests/test_views.py index 17c846c86..f60275ff3 100644 --- a/netbox/circuits/tests/test_views.py +++ b/netbox/circuits/tests/test_views.py @@ -130,6 +130,7 @@ class CircuitTestCase(ViewTestCases.PrimaryObjectViewTestCase): 'status': CircuitStatusChoices.STATUS_DECOMMISSIONED, 'tenant': None, 'install_date': datetime.date(2020, 1, 1), + 'termination_date': datetime.date(2021, 1, 1), 'commit_rate': 1000, 'description': 'A new circuit', 'comments': 'Some comments', diff --git a/netbox/templates/circuits/circuit.html b/netbox/templates/circuits/circuit.html index 881b6cca6..a4c41f871 100644 --- a/netbox/templates/circuits/circuit.html +++ b/netbox/templates/circuits/circuit.html @@ -45,6 +45,10 @@ Install Date {{ object.install_date|annotated_date|placeholder }}
      Termination Date{{ object.termination_date|annotated_date|placeholder }}
      Commit Rate {{ object.commit_rate|humanize_speed|placeholder }} {% if object.rack %} {{ object.rack }} +
      + + + +
      {% else %} {{ ''|placeholder }} {% endif %} diff --git a/netbox/templates/dcim/inc/rack_elevation.html b/netbox/templates/dcim/inc/rack_elevation.html index 27372193d..d2c4e4e08 100644 --- a/netbox/templates/dcim/inc/rack_elevation.html +++ b/netbox/templates/dcim/inc/rack_elevation.html @@ -1,8 +1,8 @@
      - +
      - + Download SVG
      diff --git a/netbox/templates/dcim/rack.html b/netbox/templates/dcim/rack.html index 42f6a8e99..51e873ffa 100644 --- a/netbox/templates/dcim/rack.html +++ b/netbox/templates/dcim/rack.html @@ -250,13 +250,13 @@

      Front

      - {% include 'dcim/inc/rack_elevation.html' with face='front' %} + {% include 'dcim/inc/rack_elevation.html' with face='front' extra_params=svg_extra %}

      Rear

      - {% include 'dcim/inc/rack_elevation.html' with face='rear' %} + {% include 'dcim/inc/rack_elevation.html' with face='rear' extra_params=svg_extra %}
      From 2077378ae174013f43cfca75bf4fc082bbfd3ed1 Mon Sep 17 00:00:00 2001 From: Hunter Johnston Date: Sat, 25 Jun 2022 15:41:31 -0400 Subject: [PATCH 171/593] Closes #9540: Filter IP addresses by assigned Device/VM --- netbox/ipam/forms/filtersets.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/netbox/ipam/forms/filtersets.py b/netbox/ipam/forms/filtersets.py index bbd6bb97b..3d67d4d37 100644 --- a/netbox/ipam/forms/filtersets.py +++ b/netbox/ipam/forms/filtersets.py @@ -1,7 +1,8 @@ from django import forms from django.utils.translation import gettext as _ -from dcim.models import Location, Rack, Region, Site, SiteGroup +from dcim.models import Location, Rack, Region, Site, SiteGroup, Device +from virtualization.models import VirtualMachine from ipam.choices import * from ipam.constants import * from ipam.models import * @@ -265,6 +266,7 @@ class IPAddressFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): ('Attributes', ('parent', 'family', 'status', 'role', 'mask_length', 'assigned_to_interface')), ('VRF', ('vrf_id', 'present_in_vrf_id')), ('Tenant', ('tenant_group_id', 'tenant_id')), + ('Device/VM', ('device_id', 'virtual_machine_id')), ) parent = forms.CharField( required=False, @@ -298,6 +300,16 @@ class IPAddressFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): required=False, label=_('Present in VRF') ) + device_id = DynamicModelMultipleChoiceField( + queryset=Device.objects.all(), + required=False, + label=_('Assigned Device'), + ) + virtual_machine_id = DynamicModelMultipleChoiceField( + queryset=VirtualMachine.objects.all(), + required=False, + label=_('Assigned VM'), + ) status = MultipleChoiceField( choices=IPAddressStatusChoices, required=False From 7dd5f9e720cc06a06462952a0c619b86c49478af Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 27 Jun 2022 11:30:52 -0400 Subject: [PATCH 172/593] Closes #9177: Add tenant assignment for wireless LANs & links --- docs/models/wireless/wirelesslan.md | 2 +- docs/models/wireless/wirelesslink.md | 2 +- docs/release-notes/version-3.3.md | 5 ++ netbox/templates/tenancy/tenant.html | 12 +++- netbox/templates/wireless/wirelesslan.html | 67 +++++++++++-------- netbox/templates/wireless/wirelesslink.html | 9 +++ netbox/tenancy/views.py | 3 + netbox/wireless/api/serializers.py | 9 ++- netbox/wireless/api/views.py | 4 +- netbox/wireless/filtersets.py | 5 +- netbox/wireless/forms/bulk_edit.py | 17 +++-- netbox/wireless/forms/bulk_import.py | 19 +++++- netbox/wireless/forms/filtersets.py | 12 +++- netbox/wireless/forms/models.py | 13 ++-- .../migrations/0004_wireless_tenancy.py | 25 +++++++ netbox/wireless/models.py | 14 ++++ netbox/wireless/tables/wirelesslan.py | 6 +- netbox/wireless/tables/wirelesslink.py | 4 +- netbox/wireless/tests/test_api.py | 30 +++++++-- netbox/wireless/tests/test_filtersets.py | 44 +++++++++--- netbox/wireless/tests/test_views.py | 46 +++++++++---- 21 files changed, 265 insertions(+), 83 deletions(-) create mode 100644 netbox/wireless/migrations/0004_wireless_tenancy.py diff --git a/docs/models/wireless/wirelesslan.md b/docs/models/wireless/wirelesslan.md index 80a3a40b0..cb478664c 100644 --- a/docs/models/wireless/wirelesslan.md +++ b/docs/models/wireless/wirelesslan.md @@ -1,6 +1,6 @@ # Wireless LANs -A wireless LAN is a set of interfaces connected via a common wireless channel. Each instance must have an SSID, and may optionally be correlated to a VLAN. Wireless LANs can be arranged into hierarchical groups. +A wireless LAN is a set of interfaces connected via a common wireless channel. Each instance must have an SSID, and may optionally be correlated to a VLAN. Wireless LANs can be arranged into hierarchical groups, and each may be associated with a particular tenant. An interface may be attached to multiple wireless LANs, provided they are all operating on the same channel. Only wireless interfaces may be attached to wireless LANs. diff --git a/docs/models/wireless/wirelesslink.md b/docs/models/wireless/wirelesslink.md index 85cdbd6d9..f52dc7191 100644 --- a/docs/models/wireless/wirelesslink.md +++ b/docs/models/wireless/wirelesslink.md @@ -1,6 +1,6 @@ # Wireless Links -A wireless link represents a connection between exactly two wireless interfaces. It may optionally be assigned an SSID and a description. It may also have a status assigned to it, similar to the cable model. +A wireless link represents a connection between exactly two wireless interfaces. It may optionally be assigned an SSID and a description. It may also have a status assigned to it, similar to the cable model. Each wireless link may also be assigned to a particular tenant. Each wireless link may have authentication attributes associated with it, including: diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 8deee0370..1e18de1e6 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -28,6 +28,7 @@ * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results * [#9166](https://github.com/netbox-community/netbox/issues/9166) - Add UI visibility toggle for custom fields +* [#9177](https://github.com/netbox-community/netbox/issues/9177) - Add tenant assignment for wireless LANs & links * [#9536](https://github.com/netbox-community/netbox/issues/9536) - Track API token usage times * [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location @@ -70,3 +71,7 @@ * Added `device` field * The `site` field is now directly writable (rather than being inferred from the assigned cluster) * The `cluster` field is now optional. A virtual machine must have a site and/or cluster assigned. +wireless.WirelessLAN + * Added `tenant` field +wireless.WirelessLink + * Added `tenant` field diff --git a/netbox/templates/tenancy/tenant.html b/netbox/templates/tenancy/tenant.html index 52c13e1aa..e8dc4b23a 100644 --- a/netbox/templates/tenancy/tenant.html +++ b/netbox/templates/tenancy/tenant.html @@ -61,6 +61,10 @@

      {{ stats.device_count }}

      Devices

      +
      +

      {{ stats.cable_count }}

      +

      Cables

      +

      {{ stats.vrf_count }}

      VRFs

      @@ -102,8 +106,12 @@

      Clusters

      -

      {{ stats.cable_count }}

      -

      Cables

      +

      {{ stats.wirelesslan_count }}

      +

      Wireless LANs

      +
      +
      +

      {{ stats.wirelesslink_count }}

      +

      Wireless Links

      diff --git a/netbox/templates/wireless/wirelesslan.html b/netbox/templates/wireless/wirelesslan.html index 185a44904..9250ef7ef 100644 --- a/netbox/templates/wireless/wirelesslan.html +++ b/netbox/templates/wireless/wirelesslan.html @@ -6,36 +6,45 @@ {% block content %}
      -
      -
      Wireless LAN
      -
      - - - - - - - - - - - - - - - - - -
      SSID{{ object.ssid }}
      Group{{ object.group|linkify|placeholder }}
      Description{{ object.description|placeholder }}
      VLAN{{ object.vlan|linkify|placeholder }}
      -
      -
      - {% include 'inc/panels/tags.html' %} - {% plugin_left_page object %} +
      +
      Wireless LAN
      +
      + + + + + + + + + + + + + + + + + + + + + +
      SSID{{ object.ssid }}
      Group{{ object.group|linkify|placeholder }}
      Description{{ object.description|placeholder }}
      VLAN{{ object.vlan|linkify|placeholder }}
      Tenant + {% if object.tenant.group %} + {{ object.tenant.group|linkify }} / + {% endif %} + {{ object.tenant|linkify|placeholder }} +
      +
      -
      - {% include 'wireless/inc/authentication_attrs.html' %} - {% include 'inc/panels/custom_fields.html' %} - {% plugin_right_page object %} + {% include 'inc/panels/tags.html' %} + {% plugin_left_page object %} +
      +
      + {% include 'wireless/inc/authentication_attrs.html' %} + {% include 'inc/panels/custom_fields.html' %} + {% plugin_right_page object %}
      diff --git a/netbox/templates/wireless/wirelesslink.html b/netbox/templates/wireless/wirelesslink.html index 4795dcdde..d1a93e40d 100644 --- a/netbox/templates/wireless/wirelesslink.html +++ b/netbox/templates/wireless/wirelesslink.html @@ -23,6 +23,15 @@
      		SSID {{ object.ssid|placeholder }}
      Tenant + {% if object.tenant.group %} + {{ object.tenant.group|linkify }} / + {% endif %} + {{ object.tenant|linkify|placeholder }} +
      Description {{ object.description|placeholder }}
      Name + + + + + + + + + + + + + + + + + + + + + + +
      {{ object.name|placeholder }}
      Slug{{ object.slug|placeholder }}
      Identifier{{ object.identifier|placeholder }}
      Type{{ object.get_type_display }}
      Description{{ object.description|placeholder }}
      Tenant{{ object.tenant|placeholder }}
      +
      +
      + {% include 'inc/panels/contacts.html' %} + {% plugin_left_page object %} +
      +
      + {% include 'inc/panels/tags.html' with tags=object.tags.all url='circuits:circuit_list' %} + {% include 'inc/panels/custom_fields.html' %} + {% plugin_right_page object %} +
      + +
      +
      + {% include 'inc/panel_table.html' with table=import_targets_table heading="Import Route Targets" %} +
      +
      + {% include 'inc/panel_table.html' with table=export_targets_table heading="Export Route Targets" %} +
      +
      +
      +
      +
      +
      L2VPN Terminations
      +
      + {% with terminations=object.terminations.all %} + {% if terminations.exists %} + + + + + + + {% for termination in terminations %} + + + + + + {% endfor %} +
      Termination TypeTermination
      {{ termination.assigned_object|meta:"verbose_name" }}{{ termination.assigned_object|linkify }} + {% if perms.ipam.change_l2vpntermination %} + + + + {% endif %} + {% if perms.ipam.delete_l2vpntermination %} + + + + {% endif %} +
      + {% else %} +
      None
      + {% endif %} + {% endwith %} +
      + {% if perms.ipam.add_l2vpntermination %} +
      + + Add a Termination + +
      + {% endif %} +
      +
      +
      +
      +
      + {% plugin_full_width_page object %} +
      +
      +{% endblock %} diff --git a/netbox/templates/ipam/l2vpntermination.html b/netbox/templates/ipam/l2vpntermination.html new file mode 100644 index 000000000..22e0cc324 --- /dev/null +++ b/netbox/templates/ipam/l2vpntermination.html @@ -0,0 +1,31 @@ +{% extends 'generic/object.html' %} +{% load helpers %} + +{% block content %} +
      +
      +
      +
      + L2VPN Attributes +
      +
      + + + + + + + + + +
      L2vPN{{ object.l2vpn.name|placeholder }}
      Assigned Object{{ object.assigned_object.name|placeholder }}
      +
      +
      +
      +
      + {% include 'inc/panels/custom_fields.html' %} + {% include 'inc/panels/tags.html' with tags=object.tags.all url='ipam:l2vpntermination_list' %} +
      +
      + +{% endblock %} diff --git a/netbox/templates/ipam/l2vpntermination_edit.html b/netbox/templates/ipam/l2vpntermination_edit.html new file mode 100644 index 000000000..3fb0460b5 --- /dev/null +++ b/netbox/templates/ipam/l2vpntermination_edit.html @@ -0,0 +1,39 @@ +{% extends 'generic/object_edit.html' %} +{% load helpers %} +{% load form_helpers %} + +{% block form %} +
      +
      +
      L2VPN Termination
      +
      + {% render_field form.l2vpn %} +
      +
      +
        + + +
      +
      +
      +
      +
      + {% render_field form.device %} +
      + {% render_field form.vlan %} +
      +
      + {% render_field form.interface %} +
      +
      +
      +
      +{% endblock %} From ccb7e96d8a294c45bf8413c4bba167e5835d8a64 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 28 Jun 2022 16:22:38 -0400 Subject: [PATCH 179/593] Changelog for #8854, #9403, #9540 --- docs/release-notes/version-3.2.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 719ceb7e1..57d965538 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -6,9 +6,12 @@ * [#7702](https://github.com/netbox-community/netbox/issues/7702) - Enable dynamic configuration for default powerfeed attributes * [#9396](https://github.com/netbox-community/netbox/issues/9396) - Allow filtering modules by bay ID +* [#9403](https://github.com/netbox-community/netbox/issues/9403) - Enable modifying virtual chassis properties when creating/editing a device +* [#9540](https://github.com/netbox-community/netbox/issues/9540) - Add filters for assigned device & VM to IP addresses list ### Bug Fixes +* [#8854](https://github.com/netbox-community/netbox/issues/8854) - Fix `REMOTE_AUTH_DEFAULT_GROUPS` for social-auth backends * [#9575](https://github.com/netbox-community/netbox/issues/9575) - Fix AttributeError exception for FHRP group with an IP address assigned * [#9597](https://github.com/netbox-community/netbox/issues/9597) - Include `installed_module` in module bay REST API serializer From 8e200a9cb485df698fe8ac30f13025fcab0f3281 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 28 Jun 2022 16:24:56 -0400 Subject: [PATCH 180/593] #9403: Add labels to device VC fields --- netbox/dcim/forms/models.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/netbox/dcim/forms/models.py b/netbox/dcim/forms/models.py index 2c905cc5c..043af751d 100644 --- a/netbox/dcim/forms/models.py +++ b/netbox/dcim/forms/models.py @@ -527,10 +527,12 @@ class DeviceForm(TenancyForm, NetBoxModelForm): ) vc_position = forms.IntegerField( required=False, + label='Position', help_text="The position in the virtual chassis this device is identified by" ) vc_priority = forms.IntegerField( required=False, + label='Priority', help_text="The priority of the device in the virtual chassis" ) From c5770392e32aeeaed9bd8dcf907a11c7df352b6c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 28 Jun 2022 18:14:57 -0400 Subject: [PATCH 181/593] Refactor ObjectChildrenView --- netbox/netbox/views/generic/bulk_views.py | 26 ++++---------- netbox/netbox/views/generic/mixins.py | 22 ++++++++++++ netbox/netbox/views/generic/object_views.py | 39 +++++++++++++-------- 3 files changed, 53 insertions(+), 34 deletions(-) create mode 100644 netbox/netbox/views/generic/mixins.py diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py index 96efc0de7..7267e73ed 100644 --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -24,6 +24,7 @@ from utilities.htmx import is_htmx from utilities.permissions import get_permission_for_model from utilities.views import GetReturnURLMixin from .base import BaseMultiObjectView +from .mixins import TableMixin __all__ = ( 'BulkComponentCreateView', @@ -36,9 +37,9 @@ __all__ = ( ) -class ObjectListView(BaseMultiObjectView): +class ObjectListView(BaseMultiObjectView, TableMixin): """ - Display multiple objects, all of the same type, as a table. + Display multiple objects, all the same type, as a table. Attributes: filterset: A django-filter FilterSet that is applied to the queryset @@ -61,20 +62,6 @@ class ObjectListView(BaseMultiObjectView): def get_required_permission(self): return get_permission_for_model(self.queryset.model, 'view') - def get_table(self, request, bulk_actions=True): - """ - Return the django-tables2 Table instance to be used for rendering the objects list. - - Args: - request: The current request - bulk_actions: Show checkboxes for object selection - """ - table = self.table(self.queryset, user=request.user) - if 'pk' in table.base_columns and bulk_actions: - table.columns.show('pk') - - return table - # # Export methods # @@ -159,7 +146,7 @@ class ObjectListView(BaseMultiObjectView): # Export the current table view if request.GET['export'] == 'table': - table = self.get_table(request, has_bulk_actions) + table = self.get_table(self.queryset, request, has_bulk_actions) columns = [name for name, _ in table.selected_columns] return self.export_table(table, columns) @@ -177,12 +164,11 @@ class ObjectListView(BaseMultiObjectView): # Fall back to default table/YAML export else: - table = self.get_table(request, has_bulk_actions) + table = self.get_table(self.queryset, request, has_bulk_actions) return self.export_table(table) # Render the objects table - table = self.get_table(request, has_bulk_actions) - table.configure(request) + table = self.get_table(self.queryset, request, has_bulk_actions) # If this is an HTMX request, return only the rendered table HTML if is_htmx(request): diff --git a/netbox/netbox/views/generic/mixins.py b/netbox/netbox/views/generic/mixins.py new file mode 100644 index 000000000..0adf3a4c4 --- /dev/null +++ b/netbox/netbox/views/generic/mixins.py @@ -0,0 +1,22 @@ +__all__ = ( + 'TableMixin', +) + + +class TableMixin: + + def get_table(self, data, request, bulk_actions=True): + """ + Return the django-tables2 Table instance to be used for rendering the objects list. + + Args: + data: Queryset or iterable containing table data + request: The current request + bulk_actions: Render checkboxes for object selection + """ + table = self.table(data, user=request.user) + if 'pk' in table.base_columns and bulk_actions: + table.columns.show('pk') + table.configure(request) + + return table diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index 88abfa48f..f9d8b6ac9 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -1,4 +1,5 @@ import logging +from collections import defaultdict from copy import deepcopy from django.contrib import messages @@ -20,6 +21,7 @@ from utilities.permissions import get_permission_for_model from utilities.utils import get_viewname, normalize_querydict, prepare_cloned_fields from utilities.views import GetReturnURLMixin from .base import BaseObjectView +from .mixins import TableMixin __all__ = ( 'ComponentCreateView', @@ -69,23 +71,31 @@ class ObjectView(BaseObjectView): }) -class ObjectChildrenView(ObjectView): +class ObjectChildrenView(ObjectView, TableMixin): """ Display a table of child objects associated with the parent object. Attributes: - table: Table class used to render child objects list + child_model: The model class which represents the child objects + table: The django-tables2 Table class used to render the child objects list + filterset: A django-filter FilterSet that is applied to the queryset """ child_model = None table = None filterset = None + actions = ('bulk_edit', 'bulk_delete') + action_perms = defaultdict(set, **{ + 'bulk_edit': {'change'}, + 'bulk_delete': {'delete'}, + }) def get_children(self, request, parent): """ Return a QuerySet of child objects. - request: The current request - parent: The parent object + Args: + request: The current request + parent: The parent object """ raise NotImplementedError(f'{self.__class__.__name__} must implement get_children()') @@ -114,16 +124,16 @@ class ObjectChildrenView(ObjectView): if self.filterset: child_objects = self.filterset(request.GET, child_objects).qs - permissions = {} - for action in ('change', 'delete'): - perm_name = get_permission_for_model(self.child_model, action) - permissions[action] = request.user.has_perm(perm_name) + # Determine the available actions + actions = [] + for action in self.actions: + if request.user.has_perms([ + get_permission_for_model(self.child_model, name) for name in self.action_perms[action] + ]): + actions.append(action) - table = self.table(self.prep_table_data(request, child_objects, instance), user=request.user) - # Determine whether to display bulk action checkboxes - if 'pk' in table.base_columns and (permissions['change'] or permissions['delete']): - table.columns.show('pk') - table.configure(request) + table_data = self.prep_table_data(request, child_objects, instance) + table = self.get_table(table_data, request, bool(actions)) # If this is an HTMX request, return only the rendered table HTML if is_htmx(request): @@ -134,8 +144,9 @@ class ObjectChildrenView(ObjectView): return render(request, self.get_template_name(), { 'object': instance, + 'child_model': self.child_model, 'table': table, - 'permissions': permissions, + 'actions': actions, **self.get_extra_context(request, instance), }) From cdcb77dea8b143c93369d5a34ded0fe128c01ea1 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 29 Jun 2022 14:06:01 -0400 Subject: [PATCH 182/593] Move actions determination to a mixin --- netbox/netbox/views/generic/bulk_views.py | 24 +++++--------------- netbox/netbox/views/generic/mixins.py | 25 +++++++++++++++++++++ netbox/netbox/views/generic/object_views.py | 20 +++++------------ 3 files changed, 36 insertions(+), 33 deletions(-) diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py index 7267e73ed..bb1c2b8e3 100644 --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -24,7 +24,7 @@ from utilities.htmx import is_htmx from utilities.permissions import get_permission_for_model from utilities.views import GetReturnURLMixin from .base import BaseMultiObjectView -from .mixins import TableMixin +from .mixins import ActionsMixin, TableMixin __all__ = ( 'BulkComponentCreateView', @@ -37,7 +37,7 @@ __all__ = ( ) -class ObjectListView(BaseMultiObjectView, TableMixin): +class ObjectListView(BaseMultiObjectView, ActionsMixin, TableMixin): """ Display multiple objects, all the same type, as a table. @@ -51,13 +51,6 @@ class ObjectListView(BaseMultiObjectView, TableMixin): template_name = 'generic/object_list.html' filterset = None filterset_form = None - actions = ('add', 'import', 'export', 'bulk_edit', 'bulk_delete') - action_perms = defaultdict(set, **{ - 'add': {'add'}, - 'import': {'add'}, - 'bulk_edit': {'change'}, - 'bulk_delete': {'delete'}, - }) def get_required_permission(self): return get_permission_for_model(self.queryset.model, 'view') @@ -134,12 +127,7 @@ class ObjectListView(BaseMultiObjectView, TableMixin): self.queryset = self.filterset(request.GET, self.queryset).qs # Determine the available actions - actions = [] - for action in self.actions: - if request.user.has_perms([ - get_permission_for_model(model, name) for name in self.action_perms[action] - ]): - actions.append(action) + actions = self.get_permitted_actions(request.user) has_bulk_actions = any([a.startswith('bulk_') for a in actions]) if 'export' in request.GET: @@ -176,15 +164,13 @@ class ObjectListView(BaseMultiObjectView, TableMixin): 'table': table, }) - context = { + return render(request, self.template_name, { 'model': model, 'table': table, 'actions': actions, 'filter_form': self.filterset_form(request.GET, label_suffix='') if self.filterset_form else None, **self.get_extra_context(request), - } - - return render(request, self.template_name, context) + }) class BulkCreateView(GetReturnURLMixin, BaseMultiObjectView): diff --git a/netbox/netbox/views/generic/mixins.py b/netbox/netbox/views/generic/mixins.py index 0adf3a4c4..4b3fa0740 100644 --- a/netbox/netbox/views/generic/mixins.py +++ b/netbox/netbox/views/generic/mixins.py @@ -1,8 +1,33 @@ +from collections import defaultdict + +from utilities.permissions import get_permission_for_model + __all__ = ( 'TableMixin', ) +class ActionsMixin: + actions = ('add', 'import', 'export', 'bulk_edit', 'bulk_delete') + action_perms = defaultdict(set, **{ + 'add': {'add'}, + 'import': {'add'}, + 'bulk_edit': {'change'}, + 'bulk_delete': {'delete'}, + }) + + def get_permitted_actions(self, user, model=None): + """ + Return a tuple of actions for which the given user is permitted to do. + """ + model = model or self.queryset.model + return [ + action for action in self.actions if user.has_perms([ + get_permission_for_model(model, name) for name in self.action_perms[action] + ]) + ] + + class TableMixin: def get_table(self, data, request, bulk_actions=True): diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index f9d8b6ac9..82867b429 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -1,5 +1,4 @@ import logging -from collections import defaultdict from copy import deepcopy from django.contrib import messages @@ -21,7 +20,7 @@ from utilities.permissions import get_permission_for_model from utilities.utils import get_viewname, normalize_querydict, prepare_cloned_fields from utilities.views import GetReturnURLMixin from .base import BaseObjectView -from .mixins import TableMixin +from .mixins import ActionsMixin, TableMixin __all__ = ( 'ComponentCreateView', @@ -71,7 +70,7 @@ class ObjectView(BaseObjectView): }) -class ObjectChildrenView(ObjectView, TableMixin): +class ObjectChildrenView(ObjectView, ActionsMixin, TableMixin): """ Display a table of child objects associated with the parent object. @@ -79,15 +78,13 @@ class ObjectChildrenView(ObjectView, TableMixin): child_model: The model class which represents the child objects table: The django-tables2 Table class used to render the child objects list filterset: A django-filter FilterSet that is applied to the queryset + actions: Supported actions for the model. When adding custom actions, bulk action names must + be prefixed with `bulk_`. Default actions: add, import, export, bulk_edit, bulk_delete + action_perms: A dictionary mapping supported actions to a set of permissions required for each """ child_model = None table = None filterset = None - actions = ('bulk_edit', 'bulk_delete') - action_perms = defaultdict(set, **{ - 'bulk_edit': {'change'}, - 'bulk_delete': {'delete'}, - }) def get_children(self, request, parent): """ @@ -125,12 +122,7 @@ class ObjectChildrenView(ObjectView, TableMixin): child_objects = self.filterset(request.GET, child_objects).qs # Determine the available actions - actions = [] - for action in self.actions: - if request.user.has_perms([ - get_permission_for_model(self.child_model, name) for name in self.action_perms[action] - ]): - actions.append(action) + actions = self.get_permitted_actions(request.user, model=self.child_model) table_data = self.prep_table_data(request, child_objects, instance) table = self.get_table(table_data, request, bool(actions)) From 4649bc632cddb530ca91dbab763de96602a3829c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 29 Jun 2022 14:21:57 -0400 Subject: [PATCH 183/593] Update templates for subclasses of ObjectChildrenView --- netbox/templates/dcim/device/consoleports.html | 4 ++-- netbox/templates/dcim/device/consoleserverports.html | 4 ++-- netbox/templates/dcim/device/devicebays.html | 4 ++-- netbox/templates/dcim/device/frontports.html | 4 ++-- netbox/templates/dcim/device/interfaces.html | 4 ++-- netbox/templates/dcim/device/inventory.html | 4 ++-- netbox/templates/dcim/device/modulebays.html | 4 ++-- netbox/templates/dcim/device/poweroutlets.html | 4 ++-- netbox/templates/dcim/device/powerports.html | 4 ++-- netbox/templates/dcim/device/rearports.html | 4 ++-- netbox/templates/ipam/aggregate/prefixes.html | 4 ++-- netbox/templates/ipam/iprange/ip_addresses.html | 4 ++-- netbox/templates/ipam/prefix/ip_addresses.html | 4 ++-- netbox/templates/ipam/prefix/ip_ranges.html | 4 ++-- netbox/templates/ipam/prefix/prefixes.html | 4 ++-- netbox/templates/virtualization/cluster/virtual_machines.html | 4 ++-- 16 files changed, 32 insertions(+), 32 deletions(-) diff --git a/netbox/templates/dcim/device/consoleports.html b/netbox/templates/dcim/device/consoleports.html index afc306bd4..04184be7c 100644 --- a/netbox/templates/dcim/device/consoleports.html +++ b/netbox/templates/dcim/device/consoleports.html @@ -17,7 +17,7 @@
      - {% if perms.dcim.change_consoleport %} + {% if 'bulk_edit' in actions %} @@ -28,7 +28,7 @@ Disconnect {% endif %} - {% if perms.dcim.delete_consoleport %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/dcim/device/consoleserverports.html b/netbox/templates/dcim/device/consoleserverports.html index 5f244cdc7..ee1be91d7 100644 --- a/netbox/templates/dcim/device/consoleserverports.html +++ b/netbox/templates/dcim/device/consoleserverports.html @@ -17,7 +17,7 @@
      - {% if perms.dcim.change_consoleserverport %} + {% if 'bulk_edit' in actions %} @@ -28,7 +28,7 @@ Disconnect {% endif %} - {% if perms.dcim.delete_consoleserverport %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/dcim/device/devicebays.html b/netbox/templates/dcim/device/devicebays.html index 5e33bdae0..7836935d9 100644 --- a/netbox/templates/dcim/device/devicebays.html +++ b/netbox/templates/dcim/device/devicebays.html @@ -17,7 +17,7 @@
      - {% if perms.dcim.change_devicebay %} + {% if 'bulk_edit' in actions %} @@ -25,7 +25,7 @@ Edit {% endif %} - {% if perms.dcim.delete_devicebay %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/dcim/device/frontports.html b/netbox/templates/dcim/device/frontports.html index 0d0f9577c..8590fd50e 100644 --- a/netbox/templates/dcim/device/frontports.html +++ b/netbox/templates/dcim/device/frontports.html @@ -17,7 +17,7 @@
      - {% if perms.dcim.change_frontport %} + {% if 'bulk_edit' in actions %} @@ -28,7 +28,7 @@ Disconnect {% endif %} - {% if perms.dcim.delete_frontport %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/dcim/device/interfaces.html b/netbox/templates/dcim/device/interfaces.html index 22f6d8be5..7db7ea0ae 100644 --- a/netbox/templates/dcim/device/interfaces.html +++ b/netbox/templates/dcim/device/interfaces.html @@ -53,7 +53,7 @@
      - {% if perms.dcim.change_interface %} + {% if 'bulk_edit' in actions %} @@ -64,7 +64,7 @@ Disconnect {% endif %} - {% if perms.dcim.delete_interface %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/dcim/device/inventory.html b/netbox/templates/dcim/device/inventory.html index 18a0712f3..de981c545 100644 --- a/netbox/templates/dcim/device/inventory.html +++ b/netbox/templates/dcim/device/inventory.html @@ -17,7 +17,7 @@
      - {% if perms.dcim.change_inventoryitem %} + {% if 'bulk_edit' in actions %} @@ -25,7 +25,7 @@ Edit {% endif %} - {% if perms.dcim.delete_inventoryitem %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/dcim/device/modulebays.html b/netbox/templates/dcim/device/modulebays.html index fc1c9a60d..3e4dadb30 100644 --- a/netbox/templates/dcim/device/modulebays.html +++ b/netbox/templates/dcim/device/modulebays.html @@ -17,7 +17,7 @@
      - {% if perms.dcim.change_modulebay %} + {% if 'bulk_edit' in actions %} @@ -25,7 +25,7 @@ Edit {% endif %} - {% if perms.dcim.delete_modulebay %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/dcim/device/poweroutlets.html b/netbox/templates/dcim/device/poweroutlets.html index d312fbbd0..f9880a4b1 100644 --- a/netbox/templates/dcim/device/poweroutlets.html +++ b/netbox/templates/dcim/device/poweroutlets.html @@ -17,7 +17,7 @@
      - {% if perms.dcim.change_powerport %} + {% if 'bulk_edit' in actions %} @@ -28,7 +28,7 @@ Disconnect {% endif %} - {% if perms.dcim.delete_poweroutlet %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/dcim/device/powerports.html b/netbox/templates/dcim/device/powerports.html index cf71e81ba..fc426a023 100644 --- a/netbox/templates/dcim/device/powerports.html +++ b/netbox/templates/dcim/device/powerports.html @@ -17,7 +17,7 @@
      - {% if perms.dcim.change_powerport %} + {% if 'bulk_edit' in actions %} @@ -28,7 +28,7 @@ Disconnect {% endif %} - {% if perms.dcim.delete_powerport %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/dcim/device/rearports.html b/netbox/templates/dcim/device/rearports.html index 73341990f..eee67b6fd 100644 --- a/netbox/templates/dcim/device/rearports.html +++ b/netbox/templates/dcim/device/rearports.html @@ -17,7 +17,7 @@
      - {% if perms.dcim.change_rearport %} + {% if 'bulk_edit' in actions %} @@ -28,7 +28,7 @@ Disconnect {% endif %} - {% if perms.dcim.delete_rearport %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/ipam/aggregate/prefixes.html b/netbox/templates/ipam/aggregate/prefixes.html index d1b48429a..8256236f4 100644 --- a/netbox/templates/ipam/aggregate/prefixes.html +++ b/netbox/templates/ipam/aggregate/prefixes.html @@ -25,12 +25,12 @@
      - {% if perms.ipam.change_prefix %} + {% if 'bulk_edit' in actions %} {% endif %} - {% if perms.ipam.delete_prefix %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/ipam/iprange/ip_addresses.html b/netbox/templates/ipam/iprange/ip_addresses.html index d9ac77fd0..61b2ee335 100644 --- a/netbox/templates/ipam/iprange/ip_addresses.html +++ b/netbox/templates/ipam/iprange/ip_addresses.html @@ -23,12 +23,12 @@
      - {% if perms.ipam.change_ipaddress %} + {% if 'bulk_edit' in actions %} {% endif %} - {% if perms.ipam.delete_ipaddress %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/ipam/prefix/ip_addresses.html b/netbox/templates/ipam/prefix/ip_addresses.html index d734b825f..31a22497d 100644 --- a/netbox/templates/ipam/prefix/ip_addresses.html +++ b/netbox/templates/ipam/prefix/ip_addresses.html @@ -23,12 +23,12 @@
      - {% if perms.ipam.change_ipaddress %} + {% if 'bulk_edit' in actions %} {% endif %} - {% if perms.ipam.delete_ipaddress %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/ipam/prefix/ip_ranges.html b/netbox/templates/ipam/prefix/ip_ranges.html index 268c290a1..45b1d4fd0 100644 --- a/netbox/templates/ipam/prefix/ip_ranges.html +++ b/netbox/templates/ipam/prefix/ip_ranges.html @@ -23,12 +23,12 @@
      - {% if perms.ipam.change_iprange %} + {% if 'bulk_edit' in actions %} {% endif %} - {% if perms.ipam.delete_iprange %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/ipam/prefix/prefixes.html b/netbox/templates/ipam/prefix/prefixes.html index 5d42596ba..46fa29581 100644 --- a/netbox/templates/ipam/prefix/prefixes.html +++ b/netbox/templates/ipam/prefix/prefixes.html @@ -25,12 +25,12 @@
      - {% if perms.ipam.change_prefix %} + {% if 'bulk_edit' in actions %} {% endif %} - {% if perms.ipam.delete_prefix %} + {% if 'bulk_delete' in actions %} diff --git a/netbox/templates/virtualization/cluster/virtual_machines.html b/netbox/templates/virtualization/cluster/virtual_machines.html index 953d9f940..9cb33258f 100644 --- a/netbox/templates/virtualization/cluster/virtual_machines.html +++ b/netbox/templates/virtualization/cluster/virtual_machines.html @@ -14,12 +14,12 @@
      - {% if perms.virtualization.change_virtualmachine %} + {% if 'bulk_edit' in actions %} {% endif %} - {% if perms.virtualization.delete_virtualmachine %} + {% if 'bulk_delete' in actions %} From a0f9b5e47b29b5e04ba921741f4d24e588caf36f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 29 Jun 2022 14:30:47 -0400 Subject: [PATCH 184/593] Document support for ObjectChildrenView --- docs/plugins/development/views.md | 25 ++++++++++++++++--------- docs/release-notes/version-3.3.md | 1 + 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/docs/plugins/development/views.md b/docs/plugins/development/views.md index 92626f8d3..cabcd7045 100644 --- a/docs/plugins/development/views.md +++ b/docs/plugins/development/views.md @@ -51,15 +51,16 @@ This makes our view accessible at the URL `/plugins/animal-sounds/random/`. (Rem NetBox provides several generic view classes (documented below) to facilitate common operations, such as creating, viewing, modifying, and deleting objects. Plugins can subclass these views for their own use. -| View Class | Description | -|--------------------|--------------------------------| -| `ObjectView` | View a single object | -| `ObjectEditView` | Create or edit a single object | -| `ObjectDeleteView` | Delete a single object | -| `ObjectListView` | View a list of objects | -| `BulkImportView` | Import a set of new objects | -| `BulkEditView` | Edit multiple objects | -| `BulkDeleteView` | Delete multiple objects | +| View Class | Description | +|----------------------|--------------------------------------------------------| +| `ObjectView` | View a single object | +| `ObjectEditView` | Create or edit a single object | +| `ObjectDeleteView` | Delete a single object | +| `ObjectChildrenView` | A list of child objects within the context of a parent | +| `ObjectListView` | View a list of objects | +| `BulkImportView` | Import a set of new objects | +| `BulkEditView` | Edit multiple objects | +| `BulkDeleteView` | Delete multiple objects | !!! warning Please note that only the classes which appear in this documentation are currently supported. Although other classes may be present within the `views.generic` module, they are not yet supported for use by plugins. @@ -99,6 +100,12 @@ Below are the class definitions for NetBox's object views. These views handle CR members: - get_object +::: netbox.views.generic.ObjectChildrenView + selection: + members: + - get_children + - prep_table_data + ## Multi-Object Views Below are the class definitions for NetBox's multi-object views. These views handle simultaneous actions for sets objects. The list, import, edit, and delete views each inherit from `BaseMultiObjectView`, which is not intended to be used directly. diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 1e18de1e6..efcf570fa 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -34,6 +34,7 @@ ### Plugins API +* [#9092](https://github.com/netbox-community/netbox/issues/9092) - Add support for `ObjectChildrenView` generic view * [#9414](https://github.com/netbox-community/netbox/issues/9414) - Add `clone()` method to NetBoxModel for copying instance attributes ### Other Changes From 779969f150b47251592a4619a2b038cbefd1c8f5 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 29 Jun 2022 16:36:10 -0400 Subject: [PATCH 185/593] Closes #9070: Hide navigation menu items based on user permissions --- docs/release-notes/version-3.3.md | 1 + .../utilities/templates/navigation/menu.html | 91 ++++++++----------- netbox/utilities/templatetags/navigation.py | 21 ++++- 3 files changed, 59 insertions(+), 54 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index efcf570fa..62644f55f 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -27,6 +27,7 @@ * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results +* [#9070](https://github.com/netbox-community/netbox/issues/9070) - Hide navigation menu items based on user permissions * [#9166](https://github.com/netbox-community/netbox/issues/9166) - Add UI visibility toggle for custom fields * [#9177](https://github.com/netbox-community/netbox/issues/9177) - Add tenant assignment for wireless LANs & links * [#9536](https://github.com/netbox-community/netbox/issues/9536) - Track API token usage times diff --git a/netbox/utilities/templates/navigation/menu.html b/netbox/utilities/templates/navigation/menu.html index dfc85968a..33a476081 100644 --- a/netbox/utilities/templates/navigation/menu.html +++ b/netbox/utilities/templates/navigation/menu.html @@ -1,58 +1,43 @@ {% load helpers %}
        - {% for menu in nav_items %} -
      • - - + {% endif %} +
        • + {% endfor %} + {% endfor %} +
      +
      +
      • + {% endfor %}
    diff --git a/netbox/utilities/templatetags/navigation.py b/netbox/utilities/templatetags/navigation.py index ede8792fa..ef0657446 100644 --- a/netbox/utilities/templatetags/navigation.py +++ b/netbox/utilities/templatetags/navigation.py @@ -13,7 +13,26 @@ def nav(context: Context) -> Dict: """ Render the navigation menu. """ + user = context['request'].user + nav_items = [] + + # Construct the navigation menu based upon the current user's permissions + for menu in MENUS: + groups = [] + for group in menu.groups: + items = [] + for item in group.items: + if user.has_perms(item.permissions): + buttons = [ + button for button in item.buttons if user.has_perms(button.permissions) + ] + items.append((item, buttons)) + if items: + groups.append((group, items)) + if groups: + nav_items.append((menu, groups)) + return { - "nav_items": MENUS, + "nav_items": nav_items, "request": context["request"] } From 3be9f6c4f3a74ab74f35f6cdc4de77593583c409 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 29 Jun 2022 16:01:20 -0500 Subject: [PATCH 186/593] #8157 - Final work on L2VPN model --- netbox/dcim/api/serializers.py | 4 +- netbox/dcim/models/device_components.py | 7 +- netbox/ipam/api/nested_serializers.py | 8 +- netbox/ipam/api/serializers.py | 5 +- netbox/ipam/api/views.py | 2 +- netbox/ipam/filtersets.py | 51 ++++++++- netbox/ipam/forms/bulk_edit.py | 5 + netbox/ipam/graphql/schema.py | 6 ++ netbox/ipam/graphql/types.py | 16 +++ netbox/ipam/models/vlans.py | 7 +- netbox/ipam/tests/test_api.py | 38 +++---- netbox/ipam/tests/test_filtersets.py | 62 +++++------ netbox/ipam/tests/test_models.py | 81 ++++++++++++-- netbox/ipam/tests/test_views.py | 138 ++++++++++++++++++++++-- netbox/ipam/urls.py | 1 + netbox/ipam/views.py | 21 ++-- netbox/templates/dcim/interface.html | 4 + netbox/templates/ipam/vlan.html | 4 + 18 files changed, 376 insertions(+), 84 deletions(-) diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 8ac2aa738..32709000b 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -10,6 +10,7 @@ from dcim.constants import * from dcim.models import * from ipam.api.nested_serializers import ( NestedASNSerializer, NestedIPAddressSerializer, NestedVLANSerializer, NestedVRFSerializer, + NestedL2VPNTerminationSerializer, ) from ipam.models import ASN, VLAN from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField @@ -823,6 +824,7 @@ class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn many=True ) vrf = NestedVRFSerializer(required=False, allow_null=True) + l2vpn_termination = NestedL2VPNTerminationSerializer(read_only=True) cable = NestedCableSerializer(read_only=True) wireless_link = NestedWirelessLinkSerializer(read_only=True) wireless_lans = SerializedPKRelatedField( @@ -841,7 +843,7 @@ class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn 'mtu', 'mac_address', 'speed', 'duplex', 'wwn', 'mgmt_only', 'description', 'mode', 'rf_role', 'rf_channel', 'poe_mode', 'poe_type', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'untagged_vlan', 'tagged_vlans', 'mark_connected', 'cable', 'wireless_link', 'link_peer', 'link_peer_type', 'wireless_lans', - 'vrf', 'connected_endpoint', 'connected_endpoint_type', 'connected_endpoint_reachable', 'tags', + 'vrf', 'l2vpn_termination', 'connected_endpoint', 'connected_endpoint_type', 'connected_endpoint_reachable', 'tags', 'custom_fields', 'created', 'last_updated', 'count_ipaddresses', 'count_fhrp_groups', '_occupied', ] diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 4d19a2d8d..70c21c165 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -649,10 +649,11 @@ class Interface(ModularComponentModel, BaseInterface, LinkTermination, PathEndpo object_id_field='interface_id', related_query_name='+' ) - l2vpn = GenericRelation( + l2vpn_terminations = GenericRelation( to='ipam.L2VPNTermination', content_type_field='assigned_object_type', object_id_field='assigned_object_id', + related_query_name='interface', ) clone_fields = ['device', 'parent', 'bridge', 'lag', 'type', 'mgmt_only', 'poe_mode', 'poe_type'] @@ -828,6 +829,10 @@ class Interface(ModularComponentModel, BaseInterface, LinkTermination, PathEndpo def link(self): return self.cable or self.wireless_link + @property + def l2vpn_termination(self): + return self.l2vpn_terminations.first() + # # Pass-through ports diff --git a/netbox/ipam/api/nested_serializers.py b/netbox/ipam/api/nested_serializers.py index 8316cb992..39305a017 100644 --- a/netbox/ipam/api/nested_serializers.py +++ b/netbox/ipam/api/nested_serializers.py @@ -11,6 +11,8 @@ __all__ = [ 'NestedFHRPGroupAssignmentSerializer', 'NestedIPAddressSerializer', 'NestedIPRangeSerializer', + 'NestedL2VPNSerializer', + 'NestedL2VPNTerminationSerializer', 'NestedPrefixSerializer', 'NestedRIRSerializer', 'NestedRoleSerializer', @@ -203,17 +205,17 @@ class NestedL2VPNSerializer(WritableNestedSerializer): class Meta: model = L2VPN fields = [ - 'id', 'url', 'display', 'name', 'type' + 'id', 'url', 'display', 'identifier', 'name', 'slug', 'type' ] class NestedL2VPNTerminationSerializer(WritableNestedSerializer): - url = serializers.HyperlinkedIdentityField(view_name='ipam-api:l2vpn_termination-detail') + url = serializers.HyperlinkedIdentityField(view_name='ipam-api:l2vpntermination-detail') l2vpn = NestedL2VPNSerializer() class Meta: model = L2VPNTermination fields = [ - 'id', 'url', 'display', 'l2vpn', 'assigned_object' + 'id', 'url', 'display', 'l2vpn' ] diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index a51043e27..36102f853 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -207,13 +207,14 @@ class VLANSerializer(NetBoxModelSerializer): tenant = NestedTenantSerializer(required=False, allow_null=True) status = ChoiceField(choices=VLANStatusChoices, required=False) role = NestedRoleSerializer(required=False, allow_null=True) + l2vpn_termination = NestedL2VPNTerminationSerializer(read_only=True) prefix_count = serializers.IntegerField(read_only=True) class Meta: model = VLAN fields = [ - 'id', 'url', 'display', 'site', 'group', 'vid', 'name', 'tenant', 'status', 'role', 'description', 'tags', - 'custom_fields', 'created', 'last_updated', 'prefix_count', + 'id', 'url', 'display', 'site', 'group', 'vid', 'name', 'tenant', 'status', 'role', 'description', + 'l2vpn_termination', 'tags', 'custom_fields', 'created', 'last_updated', 'prefix_count', ] diff --git a/netbox/ipam/api/views.py b/netbox/ipam/api/views.py index 36a6f02b6..f5a61c031 100644 --- a/netbox/ipam/api/views.py +++ b/netbox/ipam/api/views.py @@ -165,7 +165,7 @@ class L2VPNViewSet(NetBoxModelViewSet): class L2VPNTerminationViewSet(NetBoxModelViewSet): - queryset = L2VPNTermination.objects + queryset = L2VPNTermination.objects.prefetch_related('assigned_object') serializer_class = serializers.L2VPNTerminationSerializer filterset_class = filtersets.L2VPNTerminationFilterSet diff --git a/netbox/ipam/filtersets.py b/netbox/ipam/filtersets.py index 03189a7cb..f682009ee 100644 --- a/netbox/ipam/filtersets.py +++ b/netbox/ipam/filtersets.py @@ -957,7 +957,7 @@ class L2VPNFilterSet(NetBoxModelFilterSet, TenancyFilterSet): class Meta: model = L2VPN - fields = ['identifier', 'name', 'type', 'description'] + fields = ['id', 'identifier', 'name', 'type', 'description'] def search(self, queryset, name, value): if not value.strip(): @@ -977,13 +977,60 @@ class L2VPNTerminationFilterSet(NetBoxModelFilterSet): to_field_name='name', label='L2VPN (name)', ) + device = MultiValueCharFilter( + method='filter_device', + field_name='name', + label='Device (name)', + ) + device_id = MultiValueNumberFilter( + method='filter_device', + field_name='pk', + label='Device (ID)', + ) + interface = django_filters.ModelMultipleChoiceFilter( + field_name='interface__name', + queryset=Interface.objects.all(), + to_field_name='name', + label='Interface (name)', + ) + interface_id = django_filters.ModelMultipleChoiceFilter( + field_name='interface', + queryset=Interface.objects.all(), + label='Interface (ID)', + ) + vlan = django_filters.ModelMultipleChoiceFilter( + field_name='vlan__name', + queryset=VLAN.objects.all(), + to_field_name='name', + label='VLAN (name)', + ) + vlan_vid = django_filters.NumberFilter( + field_name='vlan__vid', + label='VLAN number (1-4094)', + ) + vlan_id = django_filters.ModelMultipleChoiceFilter( + field_name='vlan', + queryset=VLAN.objects.all(), + label='VLAN (ID)', + ) class Meta: model = L2VPNTermination - fields = ['l2vpn'] + fields = ['id', ] def search(self, queryset, name, value): if not value.strip(): return queryset qs_filter = Q(l2vpn__name__icontains=value) return queryset.filter(qs_filter) + + def filter_device(self, queryset, name, value): + devices = Device.objects.filter(**{'{}__in'.format(name): value}) + if not devices.exists(): + return queryset.none() + interface_ids = [] + for device in devices: + interface_ids.extend(device.vc_interfaces().values_list('id', flat=True)) + return queryset.filter( + interface__in=interface_ids + ) diff --git a/netbox/ipam/forms/bulk_edit.py b/netbox/ipam/forms/bulk_edit.py index bbfa5bf9f..50fc51522 100644 --- a/netbox/ipam/forms/bulk_edit.py +++ b/netbox/ipam/forms/bulk_edit.py @@ -19,6 +19,7 @@ __all__ = ( 'IPAddressBulkEditForm', 'IPRangeBulkEditForm', 'L2VPNBulkEditForm', + 'L2VPNTerminationBulkEditForm', 'PrefixBulkEditForm', 'RIRBulkEditForm', 'RoleBulkEditForm', @@ -458,3 +459,7 @@ class L2VPNBulkEditForm(NetBoxModelBulkEditForm): (None, ('tenant', 'description')), ) nullable_fields = ('tenant', 'description',) + + +class L2VPNTerminationBulkEditForm(NetBoxModelBulkEditForm): + model = L2VPN diff --git a/netbox/ipam/graphql/schema.py b/netbox/ipam/graphql/schema.py index f466c1857..5cd5e030e 100644 --- a/netbox/ipam/graphql/schema.py +++ b/netbox/ipam/graphql/schema.py @@ -17,6 +17,12 @@ class IPAMQuery(graphene.ObjectType): ip_range = ObjectField(IPRangeType) ip_range_list = ObjectListField(IPRangeType) + l2vpn = ObjectField(L2VPNType) + l2vpn_list = ObjectListField(L2VPNType) + + l2vpn_termination = ObjectField(L2VPNTerminationType) + l2vpn_termination_list = ObjectListField(L2VPNTerminationType) + prefix = ObjectField(PrefixType) prefix_list = ObjectListField(PrefixType) diff --git a/netbox/ipam/graphql/types.py b/netbox/ipam/graphql/types.py index ca206b4b8..5af2ca72a 100644 --- a/netbox/ipam/graphql/types.py +++ b/netbox/ipam/graphql/types.py @@ -11,6 +11,8 @@ __all__ = ( 'FHRPGroupAssignmentType', 'IPAddressType', 'IPRangeType', + 'L2VPNType', + 'L2VPNTerminationType', 'PrefixType', 'RIRType', 'RoleType', @@ -151,3 +153,17 @@ class VRFType(NetBoxObjectType): model = models.VRF fields = '__all__' filterset_class = filtersets.VRFFilterSet + + +class L2VPNType(NetBoxObjectType): + class Meta: + model = models.L2VPN + fields = '__all__' + filtersets_class = filtersets.L2VPNFilterSet + + +class L2VPNTerminationType(NetBoxObjectType): + class Meta: + model = models.L2VPNTermination + fields = '__all__' + filtersets_class = filtersets.L2VPNTerminationFilterSet diff --git a/netbox/ipam/models/vlans.py b/netbox/ipam/models/vlans.py index 3a7969405..f0e062721 100644 --- a/netbox/ipam/models/vlans.py +++ b/netbox/ipam/models/vlans.py @@ -174,10 +174,11 @@ class VLAN(NetBoxModel): blank=True ) - l2vpn = GenericRelation( + l2vpn_terminations = GenericRelation( to='ipam.L2VPNTermination', content_type_field='assigned_object_type', object_id_field='assigned_object_id', + related_query_name='vlan' ) objects = VLANQuerySet.as_manager() @@ -234,3 +235,7 @@ class VLAN(NetBoxModel): Q(untagged_vlan_id=self.pk) | Q(tagged_vlans=self.pk) ).distinct() + + @property + def l2vpn_termination(self): + return self.l2vpn_terminations.first() diff --git a/netbox/ipam/tests/test_api.py b/netbox/ipam/tests/test_api.py index 0e93bd43e..a5ebef2c7 100644 --- a/netbox/ipam/tests/test_api.py +++ b/netbox/ipam/tests/test_api.py @@ -947,28 +947,28 @@ class L2VPNTest(APIViewTestCases.APIViewTestCase): def setUpTestData(cls): l2vpns = ( - L2VPN(name='L2VPN 1', type='vxlan', identifier=650001), - L2VPN(name='L2VPN 2', type='vpws', identifier=650002), - L2VPN(name='L2VPN 3', type='vpls'), # No RD + L2VPN(name='L2VPN 1', slug='l2vpn-1', type='vxlan', identifier=650001), + L2VPN(name='L2VPN 2', slug='l2vpn-2', type='vpws', identifier=650002), + L2VPN(name='L2VPN 3', slug='l2vpn-3', type='vpls'), # No RD ) L2VPN.objects.bulk_create(l2vpns) class L2VPNTerminationTest(APIViewTestCases.APIViewTestCase): model = L2VPNTermination - brief_fields = ['display', 'id', 'l2vpn', 'assigned_object', 'assigned_object_id', 'assigned_object_type', 'url'] + brief_fields = ['display', 'id', 'l2vpn', 'url'] @classmethod def setUpTestData(cls): vlans = ( - VLAN(name='VLAN 1', vid=650001), - VLAN(name='VLAN 2', vid=650002), - VLAN(name='VLAN 3', vid=650003), - VLAN(name='VLAN 4', vid=650004), - VLAN(name='VLAN 5', vid=650005), - VLAN(name='VLAN 6', vid=650006), - VLAN(name='VLAN 7', vid=650007) + VLAN(name='VLAN 1', vid=651), + VLAN(name='VLAN 2', vid=652), + VLAN(name='VLAN 3', vid=653), + VLAN(name='VLAN 4', vid=654), + VLAN(name='VLAN 5', vid=655), + VLAN(name='VLAN 6', vid=656), + VLAN(name='VLAN 7', vid=657) ) VLAN.objects.bulk_create(vlans) @@ -986,24 +986,26 @@ class L2VPNTerminationTest(APIViewTestCases.APIViewTestCase): L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[2]) ) + L2VPNTermination.objects.bulk_create(l2vpnterminations) + cls.create_data = [ { - 'l2vpn': l2vpns[0], + 'l2vpn': l2vpns[0].pk, 'assigned_object_type': 'ipam.vlan', - 'assigned_object_id': vlans[3], + 'assigned_object_id': vlans[3].pk, }, { - 'l2vpn': l2vpns[0], + 'l2vpn': l2vpns[0].pk, 'assigned_object_type': 'ipam.vlan', - 'assigned_object_id': vlans[4], + 'assigned_object_id': vlans[4].pk, }, { - 'l2vpn': l2vpns[0], + 'l2vpn': l2vpns[0].pk, 'assigned_object_type': 'ipam.vlan', - 'assigned_object_id': vlans[5], + 'assigned_object_id': vlans[5].pk, }, ] cls.bulk_update_data = { - 'l2vpn': l2vpns[2] + 'l2vpn': l2vpns[2].pk } diff --git a/netbox/ipam/tests/test_filtersets.py b/netbox/ipam/tests/test_filtersets.py index c5cffc7dc..2b5fb0759 100644 --- a/netbox/ipam/tests/test_filtersets.py +++ b/netbox/ipam/tests/test_filtersets.py @@ -1465,8 +1465,7 @@ class ServiceTestCase(TestCase, ChangeLoggedFilterSetTests): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) -class L2VPNTest(TestCase, ChangeLoggedFilterSetTests): - # TODO: L2VPN Tests +class L2VPNTestCase(TestCase, ChangeLoggedFilterSetTests): queryset = L2VPN.objects.all() filterset = L2VPNFilterSet @@ -1480,20 +1479,8 @@ class L2VPNTest(TestCase, ChangeLoggedFilterSetTests): ) L2VPN.objects.bulk_create(l2vpns) - def test_created(self): - from datetime import date, date - pk_list = self.queryset.values_list('pk', flat=True)[:2] - print(pk_list) - self.queryset.filter(pk__in=pk_list).update(created=datetime(2021, 1, 1, 0, 0, 0, tzinfo=timezone.utc)) - params = {'created': '2021-01-01T00:00:00'} - fs = self.filterset({}, self.queryset).qs.all() - for res in fs: - print(f'{res.name}:{res.created}') - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) - -class L2VPNTerminationTest(TestCase, ChangeLoggedFilterSetTests): - # TODO: L2VPN Termination Tests +class L2VPNTerminationTestCase(TestCase, ChangeLoggedFilterSetTests): queryset = L2VPNTermination.objects.all() filterset = L2VPNTerminationFilterSet @@ -1511,22 +1498,24 @@ class L2VPNTerminationTest(TestCase, ChangeLoggedFilterSetTests): device_role=device_role, status='active' ) - interfaces = Interface.objects.bulk_create( - Interface(name='GigabitEthernet1/0/1', device=device, type='1000baset'), - Interface(name='GigabitEthernet1/0/2', device=device, type='1000baset'), - Interface(name='GigabitEthernet1/0/3', device=device, type='1000baset'), - Interface(name='GigabitEthernet1/0/4', device=device, type='1000baset'), - Interface(name='GigabitEthernet1/0/5', device=device, type='1000baset'), + + interfaces = ( + Interface(name='Interface 1', device=device, type='1000baset'), + Interface(name='Interface 2', device=device, type='1000baset'), + Interface(name='Interface 3', device=device, type='1000baset'), + Interface(name='Interface 4', device=device, type='1000baset'), + Interface(name='Interface 5', device=device, type='1000baset'), + Interface(name='Interface 6', device=device, type='1000baset') ) + Interface.objects.bulk_create(interfaces) + vlans = ( - VLAN(name='VLAN 1', vid=650001), - VLAN(name='VLAN 2', vid=650002), - VLAN(name='VLAN 3', vid=650003), - VLAN(name='VLAN 4', vid=650004), - VLAN(name='VLAN 5', vid=650005), - VLAN(name='VLAN 6', vid=650006), - VLAN(name='VLAN 7', vid=650007) + VLAN(name='VLAN 1', vid=651), + VLAN(name='VLAN 2', vid=652), + VLAN(name='VLAN 3', vid=653), + VLAN(name='VLAN 4', vid=654), + VLAN(name='VLAN 5', vid=655) ) VLAN.objects.bulk_create(vlans) @@ -1534,26 +1523,33 @@ class L2VPNTerminationTest(TestCase, ChangeLoggedFilterSetTests): l2vpns = ( L2VPN(name='L2VPN 1', type='vxlan', identifier=650001), L2VPN(name='L2VPN 2', type='vpws', identifier=650002), - L2VPN(name='L2VPN 3', type='vpls'), # No RD + L2VPN(name='L2VPN 3', type='vpls'), # No RD, ) L2VPN.objects.bulk_create(l2vpns) l2vpnterminations = ( L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[0]), - L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[1]), - L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[2]) + L2VPNTermination(l2vpn=l2vpns[1], assigned_object=vlans[1]), + L2VPNTermination(l2vpn=l2vpns[2], assigned_object=vlans[2]), + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=interfaces[0]), + L2VPNTermination(l2vpn=l2vpns[1], assigned_object=interfaces[1]), + L2VPNTermination(l2vpn=l2vpns[2], assigned_object=interfaces[2]), ) + L2VPNTermination.objects.bulk_create(l2vpnterminations) + def test_l2vpns(self): l2vpns = L2VPN.objects.all()[:2] params = {'l2vpn_id': [l2vpns[0].pk, l2vpns[1].pk]} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) params = {'l2vpn': ['L2VPN 1', 'L2VPN 2']} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) def test_interfaces(self): interfaces = Interface.objects.all()[:2] params = {'interface_id': [interfaces[0].pk, interfaces[1].pk]} + qs = self.filterset(params, self.queryset).qs + results = qs.all() self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) params = {'interface': ['Interface 1', 'Interface 2']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) diff --git a/netbox/ipam/tests/test_models.py b/netbox/ipam/tests/test_models.py index ce4643516..1b5fbadc3 100644 --- a/netbox/ipam/tests/test_models.py +++ b/netbox/ipam/tests/test_models.py @@ -2,8 +2,9 @@ from netaddr import IPNetwork, IPSet from django.core.exceptions import ValidationError from django.test import TestCase, override_settings +from dcim.models import Interface, Device, DeviceRole, DeviceType, Manufacturer, Site from ipam.choices import IPAddressRoleChoices, PrefixStatusChoices -from ipam.models import Aggregate, IPAddress, IPRange, Prefix, RIR, VLAN, VLANGroup, VRF +from ipam.models import Aggregate, IPAddress, IPRange, Prefix, RIR, VLAN, VLANGroup, VRF, L2VPN, L2VPNTermination class TestAggregate(TestCase): @@ -540,11 +541,75 @@ class TestVLANGroup(TestCase): self.assertEqual(vlangroup.get_next_available_vid(), 105) -class TestL2VPN(TestCase): - # TODO: L2VPN Tests - pass - - class TestL2VPNTermination(TestCase): - # TODO: L2VPN Termination Tests - pass + + @classmethod + def setUpTestData(cls): + + site = Site.objects.create(name='Site 1') + manufacturer = Manufacturer.objects.create(name='Manufacturer 1') + device_type = DeviceType.objects.create(model='Device Type 1', manufacturer=manufacturer) + device_role = DeviceRole.objects.create(name='Switch') + device = Device.objects.create( + name='Device 1', + site=site, + device_type=device_type, + device_role=device_role, + status='active' + ) + + interfaces = ( + Interface(name='Interface 1', device=device, type='1000baset'), + Interface(name='Interface 2', device=device, type='1000baset'), + Interface(name='Interface 3', device=device, type='1000baset'), + Interface(name='Interface 4', device=device, type='1000baset'), + Interface(name='Interface 5', device=device, type='1000baset'), + ) + + Interface.objects.bulk_create(interfaces) + + vlans = ( + VLAN(name='VLAN 1', vid=651), + VLAN(name='VLAN 2', vid=652), + VLAN(name='VLAN 3', vid=653), + VLAN(name='VLAN 4', vid=654), + VLAN(name='VLAN 5', vid=655), + VLAN(name='VLAN 6', vid=656), + VLAN(name='VLAN 7', vid=657) + ) + + VLAN.objects.bulk_create(vlans) + + l2vpns = ( + L2VPN(name='L2VPN 1', type='vxlan', identifier=650001), + L2VPN(name='L2VPN 2', type='vpws', identifier=650002), + L2VPN(name='L2VPN 3', type='vpls'), # No RD + ) + L2VPN.objects.bulk_create(l2vpns) + + l2vpnterminations = ( + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[0]), + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[1]), + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[2]) + ) + + L2VPNTermination.objects.bulk_create(l2vpnterminations) + + def test_duplicate_interface_terminations(self): + device = Device.objects.first() + interface = Interface.objects.filter(device=device).first() + l2vpn = L2VPN.objects.first() + + L2VPNTermination.objects.create(l2vpn=l2vpn, assigned_object=interface) + duplicate = L2VPNTermination(l2vpn=l2vpn, assigned_object=interface) + + self.assertRaises(ValidationError, duplicate.clean) + + def test_duplicate_vlan_terminations(self): + vlan = Interface.objects.first() + l2vpn = L2VPN.objects.first() + + L2VPNTermination.objects.create(l2vpn=l2vpn, assigned_object=vlan) + duplicate = L2VPNTermination(l2vpn=l2vpn, assigned_object=vlan) + self.assertRaises(ValidationError, duplicate.clean) + diff --git a/netbox/ipam/tests/test_views.py b/netbox/ipam/tests/test_views.py index 8d1b9bd1b..dd3733d4d 100644 --- a/netbox/ipam/tests/test_views.py +++ b/netbox/ipam/tests/test_views.py @@ -1,14 +1,18 @@ import datetime +from django.contrib.contenttypes.models import ContentType from django.test import override_settings from django.urls import reverse from netaddr import IPNetwork -from dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Site +from dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Site, Interface +from extras.choices import ObjectChangeActionChoices +from extras.models import ObjectChange from ipam.choices import * from ipam.models import * from tenancy.models import Tenant -from utilities.testing import ViewTestCases, create_tags +from users.models import ObjectPermission +from utilities.testing import ViewTestCases, create_tags, post_data class ASNTestCase(ViewTestCases.PrimaryObjectViewTestCase): @@ -749,10 +753,130 @@ class ServiceTestCase(ViewTestCases.PrimaryObjectViewTestCase): class L2VPNTestCase(ViewTestCases.PrimaryObjectViewTestCase): - # TODO: L2VPN Tests - pass + model = L2VPN + csv_data = ( + 'name,slug,type,identifier', + 'L2VPN 5,l2vpn-5,vxlan,456', + 'L2VPN 6,l2vpn-6,vxlan,444', + ) + bulk_edit_data = { + 'description': 'New Description', + } + + @classmethod + def setUpTestData(cls): + rts = ( + RouteTarget(name='64534:123'), + RouteTarget(name='64534:321') + ) + RouteTarget.objects.bulk_create(rts) + + l2vpns = ( + L2VPN(name='L2VPN 1', slug='l2vpn-1', type='vxlan', identifier='650001'), + L2VPN(name='L2VPN 2', slug='l2vpn-2', type='vxlan', identifier='650002'), + L2VPN(name='L2VPN 3', slug='l2vpn-3', type='vxlan', identifier='650003') + ) + + L2VPN.objects.bulk_create(l2vpns) + + cls.form_data = { + 'name': 'L2VPN 8', + 'slug': 'l2vpn-8', + 'type': 'vxlan', + 'identifier': 123, + 'description': 'Description', + 'import_targets': [rts[0].pk], + 'export_targets': [rts[1].pk] + } + + print(cls.form_data) -class L2VPNTerminationTestCase(ViewTestCases.PrimaryObjectViewTestCase): - # TODO: L2VPN Termination Tests - pass +class L2VPNTerminationTestCase( + ViewTestCases.GetObjectViewTestCase, + ViewTestCases.GetObjectChangelogViewTestCase, + ViewTestCases.CreateObjectViewTestCase, + ViewTestCases.EditObjectViewTestCase, + ViewTestCases.DeleteObjectViewTestCase, + ViewTestCases.ListObjectsViewTestCase, + ViewTestCases.BulkImportObjectsViewTestCase, + ViewTestCases.BulkDeleteObjectsViewTestCase, +): + + model = L2VPNTermination + + @classmethod + def setUpTestData(cls): + site = Site.objects.create(name='Site 1') + manufacturer = Manufacturer.objects.create(name='Manufacturer 1') + device_type = DeviceType.objects.create(model='Device Type 1', manufacturer=manufacturer) + device_role = DeviceRole.objects.create(name='Switch') + device = Device.objects.create( + name='Device 1', + site=site, + device_type=device_type, + device_role=device_role, + status='active' + ) + + interface = Interface.objects.create(name='Interface 1', device=device, type='1000baset') + l2vpn = L2VPN.objects.create(name='L2VPN 1', type='vxlan', identifier=650001) + l2vpn_vlans = L2VPN.objects.create(name='L2VPN 2', type='vxlan', identifier=650002) + + vlans = ( + VLAN(name='Vlan 1', vid=1001), + VLAN(name='Vlan 2', vid=1002), + VLAN(name='Vlan 3', vid=1003), + VLAN(name='Vlan 4', vid=1004), + VLAN(name='Vlan 5', vid=1005), + VLAN(name='Vlan 6', vid=1006) + ) + VLAN.objects.bulk_create(vlans) + + terminations = ( + L2VPNTermination(l2vpn=l2vpn, assigned_object=vlans[0]), + L2VPNTermination(l2vpn=l2vpn, assigned_object=vlans[1]), + L2VPNTermination(l2vpn=l2vpn, assigned_object=vlans[2]) + ) + L2VPNTermination.objects.bulk_create(terminations) + + cls.form_data = { + 'l2vpn': l2vpn.pk, + 'device': device.pk, + 'interface': interface.pk, + } + + cls.csv_data = ( + "l2vpn,vlan", + "L2VPN 2,Vlan 4", + "L2VPN 2,Vlan 5", + "L2VPN 2,Vlan 6", + ) + + cls.bulk_edit_data = {} + + # + # Custom assertions + # + + def assertInstanceEqual(self, instance, data, exclude=None, api=False): + """ + Override parent + """ + if exclude is None: + exclude = [] + + fields = [k for k in data.keys() if k not in exclude] + model_dict = self.model_to_dict(instance, fields=fields, api=api) + + # Omit any dictionary keys which are not instance attributes or have been excluded + relevant_data = { + k: v for k, v in data.items() if hasattr(instance, k) and k not in exclude + } + + # Handle relations on the model + for k, v in model_dict.items(): + if isinstance(v, object) and hasattr(v, 'first'): + model_dict[k] = v.first().pk + + self.assertDictEqual(model_dict, relevant_data) diff --git a/netbox/ipam/urls.py b/netbox/ipam/urls.py index 65a6b55ad..e00b0365f 100644 --- a/netbox/ipam/urls.py +++ b/netbox/ipam/urls.py @@ -201,6 +201,7 @@ urlpatterns = [ path('l2vpn-termination/', views.L2VPNTerminationListView.as_view(), name='l2vpntermination_list'), path('l2vpn-termination/add/', views.L2VPNTerminationEditView.as_view(), name='l2vpntermination_add'), path('l2vpn-termination/import/', views.L2VPNTerminationBulkImportView.as_view(), name='l2vpntermination_import'), + path('l2vpn-termination/edit/', views.L2VPNTerminationBulkEditView.as_view(), name='l2vpntermination_bulk_edit'), path('l2vpn-termination/delete/', views.L2VPNTerminationBulkDeleteView.as_view(), name='l2vpntermination_bulk_delete'), path('l2vpn-termination//', views.L2VPNTerminationView.as_view(), name='l2vpntermination'), path('l2vpn-termination//edit/', views.L2VPNTerminationEditView.as_view(), name='l2vpntermination_edit'), diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 77539434c..35103be48 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -1141,6 +1141,13 @@ class ServiceBulkEditView(generic.BulkEditView): queryset = Service.objects.prefetch_related('device', 'virtual_machine') filterset = filtersets.ServiceFilterSet table = tables.ServiceTable + form = forms.ServiceBulkEditForm + + +class ServiceBulkDeleteView(generic.BulkDeleteView): + queryset = Service.objects.prefetch_related('device', 'virtual_machine') + filterset = filtersets.ServiceFilterSet + table = tables.ServiceTable # L2VPN @@ -1232,14 +1239,14 @@ class L2VPNTerminationBulkImportView(generic.BulkImportView): table = tables.L2VPNTerminationTable +class L2VPNTerminationBulkEditView(generic.BulkEditView): + queryset = L2VPNTermination.objects.all() + filterset = filtersets.L2VPNTerminationFilterSet + table = tables.L2VPNTerminationTable + form = forms.L2VPNTerminationBulkEditForm + + class L2VPNTerminationBulkDeleteView(generic.BulkDeleteView): queryset = L2VPNTermination.objects.all() filterset = filtersets.L2VPNTerminationFilterSet table = tables.L2VPNTerminationTable - form = forms.ServiceBulkEditForm - - -class ServiceBulkDeleteView(generic.BulkDeleteView): - queryset = Service.objects.prefetch_related('device', 'virtual_machine') - filterset = filtersets.ServiceFilterSet - table = tables.ServiceTable diff --git a/netbox/templates/dcim/interface.html b/netbox/templates/dcim/interface.html index e98750518..247592e14 100644 --- a/netbox/templates/dcim/interface.html +++ b/netbox/templates/dcim/interface.html @@ -104,6 +104,10 @@ LAG {{ object.lag|linkify|placeholder }} + + L2VPN + {{ object.l2vpn_termination.l2vpn|linkify|placeholder }} + diff --git a/netbox/templates/ipam/vlan.html b/netbox/templates/ipam/vlan.html index fd0ba36a3..53bb75b8f 100644 --- a/netbox/templates/ipam/vlan.html +++ b/netbox/templates/ipam/vlan.html @@ -64,6 +64,10 @@ Description {{ object.description|placeholder }} + + L2VPN + {{ object.l2vpn_termination.l2vpn|linkify|placeholder }} + From 6e983d154264b6af6586db01ef93586a7276261f Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 29 Jun 2022 16:14:30 -0500 Subject: [PATCH 187/593] Fix up some PEP errors --- netbox/ipam/api/nested_serializers.py | 1 - netbox/ipam/choices.py | 31 +++++++++++++-------------- netbox/ipam/tests/test_models.py | 1 - 3 files changed, 15 insertions(+), 18 deletions(-) diff --git a/netbox/ipam/api/nested_serializers.py b/netbox/ipam/api/nested_serializers.py index 39305a017..07a7c9598 100644 --- a/netbox/ipam/api/nested_serializers.py +++ b/netbox/ipam/api/nested_serializers.py @@ -218,4 +218,3 @@ class NestedL2VPNTerminationSerializer(WritableNestedSerializer): fields = [ 'id', 'url', 'display', 'l2vpn' ] - diff --git a/netbox/ipam/choices.py b/netbox/ipam/choices.py index a867b05bc..72cd4ff73 100644 --- a/netbox/ipam/choices.py +++ b/netbox/ipam/choices.py @@ -192,26 +192,25 @@ class L2VPNTypeChoices(ChoiceSet): (TYPE_VPLS, 'VPLS'), )), ('E-Line', ( - (TYPE_EPL, 'EPL'), - (TYPE_EVPL, 'EVPL'), - )), + (TYPE_EPL, 'EPL'), + (TYPE_EVPL, 'EVPL'), + )), ('E-LAN', ( - (TYPE_EPLAN, 'Ethernet Private LAN'), - (TYPE_EVPLAN, 'Ethernet Virtual Private LAN'), - )), + (TYPE_EPLAN, 'Ethernet Private LAN'), + (TYPE_EVPLAN, 'Ethernet Virtual Private LAN'), + )), ('E-Tree', ( - (TYPE_EPTREE, 'Ethernet Private Tree'), - (TYPE_EVPTREE, 'Ethernet Virtual Private Tree'), - )), + (TYPE_EPTREE, 'Ethernet Private Tree'), + (TYPE_EVPTREE, 'Ethernet Virtual Private Tree'), + )), ('VXLAN', ( - (TYPE_VXLAN, 'VXLAN'), - (TYPE_VXLAN_EVPN, 'VXLAN-EVPN'), - )), + (TYPE_VXLAN, 'VXLAN'), + (TYPE_VXLAN_EVPN, 'VXLAN-EVPN'), + )), ('L2VPN E-VPN', ( - (TYPE_MPLS_EVPN, 'MPLS EVPN'), - (TYPE_PBB_EVPN, 'PBB EVPN'), - )) - + (TYPE_MPLS_EVPN, 'MPLS EVPN'), + (TYPE_PBB_EVPN, 'PBB EVPN'), + )) ) P2P = ( diff --git a/netbox/ipam/tests/test_models.py b/netbox/ipam/tests/test_models.py index 1b5fbadc3..3bd7e8ccb 100644 --- a/netbox/ipam/tests/test_models.py +++ b/netbox/ipam/tests/test_models.py @@ -612,4 +612,3 @@ class TestL2VPNTermination(TestCase): L2VPNTermination.objects.create(l2vpn=l2vpn, assigned_object=vlan) duplicate = L2VPNTermination(l2vpn=l2vpn, assigned_object=vlan) self.assertRaises(ValidationError, duplicate.clean) - From dd6bfed565fc25f841f58bc3f70e339da37f69ba Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 29 Jun 2022 18:37:31 -0500 Subject: [PATCH 188/593] Add migration file --- .../0059_l2vpn_l2vpntermination_and_more.py | 62 +++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 netbox/ipam/migrations/0059_l2vpn_l2vpntermination_and_more.py diff --git a/netbox/ipam/migrations/0059_l2vpn_l2vpntermination_and_more.py b/netbox/ipam/migrations/0059_l2vpn_l2vpntermination_and_more.py new file mode 100644 index 000000000..a8e5ace25 --- /dev/null +++ b/netbox/ipam/migrations/0059_l2vpn_l2vpntermination_and_more.py @@ -0,0 +1,62 @@ +# Generated by Django 4.0.5 on 2022-06-28 04:57 + +import django.core.serializers.json +from django.db import migrations, models +import django.db.models.deletion +import taggit.managers + + +class Migration(migrations.Migration): + + dependencies = [ + ('contenttypes', '0002_remove_content_type_name'), + ('tenancy', '0007_contact_link'), + ('extras', '0076_configcontext_locations'), + ('ipam', '0058_ipaddress_nat_inside_nonunique'), + ] + + operations = [ + migrations.CreateModel( + name='L2VPN', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), + ('created', models.DateTimeField(auto_now_add=True, null=True)), + ('last_updated', models.DateTimeField(auto_now=True, null=True)), + ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), + ('name', models.CharField(max_length=100, unique=True)), + ('slug', models.SlugField()), + ('type', models.CharField(max_length=50)), + ('identifier', models.BigIntegerField(blank=True, null=True, unique=True)), + ('description', models.TextField(blank=True, null=True)), + ('export_targets', models.ManyToManyField(blank=True, related_name='exporting_l2vpns', to='ipam.routetarget')), + ('import_targets', models.ManyToManyField(blank=True, related_name='importing_l2vpns', to='ipam.routetarget')), + ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), + ('tenant', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='l2vpns', to='tenancy.tenant')), + ], + options={ + 'verbose_name': 'L2VPN', + 'ordering': ('identifier', 'name'), + }, + ), + migrations.CreateModel( + name='L2VPNTermination', + fields=[ + ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), + ('created', models.DateTimeField(auto_now_add=True, null=True)), + ('last_updated', models.DateTimeField(auto_now=True, null=True)), + ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), + ('assigned_object_id', models.PositiveBigIntegerField(blank=True, null=True)), + ('assigned_object_type', models.ForeignKey(blank=True, limit_choices_to=models.Q(models.Q(models.Q(('app_label', 'dcim'), ('model', 'interface')), models.Q(('app_label', 'ipam'), ('model', 'vlan')), models.Q(('app_label', 'virtualization'), ('model', 'vminterface')), _connector='OR')), null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='contenttypes.contenttype')), + ('l2vpn', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='terminations', to='ipam.l2vpn')), + ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), + ], + options={ + 'verbose_name': 'L2VPN Termination', + 'ordering': ('l2vpn',), + }, + ), + migrations.AddConstraint( + model_name='l2vpntermination', + constraint=models.UniqueConstraint(fields=('assigned_object_type', 'assigned_object_id'), name='ipam_l2vpntermination_assigned_object'), + ), + ] From fa014fcbf0aa03d7cdd822ff3aa38e2824773d48 Mon Sep 17 00:00:00 2001 From: Craig Pund Date: Thu, 30 Jun 2022 01:38:38 -0400 Subject: [PATCH 189/593] add device bulk rename view and url --- netbox/dcim/urls.py | 1 + netbox/dcim/views.py | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/netbox/dcim/urls.py b/netbox/dcim/urls.py index c5cd0fa65..f00bd73e1 100644 --- a/netbox/dcim/urls.py +++ b/netbox/dcim/urls.py @@ -248,6 +248,7 @@ urlpatterns = [ path('devices/import/', views.DeviceBulkImportView.as_view(), name='device_import'), path('devices/import/child-devices/', views.ChildDeviceBulkImportView.as_view(), name='device_import_child'), path('devices/edit/', views.DeviceBulkEditView.as_view(), name='device_bulk_edit'), + path('devices/rename/', views.DeviceBulkRenameView.as_view(), name='device_bulk_rename'), path('devices/delete/', views.DeviceBulkDeleteView.as_view(), name='device_bulk_delete'), path('devices//', views.DeviceView.as_view(), name='device'), path('devices//edit/', views.DeviceEditView.as_view(), name='device_edit'), diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 35a1056b2..28325bcfc 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -1786,6 +1786,12 @@ class DeviceBulkDeleteView(generic.BulkDeleteView): table = tables.DeviceTable +class DeviceBulkRenameView(generic.BulkRenameView): + queryset = Device.objects.prefetch_related('tenant', 'site', 'rack', 'device_role', 'device_type__manufacturer') + filterset = filtersets.DeviceFilterSet + table = tables.DeviceTable + + # # Devices # From 5dff7433e854a09cb876602ce8220f8f5479a80a Mon Sep 17 00:00:00 2001 From: Craig Pund Date: Thu, 30 Jun 2022 01:38:53 -0400 Subject: [PATCH 190/593] add bulk device rename button to device_list --- netbox/templates/dcim/device_list.html | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/netbox/templates/dcim/device_list.html b/netbox/templates/dcim/device_list.html index 60efc842e..e5dbe0d9c 100644 --- a/netbox/templates/dcim/device_list.html +++ b/netbox/templates/dcim/device_list.html @@ -2,6 +2,10 @@ {% block bulk_buttons %} {% if perms.dcim.change_device %} + +
    From 65f4895dd652e31e1e9f432dc549b669e7cdb339 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 30 Jun 2022 14:35:41 -0400 Subject: [PATCH 193/593] Add ActionsMixin to __all__ --- netbox/netbox/views/generic/mixins.py | 1 + 1 file changed, 1 insertion(+) diff --git a/netbox/netbox/views/generic/mixins.py b/netbox/netbox/views/generic/mixins.py index 4b3fa0740..8e363f0a5 100644 --- a/netbox/netbox/views/generic/mixins.py +++ b/netbox/netbox/views/generic/mixins.py @@ -3,6 +3,7 @@ from collections import defaultdict from utilities.permissions import get_permission_for_model __all__ = ( + 'ActionsMixin', 'TableMixin', ) From 3a6f46bf38e2a6f8fd8076620c8199311e0c6950 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 30 Jun 2022 15:15:07 -0400 Subject: [PATCH 194/593] Closes #9075: Introduce AbortRequest exception for cleanly interrupting object mutations --- docs/plugins/development/exceptions.md | 28 +++++++++++++ docs/release-notes/version-3.3.md | 1 + mkdocs.yml | 1 + netbox/netbox/api/viewsets/__init__.py | 9 ++++ netbox/netbox/views/generic/bulk_views.py | 46 +++++++++++---------- netbox/netbox/views/generic/object_views.py | 29 +++++++------ netbox/utilities/exceptions.py | 17 +++++++- 7 files changed, 95 insertions(+), 36 deletions(-) create mode 100644 docs/plugins/development/exceptions.md diff --git a/docs/plugins/development/exceptions.md b/docs/plugins/development/exceptions.md new file mode 100644 index 000000000..80f5db258 --- /dev/null +++ b/docs/plugins/development/exceptions.md @@ -0,0 +1,28 @@ +# Exceptions + +The exception classes listed here may be raised by a plugin to alter NetBox's default behavior in various scenarios. + +## `AbortRequest` + +NetBox provides several [generic views](./views.md) and [REST API viewsets](./rest-api.md) which facilitate the creation, modification, and deletion of objects, either individually or in bulk. Under certain conditions, it may be desirable for a plugin to interrupt these actions and cleanly abort the request, reporting an error message to the end user or API consumer. + +For example, a plugin may prohibit the creation of a site with a prohibited name by connecting a receiver to Django's `pre_save` signal for the Site model: + +```python +from django.db.models.signals import pre_save +from django.dispatch import receiver +from dcim.models import Site +from utilities.exceptions import AbortRequest + +PROHIBITED_NAMES = ('foo', 'bar', 'baz') + +@receiver(pre_save, sender=Site) +def test_abort_request(instance, **kwargs): + if instance.name.lower() in PROHIBITED_NAMES: + raise AbortRequest(f"Site name can't be {instance.name}!") +``` + +An error message must be supplied when raising `AbortRequest`. This will be conveyed to the user and should clearly explain the reason for which the request was aborted, as well as any potential remedy. + +!!! tip "Consider custom validation rules" + This exception is intended to be used for handling complex evaluation logic and should be used sparingly. For simple object validation (such as the contrived example above), consider using [custom validation rules](../../customization/custom-validation.md) instead. diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 62644f55f..a0abb81c4 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -35,6 +35,7 @@ ### Plugins API +* [#9075](https://github.com/netbox-community/netbox/issues/9075) - Introduce `AbortRequest` exception for cleanly interrupting object mutations * [#9092](https://github.com/netbox-community/netbox/issues/9092) - Add support for `ObjectChildrenView` generic view * [#9414](https://github.com/netbox-community/netbox/issues/9414) - Add `clone()` method to NetBoxModel for copying instance attributes diff --git a/mkdocs.yml b/mkdocs.yml index 507b25627..88a2794e8 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -118,6 +118,7 @@ nav: - REST API: 'plugins/development/rest-api.md' - GraphQL API: 'plugins/development/graphql-api.md' - Background Tasks: 'plugins/development/background-tasks.md' + - Exceptions: 'plugins/development/exceptions.md' - Administration: - Authentication: - Overview: 'administration/authentication/overview.md' diff --git a/netbox/netbox/api/viewsets/__init__.py b/netbox/netbox/api/viewsets/__init__.py index 462c07c6f..2d3780bde 100644 --- a/netbox/netbox/api/viewsets/__init__.py +++ b/netbox/netbox/api/viewsets/__init__.py @@ -11,6 +11,7 @@ from rest_framework.viewsets import ModelViewSet from extras.models import ExportTemplate from netbox.api.exceptions import SerializerNotFound from utilities.api import get_serializer_for_model +from utilities.exceptions import AbortRequest from .mixins import * __all__ = ( @@ -125,6 +126,14 @@ class NetBoxModelViewSet(BulkUpdateModelMixin, BulkDestroyModelMixin, ObjectVali *args, **kwargs ) + except AbortRequest as e: + logger.debug(e.message) + return self.finalize_response( + request, + Response({'detail': e.message}, status=400), + *args, + **kwargs + ) def list(self, request, *args, **kwargs): """ diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py index bb1c2b8e3..82244bcd2 100644 --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -1,6 +1,5 @@ import logging import re -from collections import defaultdict from copy import deepcopy from django.contrib import messages @@ -12,11 +11,12 @@ from django.forms import Form, ModelMultipleChoiceField, MultipleHiddenInput from django.http import HttpResponse from django.shortcuts import get_object_or_404, redirect, render from django_tables2.export import TableExport +from django.utils.safestring import mark_safe from extras.models import ExportTemplate from extras.signals import clear_webhooks from utilities.error_handlers import handle_protectederror -from utilities.exceptions import PermissionsViolation +from utilities.exceptions import AbortRequest, PermissionsViolation from utilities.forms import ( BootstrapMixin, BulkRenameForm, ConfirmationForm, CSVDataField, CSVFileField, restrict_form_fields, ) @@ -264,10 +264,10 @@ class BulkCreateView(GetReturnURLMixin, BaseMultiObjectView): except IntegrityError: pass - except PermissionsViolation: - msg = "Object creation failed due to object-level permissions violation" - logger.debug(msg) - form.add_error(None, msg) + except (AbortRequest, PermissionsViolation) as e: + logger.debug(e.message) + form.add_error(None, e.message) + clear_webhooks.send(sender=self) else: logger.debug("Form validation failed") @@ -392,10 +392,9 @@ class BulkImportView(GetReturnURLMixin, BaseMultiObjectView): except ValidationError: clear_webhooks.send(sender=self) - except PermissionsViolation: - msg = "Object import failed due to object-level permissions violation" - logger.debug(msg) - form.add_error(None, msg) + except (AbortRequest, PermissionsViolation) as e: + logger.debug(e.message) + form.add_error(None, e.message) clear_webhooks.send(sender=self) else: @@ -542,10 +541,9 @@ class BulkEditView(GetReturnURLMixin, BaseMultiObjectView): messages.error(self.request, ", ".join(e.messages)) clear_webhooks.send(sender=self) - except PermissionsViolation: - msg = "Object update failed due to object-level permissions violation" - logger.debug(msg) - form.add_error(None, msg) + except (AbortRequest, PermissionsViolation) as e: + logger.debug(e.message) + form.add_error(None, e.message) clear_webhooks.send(sender=self) else: @@ -639,10 +637,9 @@ class BulkRenameView(GetReturnURLMixin, BaseMultiObjectView): messages.success(request, f"Renamed {len(selected_objects)} {model_name}") return redirect(self.get_return_url(request)) - except PermissionsViolation: - msg = "Object update failed due to object-level permissions violation" - logger.debug(msg) - form.add_error(None, msg) + except (AbortRequest, PermissionsViolation) as e: + logger.debug(e.message) + form.add_error(None, e.message) clear_webhooks.send(sender=self) else: @@ -717,11 +714,17 @@ class BulkDeleteView(GetReturnURLMixin, BaseMultiObjectView): if hasattr(obj, 'snapshot'): obj.snapshot() obj.delete() + except ProtectedError as e: logger.info("Caught ProtectedError while attempting to delete objects") handle_protectederror(queryset, request, e) return redirect(self.get_return_url(request)) + except AbortRequest as e: + logger.debug(e.message) + messages.error(request, mark_safe(e.message)) + return redirect(self.get_return_url(request)) + msg = f"Deleted {deleted_count} {model._meta.verbose_name_plural}" logger.info(msg) messages.success(request, msg) @@ -829,10 +832,9 @@ class BulkComponentCreateView(GetReturnURLMixin, BaseMultiObjectView): except IntegrityError: clear_webhooks.send(sender=self) - except PermissionsViolation: - msg = "Component creation failed due to object-level permissions violation" - logger.debug(msg) - form.add_error(None, msg) + except (AbortRequest, PermissionsViolation) as e: + logger.debug(e.message) + form.add_error(None, e.message) clear_webhooks.send(sender=self) if not form.errors: diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index 82867b429..dc078a7e2 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -13,7 +13,7 @@ from django.utils.safestring import mark_safe from extras.signals import clear_webhooks from utilities.error_handlers import handle_protectederror -from utilities.exceptions import AbortTransaction, PermissionsViolation +from utilities.exceptions import AbortRequest, AbortTransaction, PermissionsViolation from utilities.forms import ConfirmationForm, ImportForm, restrict_form_fields from utilities.htmx import is_htmx from utilities.permissions import get_permission_for_model @@ -246,10 +246,9 @@ class ObjectImportView(GetReturnURLMixin, BaseObjectView): except AbortTransaction: clear_webhooks.send(sender=self) - except PermissionsViolation: - msg = "Object creation failed due to object-level permissions violation" - logger.debug(msg) - form.add_error(None, msg) + except (AbortRequest, PermissionsViolation) as e: + logger.debug(e.message) + form.add_error(None, e.message) clear_webhooks.send(sender=self) if not model_form.errors: @@ -410,10 +409,9 @@ class ObjectEditView(GetReturnURLMixin, BaseObjectView): return redirect(return_url) - except PermissionsViolation: - msg = "Object save failed due to object-level permissions violation" - logger.debug(msg) - form.add_error(None, msg) + except (AbortRequest, PermissionsViolation) as e: + logger.debug(e.message) + form.add_error(None, e.message) clear_webhooks.send(sender=self) else: @@ -489,11 +487,17 @@ class ObjectDeleteView(GetReturnURLMixin, BaseObjectView): try: obj.delete() + except ProtectedError as e: logger.info("Caught ProtectedError while attempting to delete object") handle_protectederror([obj], request, e) return redirect(obj.get_absolute_url()) + except AbortRequest as e: + logger.debug(e.message) + messages.error(request, mark_safe(e.message)) + return redirect(obj.get_absolute_url()) + msg = 'Deleted {} {}'.format(self.queryset.model._meta.verbose_name, obj) logger.info(msg) messages.success(request, msg) @@ -603,10 +607,9 @@ class ComponentCreateView(GetReturnURLMixin, BaseObjectView): else: return redirect(self.get_return_url(request)) - except PermissionsViolation: - msg = "Component creation failed due to object-level permissions violation" - logger.debug(msg) - form.add_error(None, msg) + except (AbortRequest, PermissionsViolation) as e: + logger.debug(e.message) + form.add_error(None, e.message) clear_webhooks.send(sender=self) return render(request, self.template_name, { diff --git a/netbox/utilities/exceptions.py b/netbox/utilities/exceptions.py index 4ba62bc01..657e90745 100644 --- a/netbox/utilities/exceptions.py +++ b/netbox/utilities/exceptions.py @@ -1,6 +1,13 @@ from rest_framework import status from rest_framework.exceptions import APIException +__all__ = ( + 'AbortRequest', + 'AbortTransaction', + 'PermissionsViolation', + 'RQWorkerNotRunningException', +) + class AbortTransaction(Exception): """ @@ -9,12 +16,20 @@ class AbortTransaction(Exception): pass +class AbortRequest(Exception): + """ + Raised to cleanly abort a request (for example, by a pre_save signal receiver). + """ + def __init__(self, message): + self.message = message + + class PermissionsViolation(Exception): """ Raised when an operation was prevented because it would violate the allowed permissions. """ - pass + message = "Operation failed due to object-level permissions violation" class RQWorkerNotRunningException(APIException): From 76e634330fe42209a29f03167c0983b6cb255765 Mon Sep 17 00:00:00 2001 From: Craig Pund Date: Thu, 30 Jun 2022 16:00:03 -0400 Subject: [PATCH 195/593] draft for error handling on device with no name --- netbox/netbox/views/generic/bulk_views.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py index 96efc0de7..f17bc179d 100644 --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -676,6 +676,9 @@ class BulkRenameView(GetReturnURLMixin, BaseMultiObjectView): else: form = self.form(initial={'pk': request.POST.getlist('pk')}) selected_objects = self.queryset.filter(pk__in=form.initial['pk']) + for object in selected_objects: + # Do something to raise error message to user + pass return render(request, self.template_name, { 'form': form, From be778353b7b97b779261f7c06aa9a3d823ff49e4 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 30 Jun 2022 17:13:26 -0400 Subject: [PATCH 196/593] #1099: Restore PoE fields on interface edit form --- netbox/templates/dcim/interface_edit.html | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/netbox/templates/dcim/interface_edit.html b/netbox/templates/dcim/interface_edit.html index ddda1ae31..d6fdfd0e1 100644 --- a/netbox/templates/dcim/interface_edit.html +++ b/netbox/templates/dcim/interface_edit.html @@ -72,6 +72,14 @@
    {% endif %} +
    +
    +
    Power over Ethernet (PoE)
    +
    + {% render_field form.poe_mode %} + {% render_field form.poe_type %} +
    +
    802.1Q Switching
    From 29f629156a4ed2136c002480d9cf6238e64b686c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 1 Jul 2022 11:36:34 -0400 Subject: [PATCH 197/593] Update NOTICE file --- NOTICE | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/NOTICE b/NOTICE index e6dc6408a..4e4dd600c 100644 --- a/NOTICE +++ b/NOTICE @@ -1 +1,7 @@ Copyrighted and licensed under Apache License 2.0 by DigitalOcean, LLC. + +This project contains code developed expressly for NetBox, and its reuse in +other projects may introduce issues affecting performance, data integrity, +and security. + +For more information, please see https://github.com/netbox-community/netbox. From c6dfdf10e5938e8ee7af18e31663023fb4b8390d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 1 Jul 2022 11:38:39 -0400 Subject: [PATCH 198/593] Introduce qs_filter_from_constraints() for constructing object permission QS filters --- netbox/netbox/authentication.py | 22 +++++++++------------- netbox/utilities/permissions.py | 24 ++++++++++++++++++++++++ netbox/utilities/querysets.py | 27 +++++++-------------------- 3 files changed, 40 insertions(+), 33 deletions(-) diff --git a/netbox/netbox/authentication.py b/netbox/netbox/authentication.py index 00fb3ee66..c16095fdc 100644 --- a/netbox/netbox/authentication.py +++ b/netbox/netbox/authentication.py @@ -9,7 +9,9 @@ from django.core.exceptions import ImproperlyConfigured from django.db.models import Q from users.models import ObjectPermission -from utilities.permissions import permission_is_exempt, resolve_permission, resolve_permission_ct +from utilities.permissions import ( + permission_is_exempt, qs_filter_from_constraints, resolve_permission, resolve_permission_ct, +) UserModel = get_user_model() @@ -99,8 +101,10 @@ class ObjectPermissionMixin: if not user_obj.is_active or user_obj.is_anonymous: return False + object_permissions = self.get_all_permissions(user_obj) + # If no applicable ObjectPermissions have been created for this user/permission, deny permission - if perm not in self.get_all_permissions(user_obj): + if perm not in object_permissions: return False # If no object has been specified, grant permission. (The presence of a permission in this set tells @@ -113,21 +117,13 @@ class ObjectPermissionMixin: if model._meta.label_lower != '.'.join((app_label, model_name)): raise ValueError(f"Invalid permission {perm} for model {model}") - # Compile a query filter that matches all instances of the specified model - obj_perm_constraints = self.get_all_permissions(user_obj)[perm] - constraints = Q() - for perm_constraints in obj_perm_constraints: - if perm_constraints: - constraints |= Q(**perm_constraints) - else: - # Found ObjectPermission with null constraints; allow model-level access - constraints = Q() - break + # Compile a QuerySet filter that matches all instances of the specified model + qs_filter = qs_filter_from_constraints(object_permissions[perm]) # Permission to perform the requested action on the object depends on whether the specified object matches # the specified constraints. Note that this check is made against the *database* record representing the object, # not the instance itself. - return model.objects.filter(constraints, pk=obj.pk).exists() + return model.objects.filter(qs_filter, pk=obj.pk).exists() class ObjectPermissionBackend(ObjectPermissionMixin, ModelBackend): diff --git a/netbox/utilities/permissions.py b/netbox/utilities/permissions.py index b11bf504a..123df9e45 100644 --- a/netbox/utilities/permissions.py +++ b/netbox/utilities/permissions.py @@ -1,5 +1,14 @@ from django.conf import settings from django.contrib.contenttypes.models import ContentType +from django.db.models import Q + +__all__ = ( + 'get_permission_for_model', + 'permission_is_exempt', + 'qs_filter_from_constraints', + 'resolve_permission', + 'resolve_permission_ct', +) def get_permission_for_model(model, action): @@ -69,3 +78,18 @@ def permission_is_exempt(name): return True return False + + +def qs_filter_from_constraints(constraints): + """ + Construct a Q filter object from an iterable of ObjectPermission constraints. + """ + params = Q() + for constraint in constraints: + if constraint: + params |= Q(**constraint) + else: + # Found null constraint; permit model-level access + return Q() + + return params diff --git a/netbox/utilities/querysets.py b/netbox/utilities/querysets.py index 97d2e8779..8ec6012bf 100644 --- a/netbox/utilities/querysets.py +++ b/netbox/utilities/querysets.py @@ -1,6 +1,6 @@ -from django.db.models import Q, QuerySet +from django.db.models import QuerySet -from utilities.permissions import permission_is_exempt +from utilities.permissions import permission_is_exempt, qs_filter_from_constraints class RestrictedQuerySet(QuerySet): @@ -28,23 +28,10 @@ class RestrictedQuerySet(QuerySet): # Filter the queryset to include only objects with allowed attributes else: - attrs = Q() - for perm_attrs in user._object_perm_cache[permission_required]: - if type(perm_attrs) is list: - for p in perm_attrs: - attrs |= Q(**p) - elif perm_attrs: - attrs |= Q(**perm_attrs) - else: - # Any permission with null constraints grants access to _all_ instances - attrs = Q() - break - else: - # for else, when no break - # avoid duplicates when JOIN on many-to-many fields without using DISTINCT. - # DISTINCT acts globally on the entire request, which may not be desirable. - allowed_objects = self.model.objects.filter(attrs) - attrs = Q(pk__in=allowed_objects) - qs = self.filter(attrs) + attrs = qs_filter_from_constraints(user._object_perm_cache[permission_required]) + # #8715: Avoid duplicates when JOIN on many-to-many fields without using DISTINCT. + # DISTINCT acts globally on the entire request, which may not be desirable. + allowed_objects = self.model.objects.filter(attrs) + qs = self.filter(pk__in=allowed_objects) return qs From 12c138b341faff6d2413c620488e124cbbacf8ec Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 1 Jul 2022 13:34:10 -0400 Subject: [PATCH 199/593] Closes #9074: Enable referencing the current user when evaluating permission constraints --- docs/administration/permissions.md | 2 +- docs/models/users/objectpermission.md | 14 ++++++++++++++ docs/release-notes/version-3.3.md | 2 ++ netbox/netbox/authentication.py | 6 +++++- netbox/users/admin/forms.py | 9 ++++++--- netbox/users/constants.py | 2 ++ netbox/utilities/permissions.py | 15 +++++++++++++-- netbox/utilities/querysets.py | 6 +++++- 8 files changed, 48 insertions(+), 8 deletions(-) diff --git a/docs/administration/permissions.md b/docs/administration/permissions.md index f859266af..60717c28a 100644 --- a/docs/administration/permissions.md +++ b/docs/administration/permissions.md @@ -4,7 +4,7 @@ NetBox v2.9 introduced a new object-based permissions framework, which replaces {!models/users/objectpermission.md!} -### Example Constraint Definitions +#### Example Constraint Definitions | Constraints | Description | | ----------- | ----------- | diff --git a/docs/models/users/objectpermission.md b/docs/models/users/objectpermission.md index 48970dd05..075a2cae5 100644 --- a/docs/models/users/objectpermission.md +++ b/docs/models/users/objectpermission.md @@ -53,3 +53,17 @@ To achieve a logical OR with a different set of constraints, define multiple obj ``` Additionally, where multiple permissions have been assigned for an object type, their collective constraints will be merged using a logical "OR" operation. + +### Tokens + +!!! info "This feature was introduced in NetBox v3.3" + +When defining a permission constraint, administrators may use the special token `$user` to reference the current user at the time of evaluation. This can be helpful to restrict users to editing only their own journal entries, for example. Such a constraint might be defined as: + +```json +{ + "created_by": "$user" +} +``` + +The `$user` token can be used only as a constraint value, or as an item within a list of values. It cannot be modified or extended to reference specific user attributes. diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index a0abb81c4..ea9e67a38 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -15,6 +15,8 @@ #### Restrict API Tokens by Client IP ([#8233](https://github.com/netbox-community/netbox/issues/8233)) +#### Reference User in Permission Constraints ([#9074](https://github.com/netbox-community/netbox/issues/9074)) + ### Enhancements * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses diff --git a/netbox/netbox/authentication.py b/netbox/netbox/authentication.py index c16095fdc..62512943e 100644 --- a/netbox/netbox/authentication.py +++ b/netbox/netbox/authentication.py @@ -8,6 +8,7 @@ from django.contrib.auth.models import Group, AnonymousUser from django.core.exceptions import ImproperlyConfigured from django.db.models import Q +from users.constants import CONSTRAINT_TOKEN_USER from users.models import ObjectPermission from utilities.permissions import ( permission_is_exempt, qs_filter_from_constraints, resolve_permission, resolve_permission_ct, @@ -118,7 +119,10 @@ class ObjectPermissionMixin: raise ValueError(f"Invalid permission {perm} for model {model}") # Compile a QuerySet filter that matches all instances of the specified model - qs_filter = qs_filter_from_constraints(object_permissions[perm]) + tokens = { + CONSTRAINT_TOKEN_USER: user_obj, + } + qs_filter = qs_filter_from_constraints(object_permissions[perm], tokens) # Permission to perform the requested action on the object depends on whether the specified object matches # the specified constraints. Note that this check is made against the *database* record representing the object, diff --git a/netbox/users/admin/forms.py b/netbox/users/admin/forms.py index bc3d44862..540735ecc 100644 --- a/netbox/users/admin/forms.py +++ b/netbox/users/admin/forms.py @@ -3,11 +3,11 @@ from django.contrib.auth.models import Group, User from django.contrib.admin.widgets import FilteredSelectMultiple from django.contrib.contenttypes.models import ContentType from django.core.exceptions import FieldError, ValidationError -from django.db.models import Q -from users.constants import OBJECTPERMISSION_OBJECT_TYPES +from users.constants import CONSTRAINT_TOKEN_USER, OBJECTPERMISSION_OBJECT_TYPES from users.models import ObjectPermission, Token from utilities.forms.fields import ContentTypeMultipleChoiceField +from utilities.permissions import qs_filter_from_constraints __all__ = ( 'GroupAdminForm', @@ -125,7 +125,10 @@ class ObjectPermissionForm(forms.ModelForm): for ct in object_types: model = ct.model_class() try: - model.objects.filter(*[Q(**c) for c in constraints]).exists() + tokens = { + CONSTRAINT_TOKEN_USER: 0, # Replace token with a null user ID + } + model.objects.filter(qs_filter_from_constraints(constraints, tokens)).exists() except FieldError as e: raise ValidationError({ 'constraints': f'Invalid filter for {model}: {e}' diff --git a/netbox/users/constants.py b/netbox/users/constants.py index e6917c482..1e6e7c71c 100644 --- a/netbox/users/constants.py +++ b/netbox/users/constants.py @@ -6,3 +6,5 @@ OBJECTPERMISSION_OBJECT_TYPES = Q( Q(app_label='auth', model__in=['group', 'user']) | Q(app_label='users', model__in=['objectpermission', 'token']) ) + +CONSTRAINT_TOKEN_USER = '$user' diff --git a/netbox/utilities/permissions.py b/netbox/utilities/permissions.py index 123df9e45..b20aafce0 100644 --- a/netbox/utilities/permissions.py +++ b/netbox/utilities/permissions.py @@ -80,14 +80,25 @@ def permission_is_exempt(name): return False -def qs_filter_from_constraints(constraints): +def qs_filter_from_constraints(constraints, tokens=None): """ Construct a Q filter object from an iterable of ObjectPermission constraints. + + Args: + tokens: A dictionary mapping string tokens to be replaced with a value. """ + if tokens is None: + tokens = {} + + def _replace_tokens(value, tokens): + if type(value) is list: + return list(map(lambda v: tokens.get(v, v), value)) + return tokens.get(value, value) + params = Q() for constraint in constraints: if constraint: - params |= Q(**constraint) + params |= Q(**{k: _replace_tokens(v, tokens) for k, v in constraint.items()}) else: # Found null constraint; permit model-level access return Q() diff --git a/netbox/utilities/querysets.py b/netbox/utilities/querysets.py index 8ec6012bf..955a10d64 100644 --- a/netbox/utilities/querysets.py +++ b/netbox/utilities/querysets.py @@ -1,5 +1,6 @@ from django.db.models import QuerySet +from users.constants import CONSTRAINT_TOKEN_USER from utilities.permissions import permission_is_exempt, qs_filter_from_constraints @@ -28,7 +29,10 @@ class RestrictedQuerySet(QuerySet): # Filter the queryset to include only objects with allowed attributes else: - attrs = qs_filter_from_constraints(user._object_perm_cache[permission_required]) + tokens = { + CONSTRAINT_TOKEN_USER: user, + } + attrs = qs_filter_from_constraints(user._object_perm_cache[permission_required], tokens) # #8715: Avoid duplicates when JOIN on many-to-many fields without using DISTINCT. # DISTINCT acts globally on the entire request, which may not be desirable. allowed_objects = self.model.objects.filter(attrs) From c11af40a061ac5346d7d44579dd2decad4826001 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 1 Jul 2022 13:52:37 -0400 Subject: [PATCH 200/593] prepare_cloned_fields() should always return a QueryDict --- netbox/utilities/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index 731b67e43..51c411004 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -286,7 +286,7 @@ def prepare_cloned_fields(instance): """ # Generate the clone attributes from the instance if not hasattr(instance, 'clone'): - return None + return QueryDict() attrs = instance.clone() # Prepare querydict parameters From a57398b0d678405d68f785f08d0e2a393eb21768 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 1 Jul 2022 14:45:22 -0400 Subject: [PATCH 201/593] Closes #9647: Introduce customfield_value template tag --- docs/plugins/development/templates.md | 2 ++ docs/release-notes/version-3.3.md | 1 + .../templates/inc/panels/custom_fields.html | 28 +------------------ .../templates/builtins/customfield_value.html | 27 ++++++++++++++++++ .../utilities/templatetags/builtins/tags.py | 15 ++++++++++ 5 files changed, 46 insertions(+), 27 deletions(-) create mode 100644 netbox/utilities/templates/builtins/customfield_value.html diff --git a/docs/plugins/development/templates.md b/docs/plugins/development/templates.md index 64616c442..20838149f 100644 --- a/docs/plugins/development/templates.md +++ b/docs/plugins/development/templates.md @@ -215,6 +215,8 @@ The following custom template tags are available in NetBox. ::: utilities.templatetags.builtins.tags.checkmark +::: utilities.templatetags.builtins.tags.customfield_value + ::: utilities.templatetags.builtins.tags.tag ## Filters diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index ea9e67a38..f5cb8eee1 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -40,6 +40,7 @@ * [#9075](https://github.com/netbox-community/netbox/issues/9075) - Introduce `AbortRequest` exception for cleanly interrupting object mutations * [#9092](https://github.com/netbox-community/netbox/issues/9092) - Add support for `ObjectChildrenView` generic view * [#9414](https://github.com/netbox-community/netbox/issues/9414) - Add `clone()` method to NetBoxModel for copying instance attributes +* [#9647](https://github.com/netbox-community/netbox/issues/9647) - Introduce `customfield_value` template tag ### Other Changes diff --git a/netbox/templates/inc/panels/custom_fields.html b/netbox/templates/inc/panels/custom_fields.html index b18d44030..90059447f 100644 --- a/netbox/templates/inc/panels/custom_fields.html +++ b/netbox/templates/inc/panels/custom_fields.html @@ -16,33 +16,7 @@ {{ field }} - {% if field.type == 'integer' and value is not None %} - {{ value }} - {% elif field.type == 'longtext' and value %} - {{ value|markdown }} - {% elif field.type == 'boolean' and value == True %} - {% checkmark value true="True" %} - {% elif field.type == 'boolean' and value == False %} - {% checkmark value false="False" %} - {% elif field.type == 'url' and value %} - {{ value|truncatechars:70 }} - {% elif field.type == 'json' and value %} - 
    {{ value|json }}
    - {% elif field.type == 'multiselect' and value %} - {{ value|join:", " }} - {% elif field.type == 'object' and value %} - {{ value|linkify }} - {% elif field.type == 'multiobject' and value %} - {% for obj in value %} - {{ obj|linkify }}{% if not forloop.last %}
    {% endif %} - {% endfor %} - {% elif value %} - {{ value }} - {% elif field.required %} - Not defined - {% else %} - {{ ''|placeholder }} - {% endif %} + {% customfield_value field value %} {% endfor %} diff --git a/netbox/utilities/templates/builtins/customfield_value.html b/netbox/utilities/templates/builtins/customfield_value.html new file mode 100644 index 000000000..8fedb03d5 --- /dev/null +++ b/netbox/utilities/templates/builtins/customfield_value.html @@ -0,0 +1,27 @@ +{% if field.type == 'integer' and value is not None %} + {{ value }} +{% elif field.type == 'longtext' and value %} + {{ value|markdown }} +{% elif field.type == 'boolean' and value == True %} + {% checkmark value true="True" %} +{% elif field.type == 'boolean' and value == False %} + {% checkmark value false="False" %} +{% elif field.type == 'url' and value %} + {{ value|truncatechars:70 }} +{% elif field.type == 'json' and value %} + 
    {{ value|json }}
    +{% elif field.type == 'multiselect' and value %} + {{ value|join:", " }} +{% elif field.type == 'object' and value %} + {{ value|linkify }} +{% elif field.type == 'multiobject' and value %} + {% for object in value %} + {{ object|linkify }}{% if not forloop.last %}
    {% endif %} + {% endfor %} +{% elif value %} + {{ value }} +{% elif field.required %} + Not defined +{% else %} + {{ ''|placeholder }} +{% endif %} diff --git a/netbox/utilities/templatetags/builtins/tags.py b/netbox/utilities/templatetags/builtins/tags.py index 666b6a31c..ed464b332 100644 --- a/netbox/utilities/templatetags/builtins/tags.py +++ b/netbox/utilities/templatetags/builtins/tags.py @@ -18,6 +18,21 @@ def tag(value, viewname=None): } +@register.inclusion_tag('builtins/customfield_value.html') +def customfield_value(customfield, value): + """ + Render a custom field value according to the field type. + + Args: + customfield: A CustomField instance + value: The custom field value applied to an object + """ + return { + 'customfield': customfield, + 'value': value, + } + + @register.inclusion_tag('builtins/badge.html') def badge(value, bg_color=None, show_empty=False): """ From a5124ab9c835896ff434812bf870d1add82a3afe Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 1 Jul 2022 15:10:31 -0400 Subject: [PATCH 202/593] Closes #8511: Enable custom fields and tags for circuit terminations --- docs/release-notes/version-3.3.md | 3 + netbox/circuits/api/serializers.py | 4 +- netbox/circuits/filtersets.py | 2 +- netbox/circuits/forms/models.py | 4 +- netbox/circuits/graphql/types.py | 3 +- ...7_circuittermination_tags_custom_fields.py | 24 +++ netbox/circuits/models/circuits.py | 13 +- netbox/templates/circuits/circuit.html | 140 +++++++++--------- .../circuits/circuittermination_edit.html | 8 + .../circuits/inc/circuit_termination.html | 33 ++++- 10 files changed, 155 insertions(+), 79 deletions(-) create mode 100644 netbox/circuits/migrations/0037_circuittermination_tags_custom_fields.py diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index f5cb8eee1..d158e6cf9 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -28,6 +28,7 @@ * [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping +* [#8511](https://github.com/netbox-community/netbox/issues/8511) - Enable custom fields and tags for circuit terminations * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results * [#9070](https://github.com/netbox-community/netbox/issues/9070) - Hide navigation menu items based on user permissions * [#9166](https://github.com/netbox-community/netbox/issues/9166) - Add UI visibility toggle for custom fields @@ -51,6 +52,8 @@ * circuits.Circuit * Added optional `termination_date` field +* circuits.CircuitTermination + * Added 'custom_fields' and 'tags' fields * dcim.Device * The `position` field has been changed from an integer to a decimal * dcim.DeviceType diff --git a/netbox/circuits/api/serializers.py b/netbox/circuits/api/serializers.py index 2bb3cd266..844cfce89 100644 --- a/netbox/circuits/api/serializers.py +++ b/netbox/circuits/api/serializers.py @@ -98,7 +98,7 @@ class CircuitSerializer(NetBoxModelSerializer): ] -class CircuitTerminationSerializer(ValidatedModelSerializer, LinkTerminationSerializer): +class CircuitTerminationSerializer(NetBoxModelSerializer, LinkTerminationSerializer): url = serializers.HyperlinkedIdentityField(view_name='circuits-api:circuittermination-detail') circuit = NestedCircuitSerializer() site = NestedSiteSerializer(required=False, allow_null=True) @@ -110,5 +110,5 @@ class CircuitTerminationSerializer(ValidatedModelSerializer, LinkTerminationSeri fields = [ 'id', 'url', 'display', 'circuit', 'term_side', 'site', 'provider_network', 'port_speed', 'upstream_speed', 'xconnect_id', 'pp_info', 'description', 'mark_connected', 'cable', 'link_peer', 'link_peer_type', - '_occupied', 'created', 'last_updated', + '_occupied', 'tags', 'custom_fields', 'created', 'last_updated', ] diff --git a/netbox/circuits/filtersets.py b/netbox/circuits/filtersets.py index 67a0d1b02..a74ff5c5a 100644 --- a/netbox/circuits/filtersets.py +++ b/netbox/circuits/filtersets.py @@ -198,7 +198,7 @@ class CircuitFilterSet(NetBoxModelFilterSet, TenancyFilterSet, ContactModelFilte ).distinct() -class CircuitTerminationFilterSet(ChangeLoggedModelFilterSet, CableTerminationFilterSet): +class CircuitTerminationFilterSet(NetBoxModelFilterSet, CableTerminationFilterSet): q = django_filters.CharFilter( method='search', label='Search', diff --git a/netbox/circuits/forms/models.py b/netbox/circuits/forms/models.py index 907c39586..7bd7abbbf 100644 --- a/netbox/circuits/forms/models.py +++ b/netbox/circuits/forms/models.py @@ -116,7 +116,7 @@ class CircuitForm(TenancyForm, NetBoxModelForm): } -class CircuitTerminationForm(BootstrapMixin, forms.ModelForm): +class CircuitTerminationForm(NetBoxModelForm): provider = DynamicModelChoiceField( queryset=Provider.objects.all(), required=False, @@ -161,7 +161,7 @@ class CircuitTerminationForm(BootstrapMixin, forms.ModelForm): model = CircuitTermination fields = [ 'provider', 'circuit', 'term_side', 'region', 'site_group', 'site', 'provider_network', 'mark_connected', - 'port_speed', 'upstream_speed', 'xconnect_id', 'pp_info', 'description', + 'port_speed', 'upstream_speed', 'xconnect_id', 'pp_info', 'description', 'tags', ] help_texts = { 'port_speed': "Physical circuit speed", diff --git a/netbox/circuits/graphql/types.py b/netbox/circuits/graphql/types.py index 027b53203..094b78d07 100644 --- a/netbox/circuits/graphql/types.py +++ b/netbox/circuits/graphql/types.py @@ -1,4 +1,5 @@ from circuits import filtersets, models +from extras.graphql.mixins import CustomFieldsMixin, TagsMixin from netbox.graphql.types import ObjectType, OrganizationalObjectType, NetBoxObjectType __all__ = ( @@ -10,7 +11,7 @@ __all__ = ( ) -class CircuitTerminationType(ObjectType): +class CircuitTerminationType(CustomFieldsMixin, TagsMixin, ObjectType): class Meta: model = models.CircuitTermination diff --git a/netbox/circuits/migrations/0037_circuittermination_tags_custom_fields.py b/netbox/circuits/migrations/0037_circuittermination_tags_custom_fields.py new file mode 100644 index 000000000..c87bc4219 --- /dev/null +++ b/netbox/circuits/migrations/0037_circuittermination_tags_custom_fields.py @@ -0,0 +1,24 @@ +import django.core.serializers.json +from django.db import migrations, models +import taggit.managers + + +class Migration(migrations.Migration): + + dependencies = [ + ('extras', '0076_configcontext_locations'), + ('circuits', '0036_circuit_termination_date'), + ] + + operations = [ + migrations.AddField( + model_name='circuittermination', + name='custom_field_data', + field=models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder), + ), + migrations.AddField( + model_name='circuittermination', + name='tags', + field=taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag'), + ), + ] diff --git a/netbox/circuits/models/circuits.py b/netbox/circuits/models/circuits.py index 5df6f1b85..cf6ffc503 100644 --- a/netbox/circuits/models/circuits.py +++ b/netbox/circuits/models/circuits.py @@ -5,7 +5,9 @@ from django.urls import reverse from circuits.choices import * from dcim.models import LinkTermination -from netbox.models import ChangeLoggedModel, OrganizationalModel, NetBoxModel +from netbox.models import ( + ChangeLoggedModel, CustomFieldsMixin, CustomLinksMixin, OrganizationalModel, NetBoxModel, TagsMixin, +) from netbox.models.features import WebhooksMixin __all__ = ( @@ -141,7 +143,14 @@ class Circuit(NetBoxModel): return CircuitStatusChoices.colors.get(self.status) -class CircuitTermination(WebhooksMixin, ChangeLoggedModel, LinkTermination): +class CircuitTermination( + CustomFieldsMixin, + CustomLinksMixin, + TagsMixin, + WebhooksMixin, + ChangeLoggedModel, + LinkTermination +): circuit = models.ForeignKey( to='circuits.Circuit', on_delete=models.CASCADE, diff --git a/netbox/templates/circuits/circuit.html b/netbox/templates/circuits/circuit.html index a4c41f871..a11139032 100644 --- a/netbox/templates/circuits/circuit.html +++ b/netbox/templates/circuits/circuit.html @@ -8,74 +8,78 @@ {% endblock %} {% block content %} -
    -
    -
    -
    - Circuit -
    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    Provider{{ object.provider|linkify }}
    Circuit ID{{ object.cid }}
    Type{{ object.type|linkify }}
    Status{% badge object.get_status_display bg_color=object.get_status_color %}
    Tenant - {% if object.tenant.group %} - {{ object.tenant.group|linkify }} / - {% endif %} - {{ object.tenant|linkify|placeholder }} -
    Install Date{{ object.install_date|annotated_date|placeholder }}
    Termination Date{{ object.termination_date|annotated_date|placeholder }}
    Commit Rate{{ object.commit_rate|humanize_speed|placeholder }}
    Description{{ object.description|placeholder }}
    -
    +
    +
    +
    +
    Circuit
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Provider{{ object.provider|linkify }}
    Circuit ID{{ object.cid }}
    Type{{ object.type|linkify }}
    Status{% badge object.get_status_display bg_color=object.get_status_color %}
    Tenant + {% if object.tenant.group %} + {{ object.tenant.group|linkify }} / + {% endif %} + {{ object.tenant|linkify|placeholder }} +
    Install Date{{ object.install_date|annotated_date|placeholder }}
    Termination Date{{ object.termination_date|annotated_date|placeholder }}
    Commit Rate{{ object.commit_rate|humanize_speed|placeholder }}
    Description{{ object.description|placeholder }}
    - {% include 'inc/panels/custom_fields.html' %} - {% include 'inc/panels/tags.html' %} - {% include 'inc/panels/comments.html' %} - {% plugin_left_page object %} -
    -
    - {% include 'circuits/inc/circuit_termination.html' with termination=object.termination_a side='A' %} - {% include 'circuits/inc/circuit_termination.html' with termination=object.termination_z side='Z' %} - {% include 'inc/panels/contacts.html' %} - {% include 'inc/panels/image_attachments.html' %} - {% plugin_right_page object %} -
    -
    -
    -
    - {% plugin_full_width_page object %} +
    + {% include 'inc/panels/custom_fields.html' %} + {% include 'inc/panels/tags.html' %} + {% plugin_left_page object %}
    -
    +
    + {% include 'inc/panels/comments.html' %} + {% include 'inc/panels/contacts.html' %} + {% include 'inc/panels/image_attachments.html' %} + {% plugin_right_page object %} +
    +
    +
    +
    + {% include 'circuits/inc/circuit_termination.html' with termination=object.termination_a side='A' %} +
    +
    + {% include 'circuits/inc/circuit_termination.html' with termination=object.termination_z side='Z' %} +
    +
    +
    +
    + {% plugin_full_width_page object %} +
    +
    {% endblock %} diff --git a/netbox/templates/circuits/circuittermination_edit.html b/netbox/templates/circuits/circuittermination_edit.html index f8393f945..606e12b5e 100644 --- a/netbox/templates/circuits/circuittermination_edit.html +++ b/netbox/templates/circuits/circuittermination_edit.html @@ -10,6 +10,7 @@ {% render_field form.provider %} {% render_field form.circuit %} {% render_field form.term_side %} + {% render_field form.tags %} {% render_field form.mark_connected %} {% with providernetwork_tab_active=form.initial.provider_network %}
    @@ -47,6 +48,13 @@ {% render_field form.pp_info %} {% render_field form.description %}
    + +
    +
    +
    Custom Fields
    +
    + {% render_custom_fields form %} +
    {% endblock %} {# Override buttons block, 'Create & Add Another'/'_addanother' is not needed on a circuit. #} diff --git a/netbox/templates/circuits/inc/circuit_termination.html b/netbox/templates/circuits/inc/circuit_termination.html index b673cd4a3..f6bb377ec 100644 --- a/netbox/templates/circuits/inc/circuit_termination.html +++ b/netbox/templates/circuits/inc/circuit_termination.html @@ -2,7 +2,6 @@
    - Termination - {{ side }} Side
    {% if not termination and perms.circuits.add_circuittermination %} @@ -10,10 +9,10 @@ {% endif %} {% if termination and perms.circuits.change_circuittermination %} - + Edit - + Swap {% endif %} @@ -23,6 +22,7 @@ {% endif %}
    +
    Termination {{ side }}
    {% if termination %} @@ -110,6 +110,33 @@ Description {{ termination.description|placeholder }} + + Tags + + {% for tag in termination.tags.all %} + {% tag tag %} + {% empty %} + {{ ''|placeholder }} + {% endfor %} + + + {% for group_name, fields in termination.get_custom_fields_by_group.items %} + + + {{ group_name|default:"Custom Fields" }} + + + {% for field, value in fields.items %} + + + {{ field }} + + + {% customfield_value field value %} + + + {% endfor %} + {% endfor %} {% else %} None From 23f391c5b59d5e01321cf5b83e5337c45f9a09ac Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 1 Jul 2022 15:52:16 -0400 Subject: [PATCH 203/593] Closes #9228: Add serialize_object() method to ChangeLoggingMixin --- docs/release-notes/version-3.3.md | 1 + netbox/extras/webhooks.py | 13 ++++++++++--- netbox/netbox/models/features.py | 14 +++++++++++--- 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index d158e6cf9..0e3cfd35f 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -40,6 +40,7 @@ * [#9075](https://github.com/netbox-community/netbox/issues/9075) - Introduce `AbortRequest` exception for cleanly interrupting object mutations * [#9092](https://github.com/netbox-community/netbox/issues/9092) - Add support for `ObjectChildrenView` generic view +* [#9228](https://github.com/netbox-community/netbox/issues/9228) - Subclasses of `ChangeLoggingMixin` can override `serialize_object()` to control JSON serialization for change logging * [#9414](https://github.com/netbox-community/netbox/issues/9414) - Add `clone()` method to NetBoxModel for copying instance attributes * [#9647](https://github.com/netbox-community/netbox/issues/9647) - Introduce `customfield_value` template tag diff --git a/netbox/extras/webhooks.py b/netbox/extras/webhooks.py index d8739cb55..334539026 100644 --- a/netbox/extras/webhooks.py +++ b/netbox/extras/webhooks.py @@ -1,6 +1,5 @@ import hashlib import hmac -from collections import defaultdict from django.contrib.contenttypes.models import ContentType from django.utils import timezone @@ -27,10 +26,18 @@ def serialize_for_webhook(instance): def get_snapshots(instance, action): - return { + snapshots = { 'prechange': getattr(instance, '_prechange_snapshot', None), - 'postchange': serialize_object(instance) if action != ObjectChangeActionChoices.ACTION_DELETE else None, + 'postchange': None, } + if action != ObjectChangeActionChoices.ACTION_DELETE: + # Use model's serialize() method if defined; fall back to serialize_object + if hasattr(instance, 'serialize_object'): + snapshots['postchange'] = instance.serialize_object() + else: + snapshots['postchange'] = serialize_object(instance) + + return snapshots def generate_signature(request_body, secret): diff --git a/netbox/netbox/models/features.py b/netbox/netbox/models/features.py index 817da526b..6b2ee1f94 100644 --- a/netbox/netbox/models/features.py +++ b/netbox/netbox/models/features.py @@ -49,11 +49,19 @@ class ChangeLoggingMixin(models.Model): class Meta: abstract = True + def serialize_object(self): + """ + Return a JSON representation of the instance. Models can override this method to replace or extend the default + serialization logic provided by the `serialize_object()` utility function. + """ + return serialize_object(self) + def snapshot(self): """ - Save a snapshot of the object's current state in preparation for modification. + Save a snapshot of the object's current state in preparation for modification. The snapshot is saved as + `_prechange_snapshot` on the instance. """ - self._prechange_snapshot = serialize_object(self) + self._prechange_snapshot = self.serialize_object() def to_objectchange(self, action): """ @@ -69,7 +77,7 @@ class ChangeLoggingMixin(models.Model): if hasattr(self, '_prechange_snapshot'): objectchange.prechange_data = self._prechange_snapshot if action in (ObjectChangeActionChoices.ACTION_CREATE, ObjectChangeActionChoices.ACTION_UPDATE): - objectchange.postchange_data = serialize_object(self) + objectchange.postchange_data = self.serialize_object() return objectchange From 277c2ff8697ea85854bee0cb56a8964331331069 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 1 Jul 2022 16:36:24 -0400 Subject: [PATCH 204/593] Closes #8171: Populate next available address when cloning an IP --- docs/release-notes/version-3.3.md | 1 + netbox/ipam/models/ip.py | 28 ++++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 0e3cfd35f..92401c217 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -25,6 +25,7 @@ * [#5303](https://github.com/netbox-community/netbox/issues/5303) - A virtual machine may be assigned to a site and/or cluster * [#7120](https://github.com/netbox-community/netbox/issues/7120) - Add `termination_date` field to Circuit * [#7744](https://github.com/netbox-community/netbox/issues/7744) - Add `status` field to Location +* [#8171](https://github.com/netbox-community/netbox/issues/8171) - Populate next available address when cloning an IP * [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster * [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping diff --git a/netbox/ipam/models/ip.py b/netbox/ipam/models/ip.py index db662f49c..0bc0e2364 100644 --- a/netbox/ipam/models/ip.py +++ b/netbox/ipam/models/ip.py @@ -857,6 +857,25 @@ class IPAddress(NetBoxModel): address__net_host=str(self.address.ip) ).exclude(pk=self.pk) + def get_next_available_ip(self): + """ + Return the next available IP address within this IP's network (if any) + """ + if self.address and self.address.broadcast: + start_ip = self.address.ip + 1 + end_ip = self.address.broadcast - 1 + if start_ip <= end_ip: + available_ips = netaddr.IPSet(netaddr.IPRange(start_ip, end_ip)) + available_ips -= netaddr.IPSet([ + address.ip for address in IPAddress.objects.filter( + vrf=self.vrf, + address__gt=self.address, + address__net_contained_or_equal=self.address.cidr + ).values_list('address', flat=True) + ]) + if available_ips: + return next(iter(available_ips)) + def clean(self): super().clean() @@ -907,6 +926,15 @@ class IPAddress(NetBoxModel): super().save(*args, **kwargs) + def clone(self): + attrs = super().clone() + + # Populate the address field with the next available IP (if any) + if next_available_ip := self.get_next_available_ip(): + attrs['address'] = next_available_ip + + return attrs + def to_objectchange(self, action): objectchange = super().to_objectchange(action) objectchange.related_object = self.assigned_object From 13f854c91f931c50192ce84dc3631d12cf0d5ad0 Mon Sep 17 00:00:00 2001 From: Pieter Lambrecht Date: Wed, 6 Jul 2022 14:10:10 +0200 Subject: [PATCH 205/593] Re-order journal list and form --- netbox/templates/extras/object_journal.html | 34 ++++++++++++--------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/netbox/templates/extras/object_journal.html b/netbox/templates/extras/object_journal.html index 363b067a8..0ed95d9eb 100644 --- a/netbox/templates/extras/object_journal.html +++ b/netbox/templates/extras/object_journal.html @@ -5,25 +5,29 @@ {% render_errors form %} {% block content %} - {% if perms.extras.add_journalentry %} -
    -
    -
    -

    New Journal Entry

    - {% csrf_token %} - {% render_form form %} -
    -
    - Cancel - -
    -
    -
    - {% endif %}
    {% render_table table 'inc/table.html' %} {% include 'inc/paginator.html' with paginator=table.paginator page=table.page %}
    + {% if perms.extras.add_journalentry %} +
    +
    +

    New Journal Entry

    +
    +
    +
    + {% csrf_token %} + {% render_form form %} +
    +
    + Cancel + +
    +
    +
    +
    +
    + {% endif %} {% endblock %} From b1729f212799a468184ddf65faedb14a4a9555c3 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Jul 2022 08:02:29 -0500 Subject: [PATCH 206/593] Change Virtual Circuits to L2VPN Co-authored-by: Jeremy Stretch --- netbox/ipam/api/serializers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index 36102f853..d331a0f7d 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -439,7 +439,7 @@ class ServiceSerializer(NetBoxModelSerializer): ] # -# Virtual Circuits +# L2VPN # From aa856e75e8897d8a4a32b571ae7f44521b0f8695 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Jul 2022 08:02:44 -0500 Subject: [PATCH 207/593] Change Virtual Circuits to L2VPN Co-authored-by: Jeremy Stretch --- netbox/ipam/api/nested_serializers.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/ipam/api/nested_serializers.py b/netbox/ipam/api/nested_serializers.py index 07a7c9598..e74d60fb2 100644 --- a/netbox/ipam/api/nested_serializers.py +++ b/netbox/ipam/api/nested_serializers.py @@ -195,7 +195,7 @@ class NestedServiceSerializer(WritableNestedSerializer): fields = ['id', 'url', 'display', 'name', 'protocol', 'ports'] # -# Virtual Circuits +# L2VPN # From 8e39e7f8306f96080d6d13ce829b4376402bc094 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Jul 2022 08:03:07 -0500 Subject: [PATCH 208/593] Change API urls to plural form Co-authored-by: Jeremy Stretch --- netbox/ipam/api/urls.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/ipam/api/urls.py b/netbox/ipam/api/urls.py index b588b6974..20e31f4d4 100644 --- a/netbox/ipam/api/urls.py +++ b/netbox/ipam/api/urls.py @@ -46,8 +46,8 @@ router.register('service-templates', views.ServiceTemplateViewSet) router.register('services', views.ServiceViewSet) # L2VPN -router.register('l2vpn', views.L2VPNViewSet) -router.register('l2vpn-termination', views.L2VPNTerminationViewSet) +router.register('l2vpns', views.L2VPNViewSet) +router.register('l2vpn-terminations', views.L2VPNTerminationViewSet) app_name = 'ipam-api' From dbb1773e158d3243bcbcf9a950ab266ac1fa7a1b Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Jul 2022 08:04:33 -0500 Subject: [PATCH 209/593] Remove extraneous imports Co-authored-by: Jeremy Stretch --- netbox/ipam/forms/models.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/netbox/ipam/forms/models.py b/netbox/ipam/forms/models.py index 7ef47ed2f..5f4b37729 100644 --- a/netbox/ipam/forms/models.py +++ b/netbox/ipam/forms/models.py @@ -8,8 +8,6 @@ from ipam.choices import * from ipam.constants import * from ipam.formfields import IPNetworkFormField from ipam.models import * -from ipam.models import ASN -from ipam.models.l2vpn import L2VPN, L2VPNTermination from netbox.forms import NetBoxModelForm from tenancy.forms import TenancyForm from tenancy.models import Tenant From 0004b834fb21230c0a494d262138495fd9bc03d3 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Jul 2022 08:17:50 -0500 Subject: [PATCH 210/593] Commit fixes Jeremy suggested Co-authored-by: Jeremy Stretch --- netbox/ipam/api/serializers.py | 1 - netbox/ipam/api/views.py | 4 ++-- netbox/ipam/forms/models.py | 3 +++ netbox/ipam/models/l2vpn.py | 12 ++++++++---- netbox/netbox/navigation_menu.py | 2 +- 5 files changed, 14 insertions(+), 8 deletions(-) diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index d331a0f7d..c6e0027f1 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -483,7 +483,6 @@ class L2VPNTerminationSerializer(NetBoxModelSerializer): fields = [ 'id', 'url', 'display', 'l2vpn', 'assigned_object_type', 'assigned_object_id', 'assigned_object', - # Extra Fields 'tags', 'custom_fields', 'created', 'last_updated' ] diff --git a/netbox/ipam/api/views.py b/netbox/ipam/api/views.py index f5a61c031..0407c6d39 100644 --- a/netbox/ipam/api/views.py +++ b/netbox/ipam/api/views.py @@ -18,7 +18,7 @@ from netbox.config import get_config from utilities.constants import ADVISORY_LOCK_KEYS from utilities.utils import count_related from . import serializers -from ..models.l2vpn import L2VPN, L2VPNTermination +from ipam.models import L2VPN, L2VPNTermination class IPAMRootView(APIRootView): @@ -159,7 +159,7 @@ class ServiceViewSet(NetBoxModelViewSet): class L2VPNViewSet(NetBoxModelViewSet): - queryset = L2VPN.objects + queryset = L2VPN.objects.prefetch_related('import_targets', 'export_targets', 'tenant', 'tags') serializer_class = serializers.L2VPNSerializer filterset_class = filtersets.L2VPNFilterSet diff --git a/netbox/ipam/forms/models.py b/netbox/ipam/forms/models.py index 5f4b37729..bd1dce6fd 100644 --- a/netbox/ipam/forms/models.py +++ b/netbox/ipam/forms/models.py @@ -893,6 +893,9 @@ class L2VPNForm(TenancyForm, NetBoxModelForm): fields = ( 'name', 'slug', 'type', 'identifier', 'description', 'import_targets', 'export_targets', 'tenant', 'tags' ) + widgets = { + 'type': StaticSelect(), + } class L2VPNTerminationForm(NetBoxModelForm): diff --git a/netbox/ipam/models/l2vpn.py b/netbox/ipam/models/l2vpn.py index b086fa109..46cad72f8 100644 --- a/netbox/ipam/models/l2vpn.py +++ b/netbox/ipam/models/l2vpn.py @@ -34,7 +34,7 @@ class L2VPN(NetBoxModel): description = models.TextField(null=True, blank=True) tenant = models.ForeignKey( to='tenancy.Tenant', - on_delete=models.SET_NULL, + on_delete=models.PROTECT, related_name='l2vpns', blank=True, null=True @@ -85,7 +85,6 @@ class L2VPNTermination(NetBoxModel): class Meta: ordering = ('l2vpn',) verbose_name = 'L2VPN Termination' - constraints = ( models.UniqueConstraint( fields=('assigned_object_type', 'assigned_object_id'), @@ -112,5 +111,10 @@ class L2VPNTermination(NetBoxModel): # Only check if L2VPN is set and is of type P2P if self.l2vpn and self.l2vpn.type in L2VPNTypeChoices.P2P: - if L2VPNTermination.objects.filter(l2vpn=self.l2vpn).exclude(pk=self.pk).count() >= 2: - raise ValidationError(f'P2P Type L2VPNs can only have 2 terminations; first delete a termination') + terminations_count = L2VPNTermination.objects.filter(l2vpn=self.l2vpn).exclude(pk=self.pk).count() + if terminations_count >= 2: + l2vpn_type = self.l2vpn.get_type_display() + raise ValidationError( + f'{l2vpn_type} L2VPNs cannot have more than two terminations; found {terminations_count} already ' + f'defined.' + ) diff --git a/netbox/netbox/navigation_menu.py b/netbox/netbox/navigation_menu.py index f2245f68b..513cf4d9e 100644 --- a/netbox/netbox/navigation_menu.py +++ b/netbox/netbox/navigation_menu.py @@ -263,7 +263,7 @@ IPAM_MENU = Menu( MenuGroup( label='L2VPNs', items=( - get_model_item('ipam', 'l2vpn', 'L2VPN'), + get_model_item('ipam', 'l2vpn', 'L2VPNs'), get_model_item('ipam', 'l2vpntermination', 'Terminations'), ), ), From 30350e3b40dbf699fd9d9ae1c8998e41dae2d6fb Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Jul 2022 08:57:15 -0500 Subject: [PATCH 211/593] More fixes as a result of code review --- netbox/ipam/api/serializers.py | 7 +--- netbox/ipam/choices.py | 16 ++++---- netbox/ipam/forms/models.py | 32 +++++++++++++-- netbox/ipam/models/l2vpn.py | 18 +++------ netbox/ipam/tables/l2vpn.py | 23 ++++++++++- netbox/ipam/urls.py | 40 +++++++++---------- .../templates/ipam/l2vpntermination_edit.html | 16 ++++++-- 7 files changed, 98 insertions(+), 54 deletions(-) diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index c6e0027f1..9cde08374 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -464,9 +464,7 @@ class L2VPNSerializer(NetBoxModelSerializer): model = L2VPN fields = [ 'id', 'url', 'display', 'identifier', 'name', 'slug', 'type', 'import_targets', 'export_targets', - 'description', 'tenant', - # Extra Fields - 'tags', 'custom_fields', 'created', 'last_updated' + 'description', 'tenant', 'tags', 'custom_fields', 'created', 'last_updated' ] @@ -482,8 +480,7 @@ class L2VPNTerminationSerializer(NetBoxModelSerializer): model = L2VPNTermination fields = [ 'id', 'url', 'display', 'l2vpn', 'assigned_object_type', 'assigned_object_id', - 'assigned_object', - 'tags', 'custom_fields', 'created', 'last_updated' + 'assigned_object', 'tags', 'custom_fields', 'created', 'last_updated' ] @swagger_serializer_method(serializer_or_field=serializers.DictField) diff --git a/netbox/ipam/choices.py b/netbox/ipam/choices.py index 72cd4ff73..298baa643 100644 --- a/netbox/ipam/choices.py +++ b/netbox/ipam/choices.py @@ -191,6 +191,14 @@ class L2VPNTypeChoices(ChoiceSet): (TYPE_VPWS, 'VPWS'), (TYPE_VPLS, 'VPLS'), )), + ('VXLAN', ( + (TYPE_VXLAN, 'VXLAN'), + (TYPE_VXLAN_EVPN, 'VXLAN-EVPN'), + )), + ('L2VPN E-VPN', ( + (TYPE_MPLS_EVPN, 'MPLS EVPN'), + (TYPE_PBB_EVPN, 'PBB EVPN'), + )), ('E-Line', ( (TYPE_EPL, 'EPL'), (TYPE_EVPL, 'EVPL'), @@ -203,14 +211,6 @@ class L2VPNTypeChoices(ChoiceSet): (TYPE_EPTREE, 'Ethernet Private Tree'), (TYPE_EVPTREE, 'Ethernet Virtual Private Tree'), )), - ('VXLAN', ( - (TYPE_VXLAN, 'VXLAN'), - (TYPE_VXLAN_EVPN, 'VXLAN-EVPN'), - )), - ('L2VPN E-VPN', ( - (TYPE_MPLS_EVPN, 'MPLS EVPN'), - (TYPE_PBB_EVPN, 'PBB EVPN'), - )) ) P2P = ( diff --git a/netbox/ipam/forms/models.py b/netbox/ipam/forms/models.py index bd1dce6fd..d2797c1cf 100644 --- a/netbox/ipam/forms/models.py +++ b/netbox/ipam/forms/models.py @@ -929,6 +929,20 @@ class L2VPNTerminationForm(NetBoxModelForm): } ) + virtual_machine = DynamicModelChoiceField( + queryset=VirtualMachine.objects.all(), + required=False, + query_params={} + ) + + vminterface = DynamicModelChoiceField( + queryset=VMInterface.objects.all(), + required=False, + query_params={ + 'virtual_machine_id': '$virtual_machine' + } + ) + class Meta: model = L2VPNTermination fields = ('l2vpn', ) @@ -943,6 +957,8 @@ class L2VPNTerminationForm(NetBoxModelForm): initial['interface'] = instance.assigned_object elif type(instance.assigned_object) is VLAN: initial['vlan'] = instance.assigned_object + elif type(instance.assigned_object) is VMInterface: + initial['vminterface'] = instance.assigned_object kwargs['initial'] = initial super().__init__(*args, **kwargs) @@ -950,11 +966,21 @@ class L2VPNTerminationForm(NetBoxModelForm): def clean(self): super().clean() - if not (self.cleaned_data.get('interface') or self.cleaned_data.get('vlan')): + interface = self.cleaned_data.get('interface') + vlan = self.cleaned_data.get('vlan') + vminterface = self.cleaned_data.get('vminterface') + + if not (interface or vlan or vminterface): raise ValidationError('You must have either a interface or a VLAN') - if self.cleaned_data.get('interface') and self.cleaned_data.get('vlan'): + if interface and vlan and vminterface: + raise ValidationError('Cannot assign a interface, vlan and vminterface') + elif interface and vlan: raise ValidationError('Cannot assign both a interface and vlan') + elif interface and vminterface: + raise ValidationError('Cannot assign both a interface and vminterface') + elif vlan and vminterface: + raise ValidationError('Cannot assign both a vlan and vminterface') - obj = self.cleaned_data.get('interface') or self.cleaned_data.get('vlan') + obj = interface or vlan or vminterface self.instance.assigned_object = obj diff --git a/netbox/ipam/models/l2vpn.py b/netbox/ipam/models/l2vpn.py index 46cad72f8..dd8c51984 100644 --- a/netbox/ipam/models/l2vpn.py +++ b/netbox/ipam/models/l2vpn.py @@ -60,23 +60,15 @@ class L2VPNTermination(NetBoxModel): l2vpn = models.ForeignKey( to='ipam.L2VPN', on_delete=models.CASCADE, - related_name='terminations', - blank=False, - null=False + related_name='terminations' ) - assigned_object_type = models.ForeignKey( to=ContentType, limit_choices_to=L2VPN_ASSIGNMENT_MODELS, on_delete=models.PROTECT, - related_name='+', - blank=True, - null=True - ) - assigned_object_id = models.PositiveBigIntegerField( - blank=True, - null=True + related_name='+' ) + assigned_object_id = models.PositiveBigIntegerField() assigned_object = GenericForeignKey( ct_field='assigned_object_type', fk_field='assigned_object_id' @@ -95,13 +87,13 @@ class L2VPNTermination(NetBoxModel): def __str__(self): if self.pk is not None: return f'{self.assigned_object} <> {self.l2vpn}' - return '' + return super().__str__() def get_absolute_url(self): return reverse('ipam:l2vpntermination', args=[self.pk]) def clean(self): - # Only check is assigned_object is set + # Only check is assigned_object is set. Required otherwise we have an Integrity Error thrown. if self.assigned_object: obj_id = self.assigned_object.pk obj_type = ContentType.objects.get_for_model(self.assigned_object) diff --git a/netbox/ipam/tables/l2vpn.py b/netbox/ipam/tables/l2vpn.py index 551f692bb..a0e2f5d67 100644 --- a/netbox/ipam/tables/l2vpn.py +++ b/netbox/ipam/tables/l2vpn.py @@ -9,25 +9,44 @@ __all__ = ( 'L2VPNTerminationTable', ) +L2VPN_TARGETS = """ +{% for rt in value.all %} + {{ rt }}{% if not forloop.last %}
    {% endif %} +{% endfor %} +""" + class L2VPNTable(NetBoxTable): pk = columns.ToggleColumn() name = tables.Column( linkify=True ) + import_targets = columns.TemplateColumn( + template_code=L2VPN_TARGETS, + orderable=False + ) + export_targets = columns.TemplateColumn( + template_code=L2VPN_TARGETS, + orderable=False + ) class Meta(NetBoxTable.Meta): model = L2VPN - fields = ('pk', 'name', 'description', 'slug', 'type', 'tenant', 'actions') - default_columns = ('pk', 'name', 'description', 'actions') + fields = ('pk', 'name', 'slug', 'type', 'description', 'import_targets', 'export_targets', 'tenant', 'actions') + default_columns = ('pk', 'name', 'type', 'description', 'actions') class L2VPNTerminationTable(NetBoxTable): pk = columns.ToggleColumn() + l2vpn = tables.Column( + verbose_name='L2VPN', + linkify=True + ) assigned_object_type = columns.ContentTypeColumn( verbose_name='Object Type' ) assigned_object = tables.Column( + verbose_name='Assigned Object', linkify=True, orderable=False ) diff --git a/netbox/ipam/urls.py b/netbox/ipam/urls.py index e00b0365f..d27209fd2 100644 --- a/netbox/ipam/urls.py +++ b/netbox/ipam/urls.py @@ -187,25 +187,25 @@ urlpatterns = [ path('services//journal/', ObjectJournalView.as_view(), name='service_journal', kwargs={'model': Service}), # L2VPN - path('l2vpn/', views.L2VPNListView.as_view(), name='l2vpn_list'), - path('l2vpn/add/', views.L2VPNEditView.as_view(), name='l2vpn_add'), - path('l2vpn/import/', views.L2VPNBulkImportView.as_view(), name='l2vpn_import'), - path('l2vpn/edit/', views.L2VPNBulkEditView.as_view(), name='l2vpn_bulk_edit'), - path('l2vpn/delete/', views.L2VPNBulkDeleteView.as_view(), name='l2vpn_bulk_delete'), - path('l2vpn//', views.L2VPNView.as_view(), name='l2vpn'), - path('l2vpn//edit/', views.L2VPNEditView.as_view(), name='l2vpn_edit'), - path('l2vpn//delete/', views.L2VPNDeleteView.as_view(), name='l2vpn_delete'), - path('l2vpn//changelog/', ObjectChangeLogView.as_view(), name='l2vpn_changelog', kwargs={'model': L2VPN}), - path('l2vpn//journal/', ObjectJournalView.as_view(), name='l2vpn_journal', kwargs={'model': L2VPN}), + path('l2vpns/', views.L2VPNListView.as_view(), name='l2vpn_list'), + path('l2vpns/add/', views.L2VPNEditView.as_view(), name='l2vpn_add'), + path('l2vpns/import/', views.L2VPNBulkImportView.as_view(), name='l2vpn_import'), + path('l2vpns/edit/', views.L2VPNBulkEditView.as_view(), name='l2vpn_bulk_edit'), + path('l2vpns/delete/', views.L2VPNBulkDeleteView.as_view(), name='l2vpn_bulk_delete'), + path('l2vpns//', views.L2VPNView.as_view(), name='l2vpn'), + path('l2vpns//edit/', views.L2VPNEditView.as_view(), name='l2vpn_edit'), + path('l2vpns//delete/', views.L2VPNDeleteView.as_view(), name='l2vpn_delete'), + path('l2vpns//changelog/', ObjectChangeLogView.as_view(), name='l2vpn_changelog', kwargs={'model': L2VPN}), + path('l2vpns//journal/', ObjectJournalView.as_view(), name='l2vpn_journal', kwargs={'model': L2VPN}), - path('l2vpn-termination/', views.L2VPNTerminationListView.as_view(), name='l2vpntermination_list'), - path('l2vpn-termination/add/', views.L2VPNTerminationEditView.as_view(), name='l2vpntermination_add'), - path('l2vpn-termination/import/', views.L2VPNTerminationBulkImportView.as_view(), name='l2vpntermination_import'), - path('l2vpn-termination/edit/', views.L2VPNTerminationBulkEditView.as_view(), name='l2vpntermination_bulk_edit'), - path('l2vpn-termination/delete/', views.L2VPNTerminationBulkDeleteView.as_view(), name='l2vpntermination_bulk_delete'), - path('l2vpn-termination//', views.L2VPNTerminationView.as_view(), name='l2vpntermination'), - path('l2vpn-termination//edit/', views.L2VPNTerminationEditView.as_view(), name='l2vpntermination_edit'), - path('l2vpn-termination//delete/', views.L2VPNTerminationDeleteView.as_view(), name='l2vpntermination_delete'), - path('l2vpn-termination//changelog/', ObjectChangeLogView.as_view(), name='l2vpntermination_changelog', kwargs={'model': L2VPNTermination}), - path('l2vpn-termination//journal/', ObjectJournalView.as_view(), name='l2vpntermination_journal', kwargs={'model': L2VPNTermination}), + path('l2vpn-terminations/', views.L2VPNTerminationListView.as_view(), name='l2vpntermination_list'), + path('l2vpn-terminations/add/', views.L2VPNTerminationEditView.as_view(), name='l2vpntermination_add'), + path('l2vpn-terminations/import/', views.L2VPNTerminationBulkImportView.as_view(), name='l2vpntermination_import'), + path('l2vpn-terminations/edit/', views.L2VPNTerminationBulkEditView.as_view(), name='l2vpntermination_bulk_edit'), + path('l2vpn-terminations/delete/', views.L2VPNTerminationBulkDeleteView.as_view(), name='l2vpntermination_bulk_delete'), + path('l2vpn-terminations//', views.L2VPNTerminationView.as_view(), name='l2vpntermination'), + path('l2vpn-terminations//edit/', views.L2VPNTerminationEditView.as_view(), name='l2vpntermination_edit'), + path('l2vpn-terminations//delete/', views.L2VPNTerminationDeleteView.as_view(), name='l2vpntermination_delete'), + path('l2vpn-terminations//changelog/', ObjectChangeLogView.as_view(), name='l2vpntermination_changelog', kwargs={'model': L2VPNTermination}), + path('l2vpn-terminations//journal/', ObjectJournalView.as_view(), name='l2vpntermination_journal', kwargs={'model': L2VPNTermination}), ] diff --git a/netbox/templates/ipam/l2vpntermination_edit.html b/netbox/templates/ipam/l2vpntermination_edit.html index 3fb0460b5..4ba079eb5 100644 --- a/netbox/templates/ipam/l2vpntermination_edit.html +++ b/netbox/templates/ipam/l2vpntermination_edit.html @@ -12,7 +12,7 @@
      @@ -21,18 +21,28 @@ Interface +
    - {% render_field form.device %} -
    +
    + {% render_field form.device %} {% render_field form.vlan %}
    + {% render_field form.device %} {% render_field form.interface %}
    +
    + {% render_field form.virtual_machine %} + {% render_field form.vminterface %} +
    From 5bcc3a3fb9636d0b24c42a46383dc964f01287e3 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Jul 2022 09:00:33 -0500 Subject: [PATCH 212/593] Update docs --- docs/models/ipam/l2vpn.md | 2 ++ docs/models/ipam/l2vpntermination.md | 5 ++++- netbox/ipam/forms/models.py | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/models/ipam/l2vpn.md b/docs/models/ipam/l2vpn.md index 9c50a6407..9f9b4703c 100644 --- a/docs/models/ipam/l2vpn.md +++ b/docs/models/ipam/l2vpn.md @@ -17,3 +17,5 @@ Each L2VPN instance must have one of the following type associated with it: * MPLS-EVPN * PBB-EVPN +!!!note + Choosing VPWS, EPL, EP-LAN, EP-TREE will result in only being able to add 2 terminations to a given L2VPN. diff --git a/docs/models/ipam/l2vpntermination.md b/docs/models/ipam/l2vpntermination.md index 9135f72a3..cc1843639 100644 --- a/docs/models/ipam/l2vpntermination.md +++ b/docs/models/ipam/l2vpntermination.md @@ -9,4 +9,7 @@ The following types of L2VPN's are considered point-to-point: * VPWS * EPL * EP-LAN -* EP-TREE \ No newline at end of file +* EP-TREE + +!!!note + Choosing any of the above types of L2VPN's will result in only being able to add 2 terminations to a given L2VPN. diff --git a/netbox/ipam/forms/models.py b/netbox/ipam/forms/models.py index d2797c1cf..43e33dd4d 100644 --- a/netbox/ipam/forms/models.py +++ b/netbox/ipam/forms/models.py @@ -976,7 +976,7 @@ class L2VPNTerminationForm(NetBoxModelForm): if interface and vlan and vminterface: raise ValidationError('Cannot assign a interface, vlan and vminterface') elif interface and vlan: - raise ValidationError('Cannot assign both a interface and vlan') + raise Validatio`nError('Cannot assign both a interface and vlan') elif interface and vminterface: raise ValidationError('Cannot assign both a interface and vminterface') elif vlan and vminterface: From f1c8926252e923589161ede1cc7b4cd6432806c1 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Jul 2022 09:01:08 -0500 Subject: [PATCH 213/593] Fix error --- netbox/ipam/forms/models.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/ipam/forms/models.py b/netbox/ipam/forms/models.py index 43e33dd4d..d2797c1cf 100644 --- a/netbox/ipam/forms/models.py +++ b/netbox/ipam/forms/models.py @@ -976,7 +976,7 @@ class L2VPNTerminationForm(NetBoxModelForm): if interface and vlan and vminterface: raise ValidationError('Cannot assign a interface, vlan and vminterface') elif interface and vlan: - raise Validatio`nError('Cannot assign both a interface and vlan') + raise ValidationError('Cannot assign both a interface and vlan') elif interface and vminterface: raise ValidationError('Cannot assign both a interface and vminterface') elif vlan and vminterface: From 878c465c56b5a656c4f99ebc9499d11274a7692e Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Wed, 6 Jul 2022 09:10:10 -0500 Subject: [PATCH 214/593] Update Termination table rendering on L2VPN View --- netbox/templates/ipam/l2vpn.html | 34 ++------------------------------ 1 file changed, 2 insertions(+), 32 deletions(-) diff --git a/netbox/templates/ipam/l2vpn.html b/netbox/templates/ipam/l2vpn.html index 59cc6234b..130940b02 100644 --- a/netbox/templates/ipam/l2vpn.html +++ b/netbox/templates/ipam/l2vpn.html @@ -59,39 +59,9 @@
    -
    L2VPN Terminations
    +
    Terminations
    - {% with terminations=object.terminations.all %} - {% if terminations.exists %} - - - - - - - {% for termination in terminations %} - - - - - - {% endfor %} -
    Termination TypeTermination
    {{ termination.assigned_object|meta:"verbose_name" }}{{ termination.assigned_object|linkify }} - {% if perms.ipam.change_l2vpntermination %} - - - - {% endif %} - {% if perms.ipam.delete_l2vpntermination %} - - - - {% endif %} -
    - {% else %} -
    None
    - {% endif %} - {% endwith %} + {% render_table terminations_table 'inc/table.html' %}
    {% if perms.ipam.add_l2vpntermination %}
    From 29a46d2c18091b48d9d99a51ba31e62b1c8063c7 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Jul 2022 12:46:26 -0400 Subject: [PATCH 215/593] Add support for VM interface termination via bulk import --- netbox/ipam/forms/bulk_import.py | 37 ++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/netbox/ipam/forms/bulk_import.py b/netbox/ipam/forms/bulk_import.py index 5b94f6c8e..b8dd1c54c 100644 --- a/netbox/ipam/forms/bulk_import.py +++ b/netbox/ipam/forms/bulk_import.py @@ -453,49 +453,58 @@ class L2VPNTerminationCSVForm(NetBoxModelCSVForm): to_field_name='name', label='L2VPN', ) - device = CSVModelChoiceField( queryset=Device.objects.all(), required=False, to_field_name='name', - help_text='Required if assigned to a interface' + help_text='Parent device (for interface)' ) - - interface = CSVModelChoiceField( - queryset=Interface.objects.all(), + virtual_machine = CSVModelChoiceField( + queryset=VirtualMachine.objects.all(), required=False, to_field_name='name', - help_text='Required if not assigned to a vlan' + help_text='Parent virtual machine (for interface)' + ) + interface = CSVModelChoiceField( + queryset=Interface.objects.none(), # Can also refer to VMInterface + required=False, + to_field_name='name', + help_text='Assigned interface (device or VM)' ) - vlan = CSVModelChoiceField( queryset=VLAN.objects.all(), required=False, to_field_name='name', - help_text='Required if not assigned to a interface' + help_text='Assigned VLAN' ) class Meta: model = L2VPNTermination - fields = ('l2vpn', 'device', 'interface', 'vlan') + fields = ('l2vpn', 'device', 'virtual_machine', 'interface', 'vlan') def __init__(self, data=None, *args, **kwargs): super().__init__(data, *args, **kwargs) + if data: - # Limit interface queryset by assigned device + + # Limit interface queryset by device or VM if data.get('device'): self.fields['interface'].queryset = Interface.objects.filter( **{f"device__{self.fields['device'].to_field_name}": data['device']} ) + elif data.get('virtual_machine'): + self.fields['interface'].queryset = VMInterface.objects.filter( + **{f"virtual_machine__{self.fields['virtual_machine'].to_field_name}": data['virtual_machine']} + ) def clean(self): super().clean() + if self.cleaned_data.get('device') and self.cleaned_data.get('virtual_machine'): + raise ValidationError('Cannot import device and VM interface terminations simultaneously.') if not (self.cleaned_data.get('interface') or self.cleaned_data.get('vlan')): - raise ValidationError('You must have either a interface or a VLAN') - + raise ValidationError('Each termination must specify either an interface or a VLAN.') if self.cleaned_data.get('interface') and self.cleaned_data.get('vlan'): - raise ValidationError('Cannot assign both a interface and vlan') + raise ValidationError('Cannot assign both an interface and a VLAN.') - # Set Assigned Object self.instance.assigned_object = self.cleaned_data.get('interface') or self.cleaned_data.get('vlan') From 4bb4bbce1461bee0644e97900006e3fe6d71a3e4 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Jul 2022 12:49:00 -0400 Subject: [PATCH 216/593] Clean up validation --- netbox/ipam/forms/models.py | 25 ++++++------------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/netbox/ipam/forms/models.py b/netbox/ipam/forms/models.py index d2797c1cf..3986eee32 100644 --- a/netbox/ipam/forms/models.py +++ b/netbox/ipam/forms/models.py @@ -906,13 +906,11 @@ class L2VPNTerminationForm(NetBoxModelForm): label='L2VPN', fetch_trigger='open' ) - device = DynamicModelChoiceField( queryset=Device.objects.all(), required=False, query_params={} ) - vlan = DynamicModelChoiceField( queryset=VLAN.objects.all(), required=False, @@ -920,7 +918,6 @@ class L2VPNTerminationForm(NetBoxModelForm): 'available_on_device': '$device' } ) - interface = DynamicModelChoiceField( queryset=Interface.objects.all(), required=False, @@ -928,13 +925,11 @@ class L2VPNTerminationForm(NetBoxModelForm): 'device_id': '$device' } ) - virtual_machine = DynamicModelChoiceField( queryset=VirtualMachine.objects.all(), required=False, query_params={} ) - vminterface = DynamicModelChoiceField( queryset=VMInterface.objects.all(), required=False, @@ -967,20 +962,12 @@ class L2VPNTerminationForm(NetBoxModelForm): super().clean() interface = self.cleaned_data.get('interface') - vlan = self.cleaned_data.get('vlan') vminterface = self.cleaned_data.get('vminterface') + vlan = self.cleaned_data.get('vlan') - if not (interface or vlan or vminterface): - raise ValidationError('You must have either a interface or a VLAN') + if not (interface or vminterface or vlan): + raise ValidationError('A termination must specify an interface or VLAN.') + if len([x for x in (interface, vminterface, vlan) if x]) > 1: + raise ValidationError('A termination can only have one terminating object (an interface or VLAN).') - if interface and vlan and vminterface: - raise ValidationError('Cannot assign a interface, vlan and vminterface') - elif interface and vlan: - raise ValidationError('Cannot assign both a interface and vlan') - elif interface and vminterface: - raise ValidationError('Cannot assign both a interface and vminterface') - elif vlan and vminterface: - raise ValidationError('Cannot assign both a vlan and vminterface') - - obj = interface or vlan or vminterface - self.instance.assigned_object = obj + self.instance.assigned_object = interface or vminterface or vlan From 1e1ce550c02e5b2e3761450252193bc6abadd82e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Jul 2022 12:53:10 -0400 Subject: [PATCH 217/593] Update L2VPN migration --- ...2vpn_l2vpntermination_and_more.py => 0059_l2vpn.py} | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) rename netbox/ipam/migrations/{0059_l2vpn_l2vpntermination_and_more.py => 0059_l2vpn.py} (83%) diff --git a/netbox/ipam/migrations/0059_l2vpn_l2vpntermination_and_more.py b/netbox/ipam/migrations/0059_l2vpn.py similarity index 83% rename from netbox/ipam/migrations/0059_l2vpn_l2vpntermination_and_more.py rename to netbox/ipam/migrations/0059_l2vpn.py index a8e5ace25..5662049c3 100644 --- a/netbox/ipam/migrations/0059_l2vpn_l2vpntermination_and_more.py +++ b/netbox/ipam/migrations/0059_l2vpn.py @@ -1,4 +1,4 @@ -# Generated by Django 4.0.5 on 2022-06-28 04:57 +# Generated by Django 4.0.5 on 2022-07-06 16:51 import django.core.serializers.json from django.db import migrations, models @@ -9,9 +9,9 @@ import taggit.managers class Migration(migrations.Migration): dependencies = [ + ('extras', '0076_configcontext_locations'), ('contenttypes', '0002_remove_content_type_name'), ('tenancy', '0007_contact_link'), - ('extras', '0076_configcontext_locations'), ('ipam', '0058_ipaddress_nat_inside_nonunique'), ] @@ -31,7 +31,7 @@ class Migration(migrations.Migration): ('export_targets', models.ManyToManyField(blank=True, related_name='exporting_l2vpns', to='ipam.routetarget')), ('import_targets', models.ManyToManyField(blank=True, related_name='importing_l2vpns', to='ipam.routetarget')), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), - ('tenant', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='l2vpns', to='tenancy.tenant')), + ('tenant', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.PROTECT, related_name='l2vpns', to='tenancy.tenant')), ], options={ 'verbose_name': 'L2VPN', @@ -45,8 +45,8 @@ class Migration(migrations.Migration): ('created', models.DateTimeField(auto_now_add=True, null=True)), ('last_updated', models.DateTimeField(auto_now=True, null=True)), ('custom_field_data', models.JSONField(blank=True, default=dict, encoder=django.core.serializers.json.DjangoJSONEncoder)), - ('assigned_object_id', models.PositiveBigIntegerField(blank=True, null=True)), - ('assigned_object_type', models.ForeignKey(blank=True, limit_choices_to=models.Q(models.Q(models.Q(('app_label', 'dcim'), ('model', 'interface')), models.Q(('app_label', 'ipam'), ('model', 'vlan')), models.Q(('app_label', 'virtualization'), ('model', 'vminterface')), _connector='OR')), null=True, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='contenttypes.contenttype')), + ('assigned_object_id', models.PositiveBigIntegerField()), + ('assigned_object_type', models.ForeignKey(limit_choices_to=models.Q(models.Q(models.Q(('app_label', 'dcim'), ('model', 'interface')), models.Q(('app_label', 'ipam'), ('model', 'vlan')), models.Q(('app_label', 'virtualization'), ('model', 'vminterface')), _connector='OR')), on_delete=django.db.models.deletion.PROTECT, related_name='+', to='contenttypes.contenttype')), ('l2vpn', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='terminations', to='ipam.l2vpn')), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), ], From 4d3278cb52500b1ff64a4d92e5eb5ddcd43f89c0 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Jul 2022 13:31:31 -0400 Subject: [PATCH 218/593] #8157: Clean up L2VPN assignment for VM interfaces --- netbox/dcim/api/serializers.py | 4 ++-- netbox/templates/ipam/l2vpntermination.html | 6 +++--- netbox/virtualization/api/serializers.py | 9 ++++++--- netbox/virtualization/models.py | 10 ++++++++++ 4 files changed, 21 insertions(+), 8 deletions(-) diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index fcee81615..4cb988c42 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -9,8 +9,8 @@ from dcim.choices import * from dcim.constants import * from dcim.models import * from ipam.api.nested_serializers import ( - NestedASNSerializer, NestedIPAddressSerializer, NestedVLANSerializer, NestedVRFSerializer, - NestedL2VPNTerminationSerializer, + NestedASNSerializer, NestedIPAddressSerializer, NestedL2VPNTerminationSerializer, NestedVLANSerializer, + NestedVRFSerializer, ) from ipam.models import ASN, VLAN from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField diff --git a/netbox/templates/ipam/l2vpntermination.html b/netbox/templates/ipam/l2vpntermination.html index 22e0cc324..b34d1a710 100644 --- a/netbox/templates/ipam/l2vpntermination.html +++ b/netbox/templates/ipam/l2vpntermination.html @@ -11,12 +11,12 @@
    - - + + - +
    L2vPN{{ object.l2vpn.name|placeholder }}L2VPN{{ object.l2vpn|linkify }}
    Assigned Object{{ object.assigned_object.name|placeholder }}{{ object.assigned_object|linkify }}
    diff --git a/netbox/virtualization/api/serializers.py b/netbox/virtualization/api/serializers.py index bd01b5533..c5816dca8 100644 --- a/netbox/virtualization/api/serializers.py +++ b/netbox/virtualization/api/serializers.py @@ -5,7 +5,9 @@ from dcim.api.nested_serializers import ( NestedDeviceSerializer, NestedDeviceRoleSerializer, NestedPlatformSerializer, NestedSiteSerializer, ) from dcim.choices import InterfaceModeChoices -from ipam.api.nested_serializers import NestedIPAddressSerializer, NestedVLANSerializer, NestedVRFSerializer +from ipam.api.nested_serializers import ( + NestedIPAddressSerializer, NestedL2VPNTerminationSerializer, NestedVLANSerializer, NestedVRFSerializer, +) from ipam.models import VLAN from netbox.api import ChoiceField, SerializedPKRelatedField from netbox.api.serializers import NetBoxModelSerializer @@ -121,6 +123,7 @@ class VMInterfaceSerializer(NetBoxModelSerializer): many=True ) vrf = NestedVRFSerializer(required=False, allow_null=True) + l2vpn_termination = NestedL2VPNTerminationSerializer(read_only=True) count_ipaddresses = serializers.IntegerField(read_only=True) count_fhrp_groups = serializers.IntegerField(read_only=True) @@ -128,8 +131,8 @@ class VMInterfaceSerializer(NetBoxModelSerializer): model = VMInterface fields = [ 'id', 'url', 'display', 'virtual_machine', 'name', 'enabled', 'parent', 'bridge', 'mtu', 'mac_address', - 'description', 'mode', 'untagged_vlan', 'tagged_vlans', 'vrf', 'tags', 'custom_fields', 'created', - 'last_updated', 'count_ipaddresses', 'count_fhrp_groups', + 'description', 'mode', 'untagged_vlan', 'tagged_vlans', 'vrf', 'l2vpn_termination', 'tags', 'custom_fields', + 'created', 'last_updated', 'count_ipaddresses', 'count_fhrp_groups', ] def validate(self, data): diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py index 02560a962..98321976f 100644 --- a/netbox/virtualization/models.py +++ b/netbox/virtualization/models.py @@ -440,6 +440,12 @@ class VMInterface(NetBoxModel, BaseInterface): object_id_field='interface_id', related_query_name='+' ) + l2vpn_terminations = GenericRelation( + to='ipam.L2VPNTermination', + content_type_field='assigned_object_type', + object_id_field='assigned_object_id', + related_query_name='vminterface', + ) class Meta: verbose_name = 'interface' @@ -498,3 +504,7 @@ class VMInterface(NetBoxModel, BaseInterface): @property def parent_object(self): return self.virtual_machine + + @property + def l2vpn_termination(self): + return self.l2vpn_terminations.first() From 78a3dfc5d97e1fb856116d7db7c31f1a85985f3a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Jul 2022 13:38:25 -0400 Subject: [PATCH 219/593] Changelog for #8157 --- docs/release-notes/version-3.3.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 92401c217..456afd765 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -13,6 +13,8 @@ #### PoE Interface Attributes ([#1099](https://github.com/netbox-community/netbox/issues/1099)) +#### L2VPN Modeling ([#8157](https://github.com/netbox-community/netbox/issues/8157)) + #### Restrict API Tokens by Client IP ([#8233](https://github.com/netbox-community/netbox/issues/8233)) #### Reference User in Permission Constraints ([#9074](https://github.com/netbox-community/netbox/issues/9074)) @@ -52,6 +54,9 @@ ### REST API Changes +* Added the following endpoints: + * `/api/ipam/l2vpns/` + * `/api/ipam/l2vpn-terminations/` * circuits.Circuit * Added optional `termination_date` field * circuits.CircuitTermination @@ -62,6 +67,7 @@ * The `u_height` field has been changed from an integer to a decimal * dcim.Interface * Added the optional `poe_mode` and `poe_type` fields + * Added the `l2vpn_termination` read-only field * dcim.Location * Added required `status` field (default value: `active`) * dcim.Rack @@ -73,15 +79,18 @@ * ipam.IPAddress * The `nat_inside` field no longer requires a unique value * The `nat_outside` field has changed from a single IP address instance to a list of multiple IP addresses +* ipam.VLAN + * Added the `l2vpn_termination` read-only field * users.Token * Added the `allowed_ips` array field * Added the read-only `last_used` datetime field * virtualization.Cluster * Added required `status` field (default value: `active`) * virtualization.VirtualMachine - * Added `device` field * The `site` field is now directly writable (rather than being inferred from the assigned cluster) * The `cluster` field is now optional. A virtual machine must have a site and/or cluster assigned. + * Added the `device` field + * Added the `l2vpn_termination` read-only field wireless.WirelessLAN * Added `tenant` field wireless.WirelessLink From af14bfdd84ada7a4a099e660fb666d7d9f6a6c84 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Jul 2022 15:56:10 -0400 Subject: [PATCH 220/593] Rename LinkTermination to CabledObjectModel --- netbox/circuits/api/serializers.py | 11 ++- netbox/circuits/models/circuits.py | 4 +- netbox/dcim/api/serializers.py | 98 ++++++++----------------- netbox/dcim/models/device_components.py | 20 ++--- netbox/dcim/models/power.py | 4 +- 5 files changed, 49 insertions(+), 88 deletions(-) diff --git a/netbox/circuits/api/serializers.py b/netbox/circuits/api/serializers.py index ab72ffcdd..6b09cd531 100644 --- a/netbox/circuits/api/serializers.py +++ b/netbox/circuits/api/serializers.py @@ -3,11 +3,11 @@ from rest_framework import serializers from circuits.choices import CircuitStatusChoices from circuits.models import * from dcim.api.nested_serializers import NestedCableSerializer, NestedSiteSerializer -from dcim.api.serializers import LinkTerminationSerializer +from dcim.api.serializers import CabledObjectSerializer from ipam.models import ASN from ipam.api.nested_serializers import NestedASNSerializer from netbox.api import ChoiceField, SerializedPKRelatedField -from netbox.api.serializers import NetBoxModelSerializer, ValidatedModelSerializer, WritableNestedSerializer +from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer from tenancy.api.nested_serializers import NestedTenantSerializer from .nested_serializers import * @@ -98,17 +98,16 @@ class CircuitSerializer(NetBoxModelSerializer): ] -class CircuitTerminationSerializer(NetBoxModelSerializer, LinkTerminationSerializer): +class CircuitTerminationSerializer(NetBoxModelSerializer, CabledObjectSerializer): url = serializers.HyperlinkedIdentityField(view_name='circuits-api:circuittermination-detail') circuit = NestedCircuitSerializer() site = NestedSiteSerializer(required=False, allow_null=True) provider_network = NestedProviderNetworkSerializer(required=False, allow_null=True) - cable = NestedCableSerializer(read_only=True) class Meta: model = CircuitTermination fields = [ 'id', 'url', 'display', 'circuit', 'term_side', 'site', 'provider_network', 'port_speed', 'upstream_speed', - 'xconnect_id', 'pp_info', 'description', 'mark_connected', 'cable', 'link_peers', 'link_peers_type', - '_occupied', 'tags', 'custom_fields', 'created', 'last_updated', + 'xconnect_id', 'pp_info', 'description', 'mark_connected', 'cable', 'cable_end', 'link_peers', + 'link_peers_type', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] diff --git a/netbox/circuits/models/circuits.py b/netbox/circuits/models/circuits.py index cf6ffc503..d82878cde 100644 --- a/netbox/circuits/models/circuits.py +++ b/netbox/circuits/models/circuits.py @@ -4,7 +4,7 @@ from django.db import models from django.urls import reverse from circuits.choices import * -from dcim.models import LinkTermination +from dcim.models import CabledObjectModel from netbox.models import ( ChangeLoggedModel, CustomFieldsMixin, CustomLinksMixin, OrganizationalModel, NetBoxModel, TagsMixin, ) @@ -149,7 +149,7 @@ class CircuitTermination( TagsMixin, WebhooksMixin, ChangeLoggedModel, - LinkTermination + CabledObjectModel ): circuit = models.ForeignKey( to='circuits.Circuit', diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 57b32bfc6..9938bb2e9 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -8,7 +8,6 @@ from timezone_field.rest_framework import TimeZoneSerializerField from dcim.choices import * from dcim.constants import * from dcim.models import * -from extras.api.serializers import ContentTypeSerializer from ipam.api.nested_serializers import ( NestedASNSerializer, NestedIPAddressSerializer, NestedL2VPNTerminationSerializer, NestedVLANSerializer, NestedVRFSerializer, @@ -29,7 +28,9 @@ from wireless.models import WirelessLAN from .nested_serializers import * -class LinkTerminationSerializer(serializers.ModelSerializer): +class CabledObjectSerializer(serializers.ModelSerializer): + cable = NestedCableSerializer(read_only=True) + cable_end = serializers.CharField(read_only=True) link_peers_type = serializers.SerializerMethodField(read_only=True) link_peers = serializers.SerializerMethodField(read_only=True) _occupied = serializers.SerializerMethodField(read_only=True) @@ -67,37 +68,6 @@ class LinkTerminationSerializer(serializers.ModelSerializer): return obj._occupied -# class ConnectedEndpointSerializer(serializers.ModelSerializer): -# """ -# Legacy serializer for pre-v3.3 connections -# """ -# connected_endpoint_type = serializers.SerializerMethodField(read_only=True) -# connected_endpoint = serializers.SerializerMethodField(read_only=True) -# connected_endpoint_reachable = serializers.SerializerMethodField(read_only=True) -# -# def get_connected_endpoint_type(self, obj): -# if obj._path is not None and obj._path.destination is not None: -# return f'{obj._path.destination._meta.app_label}.{obj._path.destination._meta.model_name}' -# return None -# -# @swagger_serializer_method(serializer_or_field=serializers.DictField) -# def get_connected_endpoint(self, obj): -# """ -# Return the appropriate serializer for the type of connected object. -# """ -# if obj._path is not None and obj._path.destination is not None: -# serializer = get_serializer_for_model(obj._path.destination, prefix='Nested') -# context = {'request': self.context['request']} -# return serializer(obj._path.destination, context=context).data -# return None -# -# @swagger_serializer_method(serializer_or_field=serializers.BooleanField) -# def get_connected_endpoint_reachable(self, obj): -# if obj._path is not None: -# return obj._path.is_active -# return None - - class ConnectedEndpointsSerializer(serializers.ModelSerializer): """ Legacy serializer for pre-v3.3 connections @@ -729,7 +699,7 @@ class DeviceNAPALMSerializer(serializers.Serializer): # Device components # -class ConsoleServerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): +class ConsoleServerPortSerializer(NetBoxModelSerializer, CabledObjectSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:consoleserverport-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -746,18 +716,18 @@ class ConsoleServerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializ allow_null=True, required=False ) - cable = NestedCableSerializer(read_only=True) class Meta: model = ConsoleServerPort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'speed', 'description', - 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'connected_endpoints', 'connected_endpoints_type', - 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', + 'mark_connected', 'cable', 'cable_end', 'link_peers', 'link_peers_type', 'connected_endpoints', + 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', + 'last_updated', '_occupied', ] -class ConsolePortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): +class ConsolePortSerializer(NetBoxModelSerializer, CabledObjectSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:consoleport-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -774,18 +744,18 @@ class ConsolePortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Co allow_null=True, required=False ) - cable = NestedCableSerializer(read_only=True) class Meta: model = ConsolePort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'speed', 'description', - 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'connected_endpoints', 'connected_endpoints_type', - 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', + 'mark_connected', 'cable', 'cable_end', 'link_peers', 'link_peers_type', 'connected_endpoints', + 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', + 'last_updated', '_occupied', ] -class PowerOutletSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): +class PowerOutletSerializer(NetBoxModelSerializer, CabledObjectSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:poweroutlet-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -806,21 +776,18 @@ class PowerOutletSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Co allow_blank=True, required=False ) - cable = NestedCableSerializer( - read_only=True - ) class Meta: model = PowerOutlet fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'power_port', 'feed_leg', - 'description', 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'connected_endpoints', - 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', - 'last_updated', '_occupied', + 'description', 'mark_connected', 'cable', 'cable_end', 'link_peers', 'link_peers_type', + 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', + 'created', 'last_updated', '_occupied', ] -class PowerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): +class PowerPortSerializer(NetBoxModelSerializer, CabledObjectSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:powerport-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -832,19 +799,18 @@ class PowerPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn allow_blank=True, required=False ) - cable = NestedCableSerializer(read_only=True) class Meta: model = PowerPort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'maximum_draw', 'allocated_draw', - 'description', 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'connected_endpoints', - 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', - 'last_updated', '_occupied', + 'description', 'mark_connected', 'cable', 'cable_end', 'link_peers', 'link_peers_type', + 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', + 'created', 'last_updated', '_occupied', ] -class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): +class InterfaceSerializer(NetBoxModelSerializer, CabledObjectSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:interface-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -870,7 +836,6 @@ class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn ) vrf = NestedVRFSerializer(required=False, allow_null=True) l2vpn_termination = NestedL2VPNTerminationSerializer(read_only=True) - cable = NestedCableSerializer(read_only=True) wireless_link = NestedWirelessLinkSerializer(read_only=True) wireless_lans = SerializedPKRelatedField( queryset=WirelessLAN.objects.all(), @@ -887,7 +852,7 @@ class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'enabled', 'parent', 'bridge', 'lag', 'mtu', 'mac_address', 'speed', 'duplex', 'wwn', 'mgmt_only', 'description', 'mode', 'rf_role', 'rf_channel', 'poe_mode', 'poe_type', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'untagged_vlan', - 'tagged_vlans', 'mark_connected', 'cable', 'wireless_link', 'link_peers', 'link_peers_type', + 'tagged_vlans', 'mark_connected', 'cable', 'cable_end', 'wireless_link', 'link_peers', 'link_peers_type', 'wireless_lans', 'vrf', 'l2vpn_termination', 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', 'created', 'last_updated', 'count_ipaddresses', 'count_fhrp_groups', '_occupied', @@ -907,7 +872,7 @@ class InterfaceSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn return super().validate(data) -class RearPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer): +class RearPortSerializer(NetBoxModelSerializer, CabledObjectSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:rearport-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -915,13 +880,12 @@ class RearPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer): allow_null=True ) type = ChoiceField(choices=PortTypeChoices) - cable = NestedCableSerializer(read_only=True) class Meta: model = RearPort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'color', 'positions', 'description', - 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'tags', 'custom_fields', 'created', + 'mark_connected', 'cable', 'cable_end', 'link_peers', 'link_peers_type', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] @@ -937,7 +901,7 @@ class FrontPortRearPortSerializer(WritableNestedSerializer): fields = ['id', 'url', 'display', 'name', 'label'] -class FrontPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer): +class FrontPortSerializer(NetBoxModelSerializer, CabledObjectSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:frontport-detail') device = NestedDeviceSerializer() module = ComponentNestedModuleSerializer( @@ -946,14 +910,13 @@ class FrontPortSerializer(NetBoxModelSerializer, LinkTerminationSerializer): ) type = ChoiceField(choices=PortTypeChoices) rear_port = FrontPortRearPortSerializer() - cable = NestedCableSerializer(read_only=True) class Meta: model = FrontPort fields = [ 'id', 'url', 'display', 'device', 'module', 'name', 'label', 'type', 'color', 'rear_port', - 'rear_port_position', 'description', 'mark_connected', 'cable', 'link_peers', 'link_peers_type', 'tags', - 'custom_fields', 'created', 'last_updated', '_occupied', + 'rear_port_position', 'description', 'mark_connected', 'cable', 'cable_end', 'link_peers', + 'link_peers_type', 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] @@ -1204,7 +1167,7 @@ class PowerPanelSerializer(NetBoxModelSerializer): ] -class PowerFeedSerializer(NetBoxModelSerializer, LinkTerminationSerializer, ConnectedEndpointsSerializer): +class PowerFeedSerializer(NetBoxModelSerializer, CabledObjectSerializer, ConnectedEndpointsSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:powerfeed-detail') power_panel = NestedPowerPanelSerializer() rack = NestedRackSerializer( @@ -1228,13 +1191,12 @@ class PowerFeedSerializer(NetBoxModelSerializer, LinkTerminationSerializer, Conn choices=PowerFeedPhaseChoices, default=PowerFeedPhaseChoices.PHASE_SINGLE ) - cable = NestedCableSerializer(read_only=True) class Meta: model = PowerFeed fields = [ 'id', 'url', 'display', 'power_panel', 'rack', 'name', 'status', 'type', 'supply', 'phase', 'voltage', - 'amperage', 'max_utilization', 'comments', 'mark_connected', 'cable', 'link_peers', 'link_peers_type', - 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', 'tags', 'custom_fields', - 'created', 'last_updated', '_occupied', + 'amperage', 'max_utilization', 'comments', 'mark_connected', 'cable', 'cable_end', 'link_peers', + 'link_peers_type', 'connected_endpoints', 'connected_endpoints_type', 'connected_endpoints_reachable', + 'tags', 'custom_fields', 'created', 'last_updated', '_occupied', ] diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 67af3a7f8..d54ad8384 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -3,7 +3,7 @@ from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ValidationError from django.core.validators import MaxValueValidator, MinValueValidator from django.db import models -from django.db.models import Q, Sum +from django.db.models import Sum from django.urls import reverse from mptt.models import MPTTModel, TreeForeignKey @@ -23,7 +23,7 @@ from wireless.utils import get_channel_attr __all__ = ( 'BaseInterface', - 'LinkTermination', + 'CabledObjectModel', 'ConsolePort', 'ConsoleServerPort', 'DeviceBay', @@ -103,7 +103,7 @@ class ModularComponentModel(ComponentModel): abstract = True -class LinkTermination(models.Model): +class CabledObjectModel(models.Model): """ An abstract model inherited by all models to which a Cable can terminate. """ @@ -237,7 +237,7 @@ class PathEndpoint(models.Model): # Console components # -class ConsolePort(ModularComponentModel, LinkTermination, PathEndpoint): +class ConsolePort(ModularComponentModel, CabledObjectModel, PathEndpoint): """ A physical console port within a Device. ConsolePorts connect to ConsoleServerPorts. """ @@ -264,7 +264,7 @@ class ConsolePort(ModularComponentModel, LinkTermination, PathEndpoint): return reverse('dcim:consoleport', kwargs={'pk': self.pk}) -class ConsoleServerPort(ModularComponentModel, LinkTermination, PathEndpoint): +class ConsoleServerPort(ModularComponentModel, CabledObjectModel, PathEndpoint): """ A physical port within a Device (typically a designated console server) which provides access to ConsolePorts. """ @@ -295,7 +295,7 @@ class ConsoleServerPort(ModularComponentModel, LinkTermination, PathEndpoint): # Power components # -class PowerPort(ModularComponentModel, LinkTermination, PathEndpoint): +class PowerPort(ModularComponentModel, CabledObjectModel, PathEndpoint): """ A physical power supply (intake) port within a Device. PowerPorts connect to PowerOutlets. """ @@ -400,7 +400,7 @@ class PowerPort(ModularComponentModel, LinkTermination, PathEndpoint): } -class PowerOutlet(ModularComponentModel, LinkTermination, PathEndpoint): +class PowerOutlet(ModularComponentModel, CabledObjectModel, PathEndpoint): """ A physical power outlet (output) within a Device which provides power to a PowerPort. """ @@ -512,7 +512,7 @@ class BaseInterface(models.Model): return self.fhrp_group_assignments.count() -class Interface(ModularComponentModel, BaseInterface, LinkTermination, PathEndpoint): +class Interface(ModularComponentModel, BaseInterface, CabledObjectModel, PathEndpoint): """ A network interface within a Device. A physical Interface can connect to exactly one other Interface. """ @@ -837,7 +837,7 @@ class Interface(ModularComponentModel, BaseInterface, LinkTermination, PathEndpo # Pass-through ports # -class FrontPort(ModularComponentModel, LinkTermination): +class FrontPort(ModularComponentModel, CabledObjectModel): """ A pass-through port on the front of a Device. """ @@ -890,7 +890,7 @@ class FrontPort(ModularComponentModel, LinkTermination): }) -class RearPort(ModularComponentModel, LinkTermination): +class RearPort(ModularComponentModel, CabledObjectModel): """ A pass-through port on the rear of a Device. """ diff --git a/netbox/dcim/models/power.py b/netbox/dcim/models/power.py index 5978d86bd..94767c6c4 100644 --- a/netbox/dcim/models/power.py +++ b/netbox/dcim/models/power.py @@ -9,7 +9,7 @@ from dcim.constants import * from netbox.config import ConfigItem from netbox.models import NetBoxModel from utilities.validators import ExclusionValidator -from .device_components import LinkTermination, PathEndpoint +from .device_components import CabledObjectModel, PathEndpoint __all__ = ( 'PowerFeed', @@ -67,7 +67,7 @@ class PowerPanel(NetBoxModel): ) -class PowerFeed(NetBoxModel, PathEndpoint, LinkTermination): +class PowerFeed(NetBoxModel, PathEndpoint, CabledObjectModel): """ An electrical circuit delivered from a PowerPanel. """ From 1beb8522b976d83935ee07f21ad6972f79eccd09 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 6 Jul 2022 16:02:53 -0400 Subject: [PATCH 221/593] #9102: Document API changes --- docs/release-notes/version-3.3.md | 84 ++++++++++++++++++++++++++++++- 1 file changed, 83 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 456afd765..e5f999048 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -6,6 +6,26 @@ * Device position and rack unit values are now reported as decimals (e.g. `1.0` or `1.5`) to support modeling half-height rack units. * The `nat_outside` relation on the IP address model now returns a list of zero or more related IP addresses, rather than a single instance (or None). +* Several fields on the cable API serializers have been altered to support multiple-object cable terminations: + +| Old Name | Old Type | New Name | New Type | +|----------------------|----------|-----------------------|----------| +| `termination_a_type` | string | `a_terminations_type` | string | +| `termination_b_type` | string | `b_terminations_type` | string | +| `termination_a_id` | integer | _Removed_ | - | +| `termination_b_id` | integer | _Removed_ | - | +| `termination_a` | object | `a_terminations` | list | +| `termination_b` | object | `b_terminations` | list | + +* As with the cable model, several API fields on all objects to which cables can be connected (interfaces, circuit terminations, etc.) have been changed: + +| Old Name | Old Type | New Name | New Type | +|--------------------------------|----------|---------------------------------|----------| +| `link_peer` | object | `link_peers` | list | +| `link_peer_type` | string | `link_peers_type` | string | +| `connected_endpoint` | object | `connected_endpoints` | list | +| `connected_endpoint_type` | string | `connected_endpoints_type` | string | +| `connected_endpoint_reachable` | boolean | `connected_endpoints_reachable` | boolean | ### New Features @@ -19,6 +39,8 @@ #### Reference User in Permission Constraints ([#9074](https://github.com/netbox-community/netbox/issues/9074)) +#### Multi-object Cable Terminations ([#9102](https://github.com/netbox-community/netbox/issues/9102)) + ### Enhancements * [#1202](https://github.com/netbox-community/netbox/issues/1202) - Support overlapping assignment of NAT IP addresses @@ -55,23 +77,83 @@ ### REST API Changes * Added the following endpoints: + * `/api/dcim/cable-terminations/` * `/api/ipam/l2vpns/` * `/api/ipam/l2vpn-terminations/` * circuits.Circuit * Added optional `termination_date` field * circuits.CircuitTermination - * Added 'custom_fields' and 'tags' fields + * `link_peer` has been renamed to `link_peers` and now returns a list of objects + * `link_peer_type` has been renamed to `link_peers_type` + * `connected_endpoint` has been renamed to `connected_endpoints` and now returns a list of objects + * `connected_endpoint_type` has been renamed to `connected_endpoints_type` + * `connected_endpoint_reachable` has been renamed to `connected_endpoints_reachable` + * Added `custom_fields` and `tags` fields +* dcim.Cable + * `termination_a_type` has been renamed to `a_terminations_type` + * `termination_b_type` has been renamed to `b_terminations_type` + * `termination_a` renamed to `a_terminations` and now returns a list of objects + * `termination_b` renamed to `b_terminations` and now returns a list of objects + * `termination_a_id` has been removed + * `termination_b_id` has been removed +* dcim.ConsolePort + * `link_peer` has been renamed to `link_peers` and now returns a list of objects + * `link_peer_type` has been renamed to `link_peers_type` + * `connected_endpoint` has been renamed to `connected_endpoints` and now returns a list of objects + * `connected_endpoint_type` has been renamed to `connected_endpoints_type` + * `connected_endpoint_reachable` has been renamed to `connected_endpoints_reachable` +* dcim.ConsoleServerPort + * `link_peer` has been renamed to `link_peers` and now returns a list of objects + * `link_peer_type` has been renamed to `link_peers_type` + * `connected_endpoint` has been renamed to `connected_endpoints` and now returns a list of objects + * `connected_endpoint_type` has been renamed to `connected_endpoints_type` + * `connected_endpoint_reachable` has been renamed to `connected_endpoints_reachable` * dcim.Device * The `position` field has been changed from an integer to a decimal * dcim.DeviceType * The `u_height` field has been changed from an integer to a decimal +* dcim.FrontPort + * `link_peer` has been renamed to `link_peers` and now returns a list of objects + * `link_peer_type` has been renamed to `link_peers_type` + * `connected_endpoint` has been renamed to `connected_endpoints` and now returns a list of objects + * `connected_endpoint_type` has been renamed to `connected_endpoints_type` + * `connected_endpoint_reachable` has been renamed to `connected_endpoints_reachable` * dcim.Interface + * `link_peer` has been renamed to `link_peers` and now returns a list of objects + * `link_peer_type` has been renamed to `link_peers_type` + * `connected_endpoint` has been renamed to `connected_endpoints` and now returns a list of objects + * `connected_endpoint_type` has been renamed to `connected_endpoints_type` + * `connected_endpoint_reachable` has been renamed to `connected_endpoints_reachable` * Added the optional `poe_mode` and `poe_type` fields * Added the `l2vpn_termination` read-only field * dcim.Location * Added required `status` field (default value: `active`) +* dcim.PowerOutlet + * `link_peer` has been renamed to `link_peers` and now returns a list of objects + * `link_peer_type` has been renamed to `link_peers_type` + * `connected_endpoint` has been renamed to `connected_endpoints` and now returns a list of objects + * `connected_endpoint_type` has been renamed to `connected_endpoints_type` + * `connected_endpoint_reachable` has been renamed to `connected_endpoints_reachable` +* dcim.PowerFeed + * `link_peer` has been renamed to `link_peers` and now returns a list of objects + * `link_peer_type` has been renamed to `link_peers_type` + * `connected_endpoint` has been renamed to `connected_endpoints` and now returns a list of objects + * `connected_endpoint_type` has been renamed to `connected_endpoints_type` + * `connected_endpoint_reachable` has been renamed to `connected_endpoints_reachable` +* dcim.PowerPort + * `link_peer` has been renamed to `link_peers` and now returns a list of objects + * `link_peer_type` has been renamed to `link_peers_type` + * `connected_endpoint` has been renamed to `connected_endpoints` and now returns a list of objects + * `connected_endpoint_type` has been renamed to `connected_endpoints_type` + * `connected_endpoint_reachable` has been renamed to `connected_endpoints_reachable` * dcim.Rack * The `elevation` endpoint now includes half-height rack units, and utilizes decimal values for the ID and name of each unit +* dcim.RearPort + * `link_peer` has been renamed to `link_peers` and now returns a list of objects + * `link_peer_type` has been renamed to `link_peers_type` + * `connected_endpoint` has been renamed to `connected_endpoints` and now returns a list of objects + * `connected_endpoint_type` has been renamed to `connected_endpoints_type` + * `connected_endpoint_reachable` has been renamed to `connected_endpoints_reachable` * extras.ConfigContext * Added the `locations` many-to-many field to track the assignment of ConfigContexts to Locations * extras.CustomField From 9a7f3f8c1a11ba429cf733b0f441df94dc14fdf9 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 7 Jul 2022 12:48:44 -0400 Subject: [PATCH 222/593] Cleanup for #9102 --- netbox/circuits/graphql/types.py | 3 +- netbox/dcim/api/serializers.py | 35 +++--- netbox/dcim/api/views.py | 34 +++--- netbox/dcim/choices.py | 2 +- netbox/dcim/graphql/mixins.py | 5 + netbox/dcim/graphql/types.py | 17 +-- .../migrations/0157_new_cabling_models.py | 2 +- netbox/dcim/models/cables.py | 103 ++++++++++-------- netbox/dcim/models/device_components.py | 32 +++--- netbox/dcim/models/racks.py | 6 +- netbox/dcim/signals.py | 4 +- netbox/dcim/tables/template_code.py | 26 ++--- netbox/dcim/tests/test_cablepaths.py | 13 ++- netbox/dcim/utils.py | 14 +-- netbox/dcim/views.py | 32 +++--- netbox/netbox/middleware.py | 4 +- netbox/netbox/views/__init__.py | 7 +- 17 files changed, 169 insertions(+), 170 deletions(-) create mode 100644 netbox/dcim/graphql/mixins.py diff --git a/netbox/circuits/graphql/types.py b/netbox/circuits/graphql/types.py index 094b78d07..e96fe98a5 100644 --- a/netbox/circuits/graphql/types.py +++ b/netbox/circuits/graphql/types.py @@ -1,4 +1,5 @@ from circuits import filtersets, models +from dcim.graphql.mixins import CabledObjectMixin from extras.graphql.mixins import CustomFieldsMixin, TagsMixin from netbox.graphql.types import ObjectType, OrganizationalObjectType, NetBoxObjectType @@ -11,7 +12,7 @@ __all__ = ( ) -class CircuitTerminationType(CustomFieldsMixin, TagsMixin, ObjectType): +class CircuitTerminationType(CustomFieldsMixin, TagsMixin, CabledObjectMixin, ObjectType): class Meta: model = models.CircuitTermination diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 9938bb2e9..53205e162 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -52,16 +52,13 @@ class CabledObjectSerializer(serializers.ModelSerializer): """ Return the appropriate serializer for the link termination model. """ - if not obj.cable: + if not obj.link_peers: return [] # Return serialized peer termination objects - if obj.link_peers: - serializer = get_serializer_for_model(obj.link_peers[0], prefix='Nested') - context = {'request': self.context['request']} - return serializer(obj.link_peers, context=context, many=True).data - - return [] + serializer = get_serializer_for_model(obj.link_peers[0], prefix='Nested') + context = {'request': self.context['request']} + return serializer(obj.link_peers, context=context, many=True).data @swagger_serializer_method(serializer_or_field=serializers.BooleanField) def get__occupied(self, obj): @@ -77,8 +74,7 @@ class ConnectedEndpointsSerializer(serializers.ModelSerializer): connected_endpoints_reachable = serializers.SerializerMethodField(read_only=True) def get_connected_endpoints_type(self, obj): - endpoints = obj.connected_endpoints - if endpoints: + if endpoints := obj.connected_endpoints: return f'{endpoints[0]._meta.app_label}.{endpoints[0]._meta.model_name}' @swagger_serializer_method(serializer_or_field=serializers.ListField) @@ -86,8 +82,7 @@ class ConnectedEndpointsSerializer(serializers.ModelSerializer): """ Return the appropriate serializer for the type of connected object. """ - endpoints = obj.connected_endpoints - if endpoints: + if endpoints := obj.connected_endpoints: serializer = get_serializer_for_model(endpoints[0], prefix='Nested') context = {'request': self.context['request']} return serializer(endpoints, many=True, context=context).data @@ -1016,15 +1011,15 @@ class CableSerializer(NetBoxModelSerializer): ] def _get_terminations_type(self, obj, side): - assert side.lower() in ('a', 'b') - terms = [t.termination for t in obj.terminations.all() if t.cable_end == side.upper()] + assert side in CableEndChoices.values() + terms = getattr(obj, f'get_{side.lower()}_terminations')() if terms: ct = ContentType.objects.get_for_model(terms[0]) return f"{ct.app_label}.{ct.model}" def _get_terminations(self, obj, side): - assert side.lower() in ('a', 'b') - terms = [t.termination for t in obj.terminations.all() if t.cable_end == side.upper()] + assert side in CableEndChoices.values() + terms = getattr(obj, f'get_{side.lower()}_terminations')() if not terms: return [] @@ -1037,19 +1032,19 @@ class CableSerializer(NetBoxModelSerializer): @swagger_serializer_method(serializer_or_field=serializers.CharField) def get_a_terminations_type(self, obj): - return self._get_terminations_type(obj, 'a') + return self._get_terminations_type(obj, CableEndChoices.SIDE_A) @swagger_serializer_method(serializer_or_field=serializers.CharField) def get_b_terminations_type(self, obj): - return self._get_terminations_type(obj, 'b') + return self._get_terminations_type(obj, CableEndChoices.SIDE_B) @swagger_serializer_method(serializer_or_field=serializers.DictField) def get_a_terminations(self, obj): - return self._get_terminations(obj, 'a') + return self._get_terminations(obj, CableEndChoices.SIDE_A) @swagger_serializer_method(serializer_or_field=serializers.DictField) def get_b_terminations(self, obj): - return self._get_terminations(obj, 'b') + return self._get_terminations(obj, CableEndChoices.SIDE_B) class TracedCableSerializer(serializers.ModelSerializer): @@ -1066,7 +1061,7 @@ class TracedCableSerializer(serializers.ModelSerializer): class CableTerminationSerializer(NetBoxModelSerializer): - url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cable-detail') + url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cabletermination-detail') termination_type = ContentTypeField( queryset=ContentType.objects.filter(CABLE_TERMINATION_MODELS) ) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index e6f7605ef..e71a6500d 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -15,6 +15,7 @@ from circuits.models import Circuit from dcim import filtersets from dcim.constants import CABLE_TRACE_SVG_DEFAULT_WIDTH from dcim.models import * +from dcim.svg import CableTraceSVG from extras.api.views import ConfigContextQuerySetMixin from ipam.models import Prefix, VLAN from netbox.api.authentication import IsAuthenticatedOrLoginNotRequired @@ -52,37 +53,30 @@ class PathEndpointMixin(object): # Initialize the path array path = [] + # Render SVG image if requested if request.GET.get('render', None) == 'svg': - # Render SVG try: width = int(request.GET.get('width', CABLE_TRACE_SVG_DEFAULT_WIDTH)) except (ValueError, TypeError): width = CABLE_TRACE_SVG_DEFAULT_WIDTH - drawing = obj.get_trace_svg( - base_url=request.build_absolute_uri('/'), - width=width - ) - return HttpResponse(drawing.tostring(), content_type='image/svg+xml') + drawing = CableTraceSVG(self, base_url=request.build_absolute_uri('/'), width=width) + return HttpResponse(drawing.render().tostring(), content_type='image/svg+xml') + # Serialize path objects, iterating over each three-tuple in the path for near_end, cable, far_end in obj.trace(): - if near_end is None: - # Split paths - break - - # Serialize each object - serializer_a = get_serializer_for_model(near_end[0], prefix='Nested') - x = serializer_a(near_end, many=True, context={'request': request}).data - if cable is not None: - y = serializers.TracedCableSerializer(cable[0], context={'request': request}).data + if near_end is not None: + serializer_a = get_serializer_for_model(near_end[0], prefix='Nested') + near_end = serializer_a(near_end, many=True, context={'request': request}).data else: - y = None + # Path is split; stop here + break + if cable is not None: + cable = serializers.TracedCableSerializer(cable[0], context={'request': request}).data if far_end is not None: serializer_b = get_serializer_for_model(far_end[0], prefix='Nested') - z = serializer_b(far_end, many=True, context={'request': request}).data - else: - z = None + far_end = serializer_b(far_end, many=True, context={'request': request}).data - path.append((x, y, z)) + path.append((near_end, cable, far_end)) return Response(path) diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index dbbc60a93..1a66312da 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -1294,7 +1294,7 @@ class CableEndChoices(ChoiceSet): CHOICES = ( (SIDE_A, 'A'), (SIDE_B, 'B'), - ('', ''), + # ('', ''), ) diff --git a/netbox/dcim/graphql/mixins.py b/netbox/dcim/graphql/mixins.py new file mode 100644 index 000000000..d8488aa5f --- /dev/null +++ b/netbox/dcim/graphql/mixins.py @@ -0,0 +1,5 @@ +class CabledObjectMixin: + + def resolve_cable_end(self, info): + # Handle empty values + return self.cable_end or None diff --git a/netbox/dcim/graphql/types.py b/netbox/dcim/graphql/types.py index 31589dae3..a43b293a4 100644 --- a/netbox/dcim/graphql/types.py +++ b/netbox/dcim/graphql/types.py @@ -7,6 +7,7 @@ from extras.graphql.mixins import ( from ipam.graphql.mixins import IPAddressesMixin, VLANGroupsMixin from netbox.graphql.scalars import BigInt from netbox.graphql.types import BaseObjectType, OrganizationalObjectType, NetBoxObjectType +from .mixins import CabledObjectMixin __all__ = ( 'CableType', @@ -107,7 +108,7 @@ class CableTerminationType(NetBoxObjectType): filterset_class = filtersets.CableTerminationFilterSet -class ConsolePortType(ComponentObjectType): +class ConsolePortType(ComponentObjectType, CabledObjectMixin): class Meta: model = models.ConsolePort @@ -129,7 +130,7 @@ class ConsolePortTemplateType(ComponentTemplateObjectType): return self.type or None -class ConsoleServerPortType(ComponentObjectType): +class ConsoleServerPortType(ComponentObjectType, CabledObjectMixin): class Meta: model = models.ConsoleServerPort @@ -211,7 +212,7 @@ class DeviceTypeType(NetBoxObjectType): return self.airflow or None -class FrontPortType(ComponentObjectType): +class FrontPortType(ComponentObjectType, CabledObjectMixin): class Meta: model = models.FrontPort @@ -227,7 +228,7 @@ class FrontPortTemplateType(ComponentTemplateObjectType): filterset_class = filtersets.FrontPortTemplateFilterSet -class InterfaceType(IPAddressesMixin, ComponentObjectType): +class InterfaceType(IPAddressesMixin, ComponentObjectType, CabledObjectMixin): class Meta: model = models.Interface @@ -330,7 +331,7 @@ class PlatformType(OrganizationalObjectType): filterset_class = filtersets.PlatformFilterSet -class PowerFeedType(NetBoxObjectType): +class PowerFeedType(NetBoxObjectType, CabledObjectMixin): class Meta: model = models.PowerFeed @@ -338,7 +339,7 @@ class PowerFeedType(NetBoxObjectType): filterset_class = filtersets.PowerFeedFilterSet -class PowerOutletType(ComponentObjectType): +class PowerOutletType(ComponentObjectType, CabledObjectMixin): class Meta: model = models.PowerOutlet @@ -374,7 +375,7 @@ class PowerPanelType(NetBoxObjectType): filterset_class = filtersets.PowerPanelFilterSet -class PowerPortType(ComponentObjectType): +class PowerPortType(ComponentObjectType, CabledObjectMixin): class Meta: model = models.PowerPort @@ -426,7 +427,7 @@ class RackRoleType(OrganizationalObjectType): filterset_class = filtersets.RackRoleFilterSet -class RearPortType(ComponentObjectType): +class RearPortType(ComponentObjectType, CabledObjectMixin): class Meta: model = models.RearPort diff --git a/netbox/dcim/migrations/0157_new_cabling_models.py b/netbox/dcim/migrations/0157_new_cabling_models.py index def63d8bd..e7c55997c 100644 --- a/netbox/dcim/migrations/0157_new_cabling_models.py +++ b/netbox/dcim/migrations/0157_new_cabling_models.py @@ -27,7 +27,7 @@ class Migration(migrations.Migration): ), migrations.AddConstraint( model_name='cabletermination', - constraint=models.UniqueConstraint(fields=('termination_type', 'termination_id'), name='unique_termination'), + constraint=models.UniqueConstraint(fields=('termination_type', 'termination_id'), name='dcim_cable_termination_unique_termination'), ), # Update CablePath model diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 8f31c77f2..cf9f6064d 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -1,3 +1,4 @@ +import itertools from collections import defaultdict from django.contrib.contenttypes.fields import GenericForeignKey @@ -11,15 +12,14 @@ from django.urls import reverse from dcim.choices import * from dcim.constants import * from dcim.fields import PathField -from dcim.utils import decompile_path_node, flatten_path, object_to_path_node, path_node_to_object +from dcim.utils import decompile_path_node, object_to_path_node, path_node_to_object from netbox.models import NetBoxModel from utilities.fields import ColorField from utilities.querysets import RestrictedQuerySet from utilities.utils import to_meters from wireless.models import WirelessLink -from .devices import Device from .device_components import FrontPort, RearPort - +from .devices import Device __all__ = ( 'Cable', @@ -110,7 +110,8 @@ class Cable(NetBoxModel): # Cache the original status so we can check later if it's been changed self._orig_status = self.status - # Assign associated CableTerminations (if any) + # Assign any *new* CableTerminations for the instance. These will replace any existing + # terminations on save(). if a_terminations is not None: self.a_terminations = a_terminations if b_terminations is not None: @@ -133,28 +134,25 @@ class Cable(NetBoxModel): self.length_unit = '' a_terminations = [ - CableTermination(cable=self, cable_end='A', termination=t) for t in getattr(self, 'a_terminations', []) + CableTermination(cable=self, cable_end='A', termination=t) + for t in getattr(self, 'a_terminations', []) ] b_terminations = [ - CableTermination(cable=self, cable_end='B', termination=t) for t in getattr(self, 'b_terminations', []) + CableTermination(cable=self, cable_end='B', termination=t) + for t in getattr(self, 'b_terminations', []) ] # Check that all termination objects for either end are of the same type for terms in (a_terminations, b_terminations): - if terms and len(terms) > 1: - if not all(t.termination_type == terms[0].termination_type for t in terms[1:]): - raise ValidationError( - "Cannot connect different termination types to same end of cable." - ) + if len(terms) > 1 and not all(t.termination_type == terms[0].termination_type for t in terms[1:]): + raise ValidationError("Cannot connect different termination types to same end of cable.") # Check that termination types are compatible if a_terminations and b_terminations: a_type = a_terminations[0].termination_type.model b_type = b_terminations[0].termination_type.model if b_type not in COMPATIBLE_TERMINATION_TYPES.get(a_type): - raise ValidationError( - f"Incompatible termination types: {a_type} and {b_type}" - ) + raise ValidationError(f"Incompatible termination types: {a_type} and {b_type}") # Run clean() on any new CableTerminations for cabletermination in [*a_terminations, *b_terminations]: @@ -169,6 +167,7 @@ class Cable(NetBoxModel): else: self._abs_length = None + # TODO: Need to come with a proper solution for filtering by termination parent # Store the parent Device for the A and B terminations (if applicable) to enable filtering if hasattr(self, 'a_terminations'): self._termination_a_device = getattr(self.a_terminations[0], 'device', None) @@ -210,13 +209,15 @@ class Cable(NetBoxModel): return LinkStatusChoices.colors.get(self.status) def get_a_terminations(self): + # Query self.terminations.all() to leverage cached results return [ - term.termination for term in CableTermination.objects.filter(cable=self, cable_end='A') + ct.termination for ct in self.terminations.all() if ct.cable_end == CableEndChoices.SIDE_A ] def get_b_terminations(self): + # Query self.terminations.all() to leverage cached results return [ - term.termination for term in CableTermination.objects.filter(cable=self, cable_end='B') + ct.termination for ct in self.terminations.all() if ct.cable_end == CableEndChoices.SIDE_B ] @@ -253,7 +254,7 @@ class CableTermination(models.Model): constraints = ( models.UniqueConstraint( fields=('termination_type', 'termination_id'), - name='unique_termination' + name='dcim_cable_termination_unique_termination' ), ) @@ -289,34 +290,48 @@ class CableTermination(models.Model): # Delete the cable association on the terminating object termination_model = self.termination._meta.model - termination_model.objects.filter(pk=self.termination_id).update(cable=None, cable_end='', _path=None) + termination_model.objects.filter(pk=self.termination_id).update( + cable=None, + cable_end='' + ) super().delete(*args, **kwargs) class CablePath(models.Model): """ - A CablePath instance represents the physical path from an origin to a destination, including all intermediate - elements in the path. Every instance must specify an `origin`, whereas `destination` may be null (for paths which do - not terminate on a PathEndpoint). + A CablePath instance represents the physical path from a set of origin nodes to a set of destination nodes, + including all intermediate elements. - `path` contains a list of nodes within the path, each represented by a tuple of (type, ID). The first element in the - path must be a Cable instance, followed by a pair of pass-through ports. For example, consider the following + `path` contains the ordered set of nodes, arranged in lists of (type, ID) tuples. (Each cable in the path can + terminate to one or more objects.) For example, consider the following topology: - 1 2 3 - Interface A --- Front Port A | Rear Port A --- Rear Port B | Front Port B --- Interface B + A B C + Interface 1 --- Front Port 1 | Rear Port 1 --- Rear Port 2 | Front Port 3 --- Interface 2 + Front Port 2 Front Port 4 This path would be expressed as: CablePath( - origin = Interface A - destination = Interface B - path = [Cable 1, Front Port A, Rear Port A, Cable 2, Rear Port B, Front Port B, Cable 3] + path = [ + [Interface 1], + [Cable A], + [Front Port 1, Front Port 2], + [Rear Port 1], + [Cable B], + [Rear Port 2], + [Front Port 3, Front Port 4], + [Cable C], + [Interface 2], + ] ) - `is_active` is set to True only if 1) `destination` is not null, and 2) every Cable within the path has a status of - "connected". + `is_active` is set to True only if every Cable within the path has a status of "connected". `is_complete` is True + if the instance represents a complete end-to-end path from origin(s) to destination(s). `is_split` is True if the + path diverges across multiple cables. + + `_nodes` retains a flattened list of all nodes within the path to enable simple filtering. """ path = models.JSONField( default=list @@ -332,36 +347,32 @@ class CablePath(models.Model): ) _nodes = PathField() - class Meta: - pass - def __str__(self): - status = ' (active)' if self.is_active else ' (split)' if self.is_split else '' - return f"Path #{self.pk}: {len(self.path)} nodes{status}" + return f"Path #{self.pk}: {len(self.path)} hops" def save(self, *args, **kwargs): # Save the flattened nodes list - self._nodes = flatten_path(self.path) + self._nodes = list(itertools.chain(*self.path)) super().save(*args, **kwargs) # Record a direct reference to this CablePath on its originating object(s) - origin_model = self.origins[0]._meta.model - origin_ids = [o.id for o in self.origins] + origin_model = self.origin_type.model_class() + origin_ids = [decompile_path_node(node)[1] for node in self.path[0]] origin_model.objects.filter(pk__in=origin_ids).update(_path=self.pk) @property def origin_type(self): - ct_id, _ = decompile_path_node(self.path[0][0]) - return ContentType.objects.get_for_id(ct_id) + if self.path: + ct_id, _ = decompile_path_node(self.path[0][0]) + return ContentType.objects.get_for_id(ct_id) @property def destination_type(self): - if not self.is_complete: - return None - ct_id, _ = decompile_path_node(self.path[-1][0]) - return ContentType.objects.get_for_id(ct_id) + if self.is_complete: + ct_id, _ = decompile_path_node(self.path[-1][0]) + return ContentType.objects.get_for_id(ct_id) @property def path_objects(self): @@ -375,7 +386,7 @@ class CablePath(models.Model): @property def origins(self): """ - Return the list of originating objects (from cache, if available). + Return the list of originating objects. """ if hasattr(self, '_path_objects'): return self.path_objects[0] @@ -386,7 +397,7 @@ class CablePath(models.Model): @property def destinations(self): """ - Return the list of destination objects (from cache, if available), if the path is complete. + Return the list of destination objects, if the path is complete. """ if not self.is_complete: return [] diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index d54ad8384..d1bdd757e 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -10,7 +10,6 @@ from mptt.models import MPTTModel, TreeForeignKey from dcim.choices import * from dcim.constants import * from dcim.fields import MACAddressField, WWNField -from dcim.svg import CableTraceSVG from netbox.models import OrganizationalModel, NetBoxModel from utilities.choices import ColorChoices from utilities.fields import ColorField, NaturalOrderingField @@ -105,7 +104,8 @@ class ModularComponentModel(ComponentModel): class CabledObjectModel(models.Model): """ - An abstract model inherited by all models to which a Cable can terminate. + An abstract model inherited by all models to which a Cable can terminate. Provides the `cable` and `cable_end` + fields for caching cable associations, as well as `mark_connected` to designate "fake" connections. """ cable = models.ForeignKey( to='dcim.Cable', @@ -134,8 +134,11 @@ class CabledObjectModel(models.Model): raise ValidationError({ "cable_end": "Must specify cable end (A or B) when attaching a cable." }) - - if self.mark_connected and self.cable_id: + if self.cable_end and not self.cable: + raise ValidationError({ + "cable_end": "Cable end must not be set without a cable." + }) + if self.mark_connected and self.cable: raise ValidationError({ "mark_connected": "Cannot mark as connected with a cable attached." }) @@ -167,12 +170,13 @@ class CabledObjectModel(models.Model): """ Generic wrapper for a Cable, WirelessLink, or some other relation to a connected termination. """ + # TODO: Support WirelessLinks return self.cable class PathEndpoint(models.Model): """ - An abstract model inherited by any CableTermination subclass which represents the end of a CablePath; specifically, + An abstract model inherited by any CabledObjectModel subclass which represents the end of a CablePath; specifically, these include ConsolePort, ConsoleServerPort, PowerPort, PowerOutlet, Interface, and PowerFeed. `_path` references the CablePath originating from this instance, if any. It is set or cleared by the receivers in @@ -215,14 +219,6 @@ class PathEndpoint(models.Model): # Return the path as a list of three-tuples (A termination(s), cable(s), B termination(s)) return list(zip(*[iter(path)] * 3)) - def get_trace_svg(self, base_url=None, width=CABLE_TRACE_SVG_DEFAULT_WIDTH): - trace = CableTraceSVG(self, base_url=base_url, width=width) - return trace.render() - - @property - def path(self): - return self._path - @property def connected_endpoints(self): """ @@ -338,7 +334,15 @@ class PowerPort(ModularComponentModel, CabledObjectModel, PathEndpoint): def get_downstream_powerports(self, leg=None): """ - Return a queryset of all PowerPorts connected via cable to a child PowerOutlet. + Return a queryset of all PowerPorts connected via cable to a child PowerOutlet. For example, in the topology + below, PP1.get_downstream_powerports() would return PP2-4. + + ---- PO1 <---> PP2 + / + PP1 ------- PO2 <---> PP3 + \ + ---- PO3 <---> PP4 + """ poweroutlets = self.poweroutlets.filter(cable__isnull=False) if leg: diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index 3bbf38b6a..2039def09 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -438,9 +438,9 @@ class Rack(NetBoxModel): peer for peer in powerfeed.link_peers if isinstance(peer, PowerPort) ]) - allocated_draw = 0 - for powerport in powerports: - allocated_draw += powerport.get_power_draw()['allocated'] + allocated_draw = sum([ + powerport.get_power_draw()['allocated'] for powerport in powerports + ]) return int(allocated_draw / available_power_total * 100) diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index cb6b32de3..7cfdc823d 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -3,7 +3,7 @@ import logging from django.db.models.signals import post_save, post_delete, pre_delete from django.dispatch import receiver -from .choices import LinkStatusChoices +from .choices import CableEndChoices, LinkStatusChoices from .models import Cable, CablePath, CableTermination, Device, PathEndpoint, PowerPanel, Rack, Location, VirtualChassis from .models.cables import trace_paths from .utils import create_cablepath, rebuild_paths @@ -83,7 +83,7 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): a_terminations = [] b_terminations = [] for t in instance.terminations.all(): - if t.cable_end == 'A': + if t.cable_end == CableEndChoices.SIDE_A: a_terminations.append(t.termination) else: b_terminations.append(t.termination) diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index 39f40c816..a07186973 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -13,21 +13,17 @@ CABLE_LENGTH = """ {% if record.length %}{{ record.length|simplify_decimal }} {{ record.length_unit }}{% endif %} """ -CABLE_TERMINATION = """ -{{ value|join:", " }} -""" - -CABLE_TERMINATION_PARENT = """ -{% with value.0 as termination %} - {% if termination.device %} - {{ termination.device }} - {% elif termination.circuit %} - {{ termination.circuit }} - {% elif termination.power_panel %} - {{ termination.power_panel }} - {% endif %} -{% endwith %} -""" +# CABLE_TERMINATION_PARENT = """ +# {% with value.0 as termination %} +# {% if termination.device %} +# {{ termination.device }} +# {% elif termination.circuit %} +# {{ termination.circuit }} +# {% elif termination.power_panel %} +# {{ termination.power_panel }} +# {% endif %} +# {% endwith %} +# """ DEVICE_LINK = """ diff --git a/netbox/dcim/tests/test_cablepaths.py b/netbox/dcim/tests/test_cablepaths.py index e5b441c51..cfbbbc63b 100644 --- a/netbox/dcim/tests/test_cablepaths.py +++ b/netbox/dcim/tests/test_cablepaths.py @@ -3,6 +3,7 @@ from django.test import TestCase from circuits.models import * from dcim.choices import LinkStatusChoices from dcim.models import * +from dcim.svg import CableTraceSVG from dcim.utils import object_to_path_node @@ -107,7 +108,7 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface2, path2) # Test SVG generation - interface1.get_trace_svg() + CableTraceSVG(interface1).render() # Delete cable 1 cable1.delete() @@ -146,7 +147,7 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(consoleserverport1, path2) # Test SVG generation - consoleport1.get_trace_svg() + CableTraceSVG(consoleport1).render() # Delete cable 1 cable1.delete() @@ -185,7 +186,7 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(poweroutlet1, path2) # Test SVG generation - powerport1.get_trace_svg() + CableTraceSVG(powerport1).render() # Delete cable 1 cable1.delete() @@ -224,7 +225,7 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(powerfeed1, path2) # Test SVG generation - powerport1.get_trace_svg() + CableTraceSVG(powerport1).render() # Delete cable 1 cable1.delete() @@ -267,7 +268,7 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface3, path2) # Test SVG generation - interface1.get_trace_svg() + CableTraceSVG(interface1).render() # Delete cable 1 cable1.delete() @@ -319,7 +320,7 @@ class CablePathTestCase(TestCase): self.assertPathIsSet(interface4, path2) # Test SVG generation - interface1.get_trace_svg() + CableTraceSVG(interface1).render() # Delete cable 1 cable1.delete() diff --git a/netbox/dcim/utils.py b/netbox/dcim/utils.py index e773dacc0..26b6e2e25 100644 --- a/netbox/dcim/utils.py +++ b/netbox/dcim/utils.py @@ -1,3 +1,5 @@ +import itertools + from django.contrib.contenttypes.models import ContentType from django.db import transaction @@ -29,16 +31,6 @@ def path_node_to_object(repr): return ct.model_class().objects.get(pk=object_id) -def flatten_path(path): - """ - Flatten a two-dimensional array (list of lists) into a flat list. - """ - ret = [] - for step in path: - ret.extend(step) - return ret - - def create_cablepath(terminations): """ Create CablePaths for all paths originating from the specified set of nodes. @@ -54,7 +46,7 @@ def create_cablepath(terminations): def rebuild_paths(terminations): """ - Rebuild all CablePaths which traverse the specified node + Rebuild all CablePaths which traverse the specified nodes. """ from dcim.models import CablePath diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index f6262c789..5619329ac 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -28,6 +28,18 @@ from .choices import DeviceFaceChoices from .constants import NONCONNECTABLE_IFACE_TYPES from .models import * +CABLE_TERMINATION_TYPES = { + 'dcim.consoleport': ConsolePort, + 'dcim.consoleserverport': ConsoleServerPort, + 'dcim.powerport': PowerPort, + 'dcim.poweroutlet': PowerOutlet, + 'dcim.interface': Interface, + 'dcim.frontport': FrontPort, + 'dcim.rearport': RearPort, + 'dcim.powerfeed': PowerFeed, + 'circuits.circuittermination': CircuitTermination, +} + class DeviceComponentsView(generic.ObjectChildrenView): queryset = Device.objects.all() @@ -2818,22 +2830,10 @@ class CableEditView(generic.ObjectEditView): # If creating a new Cable, initialize the form class using URL query params if 'pk' not in kwargs: - termination_types = { - 'dcim.consoleport': ConsolePort, - 'dcim.consoleserverport': ConsoleServerPort, - 'dcim.powerport': PowerPort, - 'dcim.poweroutlet': PowerOutlet, - 'dcim.interface': Interface, - 'dcim.frontport': FrontPort, - 'dcim.rearport': RearPort, - 'dcim.powerfeed': PowerFeed, - 'circuits.circuittermination': CircuitTermination, - } - - a_type = termination_types.get(request.GET.get('a_terminations_type')) - b_type = termination_types.get(request.GET.get('b_terminations_type')) - - self.form = forms.get_cable_form(a_type, b_type) + self.form = forms.get_cable_form( + a_type=CABLE_TERMINATION_TYPES.get(request.GET.get('a_terminations_type')), + b_type=CABLE_TERMINATION_TYPES.get(request.GET.get('b_terminations_type')) + ) return super().dispatch(request, *args, **kwargs) diff --git a/netbox/netbox/middleware.py b/netbox/netbox/middleware.py index cc768cbdc..5c4b2813d 100644 --- a/netbox/netbox/middleware.py +++ b/netbox/netbox/middleware.py @@ -179,8 +179,8 @@ class ExceptionHandlingMiddleware: def process_exception(self, request, exception): # Handle exceptions that occur from REST API requests - if is_api_request(request): - return rest_api_server_error(request) + # if is_api_request(request): + # return rest_api_server_error(request) # Don't catch exceptions when in debug mode if settings.DEBUG: diff --git a/netbox/netbox/views/__init__.py b/netbox/netbox/views/__init__.py index 5528faec2..666e3d28a 100644 --- a/netbox/netbox/views/__init__.py +++ b/netbox/netbox/views/__init__.py @@ -3,7 +3,6 @@ import sys from django.conf import settings from django.core.cache import cache -from django.db.models import F from django.http import HttpResponseServerError from django.shortcuts import redirect, render from django.template import loader @@ -37,13 +36,13 @@ class HomeView(View): return redirect("login") connected_consoleports = ConsolePort.objects.restrict(request.user, 'view').prefetch_related('_path').filter( - _path__is_active=True + _path__is_complete=True ) connected_powerports = PowerPort.objects.restrict(request.user, 'view').prefetch_related('_path').filter( - _path__is_active=True + _path__is_complete=True ) connected_interfaces = Interface.objects.restrict(request.user, 'view').prefetch_related('_path').filter( - _path__is_active=True + _path__is_complete=True ) def build_stats(): From 13ef5dc0b32047ac93aa671b64174e636370b065 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 7 Jul 2022 13:57:39 -0400 Subject: [PATCH 223/593] Extend Interface.link_peers() to support WirelessLinks --- netbox/dcim/models/device_components.py | 36 ++++++++++++++++--------- 1 file changed, 23 insertions(+), 13 deletions(-) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index d1bdd757e..85665bb43 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -143,13 +143,19 @@ class CabledObjectModel(models.Model): "mark_connected": "Cannot mark as connected with a cable attached." }) + @property + def link(self): + """ + Generic wrapper for a Cable, WirelessLink, or some other relation to a connected termination. + """ + return self.cable + @property def link_peers(self): - # TODO: Support WirelessLinks - if not self.cable: - return [] - peer_terminations = self.cable.terminations.exclude(cable_end=self.cable_end).prefetch_related('termination') - return [ct.termination for ct in peer_terminations] + if self.cable: + peers = self.cable.terminations.exclude(cable_end=self.cable_end).prefetch_related('termination') + return [peer.termination for peer in peers] + return [] @property def _occupied(self): @@ -165,14 +171,6 @@ class CabledObjectModel(models.Model): return None return CableEndChoices.SIDE_A if self.cable_end == CableEndChoices.SIDE_B else CableEndChoices.SIDE_B - @property - def link(self): - """ - Generic wrapper for a Cable, WirelessLink, or some other relation to a connected termination. - """ - # TODO: Support WirelessLinks - return self.cable - class PathEndpoint(models.Model): """ @@ -832,6 +830,18 @@ class Interface(ModularComponentModel, BaseInterface, CabledObjectModel, PathEnd def link(self): return self.cable or self.wireless_link + @property + def link_peers(self): + if self.cable: + return super().link_peers + if self.wireless_link: + # Return the opposite side of the attached wireless link + if self.wireless_link.interface_a == self: + return [self.wireless_link.interface_b] + else: + return [self.wireless_link.interface_a] + return [] + @property def l2vpn_termination(self): return self.l2vpn_terminations.first() From a858e041e4dbfaaa3d42e481e21ba033316fe5e7 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 7 Jul 2022 14:23:05 -0400 Subject: [PATCH 224/593] Cache properties which return related objects --- netbox/dcim/models/device_components.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 85665bb43..5bc3e00ff 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -1,3 +1,5 @@ +from functools import cached_property + from django.contrib.contenttypes.fields import GenericForeignKey, GenericRelation from django.contrib.contenttypes.models import ContentType from django.core.exceptions import ValidationError @@ -150,7 +152,7 @@ class CabledObjectModel(models.Model): """ return self.cable - @property + @cached_property def link_peers(self): if self.cable: peers = self.cable.terminations.exclude(cable_end=self.cable_end).prefetch_related('termination') @@ -217,14 +219,12 @@ class PathEndpoint(models.Model): # Return the path as a list of three-tuples (A termination(s), cable(s), B termination(s)) return list(zip(*[iter(path)] * 3)) - @property + @cached_property def connected_endpoints(self): """ Caching accessor for the attached CablePath's destination (if any) """ - if not hasattr(self, '_connected_endpoints'): - self._connected_endpoints = self._path.destinations if self._path else [] - return self._connected_endpoints + return self._path.destinations if self._path else [] # @@ -830,7 +830,7 @@ class Interface(ModularComponentModel, BaseInterface, CabledObjectModel, PathEnd def link(self): return self.cable or self.wireless_link - @property + @cached_property def link_peers(self): if self.cable: return super().link_peers From d444aa11101a8ed298fd1533f8c12e6925d149df Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 7 Jul 2022 14:35:02 -0400 Subject: [PATCH 225/593] Fix support for tracing across bridge relationships --- netbox/dcim/api/views.py | 2 +- netbox/dcim/models/device_components.py | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index e71a6500d..cff337fcf 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -59,7 +59,7 @@ class PathEndpointMixin(object): width = int(request.GET.get('width', CABLE_TRACE_SVG_DEFAULT_WIDTH)) except (ValueError, TypeError): width = CABLE_TRACE_SVG_DEFAULT_WIDTH - drawing = CableTraceSVG(self, base_url=request.build_absolute_uri('/'), width=width) + drawing = CableTraceSVG(obj, base_url=request.build_absolute_uri('/'), width=width) return HttpResponse(drawing.render().tostring(), content_type='image/svg+xml') # Serialize path objects, iterating over each three-tuple in the path diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 5bc3e00ff..1105724c9 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -211,10 +211,10 @@ class PathEndpoint(models.Model): # by inserting empty entries immediately prior to the path's destination node(s) path.append([]) - # TODO: Add bridging support - # # Check for bridge interface to continue the trace - # origin = getattr(origin._path.destination, 'bridge', None) - origin = None + # Check for a bridged relationship to continue the trace + destinations = origin._path.destinations + if len(destinations) == 1: + origin = getattr(destinations[0], 'bridge', None) # Return the path as a list of three-tuples (A termination(s), cable(s), B termination(s)) return list(zip(*[iter(path)] * 3)) From 11707cb3b14eabec580adafb411d0ce2d2017d3f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 7 Jul 2022 19:08:20 -0400 Subject: [PATCH 226/593] Fix trace() loop --- netbox/dcim/models/device_components.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 1105724c9..203b4469e 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -215,6 +215,8 @@ class PathEndpoint(models.Model): destinations = origin._path.destinations if len(destinations) == 1: origin = getattr(destinations[0], 'bridge', None) + else: + origin = None # Return the path as a list of three-tuples (A termination(s), cable(s), B termination(s)) return list(zip(*[iter(path)] * 3)) From 42e5282283484a20a0bde9ac860abb2579657b00 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 8 Jul 2022 11:44:28 -0400 Subject: [PATCH 227/593] Improve filtering cables by termination device/rack/site --- netbox/dcim/filtersets.py | 38 +++++---- netbox/dcim/forms/filtersets.py | 17 +++- .../migrations/0157_new_cabling_models.py | 4 + .../0158_populate_cable_terminations.py | 55 +++++++++---- .../dcim/migrations/0161_cabling_cleanup.py | 8 ++ netbox/dcim/models/cables.py | 78 +++++++++++++------ netbox/dcim/models/device_components.py | 7 ++ netbox/dcim/tests/test_filtersets.py | 41 ++++++---- 8 files changed, 177 insertions(+), 71 deletions(-) diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index e30ab4f04..f55b3301e 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -1537,27 +1537,35 @@ class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): choices=ColorChoices ) device_id = MultiValueNumberFilter( - method='filter_device' + method='filter_by_termination' ) device = MultiValueCharFilter( - method='filter_device', + method='filter_by_termination', field_name='device__name' ) rack_id = MultiValueNumberFilter( - method='filter_device', - field_name='device__rack_id' + method='filter_by_termination', + field_name='rack_id' ) rack = MultiValueCharFilter( - method='filter_device', - field_name='device__rack__name' + method='filter_by_termination', + field_name='rack__name' + ) + location_id = MultiValueNumberFilter( + method='filter_by_termination', + field_name='location_id' + ) + location = MultiValueCharFilter( + method='filter_by_termination', + field_name='location__name' ) site_id = MultiValueNumberFilter( - method='filter_device', - field_name='device__site_id' + method='filter_by_termination', + field_name='site_id' ) site = MultiValueCharFilter( - method='filter_device', - field_name='device__site__slug' + method='filter_by_termination', + field_name='site__slug' ) class Meta: @@ -1569,12 +1577,10 @@ class CableFilterSet(TenancyFilterSet, NetBoxModelFilterSet): return queryset return queryset.filter(label__icontains=value) - def filter_device(self, queryset, name, value): - queryset = queryset.filter( - Q(**{f'_termination_a_{name}__in': value}) | - Q(**{f'_termination_b_{name}__in': value}) - ) - return queryset + def filter_by_termination(self, queryset, name, value): + # Filter by a related object cached on CableTermination. Note the underscore preceding the field name. + # Supported objects: device, rack, location, site + return queryset.filter(**{f'terminations___{name}__in': value}).distinct() class CableTerminationFilterSet(BaseFilterSet): diff --git a/netbox/dcim/forms/filtersets.py b/netbox/dcim/forms/filtersets.py index d9bc79fb5..bd64e02b4 100644 --- a/netbox/dcim/forms/filtersets.py +++ b/netbox/dcim/forms/filtersets.py @@ -730,7 +730,7 @@ class CableFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): model = Cable fieldsets = ( (None, ('q', 'tag')), - ('Location', ('site_id', 'rack_id', 'device_id')), + ('Location', ('site_id', 'location_id', 'rack_id', 'device_id')), ('Attributes', ('type', 'status', 'color', 'length', 'length_unit')), ('Tenant', ('tenant_group_id', 'tenant_id')), ) @@ -747,13 +747,23 @@ class CableFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): }, label=_('Site') ) + location_id = DynamicModelMultipleChoiceField( + queryset=Location.objects.all(), + required=False, + label=_('Location'), + null_option='None', + query_params={ + 'site_id': '$site_id' + } + ) rack_id = DynamicModelMultipleChoiceField( queryset=Rack.objects.all(), required=False, label=_('Rack'), null_option='None', query_params={ - 'site_id': '$site_id' + 'site_id': '$site_id', + 'location_id': '$location_id', } ) device_id = DynamicModelMultipleChoiceField( @@ -761,8 +771,9 @@ class CableFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): required=False, query_params={ 'site_id': '$site_id', - 'tenant_id': '$tenant_id', + 'location_id': '$location_id', 'rack_id': '$rack_id', + 'tenant_id': '$tenant_id', }, label=_('Device') ) diff --git a/netbox/dcim/migrations/0157_new_cabling_models.py b/netbox/dcim/migrations/0157_new_cabling_models.py index e7c55997c..a3a650086 100644 --- a/netbox/dcim/migrations/0157_new_cabling_models.py +++ b/netbox/dcim/migrations/0157_new_cabling_models.py @@ -20,6 +20,10 @@ class Migration(migrations.Migration): ('termination_id', models.PositiveBigIntegerField()), ('cable', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='terminations', to='dcim.cable')), ('termination_type', models.ForeignKey(limit_choices_to=models.Q(models.Q(models.Q(('app_label', 'circuits'), ('model__in', ('circuittermination',))), models.Q(('app_label', 'dcim'), ('model__in', ('consoleport', 'consoleserverport', 'frontport', 'interface', 'powerfeed', 'poweroutlet', 'powerport', 'rearport'))), _connector='OR')), on_delete=django.db.models.deletion.PROTECT, related_name='+', to='contenttypes.contenttype')), + ('_device', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='dcim.device')), + ('_rack', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='dcim.rack')), + ('_location', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='dcim.location')), + ('_site', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='dcim.site')), ], options={ 'ordering': ('cable', 'cable_end', 'pk'), diff --git a/netbox/dcim/migrations/0158_populate_cable_terminations.py b/netbox/dcim/migrations/0158_populate_cable_terminations.py index c35c39a40..82f8cd359 100644 --- a/netbox/dcim/migrations/0158_populate_cable_terminations.py +++ b/netbox/dcim/migrations/0158_populate_cable_terminations.py @@ -1,10 +1,37 @@ from django.db import migrations +def cache_related_objects(termination): + """ + Replicate caching logic from CableTermination.cache_related_objects() + """ + attrs = {} + + # Device components + if getattr(termination, 'device', None): + attrs['_device'] = termination.device + attrs['_rack'] = termination.device.rack + attrs['_location'] = termination.device.location + attrs['_site'] = termination.device.site + + # Power feeds + elif getattr(termination, 'rack', None): + attrs['_rack'] = termination.rack + attrs['_location'] = termination.rack.location + attrs['_site'] = termination.rack.site + + # Circuit terminations + elif getattr(termination, 'site', None): + attrs['_site'] = termination.site + + return attrs + + def populate_cable_terminations(apps, schema_editor): """ Replicate terminations from the Cable model into CableTermination instances. """ + ContentType = apps.get_model('contenttypes', 'ContentType') Cable = apps.get_model('dcim', 'Cable') CableTermination = apps.get_model('dcim', 'CableTermination') @@ -16,22 +43,20 @@ def populate_cable_terminations(apps, schema_editor): # Queue CableTerminations to be created cable_terminations = [] for i, cable in enumerate(cables, start=1): - cable_terminations.append( - CableTermination( + for cable_end in ('a', 'b'): + # We must manually instantiate the termination object, because GFK fields are not + # supported within migrations. + termination_ct = ContentType.objects.get(pk=cable[f'termination_{cable_end}_type']) + termination_model = apps.get_model(termination_ct.app_label, termination_ct.model) + termination = termination_model.objects.get(pk=cable[f'termination_{cable_end}_id']) + + cable_terminations.append(CableTermination( cable_id=cable['id'], - cable_end='A', - termination_type_id=cable['termination_a_type'], - termination_id=cable['termination_a_id'] - ) - ) - cable_terminations.append( - CableTermination( - cable_id=cable['id'], - cable_end='B', - termination_type_id=cable['termination_b_type'], - termination_id=cable['termination_b_id'] - ) - ) + cable_end=cable_end.upper(), + termination_type_id=cable[f'termination_{cable_end}_type'], + termination_id=cable[f'termination_{cable_end}_id'], + **cache_related_objects(termination) + )) # Bulk create the termination objects CableTermination.objects.bulk_create(cable_terminations, batch_size=100) diff --git a/netbox/dcim/migrations/0161_cabling_cleanup.py b/netbox/dcim/migrations/0161_cabling_cleanup.py index db2a9b73e..8a1b7a09e 100644 --- a/netbox/dcim/migrations/0161_cabling_cleanup.py +++ b/netbox/dcim/migrations/0161_cabling_cleanup.py @@ -34,6 +34,14 @@ class Migration(migrations.Migration): model_name='cable', name='termination_b_type', ), + migrations.RemoveField( + model_name='cable', + name='_termination_a_device', + ), + migrations.RemoveField( + model_name='cable', + name='_termination_b_device', + ), # Remove old fields from CablePath migrations.AlterUniqueTogether( diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index cf9f6064d..551521c26 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -19,7 +19,6 @@ from utilities.querysets import RestrictedQuerySet from utilities.utils import to_meters from wireless.models import WirelessLink from .device_components import FrontPort, RearPort -from .devices import Device __all__ = ( 'Cable', @@ -81,22 +80,6 @@ class Cable(NetBoxModel): blank=True, null=True ) - # Cache the associated device (where applicable) for the A and B terminations. This enables filtering of Cables by - # their associated Devices. - _termination_a_device = models.ForeignKey( - to=Device, - on_delete=models.CASCADE, - related_name='+', - blank=True, - null=True - ) - _termination_b_device = models.ForeignKey( - to=Device, - on_delete=models.CASCADE, - related_name='+', - blank=True, - null=True - ) class Meta: ordering = ('pk',) @@ -167,13 +150,6 @@ class Cable(NetBoxModel): else: self._abs_length = None - # TODO: Need to come with a proper solution for filtering by termination parent - # Store the parent Device for the A and B terminations (if applicable) to enable filtering - if hasattr(self, 'a_terminations'): - self._termination_a_device = getattr(self.a_terminations[0], 'device', None) - if hasattr(self, 'b_terminations'): - self._termination_b_device = getattr(self.b_terminations[0], 'device', None) - super().save(*args, **kwargs) # Update the private pk used in __str__ in case this is a new object (i.e. just got its pk) @@ -247,6 +223,32 @@ class CableTermination(models.Model): fk_field='termination_id' ) + # Cached associations to enable efficient filtering + _device = models.ForeignKey( + to='dcim.Device', + on_delete=models.CASCADE, + blank=True, + null=True + ) + _rack = models.ForeignKey( + to='dcim.Rack', + on_delete=models.CASCADE, + blank=True, + null=True + ) + _location = models.ForeignKey( + to='dcim.Location', + on_delete=models.CASCADE, + blank=True, + null=True + ) + _site = models.ForeignKey( + to='dcim.Site', + on_delete=models.CASCADE, + blank=True, + null=True + ) + objects = RestrictedQuerySet.as_manager() class Meta: @@ -277,6 +279,10 @@ class CableTermination(models.Model): }) def save(self, *args, **kwargs): + + # Cache objects associated with the terminating object (for filtering) + self.cache_related_objects() + super().save(*args, **kwargs) # Set the cable on the terminating object @@ -297,6 +303,30 @@ class CableTermination(models.Model): super().delete(*args, **kwargs) + def cache_related_objects(self): + """ + Cache objects related to the termination (e.g. device, rack, site) directly on the object to + enable efficient filtering. + """ + assert self.termination is not None + + # Device components + if getattr(self.termination, 'device', None): + self._device = self.termination.device + self._rack = self.termination.device.rack + self._location = self.termination.device.location + self._site = self.termination.device.site + + # Power feeds + elif getattr(self.termination, 'rack', None): + self._rack = self.termination.rack + self._location = self.termination.rack.location + self._site = self.termination.rack.site + + # Circuit terminations + elif getattr(self.termination, 'site', None): + self._site = self.termination.site + class CablePath(models.Model): """ diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 203b4469e..82dacbff6 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -126,6 +126,13 @@ class CabledObjectModel(models.Model): help_text="Treat as if a cable is connected" ) + cable_terminations = GenericRelation( + to='dcim.CableTermination', + content_type_field='termination_type', + object_id_field='termination_id', + related_query_name='%(class)s', + ) + class Meta: abstract = True diff --git a/netbox/dcim/tests/test_filtersets.py b/netbox/dcim/tests/test_filtersets.py index 2d3b57d01..24c45dd7f 100644 --- a/netbox/dcim/tests/test_filtersets.py +++ b/netbox/dcim/tests/test_filtersets.py @@ -3663,6 +3663,21 @@ class CableTestCase(TestCase, ChangeLoggedFilterSetTests): ) Site.objects.bulk_create(sites) + locations = ( + Location(name='Location 1', site=sites[0], slug='location-1'), + Location(name='Location 2', site=sites[1], slug='location-1'), + Location(name='Location 3', site=sites[2], slug='location-1'), + ) + for location in locations: + location.save() + + racks = ( + Rack(name='Rack 1', site=sites[0], location=locations[0]), + Rack(name='Rack 2', site=sites[1], location=locations[1]), + Rack(name='Rack 3', site=sites[2], location=locations[2]), + ) + Rack.objects.bulk_create(racks) + tenants = ( Tenant(name='Tenant 1', slug='tenant-1'), Tenant(name='Tenant 2', slug='tenant-2'), @@ -3670,24 +3685,17 @@ class CableTestCase(TestCase, ChangeLoggedFilterSetTests): ) Tenant.objects.bulk_create(tenants) - racks = ( - Rack(name='Rack 1', site=sites[0]), - Rack(name='Rack 2', site=sites[1]), - Rack(name='Rack 3', site=sites[2]), - ) - Rack.objects.bulk_create(racks) - manufacturer = Manufacturer.objects.create(name='Manufacturer 1', slug='manufacturer-1') device_type = DeviceType.objects.create(manufacturer=manufacturer, model='Model 1', slug='model-1') device_role = DeviceRole.objects.create(name='Device Role 1', slug='device-role-1') devices = ( - Device(name='Device 1', device_type=device_type, device_role=device_role, site=sites[0], rack=racks[0], position=1), - Device(name='Device 2', device_type=device_type, device_role=device_role, site=sites[0], rack=racks[0], position=2), - Device(name='Device 3', device_type=device_type, device_role=device_role, site=sites[1], rack=racks[1], position=1), - Device(name='Device 4', device_type=device_type, device_role=device_role, site=sites[1], rack=racks[1], position=2), - Device(name='Device 5', device_type=device_type, device_role=device_role, site=sites[2], rack=racks[2], position=1), - Device(name='Device 6', device_type=device_type, device_role=device_role, site=sites[2], rack=racks[2], position=2), + Device(name='Device 1', device_type=device_type, device_role=device_role, site=sites[0], rack=racks[0], location=locations[0], position=1), + Device(name='Device 2', device_type=device_type, device_role=device_role, site=sites[0], rack=racks[0], location=locations[0], position=2), + Device(name='Device 3', device_type=device_type, device_role=device_role, site=sites[1], rack=racks[1], location=locations[1], position=1), + Device(name='Device 4', device_type=device_type, device_role=device_role, site=sites[1], rack=racks[1], location=locations[1], position=2), + Device(name='Device 5', device_type=device_type, device_role=device_role, site=sites[2], rack=racks[2], location=locations[2], position=1), + Device(name='Device 6', device_type=device_type, device_role=device_role, site=sites[2], rack=racks[2], location=locations[2], position=2), ) Device.objects.bulk_create(devices) @@ -3759,6 +3767,13 @@ class CableTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'rack': [racks[0].name, racks[1].name]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) + def test_location(self): + locations = Location.objects.all()[:2] + params = {'location_id': [locations[0].pk, locations[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) + params = {'location': [locations[0].name, locations[1].name]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) + def test_site(self): site = Site.objects.all()[:2] params = {'site_id': [site[0].pk, site[1].pk]} From ac4a87de1345291742b05988ca99cef074d5fd2d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 8 Jul 2022 13:33:43 -0400 Subject: [PATCH 228/593] Improve display of related objects in cables list --- netbox/dcim/tables/cables.py | 120 +++++++++++++++++++++++------------ netbox/dcim/views.py | 5 +- 2 files changed, 83 insertions(+), 42 deletions(-) diff --git a/netbox/dcim/tables/cables.py b/netbox/dcim/tables/cables.py index f3643dd1b..ff2a672ca 100644 --- a/netbox/dcim/tables/cables.py +++ b/netbox/dcim/tables/cables.py @@ -1,5 +1,6 @@ import django_tables2 as tables from django_tables2.utils import Accessor +from django.utils.safestring import mark_safe from dcim.models import Cable from netbox.tables import NetBoxTable, columns @@ -11,20 +12,34 @@ __all__ = ( ) -class CableTerminationsColumn(tables.TemplateColumn): +class CableTerminationsColumn(tables.Column): + """ + Args: + cable_end: Which side of the cable to report on (A or B) + attr: The CableTermination attribute to return for each instance (returns the termination object by default) + """ + def __init__(self, cable_end, attr='termination', *args, **kwargs): + self.cable_end = cable_end + self.attr = attr + super().__init__(accessor=Accessor('terminations'), *args, **kwargs) - def __init__(self, cable_end, *args, **kwargs): - template_code = """ - {% for term in value.all %} - {% if term.cable_end == '""" + cable_end + """' %} - {{ term.termination }} - {% endif %} - {% endfor %} - """ - super().__init__(template_code=template_code, *args, **kwargs) + def _get_terminations(self, manager): + terminations = set() + for cabletermination in manager.all(): + if cabletermination.cable_end == self.cable_end: + if termination := getattr(cabletermination, self.attr, None): + terminations.add(termination) + + return terminations + + def render(self, value): + links = [ + f'{term}' for term in self._get_terminations(value) + ] + return mark_safe('
    '.join(links) or '—') def value(self, value): - return ', '.join([str(t.termination) for t in value.all()]) + return ','.join([str(t) for t in self._get_terminations(value)]) # @@ -32,41 +47,63 @@ class CableTerminationsColumn(tables.TemplateColumn): # class CableTable(NetBoxTable): - # termination_a_parent = tables.TemplateColumn( - # template_code=CABLE_TERMINATION_PARENT, - # accessor=Accessor('termination_a'), - # orderable=False, - # verbose_name='Side A' - # ) - # rack_a = tables.Column( - # accessor=Accessor('termination_a__device__rack'), - # orderable=False, - # linkify=True, - # verbose_name='Rack A' - # ) - # termination_b_parent = tables.TemplateColumn( - # template_code=CABLE_TERMINATION_PARENT, - # accessor=Accessor('termination_b'), - # orderable=False, - # verbose_name='Side B' - # ) - # rack_b = tables.Column( - # accessor=Accessor('termination_b__device__rack'), - # orderable=False, - # linkify=True, - # verbose_name='Rack B' - # ) a_terminations = CableTerminationsColumn( cable_end='A', - accessor=Accessor('terminations'), orderable=False, - verbose_name='A Side' + verbose_name='Termination A' ) b_terminations = CableTerminationsColumn( cable_end='B', - accessor=Accessor('terminations'), orderable=False, - verbose_name='B Side' + verbose_name='Termination B' + ) + device_a = CableTerminationsColumn( + cable_end='A', + attr='_device', + orderable=False, + verbose_name='Device A' + ) + device_b = CableTerminationsColumn( + cable_end='B', + attr='_device', + orderable=False, + verbose_name='Device B' + ) + location_a = CableTerminationsColumn( + cable_end='A', + attr='_location', + orderable=False, + verbose_name='Location A' + ) + location_b = CableTerminationsColumn( + cable_end='B', + attr='_location', + orderable=False, + verbose_name='Location B' + ) + rack_a = CableTerminationsColumn( + cable_end='A', + attr='_rack', + orderable=False, + verbose_name='Rack A' + ) + rack_b = CableTerminationsColumn( + cable_end='B', + attr='_rack', + orderable=False, + verbose_name='Rack B' + ) + site_a = CableTerminationsColumn( + cable_end='A', + attr='_site', + orderable=False, + verbose_name='Site A' + ) + site_b = CableTerminationsColumn( + cable_end='B', + attr='_site', + orderable=False, + verbose_name='Site B' ) status = columns.ChoiceFieldColumn() tenant = TenantColumn() @@ -82,8 +119,9 @@ class CableTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Cable fields = ( - 'pk', 'id', 'label', 'a_terminations', 'b_terminations', 'status', 'type', 'tenant', 'color', 'length', - 'tags', 'created', 'last_updated', + 'pk', 'id', 'label', 'a_terminations', 'b_terminations', 'device_a', 'device_b', 'rack_a', 'rack_b', + 'location_a', 'location_b', 'site_a', 'site_b', 'status', 'type', 'tenant', 'color', 'length', 'tags', + 'created', 'last_updated', ) default_columns = ( 'pk', 'id', 'label', 'a_terminations', 'b_terminations', 'status', 'type', diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 5619329ac..1f2f04d7a 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2756,7 +2756,10 @@ class DeviceBulkAddInventoryItemView(generic.BulkComponentCreateView): # class CableListView(generic.ObjectListView): - queryset = Cable.objects.prefetch_related('terminations__termination') + queryset = Cable.objects.prefetch_related( + 'terminations__termination', 'terminations___device', 'terminations___rack', 'terminations___location', + 'terminations___site', + ) filterset = filtersets.CableFilterSet filterset_form = forms.CableFilterForm table = tables.CableTable From f386ec82ae3086cc9e470148bc25fa23555b5199 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 8 Jul 2022 13:55:13 -0400 Subject: [PATCH 229/593] Fix CablePath serialization for pass-through port paths --- docs/release-notes/version-3.3.md | 2 ++ netbox/dcim/api/serializers.py | 34 ++++--------------------------- 2 files changed, 6 insertions(+), 30 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index e5f999048..ac499f806 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -27,6 +27,8 @@ | `connected_endpoint_type` | string | `connected_endpoints_type` | string | | `connected_endpoint_reachable` | boolean | `connected_endpoints_reachable` | boolean | +* The cable path serialization returned by the `/paths/` endpoint for pass-through ports has been simplified, and the following fields removed: `origin_type`, `origin`, `destination_type`, `destination`. (Additionally, `is_complete` has been added.) + ### New Features #### Half-Height Rack Units ([#51](https://github.com/netbox-community/netbox/issues/51)) diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 53205e162..08edd2820 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -1081,45 +1081,19 @@ class CableTerminationSerializer(NetBoxModelSerializer): class CablePathSerializer(serializers.ModelSerializer): - origin_type = ContentTypeField(read_only=True) - origin = serializers.SerializerMethodField(read_only=True) - destination_type = ContentTypeField(read_only=True) - destination = serializers.SerializerMethodField(read_only=True) path = serializers.SerializerMethodField(read_only=True) class Meta: model = CablePath - fields = [ - 'id', 'origin_type', 'origin', 'destination_type', 'destination', 'path', 'is_active', 'is_split', - ] - - @swagger_serializer_method(serializer_or_field=serializers.DictField) - def get_origin(self, obj): - """ - Return the appropriate serializer for the origin. - """ - serializer = get_serializer_for_model(obj.origin, prefix='Nested') - context = {'request': self.context['request']} - return serializer(obj.origin, context=context).data - - @swagger_serializer_method(serializer_or_field=serializers.DictField) - def get_destination(self, obj): - """ - Return the appropriate serializer for the destination, if any. - """ - if obj.destination_id is not None: - serializer = get_serializer_for_model(obj.destination, prefix='Nested') - context = {'request': self.context['request']} - return serializer(obj.destination, context=context).data - return None + fields = ['id', 'path', 'is_active', 'is_complete', 'is_split'] @swagger_serializer_method(serializer_or_field=serializers.ListField) def get_path(self, obj): ret = [] - for node in obj.path_objects(): - serializer = get_serializer_for_model(node, prefix='Nested') + for nodes in obj.path_objects: + serializer = get_serializer_for_model(nodes[0], prefix='Nested') context = {'request': self.context['request']} - ret.append(serializer(node, context=context).data) + ret.append(serializer(nodes, context=context, many=True).data) return ret From 55b3e4eeb3a1bd0e80822a47f6c6a7f46af82c49 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 8 Jul 2022 14:16:42 -0400 Subject: [PATCH 230/593] Fixes #9682: Fix bulk assignment of ASNs to sites --- docs/release-notes/version-3.2.md | 1 + netbox/netbox/views/generic/bulk_views.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 57d965538..3bd3773cf 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -14,6 +14,7 @@ * [#8854](https://github.com/netbox-community/netbox/issues/8854) - Fix `REMOTE_AUTH_DEFAULT_GROUPS` for social-auth backends * [#9575](https://github.com/netbox-community/netbox/issues/9575) - Fix AttributeError exception for FHRP group with an IP address assigned * [#9597](https://github.com/netbox-community/netbox/issues/9597) - Include `installed_module` in module bay REST API serializer +* [#9682](https://github.com/netbox-community/netbox/issues/9682) - Fix bulk assignment of ASNs to sites --- diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py index 96efc0de7..5bdf5cbc9 100644 --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -8,6 +8,7 @@ from django.contrib.contenttypes.models import ContentType from django.core.exceptions import FieldDoesNotExist, ValidationError from django.db import transaction, IntegrityError from django.db.models import ManyToManyField, ProtectedError +from django.db.models.fields.reverse_related import ManyToManyRel from django.forms import Form, ModelMultipleChoiceField, MultipleHiddenInput from django.http import HttpResponse from django.shortcuts import get_object_or_404, redirect, render @@ -484,7 +485,7 @@ class BulkEditView(GetReturnURLMixin, BaseMultiObjectView): setattr(obj, name, None if model_field.null else '') # ManyToManyFields - elif isinstance(model_field, ManyToManyField): + elif isinstance(model_field, (ManyToManyField, ManyToManyRel)): if form.cleaned_data[name]: getattr(obj, name).set(form.cleaned_data[name]) # Normal fields From a40ab9ffb1bfc9404ceb38d607d98baaaa1ab78e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 8 Jul 2022 14:59:16 -0400 Subject: [PATCH 231/593] Fixes #9657: Fix filtering for custom fields and webhooks in the UI --- docs/release-notes/version-3.2.md | 1 + netbox/extras/filtersets.py | 15 ++++-- netbox/extras/forms/filtersets.py | 14 +++--- netbox/extras/tests/test_filtersets.py | 65 +++++++++++++++++++++++++- 4 files changed, 85 insertions(+), 10 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 3bd3773cf..9b4dc800d 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -14,6 +14,7 @@ * [#8854](https://github.com/netbox-community/netbox/issues/8854) - Fix `REMOTE_AUTH_DEFAULT_GROUPS` for social-auth backends * [#9575](https://github.com/netbox-community/netbox/issues/9575) - Fix AttributeError exception for FHRP group with an IP address assigned * [#9597](https://github.com/netbox-community/netbox/issues/9597) - Include `installed_module` in module bay REST API serializer +* [#9657](https://github.com/netbox-community/netbox/issues/9657) - Fix filtering for custom fields and webhooks in the UI * [#9682](https://github.com/netbox-community/netbox/issues/9682) - Fix bulk assignment of ASNs to sites --- diff --git a/netbox/extras/filtersets.py b/netbox/extras/filtersets.py index 25477fbda..bb8d16c42 100644 --- a/netbox/extras/filtersets.py +++ b/netbox/extras/filtersets.py @@ -32,6 +32,9 @@ class WebhookFilterSet(BaseFilterSet): method='search', label='Search', ) + content_type_id = MultiValueNumberFilter( + field_name='content_types__id' + ) content_types = ContentTypeFilter() http_method = django_filters.MultipleChoiceFilter( choices=WebhookHttpMethodChoices @@ -40,8 +43,8 @@ class WebhookFilterSet(BaseFilterSet): class Meta: model = Webhook fields = [ - 'id', 'content_types', 'name', 'type_create', 'type_update', 'type_delete', 'payload_url', 'enabled', - 'http_method', 'http_content_type', 'secret', 'ssl_verification', 'ca_file_path', + 'id', 'name', 'type_create', 'type_update', 'type_delete', 'payload_url', 'enabled', 'http_method', + 'http_content_type', 'secret', 'ssl_verification', 'ca_file_path', ] def search(self, queryset, name, value): @@ -58,11 +61,17 @@ class CustomFieldFilterSet(BaseFilterSet): method='search', label='Search', ) + type = django_filters.MultipleChoiceFilter( + choices=CustomFieldTypeChoices + ) + content_type_id = MultiValueNumberFilter( + field_name='content_types__id' + ) content_types = ContentTypeFilter() class Meta: model = CustomField - fields = ['id', 'content_types', 'name', 'required', 'filter_logic', 'weight', 'description'] + fields = ['id', 'name', 'required', 'filter_logic', 'weight', 'description'] def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/extras/forms/filtersets.py b/netbox/extras/forms/filtersets.py index 5d66c8be8..71bcfd4c2 100644 --- a/netbox/extras/forms/filtersets.py +++ b/netbox/extras/forms/filtersets.py @@ -32,12 +32,13 @@ __all__ = ( class CustomFieldFilterForm(FilterForm): fieldsets = ( (None, ('q',)), - ('Attributes', ('type', 'content_types', 'weight', 'required')), + ('Attributes', ('type', 'content_type_id', 'weight', 'required')), ) - content_types = ContentTypeMultipleChoiceField( + content_type_id = ContentTypeMultipleChoiceField( queryset=ContentType.objects.all(), limit_choices_to=FeatureQuery('custom_fields'), - required=False + required=False, + label='Object type' ) type = MultipleChoiceField( choices=CustomFieldTypeChoices, @@ -110,13 +111,14 @@ class ExportTemplateFilterForm(FilterForm): class WebhookFilterForm(FilterForm): fieldsets = ( (None, ('q',)), - ('Attributes', ('content_types', 'http_method', 'enabled')), + ('Attributes', ('content_type_id', 'http_method', 'enabled')), ('Events', ('type_create', 'type_update', 'type_delete')), ) - content_types = ContentTypeMultipleChoiceField( + content_type_id = ContentTypeMultipleChoiceField( queryset=ContentType.objects.all(), limit_choices_to=FeatureQuery('webhooks'), - required=False + required=False, + label='Object type' ) http_method = MultipleChoiceField( choices=WebhookHttpMethodChoices, diff --git a/netbox/extras/tests/test_filtersets.py b/netbox/extras/tests/test_filtersets.py index bdb8de9db..aa9d724a4 100644 --- a/netbox/extras/tests/test_filtersets.py +++ b/netbox/extras/tests/test_filtersets.py @@ -7,7 +7,9 @@ from django.test import TestCase from circuits.models import Provider from dcim.models import DeviceRole, DeviceType, Manufacturer, Platform, Rack, Region, Site, SiteGroup -from extras.choices import JournalEntryKindChoices, ObjectChangeActionChoices +from extras.choices import ( + CustomFieldTypeChoices, CustomFieldFilterLogicChoices, JournalEntryKindChoices, ObjectChangeActionChoices, +) from extras.filtersets import * from extras.models import * from ipam.models import IPAddress @@ -16,6 +18,65 @@ from utilities.testing import BaseFilterSetTests, ChangeLoggedFilterSetTests, cr from virtualization.models import Cluster, ClusterGroup, ClusterType +class CustomFieldTestCase(TestCase, BaseFilterSetTests): + queryset = CustomField.objects.all() + filterset = CustomFieldFilterSet + + @classmethod + def setUpTestData(cls): + content_types = ContentType.objects.filter(model__in=['site', 'rack', 'device']) + + custom_fields = ( + CustomField( + name='Custom Field 1', + type=CustomFieldTypeChoices.TYPE_TEXT, + required=True, + weight=100, + filter_logic=CustomFieldFilterLogicChoices.FILTER_LOOSE + ), + CustomField( + name='Custom Field 2', + type=CustomFieldTypeChoices.TYPE_INTEGER, + required=False, + weight=200, + filter_logic=CustomFieldFilterLogicChoices.FILTER_EXACT + ), + CustomField( + name='Custom Field 3', + type=CustomFieldTypeChoices.TYPE_BOOLEAN, + required=False, + weight=300, + filter_logic=CustomFieldFilterLogicChoices.FILTER_DISABLED + ), + ) + CustomField.objects.bulk_create(custom_fields) + custom_fields[0].content_types.add(content_types[0]) + custom_fields[1].content_types.add(content_types[1]) + custom_fields[2].content_types.add(content_types[2]) + + def test_name(self): + params = {'name': ['Custom Field 1', 'Custom Field 2']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_content_types(self): + params = {'content_types': 'dcim.site'} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) + params = {'content_type_id': [ContentType.objects.get_for_model(Site).pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) + + def test_required(self): + params = {'required': True} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) + + def test_weight(self): + params = {'weight': [100, 200]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_filter_logic(self): + params = {'filter_logic': CustomFieldFilterLogicChoices.FILTER_LOOSE} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) + + class WebhookTestCase(TestCase, BaseFilterSetTests): queryset = Webhook.objects.all() filterset = WebhookFilterSet @@ -62,6 +123,8 @@ class WebhookTestCase(TestCase, BaseFilterSetTests): def test_content_types(self): params = {'content_types': 'dcim.site'} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) + params = {'content_type_id': [ContentType.objects.get_for_model(Site).pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) def test_type_create(self): params = {'type_create': True} From 3c2a55a521b1a8c8a36340bf37f036f242a514a0 Mon Sep 17 00:00:00 2001 From: Kim Johansson Date: Sun, 10 Jul 2022 11:58:45 +0200 Subject: [PATCH 232/593] Add TenantGroupColumn to display Tenant Group on tables Works the same as the existing TenantColumn, but displats the Tenant Group of the Tenant. Views should prefetch the Tenants Group for this to be efficient in large tables. --- netbox/tenancy/tables/columns.py | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/netbox/tenancy/tables/columns.py b/netbox/tenancy/tables/columns.py index bb5aba5de..aa66e8bc8 100644 --- a/netbox/tenancy/tables/columns.py +++ b/netbox/tenancy/tables/columns.py @@ -2,6 +2,7 @@ import django_tables2 as tables __all__ = ( 'TenantColumn', + 'TenantGroupColumn', ) @@ -24,3 +25,28 @@ class TenantColumn(tables.TemplateColumn): def value(self, value): return str(value) if value else None + + +class TenantGroupColumn(tables.TemplateColumn): + """ + Include the tenant group description. + """ + template_code = """ + {% if record.tenant and record.tenant.group %} + {{ record.tenant.group }} + {% elif record.vrf.tenant and record.vrf.tenant.group %} + {{ record.vrf.tenant.group }}* + {% else %} + — + {% endif %} + """ + + def __init__(self, *args, **kwargs): + if 'verbose_name' not in kwargs: + kwargs['verbose_name'] = 'Tenant Group' + + super().__init__(template_code=self.template_code, *args, **kwargs) + + def value(self, value): + return str(value) if value else None + From bd60d46b8285e62b05e83a36989cf39a3aaa74b4 Mon Sep 17 00:00:00 2001 From: Kim Johansson Date: Sun, 10 Jul 2022 15:08:55 +0200 Subject: [PATCH 233/593] Table mixin for Tenancy columns A mixin to add the Tenant and Tenant Group columns to a table. --- netbox/tenancy/tables/columns.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/netbox/tenancy/tables/columns.py b/netbox/tenancy/tables/columns.py index aa66e8bc8..2d25590aa 100644 --- a/netbox/tenancy/tables/columns.py +++ b/netbox/tenancy/tables/columns.py @@ -3,6 +3,7 @@ import django_tables2 as tables __all__ = ( 'TenantColumn', 'TenantGroupColumn', + 'TenancyColumnsMixin', ) @@ -50,3 +51,7 @@ class TenantGroupColumn(tables.TemplateColumn): def value(self, value): return str(value) if value else None + +class TenancyColumnsMixin(tables.Table): + tenant_group = TenantGroupColumn() + tenant = TenantColumn() From e6bfde1397314950fd11dca01675abf490353cc0 Mon Sep 17 00:00:00 2001 From: Kim Johansson Date: Sun, 10 Jul 2022 15:13:48 +0200 Subject: [PATCH 234/593] Replace TenantColumn with new TenancyColumnsMixin Replaces all usages of the TenantColumn with the new TenancyColumnsMixin. This enables the user to add a column for Tenant Group on all tables which also has a column for Tenant. --- netbox/circuits/tables/circuits.py | 7 ++-- netbox/dcim/tables/cables.py | 7 ++-- netbox/dcim/tables/devices.py | 12 +++---- netbox/dcim/tables/racks.py | 12 +++---- netbox/dcim/tables/sites.py | 12 +++---- netbox/ipam/tables/ip.py | 32 ++++++++----------- netbox/ipam/tables/vlans.py | 12 +++---- netbox/ipam/tables/vrfs.py | 12 +++---- netbox/virtualization/tables/clusters.py | 8 ++--- .../virtualization/tables/virtualmachines.py | 7 ++-- 10 files changed, 50 insertions(+), 71 deletions(-) diff --git a/netbox/circuits/tables/circuits.py b/netbox/circuits/tables/circuits.py index 40f8918ae..ea4310def 100644 --- a/netbox/circuits/tables/circuits.py +++ b/netbox/circuits/tables/circuits.py @@ -2,7 +2,7 @@ import django_tables2 as tables from circuits.models import * from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin from .columns import CommitRateColumn __all__ = ( @@ -39,7 +39,7 @@ class CircuitTypeTable(NetBoxTable): default_columns = ('pk', 'name', 'circuit_count', 'description', 'slug') -class CircuitTable(NetBoxTable): +class CircuitTable(TenancyColumnsMixin, NetBoxTable): cid = tables.Column( linkify=True, verbose_name='Circuit ID' @@ -48,7 +48,6 @@ class CircuitTable(NetBoxTable): linkify=True ) status = columns.ChoiceFieldColumn() - tenant = TenantColumn() termination_a = tables.TemplateColumn( template_code=CIRCUITTERMINATION_LINK, verbose_name='Side A' @@ -69,7 +68,7 @@ class CircuitTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Circuit fields = ( - 'pk', 'id', 'cid', 'provider', 'type', 'status', 'tenant', 'termination_a', 'termination_z', 'install_date', + 'pk', 'id', 'cid', 'provider', 'type', 'status', 'tenant', 'tenant_group', 'termination_a', 'termination_z', 'install_date', 'commit_rate', 'description', 'comments', 'contacts', 'tags', 'created', 'last_updated', ) default_columns = ( diff --git a/netbox/dcim/tables/cables.py b/netbox/dcim/tables/cables.py index 4b062ad48..4fd1b3266 100644 --- a/netbox/dcim/tables/cables.py +++ b/netbox/dcim/tables/cables.py @@ -3,7 +3,7 @@ from django_tables2.utils import Accessor from dcim.models import Cable from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin from .template_code import CABLE_LENGTH, CABLE_TERMINATION_PARENT __all__ = ( @@ -15,7 +15,7 @@ __all__ = ( # Cables # -class CableTable(NetBoxTable): +class CableTable(TenancyColumnsMixin, NetBoxTable): termination_a_parent = tables.TemplateColumn( template_code=CABLE_TERMINATION_PARENT, accessor=Accessor('termination_a'), @@ -53,7 +53,6 @@ class CableTable(NetBoxTable): verbose_name='Termination B' ) status = columns.ChoiceFieldColumn() - tenant = TenantColumn() length = columns.TemplateColumn( template_code=CABLE_LENGTH, order_by=('_abs_length', 'length_unit') @@ -67,7 +66,7 @@ class CableTable(NetBoxTable): model = Cable fields = ( 'pk', 'id', 'label', 'termination_a_parent', 'rack_a', 'termination_a', 'termination_b_parent', 'rack_b', 'termination_b', - 'status', 'type', 'tenant', 'color', 'length', 'tags', 'created', 'last_updated', + 'status', 'type', 'tenant', 'tenant_group', 'color', 'length', 'tags', 'created', 'last_updated', ) default_columns = ( 'pk', 'id', 'label', 'termination_a_parent', 'termination_a', 'termination_b_parent', 'termination_b', diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index 0f015b7f3..710921beb 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -6,7 +6,7 @@ from dcim.models import ( InventoryItemRole, ModuleBay, Platform, PowerOutlet, PowerPort, RearPort, VirtualChassis, ) from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin from .template_code import * __all__ = ( @@ -137,13 +137,12 @@ class PlatformTable(NetBoxTable): # Devices # -class DeviceTable(NetBoxTable): +class DeviceTable(TenancyColumnsMixin, NetBoxTable): name = tables.TemplateColumn( order_by=('_name',), template_code=DEVICE_LINK ) status = columns.ChoiceFieldColumn() - tenant = TenantColumn() site = tables.Column( linkify=True ) @@ -200,7 +199,7 @@ class DeviceTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Device fields = ( - 'pk', 'id', 'name', 'status', 'tenant', 'device_role', 'manufacturer', 'device_type', 'platform', 'serial', + 'pk', 'id', 'name', 'status', 'tenant', 'tenant_group', 'device_role', 'manufacturer', 'device_type', 'platform', 'serial', 'asset_tag', 'site', 'location', 'rack', 'position', 'face', 'primary_ip', 'airflow', 'primary_ip4', 'primary_ip6', 'cluster', 'virtual_chassis', 'vc_position', 'vc_priority', 'comments', 'contacts', 'tags', 'created', 'last_updated', @@ -211,12 +210,11 @@ class DeviceTable(NetBoxTable): ) -class DeviceImportTable(NetBoxTable): +class DeviceImportTable(TenancyColumnsMixin, NetBoxTable): name = tables.TemplateColumn( template_code=DEVICE_LINK ) status = columns.ChoiceFieldColumn() - tenant = TenantColumn() site = tables.Column( linkify=True ) @@ -232,7 +230,7 @@ class DeviceImportTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Device - fields = ('id', 'name', 'status', 'tenant', 'site', 'rack', 'position', 'device_role', 'device_type') + fields = ('id', 'name', 'status', 'tenant', 'tenant_group', 'site', 'rack', 'position', 'device_role', 'device_type') empty_text = False diff --git a/netbox/dcim/tables/racks.py b/netbox/dcim/tables/racks.py index e6368cb74..5412e2297 100644 --- a/netbox/dcim/tables/racks.py +++ b/netbox/dcim/tables/racks.py @@ -3,7 +3,7 @@ from django_tables2.utils import Accessor from dcim.models import Rack, RackReservation, RackRole from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin __all__ = ( 'RackTable', @@ -37,7 +37,7 @@ class RackRoleTable(NetBoxTable): # Racks # -class RackTable(NetBoxTable): +class RackTable(TenancyColumnsMixin, NetBoxTable): name = tables.Column( order_by=('_name',), linkify=True @@ -48,7 +48,6 @@ class RackTable(NetBoxTable): site = tables.Column( linkify=True ) - tenant = TenantColumn() status = columns.ChoiceFieldColumn() role = columns.ColoredLabelColumn() u_height = tables.TemplateColumn( @@ -87,7 +86,7 @@ class RackTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Rack fields = ( - 'pk', 'id', 'name', 'site', 'location', 'status', 'facility_id', 'tenant', 'role', 'serial', 'asset_tag', + 'pk', 'id', 'name', 'site', 'location', 'status', 'facility_id', 'tenant', 'tenant_group', 'role', 'serial', 'asset_tag', 'type', 'width', 'outer_width', 'outer_depth', 'u_height', 'comments', 'device_count', 'get_utilization', 'get_power_utilization', 'contacts', 'tags', 'created', 'last_updated', ) @@ -101,7 +100,7 @@ class RackTable(NetBoxTable): # Rack reservations # -class RackReservationTable(NetBoxTable): +class RackReservationTable(TenancyColumnsMixin, NetBoxTable): reservation = tables.Column( accessor='pk', linkify=True @@ -110,7 +109,6 @@ class RackReservationTable(NetBoxTable): accessor=Accessor('rack__site'), linkify=True ) - tenant = TenantColumn() rack = tables.Column( linkify=True ) @@ -125,7 +123,7 @@ class RackReservationTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = RackReservation fields = ( - 'pk', 'id', 'reservation', 'site', 'rack', 'unit_list', 'user', 'created', 'tenant', 'description', 'tags', + 'pk', 'id', 'reservation', 'site', 'rack', 'unit_list', 'user', 'created', 'tenant', 'tenant_group', 'description', 'tags', 'actions', 'created', 'last_updated', ) default_columns = ('pk', 'reservation', 'site', 'rack', 'unit_list', 'user', 'description') diff --git a/netbox/dcim/tables/sites.py b/netbox/dcim/tables/sites.py index fa3c73e12..1945199a3 100644 --- a/netbox/dcim/tables/sites.py +++ b/netbox/dcim/tables/sites.py @@ -2,7 +2,7 @@ import django_tables2 as tables from dcim.models import Location, Region, Site, SiteGroup from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin from .template_code import LOCATION_BUTTONS __all__ = ( @@ -75,7 +75,7 @@ class SiteGroupTable(NetBoxTable): # Sites # -class SiteTable(NetBoxTable): +class SiteTable(TenancyColumnsMixin, NetBoxTable): name = tables.Column( linkify=True ) @@ -96,7 +96,6 @@ class SiteTable(NetBoxTable): url_params={'site_id': 'pk'}, verbose_name='ASN Count' ) - tenant = TenantColumn() comments = columns.MarkdownColumn() contacts = columns.ManyToManyColumn( linkify_item=True @@ -108,7 +107,7 @@ class SiteTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Site fields = ( - 'pk', 'id', 'name', 'slug', 'status', 'facility', 'region', 'group', 'tenant', 'asns', 'asn_count', + 'pk', 'id', 'name', 'slug', 'status', 'facility', 'region', 'group', 'tenant', 'tenant_group', 'asns', 'asn_count', 'time_zone', 'description', 'physical_address', 'shipping_address', 'latitude', 'longitude', 'comments', 'contacts', 'tags', 'created', 'last_updated', 'actions', ) @@ -119,14 +118,13 @@ class SiteTable(NetBoxTable): # Locations # -class LocationTable(NetBoxTable): +class LocationTable(TenancyColumnsMixin, NetBoxTable): name = columns.MPTTColumn( linkify=True ) site = tables.Column( linkify=True ) - tenant = TenantColumn() rack_count = columns.LinkedCountColumn( viewname='dcim:rack_list', url_params={'location_id': 'pk'}, @@ -150,7 +148,7 @@ class LocationTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Location fields = ( - 'pk', 'id', 'name', 'site', 'tenant', 'rack_count', 'device_count', 'description', 'slug', 'contacts', + 'pk', 'id', 'name', 'site', 'tenant', 'tenant_group', 'rack_count', 'device_count', 'description', 'slug', 'contacts', 'tags', 'actions', 'created', 'last_updated', ) default_columns = ('pk', 'name', 'site', 'tenant', 'rack_count', 'device_count', 'description') diff --git a/netbox/ipam/tables/ip.py b/netbox/ipam/tables/ip.py index 558631585..e61d99fd8 100644 --- a/netbox/ipam/tables/ip.py +++ b/netbox/ipam/tables/ip.py @@ -4,7 +4,7 @@ from django_tables2.utils import Accessor from ipam.models import * from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin __all__ = ( 'AggregateTable', @@ -99,7 +99,7 @@ class RIRTable(NetBoxTable): # ASNs # -class ASNTable(NetBoxTable): +class ASNTable(TenancyColumnsMixin, NetBoxTable): asn = tables.Column( linkify=True ) @@ -122,7 +122,6 @@ class ASNTable(NetBoxTable): linkify_item=True, verbose_name='Sites' ) - tenant = TenantColumn() tags = columns.TagColumn( url_name='ipam:asn_list' ) @@ -130,7 +129,7 @@ class ASNTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = ASN fields = ( - 'pk', 'asn', 'asn_asdot', 'rir', 'site_count', 'provider_count', 'tenant', 'description', 'sites', 'tags', + 'pk', 'asn', 'asn_asdot', 'rir', 'site_count', 'provider_count', 'tenant', 'tenant_group', 'description', 'sites', 'tags', 'created', 'last_updated', 'actions', ) default_columns = ('pk', 'asn', 'rir', 'site_count', 'provider_count', 'sites', 'description', 'tenant') @@ -140,12 +139,11 @@ class ASNTable(NetBoxTable): # Aggregates # -class AggregateTable(NetBoxTable): +class AggregateTable(TenancyColumnsMixin, NetBoxTable): prefix = tables.Column( linkify=True, verbose_name='Aggregate' ) - tenant = TenantColumn() date_added = tables.DateColumn( format="Y-m-d", verbose_name='Added' @@ -164,7 +162,7 @@ class AggregateTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Aggregate fields = ( - 'pk', 'id', 'prefix', 'rir', 'tenant', 'child_count', 'utilization', 'date_added', 'description', 'tags', + 'pk', 'id', 'prefix', 'rir', 'tenant', 'tenant_group', 'child_count', 'utilization', 'date_added', 'description', 'tags', 'created', 'last_updated', ) default_columns = ('pk', 'prefix', 'rir', 'tenant', 'child_count', 'utilization', 'date_added', 'description') @@ -225,7 +223,7 @@ class PrefixUtilizationColumn(columns.UtilizationColumn): """ -class PrefixTable(NetBoxTable): +class PrefixTable(TenancyColumnsMixin, NetBoxTable): prefix = columns.TemplateColumn( template_code=PREFIX_LINK, export_raw=True, @@ -256,7 +254,6 @@ class PrefixTable(NetBoxTable): template_code=VRF_LINK, verbose_name='VRF' ) - tenant = TenantColumn() site = tables.Column( linkify=True ) @@ -289,7 +286,7 @@ class PrefixTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Prefix fields = ( - 'pk', 'id', 'prefix', 'prefix_flat', 'status', 'children', 'vrf', 'utilization', 'tenant', 'site', + 'pk', 'id', 'prefix', 'prefix_flat', 'status', 'children', 'vrf', 'utilization', 'tenant', 'tenant_group', 'site', 'vlan_group', 'vlan', 'role', 'is_pool', 'mark_utilized', 'description', 'tags', 'created', 'last_updated', ) default_columns = ( @@ -303,7 +300,7 @@ class PrefixTable(NetBoxTable): # # IP ranges # -class IPRangeTable(NetBoxTable): +class IPRangeTable(TenancyColumnsMixin, NetBoxTable): start_address = tables.Column( linkify=True ) @@ -317,7 +314,6 @@ class IPRangeTable(NetBoxTable): role = tables.Column( linkify=True ) - tenant = TenantColumn() utilization = columns.UtilizationColumn( accessor='utilization', orderable=False @@ -329,7 +325,7 @@ class IPRangeTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = IPRange fields = ( - 'pk', 'id', 'start_address', 'end_address', 'size', 'vrf', 'status', 'role', 'tenant', 'description', + 'pk', 'id', 'start_address', 'end_address', 'size', 'vrf', 'status', 'role', 'tenant', 'tenant_group', 'description', 'utilization', 'tags', 'created', 'last_updated', ) default_columns = ( @@ -344,7 +340,7 @@ class IPRangeTable(NetBoxTable): # IPAddresses # -class IPAddressTable(NetBoxTable): +class IPAddressTable(TenancyColumnsMixin, NetBoxTable): address = tables.TemplateColumn( template_code=IPADDRESS_LINK, verbose_name='IP Address' @@ -357,7 +353,6 @@ class IPAddressTable(NetBoxTable): default=AVAILABLE_LABEL ) role = columns.ChoiceFieldColumn() - tenant = TenantColumn() assigned_object = tables.Column( linkify=True, orderable=False, @@ -386,7 +381,7 @@ class IPAddressTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = IPAddress fields = ( - 'pk', 'id', 'address', 'vrf', 'status', 'role', 'tenant', 'nat_inside', 'assigned', 'dns_name', 'description', + 'pk', 'id', 'address', 'vrf', 'status', 'role', 'tenant', 'tenant_group', 'nat_inside', 'assigned', 'dns_name', 'description', 'tags', 'created', 'last_updated', ) default_columns = ( @@ -414,7 +409,7 @@ class IPAddressAssignTable(NetBoxTable): orderable = False -class AssignedIPAddressesTable(NetBoxTable): +class AssignedIPAddressesTable(TenancyColumnsMixin, NetBoxTable): """ List IP addresses assigned to an object. """ @@ -427,9 +422,8 @@ class AssignedIPAddressesTable(NetBoxTable): verbose_name='VRF' ) status = columns.ChoiceFieldColumn() - tenant = TenantColumn() class Meta(NetBoxTable.Meta): model = IPAddress - fields = ('address', 'vrf', 'status', 'role', 'tenant', 'description') + fields = ('address', 'vrf', 'status', 'role', 'tenant', 'tenant_group', 'description') exclude = ('id', ) diff --git a/netbox/ipam/tables/vlans.py b/netbox/ipam/tables/vlans.py index 4551a1c3d..4329177eb 100644 --- a/netbox/ipam/tables/vlans.py +++ b/netbox/ipam/tables/vlans.py @@ -5,7 +5,7 @@ from django_tables2.utils import Accessor from dcim.models import Interface from ipam.models import * from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin from virtualization.models import VMInterface __all__ = ( @@ -90,7 +90,7 @@ class VLANGroupTable(NetBoxTable): # VLANs # -class VLANTable(NetBoxTable): +class VLANTable(TenancyColumnsMixin, NetBoxTable): vid = tables.TemplateColumn( template_code=VLAN_LINK, verbose_name='VID' @@ -104,7 +104,6 @@ class VLANTable(NetBoxTable): group = tables.Column( linkify=True ) - tenant = TenantColumn() status = columns.ChoiceFieldColumn( default=AVAILABLE_LABEL ) @@ -123,7 +122,7 @@ class VLANTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = VLAN fields = ( - 'pk', 'id', 'vid', 'name', 'site', 'group', 'prefixes', 'tenant', 'status', 'role', 'description', 'tags', + 'pk', 'id', 'vid', 'name', 'site', 'group', 'prefixes', 'tenant', 'tenant_group', 'status', 'role', 'description', 'tags', 'created', 'last_updated', ) default_columns = ('pk', 'vid', 'name', 'site', 'group', 'prefixes', 'tenant', 'status', 'role', 'description') @@ -174,7 +173,7 @@ class VLANVirtualMachinesTable(VLANMembersTable): exclude = ('id', ) -class InterfaceVLANTable(NetBoxTable): +class InterfaceVLANTable(TenancyColumnsMixin, NetBoxTable): """ List VLANs assigned to a specific Interface. """ @@ -190,7 +189,6 @@ class InterfaceVLANTable(NetBoxTable): accessor=Accessor('group__name'), verbose_name='Group' ) - tenant = TenantColumn() status = columns.ChoiceFieldColumn() role = tables.Column( linkify=True @@ -198,7 +196,7 @@ class InterfaceVLANTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = VLAN - fields = ('vid', 'tagged', 'site', 'group', 'name', 'tenant', 'status', 'role', 'description') + fields = ('vid', 'tagged', 'site', 'group', 'name', 'tenant', 'tenant_group', 'status', 'role', 'description') exclude = ('id', ) def __init__(self, interface, *args, **kwargs): diff --git a/netbox/ipam/tables/vrfs.py b/netbox/ipam/tables/vrfs.py index 727f402ff..69807410b 100644 --- a/netbox/ipam/tables/vrfs.py +++ b/netbox/ipam/tables/vrfs.py @@ -2,7 +2,7 @@ import django_tables2 as tables from ipam.models import * from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin __all__ = ( 'RouteTargetTable', @@ -20,14 +20,13 @@ VRF_TARGETS = """ # VRFs # -class VRFTable(NetBoxTable): +class VRFTable(TenancyColumnsMixin, NetBoxTable): name = tables.Column( linkify=True ) rd = tables.Column( verbose_name='RD' ) - tenant = TenantColumn() enforce_unique = columns.BooleanColumn( verbose_name='Unique' ) @@ -46,7 +45,7 @@ class VRFTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = VRF fields = ( - 'pk', 'id', 'name', 'rd', 'tenant', 'enforce_unique', 'description', 'import_targets', 'export_targets', + 'pk', 'id', 'name', 'rd', 'tenant', 'tenant_group', 'enforce_unique', 'description', 'import_targets', 'export_targets', 'tags', 'created', 'last_updated', ) default_columns = ('pk', 'name', 'rd', 'tenant', 'description') @@ -56,16 +55,15 @@ class VRFTable(NetBoxTable): # Route targets # -class RouteTargetTable(NetBoxTable): +class RouteTargetTable(TenancyColumnsMixin, NetBoxTable): name = tables.Column( linkify=True ) - tenant = TenantColumn() tags = columns.TagColumn( url_name='ipam:vrf_list' ) class Meta(NetBoxTable.Meta): model = RouteTarget - fields = ('pk', 'id', 'name', 'tenant', 'description', 'tags', 'created', 'last_updated',) + fields = ('pk', 'id', 'name', 'tenant', 'tenant_group', 'description', 'tags', 'created', 'last_updated',) default_columns = ('pk', 'name', 'tenant', 'description') diff --git a/netbox/virtualization/tables/clusters.py b/netbox/virtualization/tables/clusters.py index a0c98425a..ccffe23fd 100644 --- a/netbox/virtualization/tables/clusters.py +++ b/netbox/virtualization/tables/clusters.py @@ -1,6 +1,7 @@ import django_tables2 as tables from netbox.tables import NetBoxTable, columns +from tenancy.tables import TenancyColumnsMixin from virtualization.models import Cluster, ClusterGroup, ClusterType __all__ = ( @@ -56,7 +57,7 @@ class ClusterGroupTable(NetBoxTable): default_columns = ('pk', 'name', 'cluster_count', 'description') -class ClusterTable(NetBoxTable): +class ClusterTable(TenancyColumnsMixin, NetBoxTable): name = tables.Column( linkify=True ) @@ -66,9 +67,6 @@ class ClusterTable(NetBoxTable): group = tables.Column( linkify=True ) - tenant = tables.Column( - linkify=True - ) site = tables.Column( linkify=True ) @@ -93,7 +91,7 @@ class ClusterTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Cluster fields = ( - 'pk', 'id', 'name', 'type', 'group', 'tenant', 'site', 'comments', 'device_count', 'vm_count', 'contacts', + 'pk', 'id', 'name', 'type', 'group', 'tenant', 'tenant_group', 'site', 'comments', 'device_count', 'vm_count', 'contacts', 'tags', 'created', 'last_updated', ) default_columns = ('pk', 'name', 'type', 'group', 'tenant', 'site', 'device_count', 'vm_count') diff --git a/netbox/virtualization/tables/virtualmachines.py b/netbox/virtualization/tables/virtualmachines.py index 89dbdf901..8cff96227 100644 --- a/netbox/virtualization/tables/virtualmachines.py +++ b/netbox/virtualization/tables/virtualmachines.py @@ -2,7 +2,7 @@ import django_tables2 as tables from dcim.tables.devices import BaseInterfaceTable from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin from virtualization.models import VirtualMachine, VMInterface __all__ = ( @@ -24,7 +24,7 @@ VMINTERFACE_BUTTONS = """ # Virtual machines # -class VirtualMachineTable(NetBoxTable): +class VirtualMachineTable(TenancyColumnsMixin, NetBoxTable): name = tables.Column( order_by=('_name',), linkify=True @@ -34,7 +34,6 @@ class VirtualMachineTable(NetBoxTable): linkify=True ) role = columns.ColoredLabelColumn() - tenant = TenantColumn() comments = columns.MarkdownColumn() primary_ip4 = tables.Column( linkify=True, @@ -56,7 +55,7 @@ class VirtualMachineTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = VirtualMachine fields = ( - 'pk', 'id', 'name', 'status', 'cluster', 'role', 'tenant', 'platform', 'vcpus', 'memory', 'disk', + 'pk', 'id', 'name', 'status', 'cluster', 'role', 'tenant', 'tenant_group', 'platform', 'vcpus', 'memory', 'disk', 'primary_ip4', 'primary_ip6', 'primary_ip', 'comments', 'tags', 'created', 'last_updated', ) default_columns = ( From 69a22ffe5e3aefafa540f13c40e88f9c5ca0b7ec Mon Sep 17 00:00:00 2001 From: Kim Johansson Date: Sun, 10 Jul 2022 15:38:21 +0200 Subject: [PATCH 235/593] Prefetch Tenant Group in global search Configure the prefetch to also include the Tenant Group, avoids additional database queries when the Tenant Group column is to be rendered. NOTE: If no personalisation of the global search tables should be done, this commit can be reverted. --- netbox/netbox/constants.py | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/netbox/netbox/constants.py b/netbox/netbox/constants.py index 8ca0d98c1..cc04e9aa8 100644 --- a/netbox/netbox/constants.py +++ b/netbox/netbox/constants.py @@ -34,7 +34,7 @@ CIRCUIT_TYPES = OrderedDict( }), ('circuit', { 'queryset': Circuit.objects.prefetch_related( - 'type', 'provider', 'tenant', 'terminations__site' + 'type', 'provider', 'tenant', 'tenant__group', 'terminations__site' ), 'filterset': circuits.filtersets.CircuitFilterSet, 'table': circuits.tables.CircuitTable, @@ -53,13 +53,13 @@ CIRCUIT_TYPES = OrderedDict( DCIM_TYPES = OrderedDict( ( ('site', { - 'queryset': Site.objects.prefetch_related('region', 'tenant'), + 'queryset': Site.objects.prefetch_related('region', 'tenant', 'tenant__group'), 'filterset': dcim.filtersets.SiteFilterSet, 'table': dcim.tables.SiteTable, 'url': 'dcim:site_list', }), ('rack', { - 'queryset': Rack.objects.prefetch_related('site', 'location', 'tenant', 'role').annotate( + 'queryset': Rack.objects.prefetch_related('site', 'location', 'tenant', 'tenant__group', 'role').annotate( device_count=count_related(Device, 'rack') ), 'filterset': dcim.filtersets.RackFilterSet, @@ -100,7 +100,7 @@ DCIM_TYPES = OrderedDict( }), ('device', { 'queryset': Device.objects.prefetch_related( - 'device_type__manufacturer', 'device_role', 'tenant', 'site', 'rack', 'primary_ip4', 'primary_ip6', + 'device_type__manufacturer', 'device_role', 'tenant', 'tenant__group', 'site', 'rack', 'primary_ip4', 'primary_ip6', ), 'filterset': dcim.filtersets.DeviceFilterSet, 'table': dcim.tables.DeviceTable, @@ -148,7 +148,7 @@ DCIM_TYPES = OrderedDict( IPAM_TYPES = OrderedDict( ( ('vrf', { - 'queryset': VRF.objects.prefetch_related('tenant'), + 'queryset': VRF.objects.prefetch_related('tenant', 'tenant__group'), 'filterset': ipam.filtersets.VRFFilterSet, 'table': ipam.tables.VRFTable, 'url': 'ipam:vrf_list', @@ -160,25 +160,25 @@ IPAM_TYPES = OrderedDict( 'url': 'ipam:aggregate_list', }), ('prefix', { - 'queryset': Prefix.objects.prefetch_related('site', 'vrf__tenant', 'tenant', 'vlan', 'role'), + 'queryset': Prefix.objects.prefetch_related('site', 'vrf__tenant', 'tenant', 'tenant__group', 'vlan', 'role'), 'filterset': ipam.filtersets.PrefixFilterSet, 'table': ipam.tables.PrefixTable, 'url': 'ipam:prefix_list', }), ('ipaddress', { - 'queryset': IPAddress.objects.prefetch_related('vrf__tenant', 'tenant'), + 'queryset': IPAddress.objects.prefetch_related('vrf__tenant', 'tenant', 'tenant__group'), 'filterset': ipam.filtersets.IPAddressFilterSet, 'table': ipam.tables.IPAddressTable, 'url': 'ipam:ipaddress_list', }), ('vlan', { - 'queryset': VLAN.objects.prefetch_related('site', 'group', 'tenant', 'role'), + 'queryset': VLAN.objects.prefetch_related('site', 'group', 'tenant', 'tenant__group', 'role'), 'filterset': ipam.filtersets.VLANFilterSet, 'table': ipam.tables.VLANTable, 'url': 'ipam:vlan_list', }), ('asn', { - 'queryset': ASN.objects.prefetch_related('rir', 'tenant'), + 'queryset': ASN.objects.prefetch_related('rir', 'tenant', 'tenant__group'), 'filterset': ipam.filtersets.ASNFilterSet, 'table': ipam.tables.ASNTable, 'url': 'ipam:asn_list', @@ -223,7 +223,7 @@ VIRTUALIZATION_TYPES = OrderedDict( }), ('virtualmachine', { 'queryset': VirtualMachine.objects.prefetch_related( - 'cluster', 'tenant', 'platform', 'primary_ip4', 'primary_ip6', + 'cluster', 'tenant', 'tenant__group', 'platform', 'primary_ip4', 'primary_ip6', ), 'filterset': virtualization.filtersets.VirtualMachineFilterSet, 'table': virtualization.tables.VirtualMachineTable, From c7ece43a1887bdc1bb3daf894c0929b9babd0505 Mon Sep 17 00:00:00 2001 From: Kim Johansson Date: Sun, 10 Jul 2022 17:16:12 +0200 Subject: [PATCH 236/593] Remove Tenant Group from child tables Removes the Tenant Group column from tables which aren't configurable by the user. --- netbox/ipam/tables/ip.py | 7 ++++--- netbox/ipam/tables/vlans.py | 7 ++++--- 2 files changed, 8 insertions(+), 6 deletions(-) diff --git a/netbox/ipam/tables/ip.py b/netbox/ipam/tables/ip.py index e61d99fd8..bec05eeff 100644 --- a/netbox/ipam/tables/ip.py +++ b/netbox/ipam/tables/ip.py @@ -4,7 +4,7 @@ from django_tables2.utils import Accessor from ipam.models import * from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenancyColumnsMixin +from tenancy.tables import TenancyColumnsMixin, TenantColumn __all__ = ( 'AggregateTable', @@ -409,7 +409,7 @@ class IPAddressAssignTable(NetBoxTable): orderable = False -class AssignedIPAddressesTable(TenancyColumnsMixin, NetBoxTable): +class AssignedIPAddressesTable(NetBoxTable): """ List IP addresses assigned to an object. """ @@ -422,8 +422,9 @@ class AssignedIPAddressesTable(TenancyColumnsMixin, NetBoxTable): verbose_name='VRF' ) status = columns.ChoiceFieldColumn() + tenant = TenantColumn() class Meta(NetBoxTable.Meta): model = IPAddress - fields = ('address', 'vrf', 'status', 'role', 'tenant', 'tenant_group', 'description') + fields = ('address', 'vrf', 'status', 'role', 'tenant', 'description') exclude = ('id', ) diff --git a/netbox/ipam/tables/vlans.py b/netbox/ipam/tables/vlans.py index 4329177eb..7878de507 100644 --- a/netbox/ipam/tables/vlans.py +++ b/netbox/ipam/tables/vlans.py @@ -5,7 +5,7 @@ from django_tables2.utils import Accessor from dcim.models import Interface from ipam.models import * from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenancyColumnsMixin +from tenancy.tables import TenancyColumnsMixin, TenantColumn from virtualization.models import VMInterface __all__ = ( @@ -173,7 +173,7 @@ class VLANVirtualMachinesTable(VLANMembersTable): exclude = ('id', ) -class InterfaceVLANTable(TenancyColumnsMixin, NetBoxTable): +class InterfaceVLANTable(NetBoxTable): """ List VLANs assigned to a specific Interface. """ @@ -189,6 +189,7 @@ class InterfaceVLANTable(TenancyColumnsMixin, NetBoxTable): accessor=Accessor('group__name'), verbose_name='Group' ) + tenant = TenantColumn() status = columns.ChoiceFieldColumn() role = tables.Column( linkify=True @@ -196,7 +197,7 @@ class InterfaceVLANTable(TenancyColumnsMixin, NetBoxTable): class Meta(NetBoxTable.Meta): model = VLAN - fields = ('vid', 'tagged', 'site', 'group', 'name', 'tenant', 'tenant_group', 'status', 'role', 'description') + fields = ('vid', 'tagged', 'site', 'group', 'name', 'tenant', 'status', 'role', 'description') exclude = ('id', ) def __init__(self, interface, *args, **kwargs): From 1539769c08e200c8586de43700f8d152e7b3cc0d Mon Sep 17 00:00:00 2001 From: Kim Johansson Date: Sun, 10 Jul 2022 17:17:56 +0200 Subject: [PATCH 237/593] Prefetch Tenant Group on user configurable tables Prefetch the Tenant Group in views which allows its table to be configured by the user. This decreases the amount of database queries that are required to fetch the data. --- netbox/circuits/views.py | 6 +++--- netbox/dcim/views.py | 2 +- netbox/ipam/views.py | 8 ++++---- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/netbox/circuits/views.py b/netbox/circuits/views.py index f3b1269f9..11f211b27 100644 --- a/netbox/circuits/views.py +++ b/netbox/circuits/views.py @@ -30,7 +30,7 @@ class ProviderView(generic.ObjectView): circuits = Circuit.objects.restrict(request.user, 'view').filter( provider=instance ).prefetch_related( - 'type', 'tenant', 'terminations__site' + 'type', 'tenant', 'tenant__group', 'terminations__site' ) circuits_table = tables.CircuitTable(circuits, user=request.user, exclude=('provider',)) circuits_table.configure(request) @@ -91,7 +91,7 @@ class ProviderNetworkView(generic.ObjectView): Q(termination_a__provider_network=instance.pk) | Q(termination_z__provider_network=instance.pk) ).prefetch_related( - 'type', 'tenant', 'terminations__site' + 'type', 'tenant', 'tenant__group', 'terminations__site' ) circuits_table = tables.CircuitTable(circuits, user=request.user) circuits_table.configure(request) @@ -192,7 +192,7 @@ class CircuitTypeBulkDeleteView(generic.BulkDeleteView): class CircuitListView(generic.ObjectListView): queryset = Circuit.objects.prefetch_related( - 'provider', 'type', 'tenant', 'termination_a', 'termination_z' + 'provider', 'type', 'tenant', 'tenant__group', 'termination_a', 'termination_z' ) filterset = filtersets.CircuitFilterSet filterset_form = forms.CircuitFilterForm diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 35a1056b2..a466246f5 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -561,7 +561,7 @@ class RackRoleBulkDeleteView(generic.BulkDeleteView): class RackListView(generic.ObjectListView): queryset = Rack.objects.prefetch_related( - 'site', 'location', 'tenant', 'role', 'devices__device_type' + 'site', 'location', 'tenant', 'tenant_group', 'role', 'devices__device_type' ).annotate( device_count=count_related(Device, 'rack') ) diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 6bcdc4c64..e6b11c427 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -298,7 +298,7 @@ class AggregatePrefixesView(generic.ObjectChildrenView): def get_children(self, request, parent): return Prefix.objects.restrict(request.user, 'view').filter( prefix__net_contained_or_equal=str(parent.prefix) - ).prefetch_related('site', 'role', 'tenant', 'vlan') + ).prefetch_related('site', 'role', 'tenant', 'tenant__group', 'vlan') def prep_table_data(self, request, queryset, parent): # Determine whether to show assigned prefixes, available prefixes, or both @@ -470,7 +470,7 @@ class PrefixPrefixesView(generic.ObjectChildrenView): def get_children(self, request, parent): return parent.get_child_prefixes().restrict(request.user, 'view').prefetch_related( - 'site', 'vrf', 'vlan', 'role', 'tenant', + 'site', 'vrf', 'vlan', 'role', 'tenant', 'tenant__group' ) def prep_table_data(self, request, queryset, parent): @@ -499,7 +499,7 @@ class PrefixIPRangesView(generic.ObjectChildrenView): def get_children(self, request, parent): return parent.get_child_ranges().restrict(request.user, 'view').prefetch_related( - 'vrf', 'role', 'tenant', + 'vrf', 'role', 'tenant', 'tenant__group', ) def get_extra_context(self, request, instance): @@ -587,7 +587,7 @@ class IPRangeIPAddressesView(generic.ObjectChildrenView): def get_children(self, request, parent): return parent.get_child_ips().restrict(request.user, 'view').prefetch_related( - 'vrf', 'role', 'tenant', + 'vrf', 'role', 'tenant', 'tenant__group', ) def get_extra_context(self, request, instance): From 93c30c94b3b25642af2e74c536a16d18c8a3d102 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Sun, 10 Jul 2022 19:16:16 +0200 Subject: [PATCH 238/593] Focus on select field after populating data --- netbox/project-static/dist/netbox.js | Bin 376144 -> 376180 bytes netbox/project-static/dist/netbox.js.map | Bin 345564 -> 345595 bytes .../src/select/api/apiSelect.ts | 1 + 3 files changed, 1 insertion(+) diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index bc0cabef08f2cab679e475fe18741c4e97ee187e..b611079e17d534b7e0aea1ed07b5e33c124129f5 100644 GIT binary patch delta 42 ycmcccOYF-pv4$4L7N!>F7M3lnH-o0T<+2KLXXX`@mguGBCzlp)zZk??p9KJbz!4Mx delta 30 mcmezJOYFigv4$4L7N!>F7M3lnH-n~sk7ZTft`N)`k_7cxt0K_2NW&< delta 47 zcmey}EqbS0w4sHug{g&k3(JLX+uwgc`G#zP*o!HP;dV D&I=I5 diff --git a/netbox/project-static/src/select/api/apiSelect.ts b/netbox/project-static/src/select/api/apiSelect.ts index f5b605d58..798694f0e 100644 --- a/netbox/project-static/src/select/api/apiSelect.ts +++ b/netbox/project-static/src/select/api/apiSelect.ts @@ -411,6 +411,7 @@ export class APISelect { } finally { this.setOptionStyles(); this.enable(); + this.slim.slim.search.input.focus(); this.base.dispatchEvent(this.loadEvent); } } From d3f91ce0a6140f4e2ecfdbaf7287ec4527de265a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 09:57:12 -0400 Subject: [PATCH 239/593] Changelog for #9632, #9686 --- 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 9b4dc800d..7c62f85ad 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -8,12 +8,14 @@ * [#9396](https://github.com/netbox-community/netbox/issues/9396) - Allow filtering modules by bay ID * [#9403](https://github.com/netbox-community/netbox/issues/9403) - Enable modifying virtual chassis properties when creating/editing a device * [#9540](https://github.com/netbox-community/netbox/issues/9540) - Add filters for assigned device & VM to IP addresses list +* [#9686](https://github.com/netbox-community/netbox/issues/9686) - Add tenant group column for all object tables with tenant assignments ### Bug Fixes * [#8854](https://github.com/netbox-community/netbox/issues/8854) - Fix `REMOTE_AUTH_DEFAULT_GROUPS` for social-auth backends * [#9575](https://github.com/netbox-community/netbox/issues/9575) - Fix AttributeError exception for FHRP group with an IP address assigned * [#9597](https://github.com/netbox-community/netbox/issues/9597) - Include `installed_module` in module bay REST API serializer +* [#9632](https://github.com/netbox-community/netbox/issues/9632) - Automatically focus on search box when expanding dropdowns * [#9657](https://github.com/netbox-community/netbox/issues/9657) - Fix filtering for custom fields and webhooks in the UI * [#9682](https://github.com/netbox-community/netbox/issues/9682) - Fix bulk assignment of ASNs to sites From e2af716a81b84972ce2f310d1f9f11d2a54f5367 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 10:03:45 -0400 Subject: [PATCH 240/593] #9686: Add default accessor to TenantGroupColumn --- netbox/tenancy/tables/columns.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/tenancy/tables/columns.py b/netbox/tenancy/tables/columns.py index 2d25590aa..21622f18b 100644 --- a/netbox/tenancy/tables/columns.py +++ b/netbox/tenancy/tables/columns.py @@ -42,11 +42,11 @@ class TenantGroupColumn(tables.TemplateColumn): {% endif %} """ - def __init__(self, *args, **kwargs): + def __init__(self, accessor=tables.A('tenant__group'), *args, **kwargs): if 'verbose_name' not in kwargs: kwargs['verbose_name'] = 'Tenant Group' - super().__init__(template_code=self.template_code, *args, **kwargs) + super().__init__(template_code=self.template_code, accessor=accessor, *args, **kwargs) def value(self, value): return str(value) if value else None From ed7f42a803c5a2d2af28a817b45d672ef417c728 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 10:28:37 -0400 Subject: [PATCH 241/593] Fixes #9704: Include last_updated field on JournalEntry REST API serializer --- docs/release-notes/version-3.2.md | 1 + netbox/extras/api/serializers.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 7c62f85ad..83c0765c3 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -18,6 +18,7 @@ * [#9632](https://github.com/netbox-community/netbox/issues/9632) - Automatically focus on search box when expanding dropdowns * [#9657](https://github.com/netbox-community/netbox/issues/9657) - Fix filtering for custom fields and webhooks in the UI * [#9682](https://github.com/netbox-community/netbox/issues/9682) - Fix bulk assignment of ASNs to sites +* [#9704](https://github.com/netbox-community/netbox/issues/9704) - Include `last_updated` field on JournalEntry REST API serializer --- diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index e05d4083c..bdb54067a 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -221,7 +221,7 @@ class JournalEntrySerializer(NetBoxModelSerializer): model = JournalEntry fields = [ 'id', 'url', 'display', 'assigned_object_type', 'assigned_object_id', 'assigned_object', 'created', - 'created_by', 'kind', 'comments', 'tags', 'custom_fields', + 'created_by', 'kind', 'comments', 'tags', 'custom_fields', 'last_updated', ] def validate(self, data): From 6415661b61d85a12a0b8002719623d19477574f2 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 10:33:14 -0400 Subject: [PATCH 242/593] Remove extraneous argument to GenericRelation --- netbox/dcim/models/device_components.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 9a0609c12..714ee3ff5 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -95,8 +95,7 @@ class ModularComponentModel(ComponentModel): inventory_items = GenericRelation( to='dcim.InventoryItem', content_type_field='component_type', - object_id_field='component_id', - related_name='%(class)ss', + object_id_field='component_id' ) class Meta: From 7c109ffd8cb6e9c76c440263568fb7194519e491 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 11:02:18 -0400 Subject: [PATCH 243/593] Fixes #9697: Fix device role link under device view --- netbox/templates/dcim/device.html | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/netbox/templates/dcim/device.html b/netbox/templates/dcim/device.html index d3d6f03dc..68af0c08f 100644 --- a/netbox/templates/dcim/device.html +++ b/netbox/templates/dcim/device.html @@ -46,13 +46,7 @@ Rack - - {% if object.rack %} - {{ object.rack }} - {% else %} - {{ ''|placeholder }} - {% endif %} - + {{ object.rack|linkify|placeholder }} Position @@ -161,9 +155,7 @@ Role - - {{ object.device_role }} - + {{ object.device_role|linkify }} Platform @@ -173,7 +165,7 @@ Primary IPv4 {% if object.primary_ip4 %} - {{ object.primary_ip4.address.ip }} + {{ object.primary_ip4.address.ip }} {% if object.primary_ip4.nat_inside %} (NAT for {{ object.primary_ip4.nat_inside.address.ip|linkify }}) {% elif object.primary_ip4.nat_outside %} @@ -188,7 +180,7 @@ Primary IPv6 {% if object.primary_ip6 %} - {{ object.primary_ip6.address.ip }} + {{ object.primary_ip6.address.ip }} {% if object.primary_ip6.nat_inside %} (NAT for {{ object.primary_ip6.nat_inside.address.ip|linkify }}) {% elif object.primary_ip6.nat_outside %} From 5a4467a4a8cc92b83606a8bbc661873b5fd294cd Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 11:12:06 -0400 Subject: [PATCH 244/593] Fixes #9687: Don't restrict custom text field lengths when entering via UI form --- docs/models/extras/customfield.md | 2 +- docs/release-notes/version-3.2.md | 1 + netbox/extras/models/customfields.py | 9 ++------- 3 files changed, 4 insertions(+), 8 deletions(-) diff --git a/docs/models/extras/customfield.md b/docs/models/extras/customfield.md index da73816b6..e0c01688d 100644 --- a/docs/models/extras/customfield.md +++ b/docs/models/extras/customfield.md @@ -10,7 +10,7 @@ Within the database, custom fields are stored as JSON data directly alongside ea Custom fields may be created by navigating to Customization > Custom Fields. NetBox supports six types of custom field: -* Text: Free-form text (up to 255 characters) +* Text: Free-form text (intended for single-line use) * Long text: Free-form of any length; supports Markdown rendering * Integer: A whole number (positive or negative) * Boolean: True or false diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 83c0765c3..86a352215 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -18,6 +18,7 @@ * [#9632](https://github.com/netbox-community/netbox/issues/9632) - Automatically focus on search box when expanding dropdowns * [#9657](https://github.com/netbox-community/netbox/issues/9657) - Fix filtering for custom fields and webhooks in the UI * [#9682](https://github.com/netbox-community/netbox/issues/9682) - Fix bulk assignment of ASNs to sites +* [#9687](https://github.com/netbox-community/netbox/issues/9687) - Don't restrict custom text field lengths when entering via UI form * [#9704](https://github.com/netbox-community/netbox/issues/9704) - Include `last_updated` field on JournalEntry REST API serializer --- diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index 49afe1bba..6a8c1dacf 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -365,13 +365,8 @@ class CustomField(ExportTemplatesMixin, WebhooksMixin, ChangeLoggedModel): # Text else: - if self.type == CustomFieldTypeChoices.TYPE_LONGTEXT: - max_length = None - widget = forms.Textarea - else: - max_length = 255 - widget = None - field = forms.CharField(max_length=max_length, required=required, initial=initial, widget=widget) + widget = forms.Textarea if self.type == CustomFieldTypeChoices.TYPE_LONGTEXT else None + field = forms.CharField(required=required, initial=initial, widget=widget) if self.validation_regex: field.validators = [ RegexValidator( From 68f24755aa4d8464111dd3eda320eee1cb99d53f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 11:40:10 -0400 Subject: [PATCH 245/593] Release v3.2.6 --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 2 +- base_requirements.txt | 8 ++++---- docs/release-notes/version-3.2.md | 2 +- netbox/netbox/settings.py | 2 +- requirements.txt | 12 ++++++------ 6 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 3b87a49e4..78231890b 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.5 + placeholder: v3.2.6 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 1fc0268ab..71d45092c 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.5 + placeholder: v3.2.6 validations: required: true - type: dropdown diff --git a/base_requirements.txt b/base_requirements.txt index 98d3f78c2..9dc85231b 100644 --- a/base_requirements.txt +++ b/base_requirements.txt @@ -1,3 +1,7 @@ +# HTML sanitizer +# https://github.com/mozilla/bleach +bleach + # The Python web framework on which NetBox is built # https://github.com/django/django Django @@ -126,7 +130,3 @@ tablib # Timezone data (required by django-timezone-field on Python 3.9+) # https://github.com/python/tzdata tzdata - -# HTML sanitizer -# https://github.com/mozilla/bleach -bleach \ No newline at end of file diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 86a352215..8775da01f 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.6 (FUTURE) +## v3.2.6 (2022-07-11) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index c0df42a2b..b9d7e20b9 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.6-dev' +VERSION = '3.2.6' # Hostname HOSTNAME = platform.node() diff --git a/requirements.txt b/requirements.txt index 1fdace4f0..f987ad7ba 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ -bleach==5.0.0 -Django==4.0.5 +bleach==5.0.1 +Django==4.0.6 django-cors-headers==3.13.0 -django-debug-toolbar==3.4.0 +django-debug-toolbar==3.5.0 django-filter==22.1 django-graphiql-debug-toolbar==0.2.0 django-mptt==0.13.4 @@ -19,13 +19,13 @@ gunicorn==20.1.0 Jinja2==3.1.2 Markdown==3.3.7 markdown-include==0.6.0 -mkdocs-material==8.3.6 +mkdocs-material==8.3.9 mkdocstrings[python-legacy]==0.19.0 netaddr==0.8.0 -Pillow==9.1.1 +Pillow==9.2.0 psycopg2-binary==2.9.3 PyYAML==6.0 -sentry-sdk==1.5.12 +sentry-sdk==1.7.0 social-auth-app-django==5.0.0 social-auth-core==4.3.0 svgwrite==1.4.2 From e106d7ac3a2a2f30b92bf2e8bd9df8f40e1e23c5 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 12:11:50 -0400 Subject: [PATCH 246/593] 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 8775da01f..1ba6235b8 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.7 (FUTURE) + +--- + ## v3.2.6 (2022-07-11) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index b9d7e20b9..736290380 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.6' +VERSION = '3.2.7-dev' # Hostname HOSTNAME = platform.node() From 57397570c08f27148c10a65a00d245147647a33f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 12:45:53 -0400 Subject: [PATCH 247/593] Drop extraneous/invalid prefetches --- netbox/dcim/views.py | 4 +--- netbox/ipam/views.py | 4 +--- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index a466246f5..ec3e9152e 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -560,9 +560,7 @@ class RackRoleBulkDeleteView(generic.BulkDeleteView): # class RackListView(generic.ObjectListView): - queryset = Rack.objects.prefetch_related( - 'site', 'location', 'tenant', 'tenant_group', 'role', 'devices__device_type' - ).annotate( + queryset = Rack.objects.prefetch_related('devices__device_type').annotate( device_count=count_related(Device, 'rack') ) filterset = filtersets.RackFilterSet diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index e6b11c427..706670cad 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -586,9 +586,7 @@ class IPRangeIPAddressesView(generic.ObjectChildrenView): template_name = 'ipam/iprange/ip_addresses.html' def get_children(self, request, parent): - return parent.get_child_ips().restrict(request.user, 'view').prefetch_related( - 'vrf', 'role', 'tenant', 'tenant__group', - ) + return parent.get_child_ips().restrict(request.user, 'view') def get_extra_context(self, request, instance): return { From 531d961d30bdcd91ff1b9ffc7d3f147f481e0101 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 14:47:15 -0400 Subject: [PATCH 248/593] Add API tokens to user menu --- netbox/templates/inc/profile_button.html | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/netbox/templates/inc/profile_button.html b/netbox/templates/inc/profile_button.html index 1e562651f..e48ec2148 100644 --- a/netbox/templates/inc/profile_button.html +++ b/netbox/templates/inc/profile_button.html @@ -28,6 +28,11 @@ Preferences +
  • + + API Tokens + +
  • From 123e758c6d86d6a1605ebdf076e36b4c3acaf8f3 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 15:43:59 -0400 Subject: [PATCH 249/593] Closes #9708: Render user API tokens in a table --- netbox/templates/inc/profile_button.html | 6 +- netbox/templates/users/api_tokens.html | 87 +++++------------------- netbox/templates/users/base.html | 8 +-- netbox/templates/users/password.html | 2 +- netbox/templates/users/preferences.html | 2 +- netbox/users/tables.py | 42 ++++++++++++ netbox/users/urls.py | 2 +- netbox/users/views.py | 24 ++++--- 8 files changed, 83 insertions(+), 90 deletions(-) create mode 100644 netbox/users/tables.py diff --git a/netbox/templates/inc/profile_button.html b/netbox/templates/inc/profile_button.html index e48ec2148..b63b25464 100644 --- a/netbox/templates/inc/profile_button.html +++ b/netbox/templates/inc/profile_button.html @@ -19,17 +19,17 @@ {% endif %}
  • - + Profile
  • - + Preferences
  • - + API Tokens
    • diff --git a/netbox/templates/users/api_tokens.html b/netbox/templates/users/api_tokens.html index 24b32cc9b..e1641468c 100644 --- a/netbox/templates/users/api_tokens.html +++ b/netbox/templates/users/api_tokens.html @@ -1,78 +1,25 @@ {% extends 'users/base.html' %} {% load helpers %} +{% load render_table from django_tables2 %} {% block title %}API Tokens{% endblock %} {% block content %} -
    -
    - {% for token in tokens %} -
    -
    -
    - Copy - Edit - Delete -
    - - {{ token.key }} - {% if token.is_expired %} - Expired - {% endif %} -
    -
    -
    -
    - Created
    - {{ token.created|annotated_date }} -
    -
    - Expires
    - {% if token.expires %} - {{ token.expires|annotated_date }} - {% else %} - Never - {% endif %} -
    -
    - Last Used
    - {% if token.last_used %} - {{ token.last_used|annotated_date }} - {% else %} - Never - {% endif %} -
    -
    - Create/Edit/Delete Operations
    - {% if token.write_enabled %} - Enabled - {% else %} - Disabled - {% endif %} -
    -
    - Allowed Source IPs
    - {% if token.allowed_ips %} - {{ token.allowed_ips|join:', ' }} - {% else %} - Any - {% endif %} -
    - {% if token.description %} -
    {{ token.description }} - {% endif %} -
    -
    - {% empty %} -
    You do not have any API tokens.
    -

    Tokens are used to authenticate REST and GraphQL API requests.

    - {% endfor %} -
    - - - Add a Token - -
    -
    +
    +
    + + Add a Token + +
    +
    +
    +
    +
    +
    + {% render_table table 'inc/table.html' %} + {% include 'inc/paginator.html' with paginator=table.paginator page=table.page %} +
    +
    +
    {% endblock %} diff --git a/netbox/templates/users/base.html b/netbox/templates/users/base.html index cf4cd585d..58861ee90 100644 --- a/netbox/templates/users/base.html +++ b/netbox/templates/users/base.html @@ -3,18 +3,18 @@ {% block tabs %} {% endblock %} diff --git a/netbox/templates/users/password.html b/netbox/templates/users/password.html index 81082792d..02e80bb26 100644 --- a/netbox/templates/users/password.html +++ b/netbox/templates/users/password.html @@ -13,7 +13,7 @@ {% render_field form.new_password2 %}
    - Cancel + Cancel
    diff --git a/netbox/templates/users/preferences.html b/netbox/templates/users/preferences.html index 6ce60a458..f2c88db3c 100644 --- a/netbox/templates/users/preferences.html +++ b/netbox/templates/users/preferences.html @@ -79,7 +79,7 @@
    - Cancel + Cancel
    diff --git a/netbox/users/tables.py b/netbox/users/tables.py new file mode 100644 index 000000000..27547b955 --- /dev/null +++ b/netbox/users/tables.py @@ -0,0 +1,42 @@ +from .models import Token +from netbox.tables import NetBoxTable, columns + +__all__ = ( + 'TokenTable', +) + + +TOKEN = """{{ value }}""" + +ALLOWED_IPS = """{{ value|join:", " }}""" + +COPY_BUTTON = """ + + + +""" + + +class TokenTable(NetBoxTable): + key = columns.TemplateColumn( + template_code=TOKEN + ) + write_enabled = columns.BooleanColumn( + verbose_name='Write' + ) + created = columns.DateColumn() + expired = columns.DateColumn() + last_used = columns.DateTimeColumn() + allowed_ips = columns.TemplateColumn( + template_code=ALLOWED_IPS + ) + actions = columns.ActionsColumn( + actions=('edit', 'delete'), + extra_buttons=COPY_BUTTON + ) + + class Meta(NetBoxTable.Meta): + model = Token + fields = ( + 'pk', 'key', 'write_enabled', 'created', 'expires', 'last_used', 'allowed_ips', 'description', + ) diff --git a/netbox/users/urls.py b/netbox/users/urls.py index 0cfcfc9de..62b17a663 100644 --- a/netbox/users/urls.py +++ b/netbox/users/urls.py @@ -2,7 +2,7 @@ from django.urls import path from . import views -app_name = 'user' +app_name = 'users' urlpatterns = [ path('profile/', views.ProfileView.as_view(), name='profile'), diff --git a/netbox/users/views.py b/netbox/users/views.py index 6a923e77e..aabdd6774 100644 --- a/netbox/users/views.py +++ b/netbox/users/views.py @@ -21,6 +21,7 @@ from netbox.config import get_config from utilities.forms import ConfirmationForm from .forms import LoginForm, PasswordChangeForm, TokenForm, UserConfigForm from .models import Token +from .tables import TokenTable # @@ -157,7 +158,7 @@ class UserConfigView(LoginRequiredMixin, View): form.save() messages.success(request, "Your preferences have been updated.") - return redirect('user:preferences') + return redirect('users:preferences') return render(request, self.template_name, { 'form': form, @@ -172,7 +173,7 @@ class ChangePasswordView(LoginRequiredMixin, View): # LDAP users cannot change their password here if getattr(request.user, 'ldap_username', None): messages.warning(request, "LDAP-authenticated user credentials cannot be changed within NetBox.") - return redirect('user:profile') + return redirect('users:profile') form = PasswordChangeForm(user=request.user) @@ -187,7 +188,7 @@ class ChangePasswordView(LoginRequiredMixin, View): form.save() update_session_auth_hash(request, form.user) messages.success(request, "Your password has been changed successfully.") - return redirect('user:profile') + return redirect('users:profile') return render(request, self.template_name, { 'form': form, @@ -204,10 +205,13 @@ class TokenListView(LoginRequiredMixin, View): def get(self, request): tokens = Token.objects.filter(user=request.user) + table = TokenTable(tokens) + table.configure(request) return render(request, 'users/api_tokens.html', { 'tokens': tokens, 'active_tab': 'api-tokens', + 'table': table, }) @@ -225,7 +229,7 @@ class TokenEditView(LoginRequiredMixin, View): return render(request, 'generic/object_edit.html', { 'object': token, 'form': form, - 'return_url': reverse('user:token_list'), + 'return_url': reverse('users:token_list'), }) def post(self, request, pk=None): @@ -248,12 +252,12 @@ class TokenEditView(LoginRequiredMixin, View): if '_addanother' in request.POST: return redirect(request.path) else: - return redirect('user:token_list') + return redirect('users:token_list') return render(request, 'generic/object_edit.html', { 'object': token, 'form': form, - 'return_url': reverse('user:token_list'), + 'return_url': reverse('users:token_list'), }) @@ -263,14 +267,14 @@ class TokenDeleteView(LoginRequiredMixin, View): token = get_object_or_404(Token.objects.filter(user=request.user), pk=pk) initial_data = { - 'return_url': reverse('user:token_list'), + 'return_url': reverse('users:token_list'), } form = ConfirmationForm(initial=initial_data) return render(request, 'generic/object_delete.html', { 'object': token, 'form': form, - 'return_url': reverse('user:token_list'), + 'return_url': reverse('users:token_list'), }) def post(self, request, pk): @@ -280,10 +284,10 @@ class TokenDeleteView(LoginRequiredMixin, View): if form.is_valid(): token.delete() messages.success(request, "Token deleted") - return redirect('user:token_list') + return redirect('users:token_list') return render(request, 'generic/object_delete.html', { 'object': token, 'form': form, - 'return_url': reverse('user:token_list'), + 'return_url': reverse('users:token_list'), }) From 8a8ada852959c745103e8351cf5d4ea83a96c114 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 16:14:46 -0400 Subject: [PATCH 250/593] #9177: Use TenancyColumnsMixin (from #9686) --- netbox/wireless/tables/wirelesslan.py | 9 ++++----- netbox/wireless/tables/wirelesslink.py | 9 ++++----- 2 files changed, 8 insertions(+), 10 deletions(-) diff --git a/netbox/wireless/tables/wirelesslan.py b/netbox/wireless/tables/wirelesslan.py index fc791d730..af0cdae88 100644 --- a/netbox/wireless/tables/wirelesslan.py +++ b/netbox/wireless/tables/wirelesslan.py @@ -2,7 +2,7 @@ import django_tables2 as tables from dcim.models import Interface from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin from wireless.models import * __all__ = ( @@ -33,14 +33,13 @@ class WirelessLANGroupTable(NetBoxTable): default_columns = ('pk', 'name', 'wirelesslan_count', 'description') -class WirelessLANTable(NetBoxTable): +class WirelessLANTable(TenancyColumnsMixin, NetBoxTable): ssid = tables.Column( linkify=True ) group = tables.Column( linkify=True ) - tenant = TenantColumn() interface_count = tables.Column( verbose_name='Interfaces' ) @@ -51,8 +50,8 @@ class WirelessLANTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = WirelessLAN fields = ( - 'pk', 'ssid', 'group', 'tenant', 'description', 'vlan', 'interface_count', 'auth_type', 'auth_cipher', - 'auth_psk', 'tags', 'created', 'last_updated', + 'pk', 'ssid', 'group', 'tenant', 'tenant_group', 'description', 'vlan', 'interface_count', 'auth_type', + 'auth_cipher', 'auth_psk', 'tags', 'created', 'last_updated', ) default_columns = ('pk', 'ssid', 'group', 'description', 'vlan', 'auth_type', 'interface_count') diff --git a/netbox/wireless/tables/wirelesslink.py b/netbox/wireless/tables/wirelesslink.py index 6a45a21ae..0135ce620 100644 --- a/netbox/wireless/tables/wirelesslink.py +++ b/netbox/wireless/tables/wirelesslink.py @@ -1,7 +1,7 @@ import django_tables2 as tables from netbox.tables import NetBoxTable, columns -from tenancy.tables import TenantColumn +from tenancy.tables import TenancyColumnsMixin from wireless.models import * __all__ = ( @@ -9,7 +9,7 @@ __all__ = ( ) -class WirelessLinkTable(NetBoxTable): +class WirelessLinkTable(TenancyColumnsMixin, NetBoxTable): id = tables.Column( linkify=True, verbose_name='ID' @@ -29,7 +29,6 @@ class WirelessLinkTable(NetBoxTable): interface_b = tables.Column( linkify=True ) - tenant = TenantColumn() tags = columns.TagColumn( url_name='wireless:wirelesslink_list' ) @@ -37,8 +36,8 @@ class WirelessLinkTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = WirelessLink fields = ( - 'pk', 'id', 'status', 'device_a', 'interface_a', 'device_b', 'interface_b', 'ssid', 'tenant', 'description', - 'auth_type', 'auth_cipher', 'auth_psk', 'tags', 'created', 'last_updated', + 'pk', 'id', 'status', 'device_a', 'interface_a', 'device_b', 'interface_b', 'ssid', 'tenant', + 'tenant_group', 'description', 'auth_type', 'auth_cipher', 'auth_psk', 'tags', 'created', 'last_updated', ) default_columns = ( 'pk', 'id', 'status', 'device_a', 'interface_a', 'device_b', 'interface_b', 'ssid', 'auth_type', From 2264937f815acef7500a79796b70482cb33a15d3 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 17:11:58 -0400 Subject: [PATCH 251/593] Consolidate custom field migrations --- ..._name.py => 0074_customfield_extensions.py} | 5 +++++ ...ions.py => 0075_configcontext_locations.py} | 2 +- .../0075_customfield_ui_visibility.py | 18 ------------------ netbox/ipam/migrations/0059_l2vpn.py | 2 +- 4 files changed, 7 insertions(+), 20 deletions(-) rename netbox/extras/migrations/{0074_customfield_group_name.py => 0074_customfield_extensions.py} (75%) rename netbox/extras/migrations/{0076_configcontext_locations.py => 0075_configcontext_locations.py} (88%) delete mode 100644 netbox/extras/migrations/0075_customfield_ui_visibility.py diff --git a/netbox/extras/migrations/0074_customfield_group_name.py b/netbox/extras/migrations/0074_customfield_extensions.py similarity index 75% rename from netbox/extras/migrations/0074_customfield_group_name.py rename to netbox/extras/migrations/0074_customfield_extensions.py index e1be76b1f..6ca8b958f 100644 --- a/netbox/extras/migrations/0074_customfield_group_name.py +++ b/netbox/extras/migrations/0074_customfield_extensions.py @@ -19,4 +19,9 @@ class Migration(migrations.Migration): name='group_name', field=models.CharField(blank=True, max_length=50), ), + migrations.AddField( + model_name='customfield', + name='ui_visibility', + field=models.CharField(default='read-write', max_length=50), + ), ] diff --git a/netbox/extras/migrations/0076_configcontext_locations.py b/netbox/extras/migrations/0075_configcontext_locations.py similarity index 88% rename from netbox/extras/migrations/0076_configcontext_locations.py rename to netbox/extras/migrations/0075_configcontext_locations.py index f9b3a664b..853aec4f7 100644 --- a/netbox/extras/migrations/0076_configcontext_locations.py +++ b/netbox/extras/migrations/0075_configcontext_locations.py @@ -7,7 +7,7 @@ class Migration(migrations.Migration): dependencies = [ ('dcim', '0156_location_status'), - ('extras', '0075_customfield_ui_visibility'), + ('extras', '0074_customfield_extensions'), ] operations = [ diff --git a/netbox/extras/migrations/0075_customfield_ui_visibility.py b/netbox/extras/migrations/0075_customfield_ui_visibility.py deleted file mode 100644 index 29ee65516..000000000 --- a/netbox/extras/migrations/0075_customfield_ui_visibility.py +++ /dev/null @@ -1,18 +0,0 @@ -# Generated by Django 4.0.4 on 2022-05-23 20:23 - -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('extras', '0074_customfield_group_name'), - ] - - operations = [ - migrations.AddField( - model_name='customfield', - name='ui_visibility', - field=models.CharField(default='read-write', max_length=50), - ), - ] diff --git a/netbox/ipam/migrations/0059_l2vpn.py b/netbox/ipam/migrations/0059_l2vpn.py index 5662049c3..ef670ddea 100644 --- a/netbox/ipam/migrations/0059_l2vpn.py +++ b/netbox/ipam/migrations/0059_l2vpn.py @@ -9,7 +9,7 @@ import taggit.managers class Migration(migrations.Migration): dependencies = [ - ('extras', '0076_configcontext_locations'), + ('extras', '0075_configcontext_locations'), ('contenttypes', '0002_remove_content_type_name'), ('tenancy', '0007_contact_link'), ('ipam', '0058_ipaddress_nat_inside_nonunique'), From 1ddb219a0cd0232524fe18638cb7f4265fb00a48 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 17:29:25 -0400 Subject: [PATCH 252/593] Documentation cleanup --- docs/configuration/optional-settings.md | 2 ++ docs/models/extras/customfield.md | 30 ++++++++++++++++++--- docs/models/users/objectpermission.md | 2 +- docs/models/users/token.md | 9 ++++++- docs/plugins/development/models.md | 4 +-- mkdocs.yml | 2 +- netbox/extras/webhooks.py | 2 +- netbox/netbox/views/generic/object_views.py | 3 ++- netbox/users/forms.py | 2 +- 9 files changed, 45 insertions(+), 11 deletions(-) diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md index 3b1c848a7..8e5664a95 100644 --- a/docs/configuration/optional-settings.md +++ b/docs/configuration/optional-settings.md @@ -212,6 +212,7 @@ The following model fields support configurable choices: * `circuits.Circuit.status` * `dcim.Device.status` +* `dcim.Location.status` * `dcim.PowerFeed.status` * `dcim.Rack.status` * `dcim.Site.status` @@ -220,6 +221,7 @@ The following model fields support configurable choices: * `ipam.IPRange.status` * `ipam.Prefix.status` * `ipam.VLAN.status` +* `virtualization.Cluster.status` * `virtualization.VirtualMachine.status` The following colors are supported: diff --git a/docs/models/extras/customfield.md b/docs/models/extras/customfield.md index e0c01688d..3f6860758 100644 --- a/docs/models/extras/customfield.md +++ b/docs/models/extras/customfield.md @@ -26,11 +26,35 @@ Each custom field must have a name. This should be a simple database-friendly st Marking a field as required will force the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields, or the exact value of a choice for selection fields. -The filter logic controls how values are matched when filtering objects by the custom field. Loose filtering (the default) matches on a partial value, whereas exact matching requires a complete match of the given string to a field's value. For example, exact filtering with the string "red" will only match the exact value "red", whereas loose filtering will match on the values "red", "red-orange", or "bored". Setting the filter logic to "disabled" disables filtering by the field entirely. - A custom field must be assigned to one or more object types, or models, in NetBox. Once created, custom fields will automatically appear as part of these models in the web UI and REST API. Note that not all models support custom fields. -### Custom Field Validation +### Filtering + +The filter logic controls how values are matched when filtering objects by the custom field. Loose filtering (the default) matches on a partial value, whereas exact matching requires a complete match of the given string to a field's value. For example, exact filtering with the string "red" will only match the exact value "red", whereas loose filtering will match on the values "red", "red-orange", or "bored". Setting the filter logic to "disabled" disables filtering by the field entirely. + +### Grouping + +!!! note + This feature was introduced in NetBox v3.3. + +Related custom fields can be grouped together within the UI by assigning each the same group name. When at least one custom field for an object type has a group defined, it will appear under the group heading within the custom fields panel under the object view. All custom fields with the same group name will appear under that heading. (Note that the group names must match exactly, or each will appear as a separate heading.) + +This parameter has no effect on the API representation of custom field data. + +### Visibility + +!!! note + This feature was introduced in NetBox v3.3. + +When creating a custom field, there are three options for UI visibility. These control how and whether the custom field is displayed within the NetBox UI. + +* **Read/write** (default): The custom field is included when viewing and editing objects. +* **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.) +* **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users. + +Note that this setting has no impact on the REST or GraphQL APIs: Custom field data will always be available via either API. + +### Validation NetBox supports limited custom validation for custom field values. Following are the types of validation enforced for each field type: diff --git a/docs/models/users/objectpermission.md b/docs/models/users/objectpermission.md index 075a2cae5..82dbc955a 100644 --- a/docs/models/users/objectpermission.md +++ b/docs/models/users/objectpermission.md @@ -54,7 +54,7 @@ To achieve a logical OR with a different set of constraints, define multiple obj Additionally, where multiple permissions have been assigned for an object type, their collective constraints will be merged using a logical "OR" operation. -### Tokens +### User Token !!! info "This feature was introduced in NetBox v3.3" diff --git a/docs/models/users/token.md b/docs/models/users/token.md index 367444477..f6c5bfe80 100644 --- a/docs/models/users/token.md +++ b/docs/models/users/token.md @@ -9,4 +9,11 @@ Each token contains a 160-bit key represented as 40 hexadecimal characters. When By default, a token can be used to perform all actions via the API that a user would be permitted to do via the web UI. Deselecting the "write enabled" option will restrict API requests made with the token to read operations (e.g. GET) only. -Additionally, a token can be set to expire at a specific time. This can be useful if an external client needs to be granted temporary access to NetBox. Tokens can also be restricted by IP range: If defined, authentication for API clients connecting from an IP address outside these ranges will fail. +Additionally, a token can be set to expire at a specific time. This can be useful if an external client needs to be granted temporary access to NetBox. + +### Client IP Restriction + +!!! note + This feature was introduced in NetBox v3.3. + +Each API token can optionally be restricted by client IP address. If one or more allowed IP prefixes/addresses is defined for a token, authentication will fail for any client connecting from an IP address outside the defined range(s). This enables restricting the use a token to a specific client. (By default, any client IP address is permitted.) diff --git a/docs/plugins/development/models.md b/docs/plugins/development/models.md index 43e3cad9a..6d7075b80 100644 --- a/docs/plugins/development/models.md +++ b/docs/plugins/development/models.md @@ -37,7 +37,7 @@ This class performs two crucial functions: 1. Apply any fields, methods, and/or attributes necessary to the operation of these features 2. Register the model with NetBox as utilizing these features -Simply subclass BaseModel when defining a model in your plugin: +Simply subclass NetBoxModel when defining a model in your plugin: ```python # models.py @@ -54,7 +54,7 @@ class MyModel(NetBoxModel): !!! info This method was introduced in NetBox v3.3. -The `NetBoxModel` class includes a `clone()` method to be used for gathering attriubtes which can be used to create a "cloned" instance. This is used primarily for form initialization, e.g. when using the "clone" button in the NetBox UI. By default, this method will replicate any fields listed in the model's `clone_fields` list, if defined. +The `NetBoxModel` class includes a `clone()` method to be used for gathering attributes which can be used to create a "cloned" instance. This is used primarily for form initialization, e.g. when using the "clone" button in the NetBox UI. By default, this method will replicate any fields listed in the model's `clone_fields` list, if defined. Plugin models can leverage this method by defining `clone_fields` as a list of field names to be replicated, or override this method to replace or extend its content: diff --git a/mkdocs.yml b/mkdocs.yml index 88a2794e8..5e9f4b842 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -131,7 +131,7 @@ nav: - NetBox Shell: 'administration/netbox-shell.md' - REST API: - Overview: 'rest-api/overview.md' - - Filtering: 'rest-api/filtering.md' + - Filtering & Ordering: 'rest-api/filtering.md' - Authentication: 'rest-api/authentication.md' - GraphQL API: - Overview: 'graphql-api/overview.md' diff --git a/netbox/extras/webhooks.py b/netbox/extras/webhooks.py index 334539026..bef90a245 100644 --- a/netbox/extras/webhooks.py +++ b/netbox/extras/webhooks.py @@ -31,7 +31,7 @@ def get_snapshots(instance, action): 'postchange': None, } if action != ObjectChangeActionChoices.ACTION_DELETE: - # Use model's serialize() method if defined; fall back to serialize_object + # Use model's serialize_object() method if defined; fall back to serialize_object() utility function if hasattr(instance, 'serialize_object'): snapshots['postchange'] = instance.serialize_object() else: diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index dc078a7e2..cb3f58123 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -72,7 +72,8 @@ class ObjectView(BaseObjectView): class ObjectChildrenView(ObjectView, ActionsMixin, TableMixin): """ - Display a table of child objects associated with the parent object. + Display a table of child objects associated with the parent object. For example, NetBox uses this to display + the set of child IP addresses within a parent prefix. Attributes: child_model: The model class which represents the child objects diff --git a/netbox/users/forms.py b/netbox/users/forms.py index 8692eb050..b4e86461d 100644 --- a/netbox/users/forms.py +++ b/netbox/users/forms.py @@ -106,7 +106,7 @@ class TokenForm(BootstrapMixin, forms.ModelForm): required=False, label='Allowed IPs', help_text='Allowed IPv4/IPv6 networks from where the token can be used. Leave blank for no restrictions. ' - 'Ex: "10.1.1.0/24, 192.168.10.16/32, 2001:DB8:1::/64"', + 'Example: 10.1.1.0/24,192.168.10.16/32,2001:db8:1::/64', ) class Meta: From 53372a747109479f632fc916244d14fb75253f60 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 11 Jul 2022 21:51:39 -0400 Subject: [PATCH 253/593] #8157: General cleanup & fix tests --- netbox/ipam/filtersets.py | 25 ++-- netbox/ipam/forms/bulk_edit.py | 9 +- netbox/ipam/forms/bulk_import.py | 2 +- netbox/ipam/forms/filtersets.py | 38 ++++-- netbox/ipam/forms/models.py | 6 +- netbox/ipam/migrations/0059_l2vpn.py | 6 +- netbox/ipam/models/ip.py | 2 +- netbox/ipam/models/l2vpn.py | 11 +- netbox/ipam/tables/l2vpn.py | 11 +- netbox/ipam/tests/test_api.py | 2 - netbox/ipam/tests/test_filtersets.py | 126 ++++++++++++------ netbox/ipam/tests/test_views.py | 37 ++--- netbox/templates/ipam/l2vpn.html | 98 +++++++------- .../templates/ipam/l2vpntermination_edit.html | 4 +- 14 files changed, 213 insertions(+), 164 deletions(-) diff --git a/netbox/ipam/filtersets.py b/netbox/ipam/filtersets.py index f682009ee..edd1867ed 100644 --- a/netbox/ipam/filtersets.py +++ b/netbox/ipam/filtersets.py @@ -930,8 +930,11 @@ class ServiceFilterSet(NetBoxModelFilterSet): # L2VPN # - class L2VPNFilterSet(NetBoxModelFilterSet, TenancyFilterSet): + type = django_filters.MultipleChoiceFilter( + choices=L2VPNTypeChoices, + null_value=None + ) import_target_id = django_filters.ModelMultipleChoiceFilter( field_name='import_targets', queryset=RouteTarget.objects.all(), @@ -972,10 +975,10 @@ class L2VPNTerminationFilterSet(NetBoxModelFilterSet): label='L2VPN (ID)', ) l2vpn = django_filters.ModelMultipleChoiceFilter( - field_name='l2vpn__name', + field_name='l2vpn__slug', queryset=L2VPN.objects.all(), - to_field_name='name', - label='L2VPN (name)', + to_field_name='slug', + label='L2VPN (slug)', ) device = MultiValueCharFilter( method='filter_device', @@ -987,17 +990,16 @@ class L2VPNTerminationFilterSet(NetBoxModelFilterSet): field_name='pk', label='Device (ID)', ) - interface = django_filters.ModelMultipleChoiceFilter( - field_name='interface__name', - queryset=Interface.objects.all(), - to_field_name='name', - label='Interface (name)', - ) interface_id = django_filters.ModelMultipleChoiceFilter( field_name='interface', queryset=Interface.objects.all(), label='Interface (ID)', ) + vminterface_id = django_filters.ModelMultipleChoiceFilter( + field_name='vminterface', + queryset=VMInterface.objects.all(), + label='VM Interface (ID)', + ) vlan = django_filters.ModelMultipleChoiceFilter( field_name='vlan__name', queryset=VLAN.objects.all(), @@ -1013,10 +1015,11 @@ class L2VPNTerminationFilterSet(NetBoxModelFilterSet): queryset=VLAN.objects.all(), label='VLAN (ID)', ) + assigned_object_type = ContentTypeFilter() class Meta: model = L2VPNTermination - fields = ['id', ] + fields = ('id', 'assigned_object_type_id') def search(self, queryset, name, value): if not value.strip(): diff --git a/netbox/ipam/forms/bulk_edit.py b/netbox/ipam/forms/bulk_edit.py index 50fc51522..5f579b07f 100644 --- a/netbox/ipam/forms/bulk_edit.py +++ b/netbox/ipam/forms/bulk_edit.py @@ -8,7 +8,7 @@ from ipam.models import ASN from netbox.forms import NetBoxModelBulkEditForm from tenancy.models import Tenant from utilities.forms import ( - add_blank_choice, BulkEditNullBooleanSelect, DatePicker, DynamicModelChoiceField, NumericArrayField, StaticSelect, + add_blank_choice, BulkEditNullBooleanSelect, DynamicModelChoiceField, NumericArrayField, StaticSelect, DynamicModelMultipleChoiceField, ) @@ -445,6 +445,11 @@ class ServiceBulkEditForm(ServiceTemplateBulkEditForm): class L2VPNBulkEditForm(NetBoxModelBulkEditForm): + type = forms.ChoiceField( + choices=add_blank_choice(L2VPNTypeChoices), + required=False, + widget=StaticSelect() + ) tenant = DynamicModelChoiceField( queryset=Tenant.objects.all(), required=False @@ -456,7 +461,7 @@ class L2VPNBulkEditForm(NetBoxModelBulkEditForm): model = L2VPN fieldsets = ( - (None, ('tenant', 'description')), + (None, ('type', 'description', 'tenant')), ) nullable_fields = ('tenant', 'description',) diff --git a/netbox/ipam/forms/bulk_import.py b/netbox/ipam/forms/bulk_import.py index b8dd1c54c..880d2722f 100644 --- a/netbox/ipam/forms/bulk_import.py +++ b/netbox/ipam/forms/bulk_import.py @@ -438,7 +438,7 @@ class L2VPNCSVForm(NetBoxModelCSVForm): ) type = CSVChoiceField( choices=L2VPNTypeChoices, - help_text='IP protocol' + help_text='L2VPN type' ) class Meta: diff --git a/netbox/ipam/forms/filtersets.py b/netbox/ipam/forms/filtersets.py index 795cfe378..384a4da33 100644 --- a/netbox/ipam/forms/filtersets.py +++ b/netbox/ipam/forms/filtersets.py @@ -1,18 +1,19 @@ from django import forms +from django.contrib.contenttypes.models import ContentType +from django.db.models import Q from django.utils.translation import gettext as _ from dcim.models import Location, Rack, Region, Site, SiteGroup, Device -from virtualization.models import VirtualMachine from ipam.choices import * from ipam.constants import * from ipam.models import * -from ipam.models import ASN from netbox.forms import NetBoxModelFilterSetForm from tenancy.forms import TenancyFilterForm from utilities.forms import ( - add_blank_choice, DynamicModelChoiceField, DynamicModelMultipleChoiceField, MultipleChoiceField, StaticSelect, - TagFilterField, BOOLEAN_WITH_BLANK_CHOICES, + add_blank_choice, ContentTypeMultipleChoiceField, DynamicModelChoiceField, DynamicModelMultipleChoiceField, + MultipleChoiceField, StaticSelect, TagFilterField, BOOLEAN_WITH_BLANK_CHOICES, ) +from virtualization.models import VirtualMachine __all__ = ( 'AggregateFilterForm', @@ -482,7 +483,8 @@ class ServiceFilterForm(ServiceTemplateFilterForm): class L2VPNFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): model = L2VPN fieldsets = ( - (None, ('type', )), + (None, ('q', 'tag')), + ('Attributes', ('type', 'import_target_id', 'export_target_id')), ('Tenant', ('tenant_group_id', 'tenant_id')), ) type = forms.ChoiceField( @@ -490,17 +492,31 @@ class L2VPNFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): required=False, widget=StaticSelect() ) + import_target_id = DynamicModelMultipleChoiceField( + queryset=RouteTarget.objects.all(), + required=False, + label=_('Import targets') + ) + export_target_id = DynamicModelMultipleChoiceField( + queryset=RouteTarget.objects.all(), + required=False, + label=_('Export targets') + ) + tag = TagFilterField(model) class L2VPNTerminationFilterForm(NetBoxModelFilterSetForm): model = L2VPNTermination fieldsets = ( - (None, ('l2vpn', )), + (None, ('l2vpn_id', 'assigned_object_type_id')), ) - l2vpn = DynamicModelChoiceField( + l2vpn_id = DynamicModelChoiceField( queryset=L2VPN.objects.all(), - required=True, - query_params={}, - label='L2VPN', - fetch_trigger='open' + required=False, + label='L2VPN' + ) + assigned_object_type_id = ContentTypeMultipleChoiceField( + queryset=ContentType.objects.all(), + required=False, + label='Object type' ) diff --git a/netbox/ipam/forms/models.py b/netbox/ipam/forms/models.py index 3986eee32..415c952be 100644 --- a/netbox/ipam/forms/models.py +++ b/netbox/ipam/forms/models.py @@ -916,7 +916,8 @@ class L2VPNTerminationForm(NetBoxModelForm): required=False, query_params={ 'available_on_device': '$device' - } + }, + label='VLAN' ) interface = DynamicModelChoiceField( queryset=Interface.objects.all(), @@ -935,7 +936,8 @@ class L2VPNTerminationForm(NetBoxModelForm): required=False, query_params={ 'virtual_machine_id': '$virtual_machine' - } + }, + label='Interface' ) class Meta: diff --git a/netbox/ipam/migrations/0059_l2vpn.py b/netbox/ipam/migrations/0059_l2vpn.py index ef670ddea..7436989f7 100644 --- a/netbox/ipam/migrations/0059_l2vpn.py +++ b/netbox/ipam/migrations/0059_l2vpn.py @@ -27,7 +27,7 @@ class Migration(migrations.Migration): ('slug', models.SlugField()), ('type', models.CharField(max_length=50)), ('identifier', models.BigIntegerField(blank=True, null=True, unique=True)), - ('description', models.TextField(blank=True, null=True)), + ('description', models.CharField(blank=True, max_length=200)), ('export_targets', models.ManyToManyField(blank=True, related_name='exporting_l2vpns', to='ipam.routetarget')), ('import_targets', models.ManyToManyField(blank=True, related_name='importing_l2vpns', to='ipam.routetarget')), ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), @@ -35,7 +35,7 @@ class Migration(migrations.Migration): ], options={ 'verbose_name': 'L2VPN', - 'ordering': ('identifier', 'name'), + 'ordering': ('name', 'identifier'), }, ), migrations.CreateModel( @@ -51,7 +51,7 @@ class Migration(migrations.Migration): ('tags', taggit.managers.TaggableManager(through='extras.TaggedItem', to='extras.Tag')), ], options={ - 'verbose_name': 'L2VPN Termination', + 'verbose_name': 'L2VPN termination', 'ordering': ('l2vpn',), }, ), diff --git a/netbox/ipam/models/ip.py b/netbox/ipam/models/ip.py index 0bc0e2364..ee5de8cf4 100644 --- a/netbox/ipam/models/ip.py +++ b/netbox/ipam/models/ip.py @@ -931,7 +931,7 @@ class IPAddress(NetBoxModel): # Populate the address field with the next available IP (if any) if next_available_ip := self.get_next_available_ip(): - attrs['address'] = next_available_ip + attrs['address'] = f'{next_available_ip}/{self.address.prefixlen}' return attrs diff --git a/netbox/ipam/models/l2vpn.py b/netbox/ipam/models/l2vpn.py index dd8c51984..5d85fe915 100644 --- a/netbox/ipam/models/l2vpn.py +++ b/netbox/ipam/models/l2vpn.py @@ -31,7 +31,10 @@ class L2VPN(NetBoxModel): related_name='exporting_l2vpns', blank=True ) - description = models.TextField(null=True, blank=True) + description = models.CharField( + max_length=200, + blank=True + ) tenant = models.ForeignKey( to='tenancy.Tenant', on_delete=models.PROTECT, @@ -44,7 +47,7 @@ class L2VPN(NetBoxModel): ) class Meta: - ordering = ('identifier', 'name') + ordering = ('name', 'identifier') verbose_name = 'L2VPN' def __str__(self): @@ -76,7 +79,7 @@ class L2VPNTermination(NetBoxModel): class Meta: ordering = ('l2vpn',) - verbose_name = 'L2VPN Termination' + verbose_name = 'L2VPN termination' constraints = ( models.UniqueConstraint( fields=('assigned_object_type', 'assigned_object_id'), @@ -102,7 +105,7 @@ class L2VPNTermination(NetBoxModel): raise ValidationError(f'L2VPN Termination already assigned ({self.assigned_object})') # Only check if L2VPN is set and is of type P2P - if self.l2vpn and self.l2vpn.type in L2VPNTypeChoices.P2P: + if hasattr(self, 'l2vpn') and self.l2vpn.type in L2VPNTypeChoices.P2P: terminations_count = L2VPNTermination.objects.filter(l2vpn=self.l2vpn).exclude(pk=self.pk).count() if terminations_count >= 2: l2vpn_type = self.l2vpn.get_type_display() diff --git a/netbox/ipam/tables/l2vpn.py b/netbox/ipam/tables/l2vpn.py index a0e2f5d67..5be525343 100644 --- a/netbox/ipam/tables/l2vpn.py +++ b/netbox/ipam/tables/l2vpn.py @@ -1,8 +1,8 @@ import django_tables2 as tables -from ipam.models import * -from ipam.models.l2vpn import L2VPN, L2VPNTermination +from ipam.models import L2VPN, L2VPNTermination from netbox.tables import NetBoxTable, columns +from tenancy.tables import TenancyColumnsMixin __all__ = ( 'L2VPNTable', @@ -16,7 +16,7 @@ L2VPN_TARGETS = """ """ -class L2VPNTable(NetBoxTable): +class L2VPNTable(TenancyColumnsMixin, NetBoxTable): pk = columns.ToggleColumn() name = tables.Column( linkify=True @@ -32,7 +32,10 @@ class L2VPNTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = L2VPN - fields = ('pk', 'name', 'slug', 'type', 'description', 'import_targets', 'export_targets', 'tenant', 'actions') + fields = ( + 'pk', 'name', 'slug', 'type', 'description', 'import_targets', 'export_targets', 'tenant', 'tenant_group', + 'actions', + ) default_columns = ('pk', 'name', 'type', 'description', 'actions') diff --git a/netbox/ipam/tests/test_api.py b/netbox/ipam/tests/test_api.py index a5ebef2c7..3fef04194 100644 --- a/netbox/ipam/tests/test_api.py +++ b/netbox/ipam/tests/test_api.py @@ -970,7 +970,6 @@ class L2VPNTerminationTest(APIViewTestCases.APIViewTestCase): VLAN(name='VLAN 6', vid=656), VLAN(name='VLAN 7', vid=657) ) - VLAN.objects.bulk_create(vlans) l2vpns = ( @@ -985,7 +984,6 @@ class L2VPNTerminationTest(APIViewTestCases.APIViewTestCase): L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[1]), L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vlans[2]) ) - L2VPNTermination.objects.bulk_create(l2vpnterminations) cls.create_data = [ diff --git a/netbox/ipam/tests/test_filtersets.py b/netbox/ipam/tests/test_filtersets.py index 2b5fb0759..9106a4965 100644 --- a/netbox/ipam/tests/test_filtersets.py +++ b/netbox/ipam/tests/test_filtersets.py @@ -1,6 +1,8 @@ +from django.contrib.contenttypes.models import ContentType from django.test import TestCase from netaddr import IPNetwork +from dcim.choices import InterfaceTypeChoices from dcim.models import Device, DeviceRole, DeviceType, Interface, Location, Manufacturer, Rack, Region, Site, SiteGroup from ipam.choices import * from ipam.filtersets import * @@ -1472,12 +1474,54 @@ class L2VPNTestCase(TestCase, ChangeLoggedFilterSetTests): @classmethod def setUpTestData(cls): + route_targets = ( + RouteTarget(name='1:1'), + RouteTarget(name='1:2'), + RouteTarget(name='1:3'), + RouteTarget(name='2:1'), + RouteTarget(name='2:2'), + RouteTarget(name='2:3'), + ) + RouteTarget.objects.bulk_create(route_targets) + l2vpns = ( - L2VPN(name='L2VPN 1', type='vxlan', identifier=650001), - L2VPN(name='L2VPN 2', type='vpws', identifier=650002), - L2VPN(name='L2VPN 3', type='vpls'), # No RD + L2VPN(name='L2VPN 1', type=L2VPNTypeChoices.TYPE_VXLAN, identifier=65001), + L2VPN(name='L2VPN 2', type=L2VPNTypeChoices.TYPE_VPWS, identifier=65002), + L2VPN(name='L2VPN 3', type=L2VPNTypeChoices.TYPE_VPLS), ) L2VPN.objects.bulk_create(l2vpns) + l2vpns[0].import_targets.add(route_targets[0]) + l2vpns[1].import_targets.add(route_targets[1]) + l2vpns[2].import_targets.add(route_targets[2]) + l2vpns[0].export_targets.add(route_targets[3]) + l2vpns[1].export_targets.add(route_targets[4]) + l2vpns[2].export_targets.add(route_targets[5]) + + def test_name(self): + params = {'name': ['L2VPN 1', 'L2VPN 2']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_identifier(self): + params = {'identifier': ['65001', '65002']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_type(self): + params = {'type': [L2VPNTypeChoices.TYPE_VXLAN, L2VPNTypeChoices.TYPE_VPWS]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_import_targets(self): + route_targets = RouteTarget.objects.filter(name__in=['1:1', '1:2']) + params = {'import_target_id': [route_targets[0].pk, route_targets[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'import_target': [route_targets[0].name, route_targets[1].name]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_export_targets(self): + route_targets = RouteTarget.objects.filter(name__in=['2:1', '2:2']) + params = {'export_target_id': [route_targets[0].pk, route_targets[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'export_target': [route_targets[0].name, route_targets[1].name]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) class L2VPNTerminationTestCase(TestCase, ChangeLoggedFilterSetTests): @@ -1486,44 +1530,33 @@ class L2VPNTerminationTestCase(TestCase, ChangeLoggedFilterSetTests): @classmethod def setUpTestData(cls): - - site = Site.objects.create(name='Site 1') - manufacturer = Manufacturer.objects.create(name='Manufacturer 1') - device_type = DeviceType.objects.create(model='Device Type 1', manufacturer=manufacturer) - device_role = DeviceRole.objects.create(name='Switch') - device = Device.objects.create( - name='Device 1', - site=site, - device_type=device_type, - device_role=device_role, - status='active' - ) - + device = create_test_device('Device 1') interfaces = ( - Interface(name='Interface 1', device=device, type='1000baset'), - Interface(name='Interface 2', device=device, type='1000baset'), - Interface(name='Interface 3', device=device, type='1000baset'), - Interface(name='Interface 4', device=device, type='1000baset'), - Interface(name='Interface 5', device=device, type='1000baset'), - Interface(name='Interface 6', device=device, type='1000baset') + Interface(name='Interface 1', device=device, type=InterfaceTypeChoices.TYPE_1GE_FIXED), + Interface(name='Interface 2', device=device, type=InterfaceTypeChoices.TYPE_1GE_FIXED), + Interface(name='Interface 3', device=device, type=InterfaceTypeChoices.TYPE_1GE_FIXED), ) - Interface.objects.bulk_create(interfaces) - vlans = ( - VLAN(name='VLAN 1', vid=651), - VLAN(name='VLAN 2', vid=652), - VLAN(name='VLAN 3', vid=653), - VLAN(name='VLAN 4', vid=654), - VLAN(name='VLAN 5', vid=655) + vm = create_test_virtualmachine('Virtual Machine 1') + vminterfaces = ( + VMInterface(name='Interface 1', virtual_machine=vm), + VMInterface(name='Interface 2', virtual_machine=vm), + VMInterface(name='Interface 3', virtual_machine=vm), ) + VMInterface.objects.bulk_create(vminterfaces) + vlans = ( + VLAN(name='VLAN 1', vid=101), + VLAN(name='VLAN 2', vid=102), + VLAN(name='VLAN 3', vid=103), + ) VLAN.objects.bulk_create(vlans) l2vpns = ( - L2VPN(name='L2VPN 1', type='vxlan', identifier=650001), - L2VPN(name='L2VPN 2', type='vpws', identifier=650002), - L2VPN(name='L2VPN 3', type='vpls'), # No RD, + L2VPN(name='L2VPN 1', slug='l2vpn-1', type='vxlan', identifier=65001), + L2VPN(name='L2VPN 2', slug='l2vpn-2', type='vpws', identifier=65002), + L2VPN(name='L2VPN 3', slug='l2vpn-3', type='vpls'), # No RD, ) L2VPN.objects.bulk_create(l2vpns) @@ -1534,27 +1567,34 @@ class L2VPNTerminationTestCase(TestCase, ChangeLoggedFilterSetTests): L2VPNTermination(l2vpn=l2vpns[0], assigned_object=interfaces[0]), L2VPNTermination(l2vpn=l2vpns[1], assigned_object=interfaces[1]), L2VPNTermination(l2vpn=l2vpns[2], assigned_object=interfaces[2]), + L2VPNTermination(l2vpn=l2vpns[0], assigned_object=vminterfaces[0]), + L2VPNTermination(l2vpn=l2vpns[1], assigned_object=vminterfaces[1]), + L2VPNTermination(l2vpn=l2vpns[2], assigned_object=vminterfaces[2]), ) - L2VPNTermination.objects.bulk_create(l2vpnterminations) - def test_l2vpns(self): + def test_l2vpn(self): l2vpns = L2VPN.objects.all()[:2] params = {'l2vpn_id': [l2vpns[0].pk, l2vpns[1].pk]} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) - params = {'l2vpn': ['L2VPN 1', 'L2VPN 2']} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 4) + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) + params = {'l2vpn': [l2vpns[0].slug, l2vpns[1].slug]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) - def test_interfaces(self): + def test_content_type(self): + params = {'assigned_object_type_id': ContentType.objects.get(model='vlan').pk} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) + + def test_interface(self): interfaces = Interface.objects.all()[:2] params = {'interface_id': [interfaces[0].pk, interfaces[1].pk]} - qs = self.filterset(params, self.queryset).qs - results = qs.all() - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) - params = {'interface': ['Interface 1', 'Interface 2']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) - def test_vlans(self): + def test_vminterface(self): + vminterfaces = VMInterface.objects.all()[:2] + params = {'vminterface_id': [vminterfaces[0].pk, vminterfaces[1].pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_vlan(self): vlans = VLAN.objects.all()[:2] params = {'vlan_id': [vlans[0].pk, vlans[1].pk]} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) diff --git a/netbox/ipam/tests/test_views.py b/netbox/ipam/tests/test_views.py index 890c0eae3..27520229a 100644 --- a/netbox/ipam/tests/test_views.py +++ b/netbox/ipam/tests/test_views.py @@ -1,18 +1,14 @@ import datetime -from django.contrib.contenttypes.models import ContentType from django.test import override_settings from django.urls import reverse from netaddr import IPNetwork from dcim.models import Device, DeviceRole, DeviceType, Manufacturer, Site, Interface -from extras.choices import ObjectChangeActionChoices -from extras.models import ObjectChange from ipam.choices import * from ipam.models import * from tenancy.models import Tenant -from users.models import ObjectPermission -from utilities.testing import ViewTestCases, create_tags, post_data +from utilities.testing import ViewTestCases, create_test_device, create_tags class ASNTestCase(ViewTestCases.PrimaryObjectViewTestCase): @@ -772,9 +768,9 @@ class L2VPNTestCase(ViewTestCases.PrimaryObjectViewTestCase): RouteTarget.objects.bulk_create(rts) l2vpns = ( - L2VPN(name='L2VPN 1', slug='l2vpn-1', type='vxlan', identifier='650001'), - L2VPN(name='L2VPN 2', slug='l2vpn-2', type='vxlan', identifier='650002'), - L2VPN(name='L2VPN 3', slug='l2vpn-3', type='vxlan', identifier='650003') + L2VPN(name='L2VPN 1', slug='l2vpn-1', type=L2VPNTypeChoices.TYPE_VXLAN, identifier='650001'), + L2VPN(name='L2VPN 2', slug='l2vpn-2', type=L2VPNTypeChoices.TYPE_VXLAN, identifier='650002'), + L2VPN(name='L2VPN 3', slug='l2vpn-3', type=L2VPNTypeChoices.TYPE_VXLAN, identifier='650003') ) L2VPN.objects.bulk_create(l2vpns) @@ -782,7 +778,7 @@ class L2VPNTestCase(ViewTestCases.PrimaryObjectViewTestCase): cls.form_data = { 'name': 'L2VPN 8', 'slug': 'l2vpn-8', - 'type': 'vxlan', + 'type': L2VPNTypeChoices.TYPE_VXLAN, 'identifier': 123, 'description': 'Description', 'import_targets': [rts[0].pk], @@ -805,21 +801,9 @@ class L2VPNTerminationTestCase( @classmethod def setUpTestData(cls): - site = Site.objects.create(name='Site 1') - manufacturer = Manufacturer.objects.create(name='Manufacturer 1') - device_type = DeviceType.objects.create(model='Device Type 1', manufacturer=manufacturer) - device_role = DeviceRole.objects.create(name='Switch') - device = Device.objects.create( - name='Device 1', - site=site, - device_type=device_type, - device_role=device_role, - status='active' - ) - + device = create_test_device('Device 1') interface = Interface.objects.create(name='Interface 1', device=device, type='1000baset') - l2vpn = L2VPN.objects.create(name='L2VPN 1', type='vxlan', identifier=650001) - l2vpn_vlans = L2VPN.objects.create(name='L2VPN 2', type='vxlan', identifier=650002) + l2vpn = L2VPN.objects.create(name='L2VPN 1', type=L2VPNTypeChoices.TYPE_VXLAN, identifier=650001) vlans = ( VLAN(name='Vlan 1', vid=1001), @@ -846,9 +830,9 @@ class L2VPNTerminationTestCase( cls.csv_data = ( "l2vpn,vlan", - "L2VPN 2,Vlan 4", - "L2VPN 2,Vlan 5", - "L2VPN 2,Vlan 6", + "L2VPN 1,Vlan 4", + "L2VPN 1,Vlan 5", + "L2VPN 1,Vlan 6", ) cls.bulk_edit_data = {} @@ -857,6 +841,7 @@ class L2VPNTerminationTestCase( # Custom assertions # + # TODO: Remove this def assertInstanceEqual(self, instance, data, exclude=None, api=False): """ Override parent diff --git a/netbox/templates/ipam/l2vpn.html b/netbox/templates/ipam/l2vpn.html index 130940b02..44a1da818 100644 --- a/netbox/templates/ipam/l2vpn.html +++ b/netbox/templates/ipam/l2vpn.html @@ -6,46 +6,40 @@ {% block content %}
    -
    -
    - L2VPN Attributes -
    -
    - Name - - - - - - - - - - - - - - - - - - - - - - -
    {{ object.name|placeholder }}
    Slug{{ object.slug|placeholder }}
    Identifier{{ object.identifier|placeholder }}
    Type{{ object.get_type_display }}
    Description{{ object.description|placeholder }}
    Tenant{{ object.tenant|placeholder }}
    -
    -
    - {% include 'inc/panels/contacts.html' %} - {% plugin_left_page object %} +
    +
    L2VPN Attributes
    +
    + + + + + + + + + + + + + + + + + + + + + +
    Name{{ object.name|placeholder }}
    Identifier{{ object.identifier|placeholder }}
    Type{{ object.get_type_display }}
    Description{{ object.description|placeholder }}
    Tenant{{ object.tenant|linkify|placeholder }}
    +
    +
    + {% include 'inc/panels/tags.html' with tags=object.tags.all url='ipam:l2vpn_list' %} + {% plugin_left_page object %}
    - {% include 'inc/panels/tags.html' with tags=object.tags.all url='circuits:circuit_list' %} - {% include 'inc/panels/custom_fields.html' %} - {% plugin_right_page object %} + {% include 'inc/panels/contacts.html' %} + {% include 'inc/panels/custom_fields.html' %} + {% plugin_right_page object %}
    @@ -58,24 +52,24 @@
    -
    -
    Terminations
    -
    - {% render_table terminations_table 'inc/table.html' %} -
    - {% if perms.ipam.add_l2vpntermination %} -
    - - Add a Termination - -
    - {% endif %} +
    +
    Terminations
    +
    + {% render_table terminations_table 'inc/table.html' %} +
    + {% if perms.ipam.add_l2vpntermination %} +
    + + Add a Termination +
    + {% endif %}
    +
    -
    - {% plugin_full_width_page object %} +
    + {% plugin_full_width_page object %}
    {% endblock %} diff --git a/netbox/templates/ipam/l2vpntermination_edit.html b/netbox/templates/ipam/l2vpntermination_edit.html index 4ba079eb5..7b4a9f50a 100644 --- a/netbox/templates/ipam/l2vpntermination_edit.html +++ b/netbox/templates/ipam/l2vpntermination_edit.html @@ -18,12 +18,12 @@ From 43b27cc052ee1fb569af3d8f62fffea3a365f3aa Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 12 Jul 2022 12:30:07 -0400 Subject: [PATCH 254/593] Misc cleanup --- docs/models/dcim/interface.md | 3 +++ docs/models/ipam/l2vpn.md | 4 ++-- docs/models/ipam/l2vpntermination.md | 8 ++++---- netbox/circuits/filtersets.py | 2 +- netbox/dcim/choices.py | 4 ++-- netbox/dcim/forms/bulk_edit.py | 6 ++++-- netbox/dcim/models/device_components.py | 4 ++++ netbox/dcim/models/devices.py | 13 ++++++++++++- netbox/dcim/svg/racks.py | 3 ++- netbox/dcim/tables/sites.py | 1 + netbox/templates/dcim/frontport.html | 6 +++++- netbox/templates/dcim/rearport.html | 6 +++++- .../virtualization/virtualmachine/base.html | 8 +++++++- netbox/virtualization/forms/models.py | 9 ++++++--- 14 files changed, 58 insertions(+), 19 deletions(-) diff --git a/docs/models/dcim/interface.md b/docs/models/dcim/interface.md index e3237c2ee..87a1411b9 100644 --- a/docs/models/dcim/interface.md +++ b/docs/models/dcim/interface.md @@ -13,6 +13,9 @@ Physical interfaces may be arranged into a link aggregation group (LAG) and asso ### Power over Ethernet (PoE) +!!! note + This feature was added in NetBox v3.3. + Physical interfaces can be assigned a PoE mode to indicate PoE capability: power supplying equipment (PSE) or powered device (PD). Additionally, a PoE mode may be specified. This can be one of the listed IEEE 802.3 standards, or a passive setting (24 or 48 volts across two or four pairs). ### Wireless Interfaces diff --git a/docs/models/ipam/l2vpn.md b/docs/models/ipam/l2vpn.md index 9f9b4703c..214b8aab0 100644 --- a/docs/models/ipam/l2vpn.md +++ b/docs/models/ipam/l2vpn.md @@ -17,5 +17,5 @@ Each L2VPN instance must have one of the following type associated with it: * MPLS-EVPN * PBB-EVPN -!!!note - Choosing VPWS, EPL, EP-LAN, EP-TREE will result in only being able to add 2 terminations to a given L2VPN. +!!! note + Choosing VPWS, EPL, EP-LAN, EP-TREE will result in only being able to add two terminations to a given L2VPN. diff --git a/docs/models/ipam/l2vpntermination.md b/docs/models/ipam/l2vpntermination.md index cc1843639..e7c6a6810 100644 --- a/docs/models/ipam/l2vpntermination.md +++ b/docs/models/ipam/l2vpntermination.md @@ -1,15 +1,15 @@ # L2VPN Termination -A L2VPN Termination is the termination point of a L2VPN. Certain types of L2VPN's may only have 2 termination points (point-to-point) while others may have many terminations (multipoint). +A L2VPN Termination is the termination point of a L2VPN. Certain types of L2VPNs may only have 2 termination points (point-to-point) while others may have many terminations (multipoint). Each termination consists of a L2VPN it is a member of as well as the connected endpoint which can be an interface or a VLAN. -The following types of L2VPN's are considered point-to-point: +The following types of L2VPNs are considered point-to-point: * VPWS * EPL * EP-LAN * EP-TREE -!!!note - Choosing any of the above types of L2VPN's will result in only being able to add 2 terminations to a given L2VPN. +!!! note + Choosing any of the above types will result in only being able to add 2 terminations to a given L2VPN. diff --git a/netbox/circuits/filtersets.py b/netbox/circuits/filtersets.py index 8005c0afe..cee38fb18 100644 --- a/netbox/circuits/filtersets.py +++ b/netbox/circuits/filtersets.py @@ -4,7 +4,7 @@ from django.db.models import Q from dcim.filtersets import CabledObjectFilterSet from dcim.models import Region, Site, SiteGroup from ipam.models import ASN -from netbox.filtersets import ChangeLoggedModelFilterSet, NetBoxModelFilterSet, OrganizationalModelFilterSet +from netbox.filtersets import NetBoxModelFilterSet, OrganizationalModelFilterSet from tenancy.filtersets import ContactModelFilterSet, TenancyFilterSet from utilities.filters import TreeNodeMultipleChoiceFilter from .choices import * diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index 1a66312da..1fe21ed4b 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -1031,8 +1031,8 @@ class InterfacePoEModeChoices(ChoiceSet): MODE_PSE = 'pse' CHOICES = ( - (MODE_PD, 'Powered device (PD)'), - (MODE_PSE, 'Power sourcing equipment (PSE)'), + (MODE_PD, 'PD'), + (MODE_PSE, 'PSE'), ) diff --git a/netbox/dcim/forms/bulk_edit.py b/netbox/dcim/forms/bulk_edit.py index b4ab226ae..6d51302d3 100644 --- a/netbox/dcim/forms/bulk_edit.py +++ b/netbox/dcim/forms/bulk_edit.py @@ -1073,13 +1073,15 @@ class InterfaceBulkEditForm( choices=add_blank_choice(InterfacePoEModeChoices), required=False, initial='', - widget=StaticSelect() + widget=StaticSelect(), + label='PoE mode' ) poe_type = forms.ChoiceField( choices=add_blank_choice(InterfacePoETypeChoices), required=False, initial='', - widget=StaticSelect() + widget=StaticSelect(), + label='PoE type' ) mark_connected = forms.NullBooleanField( required=False, diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 9645efdbf..8f62b0626 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -227,6 +227,10 @@ class PathEndpoint(models.Model): # Return the path as a list of three-tuples (A termination(s), cable(s), B termination(s)) return list(zip(*[iter(path)] * 3)) + @property + def path(self): + return self._path + @cached_property def connected_endpoints(self): """ diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index 43b84974b..6075cb5a0 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -1,3 +1,4 @@ +import decimal from collections import OrderedDict import yaml @@ -279,6 +280,12 @@ class DeviceType(NetBoxModel): def clean(self): super().clean() + # U height must be divisible by 0.5 + if self.u_height % decimal.Decimal(0.5): + raise ValidationError({ + 'u_height': "U height must be in increments of 0.5 rack units." + }) + # If editing an existing DeviceType to have a larger u_height, first validate that *all* instances of it have # room to expand within their racks. This validation will impose a very high performance penalty when there are # many instances to check, but increasing the u_height of a DeviceType should be a very rare occurrence. @@ -811,7 +818,11 @@ class Device(NetBoxModel, ConfigContextModel): 'position': "Cannot select a rack position without assigning a rack.", }) - # Validate position/face combination + # Validate rack position and face + if self.position and self.position % decimal.Decimal(0.5): + raise ValidationError({ + 'position': "Position must be in increments of 0.5 rack units." + }) if self.position and not self.face: raise ValidationError({ 'face': "Must specify rack face when defining rack position.", diff --git a/netbox/dcim/svg/racks.py b/netbox/dcim/svg/racks.py index 920bd662f..f228c416b 100644 --- a/netbox/dcim/svg/racks.py +++ b/netbox/dcim/svg/racks.py @@ -260,13 +260,14 @@ class RackElevationSVG: ) for ru in range(0, self.rack.u_height): + unit = ru + 1 if self.rack.desc_units else self.rack.u_height - ru y_offset = RACK_ELEVATION_BORDER_WIDTH + ru * self.unit_height text_coords = ( x_offset + self.unit_width / 2, y_offset + self.unit_height / 2 ) - link = Hyperlink(href=url_string.format(ru), target='_blank') + link = Hyperlink(href=url_string.format(unit), target='_blank') link.add(Rect((x_offset, y_offset), (self.unit_width, self.unit_height), class_='slot')) link.add(Text('add device', insert=text_coords, class_='add-device')) diff --git a/netbox/dcim/tables/sites.py b/netbox/dcim/tables/sites.py index e452badea..5dc2aa611 100644 --- a/netbox/dcim/tables/sites.py +++ b/netbox/dcim/tables/sites.py @@ -125,6 +125,7 @@ class LocationTable(TenancyColumnsMixin, NetBoxTable): site = tables.Column( linkify=True ) + status = columns.ChoiceFieldColumn() rack_count = columns.LinkedCountColumn( viewname='dcim:rack_list', url_params={'location_id': 'pk'}, diff --git a/netbox/templates/dcim/frontport.html b/netbox/templates/dcim/frontport.html index 4cea7989b..e5f1df5ae 100644 --- a/netbox/templates/dcim/frontport.html +++ b/netbox/templates/dcim/frontport.html @@ -41,7 +41,11 @@ Color -   + {% if object.color %} +   + {% else %} + {{ ''|placeholder }} + {% endif %} diff --git a/netbox/templates/dcim/rearport.html b/netbox/templates/dcim/rearport.html index 3caae49c3..ae7b55316 100644 --- a/netbox/templates/dcim/rearport.html +++ b/netbox/templates/dcim/rearport.html @@ -41,7 +41,11 @@ Color -   + {% if object.color %} +   + {% else %} + {{ ''|placeholder }} + {% endif %} diff --git a/netbox/templates/virtualization/virtualmachine/base.html b/netbox/templates/virtualization/virtualmachine/base.html index 0c2f43de8..946467e31 100644 --- a/netbox/templates/virtualization/virtualmachine/base.html +++ b/netbox/templates/virtualization/virtualmachine/base.html @@ -5,7 +5,13 @@ {% block breadcrumbs %} {{ block.super }} -
  • {{ object.cluster }}
    • +
  • + {% if object.cluster %} + {{ object.cluster }} + {% else %} + {{ object.site }} + {% endif %} +
    • {% endblock %} {% block extra_controls %} diff --git a/netbox/virtualization/forms/models.py b/netbox/virtualization/forms/models.py index 018b50c99..a60d15281 100644 --- a/netbox/virtualization/forms/models.py +++ b/netbox/virtualization/forms/models.py @@ -166,7 +166,8 @@ class ClusterRemoveDevicesForm(ConfirmationForm): class VirtualMachineForm(TenancyForm, NetBoxModelForm): site = DynamicModelChoiceField( - queryset=Site.objects.all() + queryset=Site.objects.all(), + required=False ) cluster_group = DynamicModelChoiceField( queryset=ClusterGroup.objects.all(), @@ -178,6 +179,7 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm): ) cluster = DynamicModelChoiceField( queryset=Cluster.objects.all(), + required=False, query_params={ 'site_id': '$site', 'group_id': '$cluster_group', @@ -188,7 +190,8 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm): required=False, query_params={ 'cluster_id': '$cluster' - } + }, + help_text="Optionally pin this VM to a specific host device within the cluster" ) role = DynamicModelChoiceField( queryset=DeviceRole.objects.all(), @@ -208,7 +211,7 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm): fieldsets = ( ('Virtual Machine', ('name', 'role', 'status', 'tags')), - ('Cluster', ('site', 'cluster_group', 'cluster', 'device')), + ('Site/Cluster', ('site', 'cluster_group', 'cluster', 'device')), ('Tenancy', ('tenant_group', 'tenant')), ('Management', ('platform', 'primary_ip4', 'primary_ip6')), ('Resources', ('vcpus', 'memory', 'disk')), From 43a4a9c86d69d273e8564fca6b72d2b93b27f26c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 12 Jul 2022 16:29:43 -0400 Subject: [PATCH 255/593] Complete release notes --- docs/release-notes/version-3.3.md | 46 +++++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 6 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index ac499f806..3d514ea69 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -31,17 +31,52 @@ ### New Features -#### Half-Height Rack Units ([#51](https://github.com/netbox-community/netbox/issues/51)) +#### Multi-object Cable Terminations ([#9102](https://github.com/netbox-community/netbox/issues/9102)) -#### PoE Interface Attributes ([#1099](https://github.com/netbox-community/netbox/issues/1099)) +When creating a cable in NetBox, each end can now be attached to multiple objects. This allows accurate modeling of duplex fiber connections to individual termination ports and breakout cables, as examples. (Note that all terminations attached to one end of a cable must be the same object type, but do not need to connect to the same parent object.) Additionally, cable terminations can now be modified without needing to delete and recreate the cable. #### L2VPN Modeling ([#8157](https://github.com/netbox-community/netbox/issues/8157)) +NetBox can now model a variety of L2 VPN technologies, including VXLAN, VPLS, and others. Each L2VPN can be terminated to multiple device or virtual machine interfaces and/or VLANs to track connectivity across an overlay. Similarly to VRFs, each L2VPN can also have import and export route targets associated with it. + +#### PoE Interface Attributes ([#1099](https://github.com/netbox-community/netbox/issues/1099)) + +Two new fields have been added to the device interface model to track power over Ethernet (PoE) capabilities: + +* **PoE mode**: Power supplying equipment (PSE) or powered device (PD) +* **PoE type**: Applicable IEEE standard or other power type + +#### Half-Height Rack Units ([#51](https://github.com/netbox-community/netbox/issues/51)) + +Device type height can now be specified in 0.5U increments, allowing for the creation of half-height devices. Additionally, a device can be installed at the half-unit mark within a rack (e.g. U2.5). For example, two half-height devices positioned in sequence will consume a single rack unit; two consecutive 1.5U devices will consume 3U of space. + #### Restrict API Tokens by Client IP ([#8233](https://github.com/netbox-community/netbox/issues/8233)) +API tokens can now be restricted to use by certain client IP addresses or networks. For example, an API token with its `allowed_ips` list set to `[192.0.2.0/24]` will only permit authentication from API clients within that network; requests from other sources will fail authentication. This can be very useful for restricting the use of a token to specific clients. + #### Reference User in Permission Constraints ([#9074](https://github.com/netbox-community/netbox/issues/9074)) -#### Multi-object Cable Terminations ([#9102](https://github.com/netbox-community/netbox/issues/9102)) +NetBox's permission constraints have been expanded to support referencing the current user associated with a request using the special `$user` token. As an example, this enables an administrator to efficiently grant each user to edit his or her own journal entries, but not those created by other users. + +```json +{ + "created_by": "$user" +} +``` + +#### Custom Field Grouping ([#8495](https://github.com/netbox-community/netbox/issues/8495)) + +A `group_name` field has been added to the custom field model to enable organizing related custom fields by group. Similarly to custom links, custom links which have been assigned to a common group will be rendered within that group when viewing an object in the UI. (Custom field grouping has no effect on API operation.) + +#### Toggle Custom Field Visibility ([#9166](https://github.com/netbox-community/netbox/issues/9166)) + +The behavior of each custom field within the NetBox UI can now be controlled individually by toggling its UI visibility. Three settings are available: + +* **Read/write**: The custom field is included when viewing and editing objects (default). +* **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.) +* **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users. + +Custom field UI visibility has no impact on API operation. ### Enhancements @@ -54,11 +89,9 @@ * [#8171](https://github.com/netbox-community/netbox/issues/8171) - Populate next available address when cloning an IP * [#8222](https://github.com/netbox-community/netbox/issues/8222) - Enable the assignment of a VM to a specific host device within a cluster * [#8471](https://github.com/netbox-community/netbox/issues/8471) - Add `status` field to Cluster -* [#8495](https://github.com/netbox-community/netbox/issues/8495) - Enable custom field grouping * [#8511](https://github.com/netbox-community/netbox/issues/8511) - Enable custom fields and tags for circuit terminations * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results * [#9070](https://github.com/netbox-community/netbox/issues/9070) - Hide navigation menu items based on user permissions -* [#9166](https://github.com/netbox-community/netbox/issues/9166) - Add UI visibility toggle for custom fields * [#9177](https://github.com/netbox-community/netbox/issues/9177) - Add tenant assignment for wireless LANs & links * [#9536](https://github.com/netbox-community/netbox/issues/9536) - Track API token usage times * [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location @@ -78,6 +111,7 @@ ### REST API Changes +* List results can now be ordered by field, by appending `?ordering={fieldname}` to the query. Multiple fields can be specified by separating the field names with a comma, e.g. `?ordering=site,name`. To invert the ordering, prepend a hyphen to the field name, e.g. `?ordering=-name`. * Added the following endpoints: * `/api/dcim/cable-terminations/` * `/api/ipam/l2vpns/` @@ -173,7 +207,7 @@ * virtualization.VirtualMachine * The `site` field is now directly writable (rather than being inferred from the assigned cluster) * The `cluster` field is now optional. A virtual machine must have a site and/or cluster assigned. - * Added the `device` field + * Added the optional `device` field * Added the `l2vpn_termination` read-only field wireless.WirelessLAN * Added `tenant` field From e135f8e74d282f4db17eed49981f8303bc239f17 Mon Sep 17 00:00:00 2001 From: Renato Almeida de Oliveira Date: Wed, 13 Jul 2022 02:49:14 +0000 Subject: [PATCH 256/593] Include Network information in Prefix Template Issue:#9505 --- netbox/templates/ipam/prefix.html | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/netbox/templates/ipam/prefix.html b/netbox/templates/ipam/prefix.html index a47566ff7..caad547c4 100644 --- a/netbox/templates/ipam/prefix.html +++ b/netbox/templates/ipam/prefix.html @@ -143,6 +143,32 @@ {% endwith %} + {% if object.prefix.version == 4 %} + + + Network Mask + + + {{ object.prefix.netmask }} + + + + + Broadcast Address + + + {{ object.prefix.broadcast }} + + + + + Wildcard Mask + + + {{ object.prefix.hostmask }} + + + {% endif %}
    From fb2bfe23375c5ffa718424ae8ae0c751eabafae0 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 13 Jul 2022 15:12:53 -0400 Subject: [PATCH 257/593] Introduce GenericObjectSerializer --- netbox/netbox/api/serializers/__init__.py | 1 + netbox/netbox/api/serializers/generic.py | 31 +++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 netbox/netbox/api/serializers/generic.py diff --git a/netbox/netbox/api/serializers/__init__.py b/netbox/netbox/api/serializers/__init__.py index adc556549..0ec3ab5f3 100644 --- a/netbox/netbox/api/serializers/__init__.py +++ b/netbox/netbox/api/serializers/__init__.py @@ -2,6 +2,7 @@ from rest_framework import serializers from .base import * from .features import * +from .generic import * from .nested import * diff --git a/netbox/netbox/api/serializers/generic.py b/netbox/netbox/api/serializers/generic.py new file mode 100644 index 000000000..81ec338ff --- /dev/null +++ b/netbox/netbox/api/serializers/generic.py @@ -0,0 +1,31 @@ +from django.contrib.contenttypes.models import ContentType +from rest_framework import serializers + +from netbox.api import ContentTypeField +from utilities.utils import content_type_identifier + +__all__ = ( + 'GenericObjectSerializer', +) + + +class GenericObjectSerializer(serializers.Serializer): + """ + Minimal representation of some generic object identified by ContentType and PK. + """ + object_type = ContentTypeField( + queryset=ContentType.objects.all() + ) + object_id = serializers.IntegerField() + + def to_internal_value(self, data): + data = super().to_internal_value(data) + model = data['object_type'].model_class() + return model.objects.get(pk=data['object_id']) + + def to_representation(self, instance): + ct = ContentType.objects.get_for_model(instance) + return { + 'object_type': content_type_identifier(ct), + 'object_id': instance.pk, + } From 0b86326435fe6ea07ef376a81ff6fb592906fafc Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 13 Jul 2022 15:35:37 -0400 Subject: [PATCH 258/593] #9102: Enable creating terminations in conjunction with cables via REST API --- docs/release-notes/version-3.3.md | 6 +- netbox/dcim/api/serializers.py | 50 ++------------- netbox/dcim/forms/bulk_import.py | 2 +- netbox/dcim/forms/connections.py | 4 +- netbox/dcim/models/cables.py | 103 +++++++++++++++++------------- netbox/dcim/signals.py | 2 +- netbox/dcim/tests/test_api.py | 48 ++++++++++---- netbox/dcim/tests/test_views.py | 16 ++++- netbox/templates/dcim/cable.html | 4 +- 9 files changed, 123 insertions(+), 112 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 3d514ea69..7a093a35b 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -6,12 +6,12 @@ * Device position and rack unit values are now reported as decimals (e.g. `1.0` or `1.5`) to support modeling half-height rack units. * The `nat_outside` relation on the IP address model now returns a list of zero or more related IP addresses, rather than a single instance (or None). -* Several fields on the cable API serializers have been altered to support multiple-object cable terminations: +* Several fields on the cable API serializers have been altered or removed to support multiple-object cable terminations: | Old Name | Old Type | New Name | New Type | |----------------------|----------|-----------------------|----------| -| `termination_a_type` | string | `a_terminations_type` | string | -| `termination_b_type` | string | `b_terminations_type` | string | +| `termination_a_type` | string | _Removed_ | - | +| `termination_b_type` | string | _Removed_ | - | | `termination_a_id` | integer | _Removed_ | - | | `termination_b_id` | integer | _Removed_ | - | | `termination_a` | object | `a_terminations` | list | diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 08edd2820..66d28c3fb 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -15,7 +15,8 @@ from ipam.api.nested_serializers import ( from ipam.models import ASN, VLAN from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField from netbox.api.serializers import ( - NestedGroupModelSerializer, NetBoxModelSerializer, ValidatedModelSerializer, WritableNestedSerializer, + GenericObjectSerializer, NestedGroupModelSerializer, NetBoxModelSerializer, ValidatedModelSerializer, + WritableNestedSerializer, ) from netbox.config import ConfigItem from tenancy.api.nested_serializers import NestedTenantSerializer @@ -994,10 +995,8 @@ class InventoryItemRoleSerializer(NetBoxModelSerializer): class CableSerializer(NetBoxModelSerializer): url = serializers.HyperlinkedIdentityField(view_name='dcim-api:cable-detail') - a_terminations_type = serializers.SerializerMethodField(read_only=True) - b_terminations_type = serializers.SerializerMethodField(read_only=True) - a_terminations = serializers.SerializerMethodField(read_only=True) - b_terminations = serializers.SerializerMethodField(read_only=True) + a_terminations = GenericObjectSerializer(many=True, required=False) + b_terminations = GenericObjectSerializer(many=True, required=False) status = ChoiceField(choices=LinkStatusChoices, required=False) tenant = NestedTenantSerializer(required=False, allow_null=True) length_unit = ChoiceField(choices=CableLengthUnitChoices, allow_blank=True, required=False) @@ -1005,47 +1004,10 @@ class CableSerializer(NetBoxModelSerializer): class Meta: model = Cable fields = [ - 'id', 'url', 'display', 'type', 'a_terminations_type', 'a_terminations', 'b_terminations_type', - 'b_terminations', 'status', 'tenant', 'label', 'color', 'length', 'length_unit', 'tags', 'custom_fields', - 'created', 'last_updated', + 'id', 'url', 'display', 'type', 'a_terminations', 'b_terminations', 'status', 'tenant', 'label', 'color', + 'length', 'length_unit', 'tags', 'custom_fields', 'created', 'last_updated', ] - def _get_terminations_type(self, obj, side): - assert side in CableEndChoices.values() - terms = getattr(obj, f'get_{side.lower()}_terminations')() - if terms: - ct = ContentType.objects.get_for_model(terms[0]) - return f"{ct.app_label}.{ct.model}" - - def _get_terminations(self, obj, side): - assert side in CableEndChoices.values() - terms = getattr(obj, f'get_{side.lower()}_terminations')() - if not terms: - return [] - - termination_type = ContentType.objects.get_for_model(terms[0]) - serializer = get_serializer_for_model(termination_type.model_class(), prefix='Nested') - context = {'request': self.context['request']} - data = serializer(terms, context=context, many=True).data - - return data - - @swagger_serializer_method(serializer_or_field=serializers.CharField) - def get_a_terminations_type(self, obj): - return self._get_terminations_type(obj, CableEndChoices.SIDE_A) - - @swagger_serializer_method(serializer_or_field=serializers.CharField) - def get_b_terminations_type(self, obj): - return self._get_terminations_type(obj, CableEndChoices.SIDE_B) - - @swagger_serializer_method(serializer_or_field=serializers.DictField) - def get_a_terminations(self, obj): - return self._get_terminations(obj, CableEndChoices.SIDE_A) - - @swagger_serializer_method(serializer_or_field=serializers.DictField) - def get_b_terminations(self, obj): - return self._get_terminations(obj, CableEndChoices.SIDE_B) - class TracedCableSerializer(serializers.ModelSerializer): """ diff --git a/netbox/dcim/forms/bulk_import.py b/netbox/dcim/forms/bulk_import.py index d6ec0f6f4..f0fd9bf86 100644 --- a/netbox/dcim/forms/bulk_import.py +++ b/netbox/dcim/forms/bulk_import.py @@ -955,7 +955,7 @@ class CableCSVForm(NetBoxModelCSVForm): except ObjectDoesNotExist: raise forms.ValidationError(f"{side.upper()} side termination not found: {device} {name}") - setattr(self.instance, f'termination_{side}', termination_object) + setattr(self.instance, f'{side}_terminations', [termination_object]) return termination_object def clean_side_a_name(self): diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index f7bfa6431..1b393ec6e 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -157,8 +157,8 @@ def get_cable_form(a_type, b_type): if self.instance and self.instance.pk: # Initialize A/B terminations when modifying an existing Cable instance - self.initial['a_terminations'] = self.instance.get_a_terminations() - self.initial['b_terminations'] = self.instance.get_b_terminations() + self.initial['a_terminations'] = self.instance.a_terminations + self.initial['b_terminations'] = self.instance.b_terminations def save(self, *args, **kwargs): diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 551521c26..b35864aa0 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -93,11 +93,12 @@ class Cable(NetBoxModel): # Cache the original status so we can check later if it's been changed self._orig_status = self.status - # Assign any *new* CableTerminations for the instance. These will replace any existing - # terminations on save(). - if a_terminations is not None: + self._terminations_modified = False + + # Assign or retrieve A/B terminations + if a_terminations: self.a_terminations = a_terminations - if b_terminations is not None: + if b_terminations: self.b_terminations = b_terminations def __str__(self): @@ -107,6 +108,34 @@ class Cable(NetBoxModel): def get_absolute_url(self): return reverse('dcim:cable', args=[self.pk]) + @property + def a_terminations(self): + if hasattr(self, '_a_terminations'): + return self._a_terminations + # Query self.terminations.all() to leverage cached results + return [ + ct.termination for ct in self.terminations.all() if ct.cable_end == CableEndChoices.SIDE_A + ] + + @a_terminations.setter + def a_terminations(self, value): + self._terminations_modified = True + self._a_terminations = value + + @property + def b_terminations(self): + if hasattr(self, '_b_terminations'): + return self._b_terminations + # Query self.terminations.all() to leverage cached results + return [ + ct.termination for ct in self.terminations.all() if ct.cable_end == CableEndChoices.SIDE_B + ] + + @b_terminations.setter + def b_terminations(self, value): + self._terminations_modified = True + self._b_terminations = value + def clean(self): super().clean() @@ -116,30 +145,28 @@ class Cable(NetBoxModel): elif self.length is None: self.length_unit = '' - a_terminations = [ - CableTermination(cable=self, cable_end='A', termination=t) - for t in getattr(self, 'a_terminations', []) - ] - b_terminations = [ - CableTermination(cable=self, cable_end='B', termination=t) - for t in getattr(self, 'b_terminations', []) - ] + if self.pk is None and (not self.a_terminations or not self.b_terminations): + raise ValidationError("Must define A and B terminations when creating a new cable.") - # Check that all termination objects for either end are of the same type - for terms in (a_terminations, b_terminations): - if len(terms) > 1 and not all(t.termination_type == terms[0].termination_type for t in terms[1:]): - raise ValidationError("Cannot connect different termination types to same end of cable.") + if self._terminations_modified: - # Check that termination types are compatible - if a_terminations and b_terminations: - a_type = a_terminations[0].termination_type.model - b_type = b_terminations[0].termination_type.model - if b_type not in COMPATIBLE_TERMINATION_TYPES.get(a_type): - raise ValidationError(f"Incompatible termination types: {a_type} and {b_type}") + # Check that all termination objects for either end are of the same type + for terms in (self.a_terminations, self.b_terminations): + if len(terms) > 1 and not all(isinstance(t, type(terms[0])) for t in terms[1:]): + raise ValidationError("Cannot connect different termination types to same end of cable.") - # Run clean() on any new CableTerminations - for cabletermination in [*a_terminations, *b_terminations]: - cabletermination.clean() + # Check that termination types are compatible + if self.a_terminations and self.b_terminations: + a_type = self.a_terminations[0]._meta.model_name + b_type = self.b_terminations[0]._meta.model_name + if b_type not in COMPATIBLE_TERMINATION_TYPES.get(a_type): + raise ValidationError(f"Incompatible termination types: {a_type} and {b_type}") + + # Run clean() on any new CableTerminations + for termination in self.a_terminations: + CableTermination(cable=self, cable_end='A', termination=termination).clean() + for termination in self.b_terminations: + CableTermination(cable=self, cable_end='B', termination=termination).clean() def save(self, *args, **kwargs): _created = self.pk is None @@ -160,23 +187,21 @@ class Cable(NetBoxModel): b_terminations = {ct.termination: ct for ct in self.terminations.filter(cable_end='B')} # Delete stale CableTerminations - if hasattr(self, 'a_terminations'): + if self._terminations_modified: for termination, ct in a_terminations.items(): - if termination not in self.a_terminations: + if termination.pk and termination not in self.a_terminations: ct.delete() - if hasattr(self, 'b_terminations'): for termination, ct in b_terminations.items(): - if termination not in self.b_terminations: + if termination.pk and termination not in self.b_terminations: ct.delete() # Save new CableTerminations (if any) - if hasattr(self, 'a_terminations'): + if self._terminations_modified: for termination in self.a_terminations: - if termination not in a_terminations: + if not termination.pk or termination not in a_terminations: CableTermination(cable=self, cable_end='A', termination=termination).save() - if hasattr(self, 'b_terminations'): for termination in self.b_terminations: - if termination not in b_terminations: + if not termination.pk or termination not in b_terminations: CableTermination(cable=self, cable_end='B', termination=termination).save() trace_paths.send(Cable, instance=self, created=_created) @@ -184,18 +209,6 @@ class Cable(NetBoxModel): def get_status_color(self): return LinkStatusChoices.colors.get(self.status) - def get_a_terminations(self): - # Query self.terminations.all() to leverage cached results - return [ - ct.termination for ct in self.terminations.all() if ct.cable_end == CableEndChoices.SIDE_A - ] - - def get_b_terminations(self): - # Query self.terminations.all() to leverage cached results - return [ - ct.termination for ct in self.terminations.all() if ct.cable_end == CableEndChoices.SIDE_B - ] - class CableTermination(models.Model): """ diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 7cfdc823d..2293f8840 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -79,7 +79,7 @@ def update_connected_endpoints(instance, created, raw=False, **kwargs): return # Update cable paths if new terminations have been set - if hasattr(instance, 'a_terminations') or hasattr(instance, 'b_terminations'): + if instance._terminations_modified: a_terminations = [] b_terminations = [] for t in instance.terminations.all(): diff --git a/netbox/dcim/tests/test_api.py b/netbox/dcim/tests/test_api.py index 1c6f45596..a78a98ae5 100644 --- a/netbox/dcim/tests/test_api.py +++ b/netbox/dcim/tests/test_api.py @@ -7,6 +7,7 @@ from dcim.choices import * from dcim.constants import * from dcim.models import * from ipam.models import ASN, RIR, VLAN, VRF +from netbox.api.serializers import GenericObjectSerializer from utilities.testing import APITestCase, APIViewTestCases, create_test_device from virtualization.models import Cluster, ClusterType from wireless.choices import WirelessChannelChoices @@ -1864,6 +1865,17 @@ class CableTest(APIViewTestCases.APIViewTestCase): # TODO: Allow updating cable terminations test_update_object = None + def model_to_dict(self, *args, **kwargs): + data = super().model_to_dict(*args, **kwargs) + + # Serialize termination objects + if 'a_terminations' in data: + data['a_terminations'] = GenericObjectSerializer(data['a_terminations'], many=True).data + if 'b_terminations' in data: + data['b_terminations'] = GenericObjectSerializer(data['b_terminations'], many=True).data + + return data + @classmethod def setUpTestData(cls): site = Site.objects.create(name='Site 1', slug='site-1') @@ -1893,24 +1905,36 @@ class CableTest(APIViewTestCases.APIViewTestCase): cls.create_data = [ { - 'a_terminations_type': 'dcim.interface', - 'a_terminations': [interfaces[4].pk], - 'b_terminations_type': 'dcim.interface', - 'b_terminations': [interfaces[14].pk], + 'a_terminations': [{ + 'object_type': 'dcim.interface', + 'object_id': interfaces[4].pk, + }], + 'b_terminations': [{ + 'object_type': 'dcim.interface', + 'object_id': interfaces[14].pk, + }], 'label': 'Cable 4', }, { - 'a_terminations_type': 'dcim.interface', - 'a_terminations': [interfaces[5].pk], - 'b_terminations_type': 'dcim.interface', - 'b_terminations': [interfaces[15].pk], + 'a_terminations': [{ + 'object_type': 'dcim.interface', + 'object_id': interfaces[5].pk, + }], + 'b_terminations': [{ + 'object_type': 'dcim.interface', + 'object_id': interfaces[15].pk, + }], 'label': 'Cable 5', }, { - 'a_terminations_type': 'dcim.interface', - 'a_terminations': [interfaces[6].pk], - 'b_terminations_type': 'dcim.interface', - 'b_terminations': [interfaces[16].pk], + 'a_terminations': [{ + 'object_type': 'dcim.interface', + 'object_id': interfaces[6].pk, + }], + 'b_terminations': [{ + 'object_type': 'dcim.interface', + 'object_id': interfaces[16].pk, + }], 'label': 'Cable 6', }, ] diff --git a/netbox/dcim/tests/test_views.py b/netbox/dcim/tests/test_views.py index c6a531a31..a25267166 100644 --- a/netbox/dcim/tests/test_views.py +++ b/netbox/dcim/tests/test_views.py @@ -12,6 +12,7 @@ from dcim.choices import * from dcim.constants import * from dcim.models import * from ipam.models import ASN, RIR, VLAN, VRF +from netbox.api.serializers import GenericObjectSerializer from tenancy.models import Tenant from utilities.testing import ViewTestCases, create_tags, create_test_device, post_data from wireless.models import WirelessLAN @@ -2640,8 +2641,8 @@ class CableTestCase( cls.form_data = { # TODO: Revisit this limitation # Changing terminations not supported when editing an existing Cable - 'a_terminations': interfaces[0].pk, - 'b_terminations': interfaces[3].pk, + 'a_terminations': [interfaces[0].pk], + 'b_terminations': [interfaces[3].pk], 'type': CableTypeChoices.TYPE_CAT6, 'status': LinkStatusChoices.STATUS_PLANNED, 'label': 'Label', @@ -2667,6 +2668,17 @@ class CableTestCase( 'length_unit': CableLengthUnitChoices.UNIT_METER, } + def model_to_dict(self, *args, **kwargs): + data = super().model_to_dict(*args, **kwargs) + + # Serialize termination objects + if 'a_terminations' in data: + data['a_terminations'] = [obj.pk for obj in data['a_terminations']] + if 'b_terminations' in data: + data['b_terminations'] = [obj.pk for obj in data['b_terminations']] + + return data + class VirtualChassisTestCase(ViewTestCases.PrimaryObjectViewTestCase): model = VirtualChassis diff --git a/netbox/templates/dcim/cable.html b/netbox/templates/dcim/cable.html index f557792c1..e032d7034 100644 --- a/netbox/templates/dcim/cable.html +++ b/netbox/templates/dcim/cable.html @@ -63,13 +63,13 @@
    Termination A
    - {% include 'dcim/inc/cable_termination.html' with terminations=object.get_a_terminations %} + {% include 'dcim/inc/cable_termination.html' with terminations=object.a_terminations %}
    Termination B
    - {% include 'dcim/inc/cable_termination.html' with terminations=object.get_b_terminations %} + {% include 'dcim/inc/cable_termination.html' with terminations=object.b_terminations %}
    {% plugin_right_page object %} From 3eb6b6c07fc1e666fa1148981200cec615b0a445 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 13 Jul 2022 16:18:55 -0400 Subject: [PATCH 259/593] Clean up core API imports --- netbox/circuits/api/nested_serializers.py | 2 +- netbox/circuits/api/serializers.py | 4 ++-- netbox/circuits/api/urls.py | 2 +- netbox/dcim/api/serializers.py | 2 +- netbox/dcim/api/urls.py | 2 +- netbox/extras/api/nested_serializers.py | 4 ++-- netbox/extras/api/serializers.py | 2 +- netbox/extras/api/urls.py | 2 +- netbox/ipam/api/nested_serializers.py | 2 +- netbox/ipam/api/serializers.py | 2 +- netbox/ipam/api/urls.py | 3 +-- netbox/netbox/api/__init__.py | 15 --------------- netbox/netbox/api/metadata.py | 2 +- netbox/tenancy/api/nested_serializers.py | 2 +- netbox/tenancy/api/serializers.py | 2 +- netbox/tenancy/api/urls.py | 2 +- netbox/users/api/nested_serializers.py | 3 ++- netbox/users/api/serializers.py | 3 ++- netbox/users/api/urls.py | 2 +- netbox/utilities/custom_inspectors.py | 3 ++- netbox/virtualization/api/nested_serializers.py | 2 +- netbox/virtualization/api/serializers.py | 2 +- netbox/virtualization/api/urls.py | 2 +- netbox/wireless/api/nested_serializers.py | 2 +- netbox/wireless/api/serializers.py | 2 +- netbox/wireless/api/urls.py | 2 +- 26 files changed, 30 insertions(+), 43 deletions(-) diff --git a/netbox/circuits/api/nested_serializers.py b/netbox/circuits/api/nested_serializers.py index 6f7cb4f21..8fc1bfaf7 100644 --- a/netbox/circuits/api/nested_serializers.py +++ b/netbox/circuits/api/nested_serializers.py @@ -1,7 +1,7 @@ from rest_framework import serializers from circuits.models import * -from netbox.api import WritableNestedSerializer +from netbox.api.serializers import WritableNestedSerializer __all__ = [ 'NestedCircuitSerializer', diff --git a/netbox/circuits/api/serializers.py b/netbox/circuits/api/serializers.py index 6b09cd531..c1d856f39 100644 --- a/netbox/circuits/api/serializers.py +++ b/netbox/circuits/api/serializers.py @@ -2,11 +2,11 @@ from rest_framework import serializers from circuits.choices import CircuitStatusChoices from circuits.models import * -from dcim.api.nested_serializers import NestedCableSerializer, NestedSiteSerializer +from dcim.api.nested_serializers import NestedSiteSerializer from dcim.api.serializers import CabledObjectSerializer from ipam.models import ASN from ipam.api.nested_serializers import NestedASNSerializer -from netbox.api import ChoiceField, SerializedPKRelatedField +from netbox.api.fields import ChoiceField, SerializedPKRelatedField from netbox.api.serializers import NetBoxModelSerializer, WritableNestedSerializer from tenancy.api.nested_serializers import NestedTenantSerializer from .nested_serializers import * diff --git a/netbox/circuits/api/urls.py b/netbox/circuits/api/urls.py index 616adfaa4..9d75009d5 100644 --- a/netbox/circuits/api/urls.py +++ b/netbox/circuits/api/urls.py @@ -1,4 +1,4 @@ -from netbox.api import NetBoxRouter +from netbox.api.routers import NetBoxRouter from . import views diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 66d28c3fb..cc5c87a8a 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -13,7 +13,7 @@ from ipam.api.nested_serializers import ( NestedVRFSerializer, ) from ipam.models import ASN, VLAN -from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField +from netbox.api.fields import ChoiceField, ContentTypeField, SerializedPKRelatedField from netbox.api.serializers import ( GenericObjectSerializer, NestedGroupModelSerializer, NetBoxModelSerializer, ValidatedModelSerializer, WritableNestedSerializer, diff --git a/netbox/dcim/api/urls.py b/netbox/dcim/api/urls.py index e73678f71..47bbfd525 100644 --- a/netbox/dcim/api/urls.py +++ b/netbox/dcim/api/urls.py @@ -1,4 +1,4 @@ -from netbox.api import NetBoxRouter +from netbox.api.routers import NetBoxRouter from . import views diff --git a/netbox/extras/api/nested_serializers.py b/netbox/extras/api/nested_serializers.py index 4acde31ab..44dfe7cbc 100644 --- a/netbox/extras/api/nested_serializers.py +++ b/netbox/extras/api/nested_serializers.py @@ -1,8 +1,8 @@ from rest_framework import serializers from extras import choices, models -from netbox.api import ChoiceField, WritableNestedSerializer -from netbox.api.serializers import NestedTagSerializer +from netbox.api.fields import ChoiceField +from netbox.api.serializers import NestedTagSerializer, WritableNestedSerializer from users.api.nested_serializers import NestedUserSerializer __all__ = [ diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index 988c3bf7b..0688f6d76 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -12,8 +12,8 @@ from dcim.models import DeviceRole, DeviceType, Location, Platform, Region, Site from extras.choices import * from extras.models import * from extras.utils import FeatureQuery -from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField from netbox.api.exceptions import SerializerNotFound +from netbox.api.fields import ChoiceField, ContentTypeField, SerializedPKRelatedField from netbox.api.serializers import BaseModelSerializer, NetBoxModelSerializer, ValidatedModelSerializer from tenancy.api.nested_serializers import NestedTenantSerializer, NestedTenantGroupSerializer from tenancy.models import Tenant, TenantGroup diff --git a/netbox/extras/api/urls.py b/netbox/extras/api/urls.py index dd6a5aeff..bcad6b77c 100644 --- a/netbox/extras/api/urls.py +++ b/netbox/extras/api/urls.py @@ -1,4 +1,4 @@ -from netbox.api import NetBoxRouter +from netbox.api.routers import NetBoxRouter from . import views diff --git a/netbox/ipam/api/nested_serializers.py b/netbox/ipam/api/nested_serializers.py index e74d60fb2..7809e84f8 100644 --- a/netbox/ipam/api/nested_serializers.py +++ b/netbox/ipam/api/nested_serializers.py @@ -2,7 +2,7 @@ from rest_framework import serializers from ipam import models from ipam.models.l2vpn import L2VPNTermination, L2VPN -from netbox.api import WritableNestedSerializer +from netbox.api.serializers import WritableNestedSerializer __all__ = [ 'NestedAggregateSerializer', diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index 9cde08374..32fa4e6af 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -8,7 +8,7 @@ from dcim.api.nested_serializers import NestedDeviceSerializer, NestedSiteSerial from ipam.choices import * from ipam.constants import IPADDRESS_ASSIGNMENT_MODELS, VLANGROUP_SCOPE_TYPES from ipam.models import * -from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField +from netbox.api.fields import ChoiceField, ContentTypeField, SerializedPKRelatedField from netbox.api.serializers import NetBoxModelSerializer from tenancy.api.nested_serializers import NestedTenantSerializer from utilities.api import get_serializer_for_model diff --git a/netbox/ipam/api/urls.py b/netbox/ipam/api/urls.py index 20e31f4d4..1e077c087 100644 --- a/netbox/ipam/api/urls.py +++ b/netbox/ipam/api/urls.py @@ -1,7 +1,6 @@ from django.urls import path -from netbox.api import NetBoxRouter -from ipam.models import IPRange, Prefix +from netbox.api.routers import NetBoxRouter from . import views diff --git a/netbox/netbox/api/__init__.py b/netbox/netbox/api/__init__.py index 231ab55e6..e69de29bb 100644 --- a/netbox/netbox/api/__init__.py +++ b/netbox/netbox/api/__init__.py @@ -1,15 +0,0 @@ -from .fields import * -from .routers import NetBoxRouter -from .serializers import BulkOperationSerializer, ValidatedModelSerializer, WritableNestedSerializer - - -__all__ = ( - 'BulkOperationSerializer', - 'ChoiceField', - 'ContentTypeField', - 'IPNetworkSerializer', - 'NetBoxRouter', - 'SerializedPKRelatedField', - 'ValidatedModelSerializer', - 'WritableNestedSerializer', -) diff --git a/netbox/netbox/api/metadata.py b/netbox/netbox/api/metadata.py index bc4ecf871..dff1474d9 100644 --- a/netbox/netbox/api/metadata.py +++ b/netbox/netbox/api/metadata.py @@ -5,7 +5,7 @@ from rest_framework import exceptions from rest_framework.metadata import SimpleMetadata from rest_framework.request import clone_request -from netbox.api import ContentTypeField +from netbox.api.fields import ContentTypeField class BulkOperationMetadata(SimpleMetadata): diff --git a/netbox/tenancy/api/nested_serializers.py b/netbox/tenancy/api/nested_serializers.py index 00ac6ff84..2f95eca8c 100644 --- a/netbox/tenancy/api/nested_serializers.py +++ b/netbox/tenancy/api/nested_serializers.py @@ -1,6 +1,6 @@ from rest_framework import serializers -from netbox.api import WritableNestedSerializer +from netbox.api.serializers import WritableNestedSerializer from tenancy.models import * __all__ = [ diff --git a/netbox/tenancy/api/serializers.py b/netbox/tenancy/api/serializers.py index a2286efed..b5cce741a 100644 --- a/netbox/tenancy/api/serializers.py +++ b/netbox/tenancy/api/serializers.py @@ -2,7 +2,7 @@ from django.contrib.auth.models import ContentType from drf_yasg.utils import swagger_serializer_method from rest_framework import serializers -from netbox.api import ChoiceField, ContentTypeField +from netbox.api.fields import ChoiceField, ContentTypeField from netbox.api.serializers import NestedGroupModelSerializer, NetBoxModelSerializer from tenancy.choices import ContactPriorityChoices from tenancy.models import * diff --git a/netbox/tenancy/api/urls.py b/netbox/tenancy/api/urls.py index 7dbe59ea4..18ea98241 100644 --- a/netbox/tenancy/api/urls.py +++ b/netbox/tenancy/api/urls.py @@ -1,4 +1,4 @@ -from netbox.api import NetBoxRouter +from netbox.api.routers import NetBoxRouter from . import views diff --git a/netbox/users/api/nested_serializers.py b/netbox/users/api/nested_serializers.py index 51e0c5b26..e9e730cc4 100644 --- a/netbox/users/api/nested_serializers.py +++ b/netbox/users/api/nested_serializers.py @@ -2,7 +2,8 @@ from django.contrib.auth.models import Group, User from django.contrib.contenttypes.models import ContentType from rest_framework import serializers -from netbox.api import ContentTypeField, WritableNestedSerializer +from netbox.api.fields import ContentTypeField +from netbox.api.serializers import WritableNestedSerializer from users.models import ObjectPermission, Token __all__ = [ diff --git a/netbox/users/api/serializers.py b/netbox/users/api/serializers.py index d05f6c7da..1ec3528f7 100644 --- a/netbox/users/api/serializers.py +++ b/netbox/users/api/serializers.py @@ -2,7 +2,8 @@ from django.contrib.auth.models import Group, User from django.contrib.contenttypes.models import ContentType from rest_framework import serializers -from netbox.api import ContentTypeField, IPNetworkSerializer, SerializedPKRelatedField, ValidatedModelSerializer +from netbox.api.fields import ContentTypeField, IPNetworkSerializer, SerializedPKRelatedField +from netbox.api.serializers import ValidatedModelSerializer from users.models import ObjectPermission, Token from .nested_serializers import * diff --git a/netbox/users/api/urls.py b/netbox/users/api/urls.py index f46cc1680..599d0bb61 100644 --- a/netbox/users/api/urls.py +++ b/netbox/users/api/urls.py @@ -1,6 +1,6 @@ from django.urls import include, path -from netbox.api import NetBoxRouter +from netbox.api.routers import NetBoxRouter from . import views diff --git a/netbox/utilities/custom_inspectors.py b/netbox/utilities/custom_inspectors.py index b110a9123..1a5ede23f 100644 --- a/netbox/utilities/custom_inspectors.py +++ b/netbox/utilities/custom_inspectors.py @@ -6,7 +6,8 @@ from rest_framework.fields import ChoiceField from rest_framework.relations import ManyRelatedField from extras.api.customfields import CustomFieldsDataField -from netbox.api import ChoiceField, SerializedPKRelatedField, WritableNestedSerializer +from netbox.api.fields import ChoiceField, SerializedPKRelatedField +from netbox.api.serializers import WritableNestedSerializer class NetBoxSwaggerAutoSchema(SwaggerAutoSchema): diff --git a/netbox/virtualization/api/nested_serializers.py b/netbox/virtualization/api/nested_serializers.py index 16e10b5fd..07a9f5d13 100644 --- a/netbox/virtualization/api/nested_serializers.py +++ b/netbox/virtualization/api/nested_serializers.py @@ -1,6 +1,6 @@ from rest_framework import serializers -from netbox.api import WritableNestedSerializer +from netbox.api.serializers import WritableNestedSerializer from virtualization.models import Cluster, ClusterGroup, ClusterType, VirtualMachine, VMInterface __all__ = [ diff --git a/netbox/virtualization/api/serializers.py b/netbox/virtualization/api/serializers.py index c5816dca8..903d89a07 100644 --- a/netbox/virtualization/api/serializers.py +++ b/netbox/virtualization/api/serializers.py @@ -9,7 +9,7 @@ from ipam.api.nested_serializers import ( NestedIPAddressSerializer, NestedL2VPNTerminationSerializer, NestedVLANSerializer, NestedVRFSerializer, ) from ipam.models import VLAN -from netbox.api import ChoiceField, SerializedPKRelatedField +from netbox.api.fields import ChoiceField, SerializedPKRelatedField from netbox.api.serializers import NetBoxModelSerializer from tenancy.api.nested_serializers import NestedTenantSerializer from virtualization.choices import * diff --git a/netbox/virtualization/api/urls.py b/netbox/virtualization/api/urls.py index 07b20bfd7..2ceeb8ce6 100644 --- a/netbox/virtualization/api/urls.py +++ b/netbox/virtualization/api/urls.py @@ -1,4 +1,4 @@ -from netbox.api import NetBoxRouter +from netbox.api.routers import NetBoxRouter from . import views diff --git a/netbox/wireless/api/nested_serializers.py b/netbox/wireless/api/nested_serializers.py index e9a840bfc..0e8404266 100644 --- a/netbox/wireless/api/nested_serializers.py +++ b/netbox/wireless/api/nested_serializers.py @@ -1,6 +1,6 @@ from rest_framework import serializers -from netbox.api import WritableNestedSerializer +from netbox.api.serializers import WritableNestedSerializer from wireless.models import * __all__ = ( diff --git a/netbox/wireless/api/serializers.py b/netbox/wireless/api/serializers.py index 49d512e51..d65511765 100644 --- a/netbox/wireless/api/serializers.py +++ b/netbox/wireless/api/serializers.py @@ -3,7 +3,7 @@ from rest_framework import serializers from dcim.choices import LinkStatusChoices from dcim.api.serializers import NestedInterfaceSerializer from ipam.api.serializers import NestedVLANSerializer -from netbox.api import ChoiceField +from netbox.api.fields import ChoiceField from netbox.api.serializers import NestedGroupModelSerializer, NetBoxModelSerializer from tenancy.api.nested_serializers import NestedTenantSerializer from wireless.choices import * diff --git a/netbox/wireless/api/urls.py b/netbox/wireless/api/urls.py index 47799bd3a..5375172eb 100644 --- a/netbox/wireless/api/urls.py +++ b/netbox/wireless/api/urls.py @@ -1,4 +1,4 @@ -from netbox.api import NetBoxRouter +from netbox.api.routers import NetBoxRouter from . import views From be00d1f3c6cb207cc9b3788c04f0356e1875a1cd Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 14 Jul 2022 08:36:16 -0400 Subject: [PATCH 260/593] Fix erroneous import --- netbox/netbox/api/serializers/generic.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/api/serializers/generic.py b/netbox/netbox/api/serializers/generic.py index 81ec338ff..8b4069c98 100644 --- a/netbox/netbox/api/serializers/generic.py +++ b/netbox/netbox/api/serializers/generic.py @@ -1,7 +1,7 @@ from django.contrib.contenttypes.models import ContentType from rest_framework import serializers -from netbox.api import ContentTypeField +from netbox.api.fields import ContentTypeField from utilities.utils import content_type_identifier __all__ = ( From 0615252e1555edc1f06dfa4ec057573573a4c826 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 14 Jul 2022 10:33:20 -0400 Subject: [PATCH 261/593] Add progress output to cable migration --- .../dcim/migrations/0158_populate_cable_terminations.py | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/netbox/dcim/migrations/0158_populate_cable_terminations.py b/netbox/dcim/migrations/0158_populate_cable_terminations.py index 82f8cd359..5836d24be 100644 --- a/netbox/dcim/migrations/0158_populate_cable_terminations.py +++ b/netbox/dcim/migrations/0158_populate_cable_terminations.py @@ -1,3 +1,5 @@ +import sys + from django.db import migrations @@ -42,6 +44,7 @@ def populate_cable_terminations(apps, schema_editor): # Queue CableTerminations to be created cable_terminations = [] + cable_count = cables.count() for i, cable in enumerate(cables, start=1): for cable_end in ('a', 'b'): # We must manually instantiate the termination object, because GFK fields are not @@ -58,6 +61,12 @@ def populate_cable_terminations(apps, schema_editor): **cache_related_objects(termination) )) + # Output progress occasionally + if 'test' not in sys.argv and not i % 100: + progress = float(i) * 100 / cable_count + sys.stdout.write(f"\r Updated {i}/{cable_count} cables ({progress:.2f}%)") + sys.stdout.flush() + # Bulk create the termination objects CableTermination.objects.bulk_create(cable_terminations, batch_size=100) From 29c81a788ff2d3121a9f80e55f8b021b5fca59c3 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 14 Jul 2022 10:37:27 -0400 Subject: [PATCH 262/593] Clean up connection tables --- netbox/dcim/tables/devices.py | 6 +++--- netbox/dcim/tables/template_code.py | 24 +++++------------------- netbox/templates/dcim/cable_trace.html | 14 +++++++------- 3 files changed, 15 insertions(+), 29 deletions(-) diff --git a/netbox/dcim/tables/devices.py b/netbox/dcim/tables/devices.py index a6c0c0ecc..c1515a15f 100644 --- a/netbox/dcim/tables/devices.py +++ b/netbox/dcim/tables/devices.py @@ -274,17 +274,17 @@ class CableTerminationTable(NetBoxTable): verbose_name='Cable Color' ) link_peer = columns.TemplateColumn( - accessor='_link_peer', + accessor='link_peers', template_code=LINKTERMINATION, orderable=False, - verbose_name='Link Peer' + verbose_name='Link Peers' ) mark_connected = columns.BooleanColumn() class PathEndpointTable(CableTerminationTable): connection = columns.TemplateColumn( - accessor='_path__last_node', + accessor='_path__destinations', template_code=LINKTERMINATION, verbose_name='Connection', orderable=False diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index a07186973..90befe0a4 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -1,11 +1,9 @@ LINKTERMINATION = """ -{% if value %} - {% if value.parent_object %} - {{ value.parent_object }} - - {% endif %} - {{ value }} -{% endif %} +{% for termination in value %} + {{ termination }}{% if not forloop.last %},{% endif %} +{% empty %} + {{ ''|placeholder }} +{% endfor %} """ CABLE_LENGTH = """ @@ -13,18 +11,6 @@ CABLE_LENGTH = """ {% if record.length %}{{ record.length|simplify_decimal }} {{ record.length_unit }}{% endif %} """ -# CABLE_TERMINATION_PARENT = """ -# {% with value.0 as termination %} -# {% if termination.device %} -# {{ termination.device }} -# {% elif termination.circuit %} -# {{ termination.circuit }} -# {% elif termination.power_panel %} -# {{ termination.power_panel }} -# {% endif %} -# {% endwith %} -# """ - DEVICE_LINK = """ {{ record.name|default:'Unnamed device' }} diff --git a/netbox/templates/dcim/cable_trace.html b/netbox/templates/dcim/cable_trace.html index ac0481925..abe13b236 100644 --- a/netbox/templates/dcim/cable_trace.html +++ b/netbox/templates/dcim/cable_trace.html @@ -10,10 +10,12 @@
    {% if path %}
    - + +
    {% with traced_path=path.origin.trace %} @@ -80,18 +82,16 @@ {% for cablepath in related_paths %} - - {{ cablepath.origin.parent_object }} / {{ cablepath.origin }} - + {{ cablepath.origins|join:", " }} - {% if cablepath.destination %} - {{ cablepath.destination }} ({{ cablepath.destination.parent_object }}) + {% if cablepath.destinations %} + {{ cablepath.destinations|join:", " }} {% else %} Incomplete {% endif %} - + {{ cablepath.segment_count }} From 15395a56e736e740757d4a2dec558ea13c862e82 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 14 Jul 2022 11:02:00 -0400 Subject: [PATCH 263/593] Move L2VPN into new menu group --- netbox/netbox/navigation_menu.py | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/netbox/netbox/navigation_menu.py b/netbox/netbox/navigation_menu.py index 513cf4d9e..a495f17c9 100644 --- a/netbox/netbox/navigation_menu.py +++ b/netbox/netbox/navigation_menu.py @@ -174,7 +174,7 @@ DEVICES_MENU = Menu( CONNECTIONS_MENU = Menu( label='Connections', - icon_class='mdi mdi-ethernet', + icon_class='mdi mdi-connection', groups=( MenuGroup( label='Connections', @@ -260,13 +260,6 @@ IPAM_MENU = Menu( get_model_item('ipam', 'vlangroup', 'VLAN Groups'), ), ), - MenuGroup( - label='L2VPNs', - items=( - get_model_item('ipam', 'l2vpn', 'L2VPNs'), - get_model_item('ipam', 'l2vpntermination', 'Terminations'), - ), - ), MenuGroup( label='Other', items=( @@ -278,6 +271,20 @@ IPAM_MENU = Menu( ), ) +OVERLAY_MENU = Menu( + label='Overlay', + icon_class='mdi mdi-graph-outline', + groups=( + MenuGroup( + label='L2VPNs', + items=( + get_model_item('ipam', 'l2vpn', 'L2VPNs'), + get_model_item('ipam', 'l2vpntermination', 'Terminations'), + ), + ), + ), +) + VIRTUALIZATION_MENU = Menu( label='Virtualization', icon_class='mdi mdi-monitor', @@ -387,6 +394,7 @@ MENUS = [ CONNECTIONS_MENU, WIRELESS_MENU, IPAM_MENU, + OVERLAY_MENU, VIRTUALIZATION_MENU, CIRCUITS_MENU, POWER_MENU, From 868e94fb730e24e174abba13a77cdef32c619e6e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 14 Jul 2022 12:04:53 -0400 Subject: [PATCH 264/593] Release v3.3-beta1 --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 2 +- base_requirements.txt | 3 +-- docs/release-notes/version-3.3.md | 2 +- mkdocs.yml | 1 + .../extras/migrations/0076_tag_slug_unicode.py | 18 ++++++++++++++++++ netbox/netbox/settings.py | 2 +- requirements.txt | 6 +++--- 8 files changed, 27 insertions(+), 9 deletions(-) create mode 100644 netbox/extras/migrations/0076_tag_slug_unicode.py diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 78231890b..88fbb1df9 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.6 + placeholder: v3.3-beta1 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 71d45092c..1035c02fb 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.6 + placeholder: v3.3-beta1 validations: required: true - type: dropdown diff --git a/base_requirements.txt b/base_requirements.txt index efeede487..59d4b8255 100644 --- a/base_requirements.txt +++ b/base_requirements.txt @@ -52,8 +52,7 @@ django-tables2 # User-defined tags for objects # https://github.com/alex/django-taggit -# Will evaluate v3.0 during NetBox v3.3 beta -django-taggit>=2.1.0,<3.0 +django-taggit # A Django field for representing time zones # https://github.com/mfogel/django-timezone-field/ diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 7a093a35b..5fc11960e 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -1,6 +1,6 @@ # NetBox v3.3 -## v3.3.0 (FUTURE) +## v3.3-beta1 (2022-07-14) ### Breaking Changes diff --git a/mkdocs.yml b/mkdocs.yml index 5e9f4b842..34c65ed01 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -152,6 +152,7 @@ nav: - Release Checklist: 'development/release-checklist.md' - Release Notes: - Summary: 'release-notes/index.md' + - Version 3.3: 'release-notes/version-3.3.md' - Version 3.2: 'release-notes/version-3.2.md' - Version 3.1: 'release-notes/version-3.1.md' - Version 3.0: 'release-notes/version-3.0.md' diff --git a/netbox/extras/migrations/0076_tag_slug_unicode.py b/netbox/extras/migrations/0076_tag_slug_unicode.py new file mode 100644 index 000000000..3f4922963 --- /dev/null +++ b/netbox/extras/migrations/0076_tag_slug_unicode.py @@ -0,0 +1,18 @@ +# Generated by Django 4.0.6 on 2022-07-14 15:51 + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('extras', '0075_configcontext_locations'), + ] + + operations = [ + migrations.AlterField( + model_name='tag', + name='slug', + field=models.SlugField(allow_unicode=True, max_length=100, unique=True), + ), + ] diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index b776650dc..e8d414b44 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.3.0-dev' +VERSION = '3.3-beta1' # Hostname HOSTNAME = platform.node() diff --git a/requirements.txt b/requirements.txt index 570c59adf..4c8e5e5ce 100644 --- a/requirements.txt +++ b/requirements.txt @@ -11,7 +11,7 @@ django-redis==5.2.0 django-rich==1.4.0 django-rq==2.5.1 django-tables2==2.4.1 -django-taggit==2.1.0 +django-taggit==3.0.0 django-timezone-field==5.0 djangorestframework==3.13.1 drf-yasg[validation]==1.20.0 @@ -26,10 +26,10 @@ netaddr==0.8.0 Pillow==9.2.0 psycopg2-binary==2.9.3 PyYAML==6.0 -sentry-sdk==1.7.0 +sentry-sdk==1.7.1 social-auth-app-django==5.0.0 social-auth-core==4.3.0 -svgwrite==1.4.2 +svgwrite==1.4.3 tablib==3.2.1 tzdata==2022.1 From b0df24e6d1fac3bf568bc29a16c5d7584032a6d3 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Fri, 15 Jul 2022 08:51:05 +0200 Subject: [PATCH 265/593] UI: Only set focus on select field search boxes if the select is open --- netbox/project-static/dist/netbox.js | Bin 376180 -> 376234 bytes netbox/project-static/dist/netbox.js.map | Bin 345595 -> 345631 bytes .../src/select/api/apiSelect.ts | 7 ++++++- 3 files changed, 6 insertions(+), 1 deletion(-) diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index b611079e17d534b7e0aea1ed07b5e33c124129f5..c766b8a72357ae532a9e3a1e3c988ac73050d0fc 100644 GIT binary patch delta 48 zcmezJOKjC|v4$4L7N!>F7M3lnkAtR9zs4do-M^iglSiqzSU0~QHBU)XO>O&?Al3z0 E0OZpWQ2+n{ delta 25 hcmZ4WTkOj(v4$4L7N!>F7M3lnkAt>L2D47g0sxkh3TprW diff --git a/netbox/project-static/dist/netbox.js.map b/netbox/project-static/dist/netbox.js.map index 494ba0b56e2fc3ad948e546f77283e156a6b89a8..55474df17cba29ff6f6346049b65baf3886a7ca2 100644 GIT binary patch delta 98 zcmey}EjqtPw4sHug{g&k3(MheYVIyN-j0smNJOBcW1vo`qhqK}u%lzJPNbu=sq^#) tw^*cD0v+8gw?F>I63oYyQR!6WtmE&PS-IVTmDQJ>DNlQQKM!k;B>+lVA4dQH delta 62 zcmbQ=Bl^2rw4sHug{g&k3(MheOwK;jAKYS*VhMC~Hr>wtoh6u$%eca+%2~(X(WGK~ S3M;EGJCmj5_RT!3IhFv Date: Fri, 15 Jul 2022 08:34:30 -0400 Subject: [PATCH 266/593] Fixes #9715: Fix SOCIAL_AUTH_PIPELINE config parameter not taking effect --- docs/administration/authentication/overview.md | 2 +- docs/release-notes/version-3.2.md | 5 +++++ netbox/netbox/settings.py | 15 ++++++++------- 3 files changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/administration/authentication/overview.md b/docs/administration/authentication/overview.md index b405ed09a..fca9eab5e 100644 --- a/docs/administration/authentication/overview.md +++ b/docs/administration/authentication/overview.md @@ -34,4 +34,4 @@ REMOTE_AUTH_BACKEND = 'social_core.backends.google.GoogleOAuth2' NetBox supports single sign-on authentication via the [python-social-auth](https://github.com/python-social-auth) library. To enable SSO, specify the path to the desired authentication backend within the `social_core` Python package. Please see the complete list of [supported authentication backends](https://github.com/python-social-auth/social-core/tree/master/social_core/backends) for the available options. -Most remote authentication backends require some additional configuration through settings prefixed with `SOCIAL_AUTH_`. These will be automatically imported from NetBox's `configuration.py` file. Additionally, the [authentication pipeline](https://python-social-auth.readthedocs.io/en/latest/pipeline.html) can be customized via the `SOCIAL_AUTH_PIPELINE` parameter. +Most remote authentication backends require some additional configuration through settings prefixed with `SOCIAL_AUTH_`. These will be automatically imported from NetBox's `configuration.py` file. Additionally, the [authentication pipeline](https://python-social-auth.readthedocs.io/en/latest/pipeline.html) can be customized via the `SOCIAL_AUTH_PIPELINE` parameter. (NetBox's default pipeline is defined in `netbox/settings.py` for your reference.) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 1ba6235b8..250082061 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,6 +2,11 @@ ## v3.2.7 (FUTURE) +### Bug Fixes + +* [#9715](https://github.com/netbox-community/netbox/issues/9715) - Fix `SOCIAL_AUTH_PIPELINE` config parameter not taking effect +* [#9734](https://github.com/netbox-community/netbox/issues/9734) - Fix stealing focus by select fields in forms + --- ## v3.2.6 (2022-07-11) diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 736290380..b17d70e31 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -476,13 +476,6 @@ if SENTRY_ENABLED: # Django social auth # -# Load all SOCIAL_AUTH_* settings from the user configuration -for param in dir(configuration): - if param.startswith('SOCIAL_AUTH_'): - globals()[param] = getattr(configuration, param) - -SOCIAL_AUTH_JSONFIELD_ENABLED = True - SOCIAL_AUTH_PIPELINE = ( 'social_core.pipeline.social_auth.social_details', 'social_core.pipeline.social_auth.social_uid', @@ -496,6 +489,14 @@ SOCIAL_AUTH_PIPELINE = ( 'social_core.pipeline.user.user_details', ) +# Load all SOCIAL_AUTH_* settings from the user configuration +for param in dir(configuration): + if param.startswith('SOCIAL_AUTH_'): + globals()[param] = getattr(configuration, param) + +# Force usage of PostgreSQL's JSONB field for extra data +SOCIAL_AUTH_JSONFIELD_ENABLED = True + # # Django Prometheus From fe2fae5b86d554a9a242a376084b246f3e78c6bf Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 15 Jul 2022 09:42:12 -0400 Subject: [PATCH 267/593] Closes #9741: Check for UserConfig instance during user login --- docs/release-notes/version-3.2.md | 4 ++++ netbox/users/views.py | 10 ++++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 250082061..6ec077b8d 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,6 +2,10 @@ ## v3.2.7 (FUTURE) +### Enhancements + +* [#9741](https://github.com/netbox-community/netbox/issues/9741) - Check for UserConfig instance during user login + ### Bug Fixes * [#9715](https://github.com/netbox-community/netbox/issues/9715) - Fix `SOCIAL_AUTH_PIPELINE` config parameter not taking effect diff --git a/netbox/users/views.py b/netbox/users/views.py index 6a923e77e..344f375fc 100644 --- a/netbox/users/views.py +++ b/netbox/users/views.py @@ -20,7 +20,7 @@ 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 -from .models import Token +from .models import Token, UserConfig # @@ -69,7 +69,13 @@ class LoginView(View): # Authenticate user auth_login(request, form.get_user()) logger.info(f"User {request.user} successfully authenticated") - messages.info(request, "Logged in as {}.".format(request.user)) + messages.info(request, f"Logged in as {request.user}.") + + # Ensure the user has a UserConfig defined. (This should normally be handled by + # create_userconfig() on user creation.) + if not hasattr(request.user, 'config'): + config = get_config() + UserConfig(user=request.user, data=config.DEFAULT_USER_PREFERENCES).save() return self.redirect_to_next(request, logger) From e8dd952aa5dd908acfa3af47f918ab2f3e4b7c45 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 15 Jul 2022 10:07:35 -0400 Subject: [PATCH 268/593] Fix migration progress output --- netbox/dcim/migrations/0158_populate_cable_terminations.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/netbox/dcim/migrations/0158_populate_cable_terminations.py b/netbox/dcim/migrations/0158_populate_cable_terminations.py index 5836d24be..72d7f154a 100644 --- a/netbox/dcim/migrations/0158_populate_cable_terminations.py +++ b/netbox/dcim/migrations/0158_populate_cable_terminations.py @@ -64,6 +64,8 @@ def populate_cable_terminations(apps, schema_editor): # Output progress occasionally if 'test' not in sys.argv and not i % 100: progress = float(i) * 100 / cable_count + if i == 100: + print('') sys.stdout.write(f"\r Updated {i}/{cable_count} cables ({progress:.2f}%)") sys.stdout.flush() From 024e7d86510adcbe8a948640c052fb1c4059223a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 15 Jul 2022 10:19:56 -0400 Subject: [PATCH 269/593] Fixes #9728: Fix validation when assigning a virtual machine to a device --- docs/release-notes/version-3.3.md | 6 +++++- netbox/virtualization/forms/models.py | 3 ++- netbox/virtualization/models.py | 4 ++++ 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 5fc11960e..b0bcaaa63 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -1,6 +1,6 @@ # NetBox v3.3 -## v3.3-beta1 (2022-07-14) +## v3.3.0 (FUTURE) ### Breaking Changes @@ -96,6 +96,10 @@ Custom field UI visibility has no impact on API operation. * [#9536](https://github.com/netbox-community/netbox/issues/9536) - Track API token usage times * [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location +### Bug Fixes + +* [#9728](https://github.com/netbox-community/netbox/issues/9728) - Fix validation when assigning a virtual machine to a device + ### Plugins API * [#9075](https://github.com/netbox-community/netbox/issues/9075) - Introduce `AbortRequest` exception for cleanly interrupting object mutations diff --git a/netbox/virtualization/forms/models.py b/netbox/virtualization/forms/models.py index a60d15281..723c19332 100644 --- a/netbox/virtualization/forms/models.py +++ b/netbox/virtualization/forms/models.py @@ -189,7 +189,8 @@ class VirtualMachineForm(TenancyForm, NetBoxModelForm): queryset=Device.objects.all(), required=False, query_params={ - 'cluster_id': '$cluster' + 'cluster_id': '$cluster', + 'site_id': '$site', }, help_text="Optionally pin this VM to a specific host device within the cluster" ) diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py index 98321976f..f07b176e7 100644 --- a/netbox/virtualization/models.py +++ b/netbox/virtualization/models.py @@ -349,6 +349,10 @@ class VirtualMachine(NetBoxModel, ConfigContextModel): }) # Validate assigned cluster device + if self.device and not self.cluster: + raise ValidationError({ + 'device': f'Must specify a cluster when assigning a host device.' + }) if self.device and self.device not in self.cluster.devices.all(): raise ValidationError({ 'device': f'The selected device ({self.device} is not assigned to this cluster ({self.cluster}).' From 6da171a6997c931fd26faa444d36c97d6ac97243 Mon Sep 17 00:00:00 2001 From: Henry Date: Fri, 15 Jul 2022 10:52:37 -0400 Subject: [PATCH 270/593] Corrected typo for description of 'snapshots' --- docs/models/extras/webhook.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/models/extras/webhook.md b/docs/models/extras/webhook.md index d0137938d..9f64401ae 100644 --- a/docs/models/extras/webhook.md +++ b/docs/models/extras/webhook.md @@ -43,7 +43,7 @@ The following data is available as context for Jinja2 templates: * `username` - The name of the user account associated with the change. * `request_id` - The unique request ID. This may be used to correlate multiple changes associated with a single request. * `data` - A detailed representation of the object in its current state. This is typically equivalent to the model's representation in NetBox's REST API. -* `snapshots` - Minimal "snapshots" of the object state both before and after the change was made; provided ass a dictionary with keys named `prechange` and `postchange`. These are not as extensive as the fully serialized representation, but contain enough information to convey what has changed. +* `snapshots` - Minimal "snapshots" of the object state both before and after the change was made; provided as a dictionary with keys named `prechange` and `postchange`. These are not as extensive as the fully serialized representation, but contain enough information to convey what has changed. ### Default Request Body From 587a34442a822e99357ee92daa9b5f43f3ce9ef6 Mon Sep 17 00:00:00 2001 From: Brian Candler Date: Fri, 15 Jul 2022 17:10:15 +0100 Subject: [PATCH 271/593] Documentation: distinguish release and git upgrade processes Fixes #9743 --- docs/installation/upgrading.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/installation/upgrading.md b/docs/installation/upgrading.md index 014dffaf8..deeec883a 100644 --- a/docs/installation/upgrading.md +++ b/docs/installation/upgrading.md @@ -18,6 +18,21 @@ NetBox v3.0 and later require the following: As with the initial installation, you can upgrade NetBox by either downloading the latest release package or by cloning the `master` branch of the git repository. +!!! warning + Use the same method as you used to install Netbox originally + +If you are not sure how Netbox was installed originally, check with this +command: + +``` +ls -ld /opt/netbox /opt/netbox/.git +``` + +If Netbox was installed from a release package, then `/opt/netbox` will be a +symlink pointing to the current version, and `/opt/netbox/.git` will not +exist. If it was installed from git, then `/opt/netbox` and +`/opt/netbox/.git` will both exist as normal directories. + ### Option A: Download a Release Download the [latest stable release](https://github.com/netbox-community/netbox/releases) from GitHub as a tarball or ZIP archive. Extract it to your desired path. In this example, we'll use `/opt/netbox`. From 68b87dd668dc1f497bd2cb27dc79b4e251d8626a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 15 Jul 2022 13:27:20 -0400 Subject: [PATCH 272/593] Fixes #9729: Fix ordering of content type creation to ensure compatability with demo data --- docs/release-notes/version-3.3.md | 1 + netbox/dcim/migrations/0160_populate_cable_ends.py | 12 ++++++++---- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index b0bcaaa63..5d4a6ccfb 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -99,6 +99,7 @@ Custom field UI visibility has no impact on API operation. ### Bug Fixes * [#9728](https://github.com/netbox-community/netbox/issues/9728) - Fix validation when assigning a virtual machine to a device +* [#9729](https://github.com/netbox-community/netbox/issues/9729) - Fix ordering of content type creation to ensure compatability with demo data ### Plugins API diff --git a/netbox/dcim/migrations/0160_populate_cable_ends.py b/netbox/dcim/migrations/0160_populate_cable_ends.py index 0dac81df3..53e042abc 100644 --- a/netbox/dcim/migrations/0160_populate_cable_ends.py +++ b/netbox/dcim/migrations/0160_populate_cable_ends.py @@ -3,7 +3,6 @@ from django.db import migrations def populate_cable_terminations(apps, schema_editor): Cable = apps.get_model('dcim', 'Cable') - ContentType = apps.get_model('contenttypes', 'ContentType') cable_termination_models = ( apps.get_model('dcim', 'ConsolePort'), @@ -18,12 +17,17 @@ def populate_cable_terminations(apps, schema_editor): ) for model in cable_termination_models: - ct = ContentType.objects.get_for_model(model) model.objects.filter( - id__in=Cable.objects.filter(termination_a_type=ct).values_list('termination_a_id', flat=True) + id__in=Cable.objects.filter( + termination_a_type__app_label=model._meta.app_label, + termination_a_type__model=model._meta.model_name + ).values_list('termination_a_id', flat=True) ).update(cable_end='A') model.objects.filter( - id__in=Cable.objects.filter(termination_b_type=ct).values_list('termination_b_id', flat=True) + id__in=Cable.objects.filter( + termination_b_type__app_label=model._meta.app_label, + termination_b_type__model=model._meta.model_name + ).values_list('termination_b_id', flat=True) ).update(cable_end='B') From 68f53aaa87137d3b22e4b6275b565a363e36b253 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 15 Jul 2022 15:24:47 -0400 Subject: [PATCH 273/593] Closes #9745: Add wireless LANs and links to global search --- docs/release-notes/version-3.2.md | 1 + netbox/netbox/constants.py | 256 +---------------------------- netbox/netbox/forms/__init__.py | 2 +- netbox/netbox/search.py | 261 ++++++++++++++++++++++++++++++ netbox/netbox/views/__init__.py | 3 +- 5 files changed, 266 insertions(+), 257 deletions(-) create mode 100644 netbox/netbox/search.py diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 6ec077b8d..3eb6a7a15 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -5,6 +5,7 @@ ### Enhancements * [#9741](https://github.com/netbox-community/netbox/issues/9741) - Check for UserConfig instance during user login +* [#9745](https://github.com/netbox-community/netbox/issues/9745) - Add wireless LANs and links to global search ### Bug Fixes diff --git a/netbox/netbox/constants.py b/netbox/netbox/constants.py index cc04e9aa8..61588d331 100644 --- a/netbox/netbox/constants.py +++ b/netbox/netbox/constants.py @@ -1,256 +1,2 @@ -from collections import OrderedDict -from typing import Dict - -import circuits.filtersets -import circuits.tables -import dcim.filtersets -import dcim.tables -import ipam.filtersets -import ipam.tables -import tenancy.filtersets -import tenancy.tables -import virtualization.filtersets -import virtualization.tables -from circuits.models import Circuit, ProviderNetwork, Provider -from dcim.models import ( - Cable, Device, DeviceType, Location, Module, ModuleType, PowerFeed, Rack, RackReservation, Site, VirtualChassis, -) -from ipam.models import Aggregate, ASN, IPAddress, Prefix, Service, VLAN, VRF -from tenancy.models import Contact, Tenant, ContactAssignment -from utilities.utils import count_related -from virtualization.models import Cluster, VirtualMachine - +# Max results per object type SEARCH_MAX_RESULTS = 15 - -CIRCUIT_TYPES = OrderedDict( - ( - ('provider', { - 'queryset': Provider.objects.annotate( - count_circuits=count_related(Circuit, 'provider') - ), - 'filterset': circuits.filtersets.ProviderFilterSet, - 'table': circuits.tables.ProviderTable, - 'url': 'circuits:provider_list', - }), - ('circuit', { - 'queryset': Circuit.objects.prefetch_related( - 'type', 'provider', 'tenant', 'tenant__group', 'terminations__site' - ), - 'filterset': circuits.filtersets.CircuitFilterSet, - 'table': circuits.tables.CircuitTable, - 'url': 'circuits:circuit_list', - }), - ('providernetwork', { - 'queryset': ProviderNetwork.objects.prefetch_related('provider'), - 'filterset': circuits.filtersets.ProviderNetworkFilterSet, - 'table': circuits.tables.ProviderNetworkTable, - 'url': 'circuits:providernetwork_list', - }), - ) -) - - -DCIM_TYPES = OrderedDict( - ( - ('site', { - 'queryset': Site.objects.prefetch_related('region', 'tenant', 'tenant__group'), - 'filterset': dcim.filtersets.SiteFilterSet, - 'table': dcim.tables.SiteTable, - 'url': 'dcim:site_list', - }), - ('rack', { - 'queryset': Rack.objects.prefetch_related('site', 'location', 'tenant', 'tenant__group', 'role').annotate( - device_count=count_related(Device, 'rack') - ), - 'filterset': dcim.filtersets.RackFilterSet, - 'table': dcim.tables.RackTable, - 'url': 'dcim:rack_list', - }), - ('rackreservation', { - 'queryset': RackReservation.objects.prefetch_related('site', 'rack', 'user'), - 'filterset': dcim.filtersets.RackReservationFilterSet, - 'table': dcim.tables.RackReservationTable, - 'url': 'dcim:rackreservation_list', - }), - ('location', { - 'queryset': Location.objects.add_related_count( - Location.objects.add_related_count( - Location.objects.all(), - Device, - 'location', - 'device_count', - cumulative=True - ), - Rack, - 'location', - 'rack_count', - cumulative=True - ).prefetch_related('site'), - 'filterset': dcim.filtersets.LocationFilterSet, - 'table': dcim.tables.LocationTable, - 'url': 'dcim:location_list', - }), - ('devicetype', { - 'queryset': DeviceType.objects.prefetch_related('manufacturer').annotate( - instance_count=count_related(Device, 'device_type') - ), - 'filterset': dcim.filtersets.DeviceTypeFilterSet, - 'table': dcim.tables.DeviceTypeTable, - 'url': 'dcim:devicetype_list', - }), - ('device', { - 'queryset': Device.objects.prefetch_related( - 'device_type__manufacturer', 'device_role', 'tenant', 'tenant__group', 'site', 'rack', 'primary_ip4', 'primary_ip6', - ), - 'filterset': dcim.filtersets.DeviceFilterSet, - 'table': dcim.tables.DeviceTable, - 'url': 'dcim:device_list', - }), - ('moduletype', { - 'queryset': ModuleType.objects.prefetch_related('manufacturer').annotate( - instance_count=count_related(Module, 'module_type') - ), - 'filterset': dcim.filtersets.ModuleTypeFilterSet, - 'table': dcim.tables.ModuleTypeTable, - 'url': 'dcim:moduletype_list', - }), - ('module', { - 'queryset': Module.objects.prefetch_related( - 'module_type__manufacturer', 'device', 'module_bay', - ), - 'filterset': dcim.filtersets.ModuleFilterSet, - 'table': dcim.tables.ModuleTable, - 'url': 'dcim:module_list', - }), - ('virtualchassis', { - 'queryset': VirtualChassis.objects.prefetch_related('master').annotate( - member_count=count_related(Device, 'virtual_chassis') - ), - 'filterset': dcim.filtersets.VirtualChassisFilterSet, - 'table': dcim.tables.VirtualChassisTable, - 'url': 'dcim:virtualchassis_list', - }), - ('cable', { - 'queryset': Cable.objects.all(), - 'filterset': dcim.filtersets.CableFilterSet, - 'table': dcim.tables.CableTable, - 'url': 'dcim:cable_list', - }), - ('powerfeed', { - 'queryset': PowerFeed.objects.all(), - 'filterset': dcim.filtersets.PowerFeedFilterSet, - 'table': dcim.tables.PowerFeedTable, - 'url': 'dcim:powerfeed_list', - }), - ) -) - -IPAM_TYPES = OrderedDict( - ( - ('vrf', { - 'queryset': VRF.objects.prefetch_related('tenant', 'tenant__group'), - 'filterset': ipam.filtersets.VRFFilterSet, - 'table': ipam.tables.VRFTable, - 'url': 'ipam:vrf_list', - }), - ('aggregate', { - 'queryset': Aggregate.objects.prefetch_related('rir'), - 'filterset': ipam.filtersets.AggregateFilterSet, - 'table': ipam.tables.AggregateTable, - 'url': 'ipam:aggregate_list', - }), - ('prefix', { - 'queryset': Prefix.objects.prefetch_related('site', 'vrf__tenant', 'tenant', 'tenant__group', 'vlan', 'role'), - 'filterset': ipam.filtersets.PrefixFilterSet, - 'table': ipam.tables.PrefixTable, - 'url': 'ipam:prefix_list', - }), - ('ipaddress', { - 'queryset': IPAddress.objects.prefetch_related('vrf__tenant', 'tenant', 'tenant__group'), - 'filterset': ipam.filtersets.IPAddressFilterSet, - 'table': ipam.tables.IPAddressTable, - 'url': 'ipam:ipaddress_list', - }), - ('vlan', { - 'queryset': VLAN.objects.prefetch_related('site', 'group', 'tenant', 'tenant__group', 'role'), - 'filterset': ipam.filtersets.VLANFilterSet, - 'table': ipam.tables.VLANTable, - 'url': 'ipam:vlan_list', - }), - ('asn', { - 'queryset': ASN.objects.prefetch_related('rir', 'tenant', 'tenant__group'), - 'filterset': ipam.filtersets.ASNFilterSet, - 'table': ipam.tables.ASNTable, - 'url': 'ipam:asn_list', - }), - ('service', { - 'queryset': Service.objects.prefetch_related('device', 'virtual_machine'), - 'filterset': ipam.filtersets.ServiceFilterSet, - 'table': ipam.tables.ServiceTable, - 'url': 'ipam:service_list', - }), - ) -) - -TENANCY_TYPES = OrderedDict( - ( - ('tenant', { - 'queryset': Tenant.objects.prefetch_related('group'), - 'filterset': tenancy.filtersets.TenantFilterSet, - 'table': tenancy.tables.TenantTable, - 'url': 'tenancy:tenant_list', - }), - ('contact', { - 'queryset': Contact.objects.prefetch_related('group', 'assignments').annotate( - assignment_count=count_related(ContactAssignment, 'contact')), - 'filterset': tenancy.filtersets.ContactFilterSet, - 'table': tenancy.tables.ContactTable, - 'url': 'tenancy:contact_list', - }), - ) -) - -VIRTUALIZATION_TYPES = OrderedDict( - ( - ('cluster', { - 'queryset': Cluster.objects.prefetch_related('type', 'group').annotate( - device_count=count_related(Device, 'cluster'), - vm_count=count_related(VirtualMachine, 'cluster') - ), - 'filterset': virtualization.filtersets.ClusterFilterSet, - 'table': virtualization.tables.ClusterTable, - 'url': 'virtualization:cluster_list', - }), - ('virtualmachine', { - 'queryset': VirtualMachine.objects.prefetch_related( - 'cluster', 'tenant', 'tenant__group', 'platform', 'primary_ip4', 'primary_ip6', - ), - 'filterset': virtualization.filtersets.VirtualMachineFilterSet, - 'table': virtualization.tables.VirtualMachineTable, - 'url': 'virtualization:virtualmachine_list', - }), - ) -) - -SEARCH_TYPE_HIERARCHY = OrderedDict( - ( - ("Circuits", CIRCUIT_TYPES), - ("DCIM", DCIM_TYPES), - ("IPAM", IPAM_TYPES), - ("Tenancy", TENANCY_TYPES), - ("Virtualization", VIRTUALIZATION_TYPES), - ) -) - - -def build_search_types() -> Dict[str, Dict]: - result = dict() - - for app_types in SEARCH_TYPE_HIERARCHY.values(): - for name, items in app_types.items(): - result[name] = items - - return result - - -SEARCH_TYPES = build_search_types() diff --git a/netbox/netbox/forms/__init__.py b/netbox/netbox/forms/__init__.py index 23848724d..d1451e003 100644 --- a/netbox/netbox/forms/__init__.py +++ b/netbox/netbox/forms/__init__.py @@ -1,6 +1,6 @@ from django import forms -from netbox.constants import SEARCH_TYPE_HIERARCHY +from netbox.search import SEARCH_TYPE_HIERARCHY from utilities.forms import BootstrapMixin from .base import * diff --git a/netbox/netbox/search.py b/netbox/netbox/search.py new file mode 100644 index 000000000..ef0c4fd87 --- /dev/null +++ b/netbox/netbox/search.py @@ -0,0 +1,261 @@ +import circuits.filtersets +import circuits.tables +import dcim.filtersets +import dcim.tables +import ipam.filtersets +import ipam.tables +import tenancy.filtersets +import tenancy.tables +import virtualization.filtersets +import wireless.tables +import wireless.filtersets +import virtualization.tables +from circuits.models import Circuit, ProviderNetwork, Provider +from dcim.models import ( + Cable, Device, DeviceType, Interface, Location, Module, ModuleType, PowerFeed, Rack, RackReservation, Site, + VirtualChassis, +) +from ipam.models import Aggregate, ASN, IPAddress, Prefix, Service, VLAN, VRF +from tenancy.models import Contact, Tenant, ContactAssignment +from utilities.utils import count_related +from wireless.models import WirelessLAN, WirelessLink +from virtualization.models import Cluster, VirtualMachine + +CIRCUIT_TYPES = { + 'provider': { + 'queryset': Provider.objects.annotate( + count_circuits=count_related(Circuit, 'provider') + ), + 'filterset': circuits.filtersets.ProviderFilterSet, + 'table': circuits.tables.ProviderTable, + 'url': 'circuits:provider_list', + }, + 'circuit': { + 'queryset': Circuit.objects.prefetch_related( + 'type', 'provider', 'tenant', 'tenant__group', 'terminations__site' + ), + 'filterset': circuits.filtersets.CircuitFilterSet, + 'table': circuits.tables.CircuitTable, + 'url': 'circuits:circuit_list', + }, + 'providernetwork': { + 'queryset': ProviderNetwork.objects.prefetch_related('provider'), + 'filterset': circuits.filtersets.ProviderNetworkFilterSet, + 'table': circuits.tables.ProviderNetworkTable, + 'url': 'circuits:providernetwork_list', + }, +} + +DCIM_TYPES = { + 'site': { + 'queryset': Site.objects.prefetch_related('region', 'tenant', 'tenant__group'), + 'filterset': dcim.filtersets.SiteFilterSet, + 'table': dcim.tables.SiteTable, + 'url': 'dcim:site_list', + }, + 'rack': { + 'queryset': Rack.objects.prefetch_related('site', 'location', 'tenant', 'tenant__group', 'role').annotate( + device_count=count_related(Device, 'rack') + ), + 'filterset': dcim.filtersets.RackFilterSet, + 'table': dcim.tables.RackTable, + 'url': 'dcim:rack_list', + }, + 'rackreservation': { + 'queryset': RackReservation.objects.prefetch_related('site', 'rack', 'user'), + 'filterset': dcim.filtersets.RackReservationFilterSet, + 'table': dcim.tables.RackReservationTable, + 'url': 'dcim:rackreservation_list', + }, + 'location': { + 'queryset': Location.objects.add_related_count( + Location.objects.add_related_count( + Location.objects.all(), + Device, + 'location', + 'device_count', + cumulative=True + ), + Rack, + 'location', + 'rack_count', + cumulative=True + ).prefetch_related('site'), + 'filterset': dcim.filtersets.LocationFilterSet, + 'table': dcim.tables.LocationTable, + 'url': 'dcim:location_list', + }, + 'devicetype': { + 'queryset': DeviceType.objects.prefetch_related('manufacturer').annotate( + instance_count=count_related(Device, 'device_type') + ), + 'filterset': dcim.filtersets.DeviceTypeFilterSet, + 'table': dcim.tables.DeviceTypeTable, + 'url': 'dcim:devicetype_list', + }, + 'device': { + 'queryset': Device.objects.prefetch_related( + 'device_type__manufacturer', 'device_role', 'tenant', 'tenant__group', 'site', 'rack', 'primary_ip4', + 'primary_ip6', + ), + 'filterset': dcim.filtersets.DeviceFilterSet, + 'table': dcim.tables.DeviceTable, + 'url': 'dcim:device_list', + }, + 'moduletype': { + 'queryset': ModuleType.objects.prefetch_related('manufacturer').annotate( + instance_count=count_related(Module, 'module_type') + ), + 'filterset': dcim.filtersets.ModuleTypeFilterSet, + 'table': dcim.tables.ModuleTypeTable, + 'url': 'dcim:moduletype_list', + }, + 'module': { + 'queryset': Module.objects.prefetch_related( + 'module_type__manufacturer', 'device', 'module_bay', + ), + 'filterset': dcim.filtersets.ModuleFilterSet, + 'table': dcim.tables.ModuleTable, + 'url': 'dcim:module_list', + }, + 'virtualchassis': { + 'queryset': VirtualChassis.objects.prefetch_related('master').annotate( + member_count=count_related(Device, 'virtual_chassis') + ), + 'filterset': dcim.filtersets.VirtualChassisFilterSet, + 'table': dcim.tables.VirtualChassisTable, + 'url': 'dcim:virtualchassis_list', + }, + 'cable': { + 'queryset': Cable.objects.all(), + 'filterset': dcim.filtersets.CableFilterSet, + 'table': dcim.tables.CableTable, + 'url': 'dcim:cable_list', + }, + 'powerfeed': { + 'queryset': PowerFeed.objects.all(), + 'filterset': dcim.filtersets.PowerFeedFilterSet, + 'table': dcim.tables.PowerFeedTable, + 'url': 'dcim:powerfeed_list', + }, +} + +IPAM_TYPES = { + 'vrf': { + 'queryset': VRF.objects.prefetch_related('tenant', 'tenant__group'), + 'filterset': ipam.filtersets.VRFFilterSet, + 'table': ipam.tables.VRFTable, + 'url': 'ipam:vrf_list', + }, + 'aggregate': { + 'queryset': Aggregate.objects.prefetch_related('rir'), + 'filterset': ipam.filtersets.AggregateFilterSet, + 'table': ipam.tables.AggregateTable, + 'url': 'ipam:aggregate_list', + }, + 'prefix': { + 'queryset': Prefix.objects.prefetch_related('site', 'vrf__tenant', 'tenant', 'tenant__group', 'vlan', 'role'), + 'filterset': ipam.filtersets.PrefixFilterSet, + 'table': ipam.tables.PrefixTable, + 'url': 'ipam:prefix_list', + }, + 'ipaddress': { + 'queryset': IPAddress.objects.prefetch_related('vrf__tenant', 'tenant', 'tenant__group'), + 'filterset': ipam.filtersets.IPAddressFilterSet, + 'table': ipam.tables.IPAddressTable, + 'url': 'ipam:ipaddress_list', + }, + 'vlan': { + 'queryset': VLAN.objects.prefetch_related('site', 'group', 'tenant', 'tenant__group', 'role'), + 'filterset': ipam.filtersets.VLANFilterSet, + 'table': ipam.tables.VLANTable, + 'url': 'ipam:vlan_list', + }, + 'asn': { + 'queryset': ASN.objects.prefetch_related('rir', 'tenant', 'tenant__group'), + 'filterset': ipam.filtersets.ASNFilterSet, + 'table': ipam.tables.ASNTable, + 'url': 'ipam:asn_list', + }, + 'service': { + 'queryset': Service.objects.prefetch_related('device', 'virtual_machine'), + 'filterset': ipam.filtersets.ServiceFilterSet, + 'table': ipam.tables.ServiceTable, + 'url': 'ipam:service_list', + }, +} + +TENANCY_TYPES = { + 'tenant': { + 'queryset': Tenant.objects.prefetch_related('group'), + 'filterset': tenancy.filtersets.TenantFilterSet, + 'table': tenancy.tables.TenantTable, + 'url': 'tenancy:tenant_list', + }, + 'contact': { + 'queryset': Contact.objects.prefetch_related('group', 'assignments').annotate( + assignment_count=count_related(ContactAssignment, 'contact')), + 'filterset': tenancy.filtersets.ContactFilterSet, + 'table': tenancy.tables.ContactTable, + 'url': 'tenancy:contact_list', + }, +} + +VIRTUALIZATION_TYPES = { + 'cluster': { + 'queryset': Cluster.objects.prefetch_related('type', 'group').annotate( + device_count=count_related(Device, 'cluster'), + vm_count=count_related(VirtualMachine, 'cluster') + ), + 'filterset': virtualization.filtersets.ClusterFilterSet, + 'table': virtualization.tables.ClusterTable, + 'url': 'virtualization:cluster_list', + }, + 'virtualmachine': { + 'queryset': VirtualMachine.objects.prefetch_related( + 'cluster', 'tenant', 'tenant__group', 'platform', 'primary_ip4', 'primary_ip6', + ), + 'filterset': virtualization.filtersets.VirtualMachineFilterSet, + 'table': virtualization.tables.VirtualMachineTable, + 'url': 'virtualization:virtualmachine_list', + }, +} + +WIRELESS_TYPES = { + 'wirelesslan': { + 'queryset': WirelessLAN.objects.prefetch_related('group', 'vlan').annotate( + interface_count=count_related(Interface, 'wireless_lans') + ), + 'filterset': wireless.filtersets.WirelessLANFilterSet, + 'table': wireless.tables.WirelessLANTable, + 'url': 'wireless:wirelesslan_list', + }, + 'wirelesslink': { + 'queryset': WirelessLink.objects.prefetch_related('interface_a__device', 'interface_b__device'), + 'filterset': wireless.filtersets.WirelessLinkFilterSet, + 'table': wireless.tables.WirelessLinkTable, + 'url': 'wireless:wirelesslink_list', + }, +} + +SEARCH_TYPE_HIERARCHY = { + 'Circuits': CIRCUIT_TYPES, + 'DCIM': DCIM_TYPES, + 'IPAM': IPAM_TYPES, + 'Tenancy': TENANCY_TYPES, + 'Virtualization': VIRTUALIZATION_TYPES, + 'Wireless': WIRELESS_TYPES, +} + + +def build_search_types(): + result = dict() + + for app_types in SEARCH_TYPE_HIERARCHY.values(): + for name, items in app_types.items(): + result[name] = items + + return result + + +SEARCH_TYPES = build_search_types() diff --git a/netbox/netbox/views/__init__.py b/netbox/netbox/views/__init__.py index f159ee637..204fce469 100644 --- a/netbox/netbox/views/__init__.py +++ b/netbox/netbox/views/__init__.py @@ -22,8 +22,9 @@ from dcim.models import ( 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 +from netbox.constants import SEARCH_MAX_RESULTS from netbox.forms import SearchForm +from netbox.search import SEARCH_TYPES from tenancy.models import Tenant from virtualization.models import Cluster, VirtualMachine from wireless.models import WirelessLAN, WirelessLink From e07dd3ddcb2b8453d5a72ccb984e456297fb8296 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 15 Jul 2022 15:31:42 -0400 Subject: [PATCH 274/593] Define NESTED_SERIALIZER_PREFIX constant --- netbox/dcim/api/serializers.py | 17 +++++++++-------- netbox/dcim/api/views.py | 5 +++-- netbox/extras/api/customfields.py | 5 +++-- netbox/extras/api/serializers.py | 7 ++++--- netbox/ipam/api/serializers.py | 7 ++++--- netbox/netbox/api/viewsets/__init__.py | 3 ++- netbox/netbox/constants.py | 3 +++ netbox/tenancy/api/serializers.py | 3 ++- 8 files changed, 30 insertions(+), 20 deletions(-) diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index c2cb846a9..d95480aa7 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -15,6 +15,7 @@ from netbox.api.serializers import ( NestedGroupModelSerializer, NetBoxModelSerializer, ValidatedModelSerializer, WritableNestedSerializer, ) from netbox.config import ConfigItem +from netbox.constants import NESTED_SERIALIZER_PREFIX from tenancy.api.nested_serializers import NestedTenantSerializer from users.api.nested_serializers import NestedUserSerializer from utilities.api import get_serializer_for_model @@ -41,7 +42,7 @@ class LinkTerminationSerializer(serializers.ModelSerializer): Return the appropriate serializer for the link termination model. """ if obj._link_peer is not None: - serializer = get_serializer_for_model(obj._link_peer, prefix='Nested') + serializer = get_serializer_for_model(obj._link_peer, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(obj._link_peer, context=context).data return None @@ -67,7 +68,7 @@ class ConnectedEndpointSerializer(serializers.ModelSerializer): Return the appropriate serializer for the type of connected object. """ if obj._path is not None and obj._path.destination is not None: - serializer = get_serializer_for_model(obj._path.destination, prefix='Nested') + serializer = get_serializer_for_model(obj._path.destination, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(obj._path.destination, context=context).data return None @@ -543,7 +544,7 @@ class InventoryItemTemplateSerializer(ValidatedModelSerializer): def get_component(self, obj): if obj.component is None: return None - serializer = get_serializer_for_model(obj.component, prefix='Nested') + serializer = get_serializer_for_model(obj.component, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(obj.component, context=context).data @@ -935,7 +936,7 @@ class InventoryItemSerializer(NetBoxModelSerializer): def get_component(self, obj): if obj.component is None: return None - serializer = get_serializer_for_model(obj.component, prefix='Nested') + serializer = get_serializer_for_model(obj.component, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(obj.component, context=context).data @@ -991,7 +992,7 @@ class CableSerializer(NetBoxModelSerializer): termination = getattr(obj, 'termination_{}'.format(side.lower())) if termination is None: return None - serializer = get_serializer_for_model(termination, prefix='Nested') + serializer = get_serializer_for_model(termination, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} data = serializer(termination, context=context).data @@ -1037,7 +1038,7 @@ class CablePathSerializer(serializers.ModelSerializer): """ Return the appropriate serializer for the origin. """ - serializer = get_serializer_for_model(obj.origin, prefix='Nested') + serializer = get_serializer_for_model(obj.origin, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(obj.origin, context=context).data @@ -1047,7 +1048,7 @@ class CablePathSerializer(serializers.ModelSerializer): Return the appropriate serializer for the destination, if any. """ if obj.destination_id is not None: - serializer = get_serializer_for_model(obj.destination, prefix='Nested') + serializer = get_serializer_for_model(obj.destination, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(obj.destination, context=context).data return None @@ -1056,7 +1057,7 @@ class CablePathSerializer(serializers.ModelSerializer): def get_path(self, obj): ret = [] for node in obj.get_path(): - serializer = get_serializer_for_model(node, prefix='Nested') + serializer = get_serializer_for_model(node, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} ret.append(serializer(node, context=context).data) return ret diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 3fa652a9b..6387e26f8 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -22,6 +22,7 @@ from netbox.api.metadata import ContentTypeMetadata from netbox.api.pagination import StripCountAnnotationsPaginator from netbox.api.viewsets import NetBoxModelViewSet from netbox.config import get_config +from netbox.constants import NESTED_SERIALIZER_PREFIX from utilities.api import get_serializer_for_model from utilities.utils import count_related from virtualization.models import VirtualMachine @@ -69,14 +70,14 @@ class PathEndpointMixin(object): break # Serialize each object - serializer_a = get_serializer_for_model(near_end, prefix='Nested') + serializer_a = get_serializer_for_model(near_end, prefix=NESTED_SERIALIZER_PREFIX) x = serializer_a(near_end, context={'request': request}).data if cable is not None: y = serializers.TracedCableSerializer(cable, context={'request': request}).data else: y = None if far_end is not None: - serializer_b = get_serializer_for_model(far_end, prefix='Nested') + serializer_b = get_serializer_for_model(far_end, prefix=NESTED_SERIALIZER_PREFIX) z = serializer_b(far_end, context={'request': request}).data else: z = None diff --git a/netbox/extras/api/customfields.py b/netbox/extras/api/customfields.py index fd6e1f550..b7fd1e129 100644 --- a/netbox/extras/api/customfields.py +++ b/netbox/extras/api/customfields.py @@ -3,6 +3,7 @@ from rest_framework.fields import Field from extras.choices import CustomFieldTypeChoices from extras.models import CustomField +from netbox.constants import NESTED_SERIALIZER_PREFIX # @@ -51,10 +52,10 @@ class CustomFieldsDataField(Field): for cf in self._get_custom_fields(): value = cf.deserialize(obj.get(cf.name)) if value is not None and cf.type == CustomFieldTypeChoices.TYPE_OBJECT: - serializer = get_serializer_for_model(cf.object_type.model_class(), prefix='Nested') + serializer = get_serializer_for_model(cf.object_type.model_class(), prefix=NESTED_SERIALIZER_PREFIX) value = serializer(value, context=self.parent.context).data elif value is not None and cf.type == CustomFieldTypeChoices.TYPE_MULTIOBJECT: - serializer = get_serializer_for_model(cf.object_type.model_class(), prefix='Nested') + serializer = get_serializer_for_model(cf.object_type.model_class(), prefix=NESTED_SERIALIZER_PREFIX) value = serializer(value, many=True, context=self.parent.context).data data[cf.name] = value diff --git a/netbox/extras/api/serializers.py b/netbox/extras/api/serializers.py index bdb54067a..a4e3c6609 100644 --- a/netbox/extras/api/serializers.py +++ b/netbox/extras/api/serializers.py @@ -15,6 +15,7 @@ from extras.utils import FeatureQuery from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField from netbox.api.exceptions import SerializerNotFound from netbox.api.serializers import BaseModelSerializer, NetBoxModelSerializer, ValidatedModelSerializer +from netbox.constants import NESTED_SERIALIZER_PREFIX from tenancy.api.nested_serializers import NestedTenantSerializer, NestedTenantGroupSerializer from tenancy.models import Tenant, TenantGroup from users.api.nested_serializers import NestedUserSerializer @@ -192,7 +193,7 @@ class ImageAttachmentSerializer(ValidatedModelSerializer): @swagger_serializer_method(serializer_or_field=serializers.DictField) def get_parent(self, obj): - serializer = get_serializer_for_model(obj.parent, prefix='Nested') + serializer = get_serializer_for_model(obj.parent, prefix=NESTED_SERIALIZER_PREFIX) return serializer(obj.parent, context={'request': self.context['request']}).data @@ -242,7 +243,7 @@ class JournalEntrySerializer(NetBoxModelSerializer): @swagger_serializer_method(serializer_or_field=serializers.DictField) def get_assigned_object(self, instance): - serializer = get_serializer_for_model(instance.assigned_object_type.model_class(), prefix='Nested') + serializer = get_serializer_for_model(instance.assigned_object_type.model_class(), prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(instance.assigned_object, context=context).data @@ -462,7 +463,7 @@ class ObjectChangeSerializer(BaseModelSerializer): return None try: - serializer = get_serializer_for_model(obj.changed_object, prefix='Nested') + serializer = get_serializer_for_model(obj.changed_object, prefix=NESTED_SERIALIZER_PREFIX) except SerializerNotFound: return obj.object_repr context = { diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index 3fa1bcc7e..4462ed697 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -10,6 +10,7 @@ from ipam.constants import IPADDRESS_ASSIGNMENT_MODELS, VLANGROUP_SCOPE_TYPES from ipam.models import * from netbox.api import ChoiceField, ContentTypeField, SerializedPKRelatedField from netbox.api.serializers import NetBoxModelSerializer +from netbox.constants import NESTED_SERIALIZER_PREFIX from tenancy.api.nested_serializers import NestedTenantSerializer from utilities.api import get_serializer_for_model from virtualization.api.nested_serializers import NestedVirtualMachineSerializer @@ -145,7 +146,7 @@ class FHRPGroupAssignmentSerializer(NetBoxModelSerializer): def get_interface(self, obj): if obj.interface is None: return None - serializer = get_serializer_for_model(obj.interface, prefix='Nested') + serializer = get_serializer_for_model(obj.interface, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(obj.interface, context=context).data @@ -191,7 +192,7 @@ class VLANGroupSerializer(NetBoxModelSerializer): def get_scope(self, obj): if obj.scope_id is None: return None - serializer = get_serializer_for_model(obj.scope, prefix='Nested') + serializer = get_serializer_for_model(obj.scope, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(obj.scope, context=context).data @@ -375,7 +376,7 @@ class IPAddressSerializer(NetBoxModelSerializer): def get_assigned_object(self, obj): if obj.assigned_object is None: return None - serializer = get_serializer_for_model(obj.assigned_object, prefix='Nested') + serializer = get_serializer_for_model(obj.assigned_object, prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(obj.assigned_object, context=context).data diff --git a/netbox/netbox/api/viewsets/__init__.py b/netbox/netbox/api/viewsets/__init__.py index 462c07c6f..0f149240d 100644 --- a/netbox/netbox/api/viewsets/__init__.py +++ b/netbox/netbox/api/viewsets/__init__.py @@ -10,6 +10,7 @@ from rest_framework.viewsets import ModelViewSet from extras.models import ExportTemplate from netbox.api.exceptions import SerializerNotFound +from netbox.constants import NESTED_SERIALIZER_PREFIX from utilities.api import get_serializer_for_model from .mixins import * @@ -60,7 +61,7 @@ class NetBoxModelViewSet(BulkUpdateModelMixin, BulkDestroyModelMixin, ObjectVali if self.brief: logger.debug("Request is for 'brief' format; initializing nested serializer") try: - serializer = get_serializer_for_model(self.queryset.model, prefix='Nested') + serializer = get_serializer_for_model(self.queryset.model, prefix=NESTED_SERIALIZER_PREFIX) logger.debug(f"Using serializer {serializer}") return serializer except SerializerNotFound: diff --git a/netbox/netbox/constants.py b/netbox/netbox/constants.py index 61588d331..776938a97 100644 --- a/netbox/netbox/constants.py +++ b/netbox/netbox/constants.py @@ -1,2 +1,5 @@ +# Prefix for nested serializers +NESTED_SERIALIZER_PREFIX = 'Nested' + # Max results per object type SEARCH_MAX_RESULTS = 15 diff --git a/netbox/tenancy/api/serializers.py b/netbox/tenancy/api/serializers.py index a2286efed..626554077 100644 --- a/netbox/tenancy/api/serializers.py +++ b/netbox/tenancy/api/serializers.py @@ -4,6 +4,7 @@ from rest_framework import serializers from netbox.api import ChoiceField, ContentTypeField from netbox.api.serializers import NestedGroupModelSerializer, NetBoxModelSerializer +from netbox.constants import NESTED_SERIALIZER_PREFIX from tenancy.choices import ContactPriorityChoices from tenancy.models import * from utilities.api import get_serializer_for_model @@ -108,6 +109,6 @@ class ContactAssignmentSerializer(NetBoxModelSerializer): @swagger_serializer_method(serializer_or_field=serializers.DictField) def get_object(self, instance): - serializer = get_serializer_for_model(instance.content_type.model_class(), prefix='Nested') + serializer = get_serializer_for_model(instance.content_type.model_class(), prefix=NESTED_SERIALIZER_PREFIX) context = {'request': self.context['request']} return serializer(instance.object, context=context).data From 250265c3d951e588a19a233fb4893fd98f68f771 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 15 Jul 2022 15:40:55 -0400 Subject: [PATCH 275/593] Fixes #9746: Permit filtering interfaces by arbitrary speed value in UI --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/forms/filtersets.py | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 3eb6a7a15..ce491e0db 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -11,6 +11,7 @@ * [#9715](https://github.com/netbox-community/netbox/issues/9715) - Fix `SOCIAL_AUTH_PIPELINE` config parameter not taking effect * [#9734](https://github.com/netbox-community/netbox/issues/9734) - Fix stealing focus by select fields in forms +* [#9746](https://github.com/netbox-community/netbox/issues/9746) - Permit filtering interfaces by arbitrary speed value in UI --- diff --git a/netbox/dcim/forms/filtersets.py b/netbox/dcim/forms/filtersets.py index 1535e5718..38221b371 100644 --- a/netbox/dcim/forms/filtersets.py +++ b/netbox/dcim/forms/filtersets.py @@ -982,8 +982,8 @@ class InterfaceFilterForm(DeviceComponentFilterForm): ) speed = forms.IntegerField( required=False, - label='Select Speed', - widget=SelectSpeedWidget(attrs={'readonly': None}) + label='Speed', + widget=SelectSpeedWidget() ) duplex = MultipleChoiceField( choices=InterfaceDuplexChoices, From f385a5fd5e87c3fd07cd804ad18239a7b54a72e2 Mon Sep 17 00:00:00 2001 From: Marek Zbroch Date: Sat, 16 Jul 2022 09:42:01 +0200 Subject: [PATCH 276/593] Typo fix in CableEditView --- netbox/dcim/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index b247c3a6d..12e070e70 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2850,7 +2850,7 @@ class CableEditView(generic.ObjectEditView): termination_a = obj.terminations.filter(cable_end='A').first() a_type = termination_a.termination._meta.model if termination_a else None termination_b = obj.terminations.filter(cable_end='B').first() - b_type = termination_b.termination._meta.model if termination_a else None + b_type = termination_b.termination._meta.model if termination_b else None self.form = forms.get_cable_form(a_type, b_type) return obj From 3d475e5afa2bbee182d33d6f9e2b08b42e6fa866 Mon Sep 17 00:00:00 2001 From: Stephen Muth Date: Wed, 13 Jul 2022 19:22:47 -0400 Subject: [PATCH 277/593] Fixes #9634: Respect image URLs which are already fully formed For local storage, URLs will always be relative, but some custom storage backends such as S3 may return absolute ones. --- netbox/dcim/svg.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/svg.py b/netbox/dcim/svg.py index 1de68ec36..4c093a312 100644 --- a/netbox/dcim/svg.py +++ b/netbox/dcim/svg.py @@ -113,8 +113,12 @@ class RackElevationSVG: # Embed front device type image if one exists if self.include_images and device.device_type.front_image: + url = device.device_type.front_image.url + # Convert any relative URLs to absolute + if url.startswith('/'): + url = '{}{}'.format(self.base_url, url) image = drawing.image( - href='{}{}'.format(self.base_url, device.device_type.front_image.url), + href=url, insert=start, size=end, class_='device-image' @@ -139,8 +143,12 @@ class RackElevationSVG: # Embed rear device type image if one exists if self.include_images and device.device_type.rear_image: + url = device.device_type.rear_image.url + # Convert any relative URLs to absolute + if url.startswith('/'): + url = '{}{}'.format(self.base_url, url) image = drawing.image( - href='{}{}'.format(self.base_url, device.device_type.rear_image.url), + href=url, insert=start, size=end, class_='device-image' From 58b191b439462316229fdf3ecc5d3ac0461e3513 Mon Sep 17 00:00:00 2001 From: Marek Zbroch Date: Sun, 17 Jul 2022 09:28:58 +0200 Subject: [PATCH 278/593] Fix CableForm Validation for #9102 --- netbox/dcim/forms/connections.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index 1b393ec6e..62247e3e3 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -160,12 +160,11 @@ def get_cable_form(a_type, b_type): self.initial['a_terminations'] = self.instance.a_terminations self.initial['b_terminations'] = self.instance.b_terminations - def save(self, *args, **kwargs): + def clean(self): + super().clean() # Set the A/B terminations on the Cable instance self.instance.a_terminations = self.cleaned_data['a_terminations'] self.instance.b_terminations = self.cleaned_data['b_terminations'] - return super().save(*args, **kwargs) - return _CableForm From b854cefb57ed3b5073498e3660119d79c6119b97 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Sun, 17 Jul 2022 17:33:47 +0200 Subject: [PATCH 279/593] Revert #9735 & #9696 --- netbox/project-static/dist/netbox.js | Bin 376234 -> 376144 bytes netbox/project-static/dist/netbox.js.map | Bin 345631 -> 345564 bytes .../src/select/api/apiSelect.ts | 6 ------ 3 files changed, 6 deletions(-) diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index c766b8a72357ae532a9e3a1e3c988ac73050d0fc..bc0cabef08f2cab679e475fe18741c4e97ee187e 100644 GIT binary patch delta 25 hcmZ4WTkOIwv4$4L7N!>F7M3lnH-okt2eX!E0RWSD3OxV- delta 70 zcmcccOKjC|v4$4L7N!>F7M3lnH-lJ;b24+MPrSw=G2OqNnUhDUxL7y8AT>`(Q%!BU aV=k*0cV=EeX^CE1esXE?_KQKR^;rP0AsL|n diff --git a/netbox/project-static/dist/netbox.js.map b/netbox/project-static/dist/netbox.js.map index 55474df17cba29ff6f6346049b65baf3886a7ca2..26bb1c514297c61a2e7d50a8863067ed8656e455 100644 GIT binary patch delta 52 zcmbQ=BYLM>w4sHug{g&k3(MheOwK;rIli+5@o^beI8{08_&XX^Y)@fj^<`%=x7@y& Ihc(9%0Px=t4gdfE delta 99 zcmcc9EjqtPw4sHug{g&k3(MheYVIyN-j0smNJOBcW1vo`qhqK}u%lzJPNbu=sq^#) uw^*cD10CHhowgtS#uCKGl~L(b<*eiHm|3}9k(Je#oheUydjSt?jwJw9*dGo6 diff --git a/netbox/project-static/src/select/api/apiSelect.ts b/netbox/project-static/src/select/api/apiSelect.ts index 4ae58d8f4..f5b605d58 100644 --- a/netbox/project-static/src/select/api/apiSelect.ts +++ b/netbox/project-static/src/select/api/apiSelect.ts @@ -411,12 +411,6 @@ export class APISelect { } finally { this.setOptionStyles(); this.enable(); - - // Set the focus to the search field if the select is open - if (this.slim.slim.content.classList.contains("ss-open")) { - this.slim.slim.search.input.focus(); - } - this.base.dispatchEvent(this.loadEvent); } } From 1a028f77d47e522f00e23c49721ba5e13c9b92f5 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 18 Jul 2022 09:16:43 -0400 Subject: [PATCH 280/593] Changelog for #9754 --- 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 ce491e0db..8884a3c91 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -10,7 +10,7 @@ ### Bug Fixes * [#9715](https://github.com/netbox-community/netbox/issues/9715) - Fix `SOCIAL_AUTH_PIPELINE` config parameter not taking effect -* [#9734](https://github.com/netbox-community/netbox/issues/9734) - Fix stealing focus by select fields in forms +* [#9754](https://github.com/netbox-community/netbox/issues/9754) - Fix regression introduced by #9632 * [#9746](https://github.com/netbox-community/netbox/issues/9746) - Permit filtering interfaces by arbitrary speed value in UI --- From 8a2276e79136d8bac7b212ce1ad7f014ffb0de41 Mon Sep 17 00:00:00 2001 From: kkthxbye-code Date: Mon, 18 Jul 2022 16:17:16 +0200 Subject: [PATCH 281/593] Use segment_count for segment count on trace view --- netbox/templates/dcim/cable_trace.html | 72 +++++++++++++------------- 1 file changed, 35 insertions(+), 37 deletions(-) diff --git a/netbox/templates/dcim/cable_trace.html b/netbox/templates/dcim/cable_trace.html index abe13b236..2611686f6 100644 --- a/netbox/templates/dcim/cable_trace.html +++ b/netbox/templates/dcim/cable_trace.html @@ -18,43 +18,41 @@
    - {% with traced_path=path.origin.trace %} - {% if path.is_split %} -

    Path split!

    -

    Select a node below to continue:

    -
      - {% for next_node in path.get_split_nodes %} - {% if next_node.cable %} -
    • - {{ next_node }} - (Cable {{ next_node.cable|linkify }}) -
      • - {% else %} -
    • {{ next_node }}
      • - {% endif %} - {% endfor %} -
    - {% else %} -

    Trace Completed

    - - - - - - - - - -
    Total segments{{ traced_path|length }}
    Total length - {% if total_length %} - {{ total_length|floatformat:"-2" }}{% if not is_definitive %}+{% endif %} Meters / - {{ total_length|meters_to_feet|floatformat:"-2" }} Feet - {% else %} - N/A - {% endif %} -
    - {% endif %} - {% endwith %} + {% if path.is_split %} +

    Path split!

    +

    Select a node below to continue:

    +
      + {% for next_node in path.get_split_nodes %} + {% if next_node.cable %} +
    • + {{ next_node }} + (Cable {{ next_node.cable|linkify }}) +
      • + {% else %} +
    • {{ next_node }}
      • + {% endif %} + {% endfor %} +
    + {% else %} +

    Trace Completed

    + + + + + + + + + +
    Total segments{{ path.segment_count }}
    Total length + {% if total_length %} + {{ total_length|floatformat:"-2" }}{% if not is_definitive %}+{% endif %} Meters / + {{ total_length|meters_to_feet|floatformat:"-2" }} Feet + {% else %} + N/A + {% endif %} +
    + {% endif %}
    {% else %}

    From b8da66bb55e562b7344812bf71a5165031b50cb8 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 18 Jul 2022 11:51:59 -0400 Subject: [PATCH 282/593] Fixes #9733: Handle split paths during trace when fanning out to front ports with differing cables --- docs/release-notes/version-3.3.md | 2 ++ netbox/dcim/models/cables.py | 11 ++++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 5d4a6ccfb..14952c2a5 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -100,6 +100,8 @@ Custom field UI visibility has no impact on API operation. * [#9728](https://github.com/netbox-community/netbox/issues/9728) - Fix validation when assigning a virtual machine to a device * [#9729](https://github.com/netbox-community/netbox/issues/9729) - Fix ordering of content type creation to ensure compatability with demo data +* [#9730](https://github.com/netbox-community/netbox/issues/9730) - Fix validation error when creating a new cable via UI form +* [#9733](https://github.com/netbox-community/netbox/issues/9733) - Handle split paths during trace when fanning out to front ports with differing cables ### Plugins API diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index b35864aa0..e0a489f5b 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -463,6 +463,10 @@ class CablePath(models.Model): """ from circuits.models import CircuitTermination + # Ensure all originating terminations are attached to the same link + if len(terminations) > 1: + assert all(t.link == terminations[0].link for t in terminations[1:]) + path = [] position_stack = [] is_complete = False @@ -474,6 +478,12 @@ class CablePath(models.Model): # Terminations must all be of the same type assert all(isinstance(t, type(terminations[0])) for t in terminations[1:]) + # Check for a split path (e.g. rear port fanning out to multiple front ports with + # different cables attached) + if len(set(t.link for t in terminations)) > 1: + is_split = True + break + # Step 1: Record the near-end termination object(s) path.append([ object_to_path_node(t) for t in terminations @@ -481,7 +491,6 @@ class CablePath(models.Model): # Step 2: Determine the attached link (Cable or WirelessLink), if any link = terminations[0].link - assert all(t.link == link for t in terminations[1:]) if link is None and len(path) == 1: # If this is the start of the path and no link exists, return None return None From 6d53788ea2ad0c946cac8f1ed15be690bf616205 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 18 Jul 2022 13:05:12 -0400 Subject: [PATCH 283/593] Changelog for #9765 --- docs/release-notes/version-3.3.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 14952c2a5..4b3f1dcb2 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -102,6 +102,7 @@ Custom field UI visibility has no impact on API operation. * [#9729](https://github.com/netbox-community/netbox/issues/9729) - Fix ordering of content type creation to ensure compatability with demo data * [#9730](https://github.com/netbox-community/netbox/issues/9730) - Fix validation error when creating a new cable via UI form * [#9733](https://github.com/netbox-community/netbox/issues/9733) - Handle split paths during trace when fanning out to front ports with differing cables +* [#9765](https://github.com/netbox-community/netbox/issues/9765) - Report correct segment count under cable trace UI view ### Plugins API From 0e18292e41f6feb77094ee0a9cd8c965071a5dd9 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 18 Jul 2022 13:09:45 -0400 Subject: [PATCH 284/593] Add summary release notes for v3.3 --- docs/release-notes/index.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md index f8bb365be..8a6a86174 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/index.md @@ -10,6 +10,17 @@ Minor releases are published in April, August, and December of each calendar yea This page contains a history of all major and minor releases since NetBox v2.0. For more detail on a specific patch release, please see the release notes page for that specific minor release. +#### [Version 3.3](./version-3.3.md) (August 2022) + +* Multi-object Cable Terminations ([#9102](https://github.com/netbox-community/netbox/issues/9102)) +* L2VPN Modeling ([#8157](https://github.com/netbox-community/netbox/issues/8157)) +* PoE Interface Attributes ([#1099](https://github.com/netbox-community/netbox/issues/1099)) +* Half-Height Rack Units ([#51](https://github.com/netbox-community/netbox/issues/51)) +* Restrict API Tokens by Client IP ([#8233](https://github.com/netbox-community/netbox/issues/8233)) +* Reference User in Permission Constraints ([#9074](https://github.com/netbox-community/netbox/issues/9074)) +* Custom Field Grouping ([#8495](https://github.com/netbox-community/netbox/issues/8495)) +* Toggle Custom Field Visibility ([#9166](https://github.com/netbox-community/netbox/issues/9166)) + #### [Version 3.2](./version-3.2.md) (April 2022) * Plugins Framework Extensions ([#8333](https://github.com/netbox-community/netbox/issues/8333)) From a7a20ad2eacec59652933dfe0ecf6c80b761114c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 19 Jul 2022 12:53:57 -0400 Subject: [PATCH 285/593] Fixes #9775: Fix exception when viewing a report with no descripton --- docs/release-notes/version-3.2.md | 2 ++ netbox/utilities/templatetags/builtins/filters.py | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 8884a3c91..40aee82ad 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -9,9 +9,11 @@ ### Bug Fixes +* [#9634](https://github.com/netbox-community/netbox/issues/9634) - Fix image URLs in rack elevations when using external storage * [#9715](https://github.com/netbox-community/netbox/issues/9715) - Fix `SOCIAL_AUTH_PIPELINE` config parameter not taking effect * [#9754](https://github.com/netbox-community/netbox/issues/9754) - Fix regression introduced by #9632 * [#9746](https://github.com/netbox-community/netbox/issues/9746) - Permit filtering interfaces by arbitrary speed value in UI +* [#9775](https://github.com/netbox-community/netbox/issues/9775) - Fix exception when viewing a report with no description --- diff --git a/netbox/utilities/templatetags/builtins/filters.py b/netbox/utilities/templatetags/builtins/filters.py index 738dc0e00..5a6841286 100644 --- a/netbox/utilities/templatetags/builtins/filters.py +++ b/netbox/utilities/templatetags/builtins/filters.py @@ -144,6 +144,8 @@ def render_markdown(value): {{ md_source_text|markdown }} """ + if not value: + return '' # Render Markdown html = markdown(value, extensions=['def_list', 'fenced_code', 'tables', StrikethroughExtension()]) From 802d9d2b6ec178fbae7bfee1947af3af0589e538 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 19 Jul 2022 13:01:51 -0400 Subject: [PATCH 286/593] Fixes #9749: Retain original slug values when modifying object names --- docs/release-notes/version-3.2.md | 1 + netbox/project-static/dist/netbox.js | Bin 376144 -> 376156 bytes netbox/project-static/dist/netbox.js.map | Bin 345564 -> 345579 bytes netbox/project-static/src/buttons/reslug.ts | 4 +++- 4 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 40aee82ad..6718fc247 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -13,6 +13,7 @@ * [#9715](https://github.com/netbox-community/netbox/issues/9715) - Fix `SOCIAL_AUTH_PIPELINE` config parameter not taking effect * [#9754](https://github.com/netbox-community/netbox/issues/9754) - Fix regression introduced by #9632 * [#9746](https://github.com/netbox-community/netbox/issues/9746) - Permit filtering interfaces by arbitrary speed value in UI +* [#9749](https://github.com/netbox-community/netbox/issues/9749) - Retain original slug values when modifying object names * [#9775](https://github.com/netbox-community/netbox/issues/9775) - Fix exception when viewing a report with no description --- diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index bc0cabef08f2cab679e475fe18741c4e97ee187e..3b9d253c910687cab913fa4410ebf02d56259832 100644 GIT binary patch delta 53 zcmcccOYF`sv4$4L7N!>F7M3lnagEY7H5w&(dS!_@rKz@Mt{O#9woYQ6=Jwo1*2mTW DLZ}p; delta 37 tcmccfOYFigv4$4L7N!>F7M3lnagEb68(9SyYp2JrW|iAMvyt_%H2^BW4yynF diff --git a/netbox/project-static/dist/netbox.js.map b/netbox/project-static/dist/netbox.js.map index 26bb1c514297c61a2e7d50a8863067ed8656e455..5a78b64f1000be47875ef11fdecfa3e13886291a 100644 GIT binary patch delta 60 zcmcc9E&94!w4sHug{g(Pg=GtCwyc1oqocQuyQ5>Mj=!UGl8)!}99dQgR)0tLESKq> QvaA-2McWU_vPx+H07u{vvH$=8 delta 52 zcmaFeEqbS0w4sHug{g(Pg=GtCw(Rt+vaC{^j;{L7I_{2+;nM|OSVgCAl4X@+%-enu HD5U`a$}|t6 diff --git a/netbox/project-static/src/buttons/reslug.ts b/netbox/project-static/src/buttons/reslug.ts index 2549bf112..f445854c1 100644 --- a/netbox/project-static/src/buttons/reslug.ts +++ b/netbox/project-static/src/buttons/reslug.ts @@ -38,7 +38,9 @@ export function initReslug(): void { slugLength = Number(slugLengthAttr); } sourceField.addEventListener('blur', () => { - slugField.value = slugify(sourceField.value, slugLength); + if (!slugField.value) { + slugField.value = slugify(sourceField.value, slugLength); + } }); slugButton.addEventListener('click', () => { slugField.value = slugify(sourceField.value, slugLength); From 44586743ea410e9df11d88ca3580ccc08a71bd17 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 19 Jul 2022 14:21:20 -0400 Subject: [PATCH 287/593] Fixes #9437: Standardize form submission buttons and behavior when using enter key --- docs/release-notes/version-3.2.md | 1 + netbox/project-static/dist/netbox.js | Bin 376156 -> 375907 bytes netbox/project-static/dist/netbox.js.map | Bin 345579 -> 345348 bytes netbox/project-static/src/forms/elements.ts | 40 +--------------- .../circuits/circuittermination_edit.html | 14 ------ netbox/templates/dcim/interface_edit.html | 11 ----- netbox/templates/generic/bulk_delete.html | 2 +- netbox/templates/generic/bulk_edit.html | 2 +- netbox/templates/generic/bulk_import.html | 12 ++--- netbox/templates/generic/bulk_remove.html | 2 +- netbox/templates/generic/bulk_rename.html | 2 +- .../templates/generic/confirmation_form.html | 45 +++++++----------- netbox/templates/generic/object_edit.html | 8 ++-- netbox/templates/generic/object_import.html | 30 ++++++------ .../virtualization/vminterface_edit.html | 11 ----- 15 files changed, 49 insertions(+), 131 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 6718fc247..7b9adb374 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -9,6 +9,7 @@ ### Bug Fixes +* [#9437](https://github.com/netbox-community/netbox/issues/9437) - Standardize form submission buttons and behavior when using enter key * [#9634](https://github.com/netbox-community/netbox/issues/9634) - Fix image URLs in rack elevations when using external storage * [#9715](https://github.com/netbox-community/netbox/issues/9715) - Fix `SOCIAL_AUTH_PIPELINE` config parameter not taking effect * [#9754](https://github.com/netbox-community/netbox/issues/9754) - Fix regression introduced by #9632 diff --git a/netbox/project-static/dist/netbox.js b/netbox/project-static/dist/netbox.js index 3b9d253c910687cab913fa4410ebf02d56259832..9ea2e5c7c51459ff2a2b51720f271929a0119eb8 100644 GIT binary patch delta 3383 zcmb7GdstOf7XQ|{dz(sF#zRR(K*W3F=twe-f!E}ra+UW(c}ViQyzb>(4qQOEV4{+s z@^T9sfv|jKIzIT0cqq#fXTGT{r>6OQKT54E&9te$a>l+{2elgGpZVi{zrFT)?e*Jh z?Q_rHali7T`+>DpF0y1?tdEt%aLFLfmyFSNz05kRu7IqpaJ=CL7A3fKB0wxl+n4~+ z%KnXW0SehI<^Y*lH)TKs`(V=mgtC^lVwlgMJ<-XxP+XL6FwSu-%4Y#R6Ie}qC{(ex z+xNl}ChvsQYwIrU4FR?N?Gz&2ARr@t!)6= z%Bt;M0J+R_Cx;w%Xy+ctXIZbsOzHC}m8)3}9jnuVo;uU%f^(T5r9cji1H{B4-s%Z% z%=O4>S{NY4+!uR~aEMS$Z@CM|amLX~@MUL@o<%AZX_3R0Bmf63Az zpX_gkVF8PIXA;s``c4llRGxU(05mQ@l=22sC`s?tfsh)&&L7`L&9Z2_x6QV{e+e00 z^FbR(%9AJJfR@N&)_s?{zc&(EAd3n2W$~Xkf!bs-@xB~*vP*zW_TgzOSQX=$TBM)7 zb+!uG4?4$?{S)W9Az!ha9}7tTnhRHu`233wK*q0LvO%Si_{mH_%GZBdj+6_Rcj%Dv zU7vM81q=Cn6D(&ZKYs@j*_JQ<1u+V{HeZMIpS|9U^cUV(iS)DUUk^aIvhQXBB~h{% z!g_DIE91UCaJVKV{;AVBT%pV^KlhwBY1VG&^Czyhe;RM^%CLNp;AX+UP2LDHr z-VsA2Q85Yj)r0sd#@{MHys8@o&7&YiW#eHtz#=}!6QW_E+UN-v@Jb`N)eAO(nS(d% z1-rW68$PB`pst<*=LN9wjHjR+O4UN68bwHRCcdGfiGLab?%eZL@(3Sa4}R*U zXJGj-kk#b5nx)K-guq0oQZI(Uw*X7jkHVmLI9VJj#{aLQUOgTO>5rg;ArZ3Be?ubZ zN0X#bu~0LNc80uH992wyuP{^3XAGtJZOj$m}d5i|NcDAdQ#PhTeC`SR`v*S{SuRT<+; z^zr%Jc2no3+P>Be0OYGrf1``U2U&gow(d!14Ac3uE()Vw`&swp*x?nSnoD`E=Hjk? zGluNK3V4SnnT&8`5Y(%lWPCD2s8B(?hx71i^0@ks=gB;9&BSYV)IunO3V$Q20YSpP(@HRwEe!u2HD@T{+IpWU0Gp2#uuY-sf~K zd}A|tn*Y>9T(Gv&&BRV|IHTG~HkR1iMiNFwYrca7@!Jbw0{3qxcU|L$2&m5Hgo2OB zBw9>jlu3*=iSZ^e+LUgvOZwk5ccGfyLBfFRxt5c^zL``)ArI^%et2bRo#Z7U!o-_4 zgC9@pAtU+JE`om-cvTk(f>7SqMS5U9PwXZe!Iyv0P1Zscx4lSeVF|zeB6%5-IO`#? z5UO77A)dp~boLH1k^Af*9%zs2IcV?LK{C<)!VZ#vkpp%TJtV2AJIM-w6n^FvvJQ`x zvx^uXTV&E>4?Gyc6ntzAtw2bnQctCk4yW?D^6(t69pk=cC~7Zzz(C z^QAOdtshO>Jf=M`4Ij$XQJz`ih2I&?UP=#6l=#ac9iwLX(^ntSp(oF@3r}+W463zs z^b8t@@X`$Gg)?w;20h^nHnk;$jwFa(^XT_e@E%)>=vwSi)x$4!V)@)C)ZFP zezKa{A)7C%p_kES+6ubFDMHd`O!9S@rJ4*LQcFC?>GA)M)uNZQDSCLy-d#ace&<0o zk8Cyed0HYs89!D_12A~wTI#_^t)hW^VGX7~x0<@DIjd*^Kn_2#njS-wjcaJMORmKb z{2-0_{xGAjANQ!kvdZ|ZIvR#9)pc|wt^Po=%4>ezBfD4V8R!15HBDyapNwdAz%U zPH-vu&7treAADinZ=eU!tacskADd+nD=p~;v!pfJuOEPUJZ?ShfMps?;?5iB6-;(} z1MP85unaNe+Zt&Q%;Ogu>2#N6zsWfGrllot?6))q`j5)LW~-*k;Z5}*3m|1xKuoR9(-djw$W)W%ZE@* zY^MSIcpH5Jy|dftObpi9PQP=)!#8iG)dJ$9J7_(2tlGAl{#(P=1GGWFr+1t}4d{ie zy75$n&c-!YXc=mp58@@=*CZUI5xDL?hyxPBef#L2P+HnYqY?J>(W$t3rjITi8L5%< U%d0n*FF8abAyVCbi1rWrFTc>I(f|Me delta 3660 zcmb7GdsI}_8eiX;y$y9~88}iZ!Kg5!M-(!zNn`R5W|Wsa6eW@YhSxBAoZ$>Aqa{89 z1w}pJ1|-b4>GeSeI+W#uZtM2AnXT^9@|};arCC2G1?S;kZ*#xau^&&sw0`>*)oA_U?Hr^v`Ou#Q>W&aI zoP2!{43+~9FQ=9WG3D;E{V<1k#d<_9Aji4K7Qt-!^s&>(XJ>aV%#ro)eT;NodM^nQ zl<|Mb(;=VoUk|}_Ipu>9NN4#6Z7^4P{6iB^yIW*MJuZ~Yk5+;px#hDT@2AWyy6$Yt z+y8a}8D8;8Ba|pl9-j%+3uZ~n(m5Ut49;&n*>>Ff1Kf9Z{-NWXmjyKb;5 z`){UG;&6-6a{EoaGW6$HC`omTj-J(_e?3beP5I~Vn+34&etlsA!t;G$&J)-Macpb> z(|Q0u3YnP6%yu@`!k+^ek5W#6QGG3J3T`f5Y~hdfgHh^H00G;9PwEe02)X@Xo4Qs9 zX9Or!OZ&k8;iSE9FHTf+f^~JzzKZs@3gA|C1EGE(B&hN**aMKorvyPV%vIL}!8yFr z7+w|(4Zt{rz&`M(2SVU;3gznZFgPoKjpvSr3Mf-gjRre_S2c@}J%G%P5v}~IXwdW4 zXJC^0?X%$Q0~R%FswQONhoj*sn5CYNh93bk)z4y~-H*(P5z~5f)Ye3(dj!Qy8IXrs zbs1nBL}tW@rP^^S|1c3mbwVM$`xvz_lh305QUP=jNr(~McYP+pI5n;Y&i2Q!LmI$; zz;tU=p_k=LB`y{`U5##lS^y8ns@wo2YVJmO8s`LW;IIki^6^cu4rZ#ynqV#9GPMN; zgG()JfdHHg+_wpSnQV8MlNK3GqU12AX&ArA?ADMu%rP2z9A=4`r{JHNdCSV~`z}%U zw!%mq+B>ls_Ui<@gD>3%v4Z5_?{7mg%GIvzFj2ts?{~ry9meR~1K}8B>mK+)z~eRh zU;qG9H|+=2Kh(mEX-rIHrX_!5_s5pcW0$-h7Hnbi)Z>ACT{nzDF5l?}F$(dU-(jrA z?T}odD+j4Q@vbl_z`{g33(vPR$?i!hEG)N6W{W!Puux7=VqLe8h;Xi3=tMpFJz-S< zE{A_1m~ff!g`n3i_{H-=y>`JjF9=!M_C=wqFIe9ERv4r0ir0k@gyic&r{2P{Q&^5T zw+BpOafvyWJ#XPp+z_zz)#w|-cl{B^-4?EDnuC86%!9F~%!Yf38bU*jUWV}%{U%)h z(XXV^oaQm66?4~3-C))Aovs_esYZUUOT-DRzI;pf|rPzUhd6vmPkgEY03S2PqFgo#l&BYe3?uG zQ>@i!@}WVa7O=#EU4_AJW;CF0$;GnoJI~=u8)+a-U!MKWi$>VEDJ}+2Jp5s?* z$xcY(TUL`&-d;;4fK~h6!E5V~`#9cSM~2`r!eD;Bj`Z=jqW`EokKN{o%D0u<4Ti~y z>aTUAF9bMx$&&}HB`@exdpTi79&$$K&zskh$bjTt1k?*_i9{idXEcy}%%ZD-qzk21 zKBbcet799900Hja)M7Uh3Wijxm~0gtRx!;gx~*cVHOC~e2br^|rJTeH3Gr6Gwi!bC=oT^y=J2W(G8snlcUnjrRPyXiWCP6RH#d=Ln8hnv zNfl)B+pS~^%-}7rl2jO}UVoJY^+C~o+sPypMR5e{>pZej+Q6wAV!#> z+IEna0227con$q{bH^@Xel*K!#2UCaOcJ=dix?nFJ-v&pFCK{cVHB+sicoW zK5wd|&A1imqj9)e;G+}4%lG@}Hg2s#YlnQ)z^fKh1!bODLT4kaSwh7jUWbuso%B#k z@)JwwoVzkmsLpSfu2vFhCP30mYDAaHiEzX3Qa;2e${mDpbCfCkXTYwECnaI3hV|kkC#`| zsj!H5RMYV=jbE*%kuZ-3*3e80nbpt<5qXZu+6!qm6xcitZJv8rcnM>6PlkP=WUhE1 zA$-QP3C2IKp&h7Qvx;^FPIHL!962UC)9Um7bV}#9R?`vOx0-rkfr{UK0E4()OWOh# zI{tTX@jZ2PGNkjXb#%P{f(Kmo49)C?+_(m5a;rbBp;-`+(VK;N^)yPK;^=9Uhi-r$ ztfw)LXp?tDNde!tj%E&v?N#uu#L;>r$*pMx^3HWwY0+xRdYYn@=H>?aG@so_ANT7q zXDcY+;~Qz1f6Bu#BTb==G{Qf&mxIzqtk-CDOC$ZcKPI(t3tg=J0QBEZYp~wc*4OF3 zHEcRSR|$~F4R25rx=wt9&O~T?11U}90Sexyn@>|{4#GACJ1dTl>7aias0Ef?ym0KD zr;)cSbU0trK}Tv4+p+qYT$K_azc!^`-*meqm0^*@@rxbw1)TNfPU?gtb#Eu_>hoW! C?*+2} diff --git a/netbox/project-static/dist/netbox.js.map b/netbox/project-static/dist/netbox.js.map index 5a78b64f1000be47875ef11fdecfa3e13886291a..60656bc6d6f3450acca6ca6d4369da29b4749527 100644 GIT binary patch delta 49 zcmaFeE!xs0+R(z-!qmdNg(cOOr64uKdApz=iy|Xau*dW~f0k-CU*|GsbJy)({8_$# F1pt|^5fA_X delta 281 zcmXw!F^j@L5QS0G$(8;9Yez&l5y9ro=t)>|i^Lc$#Rvu>h+ZQWTBN$O_m2qvC~LXa zOoGkwcHev7&ZNJ!$6xK7meO)sxj8HEw2Rh4b6_Jh0uD?9X%AF;>hhgz0|i;<$g*&t7tG(M4-I})1DzozJjHgftYEmEEj%{ua|G - * Save & Continue - * - * ``` - * - * @param event Click event. - */ -function handleSubmitWithReturnUrl(event: MouseEvent): void { - const element = event.target as HTMLElement; - if (element.tagName === 'BUTTON') { - const button = element as HTMLButtonElement; - const action = button.getAttribute('return-url'); - const form = button.form; - if (form !== null && isTruthy(action)) { - form.action = action; - form.submit(); - } - } -} +import { getElements, scrollTo } from '../util'; function handleFormSubmit(event: Event, form: HTMLFormElement): void { // Track the names of each invalid field. @@ -57,15 +29,6 @@ function handleFormSubmit(event: Event, form: HTMLFormElement): void { } } -/** - * Attach event listeners to form buttons with the `return-url` attribute present. - */ -function initReturnUrlSubmitButtons(): void { - for (const button of getElements('button[return-url]')) { - button.addEventListener('click', handleSubmitWithReturnUrl); - } -} - /** * Attach an event listener to each form's submitter (button[type=submit]). When called, the * callback checks the validity of each form field and adds the appropriate Bootstrap CSS class @@ -82,5 +45,4 @@ export function initFormElements(): void { submitter.addEventListener('click', (event: Event) => handleFormSubmit(event, form)); } } - initReturnUrlSubmitButtons(); } diff --git a/netbox/templates/circuits/circuittermination_edit.html b/netbox/templates/circuits/circuittermination_edit.html index f8393f945..8919bbd66 100644 --- a/netbox/templates/circuits/circuittermination_edit.html +++ b/netbox/templates/circuits/circuittermination_edit.html @@ -48,17 +48,3 @@ {% render_field form.description %}

    {% endblock %} - -{# Override buttons block, 'Create & Add Another'/'_addanother' is not needed on a circuit. #} -{% block buttons %} - Cancel - {% if object.pk %} - - {% else %} - - {% endif %} -{% endblock buttons %} diff --git a/netbox/templates/dcim/interface_edit.html b/netbox/templates/dcim/interface_edit.html index ddda1ae31..62aa54ef3 100644 --- a/netbox/templates/dcim/interface_edit.html +++ b/netbox/templates/dcim/interface_edit.html @@ -91,14 +91,3 @@
    {% endif %} {% endblock %} - -{% block buttons %} - Cancel - {% if object.pk %} - - - {% else %} - - - {% endif %} -{% endblock %} diff --git a/netbox/templates/generic/bulk_delete.html b/netbox/templates/generic/bulk_delete.html index 1bcc2db1d..edc5132ce 100644 --- a/netbox/templates/generic/bulk_delete.html +++ b/netbox/templates/generic/bulk_delete.html @@ -36,8 +36,8 @@ Context: {{ field }} {% endfor %}
    - Cancel + Cancel
    diff --git a/netbox/templates/generic/bulk_edit.html b/netbox/templates/generic/bulk_edit.html index 362644135..cea50eaff 100644 --- a/netbox/templates/generic/bulk_edit.html +++ b/netbox/templates/generic/bulk_edit.html @@ -118,8 +118,8 @@ Context:
    - Cancel + Cancel
    diff --git a/netbox/templates/generic/bulk_import.html b/netbox/templates/generic/bulk_import.html index 1a85c3a21..1d638cb2c 100644 --- a/netbox/templates/generic/bulk_import.html +++ b/netbox/templates/generic/bulk_import.html @@ -44,12 +44,12 @@ Context:
    -
    - {% if return_url %} - Cancel - {% endif %} - -
    +
    + + {% if return_url %} + Cancel + {% endif %} +
    {% if fields %} diff --git a/netbox/templates/generic/bulk_remove.html b/netbox/templates/generic/bulk_remove.html index 0bda6adbc..6dc102b5a 100644 --- a/netbox/templates/generic/bulk_remove.html +++ b/netbox/templates/generic/bulk_remove.html @@ -23,8 +23,8 @@ {{ field }} {% endfor %}
    - Cancel + Cancel
    diff --git a/netbox/templates/generic/bulk_rename.html b/netbox/templates/generic/bulk_rename.html index 134d3df5a..ef6b18cae 100644 --- a/netbox/templates/generic/bulk_rename.html +++ b/netbox/templates/generic/bulk_rename.html @@ -34,11 +34,11 @@
    - Cancel {% if '_preview' in request.POST and not form.errors %} {% endif %} + Cancel
    diff --git a/netbox/templates/generic/confirmation_form.html b/netbox/templates/generic/confirmation_form.html index c4c15f7e7..e9d3d01aa 100644 --- a/netbox/templates/generic/confirmation_form.html +++ b/netbox/templates/generic/confirmation_form.html @@ -2,33 +2,24 @@ {% load form_helpers %} {% block content %} -
    - -
    - -
    - {% csrf_token %} - {% for field in form.hidden_fields %} - {{ field }} - {% endfor %} - -
    -
    {% block confirmation_title %}{% endblock %}
    - -
    - {% block message %}

    Are you sure?

    {% endblock %} -
    - -
    - Cancel - -
    - -
    - -
    - +
    +
    +
    + {% csrf_token %} + {% for field in form.hidden_fields %} + {{ field }} + {% endfor %} +
    +
    {% block confirmation_title %}{% endblock %}
    +
    + {% block message %}

    Are you sure?

    {% endblock %} +
    +
    + + Cancel +
    - +
    +
    {% endblock %} diff --git a/netbox/templates/generic/object_edit.html b/netbox/templates/generic/object_edit.html index 06308e9ef..892c7d2b1 100644 --- a/netbox/templates/generic/object_edit.html +++ b/netbox/templates/generic/object_edit.html @@ -94,19 +94,19 @@ Context:
    {% block buttons %} - Cancel {% if object.pk %} {% else %} - + {% endif %} + Cancel {% endblock buttons %}
    diff --git a/netbox/templates/generic/object_import.html b/netbox/templates/generic/object_import.html index ffa16b4c2..4d54fde61 100644 --- a/netbox/templates/generic/object_import.html +++ b/netbox/templates/generic/object_import.html @@ -5,19 +5,19 @@ {% block title %}{{ obj_type|bettertitle }} Import{% endblock %} {% block content %} -
    -
    -
    - {% csrf_token %} - {% render_form form %} -
    - {% if return_url %} - Cancel - {% endif %} - - -
    -
    -
    -
    +
    +
    +
    + {% csrf_token %} + {% render_form form %} +
    + + + {% if return_url %} + Cancel + {% endif %} +
    +
    +
    +
    {% endblock content %} diff --git a/netbox/templates/virtualization/vminterface_edit.html b/netbox/templates/virtualization/vminterface_edit.html index 496960a64..316900865 100644 --- a/netbox/templates/virtualization/vminterface_edit.html +++ b/netbox/templates/virtualization/vminterface_edit.html @@ -55,14 +55,3 @@
    {% endif %} {% endblock %} - -{% block buttons %} - Cancel - {% if object.pk %} - - - {% else %} - - - {% endif %} -{% endblock %} From 1c9db2d9f8dffd3ac1f2f28564e054ca73d54e78 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 19 Jul 2022 16:21:32 -0400 Subject: [PATCH 288/593] Fixes #9499: Fix filtered bulk deletion of VM Interfaces --- docs/release-notes/version-3.2.md | 1 + netbox/virtualization/views.py | 2 ++ 2 files changed, 3 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 7b9adb374..806b0fa91 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -10,6 +10,7 @@ ### Bug Fixes * [#9437](https://github.com/netbox-community/netbox/issues/9437) - Standardize form submission buttons and behavior when using enter key +* [#9499](https://github.com/netbox-community/netbox/issues/9499) - Fix filtered bulk deletion of VM Interfaces * [#9634](https://github.com/netbox-community/netbox/issues/9634) - Fix image URLs in rack elevations when using external storage * [#9715](https://github.com/netbox-community/netbox/issues/9715) - Fix `SOCIAL_AUTH_PIPELINE` config parameter not taking effect * [#9754](https://github.com/netbox-community/netbox/issues/9754) - Fix regression introduced by #9632 diff --git a/netbox/virtualization/views.py b/netbox/virtualization/views.py index 0b593289b..4cd7da30d 100644 --- a/netbox/virtualization/views.py +++ b/netbox/virtualization/views.py @@ -471,6 +471,7 @@ class VMInterfaceBulkImportView(generic.BulkImportView): class VMInterfaceBulkEditView(generic.BulkEditView): queryset = VMInterface.objects.all() + filterset = filtersets.VMInterfaceFilterSet table = tables.VMInterfaceTable form = forms.VMInterfaceBulkEditForm @@ -482,6 +483,7 @@ class VMInterfaceBulkRenameView(generic.BulkRenameView): class VMInterfaceBulkDeleteView(generic.BulkDeleteView): queryset = VMInterface.objects.all() + filterset = filtersets.VMInterfaceFilterSet table = tables.VMInterfaceTable From e92b7f8bb95ebf2018a0d57dad2fe88a69cecc85 Mon Sep 17 00:00:00 2001 From: Marek Zbroch Date: Wed, 20 Jul 2022 13:02:10 +0200 Subject: [PATCH 289/593] Typo fix in REARPORT_BUTTONS template code --- netbox/dcim/tables/template_code.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index 90befe0a4..082df56df 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -343,7 +343,7 @@ REARPORT_BUTTONS = """
  • Console Port
  • Front Port
  • Rear Port
    • -
  • Circuit Termination
    • +
  • Circuit Termination
    • {% else %} From 17e00ac0402a10fd823dc7f223b4db6b1c4ef9e1 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 20 Jul 2022 10:39:36 -0400 Subject: [PATCH 290/593] Fixes #9705: Support filter expressions for the serial field on racks, devices, and inventory items --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/filtersets.py | 9 ++++++--- netbox/dcim/tests/test_filtersets.py | 20 +++++++++++--------- netbox/netbox/filtersets.py | 2 +- 4 files changed, 19 insertions(+), 13 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 806b0fa91..1e422547e 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -4,6 +4,7 @@ ### Enhancements +* [#9705](https://github.com/netbox-community/netbox/issues/9705) - Support filter expressions for the `serial` field on racks, devices, and inventory items * [#9741](https://github.com/netbox-community/netbox/issues/9741) - Check for UserConfig instance during user login * [#9745](https://github.com/netbox-community/netbox/issues/9745) - Add wireless LANs and links to global search diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index 4b4201578..f5342106e 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -307,7 +307,7 @@ class RackFilterSet(NetBoxModelFilterSet, TenancyFilterSet, ContactModelFilterSe to_field_name='slug', label='Role (slug)', ) - serial = django_filters.CharFilter( + serial = MultiValueCharFilter( lookup_expr='iexact' ) @@ -1002,10 +1002,13 @@ class ModuleFilterSet(NetBoxModelFilterSet): queryset=Device.objects.all(), label='Device (ID)', ) + serial = MultiValueCharFilter( + lookup_expr='iexact' + ) class Meta: model = Module - fields = ['id', 'serial', 'asset_tag'] + fields = ['id', 'asset_tag'] def search(self, queryset, name, value): if not value.strip(): @@ -1400,7 +1403,7 @@ class InventoryItemFilterSet(DeviceComponentFilterSet, NetBoxModelFilterSet): ) component_type = ContentTypeFilter() component_id = MultiValueNumberFilter() - serial = django_filters.CharFilter( + serial = MultiValueCharFilter( lookup_expr='iexact' ) diff --git a/netbox/dcim/tests/test_filtersets.py b/netbox/dcim/tests/test_filtersets.py index 47aa9368c..cf0f397df 100644 --- a/netbox/dcim/tests/test_filtersets.py +++ b/netbox/dcim/tests/test_filtersets.py @@ -494,10 +494,10 @@ class RackTestCase(TestCase, ChangeLoggedFilterSetTests): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_serial(self): - params = {'serial': 'ABC'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) - params = {'serial': 'abc'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) + params = {'serial': ['ABC', 'DEF']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'serial': ['abc', 'def']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_tenant(self): tenants = Tenant.objects.all()[:2] @@ -1860,7 +1860,9 @@ class ModuleTestCase(TestCase, ChangeLoggedFilterSetTests): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 6) def test_serial(self): - params = {'asset_tag': ['A', 'B']} + params = {'serial': ['A', 'B']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'serial': ['a', 'b']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_asset_tag(self): @@ -3413,10 +3415,10 @@ class InventoryItemTestCase(TestCase, ChangeLoggedFilterSetTests): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_serial(self): - params = {'serial': 'ABC'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) - params = {'serial': 'abc'} - self.assertEqual(self.filterset(params, self.queryset).qs.count(), 1) + params = {'serial': ['ABC', 'DEF']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + params = {'serial': ['abc', 'def']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_component_type(self): params = {'component_type': 'dcim.interface'} diff --git a/netbox/netbox/filtersets.py b/netbox/netbox/filtersets.py index 1a72d8159..f509afa5b 100644 --- a/netbox/netbox/filtersets.py +++ b/netbox/netbox/filtersets.py @@ -125,7 +125,7 @@ class BaseFilterSet(django_filters.FilterSet): return {} # Skip nonstandard lookup expressions - if existing_filter.method is not None or existing_filter.lookup_expr not in ['exact', 'in']: + if existing_filter.method is not None or existing_filter.lookup_expr not in ['exact', 'iexact', 'in']: return {} # Choose the lookup expression map based on the filter type From 9835d6b2dfd05d4ba1eb4d39dd6e6828948239db Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 20 Jul 2022 10:57:11 -0400 Subject: [PATCH 291/593] Release NetBox v3.2.7 --- .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 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 78231890b..332a0ad75 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.6 + placeholder: v3.2.7 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 71d45092c..ff9b5e358 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.6 + placeholder: v3.2.7 validations: required: true - type: dropdown diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 1e422547e..35e9b9a22 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.7 (FUTURE) +## v3.2.7 (2022-07-20) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index b17d70e31..094771581 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.7-dev' +VERSION = '3.2.7' # Hostname HOSTNAME = platform.node() From 383918d83ba039e0e1217afa353312d972c181c3 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 20 Jul 2022 11:15:02 -0400 Subject: [PATCH 292/593] 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 35e9b9a22..c36344912 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.8 (FUTURE) + +--- + ## v3.2.7 (2022-07-20) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 094771581..c7e49c1be 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.7' +VERSION = '3.2.8-dev' # Hostname HOSTNAME = platform.node() From e2580ea469e0394d7e00a65d91aca51968a97ad1 Mon Sep 17 00:00:00 2001 From: Juho Ylikorpi Date: Thu, 21 Jul 2022 16:54:23 +0300 Subject: [PATCH 293/593] fixes #9818 --- netbox/dcim/forms/connections.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index 62247e3e3..7552c0c87 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -138,7 +138,7 @@ def get_cable_form(a_type, b_type): label='Side', disabled_indicator='_occupied', query_params={ - 'circuit_id': f'termination_{cable_end}_circuit', + 'circuit_id': f'$termination_{cable_end}_circuit', } ) From 451a0067c70f13741cb52e5b9ee3dad5cb1d9d58 Mon Sep 17 00:00:00 2001 From: Gabor SOMOGYVARI Date: Fri, 22 Jul 2022 10:42:20 +0200 Subject: [PATCH 294/593] Closes #9825: Add Contacts to VM table view --- netbox/virtualization/tables/virtualmachines.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/netbox/virtualization/tables/virtualmachines.py b/netbox/virtualization/tables/virtualmachines.py index 8cff96227..d2be07876 100644 --- a/netbox/virtualization/tables/virtualmachines.py +++ b/netbox/virtualization/tables/virtualmachines.py @@ -48,6 +48,9 @@ class VirtualMachineTable(TenancyColumnsMixin, NetBoxTable): order_by=('primary_ip4', 'primary_ip6'), verbose_name='IP Address' ) + contacts = columns.ManyToManyColumn( + linkify_item=True + ) tags = columns.TagColumn( url_name='virtualization:virtualmachine_list' ) @@ -56,7 +59,7 @@ class VirtualMachineTable(TenancyColumnsMixin, NetBoxTable): model = VirtualMachine fields = ( 'pk', 'id', 'name', 'status', 'cluster', 'role', 'tenant', 'tenant_group', 'platform', 'vcpus', 'memory', 'disk', - 'primary_ip4', 'primary_ip6', 'primary_ip', 'comments', 'tags', 'created', 'last_updated', + 'primary_ip4', 'primary_ip6', 'primary_ip', 'comments', 'contacts', 'tags', 'created', 'last_updated', ) default_columns = ( 'pk', 'name', 'status', 'cluster', 'role', 'tenant', 'vcpus', 'memory', 'disk', 'primary_ip', From 7d6882bec29f2ffe70a278cee99f0abc9216d498 Mon Sep 17 00:00:00 2001 From: Renato Almeida de Oliveira Date: Sat, 23 Jul 2022 20:24:33 +0000 Subject: [PATCH 295/593] Change display to Modal --- netbox/templates/ipam/prefix.html | 84 +++++++++++++++++++++---------- 1 file changed, 58 insertions(+), 26 deletions(-) diff --git a/netbox/templates/ipam/prefix.html b/netbox/templates/ipam/prefix.html index caad547c4..ed2c3339b 100644 --- a/netbox/templates/ipam/prefix.html +++ b/netbox/templates/ipam/prefix.html @@ -143,34 +143,16 @@ {% endwith %} - {% if object.prefix.version == 4 %} - - - Network Mask - - - {{ object.prefix.netmask }} - - - - - Broadcast Address - - - {{ object.prefix.broadcast }} - - - - - Wildcard Mask - - - {{ object.prefix.hostmask }} - - - {% endif %}
    + {% if object.prefix.version == 4 %} +
    + + + Details + +
    + {% endif %} {% include 'inc/panels/custom_fields.html' %} {% include 'inc/panels/tags.html' %} @@ -186,4 +168,54 @@ {% plugin_full_width_page object %} +{% if object.prefix.version == 4 %} + +{% endif %} {% endblock %} From 12476036cd3dc5990d2a6c9973ed9ccc758c377d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 25 Jul 2022 09:55:20 -0400 Subject: [PATCH 296/593] Changelog for #9794, #9818 --- docs/release-notes/version-3.3.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 4b3f1dcb2..ad9ce1a0e 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -103,6 +103,8 @@ Custom field UI visibility has no impact on API operation. * [#9730](https://github.com/netbox-community/netbox/issues/9730) - Fix validation error when creating a new cable via UI form * [#9733](https://github.com/netbox-community/netbox/issues/9733) - Handle split paths during trace when fanning out to front ports with differing cables * [#9765](https://github.com/netbox-community/netbox/issues/9765) - Report correct segment count under cable trace UI view +* [#9794](https://github.com/netbox-community/netbox/issues/9794) - Fix link to connect a rear port to a circuit termination +* [#9818](https://github.com/netbox-community/netbox/issues/9818) - Fix circuit side selection when connecting a cable to a circuit termination ### Plugins API From 2583abc39d4eafdca645bc18110140f1e350c7df Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 25 Jul 2022 11:34:16 -0400 Subject: [PATCH 297/593] Fix null cable termination representation --- .../templates/dcim/inc/cable_termination.html | 118 +++++++++--------- 1 file changed, 61 insertions(+), 57 deletions(-) diff --git a/netbox/templates/dcim/inc/cable_termination.html b/netbox/templates/dcim/inc/cable_termination.html index 9d1c43bdd..ced9bda50 100644 --- a/netbox/templates/dcim/inc/cable_termination.html +++ b/netbox/templates/dcim/inc/cable_termination.html @@ -1,58 +1,62 @@ {% load helpers %} - - {% if terminations.0.device %} - {# Device component #} - - - - - - - - - - - - - - - - - {% elif terminations.0.power_panel %} - {# Power feed #} - - - - - - - - - - - - - {% else %} - {# Circuit termination #} - - - - - - - - - {% endif %} -
    Site{{ terminations.0.device.site|linkify }}
    Rack{{ terminations.0.device.rack|linkify|placeholder }}
    Device{{ terminations.0.device|linkify }}
    {{ terminations.0|meta:"verbose_name"|capfirst }} - {% for term in terminations %} - {{ term|linkify }}{% if not forloop.last %},{% endif %} - {% endfor %} -
    Site{{ terminations.0.power_panel.site|linkify }}
    Power Panel{{ terminations.0.power_panel|linkify }}
    {{ terminations.0|meta:"verbose_name"|capfirst }} - {% for term in terminations %} - {{ term|linkify }}{% if not forloop.last %},{% endif %} - {% endfor %} -
    Provider{{ terminations.0.circuit.provider|linkify }}
    Circuit - {% for term in terminations %} - {{ term.circuit|linkify }} ({{ term }}){% if not forloop.last %},{% endif %} - {% endfor %} -
    +{% if terminations.0 %} + + {% if terminations.0.device %} + {# Device component #} + + + + + + + + + + + + + + + + + {% elif terminations.0.power_panel %} + {# Power feed #} + + + + + + + + + + + + + {% elif terminations.0.circuit %} + {# Circuit termination #} + + + + + + + + + {% endif %} +
    Site{{ terminations.0.device.site|linkify }}
    Rack{{ terminations.0.device.rack|linkify|placeholder }}
    Device{{ terminations.0.device|linkify }}
    {{ terminations.0|meta:"verbose_name"|capfirst }} + {% for term in terminations %} + {{ term|linkify }}{% if not forloop.last %},{% endif %} + {% endfor %} +
    Site{{ terminations.0.power_panel.site|linkify }}
    Power Panel{{ terminations.0.power_panel|linkify }}
    {{ terminations.0|meta:"verbose_name"|capfirst }} + {% for term in terminations %} + {{ term|linkify }}{% if not forloop.last %},{% endif %} + {% endfor %} +
    Provider{{ terminations.0.circuit.provider|linkify }}
    Circuit + {% for term in terminations %} + {{ term.circuit|linkify }} ({{ term }}){% if not forloop.last %},{% endif %} + {% endfor %} +
    +{% else %} + No termination +{% endif %} From 6f7289f93217c5d3499264f2cfe6e540ba17d8e9 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 26 Jul 2022 07:22:21 -0500 Subject: [PATCH 298/593] Fixes #9844 - Add dedicated `device_vlan` form field --- netbox/ipam/forms/models.py | 10 ++++++++-- netbox/templates/ipam/l2vpntermination_edit.html | 2 +- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/netbox/ipam/forms/models.py b/netbox/ipam/forms/models.py index 415c952be..0a22cbc21 100644 --- a/netbox/ipam/forms/models.py +++ b/netbox/ipam/forms/models.py @@ -906,8 +906,9 @@ class L2VPNTerminationForm(NetBoxModelForm): label='L2VPN', fetch_trigger='open' ) - device = DynamicModelChoiceField( + device_vlan = DynamicModelChoiceField( queryset=Device.objects.all(), + label="Available on Device", required=False, query_params={} ) @@ -915,10 +916,15 @@ class L2VPNTerminationForm(NetBoxModelForm): queryset=VLAN.objects.all(), required=False, query_params={ - 'available_on_device': '$device' + 'available_on_device': '$device_vlan' }, label='VLAN' ) + device = DynamicModelChoiceField( + queryset=Device.objects.all(), + required=False, + query_params={} + ) interface = DynamicModelChoiceField( queryset=Interface.objects.all(), required=False, diff --git a/netbox/templates/ipam/l2vpntermination_edit.html b/netbox/templates/ipam/l2vpntermination_edit.html index 7b4a9f50a..c66b8a3d1 100644 --- a/netbox/templates/ipam/l2vpntermination_edit.html +++ b/netbox/templates/ipam/l2vpntermination_edit.html @@ -32,7 +32,7 @@
    - {% render_field form.device %} + {% render_field form.device_vlan %} {% render_field form.vlan %}
    From 6d30c07dd0608c80e4f0a161d7f5ed129b9baa0e Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 26 Jul 2022 07:29:18 -0500 Subject: [PATCH 299/593] Update changelog for #9844 --- docs/release-notes/version-3.3.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 4b3f1dcb2..85a2e1599 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -103,6 +103,7 @@ Custom field UI visibility has no impact on API operation. * [#9730](https://github.com/netbox-community/netbox/issues/9730) - Fix validation error when creating a new cable via UI form * [#9733](https://github.com/netbox-community/netbox/issues/9733) - Handle split paths during trace when fanning out to front ports with differing cables * [#9765](https://github.com/netbox-community/netbox/issues/9765) - Report correct segment count under cable trace UI view +* [#9844](https://github.com/netbox-community/netbox/issues/9844) - Fix interface api request when creating/editing L2VPN termination ### Plugins API From d442f8fd60c88ffabcd6f75e438baa8ecca15f98 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 26 Jul 2022 11:09:51 -0400 Subject: [PATCH 300/593] Fixes #9843: Fix rendering of custom field values (regression from #9647) --- docs/release-notes/version-3.3.md | 1 + .../templates/builtins/customfield_value.html | 20 +++++++++---------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 8aa91f8f9..51d595123 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -105,6 +105,7 @@ Custom field UI visibility has no impact on API operation. * [#9765](https://github.com/netbox-community/netbox/issues/9765) - Report correct segment count under cable trace UI view * [#9794](https://github.com/netbox-community/netbox/issues/9794) - Fix link to connect a rear port to a circuit termination * [#9818](https://github.com/netbox-community/netbox/issues/9818) - Fix circuit side selection when connecting a cable to a circuit termination +* [#9843](https://github.com/netbox-community/netbox/issues/9843) - Fix rendering of custom field values (regression from #9647) * [#9844](https://github.com/netbox-community/netbox/issues/9844) - Fix interface api request when creating/editing L2VPN termination ### Plugins API diff --git a/netbox/utilities/templates/builtins/customfield_value.html b/netbox/utilities/templates/builtins/customfield_value.html index 8fedb03d5..ff93a5168 100644 --- a/netbox/utilities/templates/builtins/customfield_value.html +++ b/netbox/utilities/templates/builtins/customfield_value.html @@ -1,26 +1,26 @@ -{% if field.type == 'integer' and value is not None %} +{% if customfield.type == 'integer' and value is not None %} {{ value }} -{% elif field.type == 'longtext' and value %} +{% elif customfield.type == 'longtext' and value %} {{ value|markdown }} -{% elif field.type == 'boolean' and value == True %} +{% elif customfield.type == 'boolean' and value == True %} {% checkmark value true="True" %} -{% elif field.type == 'boolean' and value == False %} +{% elif customfield.type == 'boolean' and value == False %} {% checkmark value false="False" %} -{% elif field.type == 'url' and value %} +{% elif customfield.type == 'url' and value %} {{ value|truncatechars:70 }} -{% elif field.type == 'json' and value %} +{% elif customfield.type == 'json' and value %} 
    {{ value|json }}
    -{% elif field.type == 'multiselect' and value %} +{% elif customfield.type == 'multiselect' and value %} {{ value|join:", " }} -{% elif field.type == 'object' and value %} +{% elif customfield.type == 'object' and value %} {{ value|linkify }} -{% elif field.type == 'multiobject' and value %} +{% elif customfield.type == 'multiobject' and value %} {% for object in value %} {{ object|linkify }}{% if not forloop.last %}
    {% endif %} {% endfor %} {% elif value %} {{ value }} -{% elif field.required %} +{% elif customfield.required %} Not defined {% else %} {{ ''|placeholder }} From 466931d2fbb5e9db6b3eb90d385119ae44b34886 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 26 Jul 2022 12:41:51 -0400 Subject: [PATCH 301/593] Fixes #9829: Arrange custom fields by group when editing objects --- docs/release-notes/version-3.3.md | 1 + netbox/extras/forms/customfields.py | 4 +++ netbox/netbox/forms/base.py | 27 ++++++------------- .../templates/inc/panels/custom_fields.html | 2 +- .../form_helpers/render_custom_fields.html | 13 ++++++--- 5 files changed, 23 insertions(+), 24 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 51d595123..7e8fd50e3 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -105,6 +105,7 @@ Custom field UI visibility has no impact on API operation. * [#9765](https://github.com/netbox-community/netbox/issues/9765) - Report correct segment count under cable trace UI view * [#9794](https://github.com/netbox-community/netbox/issues/9794) - Fix link to connect a rear port to a circuit termination * [#9818](https://github.com/netbox-community/netbox/issues/9818) - Fix circuit side selection when connecting a cable to a circuit termination +* [#9829](https://github.com/netbox-community/netbox/issues/9829) - Arrange custom fields by group when editing objects * [#9843](https://github.com/netbox-community/netbox/issues/9843) - Fix rendering of custom field values (regression from #9647) * [#9844](https://github.com/netbox-community/netbox/issues/9844) - Fix interface api request when creating/editing L2VPN termination diff --git a/netbox/extras/forms/customfields.py b/netbox/extras/forms/customfields.py index 4cf8b5e0a..7574f4f2b 100644 --- a/netbox/extras/forms/customfields.py +++ b/netbox/extras/forms/customfields.py @@ -19,6 +19,7 @@ class CustomFieldsMixin: def __init__(self, *args, **kwargs): self.custom_fields = {} + self.custom_field_groups = {} super().__init__(*args, **kwargs) @@ -58,3 +59,6 @@ class CustomFieldsMixin: # Annotate the field in the list of CustomField form fields self.custom_fields[field_name] = customfield + if customfield.group_name not in self.custom_field_groups: + self.custom_field_groups[customfield.group_name] = [] + self.custom_field_groups[customfield.group_name].append(field_name) diff --git a/netbox/netbox/forms/base.py b/netbox/netbox/forms/base.py index 0e232af1d..2676e4cde 100644 --- a/netbox/netbox/forms/base.py +++ b/netbox/netbox/forms/base.py @@ -94,30 +94,19 @@ class NetBoxModelBulkEditForm(BootstrapMixin, CustomFieldsMixin, forms.Form): def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) + self.fields['pk'].queryset = self.model.objects.all() + self._extend_nullable_fields() + def _get_form_field(self, customfield): return customfield.to_form_field(set_initial=False, enforce_required=False) - def _append_customfield_fields(self): - """ - Append form fields for all CustomFields assigned to this object type. - """ - nullable_custom_fields = [] - for customfield in self._get_custom_fields(self._get_content_type()): - field_name = f'cf_{customfield.name}' - self.fields[field_name] = self._get_form_field(customfield) - - # Record non-required custom fields as nullable - if not customfield.required: - nullable_custom_fields.append(field_name) - - # Annotate the field in the list of CustomField form fields - self.custom_fields[field_name] = customfield - - # Annotate nullable custom fields (if any) on the form instance - if nullable_custom_fields: - self.nullable_fields = (*self.nullable_fields, *nullable_custom_fields) + def _extend_nullable_fields(self): + nullable_custom_fields = [ + name for name, customfield in self.custom_fields.items() if not customfield.required + ] + self.nullable_fields = (*self.nullable_fields, *nullable_custom_fields) class NetBoxModelFilterSetForm(BootstrapMixin, CustomFieldsMixin, forms.Form): diff --git a/netbox/templates/inc/panels/custom_fields.html b/netbox/templates/inc/panels/custom_fields.html index 90059447f..616b1c712 100644 --- a/netbox/templates/inc/panels/custom_fields.html +++ b/netbox/templates/inc/panels/custom_fields.html @@ -7,7 +7,7 @@
    {% for group_name, fields in custom_fields.items %} {% if group_name %} -
    {{ group_name }}
    +
    {{ group_name }}
    {% endif %} {% for field, value in fields.items %} diff --git a/netbox/utilities/templates/form_helpers/render_custom_fields.html b/netbox/utilities/templates/form_helpers/render_custom_fields.html index f3e5bffa9..6b0b2840b 100644 --- a/netbox/utilities/templates/form_helpers/render_custom_fields.html +++ b/netbox/utilities/templates/form_helpers/render_custom_fields.html @@ -1,7 +1,12 @@ {% load form_helpers %} -{% for field in form %} - {% if field.name in form.custom_fields %} - {% render_field field %} - {% endif %} +{% for group, fields in form.custom_field_groups.items %} + {% if group %} +
    +
    {{ group }}
    +
    + {% endif %} + {% for name in fields %} + {% render_field form|getfield:name %} + {% endfor %} {% endfor %} From a6be8dccf55726ddd1c9a8319f4a162c43023fa0 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 26 Jul 2022 15:45:47 -0400 Subject: [PATCH 302/593] Fixes #9847: Respect desc_units when ordering rack units --- docs/release-notes/version-3.3.md | 1 + netbox/dcim/models/racks.py | 5 ++--- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 7e8fd50e3..87cb00730 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -108,6 +108,7 @@ Custom field UI visibility has no impact on API operation. * [#9829](https://github.com/netbox-community/netbox/issues/9829) - Arrange custom fields by group when editing objects * [#9843](https://github.com/netbox-community/netbox/issues/9843) - Fix rendering of custom field values (regression from #9647) * [#9844](https://github.com/netbox-community/netbox/issues/9844) - Fix interface api request when creating/editing L2VPN termination +* [#9847](https://github.com/netbox-community/netbox/issues/9847) - Respect `desc_units` when ordering rack units ### Plugins API diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index 2039def09..4dcfcde28 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -244,10 +244,9 @@ class Rack(NetBoxModel): """ Return a list of unit numbers, top to bottom. """ - max_position = self.u_height + decimal.Decimal(0.5) if self.desc_units: - drange(0.5, max_position, 0.5) - return drange(max_position, 0.5, -0.5) + return drange(decimal.Decimal(1.0), self.u_height + 1, 0.5) + return drange(self.u_height + decimal.Decimal(0.5), 0.5, -0.5) def get_status_color(self): return RackStatusChoices.colors.get(self.status) From bbf4b906e4083dbeadbaa802af5aac18e1896ba3 Mon Sep 17 00:00:00 2001 From: sleepinggenius2 Date: Tue, 26 Jul 2022 17:16:03 -0400 Subject: [PATCH 303/593] Adds patterned_fields support for bulk components --- netbox/dcim/views.py | 1 + netbox/netbox/views/generic/bulk_views.py | 17 +++++++++-------- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index ec3e9152e..3bec02f5c 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -2707,6 +2707,7 @@ class DeviceBulkAddModuleBayView(generic.BulkComponentCreateView): filterset = filtersets.DeviceFilterSet table = tables.DeviceTable default_return_url = 'dcim:device_list' + patterned_fields = ('name', 'label', 'position') class DeviceBulkAddDeviceBayView(generic.BulkComponentCreateView): diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py index 5bdf5cbc9..7e07c57d0 100644 --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -795,6 +795,7 @@ class BulkComponentCreateView(GetReturnURLMixin, BaseMultiObjectView): model_form = None filterset = None table = None + patterned_fields = ('name', 'label') def get_required_permission(self): return f'dcim.add_{self.queryset.model._meta.model_name}' @@ -830,16 +831,16 @@ class BulkComponentCreateView(GetReturnURLMixin, BaseMultiObjectView): for obj in data['pk']: - names = data['name_pattern'] - labels = data['label_pattern'] if 'label_pattern' in data else None - for i, name in enumerate(names): - label = labels[i] if labels else None - + pattern_count = len(data[f'{self.patterned_fields[0]}_pattern']) + for i in range(pattern_count): component_data = { - self.parent_field: obj.pk, - 'name': name, - 'label': label + self.parent_field: obj.pk } + + for field_name in self.patterned_fields: + if data.get(f'{field_name}_pattern'): + component_data[field_name] = data[f'{field_name}_pattern'][i] + component_data.update(data) component_form = self.model_form(component_data) if component_form.is_valid(): From 6cee12b1530597bf308ba39c661e456bd1802835 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 27 Jul 2022 15:40:25 -0400 Subject: [PATCH 304/593] Fix formatting of webhook conditions form field --- netbox/extras/forms/models.py | 1 + 1 file changed, 1 insertion(+) diff --git a/netbox/extras/forms/models.py b/netbox/extras/forms/models.py index 112911f42..82575de21 100644 --- a/netbox/extras/forms/models.py +++ b/netbox/extras/forms/models.py @@ -133,6 +133,7 @@ class WebhookForm(BootstrapMixin, forms.ModelForm): 'http_method': StaticSelect(), 'additional_headers': forms.Textarea(attrs={'class': 'font-monospace'}), 'body_template': forms.Textarea(attrs={'class': 'font-monospace'}), + 'conditions': forms.Textarea(attrs={'class': 'font-monospace'}), } From 498b655cb726b5bb1be442739923ae3746a8da41 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 27 Jul 2022 16:50:31 -0400 Subject: [PATCH 305/593] Changelog and cleanup for #9825 --- docs/release-notes/version-3.2.md | 4 ++++ netbox/virtualization/tables/virtualmachines.py | 11 ++++------- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index c36344912..14d73d1eb 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,6 +2,10 @@ ## v3.2.8 (FUTURE) +### Enhancements + +* [#9825](https://github.com/netbox-community/netbox/issues/9825) - Add contacts column to virtual machines table + --- ## v3.2.7 (2022-07-20) diff --git a/netbox/virtualization/tables/virtualmachines.py b/netbox/virtualization/tables/virtualmachines.py index d2be07876..cace51ccc 100644 --- a/netbox/virtualization/tables/virtualmachines.py +++ b/netbox/virtualization/tables/virtualmachines.py @@ -58,8 +58,9 @@ class VirtualMachineTable(TenancyColumnsMixin, NetBoxTable): class Meta(NetBoxTable.Meta): model = VirtualMachine fields = ( - 'pk', 'id', 'name', 'status', 'cluster', 'role', 'tenant', 'tenant_group', 'platform', 'vcpus', 'memory', 'disk', - 'primary_ip4', 'primary_ip6', 'primary_ip', 'comments', 'contacts', 'tags', 'created', 'last_updated', + 'pk', 'id', 'name', 'status', 'cluster', 'role', 'tenant', 'tenant_group', 'platform', 'vcpus', 'memory', + 'disk', 'primary_ip4', 'primary_ip6', 'primary_ip', 'comments', 'contacts', 'tags', 'created', + 'last_updated', ) default_columns = ( 'pk', 'name', 'status', 'cluster', 'role', 'tenant', 'vcpus', 'memory', 'disk', 'primary_ip', @@ -80,9 +81,6 @@ class VMInterfaceTable(BaseInterfaceTable): vrf = tables.Column( linkify=True ) - contacts = columns.ManyToManyColumn( - linkify_item=True - ) tags = columns.TagColumn( url_name='virtualization:vminterface_list' ) @@ -91,8 +89,7 @@ class VMInterfaceTable(BaseInterfaceTable): model = VMInterface fields = ( 'pk', 'id', 'name', 'virtual_machine', 'enabled', 'mac_address', 'mtu', 'mode', 'description', 'tags', - 'vrf', 'ip_addresses', 'fhrp_groups', 'untagged_vlan', 'tagged_vlans', 'contacts', 'created', - 'last_updated', + 'vrf', 'ip_addresses', 'fhrp_groups', 'untagged_vlan', 'tagged_vlans', 'created', 'last_updated', ) default_columns = ('pk', 'name', 'virtual_machine', 'enabled', 'description') From 62d1510c55f4afb59b8fd0a09c38405b71a29899 Mon Sep 17 00:00:00 2001 From: atownson <52260120+atownson@users.noreply.github.com> Date: Thu, 28 Jul 2022 10:23:04 -0500 Subject: [PATCH 306/593] Closes netbox-community#9762 Added nat_outside to IPAddressTable class --- netbox/ipam/tables/ip.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/netbox/ipam/tables/ip.py b/netbox/ipam/tables/ip.py index bec05eeff..087d0de73 100644 --- a/netbox/ipam/tables/ip.py +++ b/netbox/ipam/tables/ip.py @@ -369,6 +369,11 @@ class IPAddressTable(TenancyColumnsMixin, NetBoxTable): orderable=False, verbose_name='NAT (Inside)' ) + nat_outside = tables.Column( + linkify=True, + orderable=False, + verbose_name='NAT (Outside)' + ) assigned = columns.BooleanColumn( accessor='assigned_object_id', linkify=True, @@ -381,7 +386,7 @@ class IPAddressTable(TenancyColumnsMixin, NetBoxTable): class Meta(NetBoxTable.Meta): model = IPAddress fields = ( - 'pk', 'id', 'address', 'vrf', 'status', 'role', 'tenant', 'tenant_group', 'nat_inside', 'assigned', 'dns_name', 'description', + 'pk', 'id', 'address', 'vrf', 'status', 'role', 'tenant', 'tenant_group', 'nat_inside', 'nat_outside', 'assigned', 'dns_name', 'description', 'tags', 'created', 'last_updated', ) default_columns = ( From 07620db027823fe55e49155f6adb4d2c80cace76 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 28 Jul 2022 12:45:27 -0400 Subject: [PATCH 307/593] Changelog for #9762 --- 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 14d73d1eb..c0c99bb73 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -4,6 +4,7 @@ ### Enhancements +* [#9762](https://github.com/netbox-community/netbox/issues/9762) - Add `nat_outside` column to the IPAddress table * [#9825](https://github.com/netbox-community/netbox/issues/9825) - Add contacts column to virtual machines table --- From c5fb7b72f0eb2b1e3f53b3397090b0470398f725 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 28 Jul 2022 14:36:20 -0400 Subject: [PATCH 308/593] Closes #9391: Remove 500-character limit for custom link text & URL fields --- docs/release-notes/version-3.3.md | 1 + .../0077_customlink_extend_text_and_url.py | 21 +++++++++++++++++++ netbox/extras/models/models.py | 6 ++---- 3 files changed, 24 insertions(+), 4 deletions(-) create mode 100644 netbox/extras/migrations/0077_customlink_extend_text_and_url.py diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 87cb00730..211f264f0 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -93,6 +93,7 @@ Custom field UI visibility has no impact on API operation. * [#8995](https://github.com/netbox-community/netbox/issues/8995) - Enable arbitrary ordering of REST API results * [#9070](https://github.com/netbox-community/netbox/issues/9070) - Hide navigation menu items based on user permissions * [#9177](https://github.com/netbox-community/netbox/issues/9177) - Add tenant assignment for wireless LANs & links +* [#9391](https://github.com/netbox-community/netbox/issues/9391) - Remove 500-character limit for custom link text & URL fields * [#9536](https://github.com/netbox-community/netbox/issues/9536) - Track API token usage times * [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location diff --git a/netbox/extras/migrations/0077_customlink_extend_text_and_url.py b/netbox/extras/migrations/0077_customlink_extend_text_and_url.py new file mode 100644 index 000000000..c08948aa6 --- /dev/null +++ b/netbox/extras/migrations/0077_customlink_extend_text_and_url.py @@ -0,0 +1,21 @@ +from django.db import migrations, models + + +class Migration(migrations.Migration): + + dependencies = [ + ('extras', '0076_tag_slug_unicode'), + ] + + operations = [ + migrations.AlterField( + model_name='customlink', + name='link_text', + field=models.TextField(), + ), + migrations.AlterField( + model_name='customlink', + name='link_url', + field=models.TextField(), + ), + ] diff --git a/netbox/extras/models/models.py b/netbox/extras/models/models.py index e614a1258..4873a1f9e 100644 --- a/netbox/extras/models/models.py +++ b/netbox/extras/models/models.py @@ -204,12 +204,10 @@ class CustomLink(ExportTemplatesMixin, WebhooksMixin, ChangeLoggedModel): enabled = models.BooleanField( default=True ) - link_text = models.CharField( - max_length=500, + link_text = models.TextField( help_text="Jinja2 template code for link text" ) - link_url = models.CharField( - max_length=500, + link_url = models.TextField( verbose_name='Link URL', help_text="Jinja2 template code for link URL" ) From 2c43c8d077c34402720b86658674c46371da321d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 28 Jul 2022 15:03:24 -0400 Subject: [PATCH 309/593] Closes #9793: Add PoE attributes to interface templates --- docs/models/dcim/interfacetemplate.md | 2 +- docs/release-notes/version-3.3.md | 4 +++- netbox/dcim/api/serializers.py | 12 +++++++++++- netbox/dcim/filtersets.py | 6 ++++++ netbox/dcim/forms/bulk_edit.py | 16 +++++++++++++++- netbox/dcim/forms/filtersets.py | 6 ++++-- netbox/dcim/forms/models.py | 4 +++- netbox/dcim/forms/object_import.py | 14 ++++++++++++-- netbox/dcim/graphql/types.py | 6 ++++++ .../migrations/0155_interface_poe_mode_type.py | 10 ++++++++++ netbox/dcim/models/device_component_templates.py | 16 +++++++++++++++- netbox/dcim/models/devices.py | 2 ++ netbox/dcim/tables/devicetypes.py | 2 +- netbox/dcim/tests/test_filtersets.py | 12 ++++++++++-- 14 files changed, 99 insertions(+), 13 deletions(-) diff --git a/docs/models/dcim/interfacetemplate.md b/docs/models/dcim/interfacetemplate.md index d9b30dd87..e11abcce4 100644 --- a/docs/models/dcim/interfacetemplate.md +++ b/docs/models/dcim/interfacetemplate.md @@ -1,3 +1,3 @@ ## Interface Templates -A template for a network interface that will be created on all instantiations of the parent device type. Each interface may be assigned a physical or virtual type, and may be designated as "management-only." +A template for a network interface that will be created on all instantiations of the parent device type. Each interface may be assigned a physical or virtual type, and may be designated as "management-only." Power over Ethernet (PoE) mode and type may also be assigned to interface templates. diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 211f264f0..68cff0547 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -97,7 +97,7 @@ Custom field UI visibility has no impact on API operation. * [#9536](https://github.com/netbox-community/netbox/issues/9536) - Track API token usage times * [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location -### Bug Fixes +### Bug Fixes (from Beta1) * [#9728](https://github.com/netbox-community/netbox/issues/9728) - Fix validation when assigning a virtual machine to a device * [#9729](https://github.com/netbox-community/netbox/issues/9729) - Fix ordering of content type creation to ensure compatability with demo data @@ -177,6 +177,8 @@ Custom field UI visibility has no impact on API operation. * `connected_endpoint_reachable` has been renamed to `connected_endpoints_reachable` * Added the optional `poe_mode` and `poe_type` fields * Added the `l2vpn_termination` read-only field +* dcim.InterfaceTemplate + * Added the optional `poe_mode` and `poe_type` fields * dcim.Location * Added required `status` field (default value: `active`) * dcim.PowerOutlet diff --git a/netbox/dcim/api/serializers.py b/netbox/dcim/api/serializers.py index 5f30b7385..249a3f167 100644 --- a/netbox/dcim/api/serializers.py +++ b/netbox/dcim/api/serializers.py @@ -469,12 +469,22 @@ class InterfaceTemplateSerializer(ValidatedModelSerializer): default=None ) type = ChoiceField(choices=InterfaceTypeChoices) + poe_mode = ChoiceField( + choices=InterfacePoEModeChoices, + required=False, + allow_blank=True + ) + poe_type = ChoiceField( + choices=InterfacePoETypeChoices, + required=False, + allow_blank=True + ) class Meta: model = InterfaceTemplate fields = [ 'id', 'url', 'display', 'device_type', 'module_type', 'name', 'label', 'type', 'mgmt_only', 'description', - 'created', 'last_updated', + 'poe_mode', 'poe_type', 'created', 'last_updated', ] diff --git a/netbox/dcim/filtersets.py b/netbox/dcim/filtersets.py index 4bdc525a5..874d08ba5 100644 --- a/netbox/dcim/filtersets.py +++ b/netbox/dcim/filtersets.py @@ -652,6 +652,12 @@ class InterfaceTemplateFilterSet(ChangeLoggedModelFilterSet, ModularDeviceTypeCo choices=InterfaceTypeChoices, null_value=None ) + poe_mode = django_filters.MultipleChoiceFilter( + choices=InterfacePoEModeChoices + ) + poe_type = django_filters.MultipleChoiceFilter( + choices=InterfacePoETypeChoices + ) class Meta: model = InterfaceTemplate diff --git a/netbox/dcim/forms/bulk_edit.py b/netbox/dcim/forms/bulk_edit.py index 6d51302d3..8f765ae9b 100644 --- a/netbox/dcim/forms/bulk_edit.py +++ b/netbox/dcim/forms/bulk_edit.py @@ -818,8 +818,22 @@ class InterfaceTemplateBulkEditForm(BulkEditForm): description = forms.CharField( required=False ) + poe_mode = forms.ChoiceField( + choices=add_blank_choice(InterfacePoEModeChoices), + required=False, + initial='', + widget=StaticSelect(), + label='PoE mode' + ) + poe_type = forms.ChoiceField( + choices=add_blank_choice(InterfacePoETypeChoices), + required=False, + initial='', + widget=StaticSelect(), + label='PoE type' + ) - nullable_fields = ('label', 'description') + nullable_fields = ('label', 'description', 'poe_mode', 'poe_type') class FrontPortTemplateBulkEditForm(BulkEditForm): diff --git a/netbox/dcim/forms/filtersets.py b/netbox/dcim/forms/filtersets.py index 8d2e24c9c..c5474a2b1 100644 --- a/netbox/dcim/forms/filtersets.py +++ b/netbox/dcim/forms/filtersets.py @@ -1027,11 +1027,13 @@ class InterfaceFilterForm(DeviceComponentFilterForm): ) poe_mode = MultipleChoiceField( choices=InterfacePoEModeChoices, - required=False + required=False, + label='PoE mode' ) poe_type = MultipleChoiceField( choices=InterfacePoEModeChoices, - required=False + required=False, + label='PoE type' ) rf_role = MultipleChoiceField( choices=WirelessRoleChoices, diff --git a/netbox/dcim/forms/models.py b/netbox/dcim/forms/models.py index aa573a4df..f3ab6f3a9 100644 --- a/netbox/dcim/forms/models.py +++ b/netbox/dcim/forms/models.py @@ -1052,12 +1052,14 @@ class InterfaceTemplateForm(BootstrapMixin, forms.ModelForm): class Meta: model = InterfaceTemplate fields = [ - 'device_type', 'module_type', 'name', 'label', 'type', 'mgmt_only', 'description', + 'device_type', 'module_type', 'name', 'label', 'type', 'mgmt_only', 'description', 'poe_mode', 'poe_type', ] widgets = { 'device_type': forms.HiddenInput(), 'module_type': forms.HiddenInput(), 'type': StaticSelect(), + 'poe_mode': StaticSelect(), + 'poe_type': StaticSelect(), } diff --git a/netbox/dcim/forms/object_import.py b/netbox/dcim/forms/object_import.py index afbcd6543..a51f48c5b 100644 --- a/netbox/dcim/forms/object_import.py +++ b/netbox/dcim/forms/object_import.py @@ -1,6 +1,6 @@ from django import forms -from dcim.choices import InterfaceTypeChoices, PortTypeChoices +from dcim.choices import InterfacePoEModeChoices, InterfacePoETypeChoices, InterfaceTypeChoices, PortTypeChoices from dcim.models import * from utilities.forms import BootstrapMixin @@ -112,11 +112,21 @@ class InterfaceTemplateImportForm(ComponentTemplateImportForm): type = forms.ChoiceField( choices=InterfaceTypeChoices.CHOICES ) + poe_mode = forms.ChoiceField( + choices=InterfacePoEModeChoices, + required=False, + label='PoE mode' + ) + poe_type = forms.ChoiceField( + choices=InterfacePoETypeChoices, + required=False, + label='PoE type' + ) class Meta: model = InterfaceTemplate fields = [ - 'device_type', 'module_type', 'name', 'label', 'type', 'mgmt_only', 'description', + 'device_type', 'module_type', 'name', 'label', 'type', 'mgmt_only', 'description', 'poe_mode', 'poe_type', ] diff --git a/netbox/dcim/graphql/types.py b/netbox/dcim/graphql/types.py index a43b293a4..52a98278a 100644 --- a/netbox/dcim/graphql/types.py +++ b/netbox/dcim/graphql/types.py @@ -258,6 +258,12 @@ class InterfaceTemplateType(ComponentTemplateObjectType): fields = '__all__' filterset_class = filtersets.InterfaceTemplateFilterSet + def resolve_poe_mode(self, info): + return self.poe_mode or None + + def resolve_poe_type(self, info): + return self.poe_type or None + class InventoryItemType(ComponentObjectType): diff --git a/netbox/dcim/migrations/0155_interface_poe_mode_type.py b/netbox/dcim/migrations/0155_interface_poe_mode_type.py index 0615d5d7e..13f2ddfc0 100644 --- a/netbox/dcim/migrations/0155_interface_poe_mode_type.py +++ b/netbox/dcim/migrations/0155_interface_poe_mode_type.py @@ -20,4 +20,14 @@ class Migration(migrations.Migration): name='poe_type', field=models.CharField(blank=True, max_length=50), ), + migrations.AddField( + model_name='interfacetemplate', + name='poe_mode', + field=models.CharField(blank=True, max_length=50), + ), + migrations.AddField( + model_name='interfacetemplate', + name='poe_type', + field=models.CharField(blank=True, max_length=50), + ), ] diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index 92658d310..4a66bc457 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -1,6 +1,6 @@ from django.contrib.contenttypes.fields import GenericForeignKey from django.contrib.contenttypes.models import ContentType -from django.core.exceptions import ObjectDoesNotExist, ValidationError +from django.core.exceptions import ValidationError from django.core.validators import MaxValueValidator, MinValueValidator from django.db import models from mptt.models import MPTTModel, TreeForeignKey @@ -318,6 +318,18 @@ class InterfaceTemplate(ModularComponentTemplateModel): default=False, verbose_name='Management only' ) + poe_mode = models.CharField( + max_length=50, + choices=InterfacePoEModeChoices, + blank=True, + verbose_name='PoE mode' + ) + poe_type = models.CharField( + max_length=50, + choices=InterfacePoETypeChoices, + blank=True, + verbose_name='PoE type' + ) component_model = Interface @@ -334,6 +346,8 @@ class InterfaceTemplate(ModularComponentTemplateModel): label=self.resolve_label(kwargs.get('module')), type=self.type, mgmt_only=self.mgmt_only, + poe_mode=self.poe_mode, + poe_type=self.poe_type, **kwargs ) diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index 6075cb5a0..f8a28eb58 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -229,6 +229,8 @@ class DeviceType(NetBoxModel): 'mgmt_only': c.mgmt_only, 'label': c.label, 'description': c.description, + 'poe_mode': c.poe_mode, + 'poe_type': c.poe_type, } for c in self.interfacetemplates.all() ] diff --git a/netbox/dcim/tables/devicetypes.py b/netbox/dcim/tables/devicetypes.py index 2da9daee7..3ed4d8c08 100644 --- a/netbox/dcim/tables/devicetypes.py +++ b/netbox/dcim/tables/devicetypes.py @@ -172,7 +172,7 @@ class InterfaceTemplateTable(ComponentTemplateTable): class Meta(ComponentTemplateTable.Meta): model = InterfaceTemplate - fields = ('pk', 'name', 'label', 'mgmt_only', 'type', 'description', 'actions') + fields = ('pk', 'name', 'label', 'mgmt_only', 'type', 'description', 'poe_mode', 'poe_type', 'actions') empty_text = "None" diff --git a/netbox/dcim/tests/test_filtersets.py b/netbox/dcim/tests/test_filtersets.py index 21daa32c1..fbc0addb8 100644 --- a/netbox/dcim/tests/test_filtersets.py +++ b/netbox/dcim/tests/test_filtersets.py @@ -1089,8 +1089,8 @@ class InterfaceTemplateTestCase(TestCase, ChangeLoggedFilterSetTests): DeviceType.objects.bulk_create(device_types) InterfaceTemplate.objects.bulk_create(( - InterfaceTemplate(device_type=device_types[0], name='Interface 1', type=InterfaceTypeChoices.TYPE_1GE_FIXED, mgmt_only=True), - InterfaceTemplate(device_type=device_types[1], name='Interface 2', type=InterfaceTypeChoices.TYPE_1GE_GBIC, mgmt_only=False), + InterfaceTemplate(device_type=device_types[0], name='Interface 1', type=InterfaceTypeChoices.TYPE_1GE_FIXED, mgmt_only=True, poe_mode=InterfacePoEModeChoices.MODE_PD, poe_type=InterfacePoETypeChoices.TYPE_1_8023AF), + InterfaceTemplate(device_type=device_types[1], name='Interface 2', type=InterfaceTypeChoices.TYPE_1GE_GBIC, mgmt_only=False, poe_mode=InterfacePoEModeChoices.MODE_PSE, poe_type=InterfacePoETypeChoices.TYPE_2_8023AT), InterfaceTemplate(device_type=device_types[2], name='Interface 3', type=InterfaceTypeChoices.TYPE_1GE_SFP, mgmt_only=False), )) @@ -1113,6 +1113,14 @@ class InterfaceTemplateTestCase(TestCase, ChangeLoggedFilterSetTests): params = {'mgmt_only': 'false'} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + def test_poe_mode(self): + params = {'poe_mode': [InterfacePoEModeChoices.MODE_PD, InterfacePoEModeChoices.MODE_PSE]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_poe_type(self): + params = {'poe_type': [InterfacePoETypeChoices.TYPE_1_8023AF, InterfacePoETypeChoices.TYPE_2_8023AT]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + class FrontPortTemplateTestCase(TestCase, ChangeLoggedFilterSetTests): queryset = FrontPortTemplate.objects.all() From 04fb0bd51c5a3fd0d13fddea155de311b0f4edd9 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 28 Jul 2022 15:41:10 -0400 Subject: [PATCH 310/593] Closes #9858: ChangeLoggedModelFilterSet cleanup --- netbox/netbox/filtersets.py | 23 +++++------------------ netbox/utilities/testing/filtersets.py | 4 ++-- 2 files changed, 7 insertions(+), 20 deletions(-) diff --git a/netbox/netbox/filtersets.py b/netbox/netbox/filtersets.py index f509afa5b..3a0434592 100644 --- a/netbox/netbox/filtersets.py +++ b/netbox/netbox/filtersets.py @@ -197,24 +197,11 @@ class BaseFilterSet(django_filters.FilterSet): class ChangeLoggedModelFilterSet(BaseFilterSet): - created = django_filters.DateTimeFilter() - created__gte = django_filters.DateTimeFilter( - field_name='created', - lookup_expr='gte' - ) - created__lte = django_filters.DateTimeFilter( - field_name='created', - lookup_expr='lte' - ) - last_updated = django_filters.DateTimeFilter() - last_updated__gte = django_filters.DateTimeFilter( - field_name='last_updated', - lookup_expr='gte' - ) - last_updated__lte = django_filters.DateTimeFilter( - field_name='last_updated', - lookup_expr='lte' - ) + """ + Base FilterSet for ChangeLoggedModel classes. + """ + created = filters.MultiValueDateTimeFilter() + last_updated = filters.MultiValueDateTimeFilter() class NetBoxModelFilterSet(ChangeLoggedModelFilterSet): diff --git a/netbox/utilities/testing/filtersets.py b/netbox/utilities/testing/filtersets.py index 9c90f5530..00f3d9745 100644 --- a/netbox/utilities/testing/filtersets.py +++ b/netbox/utilities/testing/filtersets.py @@ -25,11 +25,11 @@ class ChangeLoggedFilterSetTests(BaseFilterSetTests): def test_created(self): pk_list = self.queryset.values_list('pk', flat=True)[:2] self.queryset.filter(pk__in=pk_list).update(created=datetime(2021, 1, 1, 0, 0, 0, tzinfo=timezone.utc)) - params = {'created': '2021-01-01T00:00:00'} + params = {'created': ['2021-01-01T00:00:00']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) def test_last_updated(self): pk_list = self.queryset.values_list('pk', flat=True)[:2] self.queryset.filter(pk__in=pk_list).update(last_updated=datetime(2021, 1, 2, 0, 0, 0, tzinfo=timezone.utc)) - params = {'last_updated': '2021-01-02T00:00:00'} + params = {'last_updated': ['2021-01-02T00:00:00']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) From c582d7459f2bd5db72ba407b360bf381694b1767 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 29 Jul 2022 10:06:26 -0400 Subject: [PATCH 311/593] Rearrange introductory content --- docs/index.md | 81 ++++++++++++++++++-------------------------- docs/introduction.md | 79 ++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 2 +- 3 files changed, 113 insertions(+), 49 deletions(-) create mode 100644 docs/introduction.md diff --git a/docs/index.md b/docs/index.md index 81c899387..a6bbcecff 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,63 +1,48 @@ ![NetBox](netbox_logo.svg "NetBox logo"){style="height: 100px; margin-bottom: 3em"} -# What is NetBox? +# The Premiere Network Source of Truth -NetBox is an infrastructure resource modeling (IRM) application designed to empower network automation. Initially conceived by the network engineering team at [DigitalOcean](https://www.digitalocean.com/), NetBox was developed specifically to address the needs of network and infrastructure engineers. NetBox is made available as open source under the Apache 2 license. It encompasses the following aspects of network management: +NetBox is the leading solution for modeling modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation. -* **IP address management (IPAM)** - IP networks and addresses, VRFs, and VLANs -* **Equipment racks** - Organized by group and site -* **Devices** - Types of devices and where they are installed -* **Connections** - Network, console, and power connections among devices -* **Virtualization** - Virtual machines and clusters -* **Data circuits** - Long-haul communications circuits and providers +## Built for Networks -## What NetBox Is Not +Unlike general-purpose CMDBs, NetBox has curated a data model which caters specifically to the needs of network engineers and operators. It delivers a wide assortment of object types carefully crafted to best serve the needs of network engineers and operators. These cover all facets of network design, from IP address managements to cabling to overlays and more: -While NetBox strives to cover many areas of network management, the scope of its feature set is necessarily limited. This ensures that development focuses on core functionality and that scope creep is reasonably contained. To that end, it might help to provide some examples of functionality that NetBox **does not** provide: +* Hierarchical regions, site groups, sites, and locations +* Racks, devices, and device components +* Cables and wireless connections +* Power distribution +* Data circuits and providers +* Virtual machines and clusters +* IP prefixes, ranges, and addresses +* VRFs and route targets +* FHRP groups (VRRP, HSRP, etc.) +* AS numbers +* VLANs and scoped VLAN groups +* L2VPN overlays +* Organizational tenants and contacts -* Network monitoring -* DNS server -* RADIUS server -* Configuration management -* Facilities management +## Customizable & Extensible -That said, NetBox _can_ be used to great effect in populating external tools with the data they need to perform these functions. +In addition to its expansive and robust data model, NetBox offers myriad mechanisms through it can be customized and extended. -## Design Philosophy +* Custom fields +* Custom model validation +* Export templates +* Webhooks +* Plugins +* REST & GraphQL APIs -NetBox was designed with the following tenets foremost in mind. +## Always Open -### Replicate the Real World - -Careful consideration has been given to the data model to ensure that it can accurately reflect a real-world network. For instance, IP addresses are assigned not to devices, but to specific interfaces attached to a device, and an interface may have multiple IP addresses assigned to it. - -### Serve as a "Source of Truth" - -NetBox intends to represent the _desired_ state of a network versus its _operational_ state. As such, automated import of live network state is strongly discouraged. All data created in NetBox should first be vetted by a human to ensure its integrity. NetBox can then be used to populate monitoring and provisioning systems with a high degree of confidence. - -### Keep it Simple - -When given a choice between a relatively simple [80% solution](https://en.wikipedia.org/wiki/Pareto_principle) and a much more complex complete solution, the former will typically be favored. This ensures a lean codebase with a low learning curve. - -## Application Stack - -NetBox is built on the [Django](https://djangoproject.com/) Python framework and utilizes a [PostgreSQL](https://www.postgresql.org/) database. It runs as a WSGI service behind your choice of HTTP server. - -| Function | Component | -|--------------------|-------------------| -| HTTP service | nginx or Apache | -| WSGI service | gunicorn or uWSGI | -| Application | Django/Python | -| Database | PostgreSQL 10+ | -| Task queuing | Redis/django-rq | -| Live device access | NAPALM (optional) | - -## Supported Python Versions - -NetBox supports Python 3.8, 3.9, and 3.10 environments. +Because NetBox is an open source application licensed under [Apache 2](https://www.apache.org/licenses/LICENSE-2.0.html), its entire code base is completely accessible to the end user, and there's never a risk of vendor lock-out. Additionally, NetBox development is an entirely public, community-driven process to which everyone can provide input. ## Getting Started -Minor NetBox releases (e.g. v3.1) are published three times a year; in April, August, and December. These typically introduce major new features and may contain breaking API changes. Patch releases are published roughly every one to two weeks to resolve bugs and fulfill minor feature requests. These are backward-compatible with previous releases unless otherwise noted. The NetBox maintainers strongly recommend running the latest stable release whenever possible. +* Public Demo +* Installation Guide +* Docker install +* NetBox Cloud -Please see the [official installation guide](installation/index.md) for detailed instructions on obtaining and installing NetBox. +!!! tip "NetBox Development" + Interested in contributing to NetBox? Check out our [GitHub repository](https://github.com/netbox-community/netbox) to get started! diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 000000000..cffcb37dd --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,79 @@ +# Introduction to NetBox + +## Origin Story + +NetBox was originally developed by its lead maintainer, [Jeremy Stretch](https://github.com/jeremystretch), while he was working as a network engineer at [DigitalOcean](https://www.digitalocean.com/) in 2015 as part of an effort to automate their network provisioning. Recognizing the new tool's potential, DigitalOcean agreed to release it as an open source project in June 2016. + +Since then, thousands of organizations around the world have embraced NetBox as their central network source of truth to empower both network operators and automation. + +## Key Features + +NetBox was built specifically to serve the needs of network engineers and operators. Below is a very brief overview of the core features it provides. + +* IP address management (IPAM) with full IPv4/IPv6 parity +* Automatic provisioning of next available prefix/IP +* VRFs with import & export route targets +* VLANs with variably-scoped groups +* AS number (ASN) management +* Rack elevations with SVG rendering +* Device modeling using pre-defined types +* Network, power, and console cabling with SVG traces +* Power distribution modeling +* Data circuit and provider tracking +* Wireless LAN and point-to-point links +* L2 VPN overlays +* FHRP groups (VRRP, HSRP, etc.) +* Application service bindings +* Virtual machines & clusters +* Flexible hierarchy for sites and locations +* Tenant ownership assignment +* Device & VM configuration contexts for advanced configuration rendering +* Custom fields for data model extension +* Support for custom validation rules +* Custom reports & scripts executable directly within the UI +* Extensive plugin framework for adding custom functionality +* Single sign-on (SSO) authentication +* Robust object-based permissions +* Detailed, automatic change logging +* NAPALM integration + +## What NetBox Is Not + +While NetBox strives to cover many areas of network management, the scope of its feature set is necessarily limited. This ensures that development focuses on core functionality and that scope creep is reasonably contained. To that end, it might help to provide some examples of functionality that NetBox **does not** provide: + +* Network monitoring +* DNS server +* RADIUS server +* Configuration management +* Facilities management + +That said, NetBox _can_ be used to great effect in populating external tools with the data they need to perform these functions. + +## Design Philosophy + +NetBox was designed with the following tenets foremost in mind. + +### Replicate the Real World + +Careful consideration has been given to the data model to ensure that it can accurately reflect a real-world network. For instance, IP addresses are assigned not to devices, but to specific interfaces attached to a device, and an interface may have multiple IP addresses assigned to it. + +### Serve as a "Source of Truth" + +NetBox intends to represent the _desired_ state of a network versus its _operational_ state. As such, automated import of live network state is strongly discouraged. All data created in NetBox should first be vetted by a human to ensure its integrity. NetBox can then be used to populate monitoring and provisioning systems with a high degree of confidence. + +### Keep it Simple + +When given a choice between a relatively simple [80% solution](https://en.wikipedia.org/wiki/Pareto_principle) and a much more complex complete solution, the former will typically be favored. This ensures a lean codebase with a low learning curve. + +## Application Stack + +NetBox is built on the [Django](https://djangoproject.com/) Python framework and utilizes a [PostgreSQL](https://www.postgresql.org/) database. It runs as a WSGI service behind your choice of HTTP server. + +| Function | Component | +|--------------------|-------------------| +| HTTP service | nginx or Apache | +| WSGI service | gunicorn or uWSGI | +| Application | Django/Python | +| Database | PostgreSQL 10+ | +| Task queuing | Redis/django-rq | +| Live device access | NAPALM (optional) | diff --git a/mkdocs.yml b/mkdocs.yml index 34c65ed01..992859d66 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -57,7 +57,7 @@ markdown_extensions: - pymdownx.tabbed: alternate_style: true nav: - - Introduction: 'index.md' + - Introduction: 'introduction.md' - Installation: - Installing NetBox: 'installation/index.md' - 1. PostgreSQL: 'installation/1-postgresql.md' From 18acac18e0301ad0e3355f9742177062aad403c3 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 29 Jul 2022 10:30:47 -0400 Subject: [PATCH 312/593] Move data model definitions to separate hierarchy --- docs/core-functionality/circuits.md | 10 -- docs/core-functionality/contacts.md | 5 - docs/core-functionality/device-types.md | 41 --------- docs/core-functionality/devices.md | 40 -------- docs/core-functionality/ipam.md | 33 ------- docs/core-functionality/modules.md | 4 - docs/core-functionality/power.md | 8 -- docs/core-functionality/services.md | 4 - docs/core-functionality/sites-and-racks.md | 12 --- docs/core-functionality/tenancy.md | 4 - docs/core-functionality/virtualization.md | 10 -- docs/core-functionality/vlans.md | 4 - docs/core-functionality/wireless.md | 8 -- docs/installation/migrating-to-systemd.md | 55 ----------- mkdocs.yml | 101 +++++++++++++++++---- 15 files changed, 85 insertions(+), 254 deletions(-) delete mode 100644 docs/core-functionality/circuits.md delete mode 100644 docs/core-functionality/contacts.md delete mode 100644 docs/core-functionality/device-types.md delete mode 100644 docs/core-functionality/devices.md delete mode 100644 docs/core-functionality/ipam.md delete mode 100644 docs/core-functionality/modules.md delete mode 100644 docs/core-functionality/power.md delete mode 100644 docs/core-functionality/services.md delete mode 100644 docs/core-functionality/sites-and-racks.md delete mode 100644 docs/core-functionality/tenancy.md delete mode 100644 docs/core-functionality/virtualization.md delete mode 100644 docs/core-functionality/vlans.md delete mode 100644 docs/core-functionality/wireless.md delete mode 100644 docs/installation/migrating-to-systemd.md diff --git a/docs/core-functionality/circuits.md b/docs/core-functionality/circuits.md deleted file mode 100644 index b1b02e300..000000000 --- a/docs/core-functionality/circuits.md +++ /dev/null @@ -1,10 +0,0 @@ -# Circuits - -{!models/circuits/provider.md!} -{!models/circuits/providernetwork.md!} - ---- - -{!models/circuits/circuit.md!} -{!models/circuits/circuittype.md!} -{!models/circuits/circuittermination.md!} diff --git a/docs/core-functionality/contacts.md b/docs/core-functionality/contacts.md deleted file mode 100644 index 76a005fc0..000000000 --- a/docs/core-functionality/contacts.md +++ /dev/null @@ -1,5 +0,0 @@ -# Contacts - -{!models/tenancy/contact.md!} -{!models/tenancy/contactgroup.md!} -{!models/tenancy/contactrole.md!} diff --git a/docs/core-functionality/device-types.md b/docs/core-functionality/device-types.md deleted file mode 100644 index ec5cbacdb..000000000 --- a/docs/core-functionality/device-types.md +++ /dev/null @@ -1,41 +0,0 @@ -# Device Types - -{!models/dcim/devicetype.md!} -{!models/dcim/manufacturer.md!} - ---- - -## Device Component Templates - -Each device type is assigned a number of component templates which define the physical components within a device. These are: - -* Console ports -* Console server ports -* Power ports -* Power outlets -* Network interfaces -* Front ports -* Rear ports -* Device bays (which house child devices) - -Whenever a new device is created, its components are automatically created per the templates assigned to its device type. For example, a Juniper EX4300-48T device type might have the following component templates defined: - -* One template for a console port ("Console") -* Two templates for power ports ("PSU0" and "PSU1") -* 48 templates for 1GE interfaces ("ge-0/0/0" through "ge-0/0/47") -* Four templates for 10GE interfaces ("xe-0/2/0" through "xe-0/2/3") - -Once component templates have been created, every new device that you create as an instance of this type will automatically be assigned each of the components listed above. - -!!! note - Assignment of components from templates occurs only at the time of device creation. If you modify the templates of a device type, it will not affect devices which have already been created. However, you always have the option of adding, modifying, or deleting components on existing devices. - -{!models/dcim/consoleporttemplate.md!} -{!models/dcim/consoleserverporttemplate.md!} -{!models/dcim/powerporttemplate.md!} -{!models/dcim/poweroutlettemplate.md!} -{!models/dcim/interfacetemplate.md!} -{!models/dcim/frontporttemplate.md!} -{!models/dcim/rearporttemplate.md!} -{!models/dcim/modulebaytemplate.md!} -{!models/dcim/devicebaytemplate.md!} diff --git a/docs/core-functionality/devices.md b/docs/core-functionality/devices.md deleted file mode 100644 index 35c978210..000000000 --- a/docs/core-functionality/devices.md +++ /dev/null @@ -1,40 +0,0 @@ -# Devices and Cabling - -{!models/dcim/device.md!} -{!models/dcim/devicerole.md!} -{!models/dcim/platform.md!} - ---- - -## Device Components - -Device components represent discrete objects within a device which are used to terminate cables, house child devices, or track resources. - -{!models/dcim/consoleport.md!} -{!models/dcim/consoleserverport.md!} -{!models/dcim/powerport.md!} -{!models/dcim/poweroutlet.md!} -{!models/dcim/interface.md!} -{!models/dcim/frontport.md!} -{!models/dcim/rearport.md!} -{!models/dcim/modulebay.md!} -{!models/dcim/devicebay.md!} -{!models/dcim/inventoryitem.md!} - ---- - -{!models/dcim/virtualchassis.md!} - ---- - -{!models/dcim/cable.md!} - -In the example below, three individual cables comprise a path between devices A and D: - -![Cable path](../media/models/dcim_cable_trace.png) - -Traced from Interface 1 on Device A, NetBox will show the following path: - -* Cable 1: Interface 1 to Front Port 1 -* Cable 2: Rear Port 1 to Rear Port 2 -* Cable 3: Front Port 2 to Interface 2 diff --git a/docs/core-functionality/ipam.md b/docs/core-functionality/ipam.md deleted file mode 100644 index c86819380..000000000 --- a/docs/core-functionality/ipam.md +++ /dev/null @@ -1,33 +0,0 @@ -# IP Address Management - -{!models/ipam/aggregate.md!} -{!models/ipam/rir.md!} - ---- - -{!models/ipam/prefix.md!} -{!models/ipam/role.md!} - ---- - -{!models/ipam/iprange.md!} -{!models/ipam/ipaddress.md!} - ---- - -{!models/ipam/vrf.md!} -{!models/ipam/routetarget.md!} - ---- - -{!models/ipam/fhrpgroup.md!} -{!models/ipam/fhrpgroupassignment.md!} - ---- - -{!models/ipam/asn.md!} - ---- - -{!models/ipam/l2vpn.md!} -{!models/ipam/l2vpntermination.md!} diff --git a/docs/core-functionality/modules.md b/docs/core-functionality/modules.md deleted file mode 100644 index 4d32fe18c..000000000 --- a/docs/core-functionality/modules.md +++ /dev/null @@ -1,4 +0,0 @@ -# Modules - -{!models/dcim/moduletype.md!} -{!models/dcim/module.md!} diff --git a/docs/core-functionality/power.md b/docs/core-functionality/power.md deleted file mode 100644 index 4d7d5f0ab..000000000 --- a/docs/core-functionality/power.md +++ /dev/null @@ -1,8 +0,0 @@ -# Power Tracking - -{!models/dcim/powerpanel.md!} -{!models/dcim/powerfeed.md!} - -# Example Power Topology - -![Power distribution model](../media/power_distribution.png) diff --git a/docs/core-functionality/services.md b/docs/core-functionality/services.md deleted file mode 100644 index 316c7fe00..000000000 --- a/docs/core-functionality/services.md +++ /dev/null @@ -1,4 +0,0 @@ -# Service Mapping - -{!models/ipam/servicetemplate.md!} -{!models/ipam/service.md!} diff --git a/docs/core-functionality/sites-and-racks.md b/docs/core-functionality/sites-and-racks.md deleted file mode 100644 index c78f2120a..000000000 --- a/docs/core-functionality/sites-and-racks.md +++ /dev/null @@ -1,12 +0,0 @@ -# Sites and Racks - -{!models/dcim/region.md!} -{!models/dcim/sitegroup.md!} -{!models/dcim/site.md!} -{!models/dcim/location.md!} - ---- - -{!models/dcim/rack.md!} -{!models/dcim/rackrole.md!} -{!models/dcim/rackreservation.md!} diff --git a/docs/core-functionality/tenancy.md b/docs/core-functionality/tenancy.md deleted file mode 100644 index fbe1ea8b9..000000000 --- a/docs/core-functionality/tenancy.md +++ /dev/null @@ -1,4 +0,0 @@ -# Tenancy Assignment - -{!models/tenancy/tenant.md!} -{!models/tenancy/tenantgroup.md!} diff --git a/docs/core-functionality/virtualization.md b/docs/core-functionality/virtualization.md deleted file mode 100644 index 220030ab2..000000000 --- a/docs/core-functionality/virtualization.md +++ /dev/null @@ -1,10 +0,0 @@ -# Virtualization - -{!models/virtualization/cluster.md!} -{!models/virtualization/clustertype.md!} -{!models/virtualization/clustergroup.md!} - ---- - -{!models/virtualization/virtualmachine.md!} -{!models/virtualization/vminterface.md!} diff --git a/docs/core-functionality/vlans.md b/docs/core-functionality/vlans.md deleted file mode 100644 index d69128765..000000000 --- a/docs/core-functionality/vlans.md +++ /dev/null @@ -1,4 +0,0 @@ -# VLAN Management - -{!models/ipam/vlan.md!} -{!models/ipam/vlangroup.md!} diff --git a/docs/core-functionality/wireless.md b/docs/core-functionality/wireless.md deleted file mode 100644 index 57133f756..000000000 --- a/docs/core-functionality/wireless.md +++ /dev/null @@ -1,8 +0,0 @@ -# Wireless Networks - -{!models/wireless/wirelesslan.md!} -{!models/wireless/wirelesslangroup.md!} - ---- - -{!models/wireless/wirelesslink.md!} diff --git a/docs/installation/migrating-to-systemd.md b/docs/installation/migrating-to-systemd.md deleted file mode 100644 index a71b748fd..000000000 --- a/docs/installation/migrating-to-systemd.md +++ /dev/null @@ -1,55 +0,0 @@ -# Migrating to systemd - -This document contains instructions for migrating from a legacy NetBox deployment using [supervisor](http://supervisord.org/) to a systemd-based approach. - -## Ubuntu - -### Uninstall supervisord - -```no-highlight -# apt-get remove -y supervisor -``` - -### Configure systemd - -!!! note - These instructions assume the presence of a Python virtual environment at `/opt/netbox/venv`. If you have not created this environment, please refer to the [installation instructions](3-netbox.md#set-up-python-environment) for direction. - -We'll use systemd to control the daemonization of NetBox services. First, copy `contrib/netbox.service` and `contrib/netbox-rq.service` to the `/etc/systemd/system/` directory: - -```no-highlight -# cp contrib/*.service /etc/systemd/system/ -``` - -!!! note - You may need to modify the user that the systemd service runs as. Please verify the user for httpd on your specific release and edit both files to match your httpd service under user and group. The username could be "nobody", "nginx", "apache", "www-data", or something else. - -Then, start the `netbox` and `netbox-rq` services and enable them to initiate at boot time: - -```no-highlight -# systemctl daemon-reload -# systemctl start netbox netbox-rq -# systemctl enable netbox netbox-rq -``` - -You can use the command `systemctl status netbox` to verify that the WSGI service is running: - -``` -# systemctl status netbox.service -● netbox.service - NetBox WSGI Service - Loaded: loaded (/etc/systemd/system/netbox.service; enabled; vendor preset: enabled) - Active: active (running) since Sat 2020-10-24 19:23:40 UTC; 25s ago - Docs: https://docs.netbox.dev/ - Main PID: 11993 (gunicorn) - Tasks: 6 (limit: 2362) - CGroup: /system.slice/netbox.service - ├─11993 /opt/netbox/venv/bin/python3 /opt/netbox/venv/bin/gunicorn --pid /var/tmp/netbox.pid --pythonpath /opt/netbox/... - ├─12015 /opt/netbox/venv/bin/python3 /opt/netbox/venv/bin/gunicorn --pid /var/tmp/netbox.pid --pythonpath /opt/netbox/... - ├─12016 /opt/netbox/venv/bin/python3 /opt/netbox/venv/bin/gunicorn --pid /var/tmp/netbox.pid --pythonpath /opt/netbox/... -... -``` - -At this point, you should be able to connect to the HTTP service at the server name or IP address you provided. If you are unable to connect, check that the nginx service is running and properly configured. If you receive a 502 (bad gateway) error, this indicates that gunicorn is misconfigured or not running. Issue the command `journalctl -xe` to see why the services were unable to start. - -!!! info - Please keep in mind that the configurations provided here are bare minimums required to get NetBox up and running. You may want to make adjustments to better suit your production environment. diff --git a/mkdocs.yml b/mkdocs.yml index 992859d66..6471783e0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -58,7 +58,7 @@ markdown_extensions: alternate_style: true nav: - Introduction: 'introduction.md' - - Installation: + - Installation & Upgrade: - Installing NetBox: 'installation/index.md' - 1. PostgreSQL: 'installation/1-postgresql.md' - 2. Redis: 'installation/2-redis.md' @@ -67,7 +67,6 @@ nav: - 5. HTTP Server: 'installation/5-http-server.md' - 6. LDAP (Optional): 'installation/6-ldap.md' - Upgrading NetBox: 'installation/upgrading.md' - - Migrating to systemd: 'installation/migrating-to-systemd.md' - Configuration: - Configuring NetBox: 'configuration/index.md' - Required Settings: 'configuration/required-settings.md' @@ -75,20 +74,6 @@ nav: - Dynamic Settings: 'configuration/dynamic-settings.md' - Error Reporting: 'configuration/error-reporting.md' - Remote Authentication: 'configuration/remote-authentication.md' - - Core Functionality: - - IP Address Management: 'core-functionality/ipam.md' - - VLAN Management: 'core-functionality/vlans.md' - - Sites and Racks: 'core-functionality/sites-and-racks.md' - - Devices and Cabling: 'core-functionality/devices.md' - - Device Types: 'core-functionality/device-types.md' - - Modules: 'core-functionality/modules.md' - - Virtualization: 'core-functionality/virtualization.md' - - Service Mapping: 'core-functionality/services.md' - - Circuits: 'core-functionality/circuits.md' - - Wireless: 'core-functionality/wireless.md' - - Power Tracking: 'core-functionality/power.md' - - Tenancy: 'core-functionality/tenancy.md' - - Contacts: 'core-functionality/contacts.md' - Customization: - Custom Fields: 'customization/custom-fields.md' - Custom Validation: 'customization/custom-validation.md' @@ -135,6 +120,90 @@ nav: - Authentication: 'rest-api/authentication.md' - GraphQL API: - Overview: 'graphql-api/overview.md' + - Data Model: + - Circuits: + - Circuit: 'models/circuits/circuit.md' + - Circuit Termination: 'models/circuits/circuittermination.md' + - Circuit Type: 'models/circuits/circuittype.md' + - Provider: 'models/circuits/provider.md' + - Provider Network: 'models/circuits/providernetwork.md' + - DCIM: + - Cable: 'models/dcim/cable.md' + - CablePath: 'models/dcim/cablepath.md' + - CableTermination: 'models/dcim/cabletermination.md' + - ConsolePort: 'models/dcim/consoleport.md' + - ConsolePortTemplate: 'models/dcim/consoleporttemplate.md' + - ConsoleServerPort: 'models/dcim/consoleserverport.md' + - ConsoleServerPortTemplate: 'models/dcim/consoleserverporttemplate.md' + - Device: 'models/dcim/device.md' + - DeviceBay: 'models/dcim/devicebay.md' + - DeviceBayTemplate: 'models/dcim/devicebaytemplate.md' + - DeviceRole: 'models/dcim/devicerole.md' + - DeviceType: 'models/dcim/devicetype.md' + - FrontPort: 'models/dcim/frontport.md' + - FrontPortTemplate: 'models/dcim/frontporttemplate.md' + - Interface: 'models/dcim/interface.md' + - InterfaceTemplate: 'models/dcim/interfacetemplate.md' + - InventoryItem: 'models/dcim/inventoryitem.md' + - InventoryItemRole: 'models/dcim/inventoryitemrole.md' + - InventoryItemTemplate: 'models/dcim/inventoryitemtemplate.md' + - Location: 'models/dcim/location.md' + - Manufacturer: 'models/dcim/manufacturer.md' + - Module: 'models/dcim/module.md' + - ModuleBay: 'models/dcim/modulebay.md' + - ModuleBayTemplate: 'models/dcim/modulebaytemplate.md' + - ModuleType: 'models/dcim/moduletype.md' + - Platform: 'models/dcim/platform.md' + - PowerFeed: 'models/dcim/powerfeed.md' + - PowerOutlet: 'models/dcim/poweroutlet.md' + - PowerOutletTemplate: 'models/dcim/poweroutlettemplate.md' + - PowerPanel: 'models/dcim/powerpanel.md' + - PowerPort: 'models/dcim/powerport.md' + - PowerPortTemplate: 'models/dcim/powerporttemplate.md' + - Rack: 'models/dcim/rack.md' + - RackReservation: 'models/dcim/rackreservation.md' + - RackRole: 'models/dcim/rackrole.md' + - RearPort: 'models/dcim/rearport.md' + - RearPortTemplate: 'models/dcim/rearporttemplate.md' + - Region: 'models/dcim/region.md' + - Site: 'models/dcim/site.md' + - SiteGroup: 'models/dcim/sitegroup.md' + - VirtualChassis: 'models/dcim/virtualchassis.md' + - IPAM: + - ASN: 'models/ipam/asn.md' + - Aggregate: 'models/ipam/aggregate.md' + - FHRPGroup: 'models/ipam/fhrpgroup.md' + - FHRPGroupAssignment: 'models/ipam/fhrpgroupassignment.md' + - IPAddress: 'models/ipam/ipaddress.md' + - IPRange: 'models/ipam/iprange.md' + - L2VPN: 'models/ipam/l2vpn.md' + - L2VPNTermination: 'models/ipam/l2vpntermination.md' + - Prefix: 'models/ipam/prefix.md' + - RIR: 'models/ipam/rir.md' + - Role: 'models/ipam/role.md' + - RouteTarget: 'models/ipam/routetarget.md' + - Service: 'models/ipam/service.md' + - ServiceTemplate: 'models/ipam/servicetemplate.md' + - VLAN: 'models/ipam/vlan.md' + - VLANGroup: 'models/ipam/vlangroup.md' + - VRF: 'models/ipam/vrf.md' + - Tenancy: + - Contact: 'models/tenancy/contact.md' + - ContactAssignment: 'models/tenancy/contactassignment.md' + - ContactGroup: 'models/tenancy/contactgroup.md' + - ContactRole: 'models/tenancy/contactrole.md' + - Tenant: 'models/tenancy/tenant.md' + - TenantGroup: 'models/tenancy/tenantgroup.md' + - Virtualization: + - Cluster: 'models/virtualization/cluster.md' + - ClusterGroup: 'models/virtualization/clustergroup.md' + - ClusterType: 'models/virtualization/clustertype.md' + - VMInterface: 'models/virtualization/vminterface.md' + - VirtualMachine: 'models/virtualization/virtualmachine.md' + - Wireless: + - WirelessLAN: 'models/wireless/wirelesslan.md' + - WirelessLANGroup: 'models/wireless/wirelesslangroup.md' + - WirelessLink: 'models/wireless/wirelesslink.md' - Reference: - Conditions: 'reference/conditions.md' - Markdown: 'reference/markdown.md' From 890efa5400b0325fc32ccbd4946a554a78566447 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Fri, 29 Jul 2022 11:55:26 -0500 Subject: [PATCH 313/593] Fixes #9062 - Add/edit {module} substitution to help text for component template name --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/forms/object_create.py | 8 ++++++++ netbox/dcim/models/device_component_templates.py | 5 ++++- 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index c0c99bb73..ce8552b0b 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -4,6 +4,7 @@ ### Enhancements +* [#9062](https://github.com/netbox-community/netbox/issues/9062) - Add/edit {module} substitution to help text for component template name * [#9762](https://github.com/netbox-community/netbox/issues/9762) - Add `nat_outside` column to the IPAddress table * [#9825](https://github.com/netbox-community/netbox/issues/9825) - Add contacts column to virtual machines table diff --git a/netbox/dcim/forms/object_create.py b/netbox/dcim/forms/object_create.py index 8c9ddab19..d2c941b34 100644 --- a/netbox/dcim/forms/object_create.py +++ b/netbox/dcim/forms/object_create.py @@ -64,6 +64,14 @@ class ModularComponentTemplateCreateForm(ComponentCreateForm): """ Creation form for component templates that can be assigned to either a DeviceType *or* a ModuleType. """ + name_pattern = ExpandableNameField( + label='Name', + help_text=""" + Alphanumeric ranges are supported for bulk creation. Mixed cases and types within a single range + are not supported. Example: [ge,xe]-0/0/[0-9]. {module} is accepted as a substitution for + the module bay position. + """ + ) device_type = DynamicModelChoiceField( queryset=DeviceType.objects.all(), required=False diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index 92658d310..ac0738b3f 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -39,7 +39,10 @@ class ComponentTemplateModel(WebhooksMixin, ChangeLoggedModel): related_name='%(class)ss' ) name = models.CharField( - max_length=64 + max_length=64, + help_text=""" + {module} is accepted as a substitution for the module bay position when attached to a module type. + """ ) _name = NaturalOrderingField( target_field='name', From b1ce8bd222a7b39bcacbe1d66ce5ab69f11dfe8e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 29 Jul 2022 13:45:59 -0400 Subject: [PATCH 314/593] Started "getting started" guide --- docs/getting-started/planning.md | 87 +++++++++++++++++++++++++ docs/getting-started/populating-data.md | 42 ++++++++++++ mkdocs.yml | 3 + 3 files changed, 132 insertions(+) create mode 100644 docs/getting-started/planning.md create mode 100644 docs/getting-started/populating-data.md diff --git a/docs/getting-started/planning.md b/docs/getting-started/planning.md new file mode 100644 index 000000000..00640ca44 --- /dev/null +++ b/docs/getting-started/planning.md @@ -0,0 +1,87 @@ +# Planning Your Move + +This guide outlines the steps necessary for planning a successful migration to NetBox. Although it is written under the context of a completely new installation, the general approach outlined here works just as well for adding new data to existing NetBox deployments. + +## Identify Current Sources of Truth + +Before beginning to use NetBox for your own data, it's crucial to first understand where your existing sources of truth reside. A "source of truth" is really just any repository of data that is authoritative for a given domain. For example, you may have a spreadsheet which tracks all IP prefixes in use on your network. So long as everyone involved agrees that this spreadsheet is _authoritative_ for the entire network, it is your source of truth for IP prefixes. + +Anything can be a source of truth, provided it meets two conditions: + +1. It is agreed upon by all relevant parties that this source of data is correct. +2. The domain to which it applies is well-defined. + + + +Dedicate some time to take stock of your own sources of truth for your infrastructure. Upon attempting to catalog these, you're very likely to encounter some challenges, such as: + +* **Multiple conflicting sources** for a given domain. For example, there may be multiple versions of a spreadsheet circulating, each of which asserts a conflicting set of data. +* **Sources with no domain defined.** You may encounter that different teams within your organization use different tools for the same purpose, with no normal definition of when either should be used. +* **Inaccessible data formatting.** Some tools are better suited for programmatic usage than others. For example, spreadsheets are generally very easy to parse and export, however free-form notes on wiki or similar application are much more difficult to consume. +* **There is no source of truth.** Sometimes you'll find that a source of truth simply doesn't exist for a domain. For example, when assigning IP addresses, operators may be just using any (presumed) available IP from a subnet without ever recording its usage. + +See if you can identify each domain of infrastructure data for your organization, and the source of truth for each. Once you have these compiled, you'll need to determine what belongs in NetBox. + +## Determine What to Move + +The general rule when determining what data to put into NetBox is this: If there's a model for it, it belongs in NetBox. For instance, NetBox has purpose-built models for racks, devices, cables, IP prefixes, VLANs, and so on. These are very straightforward to use. However, you'll inevitably reach the limits of NetBox's data model and question what additional data might make sense to record in NetBox. For example, you might wonder whether NetBox should function as the source of truth for infrastructure DNS records or DHCP scopes. + +NetBox provides two core mechanisms for extending its data model. The first is custom fields: Most models in NetBox support the addition of custom fields to hold additional data for which a built-in field does not exist. For example, you might wish to add an "inventory ID" field to the device model. The second mechanism is plugins. Users can create their own plugins to introduce entirely new models, views, and API endpoints in NetBox. This can be incredibly powerful, as it enables rapid development and tight integration with core models. + +That said, it doesn't always make sense to migrate a domain of data to NetBox. For example, many organizations opt to use only the IPAM components or only the DCIM components of NetBox, and integrate with other sources of truth for different domains. This is an entirely valid approach (so long as everyone involved agrees which tool is authoritative for each domain). Ultimately, you'll need to weigh the value of having non-native data models in NetBox against the effort required to define and maintain those models. + +Consider also that NetBox is under constant development. Although the current release might not support a particular type of object, there may be plans to add support for it in a future release. (And if there aren't, consider submitting a feature request citing your use case.) + +## Validate Existing Data + +The last step before migrating data to NetBox is the most crucial: **validation**. The GIGO (garbage in, garbage out) principle is in full effect: Your source of truth is only as good as the data it holds. While NetBox has very powerful data validation tools (including support for custom validation rules), ultimately the onus falls to a human operator to assert what is correct and what is not. For example, NetBox can validate the connection of a cable between two interfaces, but it cannot say whether the cable _should_ be there. + +Here are some tips to help ensure you're only importing valid data into NetBox: + +* Ensure you're starting with complete, well-formatted data. JSON or CSV is highly recommended for the best portability. +* Consider defining custom validation rules in NetBox prior to import. (For example, to enforce device naming schemes.) +* Use custom scripts to automatically populate patterned data. (For example, to automatically create a set of standard VLANs for each site.) + +There are several methods available to import data into NetBox, which we'll cover in the next section. + +## Order of Operations + +When starting with a completely empty database, it might not be immediately clear where to begin. Many models in NetBox rely on the advance creation of other types. For example, you cannot create a device type until after you have created its manufacturer. + +Below is the (rough) recommended order in which NetBox objects should be created or imported. While it is not required to follow this exact order, doing so will help ensure the smoothest workflow. + + + +1. Tenant groups +2. Tenants +3. Regions and/or site groups +4. Sites +5. Locations +6. Rack roles +7. Racks +8. Platforms +9. Manufacturers +10. Device types +11. Module types +12. Device roles +13. Devices +14. Providers +15. Provider networks +16. Circuit types +17. Circuits +18. Wireless LAN groups +19. Wireless LANs & links +20. Route targets +21. VRFs +22. RIRs +23. Aggregates +24. IP/VLAN roles +25. Prefixes +26. IP ranges & addresses +27. VLAN groups +28. VLANs +29. Services +30. Clusters +31. Virtual machines +32. VM interfaces +33. L2 VPNs diff --git a/docs/getting-started/populating-data.md b/docs/getting-started/populating-data.md new file mode 100644 index 000000000..e182a9d52 --- /dev/null +++ b/docs/getting-started/populating-data.md @@ -0,0 +1,42 @@ +# Populating Data + +This section covers the mechanisms which are available to populate data in NetBox. + +## Manual Object Creation + +The simplest and most direct way of populating data in NetBox is to use the object creation forms in the user interface. + +!!! warning "Not Ideal for Large Imports" + While convenient and readily accessible to even novice users, creating objects one at a time by manually completing these forms obviously does not scale well. For large imports, you're generally best served by using one of the other methods discussed in this section. + +To create a new object in NetBox, find the object type in the navigation menu and click the green "Add" button. + +!!! info "Missing Button?" + If you don't see an "add" button for certain object types, it's likely that your account does not have sufficient permission to create these types. Ask your NetBox administrator to grant the required permissions. + + Also note that some object types, such as device components, cannot be created directly from the navigation menu. These must be created within the context of a parent object (such as a parent device). + + + +## Bulk Import (CSV/YAML) + +NetBox supports the bulk import of new objects using CSV-formatted data. This method can be ideal for importing spreadsheet data, which is very easy to convert to CSV data. CSV data can be imported either as raw text using the form field, or by uploading a properly formatted CSV file. + +When viewing the CSV import form for an object type, you'll notice that the headers for the required columns have been pre-populated. Each form has a table beneath it titled "CSV Field Options," which lists _all_ supported columns for your reference. (Generally, these map to the fields you see in the corresponding creation form for individual objects.) + + + +Note that some models (namely device types and module types) do not support CSV import. Instead, they accept YAML-formatted data to facilitate the import of both the parent object as well as child components. + +## Scripting + +Sometimes you'll find that data you need to populate in NetBox can be easily reduced to a pattern. For example, suppose you have one hundred branch sites and each site gets five VLANs, numbered 101 through 105. While it's certainly possible to explicitly define each of these 500 VLANs in a CSV file for import, it may be quicker to draft a simple custom script to automatically create these VLANs according to the pattern. This ensures a high degree of confidence in the validity of the data, since it's impossible for a script to "miss" a VLAN here or there. + +!!! tip "Reconstruct Existing Data with Scripts" + Sometimes, you might want to write a script to populate objects even if you have the necessary data ready for import. This is because using a script eliminates the need to manually verify existing data prior to import. + +## REST API + +You can also use the REST API to facilitate the population of data in NetBox. The REST API offers full programmatic control over the creation of objects, subject to the same validation rules enforced by the UI forms. Additionally, the REST API supports the bulk creation of multiple objects using a single request. + +For more information about this option, see the [REST API documentation](../rest-api/overview.md). diff --git a/mkdocs.yml b/mkdocs.yml index 6471783e0..2203b8934 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -67,6 +67,9 @@ nav: - 5. HTTP Server: 'installation/5-http-server.md' - 6. LDAP (Optional): 'installation/6-ldap.md' - Upgrading NetBox: 'installation/upgrading.md' + - Getting Started: + - Planning: 'getting-started/planning.md' + - Populating Data: 'getting-started/populating-data.md' - Configuration: - Configuring NetBox: 'configuration/index.md' - Required Settings: 'configuration/required-settings.md' From a6c431f3ba236760ab753f92b8b7aec16c07c568 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 29 Jul 2022 15:10:50 -0400 Subject: [PATCH 315/593] Reorganize configuration docs --- docs/additional-features/napalm.md | 2 +- docs/administration/housekeeping.md | 4 +- docs/configuration/data-validation.md | 86 +++ docs/configuration/date-time.md | 20 + docs/configuration/default-values.md | 77 +++ docs/configuration/development.md | 21 + docs/configuration/dynamic-settings.md | 232 --------- docs/configuration/index.md | 44 +- docs/configuration/miscellaneous.md | 159 ++++++ docs/configuration/napalm.md | 51 ++ docs/configuration/optional-settings.md | 489 ------------------ docs/configuration/plugins.md | 35 ++ docs/configuration/remote-authentication.md | 32 +- ...red-settings.md => required-parameters.md} | 0 docs/configuration/security.md | 144 ++++++ docs/configuration/system.md | 178 +++++++ docs/customization/custom-validation.md | 2 +- docs/customization/export-templates.md | 2 +- docs/customization/reports.md | 2 +- docs/graphql-api/overview.md | 2 +- docs/installation/3-netbox.md | 6 +- docs/installation/6-ldap.md | 2 +- docs/plugins/development/models.md | 2 +- docs/release-notes/version-3.0.md | 2 +- docs/release-notes/version-3.1.md | 2 - docs/release-notes/version-3.2.md | 4 +- docs/rest-api/authentication.md | 2 +- docs/rest-api/overview.md | 4 +- mkdocs.yml | 15 +- 29 files changed, 851 insertions(+), 770 deletions(-) create mode 100644 docs/configuration/data-validation.md create mode 100644 docs/configuration/date-time.md create mode 100644 docs/configuration/default-values.md create mode 100644 docs/configuration/development.md delete mode 100644 docs/configuration/dynamic-settings.md create mode 100644 docs/configuration/miscellaneous.md create mode 100644 docs/configuration/napalm.md delete mode 100644 docs/configuration/optional-settings.md create mode 100644 docs/configuration/plugins.md rename docs/configuration/{required-settings.md => required-parameters.md} (100%) create mode 100644 docs/configuration/security.md create mode 100644 docs/configuration/system.md diff --git a/docs/additional-features/napalm.md b/docs/additional-features/napalm.md index 2387bc8b7..60d8014e2 100644 --- a/docs/additional-features/napalm.md +++ b/docs/additional-features/napalm.md @@ -29,7 +29,7 @@ GET /api/dcim/devices/1/napalm/?method=get_environment ## Authentication -By default, the [`NAPALM_USERNAME`](../configuration/dynamic-settings.md#napalm_username) and [`NAPALM_PASSWORD`](../configuration/dynamic-settings.md#napalm_password) configuration parameters are used for NAPALM authentication. They can be overridden for an individual API call by specifying the `X-NAPALM-Username` and `X-NAPALM-Password` headers. +By default, the [`NAPALM_USERNAME`](../configuration/napalm.md#napalm_username) and [`NAPALM_PASSWORD`](../configuration/napalm.md#napalm_password) configuration parameters are used for NAPALM authentication. They can be overridden for an individual API call by specifying the `X-NAPALM-Username` and `X-NAPALM-Password` headers. ``` $ curl "http://localhost/api/dcim/devices/1/napalm/?method=get_environment" \ diff --git a/docs/administration/housekeeping.md b/docs/administration/housekeeping.md index 1989e41c0..da1a5443b 100644 --- a/docs/administration/housekeeping.md +++ b/docs/administration/housekeeping.md @@ -3,8 +3,8 @@ NetBox includes a `housekeeping` management command that should be run nightly. This command handles: * 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) +* Deleting changelog records older than the configured [retention time](../configuration/miscellaneous.md#changelog_retention) +* Deleting job result records older than the configured [retention time](../configuration/miscellaneous.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/data-validation.md b/docs/configuration/data-validation.md new file mode 100644 index 000000000..e4eb4baff --- /dev/null +++ b/docs/configuration/data-validation.md @@ -0,0 +1,86 @@ +# Data & Validation Parameters + +## CUSTOM_VALIDATORS + +!!! tip "Dynamic Configuration Parameter" + +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: + +```python +CUSTOM_VALIDATORS = { + "dcim.site": [ + { + "name": { + "min_length": 5, + "max_length": 30 + } + }, + "my_plugin.validators.Validator1" + ], + "dim.device": [ + "my_plugin.validators.Validator1" + ] +} +``` + +--- + +## FIELD_CHOICES + +Some static choice fields on models can be configured with custom values. This is done by defining `FIELD_CHOICES` as a dictionary mapping model fields to their choices. Each choice in the list must have a database value and a human-friendly label, and may optionally specify a color. (A list of available colors is provided below.) + +The choices provided can either replace the stock choices provided by NetBox, or append to them. To _replace_ the available choices, specify the app, model, and field name separated by dots. For example, the site model would be referenced as `dcim.Site.status`. To _extend_ the available choices, append a plus sign to the end of this string (e.g. `dcim.Site.status+`). + +For example, the following configuration would replace the default site status choices with the options Foo, Bar, and Baz: + +```python +FIELD_CHOICES = { + 'dcim.Site.status': ( + ('foo', 'Foo', 'red'), + ('bar', 'Bar', 'green'), + ('baz', 'Baz', 'blue'), + ) +} +``` + +Appending a plus sign to the field identifier would instead _add_ these choices to the ones already offered: + +```python +FIELD_CHOICES = { + 'dcim.Site.status+': ( + ... + ) +} +``` + +The following model fields support configurable choices: + +* `circuits.Circuit.status` +* `dcim.Device.status` +* `dcim.Location.status` +* `dcim.PowerFeed.status` +* `dcim.Rack.status` +* `dcim.Site.status` +* `extras.JournalEntry.kind` +* `ipam.IPAddress.status` +* `ipam.IPRange.status` +* `ipam.Prefix.status` +* `ipam.VLAN.status` +* `virtualization.Cluster.status` +* `virtualization.VirtualMachine.status` + +The following colors are supported: + +* `blue` +* `indigo` +* `purple` +* `pink` +* `red` +* `orange` +* `yellow` +* `green` +* `teal` +* `cyan` +* `gray` +* `black` +* `white` diff --git a/docs/configuration/date-time.md b/docs/configuration/date-time.md new file mode 100644 index 000000000..ab8b5ad13 --- /dev/null +++ b/docs/configuration/date-time.md @@ -0,0 +1,20 @@ +# Date & Time Parameters + +## TIME_ZONE + +Default: UTC + +The time zone NetBox will use when dealing with dates and times. It is recommended to use UTC time unless you have a specific need to use a local time zone. Please see the [list of available time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). + +## Date and Time Formatting + +You may define custom formatting for date and times. For detailed instructions on writing format strings, please see [the Django documentation](https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date). Default formats are listed below. + +```python +DATE_FORMAT = 'N j, Y' # June 26, 2016 +SHORT_DATE_FORMAT = 'Y-m-d' # 2016-06-26 +TIME_FORMAT = 'g:i a' # 1:23 p.m. +SHORT_TIME_FORMAT = 'H:i:s' # 13:23:00 +DATETIME_FORMAT = 'N j, Y g:i a' # June 26, 2016 1:23 p.m. +SHORT_DATETIME_FORMAT = 'Y-m-d H:i' # 2016-06-26 13:23 +``` diff --git a/docs/configuration/default-values.md b/docs/configuration/default-values.md new file mode 100644 index 000000000..6d92858eb --- /dev/null +++ b/docs/configuration/default-values.md @@ -0,0 +1,77 @@ +# Default Value Parameters + +## DEFAULT_USER_PREFERENCES + +!!! tip "Dynamic Configuration Parameter" + +This is a dictionary defining the default preferences to be set for newly-created user accounts. For example, to set the default page size for all users to 100, define the following: + +```python +DEFAULT_USER_PREFERENCES = { + "pagination": { + "per_page": 100 + } +} +``` + +For a complete list of available preferences, log into NetBox and navigate to `/user/preferences/`. A period in a preference name indicates a level of nesting in the JSON data. The example above maps to `pagination.per_page`. + +--- + +## PAGINATE_COUNT + +!!! tip "Dynamic Configuration Parameter" + +Default: 50 + +The default maximum number of objects to display per page within each list of objects. + +--- + +## POWERFEED_DEFAULT_AMPERAGE + +!!! tip "Dynamic Configuration Parameter" + +Default: 15 + +The default value for the `amperage` field when creating new power feeds. + +--- + +## POWERFEED_DEFAULT_MAX_UTILIZATION + +!!! tip "Dynamic Configuration Parameter" + +Default: 80 + +The default value (percentage) for the `max_utilization` field when creating new power feeds. + +--- + +## POWERFEED_DEFAULT_VOLTAGE + +!!! tip "Dynamic Configuration Parameter" + +Default: 120 + +The default value for the `voltage` field when creating new power feeds. + +--- + +## RACK_ELEVATION_DEFAULT_UNIT_HEIGHT + +!!! tip "Dynamic Configuration Parameter" + +Default: 22 + +Default height (in pixels) of a unit within a rack elevation. For best results, this should be approximately one tenth of `RACK_ELEVATION_DEFAULT_UNIT_WIDTH`. + +--- + +## RACK_ELEVATION_DEFAULT_UNIT_WIDTH + +!!! tip "Dynamic Configuration Parameter" + +Default: 220 + +Default width (in pixels) of a unit within a rack elevation. diff --git a/docs/configuration/development.md b/docs/configuration/development.md new file mode 100644 index 000000000..3af56b0e3 --- /dev/null +++ b/docs/configuration/development.md @@ -0,0 +1,21 @@ +# Development Parameters + +## DEBUG + +Default: False + +This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only +clients which access NetBox from a recognized [internal IP address](#internal_ips) will see debugging tools in the user +interface. + +!!! warning + Never enable debugging on a production system, as it can expose sensitive data to unauthenticated users and impose a + substantial performance penalty. + +--- + +## DEVELOPER + +Default: False + +This parameter serves as a safeguard to prevent some potentially dangerous behavior, such as generating new database schema migrations. Set this to `True` **only** if you are actively developing the NetBox code base. diff --git a/docs/configuration/dynamic-settings.md b/docs/configuration/dynamic-settings.md deleted file mode 100644 index d376dc5c4..000000000 --- a/docs/configuration/dynamic-settings.md +++ /dev/null @@ -1,232 +0,0 @@ -# Dynamic Configuration Settings - -These configuration parameters are primarily controlled via NetBox's admin interface (under Admin > Extras > Configuration Revisions). These setting may also be overridden in `configuration.py`; this will prevent them from being modified via the UI. - ---- - -## ALLOWED_URL_SCHEMES - -Default: `('file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp')` - -A list of permitted URL schemes referenced when rendering links within NetBox. Note that only the schemes specified in this list will be accepted: If adding your own, be sure to replicate all of the default values as well (excluding those schemes which are not desirable). - ---- - -## BANNER_TOP - -## BANNER_BOTTOM - -Setting these variables will display custom content in a banner at the top and/or bottom of the page, respectively. HTML is allowed. To replicate the content of the top banner in the bottom banner, set: - -```python -BANNER_TOP = 'Your banner text' -BANNER_BOTTOM = BANNER_TOP -``` - ---- - -## BANNER_LOGIN - -This defines custom content to be displayed on the login page above the login form. HTML is allowed. - ---- - -## CHANGELOG_RETENTION - -Default: 90 - -The number of days to retain logged changes (object creations, updates, and deletions). Set this to `0` to retain -changes in the database indefinitely. - -!!! warning - If enabling indefinite changelog 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: - -```python -CUSTOM_VALIDATORS = { - "dcim.site": [ - { - "name": { - "min_length": 5, - "max_length": 30 - } - }, - "my_plugin.validators.Validator1" - ], - "dim.device": [ - "my_plugin.validators.Validator1" - ] -} -``` - ---- - -## DEFAULT_USER_PREFERENCES - -This is a dictionary defining the default preferences to be set for newly-created user accounts. For example, to set the default page size for all users to 100, define the following: - -```python -DEFAULT_USER_PREFERENCES = { - "pagination": { - "per_page": 100 - } -} -``` - -For a complete list of available preferences, log into NetBox and navigate to `/user/preferences/`. A period in a preference name indicates a level of nesting in the JSON data. The example above maps to `pagination.per_page`. - ---- - -## ENFORCE_GLOBAL_UNIQUE - -Default: False - -By default, NetBox will permit users to create duplicate prefixes and IP addresses in the global table (that is, those which are not assigned to any VRF). This behavior can be disabled by setting `ENFORCE_GLOBAL_UNIQUE` to True. - ---- - -## GRAPHQL_ENABLED - -Default: True - -Setting this to False will disable the GraphQL API. - ---- - -## JOBRESULT_RETENTION - -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. - -!!! warning - If enabling indefinite job results retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity. - ---- - -## MAINTENANCE_MODE - -Default: False - -Setting this to True will display a "maintenance mode" banner at the top of every page. Additionally, NetBox will no longer update a user's "last active" time upon login. This is to allow new logins when the database is in a read-only state. Recording of login times will resume when maintenance mode is disabled. - ---- - -## MAPS_URL - -Default: `https://maps.google.com/?q=` (Google Maps) - -This specifies the URL to use when presenting a map of a physical location by street address or GPS coordinates. The URL must accept either a free-form street address or a comma-separated pair of numeric coordinates appended to it. - ---- - -## MAX_PAGE_SIZE - -Default: 1000 - -A web user or API consumer can request an arbitrary number of objects by appending the "limit" parameter to the URL (e.g. `?limit=1000`). This parameter defines the maximum acceptable limit. Setting this to `0` or `None` will allow a client to retrieve _all_ matching objects at once with no limit by specifying `?limit=0`. - ---- - -## NAPALM_USERNAME - -## NAPALM_PASSWORD - -NetBox will use these credentials when authenticating to remote devices via the supported [NAPALM integration](../additional-features/napalm.md), if installed. Both parameters are optional. - -!!! note - If SSH public key authentication has been set up on the remote device(s) for the system account under which NetBox runs, these parameters are not needed. - ---- - -## NAPALM_ARGS - -A dictionary of optional arguments to pass to NAPALM when instantiating a network driver. See the NAPALM documentation for a [complete list of optional arguments](https://napalm.readthedocs.io/en/latest/support/#optional-arguments). An example: - -```python -NAPALM_ARGS = { - 'api_key': '472071a93b60a1bd1fafb401d9f8ef41', - 'port': 2222, -} -``` - -Some platforms (e.g. Cisco IOS) require an argument named `secret` to be passed in addition to the normal password. If desired, you can use the configured `NAPALM_PASSWORD` as the value for this argument: - -```python -NAPALM_USERNAME = 'username' -NAPALM_PASSWORD = 'MySecretPassword' -NAPALM_ARGS = { - 'secret': NAPALM_PASSWORD, - # Include any additional args here -} -``` - ---- - -## NAPALM_TIMEOUT - -Default: 30 seconds - -The amount of time (in seconds) to wait for NAPALM to connect to a device. - ---- - -## PAGINATE_COUNT - -Default: 50 - -The default maximum number of objects to display per page within each list of objects. - ---- - -## POWERFEED_DEFAULT_AMPERAGE - -Default: 15 - -The default value for the `amperage` field when creating new power feeds. - ---- - -## POWERFEED_DEFAULT_MAX_UTILIZATION - -Default: 80 - -The default value (percentage) for the `max_utilization` field when creating new power feeds. - ---- - -## POWERFEED_DEFAULT_VOLTAGE - -Default: 120 - -The default value for the `voltage` field when creating new power feeds. - ---- - -## PREFER_IPV4 - -Default: False - -When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to prefer IPv4 instead. - ---- - -## RACK_ELEVATION_DEFAULT_UNIT_HEIGHT - -Default: 22 - -Default height (in pixels) of a unit within a rack elevation. For best results, this should be approximately one tenth of `RACK_ELEVATION_DEFAULT_UNIT_WIDTH`. - ---- - -## RACK_ELEVATION_DEFAULT_UNIT_WIDTH - -Default: 220 - -Default width (in pixels) of a unit within a rack elevation. diff --git a/docs/configuration/index.md b/docs/configuration/index.md index a863ef3dc..42d254027 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -1,24 +1,50 @@ # NetBox Configuration -NetBox's local configuration is stored in `$INSTALL_ROOT/netbox/netbox/configuration.py` by default. An example configuration is provided as `configuration_example.py`. You may copy or rename the example configuration and make changes as appropriate. NetBox will not run without a configuration file. While NetBox has many configuration settings, only a few of them must be defined at the time of installation: these are defined under "required settings" below. +## Configuration File + +NetBox's configuration file contains all the important parameters which control how NetBox functions: database settings, security controls, user preferences, and so on. While the default configuration suffices out of the box for most use cases, there are a few [required parameters](./required-parameters.md) which **must** be defined during installation. + +The configuration file is loaded from `$INSTALL_ROOT/netbox/netbox/configuration.py` by default. An example configuration is provided at `configuration_example.py`, which you may copy to use as your default config. Note that a configuration file must be defined; NetBox will not run without one. !!! info "Customizing the Configuration Module" A custom configuration module may be specified by setting the `NETBOX_CONFIGURATION` environment variable. This must be a dotted path to the desired Python module. For example, a file named `my_config.py` in the same directory as `settings.py` would be referenced as `netbox.my_config`. - For the sake of brevity, the NetBox documentation refers to the configuration file simply as `configuration.py`. + To keep things simple, the NetBox documentation refers to the configuration file simply as `configuration.py`. Some configuration parameters may alternatively be defined either in `configuration.py` or within the administrative section of the user interface. Settings which are "hard-coded" in the configuration file take precedence over those defined via the UI. -## Configuration Parameters +## Dynamic Configuration Parameters -* [Required settings](required-settings.md) -* [Optional settings](optional-settings.md) -* [Dynamic settings](dynamic-settings.md) -* [Remote authentication settings](remote-authentication.md) +Some configuration parameters are primarily controlled via NetBox's admin interface (under Admin > Extras > Configuration Revisions). These are noted where applicable in the documentation. These settings may also be overridden in `configuration.py` to prevent them from being modified via the UI. A complete list of supported parameters is provided below: -## Changing the Configuration +* [`ALLOWED_URL_SCHEMES`](./security.md#allowed_url_schemes) +* [`BANNER_BOTTOM`](./miscellaneous.md#banner_bottom) +* [`BANNER_LOGIN`](./miscellaneous.md#banner_login) +* [`BANNER_TOP`](./miscellaneous.md#banner_top) +* [`CHANGELOG_RETENTION`](./miscellaneous.md#changelog_retention) +* [`CUSTOM_VALIDATORS`](./data-validation.md#custom_validators) +* [`DEFAULT_USER_PREFERENCES`](./default-values.md#default_user_preferences) +* [`ENFORCE_GLOBAL_UNIQUE`](./miscellaneous.md#enforce_global_unique) +* [`GRAPHQL_ENABLED`](./miscellaneous.md#graphql_enabled) +* [`JOBRESULT_RETENTION`](./miscellaneous.md#jobresult_retention) +* [`MAINTENANCE_MODE`](./miscellaneous.md#maintenance_mode) +* [`MAPS_URL`](./miscellaneous.md#maps_url) +* [`MAX_PAGE_SIZE`](./miscellaneous.md#max_page_size) +* [`NAPALM_ARGS`](./napalm.md#napalm_args) +* [`NAPALM_PASSWORD`](./napalm.md#napalm_password) +* [`NAPALM_TIMEOUT`](./napalm.md#napalm_timeout) +* [`NAPALM_USERNAME`](./napalm.md#napalm_username) +* [`PAGINATE_COUNT`](./default-values.md#paginate_count) +* [`POWERFEED_DEFAULT_AMPERAGE`](./default-values.md#powerfeed_default_amperage) +* [`POWERFEED_DEFAULT_MAX_UTILIZATION`](./default-values.md#powerfeed_default_max_utilization) +* [`POWERFEED_DEFAULT_VOLTAGE`](./default-values.md#powerfeed_default_voltage) +* [`PREFER_IPV4`](./miscellaneous.md#prefer_ipv4) +* [`RACK_ELEVATION_DEFAULT_UNIT_HEIGHT`](./default-values.md#rack_elevation_default_unit_height) +* [`RACK_ELEVATION_DEFAULT_UNIT_WIDTH`](./default-values.md#rack_elevation_default_unit_width) -The configuration file may be modified at any time. However, the WSGI service (e.g. Gunicorn) must be restarted before the changes will take effect: +## Modifying the Configuration + +The configuration file may be modified at any time. However, the WSGI service (e.g. Gunicorn) must be restarted before these changes will take effect: ```no-highlight $ sudo systemctl restart netbox diff --git a/docs/configuration/miscellaneous.md b/docs/configuration/miscellaneous.md new file mode 100644 index 000000000..2aa21b7e5 --- /dev/null +++ b/docs/configuration/miscellaneous.md @@ -0,0 +1,159 @@ +# Miscellaneous Parameters + +## ADMINS + +NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example: + +```python +ADMINS = [ + ['Hank Hill', 'hhill@example.com'], + ['Dale Gribble', 'dgribble@example.com'], +] +``` + +--- + +## BANNER_BOTTOM + +!!! tip "Dynamic Configuration Parameter" + +Sets content for the bottom banner in the user interface. + +--- + +## BANNER_LOGIN + +!!! tip "Dynamic Configuration Parameter" + +This defines custom content to be displayed on the login page above the login form. HTML is allowed. + +--- + +## BANNER_TOP + +!!! tip "Dynamic Configuration Parameter" + +Sets content for the top banner in the user interface. + +!!! tip + If you'd like the top and bottom banners to match, set the following: + + ```python + BANNER_TOP = 'Your banner text' + BANNER_BOTTOM = BANNER_TOP + ``` + +--- + +## CHANGELOG_RETENTION + +!!! tip "Dynamic Configuration Parameter" + +Default: 90 + +The number of days to retain logged changes (object creations, updates, and deletions). Set this to `0` to retain +changes in the database indefinitely. + +!!! warning + If enabling indefinite changelog retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity. + +--- + +## ENFORCE_GLOBAL_UNIQUE + +!!! tip "Dynamic Configuration Parameter" + +Default: False + +By default, NetBox will permit users to create duplicate prefixes and IP addresses in the global table (that is, those which are not assigned to any VRF). This behavior can be disabled by setting `ENFORCE_GLOBAL_UNIQUE` to True. + +--- + +## GRAPHQL_ENABLED + +!!! tip "Dynamic Configuration Parameter" + +Default: True + +Setting this to False will disable the GraphQL API. + +--- + +## JOBRESULT_RETENTION + +!!! tip "Dynamic Configuration Parameter" + +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. + +!!! warning + If enabling indefinite job results retention, it is recommended to periodically delete old entries. Otherwise, the database may eventually exceed capacity. + +--- + +## MAINTENANCE_MODE + +!!! tip "Dynamic Configuration Parameter" + +Default: False + +Setting this to True will display a "maintenance mode" banner at the top of every page. Additionally, NetBox will no longer update a user's "last active" time upon login. This is to allow new logins when the database is in a read-only state. Recording of login times will resume when maintenance mode is disabled. + +--- + +## MAPS_URL + +!!! tip "Dynamic Configuration Parameter" + +Default: `https://maps.google.com/?q=` (Google Maps) + +This specifies the URL to use when presenting a map of a physical location by street address or GPS coordinates. The URL must accept either a free-form street address or a comma-separated pair of numeric coordinates appended to it. + +--- + +## MAX_PAGE_SIZE + +!!! tip "Dynamic Configuration Parameter" + +Default: 1000 + +A web user or API consumer can request an arbitrary number of objects by appending the "limit" parameter to the URL (e.g. `?limit=1000`). This parameter defines the maximum acceptable limit. Setting this to `0` or `None` will allow a client to retrieve _all_ matching objects at once with no limit by specifying `?limit=0`. + +--- + +## METRICS_ENABLED + +Default: False + +Toggle the availability Prometheus-compatible metrics at `/metrics`. See the [Prometheus Metrics](../additional-features/prometheus-metrics.md) documentation for more details. + +--- + +## PREFER_IPV4 + +!!! tip "Dynamic Configuration Parameter" + +Default: False + +When determining the primary IP address for a device, IPv6 is preferred over IPv4 by default. Set this to True to prefer IPv4 instead. + +--- + +## RELEASE_CHECK_URL + +Default: None (disabled) + +This parameter defines the URL of the repository that will be checked for new NetBox releases. When a new release is detected, a message will be displayed to administrative users on the home page. This can be set to the official repository (`'https://api.github.com/repos/netbox-community/netbox/releases'`) or a custom fork. Set this to `None` to disable automatic update checks. + +!!! note + The URL provided **must** be compatible with the [GitHub REST API](https://docs.github.com/en/rest). + +--- + +## RQ_DEFAULT_TIMEOUT + +Default: `300` + +The maximum execution time of a background task (such as running a custom script), in seconds. diff --git a/docs/configuration/napalm.md b/docs/configuration/napalm.md new file mode 100644 index 000000000..925ec17e6 --- /dev/null +++ b/docs/configuration/napalm.md @@ -0,0 +1,51 @@ +# NAPALM Parameters + +## NAPALM_USERNAME + +## NAPALM_PASSWORD + +!!! tip "Dynamic Configuration Parameter" + +NetBox will use these credentials when authenticating to remote devices via the supported [NAPALM integration](../additional-features/napalm.md), if installed. Both parameters are optional. + +!!! note + If SSH public key authentication has been set up on the remote device(s) for the system account under which NetBox runs, these parameters are not needed. + +--- + +## NAPALM_ARGS + +!!! tip "Dynamic Configuration Parameter" + +A dictionary of optional arguments to pass to NAPALM when instantiating a network driver. See the NAPALM documentation for a [complete list of optional arguments](https://napalm.readthedocs.io/en/latest/support/#optional-arguments). An example: + +```python +NAPALM_ARGS = { + 'api_key': '472071a93b60a1bd1fafb401d9f8ef41', + 'port': 2222, +} +``` + +Some platforms (e.g. Cisco IOS) require an argument named `secret` to be passed in addition to the normal password. If desired, you can use the configured `NAPALM_PASSWORD` as the value for this argument: + +```python +NAPALM_USERNAME = 'username' +NAPALM_PASSWORD = 'MySecretPassword' +NAPALM_ARGS = { + 'secret': NAPALM_PASSWORD, + # Include any additional args here +} +``` + +--- + +## NAPALM_TIMEOUT + +!!! tip "Dynamic Configuration Parameter" + +Default: 30 seconds + +The amount of time (in seconds) to wait for NAPALM to connect to a device. + +--- + diff --git a/docs/configuration/optional-settings.md b/docs/configuration/optional-settings.md deleted file mode 100644 index 8e5664a95..000000000 --- a/docs/configuration/optional-settings.md +++ /dev/null @@ -1,489 +0,0 @@ -# Optional Configuration Settings - -## ADMINS - -NetBox will email details about critical errors to the administrators listed here. This should be a list of (name, email) tuples. For example: - -```python -ADMINS = [ - ['Hank Hill', 'hhill@example.com'], - ['Dale Gribble', 'dgribble@example.com'], -] -``` - ---- - -## AUTH_PASSWORD_VALIDATORS - -This parameter acts as a pass-through for configuring Django's built-in password validators for local user accounts. If configured, these will be applied whenever a user's password is updated to ensure that it meets minimum criteria such as length or complexity. An example is provided below. For more detail on the available options, please see [the Django documentation](https://docs.djangoproject.com/en/stable/topics/auth/passwords/#password-validation). - -```python -AUTH_PASSWORD_VALIDATORS = [ - { - 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', - 'OPTIONS': { - 'min_length': 10, - } - }, -] -``` - ---- - -## BASE_PATH - -Default: None - -The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: - -```python -BASE_PATH = 'netbox/' -``` - ---- - -## CORS_ORIGIN_ALLOW_ALL - -Default: False - -If True, cross-origin resource sharing (CORS) requests will be accepted from all origins. If False, a whitelist will be used (see below). - ---- - -## CORS_ORIGIN_WHITELIST - -## CORS_ORIGIN_REGEX_WHITELIST - -These settings specify a list of origins that are authorized to make cross-site API requests. Use -`CORS_ORIGIN_WHITELIST` to define a list of exact hostnames, or `CORS_ORIGIN_REGEX_WHITELIST` to define a set of regular -expressions. (These settings have no effect if `CORS_ORIGIN_ALLOW_ALL` is True.) For example: - -```python -CORS_ORIGIN_WHITELIST = [ - 'https://example.com', -] -``` - ---- - -## CSRF_COOKIE_NAME - -Default: `csrftoken` - -The name of the cookie to use for the cross-site request forgery (CSRF) authentication token. See the [Django documentation](https://docs.djangoproject.com/en/stable/ref/settings/#csrf-cookie-name) for more detail. - ---- - -## CSRF_TRUSTED_ORIGINS - -Default: `[]` - -Defines a list of trusted origins for unsafe (e.g. `POST`) requests. This is a pass-through to Django's [`CSRF_TRUSTED_ORIGINS`](https://docs.djangoproject.com/en/4.0/ref/settings/#std:setting-CSRF_TRUSTED_ORIGINS) setting. Note that each host listed must specify a scheme (e.g. `http://` or `https://). - -```python -CSRF_TRUSTED_ORIGINS = ( - 'http://netbox.local', - 'https://netbox.local', -) -``` - ---- - -## DEBUG - -Default: False - -This setting enables debugging. Debugging should be enabled only during development or troubleshooting. Note that only -clients which access NetBox from a recognized [internal IP address](#internal_ips) will see debugging tools in the user -interface. - -!!! warning - Never enable debugging on a production system, as it can expose sensitive data to unauthenticated users and impose a - substantial performance penalty. - ---- - -## DEVELOPER - -Default: False - -This parameter serves as a safeguard to prevent some potentially dangerous behavior, such as generating new database schema migrations. Set this to `True` **only** if you are actively developing the NetBox code base. - ---- - -## DOCS_ROOT - -Default: `$INSTALL_ROOT/docs/` - -The filesystem path to NetBox's documentation. This is used when presenting context-sensitive documentation in the web UI. By default, this will be the `docs/` directory within the root NetBox installation path. (Set this to `None` to disable the embedded documentation.) - ---- - -## EMAIL - -In order to send email, NetBox needs an email server configured. The following items can be defined within the `EMAIL` configuration parameter: - -* `SERVER` - Hostname or IP address of the email server (use `localhost` if running locally) -* `PORT` - TCP port to use for the connection (default: `25`) -* `USERNAME` - Username with which to authenticate -* `PASSSWORD` - Password with which to authenticate -* `USE_SSL` - Use SSL when connecting to the server (default: `False`) -* `USE_TLS` - Use TLS when connecting to the server (default: `False`) -* `SSL_CERTFILE` - Path to the PEM-formatted SSL certificate file (optional) -* `SSL_KEYFILE` - Path to the PEM-formatted SSL private key file (optional) -* `TIMEOUT` - Amount of time to wait for a connection, in seconds (default: `10`) -* `FROM_EMAIL` - Sender address for emails sent by NetBox - -!!! note - The `USE_SSL` and `USE_TLS` parameters are mutually exclusive. - -Email is sent from NetBox only for critical events or if configured for [logging](#logging). If you would like to test the email server configuration, Django provides a convenient [send_mail()](https://docs.djangoproject.com/en/stable/topics/email/#send-mail) function accessible within the NetBox shell: - -```no-highlight -# python ./manage.py nbshell ->>> from django.core.mail import send_mail ->>> send_mail( - 'Test Email Subject', - 'Test Email Body', - 'noreply-netbox@example.com', - ['users@example.com'], - fail_silently=False -) -``` - ---- - -## EXEMPT_VIEW_PERMISSIONS - -Default: Empty list - -A list of NetBox models to exempt from the enforcement of view permissions. Models listed here will be viewable by all users, both authenticated and anonymous. - -List models in the form `.`. For example: - -```python -EXEMPT_VIEW_PERMISSIONS = [ - 'dcim.site', - 'dcim.region', - 'ipam.prefix', -] -``` - -To exempt _all_ models from view permission enforcement, set the following. (Note that `EXEMPT_VIEW_PERMISSIONS` must be an iterable.) - -```python -EXEMPT_VIEW_PERMISSIONS = ['*'] -``` - -!!! note - Using a wildcard will not affect certain potentially sensitive models, such as user permissions. If there is a need to exempt these models, they must be specified individually. - ---- - -## FIELD_CHOICES - -Some static choice fields on models can be configured with custom values. This is done by defining `FIELD_CHOICES` as a dictionary mapping model fields to their choices. Each choice in the list must have a database value and a human-friendly label, and may optionally specify a color. (A list of available colors is provided below.) - -The choices provided can either replace the stock choices provided by NetBox, or append to them. To _replace_ the available choices, specify the app, model, and field name separated by dots. For example, the site model would be referenced as `dcim.Site.status`. To _extend_ the available choices, append a plus sign to the end of this string (e.g. `dcim.Site.status+`). - -For example, the following configuration would replace the default site status choices with the options Foo, Bar, and Baz: - -```python -FIELD_CHOICES = { - 'dcim.Site.status': ( - ('foo', 'Foo', 'red'), - ('bar', 'Bar', 'green'), - ('baz', 'Baz', 'blue'), - ) -} -``` - -Appending a plus sign to the field identifier would instead _add_ these choices to the ones already offered: - -```python -FIELD_CHOICES = { - 'dcim.Site.status+': ( - ... - ) -} -``` - -The following model fields support configurable choices: - -* `circuits.Circuit.status` -* `dcim.Device.status` -* `dcim.Location.status` -* `dcim.PowerFeed.status` -* `dcim.Rack.status` -* `dcim.Site.status` -* `extras.JournalEntry.kind` -* `ipam.IPAddress.status` -* `ipam.IPRange.status` -* `ipam.Prefix.status` -* `ipam.VLAN.status` -* `virtualization.Cluster.status` -* `virtualization.VirtualMachine.status` - -The following colors are supported: - -* `blue` -* `indigo` -* `purple` -* `pink` -* `red` -* `orange` -* `yellow` -* `green` -* `teal` -* `cyan` -* `gray` -* `black` -* `white` - ---- - -## HTTP_PROXIES - -Default: None - -A dictionary of HTTP proxies to use for outbound requests originating from NetBox (e.g. when sending webhook requests). Proxies should be specified by schema (HTTP and HTTPS) as per the [Python requests library documentation](https://2.python-requests.org/en/master/user/advanced/). For example: - -```python -HTTP_PROXIES = { - 'http': 'http://10.10.1.10:3128', - 'https': 'http://10.10.1.10:1080', -} -``` - ---- - -## JINJA2_FILTERS - -Default: `{}` - -A dictionary of custom jinja2 filters with the key being the filter name and the value being a callable. For more information see the [Jinja2 documentation](https://jinja.palletsprojects.com/en/3.1.x/api/#custom-filters). For example: - -```python -def uppercase(x): - return str(x).upper() - -JINJA2_FILTERS = { - 'uppercase': uppercase, -} -``` - ---- - -## INTERNAL_IPS - -Default: `('127.0.0.1', '::1')` - -A list of IP addresses recognized as internal to the system, used to control the display of debugging output. For -example, the debugging toolbar will be viewable only when a client is accessing NetBox from one of the listed IP -addresses (and [`DEBUG`](#debug) is true). - ---- - -## LOGGING - -By default, all messages of INFO severity or higher will be logged to the console. Additionally, if [`DEBUG`](#debug) is False and email access has been configured, ERROR and CRITICAL messages will be emailed to the users defined in [`ADMINS`](#admins). - -The Django framework on which NetBox runs allows for the customization of logging format and destination. Please consult the [Django logging documentation](https://docs.djangoproject.com/en/stable/topics/logging/) for more information on configuring this setting. Below is an example which will write all INFO and higher messages to a local file: - -```python -LOGGING = { - 'version': 1, - 'disable_existing_loggers': False, - 'handlers': { - 'file': { - 'level': 'INFO', - 'class': 'logging.FileHandler', - 'filename': '/var/log/netbox.log', - }, - }, - 'loggers': { - 'django': { - 'handlers': ['file'], - 'level': 'INFO', - }, - }, -} -``` - -### Available Loggers - -* `netbox..` - Generic form for model-specific log messages -* `netbox.auth.*` - Authentication events -* `netbox.api.views.*` - Views which handle business logic for the REST API -* `netbox.reports.*` - Report execution (`module.name`) -* `netbox.scripts.*` - Custom script execution (`module.name`) -* `netbox.views.*` - Views which handle business logic for the web UI - ---- - -## LOGIN_PERSISTENCE - -Default: False - -If true, the lifetime of a user's authentication session will be automatically reset upon each valid request. For example, if [`LOGIN_TIMEOUT`](#login_timeout) is configured to 14 days (the default), and a user whose session is due to expire in five days makes a NetBox request (with a valid session cookie), the session's lifetime will be reset to 14 days. - -Note that enabling this setting causes NetBox to update a user's session in the database (or file, as configured per [`SESSION_FILE_PATH`](#session_file_path)) with each request, which may introduce significant overhead in very active environments. It also permits an active user to remain authenticated to NetBox indefinitely. - ---- - -## LOGIN_REQUIRED - -Default: False - -Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users are permitted to access most data in NetBox but not make any changes. - ---- - -## LOGIN_TIMEOUT - -Default: 1209600 seconds (14 days) - -The lifetime (in seconds) of the authentication cookie issued to a NetBox user upon login. - ---- - -## MEDIA_ROOT - -Default: $INSTALL_ROOT/netbox/media/ - -The file path to the location where media files (such as image attachments) are stored. By default, this is the `netbox/media/` directory within the base NetBox installation path. - ---- - -## METRICS_ENABLED - -Default: False - -Toggle the availability Prometheus-compatible metrics at `/metrics`. See the [Prometheus Metrics](../additional-features/prometheus-metrics.md) documentation for more details. - ---- - -## PLUGINS - -Default: Empty - -A list of installed [NetBox plugins](../../plugins/) to enable. Plugins will not take effect unless they are listed here. - -!!! warning - Plugins extend NetBox by allowing external code to run with the same access and privileges as NetBox itself. Only install plugins from trusted sources. The NetBox maintainers make absolutely no guarantees about the integrity or security of your installation with plugins enabled. - ---- - -## PLUGINS_CONFIG - -Default: Empty - -This parameter holds configuration settings for individual NetBox plugins. It is defined as a dictionary, with each key using the name of an installed plugin. The specific parameters supported are unique to each plugin: Reference the plugin's documentation to determine the supported parameters. An example configuration is shown below: - -```python -PLUGINS_CONFIG = { - 'plugin1': { - 'foo': 123, - 'bar': True - }, - 'plugin2': { - 'foo': 456, - }, -} -``` - -Note that a plugin must be listed in `PLUGINS` for its configuration to take effect. - ---- - -## RELEASE_CHECK_URL - -Default: None (disabled) - -This parameter defines the URL of the repository that will be checked for new NetBox releases. When a new release is detected, a message will be displayed to administrative users on the home page. This can be set to the official repository (`'https://api.github.com/repos/netbox-community/netbox/releases'`) or a custom fork. Set this to `None` to disable automatic update checks. - -!!! note - The URL provided **must** be compatible with the [GitHub REST API](https://docs.github.com/en/rest). - ---- - -## REPORTS_ROOT - -Default: `$INSTALL_ROOT/netbox/reports/` - -The file path to the location where [custom reports](../customization/reports.md) will be kept. By default, this is the `netbox/reports/` directory within the base NetBox installation path. - ---- - -## RQ_DEFAULT_TIMEOUT - -Default: `300` - -The maximum execution time of a background task (such as running a custom script), in seconds. - ---- - -## SCRIPTS_ROOT - -Default: `$INSTALL_ROOT/netbox/scripts/` - -The file path to the location where [custom scripts](../customization/custom-scripts.md) will be kept. By default, this is the `netbox/scripts/` directory within the base NetBox installation path. - ---- - -## SESSION_COOKIE_NAME - -Default: `sessionid` - -The name used for the session cookie. See the [Django documentation](https://docs.djangoproject.com/en/stable/ref/settings/#session-cookie-name) for more detail. - ---- - -## SESSION_FILE_PATH - -Default: None - -HTTP session data is used to track authenticated users when they access NetBox. By default, NetBox stores session data in its PostgreSQL database. However, this inhibits authentication to a standby instance of NetBox without write access to the database. Alternatively, a local file path may be specified here and NetBox will store session data as files instead of using the database. Note that the NetBox system user must have read and write permissions to this path. - ---- - -## STORAGE_BACKEND - -Default: None (local storage) - -The backend storage engine for handling uploaded files (e.g. image attachments). NetBox supports integration with the [`django-storages`](https://django-storages.readthedocs.io/en/stable/) package, which provides backends for several popular file storage services. If not configured, local filesystem storage will be used. - -The configuration parameters for the specified storage backend are defined under the `STORAGE_CONFIG` setting. - ---- - -## STORAGE_CONFIG - -Default: Empty - -A dictionary of configuration parameters for the storage backend configured as `STORAGE_BACKEND`. The specific parameters to be used here are specific to each backend; see the [`django-storages` documentation](https://django-storages.readthedocs.io/en/stable/) for more detail. - -If `STORAGE_BACKEND` is not defined, this setting will be ignored. - ---- - -## TIME_ZONE - -Default: UTC - -The time zone NetBox will use when dealing with dates and times. It is recommended to use UTC time unless you have a specific need to use a local time zone. Please see the [list of available time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). - ---- - -## Date and Time Formatting - -You may define custom formatting for date and times. For detailed instructions on writing format strings, please see [the Django documentation](https://docs.djangoproject.com/en/stable/ref/templates/builtins/#date). Default formats are listed below. - -```python -DATE_FORMAT = 'N j, Y' # June 26, 2016 -SHORT_DATE_FORMAT = 'Y-m-d' # 2016-06-26 -TIME_FORMAT = 'g:i a' # 1:23 p.m. -SHORT_TIME_FORMAT = 'H:i:s' # 13:23:00 -DATETIME_FORMAT = 'N j, Y g:i a' # June 26, 2016 1:23 p.m. -SHORT_DATETIME_FORMAT = 'Y-m-d H:i' # 2016-06-26 13:23 -``` diff --git a/docs/configuration/plugins.md b/docs/configuration/plugins.md new file mode 100644 index 000000000..aea60f389 --- /dev/null +++ b/docs/configuration/plugins.md @@ -0,0 +1,35 @@ +# Plugin Parameters + +## PLUGINS + +Default: Empty + +A list of installed [NetBox plugins](../../plugins/) to enable. Plugins will not take effect unless they are listed here. + +!!! warning + Plugins extend NetBox by allowing external code to run with the same access and privileges as NetBox itself. Only install plugins from trusted sources. The NetBox maintainers make absolutely no guarantees about the integrity or security of your installation with plugins enabled. + +--- + +## PLUGINS_CONFIG + +Default: Empty + +This parameter holds configuration settings for individual NetBox plugins. It is defined as a dictionary, with each key using the name of an installed plugin. The specific parameters supported are unique to each plugin: Reference the plugin's documentation to determine the supported parameters. An example configuration is shown below: + +```python +PLUGINS_CONFIG = { + 'plugin1': { + 'foo': 123, + 'bar': True + }, + 'plugin2': { + 'foo': 456, + }, +} +``` + +Note that a plugin must be listed in `PLUGINS` for its configuration to take effect. + +--- + diff --git a/docs/configuration/remote-authentication.md b/docs/configuration/remote-authentication.md index 2c3a7002f..07adf5c6a 100644 --- a/docs/configuration/remote-authentication.md +++ b/docs/configuration/remote-authentication.md @@ -47,6 +47,22 @@ NetBox can be configured to support remote user authentication by inferring user --- +## REMOTE_AUTH_GROUP_HEADER + +Default: `'HTTP_REMOTE_USER_GROUP'` + +When remote user authentication is in use, this is the name of the HTTP header which informs NetBox of the currently authenticated user. For example, to use the request header `X-Remote-User-Groups` it needs to be set to `HTTP_X_REMOTE_USER_GROUPS`. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` ) + +--- + +## REMOTE_AUTH_GROUP_SEPARATOR + +Default: `|` (Pipe) + +The Seperator upon which `REMOTE_AUTH_GROUP_HEADER` gets split into individual Groups. This needs to be coordinated with your authentication Proxy. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` ) + +--- + ## REMOTE_AUTH_GROUP_SYNC_ENABLED Default: `False` @@ -63,14 +79,6 @@ When remote user authentication is in use, this is the name of the HTTP header w --- -## REMOTE_AUTH_GROUP_HEADER - -Default: `'HTTP_REMOTE_USER_GROUP'` - -When remote user authentication is in use, this is the name of the HTTP header which informs NetBox of the currently authenticated user. For example, to use the request header `X-Remote-User-Groups` it needs to be set to `HTTP_X_REMOTE_USER_GROUPS`. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` ) - ---- - ## REMOTE_AUTH_SUPERUSER_GROUPS Default: `[]` (Empty list) @@ -100,11 +108,3 @@ The list of groups that promote an remote User to Staff on Login. If group isn't Default: `[]` (Empty list) The list of users that get promoted to Staff on Login. If user isn't present in list on next Login, the Role gets revoked. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` ) - ---- - -## REMOTE_AUTH_GROUP_SEPARATOR - -Default: `|` (Pipe) - -The Seperator upon which `REMOTE_AUTH_GROUP_HEADER` gets split into individual Groups. This needs to be coordinated with your authentication Proxy. (Requires `REMOTE_AUTH_ENABLED` and `REMOTE_AUTH_GROUP_SYNC_ENABLED` ) diff --git a/docs/configuration/required-settings.md b/docs/configuration/required-parameters.md similarity index 100% rename from docs/configuration/required-settings.md rename to docs/configuration/required-parameters.md diff --git a/docs/configuration/security.md b/docs/configuration/security.md new file mode 100644 index 000000000..6aa363b1a --- /dev/null +++ b/docs/configuration/security.md @@ -0,0 +1,144 @@ +# Security & Authentication Parameters + +## ALLOWED_URL_SCHEMES + +!!! tip "Dynamic Configuration Parameter" + +Default: `('file', 'ftp', 'ftps', 'http', 'https', 'irc', 'mailto', 'sftp', 'ssh', 'tel', 'telnet', 'tftp', 'vnc', 'xmpp')` + +A list of permitted URL schemes referenced when rendering links within NetBox. Note that only the schemes specified in this list will be accepted: If adding your own, be sure to replicate all the default values as well (excluding those schemes which are not desirable). + +--- + +## AUTH_PASSWORD_VALIDATORS + +This parameter acts as a pass-through for configuring Django's built-in password validators for local user accounts. If configured, these will be applied whenever a user's password is updated to ensure that it meets minimum criteria such as length or complexity. An example is provided below. For more detail on the available options, please see [the Django documentation](https://docs.djangoproject.com/en/stable/topics/auth/passwords/#password-validation). + +```python +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + 'OPTIONS': { + 'min_length': 10, + } + }, +] +``` + +--- + +## CORS_ORIGIN_ALLOW_ALL + +Default: False + +If True, cross-origin resource sharing (CORS) requests will be accepted from all origins. If False, a whitelist will be used (see below). + +--- + +## CORS_ORIGIN_WHITELIST + +## CORS_ORIGIN_REGEX_WHITELIST + +These settings specify a list of origins that are authorized to make cross-site API requests. Use +`CORS_ORIGIN_WHITELIST` to define a list of exact hostnames, or `CORS_ORIGIN_REGEX_WHITELIST` to define a set of regular +expressions. (These settings have no effect if `CORS_ORIGIN_ALLOW_ALL` is True.) For example: + +```python +CORS_ORIGIN_WHITELIST = [ + 'https://example.com', +] +``` + +--- + +## CSRF_COOKIE_NAME + +Default: `csrftoken` + +The name of the cookie to use for the cross-site request forgery (CSRF) authentication token. See the [Django documentation](https://docs.djangoproject.com/en/stable/ref/settings/#csrf-cookie-name) for more detail. + +--- + +--- + +## CSRF_TRUSTED_ORIGINS + +Default: `[]` + +Defines a list of trusted origins for unsafe (e.g. `POST`) requests. This is a pass-through to Django's [`CSRF_TRUSTED_ORIGINS`](https://docs.djangoproject.com/en/4.0/ref/settings/#std:setting-CSRF_TRUSTED_ORIGINS) setting. Note that each host listed must specify a scheme (e.g. `http://` or `https://). + +```python +CSRF_TRUSTED_ORIGINS = ( + 'http://netbox.local', + 'https://netbox.local', +) +``` + +--- + +## EXEMPT_VIEW_PERMISSIONS + +Default: Empty list + +A list of NetBox models to exempt from the enforcement of view permissions. Models listed here will be viewable by all users, both authenticated and anonymous. + +List models in the form `.`. For example: + +```python +EXEMPT_VIEW_PERMISSIONS = [ + 'dcim.site', + 'dcim.region', + 'ipam.prefix', +] +``` + +To exempt _all_ models from view permission enforcement, set the following. (Note that `EXEMPT_VIEW_PERMISSIONS` must be an iterable.) + +```python +EXEMPT_VIEW_PERMISSIONS = ['*'] +``` + +!!! note + Using a wildcard will not affect certain potentially sensitive models, such as user permissions. If there is a need to exempt these models, they must be specified individually. + +--- + +## LOGIN_PERSISTENCE + +Default: False + +If true, the lifetime of a user's authentication session will be automatically reset upon each valid request. For example, if [`LOGIN_TIMEOUT`](#login_timeout) is configured to 14 days (the default), and a user whose session is due to expire in five days makes a NetBox request (with a valid session cookie), the session's lifetime will be reset to 14 days. + +Note that enabling this setting causes NetBox to update a user's session in the database (or file, as configured per [`SESSION_FILE_PATH`](#session_file_path)) with each request, which may introduce significant overhead in very active environments. It also permits an active user to remain authenticated to NetBox indefinitely. + +--- + +## LOGIN_REQUIRED + +Default: False + +Setting this to True will permit only authenticated users to access any part of NetBox. By default, anonymous users are permitted to access most data in NetBox but not make any changes. + +--- + +## LOGIN_TIMEOUT + +Default: 1209600 seconds (14 days) + +The lifetime (in seconds) of the authentication cookie issued to a NetBox user upon login. + +--- + +## SESSION_COOKIE_NAME + +Default: `sessionid` + +The name used for the session cookie. See the [Django documentation](https://docs.djangoproject.com/en/stable/ref/settings/#session-cookie-name) for more detail. + +--- + +## SESSION_FILE_PATH + +Default: None + +HTTP session data is used to track authenticated users when they access NetBox. By default, NetBox stores session data in its PostgreSQL database. However, this inhibits authentication to a standby instance of NetBox without write access to the database. Alternatively, a local file path may be specified here and NetBox will store session data as files instead of using the database. Note that the NetBox system user must have read and write permissions to this path. diff --git a/docs/configuration/system.md b/docs/configuration/system.md new file mode 100644 index 000000000..21607e566 --- /dev/null +++ b/docs/configuration/system.md @@ -0,0 +1,178 @@ +# System Parameters + +## BASE_PATH + +Default: None + +The base URL path to use when accessing NetBox. Do not include the scheme or domain name. For example, if installed at https://example.com/netbox/, set: + +```python +BASE_PATH = 'netbox/' +``` + +--- + +## DOCS_ROOT + +Default: `$INSTALL_ROOT/docs/` + +The filesystem path to NetBox's documentation. This is used when presenting context-sensitive documentation in the web UI. By default, this will be the `docs/` directory within the root NetBox installation path. (Set this to `None` to disable the embedded documentation.) + +--- + +## EMAIL + +In order to send email, NetBox needs an email server configured. The following items can be defined within the `EMAIL` configuration parameter: + +* `SERVER` - Hostname or IP address of the email server (use `localhost` if running locally) +* `PORT` - TCP port to use for the connection (default: `25`) +* `USERNAME` - Username with which to authenticate +* `PASSSWORD` - Password with which to authenticate +* `USE_SSL` - Use SSL when connecting to the server (default: `False`) +* `USE_TLS` - Use TLS when connecting to the server (default: `False`) +* `SSL_CERTFILE` - Path to the PEM-formatted SSL certificate file (optional) +* `SSL_KEYFILE` - Path to the PEM-formatted SSL private key file (optional) +* `TIMEOUT` - Amount of time to wait for a connection, in seconds (default: `10`) +* `FROM_EMAIL` - Sender address for emails sent by NetBox + +!!! note + The `USE_SSL` and `USE_TLS` parameters are mutually exclusive. + +Email is sent from NetBox only for critical events or if configured for [logging](#logging). If you would like to test the email server configuration, Django provides a convenient [send_mail()](https://docs.djangoproject.com/en/stable/topics/email/#send-mail) function accessible within the NetBox shell: + +```no-highlight +# python ./manage.py nbshell +>>> from django.core.mail import send_mail +>>> send_mail( + 'Test Email Subject', + 'Test Email Body', + 'noreply-netbox@example.com', + ['users@example.com'], + fail_silently=False +) +``` + +--- + +## HTTP_PROXIES + +Default: None + +A dictionary of HTTP proxies to use for outbound requests originating from NetBox (e.g. when sending webhook requests). Proxies should be specified by schema (HTTP and HTTPS) as per the [Python requests library documentation](https://2.python-requests.org/en/master/user/advanced/). For example: + +```python +HTTP_PROXIES = { + 'http': 'http://10.10.1.10:3128', + 'https': 'http://10.10.1.10:1080', +} +``` + +--- + +## INTERNAL_IPS + +Default: `('127.0.0.1', '::1')` + +A list of IP addresses recognized as internal to the system, used to control the display of debugging output. For +example, the debugging toolbar will be viewable only when a client is accessing NetBox from one of the listed IP +addresses (and [`DEBUG`](#debug) is true). + +--- + +## JINJA2_FILTERS + +Default: `{}` + +A dictionary of custom jinja2 filters with the key being the filter name and the value being a callable. For more information see the [Jinja2 documentation](https://jinja.palletsprojects.com/en/3.1.x/api/#custom-filters). For example: + +```python +def uppercase(x): + return str(x).upper() + +JINJA2_FILTERS = { + 'uppercase': uppercase, +} +``` + +--- + +## LOGGING + +By default, all messages of INFO severity or higher will be logged to the console. Additionally, if [`DEBUG`](#debug) is False and email access has been configured, ERROR and CRITICAL messages will be emailed to the users defined in [`ADMINS`](#admins). + +The Django framework on which NetBox runs allows for the customization of logging format and destination. Please consult the [Django logging documentation](https://docs.djangoproject.com/en/stable/topics/logging/) for more information on configuring this setting. Below is an example which will write all INFO and higher messages to a local file: + +```python +LOGGING = { + 'version': 1, + 'disable_existing_loggers': False, + 'handlers': { + 'file': { + 'level': 'INFO', + 'class': 'logging.FileHandler', + 'filename': '/var/log/netbox.log', + }, + }, + 'loggers': { + 'django': { + 'handlers': ['file'], + 'level': 'INFO', + }, + }, +} +``` + +### Available Loggers + +* `netbox..` - Generic form for model-specific log messages +* `netbox.auth.*` - Authentication events +* `netbox.api.views.*` - Views which handle business logic for the REST API +* `netbox.reports.*` - Report execution (`module.name`) +* `netbox.scripts.*` - Custom script execution (`module.name`) +* `netbox.views.*` - Views which handle business logic for the web UI + +--- + +## MEDIA_ROOT + +Default: $INSTALL_ROOT/netbox/media/ + +The file path to the location where media files (such as image attachments) are stored. By default, this is the `netbox/media/` directory within the base NetBox installation path. + +--- + +## REPORTS_ROOT + +Default: `$INSTALL_ROOT/netbox/reports/` + +The file path to the location where [custom reports](../customization/reports.md) will be kept. By default, this is the `netbox/reports/` directory within the base NetBox installation path. + +--- + +## SCRIPTS_ROOT + +Default: `$INSTALL_ROOT/netbox/scripts/` + +The file path to the location where [custom scripts](../customization/custom-scripts.md) will be kept. By default, this is the `netbox/scripts/` directory within the base NetBox installation path. + +--- + +## STORAGE_BACKEND + +Default: None (local storage) + +The backend storage engine for handling uploaded files (e.g. image attachments). NetBox supports integration with the [`django-storages`](https://django-storages.readthedocs.io/en/stable/) package, which provides backends for several popular file storage services. If not configured, local filesystem storage will be used. + +The configuration parameters for the specified storage backend are defined under the `STORAGE_CONFIG` setting. + +--- + +## STORAGE_CONFIG + +Default: Empty + +A dictionary of configuration parameters for the storage backend configured as `STORAGE_BACKEND`. The specific parameters to be used here are specific to each backend; see the [`django-storages` documentation](https://django-storages.readthedocs.io/en/stable/) for more detail. + +If `STORAGE_BACKEND` is not defined, this setting will be ignored. + +--- diff --git a/docs/customization/custom-validation.md b/docs/customization/custom-validation.md index f88cd309b..30198117f 100644 --- a/docs/customization/custom-validation.md +++ b/docs/customization/custom-validation.md @@ -50,7 +50,7 @@ The `fail()` method may optionally specify a field with which to associate the s ## Assigning Custom Validators -Custom validators are associated with specific NetBox models under the [CUSTOM_VALIDATORS](../configuration/dynamic-settings.md#custom_validators) configuration parameter. There are three manners by which custom validation rules can be defined: +Custom validators are associated with specific NetBox models under the [CUSTOM_VALIDATORS](../configuration/data-validation.md#custom_validators) configuration parameter. There are three manners by which custom validation rules can be defined: 1. Plain JSON mapping (no custom logic) 2. Dotted path to a custom validator class diff --git a/docs/customization/export-templates.md b/docs/customization/export-templates.md index affd39aae..3c7ff7d20 100644 --- a/docs/customization/export-templates.md +++ b/docs/customization/export-templates.md @@ -2,7 +2,7 @@ ## REST API Integration -When it is necessary to provide authentication credentials (such as when [`LOGIN_REQUIRED`](../configuration/optional-settings.md#login_required) has been enabled), it is recommended to render export templates via the REST API. This allows the client to specify an authentication token. To render an export template via the REST API, make a `GET` request to the model's list endpoint and append the `export` parameter specifying the export template name. For example: +When it is necessary to provide authentication credentials (such as when [`LOGIN_REQUIRED`](../configuration/security.md#login_required) has been enabled), it is recommended to render export templates via the REST API. This allows the client to specify an authentication token. To render an export template via the REST API, make a `GET` request to the model's list endpoint and append the `export` parameter specifying the export template name. For example: ``` GET /api/dcim/sites/?export=MyTemplateName diff --git a/docs/customization/reports.md b/docs/customization/reports.md index ae4ceb9aa..150c32f40 100644 --- a/docs/customization/reports.md +++ b/docs/customization/reports.md @@ -12,7 +12,7 @@ A NetBox report is a mechanism for validating the integrity of data within NetBo ## Writing Reports -Reports must be saved as files in the [`REPORTS_ROOT`](../configuration/optional-settings.md#reports_root) path (which defaults to `netbox/reports/`). Each file created within this path is considered a separate module. Each module holds one or more reports (Python classes), each of which performs a certain function. The logic of each report is broken into discrete test methods, each of which applies a small portion of the logic comprising the overall test. +Reports must be saved as files in the [`REPORTS_ROOT`](../configuration/system.md#reports_root) path (which defaults to `netbox/reports/`). Each file created within this path is considered a separate module. Each module holds one or more reports (Python classes), each of which performs a certain function. The logic of each report is broken into discrete test methods, each of which applies a small portion of the logic comprising the overall test. !!! warning The reports path includes a file named `__init__.py`, which registers the path as a Python module. Do not delete this file. diff --git a/docs/graphql-api/overview.md b/docs/graphql-api/overview.md index 57dfb22bd..4fc6d2dd8 100644 --- a/docs/graphql-api/overview.md +++ b/docs/graphql-api/overview.md @@ -67,4 +67,4 @@ Authorization: Token $TOKEN ## Disabling the GraphQL API -If not needed, the GraphQL API can be disabled by setting the [`GRAPHQL_ENABLED`](../configuration/dynamic-settings.md#graphql_enabled) configuration parameter to False and restarting NetBox. +If not needed, the GraphQL API can be disabled by setting the [`GRAPHQL_ENABLED`](../configuration/miscellaneous.md#graphql_enabled) configuration parameter to False and restarting NetBox. diff --git a/docs/installation/3-netbox.md b/docs/installation/3-netbox.md index 50b350d3a..7c4a60500 100644 --- a/docs/installation/3-netbox.md +++ b/docs/installation/3-netbox.md @@ -142,7 +142,7 @@ ALLOWED_HOSTS = ['*'] ### DATABASE -This parameter holds the database configuration details. You must define the username and password used when you configured PostgreSQL. If the service is running on a remote host, update the `HOST` and `PORT` parameters accordingly. See the [configuration documentation](../configuration/required-settings.md#database) for more detail on individual parameters. +This parameter holds the database configuration details. You must define the username and password used when you configured PostgreSQL. If the service is running on a remote host, update the `HOST` and `PORT` parameters accordingly. See the [configuration documentation](../configuration/required-parameters.md#database) for more detail on individual parameters. ```python DATABASE = { @@ -157,7 +157,7 @@ DATABASE = { ### REDIS -Redis is a in-memory key-value store used by NetBox for caching and background task queuing. Redis typically requires minimal configuration; the values below should suffice for most installations. See the [configuration documentation](../configuration/required-settings.md#redis) for more detail on individual parameters. +Redis is a in-memory key-value store used by NetBox for caching and background task queuing. Redis typically requires minimal configuration; the values below should suffice for most installations. See the [configuration documentation](../configuration/required-parameters.md#redis) for more detail on individual parameters. Note that NetBox requires the specification of two separate Redis databases: `tasks` and `caching`. These may both be provided by the same Redis service, however each should have a unique numeric database ID. @@ -209,7 +209,7 @@ sudo sh -c "echo 'napalm' >> /opt/netbox/local_requirements.txt" ### Remote File Storage -By default, NetBox will use the local filesystem to store uploaded files. To use a remote filesystem, install the [`django-storages`](https://django-storages.readthedocs.io/en/stable/) library and configure your [desired storage backend](../configuration/optional-settings.md#storage_backend) in `configuration.py`. +By default, NetBox will use the local filesystem to store uploaded files. To use a remote filesystem, install the [`django-storages`](https://django-storages.readthedocs.io/en/stable/) library and configure your [desired storage backend](../configuration/system.md#storage_backend) in `configuration.py`. ```no-highlight sudo sh -c "echo 'django-storages' >> /opt/netbox/local_requirements.txt" diff --git a/docs/installation/6-ldap.md b/docs/installation/6-ldap.md index 281554f75..163ace70d 100644 --- a/docs/installation/6-ldap.md +++ b/docs/installation/6-ldap.md @@ -142,7 +142,7 @@ AUTH_LDAP_CACHE_TIMEOUT = 3600 `systemctl restart netbox` restarts the NetBox service, and initiates any changes made to `ldap_config.py`. If there are syntax errors present, the NetBox process will not spawn an instance, and errors should be logged to `/var/log/messages`. -For troubleshooting LDAP user/group queries, add or merge the following [logging](../configuration/optional-settings.md#logging) configuration to `configuration.py`: +For troubleshooting LDAP user/group queries, add or merge the following [logging](../configuration/system.md#logging) configuration to `configuration.py`: ```python LOGGING = { diff --git a/docs/plugins/development/models.md b/docs/plugins/development/models.md index 6d7075b80..c58621b81 100644 --- a/docs/plugins/development/models.md +++ b/docs/plugins/development/models.md @@ -156,7 +156,7 @@ class StatusChoices(ChoiceSet): key = 'MyModel.status' ``` -To extend or replace the default values for this choice set, a NetBox administrator can then reference it under the [`FIELD_CHOICES`](../../configuration/optional-settings.md#field_choices) configuration parameter. For example, the `status` field on `MyModel` in `my_plugin` would be referenced as: +To extend or replace the default values for this choice set, a NetBox administrator can then reference it under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter. For example, the `status` field on `MyModel` in `my_plugin` would be referenced as: ```python FIELD_CHOICES = { diff --git a/docs/release-notes/version-3.0.md b/docs/release-notes/version-3.0.md index 7d6341f44..93ff33d95 100644 --- a/docs/release-notes/version-3.0.md +++ b/docs/release-notes/version-3.0.md @@ -367,7 +367,7 @@ More information about IP ranges is available [in the documentation](../models/i #### Custom Model Validation ([#5963](https://github.com/netbox-community/netbox/issues/5963)) -This release introduces the [`CUSTOM_VALIDATORS`](../configuration/dynamic-settings.md#custom_validators) configuration parameter, which allows administrators to map NetBox models to custom validator classes to enforce custom validation logic. For example, the following configuration requires every site to have a name of at least ten characters and a description: +This release introduces the [`CUSTOM_VALIDATORS`](../configuration/data-validation.md#custom_validators) configuration parameter, which allows administrators to map NetBox models to custom validator classes to enforce custom validation logic. For example, the following configuration requires every site to have a name of at least ten characters and a description: ```python from extras.validators import CustomValidator diff --git a/docs/release-notes/version-3.1.md b/docs/release-notes/version-3.1.md index 27ba4e69e..9dce1dfd4 100644 --- a/docs/release-notes/version-3.1.md +++ b/docs/release-notes/version-3.1.md @@ -313,8 +313,6 @@ Some parameters of NetBox's configuration are now accessible via the admin UI. T Dynamic configuration parameters may also still be defined within `configuration.py`, and the settings defined here take precedence over those defined via the user interface. -For a complete list of supported parameters, please see the [dynamic configuration documentation](../configuration/dynamic-settings.md). - #### First Hop Redundancy Protocol (FHRP) Groups ([#6235](https://github.com/netbox-community/netbox/issues/6235)) A new FHRP group model has been introduced to aid in modeling the configurations of protocols such as HSRP, VRRP, and GLBP. Each FHRP group may be assigned one or more virtual IP addresses, as well as an authentication type and key. Member device and VM interfaces may be associated with one or more FHRP groups, with each assignment receiving a numeric priority designation. diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index c36344912..10ccaeb4d 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -267,7 +267,7 @@ Custom field object assignment is fully supported in the REST API, and functions #### Custom Status Choices ([#8054](https://github.com/netbox-community/netbox/issues/8054)) -Custom choices can be now added to most object status fields in NetBox. This is done by defining the [`FIELD_CHOICES`](../configuration/optional-settings.md#field_choices) configuration parameter to map field identifiers to an iterable of custom choices an (optionally) colors. These choices are populated automatically when NetBox initializes. For example, the following configuration will add three custom choices for the site status field, each with a designated color: +Custom choices can be now added to most object status fields in NetBox. This is done by defining the [`FIELD_CHOICES`](../configuration/data-validation.md#field_choices) configuration parameter to map field identifiers to an iterable of custom choices an (optionally) colors. These choices are populated automatically when NetBox initializes. For example, the following configuration will add three custom choices for the site status field, each with a designated color: ```python FIELD_CHOICES = { @@ -291,7 +291,7 @@ FIELD_CHOICES = { #### Improved User Preferences ([#7759](https://github.com/netbox-community/netbox/issues/7759)) -A robust new mechanism for managing user preferences is included in this release. The user preferences form has been improved for better usability, and administrators can now define default preferences for all users with the [`DEFAULT_USER_PREFERENCES`](../configuration/dynamic-settings.md##default_user_preferences) configuration parameter. For example, this can be used to define the columns which appear by default in a table: +A robust new mechanism for managing user preferences is included in this release. The user preferences form has been improved for better usability, and administrators can now define default preferences for all users with the [`DEFAULT_USER_PREFERENCES`](../configuration/default-values.md#default_user_preferences) configuration parameter. For example, this can be used to define the columns which appear by default in a table: ```python DEFAULT_USER_PREFERENCES = { diff --git a/docs/rest-api/authentication.md b/docs/rest-api/authentication.md index 18b6bc4f8..411063338 100644 --- a/docs/rest-api/authentication.md +++ b/docs/rest-api/authentication.md @@ -20,7 +20,7 @@ https://netbox/api/dcim/sites/ } ``` -A token is not required for read-only operations which have been exempted from permissions enforcement (using the [`EXEMPT_VIEW_PERMISSIONS`](../configuration/optional-settings.md#exempt_view_permissions) configuration parameter). However, if a token _is_ required but not present in a request, the API will return a 403 (Forbidden) response: +A token is not required for read-only operations which have been exempted from permissions enforcement (using the [`EXEMPT_VIEW_PERMISSIONS`](../configuration/security.md#exempt_view_permissions) configuration parameter). However, if a token _is_ required but not present in a request, the API will return a 403 (Forbidden) response: ``` $ curl https://netbox/api/dcim/sites/ diff --git a/docs/rest-api/overview.md b/docs/rest-api/overview.md index 27a9b6a7e..5fc4f18bb 100644 --- a/docs/rest-api/overview.md +++ b/docs/rest-api/overview.md @@ -308,7 +308,7 @@ Vary: Accept } ``` -The default page is determined by the [`PAGINATE_COUNT`](../configuration/dynamic-settings.md#paginate_count) configuration parameter, which defaults to 50. However, this can be overridden per request by specifying the desired `offset` and `limit` query parameters. For example, if you wish to retrieve a hundred devices at a time, you would make a request for: +The default page is determined by the [`PAGINATE_COUNT`](../configuration/default-values.md#paginate_count) configuration parameter, which defaults to 50. However, this can be overridden per request by specifying the desired `offset` and `limit` query parameters. For example, if you wish to retrieve a hundred devices at a time, you would make a request for: ``` http://netbox/api/dcim/devices/?limit=100 @@ -325,7 +325,7 @@ The response will return devices 1 through 100. The URL provided in the `next` a } ``` -The maximum number of objects that can be returned is limited by the [`MAX_PAGE_SIZE`](../configuration/dynamic-settings.md#max_page_size) configuration parameter, which is 1000 by default. Setting this to `0` or `None` will remove the maximum limit. An API consumer can then pass `?limit=0` to retrieve _all_ matching objects with a single request. +The maximum number of objects that can be returned is limited by the [`MAX_PAGE_SIZE`](../configuration/miscellaneous.md#max_page_size) configuration parameter, which is 1000 by default. Setting this to `0` or `None` will remove the maximum limit. An API consumer can then pass `?limit=0` to retrieve _all_ matching objects with a single request. !!! warning Disabling the page size limit introduces a potential for very resource-intensive requests, since one API request can effectively retrieve an entire table from the database. diff --git a/mkdocs.yml b/mkdocs.yml index 2203b8934..3acb157aa 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -72,11 +72,18 @@ nav: - Populating Data: 'getting-started/populating-data.md' - Configuration: - Configuring NetBox: 'configuration/index.md' - - Required Settings: 'configuration/required-settings.md' - - Optional Settings: 'configuration/optional-settings.md' - - Dynamic Settings: 'configuration/dynamic-settings.md' - - Error Reporting: 'configuration/error-reporting.md' + - Required Parameters: 'configuration/required-parameters.md' + - System: 'configuration/system.md' + - Security: 'configuration/security.md' - Remote Authentication: 'configuration/remote-authentication.md' + - Data & Validation: 'configuration/data-validation.md' + - Default Values: 'configuration/default-values.md' + - Error Reporting: 'configuration/error-reporting.md' + - Plugins: 'configuration/plugins.md' + - NAPALM: 'configuration/napalm.md' + - Date & Time: 'configuration/date-time.md' + - Miscellaneous: 'configuration/miscellaneous.md' + - Development: 'configuration/development.md' - Customization: - Custom Fields: 'customization/custom-fields.md' - Custom Validation: 'customization/custom-validation.md' From 1cd407548813bc959f4959f7009b3d800fe71311 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 29 Jul 2022 16:23:45 -0400 Subject: [PATCH 316/593] Add mermaid flowcharts showing rough data model dependencies --- docs/getting-started/planning.md | 116 ++++++++++++++++++++++--------- mkdocs.yml | 6 +- 2 files changed, 87 insertions(+), 35 deletions(-) diff --git a/docs/getting-started/planning.md b/docs/getting-started/planning.md index 00640ca44..5c431a4d2 100644 --- a/docs/getting-started/planning.md +++ b/docs/getting-started/planning.md @@ -50,38 +50,86 @@ When starting with a completely empty database, it might not be immediately clea Below is the (rough) recommended order in which NetBox objects should be created or imported. While it is not required to follow this exact order, doing so will help ensure the smoothest workflow. - +1. Tenant groups and tenants +2. Regions, site groups, sites, and locations +3. Rack roles and racks +4. Manufacturers, device types, and module types +5. Platforms and device roles +6. Devices and modules +7. Providers and provider networks +8. Circuit types and circuits +9. Wireless LAN groups and wireless LANs +10. Route targets and VRFs +11. RIRs and aggregates +12. IP/VLAN roles +13. Prefixes, IP ranges, and IP addresses +14. VLAN groups and VLANs +15. Cluster types, cluster groups, and clusters +16. Virtual machines and VM interfaces -1. Tenant groups -2. Tenants -3. Regions and/or site groups -4. Sites -5. Locations -6. Rack roles -7. Racks -8. Platforms -9. Manufacturers -10. Device types -11. Module types -12. Device roles -13. Devices -14. Providers -15. Provider networks -16. Circuit types -17. Circuits -18. Wireless LAN groups -19. Wireless LANs & links -20. Route targets -21. VRFs -22. RIRs -23. Aggregates -24. IP/VLAN roles -25. Prefixes -26. IP ranges & addresses -27. VLAN groups -28. VLANs -29. Services -30. Clusters -31. Virtual machines -32. VM interfaces -33. L2 VPNs +This is not a comprehensive list, but should suffice for the initial data imports. Beyond these, it the order in which objects are added doesn't have much if any impact. + +The graphs below illustrate some of the core dependencies among different models in NetBox for your reference. + +!!! note "Self-Nesting Models" + Each model in the graphs below which show a looping arrow pointing back to itself can be nested in a recursive hierarchy. For example, you can have regions representing both countries and cities, with the latter nested underneath the former. + +### Tenancy + +```mermaid +flowchart TD + TenantGroup --> TenantGroup + TenantGroup --> Tenant + Tenant --> Site & Device & Prefix & VLAN & ... +``` + +### Sites, Racks, and Devices + +```mermaid +flowchart TD + Region --> Region + SiteGroup --> SiteGroup + DeviceRole & Platform --> Device + Region & SiteGroup --> Site + Site --> Location & Device + Location --> Location + Location --> Rack & Device + Rack --> Device + Manufacturer --> DeviceType & ModuleType + DeviceType --> Device + Device & ModuleType ---> Module + Device & Module --> Interface +``` + +### VRFs, Prefixes, IP Addresses, and VLANs + +```mermaid +flowchart TD + VLANGroup --> VLAN + Role --> VLAN & IPRange & Prefix + RIR --> Aggregate + RouteTarget --> VRF + Aggregate & VRF --> Prefix + VRF --> IPRange & IPAddress + Prefix --> VLAN & IPRange & IPAddress +``` + +### Circuits + +```mermaid +flowchart TD + Provider & CircuitType --> Circuit + Provider --> ProviderNetwork + Circuit --> CircuitTermination +``` + +### Clusters and Virtual Machines + +```mermaid +flowchart TD + ClusterGroup & ClusterType --> Cluster + Cluster --> VirtualMachine + Site --> Cluster & VirtualMachine + Device & Platform --> VirtualMachine + VirtualMachine --> VMInterface +``` diff --git a/mkdocs.yml b/mkdocs.yml index 3acb157aa..4c5279127 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -53,7 +53,11 @@ markdown_extensions: - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg - - pymdownx.superfences + - pymdownx.superfences: + custom_fences: + - name: mermaid + class: mermaid + format: !!python/name:pymdownx.superfences.fence_code_format - pymdownx.tabbed: alternate_style: true nav: From 6904666e2a6e9be451be3acbdd669af012aec45b Mon Sep 17 00:00:00 2001 From: Kim Johansson Date: Sat, 30 Jul 2022 01:18:30 +0200 Subject: [PATCH 317/593] Remove deprecated usage of prefetch_related Fixes #9699 --- netbox/circuits/views.py | 15 ++++-- netbox/dcim/views.py | 90 +++++++++++++++++----------------- netbox/extras/views.py | 4 +- netbox/ipam/views.py | 61 +++++++++++------------ netbox/tenancy/views.py | 10 ++-- netbox/virtualization/views.py | 15 +++--- 6 files changed, 101 insertions(+), 94 deletions(-) diff --git a/netbox/circuits/views.py b/netbox/circuits/views.py index 11f211b27..423bd67d6 100644 --- a/netbox/circuits/views.py +++ b/netbox/circuits/views.py @@ -30,7 +30,8 @@ class ProviderView(generic.ObjectView): circuits = Circuit.objects.restrict(request.user, 'view').filter( provider=instance ).prefetch_related( - 'type', 'tenant', 'tenant__group', 'terminations__site' + 'tenant__group', 'termination_a__site', 'termination_z__site', + 'termination_a__provider_network', 'termination_z__provider_network', ) circuits_table = tables.CircuitTable(circuits, user=request.user, exclude=('provider',)) circuits_table.configure(request) @@ -91,7 +92,8 @@ class ProviderNetworkView(generic.ObjectView): Q(termination_a__provider_network=instance.pk) | Q(termination_z__provider_network=instance.pk) ).prefetch_related( - 'type', 'tenant', 'tenant__group', 'terminations__site' + 'tenant__group', 'termination_a__site', 'termination_z__site', + 'termination_a__provider_network', 'termination_z__provider_network', ) circuits_table = tables.CircuitTable(circuits, user=request.user) circuits_table.configure(request) @@ -192,7 +194,8 @@ class CircuitTypeBulkDeleteView(generic.BulkDeleteView): class CircuitListView(generic.ObjectListView): queryset = Circuit.objects.prefetch_related( - 'provider', 'type', 'tenant', 'tenant__group', 'termination_a', 'termination_z' + 'tenant__group', 'termination_a__site', 'termination_z__site', + 'termination_a__provider_network', 'termination_z__provider_network', ) filterset = filtersets.CircuitFilterSet filterset_form = forms.CircuitFilterForm @@ -220,7 +223,8 @@ class CircuitBulkImportView(generic.BulkImportView): class CircuitBulkEditView(generic.BulkEditView): queryset = Circuit.objects.prefetch_related( - 'provider', 'type', 'tenant', 'terminations' + 'termination_a__site', 'termination_z__site', + 'termination_a__provider_network', 'termination_z__provider_network', ) filterset = filtersets.CircuitFilterSet table = tables.CircuitTable @@ -229,7 +233,8 @@ class CircuitBulkEditView(generic.BulkEditView): class CircuitBulkDeleteView(generic.BulkDeleteView): queryset = Circuit.objects.prefetch_related( - 'provider', 'type', 'tenant', 'terminations' + 'termination_a__site', 'termination_z__site', + 'termination_a__provider_network', 'termination_z__provider_network', ) filterset = filtersets.CircuitFilterSet table = tables.CircuitTable diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 12e070e70..6daecb3a6 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -324,7 +324,7 @@ class SiteListView(generic.ObjectListView): class SiteView(generic.ObjectView): - queryset = Site.objects.prefetch_related('region', 'tenant__group') + queryset = Site.objects.prefetch_related('tenant__group') def get_extra_context(self, request, instance): stats = { @@ -359,7 +359,7 @@ class SiteView(generic.ObjectView): site=instance, position__isnull=True, parent_bay__isnull=True - ).prefetch_related('device_type__manufacturer') + ).prefetch_related('device_type__manufacturer', 'parent_bay', 'device_role') asns = ASN.objects.restrict(request.user, 'view').filter(sites=instance) asn_count = asns.count() @@ -391,14 +391,14 @@ class SiteBulkImportView(generic.BulkImportView): class SiteBulkEditView(generic.BulkEditView): - queryset = Site.objects.prefetch_related('region', 'tenant') + queryset = Site.objects.all() filterset = filtersets.SiteFilterSet table = tables.SiteTable form = forms.SiteBulkEditForm class SiteBulkDeleteView(generic.BulkDeleteView): - queryset = Site.objects.prefetch_related('region', 'tenant') + queryset = Site.objects.all() filterset = filtersets.SiteFilterSet table = tables.SiteTable @@ -454,7 +454,7 @@ class LocationView(generic.ObjectView): location=instance, position__isnull=True, parent_bay__isnull=True - ).prefetch_related('device_type__manufacturer') + ).prefetch_related('device_type__manufacturer', 'parent_bay', 'device_role') return { 'rack_count': rack_count, @@ -572,7 +572,7 @@ class RackRoleBulkDeleteView(generic.BulkDeleteView): # class RackListView(generic.ObjectListView): - queryset = Rack.objects.prefetch_related('devices__device_type').annotate( + queryset = Rack.objects.annotate( device_count=count_related(Device, 'rack') ) filterset = filtersets.RackFilterSet @@ -631,7 +631,7 @@ class RackView(generic.ObjectView): rack=instance, position__isnull=True, parent_bay__isnull=True - ).prefetch_related('device_type__manufacturer') + ).prefetch_related('device_type__manufacturer', 'parent_bay', 'device_role') peer_racks = Rack.objects.restrict(request.user, 'view').filter(site=instance.site) @@ -682,14 +682,14 @@ class RackBulkImportView(generic.BulkImportView): class RackBulkEditView(generic.BulkEditView): - queryset = Rack.objects.prefetch_related('site', 'location', 'tenant', 'role') + queryset = Rack.objects.all() filterset = filtersets.RackFilterSet table = tables.RackTable form = forms.RackBulkEditForm class RackBulkDeleteView(generic.BulkDeleteView): - queryset = Rack.objects.prefetch_related('site', 'location', 'tenant', 'role') + queryset = Rack.objects.all() filterset = filtersets.RackFilterSet table = tables.RackTable @@ -706,7 +706,7 @@ class RackReservationListView(generic.ObjectListView): class RackReservationView(generic.ObjectView): - queryset = RackReservation.objects.prefetch_related('rack') + queryset = RackReservation.objects.all() class RackReservationEditView(generic.ObjectEditView): @@ -742,14 +742,14 @@ class RackReservationImportView(generic.BulkImportView): class RackReservationBulkEditView(generic.BulkEditView): - queryset = RackReservation.objects.prefetch_related('rack', 'user') + queryset = RackReservation.objects.all() filterset = filtersets.RackReservationFilterSet table = tables.RackReservationTable form = forms.RackReservationBulkEditForm class RackReservationBulkDeleteView(generic.BulkDeleteView): - queryset = RackReservation.objects.prefetch_related('rack', 'user') + queryset = RackReservation.objects.all() filterset = filtersets.RackReservationFilterSet table = tables.RackReservationTable @@ -831,7 +831,7 @@ class ManufacturerBulkDeleteView(generic.BulkDeleteView): # class DeviceTypeListView(generic.ObjectListView): - queryset = DeviceType.objects.prefetch_related('manufacturer').annotate( + queryset = DeviceType.objects.annotate( instance_count=count_related(Device, 'device_type') ) filterset = filtersets.DeviceTypeFilterSet @@ -840,7 +840,7 @@ class DeviceTypeListView(generic.ObjectListView): class DeviceTypeView(generic.ObjectView): - queryset = DeviceType.objects.prefetch_related('manufacturer') + queryset = DeviceType.objects.all() def get_extra_context(self, request, instance): instance_count = Device.objects.restrict(request.user).filter(device_type=instance).count() @@ -964,7 +964,7 @@ class DeviceTypeImportView(generic.ObjectImportView): class DeviceTypeBulkEditView(generic.BulkEditView): - queryset = DeviceType.objects.prefetch_related('manufacturer').annotate( + queryset = DeviceType.objects.annotate( instance_count=count_related(Device, 'device_type') ) filterset = filtersets.DeviceTypeFilterSet @@ -973,7 +973,7 @@ class DeviceTypeBulkEditView(generic.BulkEditView): class DeviceTypeBulkDeleteView(generic.BulkDeleteView): - queryset = DeviceType.objects.prefetch_related('manufacturer').annotate( + queryset = DeviceType.objects.annotate( instance_count=count_related(Device, 'device_type') ) filterset = filtersets.DeviceTypeFilterSet @@ -985,7 +985,7 @@ class DeviceTypeBulkDeleteView(generic.BulkDeleteView): # class ModuleTypeListView(generic.ObjectListView): - queryset = ModuleType.objects.prefetch_related('manufacturer').annotate( + queryset = ModuleType.objects.annotate( instance_count=count_related(Module, 'module_type') ) filterset = filtersets.ModuleTypeFilterSet @@ -994,7 +994,7 @@ class ModuleTypeListView(generic.ObjectListView): class ModuleTypeView(generic.ObjectView): - queryset = ModuleType.objects.prefetch_related('manufacturer') + queryset = ModuleType.objects.all() def get_extra_context(self, request, instance): instance_count = Module.objects.restrict(request.user).filter(module_type=instance).count() @@ -1091,7 +1091,7 @@ class ModuleTypeImportView(generic.ObjectImportView): class ModuleTypeBulkEditView(generic.BulkEditView): - queryset = ModuleType.objects.prefetch_related('manufacturer').annotate( + queryset = ModuleType.objects.annotate( instance_count=count_related(Module, 'module_type') ) filterset = filtersets.ModuleTypeFilterSet @@ -1100,7 +1100,7 @@ class ModuleTypeBulkEditView(generic.BulkEditView): class ModuleTypeBulkDeleteView(generic.BulkDeleteView): - queryset = ModuleType.objects.prefetch_related('manufacturer').annotate( + queryset = ModuleType.objects.annotate( instance_count=count_related(Module, 'module_type') ) filterset = filtersets.ModuleTypeFilterSet @@ -1611,9 +1611,7 @@ class DeviceListView(generic.ObjectListView): class DeviceView(generic.ObjectView): - queryset = Device.objects.prefetch_related( - 'site__region', 'location', 'rack', 'tenant__group', 'device_role', 'platform', 'primary_ip4', 'primary_ip6' - ) + queryset = Device.objects.all() def get_extra_context(self, request, instance): # VirtualChassis members @@ -1790,14 +1788,14 @@ class ChildDeviceBulkImportView(generic.BulkImportView): class DeviceBulkEditView(generic.BulkEditView): - queryset = Device.objects.prefetch_related('tenant', 'site', 'rack', 'device_role', 'device_type__manufacturer') + queryset = Device.objects.prefetch_related('device_type__manufacturer') filterset = filtersets.DeviceFilterSet table = tables.DeviceTable form = forms.DeviceBulkEditForm class DeviceBulkDeleteView(generic.BulkDeleteView): - queryset = Device.objects.prefetch_related('tenant', 'site', 'rack', 'device_role', 'device_type__manufacturer') + queryset = Device.objects.prefetch_related('device_type__manufacturer') filterset = filtersets.DeviceFilterSet table = tables.DeviceTable @@ -1807,7 +1805,7 @@ class DeviceBulkDeleteView(generic.BulkDeleteView): # class ModuleListView(generic.ObjectListView): - queryset = Module.objects.prefetch_related('device', 'module_type__manufacturer') + queryset = Module.objects.prefetch_related('module_type__manufacturer') filterset = filtersets.ModuleFilterSet filterset_form = forms.ModuleFilterForm table = tables.ModuleTable @@ -1833,14 +1831,14 @@ class ModuleBulkImportView(generic.BulkImportView): class ModuleBulkEditView(generic.BulkEditView): - queryset = Module.objects.prefetch_related('device', 'module_type__manufacturer') + queryset = Module.objects.prefetch_related('module_type__manufacturer') filterset = filtersets.ModuleFilterSet table = tables.ModuleTable form = forms.ModuleBulkEditForm class ModuleBulkDeleteView(generic.BulkDeleteView): - queryset = Module.objects.prefetch_related('device', 'module_type__manufacturer') + queryset = Module.objects.prefetch_related('module_type__manufacturer') filterset = filtersets.ModuleFilterSet table = tables.ModuleTable @@ -2566,7 +2564,7 @@ class InventoryItemBulkImportView(generic.BulkImportView): class InventoryItemBulkEditView(generic.BulkEditView): - queryset = InventoryItem.objects.prefetch_related('device', 'manufacturer', 'role') + queryset = InventoryItem.objects.all() filterset = filtersets.InventoryItemFilterSet table = tables.InventoryItemTable form = forms.InventoryItemBulkEditForm @@ -2577,7 +2575,7 @@ class InventoryItemBulkRenameView(generic.BulkRenameView): class InventoryItemBulkDeleteView(generic.BulkDeleteView): - queryset = InventoryItem.objects.prefetch_related('device', 'manufacturer', 'role') + queryset = InventoryItem.objects.all() table = tables.InventoryItemTable template_name = 'dcim/inventoryitem_bulk_delete.html' @@ -2867,14 +2865,20 @@ class CableBulkImportView(generic.BulkImportView): class CableBulkEditView(generic.BulkEditView): - queryset = Cable.objects.prefetch_related('terminations') + queryset = Cable.objects.prefetch_related( + 'terminations__termination', 'terminations___device', 'terminations___rack', 'terminations___location', + 'terminations___site', + ) filterset = filtersets.CableFilterSet table = tables.CableTable form = forms.CableBulkEditForm class CableBulkDeleteView(generic.BulkDeleteView): - queryset = Cable.objects.prefetch_related('terminations') + queryset = Cable.objects.prefetch_related( + 'terminations__termination', 'terminations___device', 'terminations___rack', 'terminations___location', + 'terminations___site', + ) filterset = filtersets.CableFilterSet table = tables.CableTable @@ -2930,7 +2934,7 @@ class InterfaceConnectionsListView(generic.ObjectListView): # class VirtualChassisListView(generic.ObjectListView): - queryset = VirtualChassis.objects.prefetch_related('master').annotate( + queryset = VirtualChassis.objects.annotate( member_count=count_related(Device, 'virtual_chassis') ) table = tables.VirtualChassisTable @@ -3158,9 +3162,7 @@ class VirtualChassisBulkDeleteView(generic.BulkDeleteView): # class PowerPanelListView(generic.ObjectListView): - queryset = PowerPanel.objects.prefetch_related( - 'site', 'location' - ).annotate( + queryset = PowerPanel.objects.annotate( powerfeed_count=count_related(PowerFeed, 'power_panel') ) filterset = filtersets.PowerPanelFilterSet @@ -3169,10 +3171,10 @@ class PowerPanelListView(generic.ObjectListView): class PowerPanelView(generic.ObjectView): - queryset = PowerPanel.objects.prefetch_related('site', 'location') + queryset = PowerPanel.objects.all() def get_extra_context(self, request, instance): - power_feeds = PowerFeed.objects.restrict(request.user).filter(power_panel=instance).prefetch_related('rack') + power_feeds = PowerFeed.objects.restrict(request.user).filter(power_panel=instance) powerfeed_table = tables.PowerFeedTable( data=power_feeds, orderable=False @@ -3202,16 +3204,14 @@ class PowerPanelBulkImportView(generic.BulkImportView): class PowerPanelBulkEditView(generic.BulkEditView): - queryset = PowerPanel.objects.prefetch_related('site', 'location') + queryset = PowerPanel.objects.all() filterset = filtersets.PowerPanelFilterSet table = tables.PowerPanelTable form = forms.PowerPanelBulkEditForm class PowerPanelBulkDeleteView(generic.BulkDeleteView): - queryset = PowerPanel.objects.prefetch_related( - 'site', 'location' - ).annotate( + queryset = PowerPanel.objects.annotate( powerfeed_count=count_related(PowerFeed, 'power_panel') ) filterset = filtersets.PowerPanelFilterSet @@ -3230,7 +3230,7 @@ class PowerFeedListView(generic.ObjectListView): class PowerFeedView(generic.ObjectView): - queryset = PowerFeed.objects.prefetch_related('power_panel', 'rack') + queryset = PowerFeed.objects.all() class PowerFeedEditView(generic.ObjectEditView): @@ -3249,7 +3249,7 @@ class PowerFeedBulkImportView(generic.BulkImportView): class PowerFeedBulkEditView(generic.BulkEditView): - queryset = PowerFeed.objects.prefetch_related('power_panel', 'rack') + queryset = PowerFeed.objects.all() filterset = filtersets.PowerFeedFilterSet table = tables.PowerFeedTable form = forms.PowerFeedBulkEditForm @@ -3260,6 +3260,6 @@ class PowerFeedBulkDisconnectView(BulkDisconnectView): class PowerFeedBulkDeleteView(generic.BulkDeleteView): - queryset = PowerFeed.objects.prefetch_related('power_panel', 'rack') + queryset = PowerFeed.objects.all() filterset = filtersets.PowerFeedFilterSet table = tables.PowerFeedTable diff --git a/netbox/extras/views.py b/netbox/extras/views.py index bb99536c3..5b589c181 100644 --- a/netbox/extras/views.py +++ b/netbox/extras/views.py @@ -492,14 +492,14 @@ class JournalEntryDeleteView(generic.ObjectDeleteView): class JournalEntryBulkEditView(generic.BulkEditView): - queryset = JournalEntry.objects.prefetch_related('created_by') + queryset = JournalEntry.objects.all() filterset = filtersets.JournalEntryFilterSet table = tables.JournalEntryTable form = forms.JournalEntryBulkEditForm class JournalEntryBulkDeleteView(generic.BulkDeleteView): - queryset = JournalEntry.objects.prefetch_related('created_by') + queryset = JournalEntry.objects.all() filterset = filtersets.JournalEntryFilterSet table = tables.JournalEntryTable diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 72b223b55..880ddb83b 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -40,11 +40,11 @@ class VRFView(generic.ObjectView): ipaddress_count = IPAddress.objects.restrict(request.user, 'view').filter(vrf=instance).count() import_targets_table = tables.RouteTargetTable( - instance.import_targets.prefetch_related('tenant'), + instance.import_targets.all(), orderable=False ) export_targets_table = tables.RouteTargetTable( - instance.export_targets.prefetch_related('tenant'), + instance.export_targets.all(), orderable=False ) @@ -72,14 +72,14 @@ class VRFBulkImportView(generic.BulkImportView): class VRFBulkEditView(generic.BulkEditView): - queryset = VRF.objects.prefetch_related('tenant') + queryset = VRF.objects.all() filterset = filtersets.VRFFilterSet table = tables.VRFTable form = forms.VRFBulkEditForm class VRFBulkDeleteView(generic.BulkDeleteView): - queryset = VRF.objects.prefetch_related('tenant') + queryset = VRF.objects.all() filterset = filtersets.VRFFilterSet table = tables.VRFTable @@ -100,11 +100,11 @@ class RouteTargetView(generic.ObjectView): def get_extra_context(self, request, instance): importing_vrfs_table = tables.VRFTable( - instance.importing_vrfs.prefetch_related('tenant'), + instance.importing_vrfs.all(), orderable=False ) exporting_vrfs_table = tables.VRFTable( - instance.exporting_vrfs.prefetch_related('tenant'), + instance.exporting_vrfs.all(), orderable=False ) @@ -130,14 +130,14 @@ class RouteTargetBulkImportView(generic.BulkImportView): class RouteTargetBulkEditView(generic.BulkEditView): - queryset = RouteTarget.objects.prefetch_related('tenant') + queryset = RouteTarget.objects.all() filterset = filtersets.RouteTargetFilterSet table = tables.RouteTargetTable form = forms.RouteTargetBulkEditForm class RouteTargetBulkDeleteView(generic.BulkDeleteView): - queryset = RouteTarget.objects.prefetch_related('tenant') + queryset = RouteTarget.objects.all() filterset = filtersets.RouteTargetFilterSet table = tables.RouteTargetTable @@ -334,14 +334,14 @@ class AggregateBulkImportView(generic.BulkImportView): class AggregateBulkEditView(generic.BulkEditView): - queryset = Aggregate.objects.prefetch_related('rir') + queryset = Aggregate.objects.all() filterset = filtersets.AggregateFilterSet table = tables.AggregateTable form = forms.AggregateBulkEditForm class AggregateBulkDeleteView(generic.BulkDeleteView): - queryset = Aggregate.objects.prefetch_related('rir') + queryset = Aggregate.objects.all() filterset = filtersets.AggregateFilterSet table = tables.AggregateTable @@ -417,7 +417,7 @@ class PrefixListView(generic.ObjectListView): class PrefixView(generic.ObjectView): - queryset = Prefix.objects.prefetch_related('vrf', 'site__region', 'tenant__group', 'vlan__group', 'role') + queryset = Prefix.objects.all() def get_extra_context(self, request, instance): try: @@ -433,7 +433,7 @@ class PrefixView(generic.ObjectView): ).filter( prefix__net_contains=str(instance.prefix) ).prefetch_related( - 'site', 'role', 'tenant' + 'site', 'role', 'tenant', 'vlan', ) parent_prefix_table = tables.PrefixTable( list(parent_prefixes), @@ -447,7 +447,7 @@ class PrefixView(generic.ObjectView): ).exclude( pk=instance.pk ).prefetch_related( - 'site', 'role' + 'site', 'role', 'tenant', 'vlan', ) duplicate_prefix_table = tables.PrefixTable( list(duplicate_prefixes), @@ -500,7 +500,7 @@ class PrefixIPRangesView(generic.ObjectChildrenView): def get_children(self, request, parent): return parent.get_child_ranges().restrict(request.user, 'view').prefetch_related( - 'vrf', 'role', 'tenant', 'tenant__group', + 'tenant__group', ) def get_extra_context(self, request, instance): @@ -519,7 +519,7 @@ class PrefixIPAddressesView(generic.ObjectChildrenView): template_name = 'ipam/prefix/ip_addresses.html' def get_children(self, request, parent): - return parent.get_child_ips().restrict(request.user, 'view').prefetch_related('vrf', 'tenant') + return parent.get_child_ips().restrict(request.user, 'view').prefetch_related('vrf', 'tenant', 'tenant__group') def prep_table_data(self, request, queryset, parent): show_available = bool(request.GET.get('show_available', 'true') == 'true') @@ -552,14 +552,14 @@ class PrefixBulkImportView(generic.BulkImportView): class PrefixBulkEditView(generic.BulkEditView): - queryset = Prefix.objects.prefetch_related('site', 'vrf__tenant', 'tenant', 'vlan', 'role') + queryset = Prefix.objects.prefetch_related('vrf__tenant') filterset = filtersets.PrefixFilterSet table = tables.PrefixTable form = forms.PrefixBulkEditForm class PrefixBulkDeleteView(generic.BulkDeleteView): - queryset = Prefix.objects.prefetch_related('site', 'vrf__tenant', 'tenant', 'vlan', 'role') + queryset = Prefix.objects.prefetch_related('vrf__tenant') filterset = filtersets.PrefixFilterSet table = tables.PrefixTable @@ -611,14 +611,14 @@ class IPRangeBulkImportView(generic.BulkImportView): class IPRangeBulkEditView(generic.BulkEditView): - queryset = IPRange.objects.prefetch_related('vrf', 'tenant') + queryset = IPRange.objects.all() filterset = filtersets.IPRangeFilterSet table = tables.IPRangeTable form = forms.IPRangeBulkEditForm class IPRangeBulkDeleteView(generic.BulkDeleteView): - queryset = IPRange.objects.prefetch_related('vrf', 'tenant') + queryset = IPRange.objects.all() filterset = filtersets.IPRangeFilterSet table = tables.IPRangeTable @@ -789,14 +789,14 @@ class IPAddressBulkImportView(generic.BulkImportView): class IPAddressBulkEditView(generic.BulkEditView): - queryset = IPAddress.objects.prefetch_related('vrf__tenant', 'tenant') + queryset = IPAddress.objects.prefetch_related('vrf__tenant') filterset = filtersets.IPAddressFilterSet table = tables.IPAddressTable form = forms.IPAddressBulkEditForm class IPAddressBulkDeleteView(generic.BulkDeleteView): - queryset = IPAddress.objects.prefetch_related('vrf__tenant', 'tenant') + queryset = IPAddress.objects.prefetch_related('vrf__tenant') filterset = filtersets.IPAddressFilterSet table = tables.IPAddressTable @@ -819,7 +819,8 @@ class VLANGroupView(generic.ObjectView): def get_extra_context(self, request, instance): vlans = VLAN.objects.restrict(request.user, 'view').filter(group=instance).prefetch_related( - Prefetch('prefixes', queryset=Prefix.objects.restrict(request.user)) + Prefetch('prefixes', queryset=Prefix.objects.restrict(request.user)), + 'tenant', 'site', 'role', ).order_by('vid') vlans_count = vlans.count() vlans = add_available_vlans(vlans, vlan_group=instance) @@ -894,7 +895,7 @@ class FHRPGroupView(generic.ObjectView): def get_extra_context(self, request, instance): # Get assigned IP addresses ipaddress_table = tables.AssignedIPAddressesTable( - data=instance.ip_addresses.restrict(request.user, 'view').prefetch_related('vrf', 'tenant'), + data=instance.ip_addresses.restrict(request.user, 'view'), orderable=False ) @@ -984,11 +985,11 @@ class VLANListView(generic.ObjectListView): class VLANView(generic.ObjectView): - queryset = VLAN.objects.prefetch_related('site__region', 'tenant__group', 'role') + queryset = VLAN.objects.all() def get_extra_context(self, request, instance): prefixes = Prefix.objects.restrict(request.user, 'view').filter(vlan=instance).prefetch_related( - 'vrf', 'site', 'role' + 'vrf', 'site', 'role', 'tenant' ) prefix_table = tables.PrefixTable(list(prefixes), exclude=('vlan', 'utilization'), orderable=False) @@ -1046,14 +1047,14 @@ class VLANBulkImportView(generic.BulkImportView): class VLANBulkEditView(generic.BulkEditView): - queryset = VLAN.objects.prefetch_related('site', 'group', 'tenant', 'role') + queryset = VLAN.objects.all() filterset = filtersets.VLANFilterSet table = tables.VLANTable form = forms.VLANBulkEditForm class VLANBulkDeleteView(generic.BulkDeleteView): - queryset = VLAN.objects.prefetch_related('site', 'group', 'tenant', 'role') + queryset = VLAN.objects.all() filterset = filtersets.VLANFilterSet table = tables.VLANTable @@ -1106,14 +1107,14 @@ class ServiceTemplateBulkDeleteView(generic.BulkDeleteView): # class ServiceListView(generic.ObjectListView): - queryset = Service.objects.all() + queryset = Service.objects.prefetch_related('device', 'virtual_machine') filterset = filtersets.ServiceFilterSet filterset_form = forms.ServiceFilterForm table = tables.ServiceTable class ServiceView(generic.ObjectView): - queryset = Service.objects.prefetch_related('ipaddresses') + queryset = Service.objects.all() class ServiceCreateView(generic.ObjectEditView): @@ -1123,7 +1124,7 @@ class ServiceCreateView(generic.ObjectEditView): class ServiceEditView(generic.ObjectEditView): - queryset = Service.objects.prefetch_related('ipaddresses') + queryset = Service.objects.all() form = forms.ServiceForm template_name = 'ipam/service_edit.html' diff --git a/netbox/tenancy/views.py b/netbox/tenancy/views.py index 07a25b5a4..9a2fe6ab9 100644 --- a/netbox/tenancy/views.py +++ b/netbox/tenancy/views.py @@ -95,7 +95,7 @@ class TenantListView(generic.ObjectListView): class TenantView(generic.ObjectView): - queryset = Tenant.objects.prefetch_related('group') + queryset = Tenant.objects.all() def get_extra_context(self, request, instance): stats = { @@ -140,14 +140,14 @@ class TenantBulkImportView(generic.BulkImportView): class TenantBulkEditView(generic.BulkEditView): - queryset = Tenant.objects.prefetch_related('group') + queryset = Tenant.objects.all() filterset = filtersets.TenantFilterSet table = tables.TenantTable form = forms.TenantBulkEditForm class TenantBulkDeleteView(generic.BulkDeleteView): - queryset = Tenant.objects.prefetch_related('group') + queryset = Tenant.objects.all() filterset = filtersets.TenantFilterSet table = tables.TenantTable @@ -337,14 +337,14 @@ class ContactBulkImportView(generic.BulkImportView): class ContactBulkEditView(generic.BulkEditView): - queryset = Contact.objects.prefetch_related('group') + queryset = Contact.objects.all() filterset = filtersets.ContactFilterSet table = tables.ContactTable form = forms.ContactBulkEditForm class ContactBulkDeleteView(generic.BulkDeleteView): - queryset = Contact.objects.prefetch_related('group') + queryset = Contact.objects.all() filterset = filtersets.ContactFilterSet table = tables.ContactTable diff --git a/netbox/virtualization/views.py b/netbox/virtualization/views.py index 4cd7da30d..5b26f8503 100644 --- a/netbox/virtualization/views.py +++ b/netbox/virtualization/views.py @@ -209,14 +209,14 @@ class ClusterBulkImportView(generic.BulkImportView): class ClusterBulkEditView(generic.BulkEditView): - queryset = Cluster.objects.prefetch_related('type', 'group', 'site') + queryset = Cluster.objects.all() filterset = filtersets.ClusterFilterSet table = tables.ClusterTable form = forms.ClusterBulkEditForm class ClusterBulkDeleteView(generic.BulkDeleteView): - queryset = Cluster.objects.prefetch_related('type', 'group', 'site') + queryset = Cluster.objects.all() filterset = filtersets.ClusterFilterSet table = tables.ClusterTable @@ -308,7 +308,7 @@ class ClusterRemoveDevicesView(generic.ObjectEditView): # class VirtualMachineListView(generic.ObjectListView): - queryset = VirtualMachine.objects.all() + queryset = VirtualMachine.objects.prefetch_related('primary_ip4', 'primary_ip6') filterset = filtersets.VirtualMachineFilterSet filterset_form = forms.VirtualMachineFilterForm table = tables.VirtualMachineTable @@ -334,7 +334,8 @@ class VirtualMachineView(generic.ObjectView): services = Service.objects.restrict(request.user, 'view').filter( virtual_machine=instance ).prefetch_related( - Prefetch('ipaddresses', queryset=IPAddress.objects.restrict(request.user)) + Prefetch('ipaddresses', queryset=IPAddress.objects.restrict(request.user)), + 'virtual_machine' ) return { @@ -383,14 +384,14 @@ class VirtualMachineBulkImportView(generic.BulkImportView): class VirtualMachineBulkEditView(generic.BulkEditView): - queryset = VirtualMachine.objects.prefetch_related('cluster', 'tenant', 'role') + queryset = VirtualMachine.objects.prefetch_related('primary_ip4', 'primary_ip6') filterset = filtersets.VirtualMachineFilterSet table = tables.VirtualMachineTable form = forms.VirtualMachineBulkEditForm class VirtualMachineBulkDeleteView(generic.BulkDeleteView): - queryset = VirtualMachine.objects.prefetch_related('cluster', 'tenant', 'role') + queryset = VirtualMachine.objects.prefetch_related('primary_ip4', 'primary_ip6') filterset = filtersets.VirtualMachineFilterSet table = tables.VirtualMachineTable @@ -413,7 +414,7 @@ class VMInterfaceView(generic.ObjectView): def get_extra_context(self, request, instance): # Get assigned IP addresses ipaddress_table = AssignedIPAddressesTable( - data=instance.ip_addresses.restrict(request.user, 'view').prefetch_related('vrf', 'tenant'), + data=instance.ip_addresses.restrict(request.user, 'view'), orderable=False ) From 5ab03b7e926506a7ae949982bb252d62133fb7eb Mon Sep 17 00:00:00 2001 From: atownson <52260120+atownson@users.noreply.github.com> Date: Mon, 1 Aug 2022 08:01:18 -0500 Subject: [PATCH 318/593] Closes #9637: Add existing fields to the Rack Reservation user interface pages (#9870) * Closes netbox-community#9637 Added site_group to RackReservationFrom class fieldsets Added location to RackReservationTable class --- netbox/dcim/forms/filtersets.py | 2 +- netbox/dcim/forms/models.py | 2 +- netbox/dcim/tables/racks.py | 6 +++++- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/netbox/dcim/forms/filtersets.py b/netbox/dcim/forms/filtersets.py index 38221b371..9a9f91ffb 100644 --- a/netbox/dcim/forms/filtersets.py +++ b/netbox/dcim/forms/filtersets.py @@ -287,7 +287,7 @@ class RackReservationFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): fieldsets = ( (None, ('q', 'tag')), ('User', ('user_id',)), - ('Rack', ('region_id', 'site_group_id', 'site_id', 'location_id')), + ('Location', ('region_id', 'site_group_id', 'site_id', 'location_id')), ('Tenant', ('tenant_group_id', 'tenant_id')), ) region_id = DynamicModelMultipleChoiceField( diff --git a/netbox/dcim/forms/models.py b/netbox/dcim/forms/models.py index 043af751d..fb09b9871 100644 --- a/netbox/dcim/forms/models.py +++ b/netbox/dcim/forms/models.py @@ -321,7 +321,7 @@ class RackReservationForm(TenancyForm, NetBoxModelForm): ) fieldsets = ( - ('Reservation', ('region', 'site', 'location', 'rack', 'units', 'user', 'description', 'tags')), + ('Reservation', ('region', 'site_group', 'site', 'location', 'rack', 'units', 'user', 'description', 'tags')), ('Tenancy', ('tenant_group', 'tenant')), ) diff --git a/netbox/dcim/tables/racks.py b/netbox/dcim/tables/racks.py index 5412e2297..d83f25a5f 100644 --- a/netbox/dcim/tables/racks.py +++ b/netbox/dcim/tables/racks.py @@ -109,6 +109,10 @@ class RackReservationTable(TenancyColumnsMixin, NetBoxTable): accessor=Accessor('rack__site'), linkify=True ) + location = tables.Column( + accessor=Accessor('rack__location'), + linkify=True + ) rack = tables.Column( linkify=True ) @@ -123,7 +127,7 @@ class RackReservationTable(TenancyColumnsMixin, NetBoxTable): class Meta(NetBoxTable.Meta): model = RackReservation fields = ( - 'pk', 'id', 'reservation', 'site', 'rack', 'unit_list', 'user', 'created', 'tenant', 'tenant_group', 'description', 'tags', + 'pk', 'id', 'reservation', 'site', 'location', 'rack', 'unit_list', 'user', 'created', 'tenant', 'tenant_group', 'description', 'tags', 'actions', 'created', 'last_updated', ) default_columns = ('pk', 'reservation', 'site', 'rack', 'unit_list', 'user', 'description') From 728ad5162466fa805a428553a621bd78134ba61b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 09:12:15 -0400 Subject: [PATCH 319/593] Changelog & cleanup for #9637 --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/forms/filtersets.py | 35 +++++++++++++++++++++---------- 2 files changed, 25 insertions(+), 11 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index ce8552b0b..57a6dffe1 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -5,6 +5,7 @@ ### Enhancements * [#9062](https://github.com/netbox-community/netbox/issues/9062) - Add/edit {module} substitution to help text for component template name +* [#9637](https://github.com/netbox-community/netbox/issues/9637) - Add site group field to rack reservation form * [#9762](https://github.com/netbox-community/netbox/issues/9762) - Add `nat_outside` column to the IPAddress table * [#9825](https://github.com/netbox-community/netbox/issues/9825) - Add contacts column to virtual machines table diff --git a/netbox/dcim/forms/filtersets.py b/netbox/dcim/forms/filtersets.py index 9a9f91ffb..12905aec9 100644 --- a/netbox/dcim/forms/filtersets.py +++ b/netbox/dcim/forms/filtersets.py @@ -287,7 +287,7 @@ class RackReservationFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): fieldsets = ( (None, ('q', 'tag')), ('User', ('user_id',)), - ('Location', ('region_id', 'site_group_id', 'site_id', 'location_id')), + ('Rack', ('region_id', 'site_group_id', 'site_id', 'location_id', 'rack_id')), ('Tenant', ('tenant_group_id', 'tenant_id')), ) region_id = DynamicModelMultipleChoiceField( @@ -295,25 +295,38 @@ class RackReservationFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): required=False, label=_('Region') ) - site_id = DynamicModelMultipleChoiceField( - queryset=Site.objects.all(), - required=False, - query_params={ - 'region_id': '$region_id' - }, - label=_('Site') - ) site_group_id = DynamicModelMultipleChoiceField( queryset=SiteGroup.objects.all(), required=False, label=_('Site group') ) - location_id = DynamicModelMultipleChoiceField( - queryset=Location.objects.prefetch_related('site'), + site_id = DynamicModelMultipleChoiceField( + queryset=Site.objects.all(), required=False, + query_params={ + 'region_id': '$region_id', + 'group_id': '$site_group_id', + }, + label=_('Site') + ) + location_id = DynamicModelMultipleChoiceField( + queryset=Location.objects.all(), + required=False, + query_params={ + 'site_id': '$site_id', + }, label=_('Location'), null_option='None' ) + rack_id = DynamicModelMultipleChoiceField( + queryset=Rack.objects.all(), + required=False, + query_params={ + 'site_id': '$site_id', + 'location_id': '$location_id', + }, + label=_('Rack') + ) user_id = DynamicModelMultipleChoiceField( queryset=User.objects.all(), required=False, From 84f2225f42f16ca64777172135eba2689db958f3 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 09:16:58 -0400 Subject: [PATCH 320/593] PEP8 cleanup --- netbox/dcim/tests/test_models.py | 4 ++-- netbox/extras/models/customfields.py | 2 +- netbox/extras/tests/test_customfields.py | 2 +- netbox/extras/tests/test_registry.py | 2 +- netbox/ipam/forms/models.py | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/netbox/dcim/tests/test_models.py b/netbox/dcim/tests/test_models.py index 8566f969b..03438a441 100644 --- a/netbox/dcim/tests/test_models.py +++ b/netbox/dcim/tests/test_models.py @@ -194,14 +194,14 @@ class RackTestCase(TestCase): # Validate inventory (front face) rack1_inventory_front = self.rack.get_rack_units(face=DeviceFaceChoices.FACE_FRONT) self.assertEqual(rack1_inventory_front[-10]['device'], device1) - del(rack1_inventory_front[-10]) + del rack1_inventory_front[-10] for u in rack1_inventory_front: self.assertIsNone(u['device']) # Validate inventory (rear face) rack1_inventory_rear = self.rack.get_rack_units(face=DeviceFaceChoices.FACE_REAR) self.assertEqual(rack1_inventory_rear[-10]['device'], device1) - del(rack1_inventory_rear[-10]) + del rack1_inventory_rear[-10] for u in rack1_inventory_rear: self.assertIsNone(u['device']) diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index 6a8c1dacf..b7d77e550 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -169,7 +169,7 @@ class CustomField(ExportTemplatesMixin, WebhooksMixin, ChangeLoggedModel): model = ct.model_class() instances = model.objects.filter(**{f'custom_field_data__{self.name}__isnull': False}) for instance in instances: - del(instance.custom_field_data[self.name]) + del instance.custom_field_data[self.name] model.objects.bulk_update(instances, ['custom_field_data'], batch_size=100) def rename_object_data(self, old_name, new_name): diff --git a/netbox/extras/tests/test_customfields.py b/netbox/extras/tests/test_customfields.py index 8dcb53b09..946999bc2 100644 --- a/netbox/extras/tests/test_customfields.py +++ b/netbox/extras/tests/test_customfields.py @@ -992,7 +992,7 @@ class CustomFieldModelTest(TestCase): with self.assertRaises(ValidationError): site.clean() - del(site.cf['bar']) + del site.cf['bar'] site.clean() def test_missing_required_field(self): diff --git a/netbox/extras/tests/test_registry.py b/netbox/extras/tests/test_registry.py index 53ba6584a..38a6b9f83 100644 --- a/netbox/extras/tests/test_registry.py +++ b/netbox/extras/tests/test_registry.py @@ -30,4 +30,4 @@ class RegistryTest(TestCase): reg['foo'] = 123 with self.assertRaises(TypeError): - del(reg['foo']) + del reg['foo'] diff --git a/netbox/ipam/forms/models.py b/netbox/ipam/forms/models.py index e86abc672..d3421f22b 100644 --- a/netbox/ipam/forms/models.py +++ b/netbox/ipam/forms/models.py @@ -848,7 +848,7 @@ class ServiceCreateForm(ServiceForm): # Fields which may be populated from a ServiceTemplate are not required for field in ('name', 'protocol', 'ports'): self.fields[field].required = False - del(self.fields[field].widget.attrs['required']) + del self.fields[field].widget.attrs['required'] def clean(self): if self.cleaned_data['service_template']: From 9fe5f09742b8d9ed0a0ddc8ea57a7ad21884726b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 09:32:52 -0400 Subject: [PATCH 321/593] Fixes #9891: Ensure consistent ordering for tags during object serialization --- docs/release-notes/version-3.2.md | 6 +++++- netbox/utilities/utils.py | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 57a6dffe1..ed08ad891 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -4,11 +4,15 @@ ### Enhancements -* [#9062](https://github.com/netbox-community/netbox/issues/9062) - Add/edit {module} substitution to help text for component template name +* [#9062](https://github.com/netbox-community/netbox/issues/9062) - Add/edit {module} substitution to help text for component template name * [#9637](https://github.com/netbox-community/netbox/issues/9637) - Add site group field to rack reservation form * [#9762](https://github.com/netbox-community/netbox/issues/9762) - Add `nat_outside` column to the IPAddress table * [#9825](https://github.com/netbox-community/netbox/issues/9825) - Add contacts column to virtual machines table +### Bug Fixes + +* [#9891](https://github.com/netbox-community/netbox/issues/9891) - Ensure consistent ordering for tags during object serialization + --- ## v3.2.7 (2022-07-20) diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index 2b939471c..da7cdde94 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -148,7 +148,7 @@ def serialize_object(obj, extra=None): # Include any tags. Check for tags cached on the instance; fall back to using the manager. if is_taggable(obj): tags = getattr(obj, '_tags', None) or obj.tags.all() - data['tags'] = [tag.name for tag in tags] + data['tags'] = sorted([tag.name for tag in tags]) # Append any extra data if extra is not None: From 8a075bcff9b3a75ae86cd21eeb3921108594802f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 09:47:18 -0400 Subject: [PATCH 322/593] Fixes #9884: Prevent querying assigned VRF on prefix object init --- docs/release-notes/version-3.2.md | 1 + netbox/ipam/models/ip.py | 2 +- netbox/ipam/signals.py | 4 ++-- 3 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 ed08ad891..caaf079b2 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -11,6 +11,7 @@ ### Bug Fixes +* [#9884](https://github.com/netbox-community/netbox/issues/9884) - Prevent querying assigned VRF on prefix object init * [#9891](https://github.com/netbox-community/netbox/issues/9891) - Ensure consistent ordering for tags during object serialization --- diff --git a/netbox/ipam/models/ip.py b/netbox/ipam/models/ip.py index a3b8fb2c1..d1538953a 100644 --- a/netbox/ipam/models/ip.py +++ b/netbox/ipam/models/ip.py @@ -373,7 +373,7 @@ class Prefix(GetAvailablePrefixesMixin, NetBoxModel): # Cache the original prefix and VRF so we can check if they have changed on post_save self._prefix = self.prefix - self._vrf = self.vrf + self._vrf_id = self.vrf_id def __str__(self): return str(self.prefix) diff --git a/netbox/ipam/signals.py b/netbox/ipam/signals.py index 3e8b86050..8555f5e67 100644 --- a/netbox/ipam/signals.py +++ b/netbox/ipam/signals.py @@ -30,14 +30,14 @@ def update_children_depth(prefix): def handle_prefix_saved(instance, created, **kwargs): # Prefix has changed (or new instance has been created) - if created or instance.vrf != instance._vrf or instance.prefix != instance._prefix: + if created or instance.vrf_id != instance._vrf_id or instance.prefix != instance._prefix: update_parents_children(instance) update_children_depth(instance) # If this is not a new prefix, clean up parent/children of previous prefix if not created: - old_prefix = Prefix(vrf=instance._vrf, prefix=instance._prefix) + old_prefix = Prefix(vrf_id=instance._vrf_id, prefix=instance._prefix) update_parents_children(old_prefix) update_children_depth(old_prefix) From 1bbf5d214b3c58d97c0c600ca2cf4c929f588e5e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 10:23:18 -0400 Subject: [PATCH 323/593] Closes #9881: Increase granularity in utilization graph values --- docs/release-notes/version-3.2.md | 1 + netbox/utilities/templates/helpers/utilization_graph.html | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index caaf079b2..b366d7c8f 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -8,6 +8,7 @@ * [#9637](https://github.com/netbox-community/netbox/issues/9637) - Add site group field to rack reservation form * [#9762](https://github.com/netbox-community/netbox/issues/9762) - Add `nat_outside` column to the IPAddress table * [#9825](https://github.com/netbox-community/netbox/issues/9825) - Add contacts column to virtual machines table +* [#9881](https://github.com/netbox-community/netbox/issues/9881) - Increase granularity in utilization graph values ### Bug Fixes diff --git a/netbox/utilities/templates/helpers/utilization_graph.html b/netbox/utilities/templates/helpers/utilization_graph.html index e6829befc..08e4e6f8a 100644 --- a/netbox/utilities/templates/helpers/utilization_graph.html +++ b/netbox/utilities/templates/helpers/utilization_graph.html @@ -12,10 +12,10 @@ class="progress-bar {{ bar_class }}" style="width: {{ utilization }}%;" > - {% if utilization >= 25 %}{{ utilization|floatformat:0 }}%{% endif %} + {% if utilization >= 25 %}{{ utilization|floatformat }}%{% endif %} {% if utilization < 25 %} - {{ utilization|floatformat:0 }}% + {{ utilization|floatformat }}% {% endif %} {% endif %} From 9646f88384360855fdc000156920eb3365d68d81 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 10:28:21 -0400 Subject: [PATCH 324/593] Fixes #9885: Fix child prefix counts when editing/deleting aggregates in bulk --- docs/release-notes/version-3.2.md | 1 + netbox/ipam/views.py | 8 ++++++-- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index b366d7c8f..8a57f4644 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -13,6 +13,7 @@ ### Bug Fixes * [#9884](https://github.com/netbox-community/netbox/issues/9884) - Prevent querying assigned VRF on prefix object init +* [#9885](https://github.com/netbox-community/netbox/issues/9885) - Fix child prefix counts when editing/deleting aggregates in bulk * [#9891](https://github.com/netbox-community/netbox/issues/9891) - Ensure consistent ordering for tags during object serialization --- diff --git a/netbox/ipam/views.py b/netbox/ipam/views.py index 706670cad..9ae7cd4d7 100644 --- a/netbox/ipam/views.py +++ b/netbox/ipam/views.py @@ -333,14 +333,18 @@ class AggregateBulkImportView(generic.BulkImportView): class AggregateBulkEditView(generic.BulkEditView): - queryset = Aggregate.objects.prefetch_related('rir') + queryset = Aggregate.objects.annotate( + child_count=RawSQL('SELECT COUNT(*) FROM ipam_prefix WHERE ipam_prefix.prefix <<= ipam_aggregate.prefix', ()) + ) filterset = filtersets.AggregateFilterSet table = tables.AggregateTable form = forms.AggregateBulkEditForm class AggregateBulkDeleteView(generic.BulkDeleteView): - queryset = Aggregate.objects.prefetch_related('rir') + queryset = Aggregate.objects.annotate( + child_count=RawSQL('SELECT COUNT(*) FROM ipam_prefix WHERE ipam_prefix.prefix <<= ipam_aggregate.prefix', ()) + ) filterset = filtersets.AggregateFilterSet table = tables.AggregateTable From 3af989763e41fefdfbee1806c7e4c163e148db9b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 10:32:05 -0400 Subject: [PATCH 325/593] Closes #9883: Linkify location column in power panels table --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/tables/power.py | 7 ++++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 8a57f4644..e4c7d9268 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -9,6 +9,7 @@ * [#9762](https://github.com/netbox-community/netbox/issues/9762) - Add `nat_outside` column to the IPAddress table * [#9825](https://github.com/netbox-community/netbox/issues/9825) - Add contacts column to virtual machines table * [#9881](https://github.com/netbox-community/netbox/issues/9881) - Increase granularity in utilization graph values +* [#9883](https://github.com/netbox-community/netbox/issues/9883) - Linkify location column in power panels table ### Bug Fixes diff --git a/netbox/dcim/tables/power.py b/netbox/dcim/tables/power.py index 92c4bb0aa..6696d516a 100644 --- a/netbox/dcim/tables/power.py +++ b/netbox/dcim/tables/power.py @@ -21,6 +21,9 @@ class PowerPanelTable(NetBoxTable): site = tables.Column( linkify=True ) + location = tables.Column( + linkify=True + ) powerfeed_count = columns.LinkedCountColumn( viewname='dcim:powerfeed_list', url_params={'power_panel_id': 'pk'}, @@ -35,7 +38,9 @@ class PowerPanelTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = PowerPanel - fields = ('pk', 'id', 'name', 'site', 'location', 'powerfeed_count', 'contacts', 'tags', 'created', 'last_updated',) + fields = ( + 'pk', 'id', 'name', 'site', 'location', 'powerfeed_count', 'contacts', 'tags', 'created', 'last_updated', + ) default_columns = ('pk', 'name', 'site', 'location', 'powerfeed_count') From efa449faff99205a351553770e7e5186b487b754 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 10:36:53 -0400 Subject: [PATCH 326/593] Closes #9882: Add manufacturer column to modules table --- docs/release-notes/version-3.2.md | 1 + netbox/dcim/tables/modules.py | 12 ++++++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index e4c7d9268..64e229129 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -9,6 +9,7 @@ * [#9762](https://github.com/netbox-community/netbox/issues/9762) - Add `nat_outside` column to the IPAddress table * [#9825](https://github.com/netbox-community/netbox/issues/9825) - Add contacts column to virtual machines table * [#9881](https://github.com/netbox-community/netbox/issues/9881) - Increase granularity in utilization graph values +* [#9882](https://github.com/netbox-community/netbox/issues/9882) - Add manufacturer column to modules table * [#9883](https://github.com/netbox-community/netbox/issues/9883) - Linkify location column in power panels table ### Bug Fixes diff --git a/netbox/dcim/tables/modules.py b/netbox/dcim/tables/modules.py index 5b009e42e..e40d7bd80 100644 --- a/netbox/dcim/tables/modules.py +++ b/netbox/dcim/tables/modules.py @@ -14,6 +14,9 @@ class ModuleTypeTable(NetBoxTable): linkify=True, verbose_name='Module Type' ) + manufacturer = tables.Column( + linkify=True + ) instance_count = columns.LinkedCountColumn( viewname='dcim:module_list', url_params={'module_type_id': 'pk'}, @@ -41,6 +44,10 @@ class ModuleTable(NetBoxTable): module_bay = tables.Column( linkify=True ) + manufacturer = tables.Column( + accessor=tables.A('module_type__manufacturer'), + linkify=True + ) module_type = tables.Column( linkify=True ) @@ -52,8 +59,9 @@ class ModuleTable(NetBoxTable): class Meta(NetBoxTable.Meta): model = Module fields = ( - 'pk', 'id', 'device', 'module_bay', 'module_type', 'serial', 'asset_tag', 'comments', 'tags', + 'pk', 'id', 'device', 'module_bay', 'manufacturer', 'module_type', 'serial', 'asset_tag', 'comments', + 'tags', ) default_columns = ( - 'pk', 'id', 'device', 'module_bay', 'module_type', 'serial', 'asset_tag', + 'pk', 'id', 'device', 'module_bay', 'manufacturer', 'module_type', 'serial', 'asset_tag', ) From 984d15d7fb637f7e5a73fa2138637d11a76f524b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 11:39:07 -0400 Subject: [PATCH 327/593] Closes #9893: Move YAML serialization logic for component templates under the individual models --- .../dcim/models/device_component_templates.py | 79 ++++++++ netbox/dcim/models/devices.py | 179 ++++-------------- 2 files changed, 112 insertions(+), 146 deletions(-) diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index ac0738b3f..f596cf28b 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -160,6 +160,14 @@ class ConsolePortTemplate(ModularComponentTemplateModel): **kwargs ) + def to_yaml(self): + return { + 'name': self.name, + 'type': self.type, + 'label': self.label, + 'description': self.description, + } + class ConsoleServerPortTemplate(ModularComponentTemplateModel): """ @@ -188,6 +196,14 @@ class ConsoleServerPortTemplate(ModularComponentTemplateModel): **kwargs ) + def to_yaml(self): + return { + 'name': self.name, + 'type': self.type, + 'label': self.label, + 'description': self.description, + } + class PowerPortTemplate(ModularComponentTemplateModel): """ @@ -239,6 +255,16 @@ class PowerPortTemplate(ModularComponentTemplateModel): 'allocated_draw': f"Allocated draw cannot exceed the maximum draw ({self.maximum_draw}W)." }) + def to_yaml(self): + return { + 'name': self.name, + 'type': self.type, + 'maximum_draw': self.maximum_draw, + 'allocated_draw': self.allocated_draw, + 'label': self.label, + 'description': self.description, + } + class PowerOutletTemplate(ModularComponentTemplateModel): """ @@ -301,6 +327,16 @@ class PowerOutletTemplate(ModularComponentTemplateModel): **kwargs ) + def to_yaml(self): + return { + 'name': self.name, + 'type': self.type, + 'power_port': self.power_port.name if self.power_port else None, + 'feed_leg': self.feed_leg, + 'label': self.label, + 'description': self.description, + } + class InterfaceTemplate(ModularComponentTemplateModel): """ @@ -340,6 +376,15 @@ class InterfaceTemplate(ModularComponentTemplateModel): **kwargs ) + def to_yaml(self): + return { + 'name': self.name, + 'type': self.type, + 'mgmt_only': self.mgmt_only, + 'label': self.label, + 'description': self.description, + } + class FrontPortTemplate(ModularComponentTemplateModel): """ @@ -413,6 +458,16 @@ class FrontPortTemplate(ModularComponentTemplateModel): **kwargs ) + def to_yaml(self): + return { + 'name': self.name, + 'type': self.type, + 'rear_port': self.rear_port.name, + 'rear_port_position': self.rear_port_position, + 'label': self.label, + 'description': self.description, + } + class RearPortTemplate(ModularComponentTemplateModel): """ @@ -452,6 +507,15 @@ class RearPortTemplate(ModularComponentTemplateModel): **kwargs ) + def to_yaml(self): + return { + 'name': self.name, + 'type': self.type, + 'positions': self.positions, + 'label': self.label, + 'description': self.description, + } + class ModuleBayTemplate(ComponentTemplateModel): """ @@ -477,6 +541,14 @@ class ModuleBayTemplate(ComponentTemplateModel): position=self.position ) + def to_yaml(self): + return { + 'name': self.name, + 'label': self.label, + 'position': self.position, + 'description': self.description, + } + class DeviceBayTemplate(ComponentTemplateModel): """ @@ -501,6 +573,13 @@ class DeviceBayTemplate(ComponentTemplateModel): f"Subdevice role of device type ({self.device_type}) must be set to \"parent\" to allow device bays." ) + def to_yaml(self): + return { + 'name': self.name, + 'label': self.label, + 'description': self.description, + } + class InventoryItemTemplate(MPTTModel, ComponentTemplateModel): """ diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index e88af2d05..91227f1cf 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -1,5 +1,3 @@ -from collections import OrderedDict - import yaml from django.contrib.contenttypes.fields import GenericRelation from django.core.exceptions import ValidationError @@ -161,115 +159,54 @@ class DeviceType(NetBoxModel): return reverse('dcim:devicetype', args=[self.pk]) def to_yaml(self): - data = OrderedDict(( - ('manufacturer', self.manufacturer.name), - ('model', self.model), - ('slug', self.slug), - ('part_number', self.part_number), - ('u_height', self.u_height), - ('is_full_depth', self.is_full_depth), - ('subdevice_role', self.subdevice_role), - ('airflow', self.airflow), - ('comments', self.comments), - )) + data = { + 'manufacturer': self.manufacturer.name, + 'model': self.model, + 'slug': self.slug, + 'part_number': self.part_number, + 'u_height': self.u_height, + 'is_full_depth': self.is_full_depth, + 'subdevice_role': self.subdevice_role, + 'airflow': self.airflow, + 'comments': self.comments, + } # Component templates if self.consoleporttemplates.exists(): data['console-ports'] = [ - { - 'name': c.name, - 'type': c.type, - 'label': c.label, - 'description': c.description, - } - for c in self.consoleporttemplates.all() + c.to_yaml() for c in self.consoleporttemplates.all() ] if self.consoleserverporttemplates.exists(): data['console-server-ports'] = [ - { - 'name': c.name, - 'type': c.type, - 'label': c.label, - 'description': c.description, - } - for c in self.consoleserverporttemplates.all() + c.to_yaml() for c in self.consoleserverporttemplates.all() ] if self.powerporttemplates.exists(): data['power-ports'] = [ - { - 'name': c.name, - 'type': c.type, - 'maximum_draw': c.maximum_draw, - 'allocated_draw': c.allocated_draw, - 'label': c.label, - 'description': c.description, - } - for c in self.powerporttemplates.all() + c.to_yaml() for c in self.powerporttemplates.all() ] if self.poweroutlettemplates.exists(): data['power-outlets'] = [ - { - 'name': c.name, - 'type': c.type, - 'power_port': c.power_port.name if c.power_port else None, - 'feed_leg': c.feed_leg, - 'label': c.label, - 'description': c.description, - } - for c in self.poweroutlettemplates.all() + c.to_yaml() for c in self.poweroutlettemplates.all() ] if self.interfacetemplates.exists(): data['interfaces'] = [ - { - 'name': c.name, - 'type': c.type, - 'mgmt_only': c.mgmt_only, - 'label': c.label, - 'description': c.description, - } - for c in self.interfacetemplates.all() + c.to_yaml() for c in self.interfacetemplates.all() ] if self.frontporttemplates.exists(): data['front-ports'] = [ - { - 'name': c.name, - 'type': c.type, - 'rear_port': c.rear_port.name, - 'rear_port_position': c.rear_port_position, - 'label': c.label, - 'description': c.description, - } - for c in self.frontporttemplates.all() + c.to_yaml() for c in self.frontporttemplates.all() ] if self.rearporttemplates.exists(): data['rear-ports'] = [ - { - 'name': c.name, - 'type': c.type, - 'positions': c.positions, - 'label': c.label, - 'description': c.description, - } - for c in self.rearporttemplates.all() + c.to_yaml() for c in self.rearporttemplates.all() ] if self.modulebaytemplates.exists(): data['module-bays'] = [ - { - 'name': c.name, - 'label': c.label, - 'position': c.position, - 'description': c.description, - } - for c in self.modulebaytemplates.all() + c.to_yaml() for c in self.modulebaytemplates.all() ] if self.devicebaytemplates.exists(): data['device-bays'] = [ - { - 'name': c.name, - 'label': c.label, - 'description': c.description, - } - for c in self.devicebaytemplates.all() + c.to_yaml() for c in self.devicebaytemplates.all() ] return yaml.dump(dict(data), sort_keys=False) @@ -395,91 +332,41 @@ class ModuleType(NetBoxModel): return reverse('dcim:moduletype', args=[self.pk]) def to_yaml(self): - data = OrderedDict(( - ('manufacturer', self.manufacturer.name), - ('model', self.model), - ('part_number', self.part_number), - ('comments', self.comments), - )) + data = { + 'manufacturer': self.manufacturer.name, + 'model': self.model, + 'part_number': self.part_number, + 'comments': self.comments, + } # Component templates if self.consoleporttemplates.exists(): data['console-ports'] = [ - { - 'name': c.name, - 'type': c.type, - 'label': c.label, - 'description': c.description, - } - for c in self.consoleporttemplates.all() + c.to_yaml() for c in self.consoleporttemplates.all() ] if self.consoleserverporttemplates.exists(): data['console-server-ports'] = [ - { - 'name': c.name, - 'type': c.type, - 'label': c.label, - 'description': c.description, - } - for c in self.consoleserverporttemplates.all() + c.to_yaml() for c in self.consoleserverporttemplates.all() ] if self.powerporttemplates.exists(): data['power-ports'] = [ - { - 'name': c.name, - 'type': c.type, - 'maximum_draw': c.maximum_draw, - 'allocated_draw': c.allocated_draw, - 'label': c.label, - 'description': c.description, - } - for c in self.powerporttemplates.all() + c.to_yaml() for c in self.powerporttemplates.all() ] if self.poweroutlettemplates.exists(): data['power-outlets'] = [ - { - 'name': c.name, - 'type': c.type, - 'power_port': c.power_port.name if c.power_port else None, - 'feed_leg': c.feed_leg, - 'label': c.label, - 'description': c.description, - } - for c in self.poweroutlettemplates.all() + c.to_yaml() for c in self.poweroutlettemplates.all() ] if self.interfacetemplates.exists(): data['interfaces'] = [ - { - 'name': c.name, - 'type': c.type, - 'mgmt_only': c.mgmt_only, - 'label': c.label, - 'description': c.description, - } - for c in self.interfacetemplates.all() + c.to_yaml() for c in self.interfacetemplates.all() ] if self.frontporttemplates.exists(): data['front-ports'] = [ - { - 'name': c.name, - 'type': c.type, - 'rear_port': c.rear_port.name, - 'rear_port_position': c.rear_port_position, - 'label': c.label, - 'description': c.description, - } - for c in self.frontporttemplates.all() + c.to_yaml() for c in self.frontporttemplates.all() ] if self.rearporttemplates.exists(): data['rear-ports'] = [ - { - 'name': c.name, - 'type': c.type, - 'positions': c.positions, - 'label': c.label, - 'description': c.description, - } - for c in self.rearporttemplates.all() + c.to_yaml() for c in self.rearporttemplates.all() ] return yaml.dump(dict(data), sort_keys=False) From d4d73674fced54570db111574dae0a080f89ce77 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 11:54:39 -0400 Subject: [PATCH 328/593] Fixes #9871: Fix utilization graph value alignments --- docs/release-notes/version-3.2.md | 1 + .../templates/helpers/utilization_graph.html | 34 ++++++++----------- 2 files changed, 15 insertions(+), 20 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 64e229129..5e538890c 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -14,6 +14,7 @@ ### Bug Fixes +* [#9871](https://github.com/netbox-community/netbox/issues/9871) - Fix utilization graph value alignments * [#9884](https://github.com/netbox-community/netbox/issues/9884) - Prevent querying assigned VRF on prefix object init * [#9885](https://github.com/netbox-community/netbox/issues/9885) - Fix child prefix counts when editing/deleting aggregates in bulk * [#9891](https://github.com/netbox-community/netbox/issues/9891) - Ensure consistent ordering for tags during object serialization diff --git a/netbox/utilities/templates/helpers/utilization_graph.html b/netbox/utilities/templates/helpers/utilization_graph.html index 08e4e6f8a..2a1856abf 100644 --- a/netbox/utilities/templates/helpers/utilization_graph.html +++ b/netbox/utilities/templates/helpers/utilization_graph.html @@ -1,21 +1,15 @@ -{% if utilization == 0 %} -
    - {{ utilization }}% +
    +
    + {% if utilization >= 25 %}{{ utilization|floatformat:1 }}%{% endif %}
    -{% else %} -
    -
    - {% if utilization >= 25 %}{{ utilization|floatformat }}%{% endif %} -
    - {% if utilization < 25 %} - {{ utilization|floatformat }}% - {% endif %} -
    -{% endif %} + {% if utilization < 25 %} + {{ utilization|floatformat:1 }}% + {% endif %} +
    From ff3fcb8134c229033453afadcc1e315c52f3fd20 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 12:38:12 -0400 Subject: [PATCH 329/593] #9871: Tweak display of utilization graph value --- netbox/utilities/templates/helpers/utilization_graph.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/utilities/templates/helpers/utilization_graph.html b/netbox/utilities/templates/helpers/utilization_graph.html index 2a1856abf..967ac8a87 100644 --- a/netbox/utilities/templates/helpers/utilization_graph.html +++ b/netbox/utilities/templates/helpers/utilization_graph.html @@ -7,9 +7,9 @@ class="progress-bar {{ bar_class }}" style="width: {{ utilization }}%;" > - {% if utilization >= 25 %}{{ utilization|floatformat:1 }}%{% endif %} + {% if utilization >= 35 %}{{ utilization|floatformat:1 }}%{% endif %}
    - {% if utilization < 25 %} + {% if utilization < 35 %} {{ utilization|floatformat:1 }}% {% endif %} From 262a0cf397e1bf2cee4d11567b747c163161a838 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 13:29:39 -0400 Subject: [PATCH 330/593] Fixes #9789: Fix rendering of cable traces ending at provider networks --- docs/release-notes/version-3.3.md | 1 + netbox/dcim/api/views.py | 18 +++++++++--------- netbox/dcim/models/device_components.py | 11 +++++++---- netbox/dcim/svg/cables.py | 6 ++++-- 4 files changed, 21 insertions(+), 15 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 68cff0547..e30ff011c 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -104,6 +104,7 @@ Custom field UI visibility has no impact on API operation. * [#9730](https://github.com/netbox-community/netbox/issues/9730) - Fix validation error when creating a new cable via UI form * [#9733](https://github.com/netbox-community/netbox/issues/9733) - Handle split paths during trace when fanning out to front ports with differing cables * [#9765](https://github.com/netbox-community/netbox/issues/9765) - Report correct segment count under cable trace UI view +* [#9789](https://github.com/netbox-community/netbox/issues/9789) - Fix rendering of cable traces ending at provider networks * [#9794](https://github.com/netbox-community/netbox/issues/9794) - Fix link to connect a rear port to a circuit termination * [#9818](https://github.com/netbox-community/netbox/issues/9818) - Fix circuit side selection when connecting a cable to a circuit termination * [#9829](https://github.com/netbox-community/netbox/issues/9829) - Arrange custom fields by group when editing objects diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 59445d97b..32cc3dbba 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -64,20 +64,20 @@ class PathEndpointMixin(object): return HttpResponse(drawing.render().tostring(), content_type='image/svg+xml') # Serialize path objects, iterating over each three-tuple in the path - for near_end, cable, far_end in obj.trace(): - if near_end is not None: - serializer_a = get_serializer_for_model(near_end[0], prefix=NESTED_SERIALIZER_PREFIX) - near_end = serializer_a(near_end, many=True, context={'request': request}).data + for near_ends, cable, far_ends in obj.trace(): + if near_ends: + serializer_a = get_serializer_for_model(near_ends[0], prefix=NESTED_SERIALIZER_PREFIX) + near_ends = serializer_a(near_ends, many=True, context={'request': request}).data else: # Path is split; stop here break - if cable is not None: + if cable: cable = serializers.TracedCableSerializer(cable[0], context={'request': request}).data - if far_end is not None: - serializer_b = get_serializer_for_model(far_end[0], prefix=NESTED_SERIALIZER_PREFIX) - far_end = serializer_b(far_end, many=True, context={'request': request}).data + if far_ends: + serializer_b = get_serializer_for_model(far_ends[0], prefix=NESTED_SERIALIZER_PREFIX) + far_ends = serializer_b(far_ends, many=True, context={'request': request}).data - path.append((near_end, cable, far_end)) + path.append((near_ends, cable, far_ends)) return Response(path) diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 8f62b0626..5e2fc348e 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -212,10 +212,13 @@ class PathEndpoint(models.Model): break path.extend(origin._path.path_objects) - while (len(path)) % 3: - # Pad to ensure we have complete three-tuples (e.g. for paths that end at a non-connected FrontPort) - # by inserting empty entries immediately prior to the path's destination node(s) - path.append([]) + + # If the path ends at a non-connected pass-through port, pad out the link and far-end terminations + if len(path) % 3 == 1: + path.extend(([], [])) + # If the path ends at a site or provider network, inject a null "link" to render an attachment + elif len(path) % 3 == 2: + path.insert(-1, []) # Check for a bridged relationship to continue the trace destinations = origin._path.destinations diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py index f9c614b67..3b259eca2 100644 --- a/netbox/dcim/svg/cables.py +++ b/netbox/dcim/svg/cables.py @@ -369,14 +369,16 @@ class CableTraceSVG: parent_objects = set(end.parent_object for end in far_ends) self.draw_parent_objects(parent_objects) + # Render a far-end object not connected via a link (e.g. a ProviderNetwork or Site associated with + # a CircuitTermination) elif far_ends: # Attachment attachment = self.draw_attachment() self.connectors.append(attachment) - # ProviderNetwork - self.draw_parent_objects(set(end.parent_object for end in far_ends)) + # Object + self.draw_parent_objects(far_ends) # Determine drawing size self.drawing = svgwrite.Drawing( From 29a611c7293741100f3e5351243dffbae8e5b481 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 1 Aug 2022 16:51:44 -0400 Subject: [PATCH 331/593] Closes #9896: Discontinue arbitrary use of OrderedDict --- netbox/dcim/api/views.py | 3 +- netbox/dcim/views.py | 44 +++++++++++----------- netbox/extras/reports.py | 17 ++++----- netbox/extras/scripts.py | 5 +-- netbox/extras/templatetags/custom_links.py | 4 +- netbox/ipam/api/serializers.py | 32 ++++++++-------- netbox/netbox/api/fields.py | 10 ++--- netbox/netbox/api/views.py | 25 ++++++------ netbox/utilities/utils.py | 3 +- 9 files changed, 65 insertions(+), 78 deletions(-) diff --git a/netbox/dcim/api/views.py b/netbox/dcim/api/views.py index 32cc3dbba..c18eab01f 100644 --- a/netbox/dcim/api/views.py +++ b/netbox/dcim/api/views.py @@ -1,5 +1,4 @@ import socket -from collections import OrderedDict from django.http import Http404, HttpResponse, HttpResponseForbidden from django.shortcuts import get_object_or_404 @@ -484,7 +483,7 @@ class DeviceViewSet(ConfigContextQuerySetMixin, NetBoxModelViewSet): return HttpResponseForbidden() napalm_methods = request.GET.getlist('method') - response = OrderedDict([(m, None) for m in napalm_methods]) + response = {m: None for m in napalm_methods} config = get_config() username = config.NAPALM_USERNAME diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 6daecb3a6..4480bee6e 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -1,5 +1,3 @@ -from collections import OrderedDict - from django.contrib import messages from django.contrib.contenttypes.models import ContentType from django.core.paginator import EmptyPage, PageNotAnInteger @@ -945,18 +943,18 @@ class DeviceTypeImportView(generic.ObjectImportView): ] queryset = DeviceType.objects.all() model_form = forms.DeviceTypeImportForm - related_object_forms = OrderedDict(( - ('console-ports', forms.ConsolePortTemplateImportForm), - ('console-server-ports', forms.ConsoleServerPortTemplateImportForm), - ('power-ports', forms.PowerPortTemplateImportForm), - ('power-outlets', forms.PowerOutletTemplateImportForm), - ('interfaces', forms.InterfaceTemplateImportForm), - ('rear-ports', forms.RearPortTemplateImportForm), - ('front-ports', forms.FrontPortTemplateImportForm), - ('module-bays', forms.ModuleBayTemplateImportForm), - ('device-bays', forms.DeviceBayTemplateImportForm), - ('inventory-items', forms.InventoryItemTemplateImportForm), - )) + related_object_forms = { + 'console-ports': forms.ConsolePortTemplateImportForm, + 'console-server-ports': forms.ConsoleServerPortTemplateImportForm, + 'power-ports': forms.PowerPortTemplateImportForm, + 'power-outlets': forms.PowerOutletTemplateImportForm, + 'interfaces': forms.InterfaceTemplateImportForm, + 'rear-ports': forms.RearPortTemplateImportForm, + 'front-ports': forms.FrontPortTemplateImportForm, + 'module-bays': forms.ModuleBayTemplateImportForm, + 'device-bays': forms.DeviceBayTemplateImportForm, + 'inventory-items': forms.InventoryItemTemplateImportForm, + } def prep_related_object_data(self, parent, data): data.update({'device_type': parent}) @@ -1075,15 +1073,15 @@ class ModuleTypeImportView(generic.ObjectImportView): ] queryset = ModuleType.objects.all() model_form = forms.ModuleTypeImportForm - related_object_forms = OrderedDict(( - ('console-ports', forms.ConsolePortTemplateImportForm), - ('console-server-ports', forms.ConsoleServerPortTemplateImportForm), - ('power-ports', forms.PowerPortTemplateImportForm), - ('power-outlets', forms.PowerOutletTemplateImportForm), - ('interfaces', forms.InterfaceTemplateImportForm), - ('rear-ports', forms.RearPortTemplateImportForm), - ('front-ports', forms.FrontPortTemplateImportForm), - )) + related_object_forms = { + 'console-ports': forms.ConsolePortTemplateImportForm, + 'console-server-ports': forms.ConsoleServerPortTemplateImportForm, + 'power-ports': forms.PowerPortTemplateImportForm, + 'power-outlets': forms.PowerOutletTemplateImportForm, + 'interfaces': forms.InterfaceTemplateImportForm, + 'rear-ports': forms.RearPortTemplateImportForm, + 'front-ports': forms.FrontPortTemplateImportForm, + } def prep_related_object_data(self, parent, data): data.update({'module_type': parent}) diff --git a/netbox/extras/reports.py b/netbox/extras/reports.py index 0a8a8d89b..43d916aff 100644 --- a/netbox/extras/reports.py +++ b/netbox/extras/reports.py @@ -3,7 +3,6 @@ import inspect import logging import pkgutil import traceback -from collections import OrderedDict from django.conf import settings from django.utils import timezone @@ -114,7 +113,7 @@ class Report(object): def __init__(self): - self._results = OrderedDict() + self._results = {} self.active_test = None self.failed = False @@ -125,13 +124,13 @@ class Report(object): for method in dir(self): if method.startswith('test_') and callable(getattr(self, method)): test_methods.append(method) - self._results[method] = OrderedDict([ - ('success', 0), - ('info', 0), - ('warning', 0), - ('failure', 0), - ('log', []), - ]) + self._results[method] = { + 'success': 0, + 'info': 0, + 'warning': 0, + 'failure': 0, + 'log': [], + } if not test_methods: raise Exception("A report must contain at least one test method.") self.test_methods = test_methods diff --git a/netbox/extras/scripts.py b/netbox/extras/scripts.py index cee264878..6e4478304 100644 --- a/netbox/extras/scripts.py +++ b/netbox/extras/scripts.py @@ -6,7 +6,6 @@ import pkgutil import sys import traceback import threading -from collections import OrderedDict import yaml from django import forms @@ -496,7 +495,7 @@ def get_scripts(use_names=False): Return a dict of dicts mapping all scripts to their modules. Set use_names to True to use each module's human- defined name in place of the actual module name. """ - scripts = OrderedDict() + scripts = {} # 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]): @@ -510,7 +509,7 @@ def get_scripts(use_names=False): if use_names and hasattr(module, 'name'): module_name = module.name - module_scripts = OrderedDict() + module_scripts = {} script_order = getattr(module, "script_order", ()) ordered_scripts = [cls for cls in script_order if is_script(cls)] unordered_scripts = [cls for _, cls in inspect.getmembers(module, is_script) if cls not in script_order] diff --git a/netbox/extras/templatetags/custom_links.py b/netbox/extras/templatetags/custom_links.py index d963bd25a..a73eb3fb4 100644 --- a/netbox/extras/templatetags/custom_links.py +++ b/netbox/extras/templatetags/custom_links.py @@ -1,5 +1,3 @@ -from collections import OrderedDict - from django import template from django.contrib.contenttypes.models import ContentType from django.utils.safestring import mark_safe @@ -50,7 +48,7 @@ def custom_links(context, obj): 'perms': context['perms'], # django.contrib.auth.context_processors.auth } template_code = '' - group_names = OrderedDict() + group_names = {} for cl in custom_links: diff --git a/netbox/ipam/api/serializers.py b/netbox/ipam/api/serializers.py index b3a3589fd..91a81d3b2 100644 --- a/netbox/ipam/api/serializers.py +++ b/netbox/ipam/api/serializers.py @@ -1,5 +1,3 @@ -from collections import OrderedDict - from django.contrib.contenttypes.models import ContentType from drf_yasg.utils import swagger_serializer_method from rest_framework import serializers @@ -227,13 +225,13 @@ class AvailableVLANSerializer(serializers.Serializer): group = NestedVLANGroupSerializer(read_only=True) def to_representation(self, instance): - return OrderedDict([ - ('vid', instance), - ('group', NestedVLANGroupSerializer( + return { + 'vid': instance, + 'group': NestedVLANGroupSerializer( self.context['group'], context={'request': self.context['request']} - ).data), - ]) + ).data, + } class CreateAvailableVLANSerializer(NetBoxModelSerializer): @@ -318,11 +316,11 @@ class AvailablePrefixSerializer(serializers.Serializer): vrf = NestedVRFSerializer(self.context['vrf'], context={'request': self.context['request']}).data else: vrf = None - return OrderedDict([ - ('family', instance.version), - ('prefix', str(instance)), - ('vrf', vrf), - ]) + return { + 'family': instance.version, + 'prefix': str(instance), + 'vrf': vrf, + } # @@ -397,11 +395,11 @@ class AvailableIPSerializer(serializers.Serializer): vrf = NestedVRFSerializer(self.context['vrf'], context={'request': self.context['request']}).data else: vrf = None - return OrderedDict([ - ('family', self.context['parent'].family), - ('address', f"{instance}/{self.context['parent'].mask_length}"), - ('vrf', vrf), - ]) + return { + 'family': self.context['parent'].family, + 'address': f"{instance}/{self.context['parent'].mask_length}", + 'vrf': vrf, + } # diff --git a/netbox/netbox/api/fields.py b/netbox/netbox/api/fields.py index 1f3c40dc2..52343c2f6 100644 --- a/netbox/netbox/api/fields.py +++ b/netbox/netbox/api/fields.py @@ -1,5 +1,3 @@ -from collections import OrderedDict - from django.core.exceptions import ObjectDoesNotExist from netaddr import IPNetwork from rest_framework import serializers @@ -48,10 +46,10 @@ class ChoiceField(serializers.Field): def to_representation(self, obj): if obj == '': return None - return OrderedDict([ - ('value', obj), - ('label', self._choices[obj]) - ]) + return { + 'value': obj, + 'label': self._choices[obj], + } def to_internal_value(self, data): if data == '': diff --git a/netbox/netbox/api/views.py b/netbox/netbox/api/views.py index 835ebc6a9..6c6083959 100644 --- a/netbox/netbox/api/views.py +++ b/netbox/netbox/api/views.py @@ -1,5 +1,4 @@ import platform -from collections import OrderedDict from django import __version__ as DJANGO_VERSION from django.apps import apps @@ -26,18 +25,18 @@ class APIRootView(APIView): def get(self, request, format=None): - return Response(OrderedDict(( - ('circuits', reverse('circuits-api:api-root', request=request, format=format)), - ('dcim', reverse('dcim-api:api-root', request=request, format=format)), - ('extras', reverse('extras-api:api-root', request=request, format=format)), - ('ipam', reverse('ipam-api:api-root', request=request, format=format)), - ('plugins', reverse('plugins-api:api-root', request=request, format=format)), - ('status', reverse('api-status', request=request, format=format)), - ('tenancy', reverse('tenancy-api:api-root', request=request, format=format)), - ('users', reverse('users-api:api-root', request=request, format=format)), - ('virtualization', reverse('virtualization-api:api-root', request=request, format=format)), - ('wireless', reverse('wireless-api:api-root', request=request, format=format)), - ))) + return Response({ + 'circuits': reverse('circuits-api:api-root', request=request, format=format), + 'dcim': reverse('dcim-api:api-root', request=request, format=format), + 'extras': reverse('extras-api:api-root', request=request, format=format), + 'ipam': reverse('ipam-api:api-root', request=request, format=format), + 'plugins': reverse('plugins-api:api-root', request=request, format=format), + 'status': reverse('api-status', request=request, format=format), + 'tenancy': reverse('tenancy-api:api-root', request=request, format=format), + 'users': reverse('users-api:api-root', request=request, format=format), + 'virtualization': reverse('virtualization-api:api-root', request=request, format=format), + 'wireless': reverse('wireless-api:api-root', request=request, format=format), + }) class StatusView(APIView): diff --git a/netbox/utilities/utils.py b/netbox/utilities/utils.py index fa0534ec0..1dece76c8 100644 --- a/netbox/utilities/utils.py +++ b/netbox/utilities/utils.py @@ -1,7 +1,6 @@ import datetime import decimal import json -from collections import OrderedDict from decimal import Decimal from itertools import count, groupby @@ -218,7 +217,7 @@ def deepmerge(original, new): """ Deep merge two dictionaries (new into original) and return a new dict """ - merged = OrderedDict(original) + merged = dict(original) for key, val in new.items(): if key in original and isinstance(original[key], dict) and val and isinstance(val, dict): merged[key] = deepmerge(original[key], val) From e96620260a6c1b5cf8cff2112d40d061984a7b2c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 2 Aug 2022 13:49:34 -0400 Subject: [PATCH 332/593] Closes #9903: Implement a mechanism for automatically updating denormalized fields --- docs/release-notes/version-3.3.md | 1 + netbox/extras/registry.py | 1 + netbox/netbox/denormalized.py | 54 +++++++++++++++++++++++++++++++ 3 files changed, 56 insertions(+) create mode 100644 netbox/netbox/denormalized.py diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index e30ff011c..49d6891e2 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -124,6 +124,7 @@ Custom field UI visibility has no impact on API operation. * [#9261](https://github.com/netbox-community/netbox/issues/9261) - `NetBoxTable` no longer automatically clears pre-existing calls to `prefetch_related()` on its queryset * [#9434](https://github.com/netbox-community/netbox/issues/9434) - Enabled `django-rich` test runner for more user-friendly output +* [#9903](https://github.com/netbox-community/netbox/issues/9903) - Implement a mechanism for automatically updating denormalized fields ### REST API Changes diff --git a/netbox/extras/registry.py b/netbox/extras/registry.py index 07fd4cc24..e1437c00e 100644 --- a/netbox/extras/registry.py +++ b/netbox/extras/registry.py @@ -28,3 +28,4 @@ registry = Registry() registry['model_features'] = { feature: collections.defaultdict(set) for feature in EXTRAS_FEATURES } +registry['denormalized_fields'] = collections.defaultdict(list) diff --git a/netbox/netbox/denormalized.py b/netbox/netbox/denormalized.py new file mode 100644 index 000000000..5808acddc --- /dev/null +++ b/netbox/netbox/denormalized.py @@ -0,0 +1,54 @@ +import logging + +from django.db.models.signals import post_save +from django.dispatch import receiver + +from extras.registry import registry + + +logger = logging.getLogger('netbox.denormalized') + + +def register(model, field_name, mappings): + """ + Register a denormalized model field to ensure that it is kept up-to-date with the related object. + + Args: + model: The class being updated + field_name: The name of the field related to the triggering instance + mappings: Dictionary mapping of local to remote fields + """ + logger.debug(f'Registering denormalized field {model}.{field_name}') + + field = model._meta.get_field(field_name) + rel_model = field.related_model + + registry['denormalized_fields'][rel_model].append( + (model, field_name, mappings) + ) + + +@receiver(post_save) +def update_denormalized_fields(sender, instance, created, raw, **kwargs): + """ + Check if the sender has denormalized fields registered, and update them as necessary. + """ + # Skip for new objects or those being populated from raw data + if created or raw: + return + + # Look up any denormalized fields referencing this model from the application registry + for model, field_name, mappings in registry['denormalized_fields'].get(sender, []): + logger.debug(f'Updating denormalized values for {model}.{field_name}') + filter_params = { + field_name: instance.pk, + } + update_params = { + # Map the denormalized field names to the instance's values + denorm: getattr(instance, origin) for denorm, origin in mappings.items() + } + + # TODO: Improve efficiency here by placing conditions on the query? + # Update all the denormalized fields with the triggering object's new values + count = model.objects.filter(**filter_params).update(**update_params) + logger.debug(f'Updated {count} rows') From 5b3ef045506100c6fdf6ae9a15d7f717a1fd0f15 Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 2 Aug 2022 12:38:16 -0500 Subject: [PATCH 333/593] #9888 - Add filter and columns for device and site --- netbox/ipam/filtersets.py | 83 +++++++++++++++++++++++++++------ netbox/ipam/forms/filtersets.py | 44 ++++++++++++++++- netbox/ipam/models/l2vpn.py | 15 ++++++ netbox/ipam/tables/l2vpn.py | 11 ++++- 4 files changed, 136 insertions(+), 17 deletions(-) diff --git a/netbox/ipam/filtersets.py b/netbox/ipam/filtersets.py index edd1867ed..132094325 100644 --- a/netbox/ipam/filtersets.py +++ b/netbox/ipam/filtersets.py @@ -980,21 +980,65 @@ class L2VPNTerminationFilterSet(NetBoxModelFilterSet): to_field_name='slug', label='L2VPN (slug)', ) - device = MultiValueCharFilter( - method='filter_device', - field_name='name', - label='Device (name)', + region = MultiValueCharFilter( + method='filter_region', + field_name='slug', + label='Region (slug)', ) - device_id = MultiValueNumberFilter( - method='filter_device', + region_id = MultiValueNumberFilter( + method='filter_region', + field_name='pk', + label='Region (ID)', + ) + site = MultiValueCharFilter( + method='filter_site', + field_name='slug', + label='Device (slug)', + ) + site_id = MultiValueNumberFilter( + method='filter_site', field_name='pk', label='Device (ID)', ) + device = django_filters.ModelMultipleChoiceFilter( + field_name='interface__device__name', + queryset=Device.objects.all(), + to_field_name='name', + label='Device (name)', + ) + device_id = django_filters.ModelMultipleChoiceFilter( + field_name='interface__device', + queryset=Device.objects.all(), + label='Device (ID)', + ) + virtual_machine = django_filters.ModelMultipleChoiceFilter( + field_name='vminterface__virtual_machine__name', + queryset=VirtualMachine.objects.all(), + to_field_name='name', + label='Virtual machine (name)', + ) + virtual_machine_id = django_filters.ModelMultipleChoiceFilter( + field_name='vminterface__virtual_machine', + queryset=VirtualMachine.objects.all(), + label='Virtual machine (ID)', + ) + interface = django_filters.ModelMultipleChoiceFilter( + field_name='interface__name', + queryset=Interface.objects.all(), + to_field_name='name', + label='Interface (name)', + ) interface_id = django_filters.ModelMultipleChoiceFilter( field_name='interface', queryset=Interface.objects.all(), label='Interface (ID)', ) + vminterface = django_filters.ModelMultipleChoiceFilter( + field_name='vminterface__name', + queryset=VMInterface.objects.all(), + to_field_name='name', + label='VM interface (name)', + ) vminterface_id = django_filters.ModelMultipleChoiceFilter( field_name='vminterface', queryset=VMInterface.objects.all(), @@ -1027,13 +1071,22 @@ class L2VPNTerminationFilterSet(NetBoxModelFilterSet): qs_filter = Q(l2vpn__name__icontains=value) return queryset.filter(qs_filter) - def filter_device(self, queryset, name, value): - devices = Device.objects.filter(**{'{}__in'.format(name): value}) - if not devices.exists(): - return queryset.none() - interface_ids = [] - for device in devices: - interface_ids.extend(device.vc_interfaces().values_list('id', flat=True)) - return queryset.filter( - interface__in=interface_ids + def filter_site(self, queryset, name, value): + qs = queryset.filter( + Q( + Q(**{'vlan__site__{}__in'.format(name): value}) | + Q(**{'interface__device__site__{}__in'.format(name): value}) | + Q(**{'vminterface__virtual_machine__site__{}__in'.format(name): value}) + ) ) + return qs + + def filter_region(self, queryset, name, value): + qs = queryset.filter( + Q( + Q(**{'vlan__site__region__{}__in'.format(name): value}) | + Q(**{'interface__device__site__region__{}__in'.format(name): value}) | + Q(**{'vminterface__virtual_machine__site__region__{}__in'.format(name): value}) + ) + ) + return qs diff --git a/netbox/ipam/forms/filtersets.py b/netbox/ipam/forms/filtersets.py index 384a4da33..d93bd16d0 100644 --- a/netbox/ipam/forms/filtersets.py +++ b/netbox/ipam/forms/filtersets.py @@ -508,7 +508,8 @@ class L2VPNFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): class L2VPNTerminationFilterForm(NetBoxModelFilterSetForm): model = L2VPNTermination fieldsets = ( - (None, ('l2vpn_id', 'assigned_object_type_id')), + (None, ('l2vpn_id', 'assigned_object_type_id', )), + ('Assigned Object', ('region_id', 'site_id', 'device_id', 'virtual_machine_id', 'vlan_id')), ) l2vpn_id = DynamicModelChoiceField( queryset=L2VPN.objects.all(), @@ -520,3 +521,44 @@ class L2VPNTerminationFilterForm(NetBoxModelFilterSetForm): required=False, label='Object type' ) + region_id = DynamicModelMultipleChoiceField( + queryset=Region.objects.all(), + required=False, + label=_('Region') + ) + site_id = DynamicModelMultipleChoiceField( + queryset=Site.objects.all(), + required=False, + null_option='None', + query_params={ + 'region_id': '$region_id' + }, + label=_('Site') + ) + device_id = DynamicModelMultipleChoiceField( + queryset=Device.objects.all(), + required=False, + null_option='None', + query_params={ + 'site_id': '$site_id' + }, + label=_('Device') + ) + vlan_id = DynamicModelMultipleChoiceField( + queryset=VLAN.objects.all(), + required=False, + null_option='None', + query_params={ + 'site_id': '$site_id' + }, + label=_('VLAN') + ) + virtual_machine_id = DynamicModelMultipleChoiceField( + queryset=VirtualMachine.objects.all(), + required=False, + null_option='None', + query_params={ + 'site_id': '$site_id' + }, + label=_('Virtual Machine') + ) diff --git a/netbox/ipam/models/l2vpn.py b/netbox/ipam/models/l2vpn.py index 5d85fe915..5adf5e05d 100644 --- a/netbox/ipam/models/l2vpn.py +++ b/netbox/ipam/models/l2vpn.py @@ -113,3 +113,18 @@ class L2VPNTermination(NetBoxModel): f'{l2vpn_type} L2VPNs cannot have more than two terminations; found {terminations_count} already ' f'defined.' ) + + @property + def assigned_object_parent(self): + obj_type = ContentType.objects.get_for_model(self.assigned_object) + if obj_type.model == 'vminterface': + return self.assigned_object.virtual_machine + elif obj_type.model == 'interface': + return self.assigned_object.device + elif obj_type.model == 'vminterface': + return self.assigned_object.virtual_machine + return None + + @property + def assigned_object_site(self): + return self.assigned_object_parent.site diff --git a/netbox/ipam/tables/l2vpn.py b/netbox/ipam/tables/l2vpn.py index 5be525343..e2eae7a32 100644 --- a/netbox/ipam/tables/l2vpn.py +++ b/netbox/ipam/tables/l2vpn.py @@ -53,8 +53,17 @@ class L2VPNTerminationTable(NetBoxTable): linkify=True, orderable=False ) + assigned_object_parent = tables.Column( + linkify=True, + orderable=False + ) + assigned_object_site = tables.Column( + linkify=True, + orderable=False + ) class Meta(NetBoxTable.Meta): model = L2VPNTermination - fields = ('pk', 'l2vpn', 'assigned_object_type', 'assigned_object', 'actions') + fields = ('pk', 'l2vpn', 'assigned_object_type', 'assigned_object', 'assigned_object_parent', + 'assigned_object_site', 'actions') default_columns = ('pk', 'l2vpn', 'assigned_object_type', 'assigned_object', 'actions') From d3a567a2f565097d7409d888dacabda2c59f42f6 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 2 Aug 2022 13:56:52 -0400 Subject: [PATCH 334/593] Fixes #9788: Ensure denormalized fields on CableTermination are kept in sync with related objects --- docs/release-notes/version-3.3.md | 1 + netbox/dcim/apps.py | 18 +++++++++++++++++- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 49d6891e2..5d043a777 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -104,6 +104,7 @@ Custom field UI visibility has no impact on API operation. * [#9730](https://github.com/netbox-community/netbox/issues/9730) - Fix validation error when creating a new cable via UI form * [#9733](https://github.com/netbox-community/netbox/issues/9733) - Handle split paths during trace when fanning out to front ports with differing cables * [#9765](https://github.com/netbox-community/netbox/issues/9765) - Report correct segment count under cable trace UI view +* [#9788](https://github.com/netbox-community/netbox/issues/9788) - Ensure denormalized fields on CableTermination are kept in sync with related objects * [#9789](https://github.com/netbox-community/netbox/issues/9789) - Fix rendering of cable traces ending at provider networks * [#9794](https://github.com/netbox-community/netbox/issues/9794) - Fix link to connect a rear port to a circuit termination * [#9818](https://github.com/netbox-community/netbox/issues/9818) - Fix circuit side selection when connecting a cable to a circuit termination diff --git a/netbox/dcim/apps.py b/netbox/dcim/apps.py index 78a243f84..4be2df659 100644 --- a/netbox/dcim/apps.py +++ b/netbox/dcim/apps.py @@ -1,10 +1,26 @@ from django.apps import AppConfig +from netbox import denormalized + class DCIMConfig(AppConfig): name = "dcim" verbose_name = "DCIM" def ready(self): - import dcim.signals + from .models import CableTermination + + # Register denormalized fields + denormalized.register(CableTermination, '_device', { + '_rack': 'rack', + '_location': 'location', + '_site': 'site', + }) + denormalized.register(CableTermination, '_rack', { + '_location': 'location', + '_site': 'site', + }) + denormalized.register(CableTermination, '_location', { + '_site': 'site', + }) From 37c4f1a7d3509f137a5a81d1b570d10a7533ccae Mon Sep 17 00:00:00 2001 From: Daniel Sheppard Date: Tue, 2 Aug 2022 13:38:17 -0500 Subject: [PATCH 335/593] Fix up a few minor mistakes. Add tests. --- netbox/ipam/filtersets.py | 4 ++-- netbox/ipam/forms/filtersets.py | 11 ++++++----- netbox/ipam/tests/test_filtersets.py | 21 +++++++++++++++++++++ 3 files changed, 29 insertions(+), 7 deletions(-) diff --git a/netbox/ipam/filtersets.py b/netbox/ipam/filtersets.py index 132094325..49ec15fc1 100644 --- a/netbox/ipam/filtersets.py +++ b/netbox/ipam/filtersets.py @@ -993,12 +993,12 @@ class L2VPNTerminationFilterSet(NetBoxModelFilterSet): site = MultiValueCharFilter( method='filter_site', field_name='slug', - label='Device (slug)', + label='Site (slug)', ) site_id = MultiValueNumberFilter( method='filter_site', field_name='pk', - label='Device (ID)', + label='Site (ID)', ) device = django_filters.ModelMultipleChoiceFilter( field_name='interface__device__name', diff --git a/netbox/ipam/forms/filtersets.py b/netbox/ipam/forms/filtersets.py index d93bd16d0..ecf63b49f 100644 --- a/netbox/ipam/forms/filtersets.py +++ b/netbox/ipam/forms/filtersets.py @@ -11,7 +11,7 @@ from netbox.forms import NetBoxModelFilterSetForm from tenancy.forms import TenancyFilterForm from utilities.forms import ( add_blank_choice, ContentTypeMultipleChoiceField, DynamicModelChoiceField, DynamicModelMultipleChoiceField, - MultipleChoiceField, StaticSelect, TagFilterField, BOOLEAN_WITH_BLANK_CHOICES, + MultipleChoiceField, StaticSelect, TagFilterField, BOOLEAN_WITH_BLANK_CHOICES, APISelectMultiple, ) from virtualization.models import VirtualMachine @@ -508,8 +508,8 @@ class L2VPNFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm): class L2VPNTerminationFilterForm(NetBoxModelFilterSetForm): model = L2VPNTermination fieldsets = ( - (None, ('l2vpn_id', 'assigned_object_type_id', )), - ('Assigned Object', ('region_id', 'site_id', 'device_id', 'virtual_machine_id', 'vlan_id')), + (None, ('l2vpn_id', )), + ('Assigned Object', ('assigned_object_type_id', 'region_id', 'site_id', 'device_id', 'virtual_machine_id', 'vlan_id')), ) l2vpn_id = DynamicModelChoiceField( queryset=L2VPN.objects.all(), @@ -517,9 +517,10 @@ class L2VPNTerminationFilterForm(NetBoxModelFilterSetForm): label='L2VPN' ) assigned_object_type_id = ContentTypeMultipleChoiceField( - queryset=ContentType.objects.all(), + queryset=ContentType.objects.filter(L2VPN_ASSIGNMENT_MODELS), required=False, - label='Object type' + label=_('Assigned Object Type'), + limit_choices_to=L2VPN_ASSIGNMENT_MODELS ) region_id = DynamicModelMultipleChoiceField( queryset=Region.objects.all(), diff --git a/netbox/ipam/tests/test_filtersets.py b/netbox/ipam/tests/test_filtersets.py index 9106a4965..081f6e11d 100644 --- a/netbox/ipam/tests/test_filtersets.py +++ b/netbox/ipam/tests/test_filtersets.py @@ -1600,3 +1600,24 @@ class L2VPNTerminationTestCase(TestCase, ChangeLoggedFilterSetTests): self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) params = {'vlan': ['VLAN 1', 'VLAN 2']} self.assertEqual(self.filterset(params, self.queryset).qs.count(), 2) + + def test_site(self): + site = Site.objects.all().first() + params = {'site_id': [site.pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) + params = {'site': ['site-1']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) + + def test_device(self): + device = Device.objects.all().first() + params = {'device_id': [device.pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) + params = {'device': ['Device 1']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) + + def test_virtual_machine(self): + virtual_machine = VirtualMachine.objects.all().first() + params = {'virtual_machine_id': [virtual_machine.pk]} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) + params = {'virtual_machine': ['Virtual Machine 1']} + self.assertEqual(self.filterset(params, self.queryset).qs.count(), 3) From c6e25f068d7aeb77f18add68ccab9ced6ff68d9a Mon Sep 17 00:00:00 2001 From: Jason Lavoie Date: Tue, 2 Aug 2022 20:39:56 -0400 Subject: [PATCH 336/593] import/export color field on front- and rear-ports for module-types and device-types Closes: #9906 - Adds `color` field to front and rearport template import forms - Adds `color` field to `to_yaml` export for front and rearport templates --- netbox/dcim/forms/object_import.py | 4 ++-- netbox/dcim/models/device_component_templates.py | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/forms/object_import.py b/netbox/dcim/forms/object_import.py index afbcd6543..606333e83 100644 --- a/netbox/dcim/forms/object_import.py +++ b/netbox/dcim/forms/object_import.py @@ -146,7 +146,7 @@ class FrontPortTemplateImportForm(ComponentTemplateImportForm): class Meta: model = FrontPortTemplate fields = [ - 'device_type', 'module_type', 'name', 'type', 'rear_port', 'rear_port_position', 'label', 'description', + 'device_type', 'module_type', 'name', 'type', 'color', 'rear_port', 'rear_port_position', 'label', 'description', ] @@ -158,7 +158,7 @@ class RearPortTemplateImportForm(ComponentTemplateImportForm): class Meta: model = RearPortTemplate fields = [ - 'device_type', 'module_type', 'name', 'type', 'positions', 'label', 'description', + 'device_type', 'module_type', 'name', 'type', 'color', 'positions', 'label', 'description', ] diff --git a/netbox/dcim/models/device_component_templates.py b/netbox/dcim/models/device_component_templates.py index f596cf28b..74252e480 100644 --- a/netbox/dcim/models/device_component_templates.py +++ b/netbox/dcim/models/device_component_templates.py @@ -462,6 +462,7 @@ class FrontPortTemplate(ModularComponentTemplateModel): return { 'name': self.name, 'type': self.type, + 'color': self.color, 'rear_port': self.rear_port.name, 'rear_port_position': self.rear_port_position, 'label': self.label, @@ -511,6 +512,7 @@ class RearPortTemplate(ModularComponentTemplateModel): return { 'name': self.name, 'type': self.type, + 'color': self.color, 'positions': self.positions, 'label': self.label, 'description': self.description, From b9678c7c0e50c9b2f24aec95a0d8c13c1b20f3dd Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 3 Aug 2022 10:50:35 -0400 Subject: [PATCH 337/593] Closes #9853: Show full object in cable A/B termination lists --- netbox/netbox/api/serializers/generic.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/netbox/netbox/api/serializers/generic.py b/netbox/netbox/api/serializers/generic.py index 8b4069c98..5016bdaab 100644 --- a/netbox/netbox/api/serializers/generic.py +++ b/netbox/netbox/api/serializers/generic.py @@ -1,7 +1,10 @@ from django.contrib.contenttypes.models import ContentType +from drf_yasg.utils import swagger_serializer_method from rest_framework import serializers from netbox.api.fields import ContentTypeField +from netbox.constants import NESTED_SERIALIZER_PREFIX +from utilities.api import get_serializer_for_model from utilities.utils import content_type_identifier __all__ = ( @@ -17,6 +20,7 @@ class GenericObjectSerializer(serializers.Serializer): queryset=ContentType.objects.all() ) object_id = serializers.IntegerField() + object = serializers.SerializerMethodField(read_only=True) def to_internal_value(self, data): data = super().to_internal_value(data) @@ -25,7 +29,17 @@ class GenericObjectSerializer(serializers.Serializer): def to_representation(self, instance): ct = ContentType.objects.get_for_model(instance) - return { + data = { 'object_type': content_type_identifier(ct), 'object_id': instance.pk, } + if 'request' in self.context: + data['object'] = self.get_object(instance) + + return data + + @swagger_serializer_method(serializer_or_field=serializers.DictField) + def get_object(self, obj): + serializer = get_serializer_for_model(obj, prefix=NESTED_SERIALIZER_PREFIX) + # context = {'request': self.context['request']} + return serializer(obj, context=self.context).data From 367bf25618d1be55c10b7e707101f2759711e855 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 3 Aug 2022 12:46:16 -0400 Subject: [PATCH 338/593] Fixes #9778: Fix exception during cable deletion after deleting a connected termination --- docs/release-notes/version-3.3.md | 1 + netbox/dcim/models/cables.py | 24 +++++++++++++----------- netbox/dcim/signals.py | 5 ++++- netbox/dcim/svg/cables.py | 5 ++++- netbox/dcim/utils.py | 5 +++-- netbox/templates/dcim/interface.html | 2 +- 6 files changed, 26 insertions(+), 16 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 5d043a777..6099e8a61 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -104,6 +104,7 @@ Custom field UI visibility has no impact on API operation. * [#9730](https://github.com/netbox-community/netbox/issues/9730) - Fix validation error when creating a new cable via UI form * [#9733](https://github.com/netbox-community/netbox/issues/9733) - Handle split paths during trace when fanning out to front ports with differing cables * [#9765](https://github.com/netbox-community/netbox/issues/9765) - Report correct segment count under cable trace UI view +* [#9778](https://github.com/netbox-community/netbox/issues/9778) - Fix exception during cable deletion after deleting a connected termination * [#9788](https://github.com/netbox-community/netbox/issues/9788) - Ensure denormalized fields on CableTermination are kept in sync with related objects * [#9789](https://github.com/netbox-community/netbox/issues/9789) - Fix rendering of cable traces ending at provider networks * [#9794](https://github.com/netbox-community/netbox/issues/9794) - Fix link to connect a rear port to a circuit termination diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index e0a489f5b..321d808ff 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -431,11 +431,7 @@ class CablePath(models.Model): """ Return the list of originating objects. """ - if hasattr(self, '_path_objects'): - return self.path_objects[0] - return [ - path_node_to_object(node) for node in self.path[0] - ] + return self.path_objects[0] @property def destinations(self): @@ -444,11 +440,7 @@ class CablePath(models.Model): """ if not self.is_complete: return [] - if hasattr(self, '_path_objects'): - return self.path_objects[-1] - return [ - path_node_to_object(node) for node in self.path[-1] - ] + return self.path_objects[-1] @property def segment_count(self): @@ -463,6 +455,9 @@ class CablePath(models.Model): """ from circuits.models import CircuitTermination + if not terminations: + return None + # Ensure all originating terminations are attached to the same link if len(terminations) > 1: assert all(t.link == terminations[0].link for t in terminations[1:]) @@ -529,6 +524,9 @@ class CablePath(models.Model): ]) # Step 6: Determine the "next hop" terminations, if applicable + if not remote_terminations: + break + if isinstance(remote_terminations[0], FrontPort): # Follow FrontPorts to their corresponding RearPorts rear_ports = RearPort.objects.filter( @@ -640,7 +638,11 @@ class CablePath(models.Model): nodes = [] for node in step: ct_id, object_id = decompile_path_node(node) - nodes.append(prefetched[ct_id][object_id]) + try: + nodes.append(prefetched[ct_id][object_id]) + except KeyError: + # Ignore stale (deleted) object IDs + pass path.append(nodes) return path diff --git a/netbox/dcim/signals.py b/netbox/dcim/signals.py index 2293f8840..b990daf1a 100644 --- a/netbox/dcim/signals.py +++ b/netbox/dcim/signals.py @@ -116,7 +116,10 @@ def retrace_cable_paths(instance, **kwargs): @receiver(post_delete, sender=CableTermination) def nullify_connected_endpoints(instance, **kwargs): """ - Disassociate the Cable from the termination object. + Disassociate the Cable from the termination object, and retrace any affected CablePaths. """ model = instance.termination_type.model_class() model.objects.filter(pk=instance.termination_id).update(cable=None, cable_end='') + + for cablepath in CablePath.objects.filter(_nodes__contains=instance.cable): + cablepath.retrace() diff --git a/netbox/dcim/svg/cables.py b/netbox/dcim/svg/cables.py index 3b259eca2..26d16fafe 100644 --- a/netbox/dcim/svg/cables.py +++ b/netbox/dcim/svg/cables.py @@ -362,8 +362,11 @@ class CableTraceSVG: terminations = self.draw_terminations(far_ends) for term in terminations: self.draw_fanout(term, cable) - else: + elif far_ends: self.draw_terminations(far_ends) + else: + # Link is not connected to anything + break # Far end parent parent_objects = set(end.parent_object for end in far_ends) diff --git a/netbox/dcim/utils.py b/netbox/dcim/utils.py index 26b6e2e25..eadd2da96 100644 --- a/netbox/dcim/utils.py +++ b/netbox/dcim/utils.py @@ -24,11 +24,12 @@ def object_to_path_node(obj): def path_node_to_object(repr): """ - Given the string representation of a path node, return the corresponding instance. + Given the string representation of a path node, return the corresponding instance. If the object no longer + exists, return None. """ ct_id, object_id = decompile_path_node(repr) ct = ContentType.objects.get_for_id(ct_id) - return ct.model_class().objects.get(pk=object_id) + return ct.model_class().objects.filter(pk=object_id).first() def create_cablepath(terminations): diff --git a/netbox/templates/dcim/interface.html b/netbox/templates/dcim/interface.html index 3a7fe986a..11e776872 100644 --- a/netbox/templates/dcim/interface.html +++ b/netbox/templates/dcim/interface.html @@ -219,7 +219,7 @@     + + {% for contact in contacts %} @@ -17,6 +19,20 @@ + +
    Path Status - {% if object.path.is_active %} + {% if object.path.is_complete and object.path.is_active %} Reachable {% else %} Not Reachable From f11a6f0135fc40bb2b695f38b5668a09ec46e3be Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 3 Aug 2022 14:41:50 -0400 Subject: [PATCH 339/593] Release v3.3-beta2 --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 2 +- docs/release-notes/version-3.3.md | 2 +- netbox/netbox/settings.py | 2 +- requirements.txt | 10 +++++----- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 88fbb1df9..dc8dd8275 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.3-beta1 + placeholder: v3.3-beta2 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 1035c02fb..d9e5a26fd 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.3-beta1 + placeholder: v3.3-beta2 validations: required: true - type: dropdown diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 6099e8a61..2a3935e5e 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -1,6 +1,6 @@ # NetBox v3.3 -## v3.3.0 (FUTURE) +## v3.3-beta2 (2022-08-03) ### Breaking Changes diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index e0ec8e1ec..0dcde9cf6 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.3-beta1' +VERSION = '3.3-beta2' # Hostname HOSTNAME = platform.node() diff --git a/requirements.txt b/requirements.txt index 4c8e5e5ce..8a7dd79d4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ bleach==5.0.1 -Django==4.0.6 +Django==4.0.7 django-cors-headers==3.13.0 django-debug-toolbar==3.5.0 django-filter==22.1 @@ -14,19 +14,19 @@ django-tables2==2.4.1 django-taggit==3.0.0 django-timezone-field==5.0 djangorestframework==3.13.1 -drf-yasg[validation]==1.20.0 +drf-yasg[validation]==1.21.3 graphene-django==2.15.0 gunicorn==20.1.0 Jinja2==3.1.2 -Markdown==3.3.7 -markdown-include==0.6.0 +Markdown==3.4.1 +markdown-include==0.7.0 mkdocs-material==8.3.9 mkdocstrings[python-legacy]==0.19.0 netaddr==0.8.0 Pillow==9.2.0 psycopg2-binary==2.9.3 PyYAML==6.0 -sentry-sdk==1.7.1 +sentry-sdk==1.9.0 social-auth-app-django==5.0.0 social-auth-core==4.3.0 svgwrite==1.4.3 From a2e84dd279549c7284184ff98da4a1ce23c646c9 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 3 Aug 2022 15:22:51 -0400 Subject: [PATCH 340/593] Changelog for #9827, #9906 --- 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 5e538890c..1c7eb79e8 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -11,9 +11,11 @@ * [#9881](https://github.com/netbox-community/netbox/issues/9881) - Increase granularity in utilization graph values * [#9882](https://github.com/netbox-community/netbox/issues/9882) - Add manufacturer column to modules table * [#9883](https://github.com/netbox-community/netbox/issues/9883) - Linkify location column in power panels table +* [#9906](https://github.com/netbox-community/netbox/issues/9906) - Include `color` attribute in front & rear port YAML import/export ### Bug Fixes +* [#9827](https://github.com/netbox-community/netbox/issues/9827) - Fix assignment of module bay position during bulk creation * [#9871](https://github.com/netbox-community/netbox/issues/9871) - Fix utilization graph value alignments * [#9884](https://github.com/netbox-community/netbox/issues/9884) - Prevent querying assigned VRF on prefix object init * [#9885](https://github.com/netbox-community/netbox/issues/9885) - Fix child prefix counts when editing/deleting aggregates in bulk From 56433cf85520edee9cf0d440bfeb82524eac7fc7 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 4 Aug 2022 10:42:44 -0400 Subject: [PATCH 341/593] Fix denormalization logic to be compatible with loading fixture data --- netbox/netbox/denormalized.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/netbox/netbox/denormalized.py b/netbox/netbox/denormalized.py index 5808acddc..cd4a869d2 100644 --- a/netbox/netbox/denormalized.py +++ b/netbox/netbox/denormalized.py @@ -33,6 +33,10 @@ def update_denormalized_fields(sender, instance, created, raw, **kwargs): """ Check if the sender has denormalized fields registered, and update them as necessary. """ + def _get_field_value(instance, field_name): + field = instance._meta.get_field(field_name) + return field.value_from_object(instance) + # Skip for new objects or those being populated from raw data if created or raw: return @@ -45,7 +49,7 @@ def update_denormalized_fields(sender, instance, created, raw, **kwargs): } update_params = { # Map the denormalized field names to the instance's values - denorm: getattr(instance, origin) for denorm, origin in mappings.items() + denorm: _get_field_value(instance, origin) for denorm, origin in mappings.items() } # TODO: Improve efficiency here by placing conditions on the query? From f874e9932d06653e330da65d93c2fe0fd7720968 Mon Sep 17 00:00:00 2001 From: Osamu-kj Date: Thu, 4 Aug 2022 18:52:25 +0200 Subject: [PATCH 342/593] Added HTML Sanitization to the custom fields --- netbox/netbox/tables/columns.py | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index 7da241566..7774a495f 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -1,4 +1,5 @@ from dataclasses import dataclass +from glob import escape from typing import Optional import django_tables2 as tables @@ -433,21 +434,21 @@ class CustomFieldColumn(tables.Column): def render(self, value): if self.customfield.type == CustomFieldTypeChoices.TYPE_BOOLEAN and value is True: - return mark_safe('') + return escape('') if self.customfield.type == CustomFieldTypeChoices.TYPE_BOOLEAN and value is False: - return mark_safe('') + return escape('') if self.customfield.type == CustomFieldTypeChoices.TYPE_URL: - return mark_safe(f'{value}') + return escape(f'{value}') if self.customfield.type == CustomFieldTypeChoices.TYPE_MULTISELECT: return ', '.join(v for v in value) if self.customfield.type == CustomFieldTypeChoices.TYPE_MULTIOBJECT: - return mark_safe(', '.join([ + return escape(', '.join([ self._likify_item(obj) for obj in self.customfield.deserialize(value) ])) if value is not None: obj = self.customfield.deserialize(value) - return mark_safe(self._likify_item(obj)) - return self.default + return escape(self._likify_item(obj)) + return escape(self.default) def value(self, value): if isinstance(value, list): From 5da3cab4de0469c8e8f19726600286abc590c7c3 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 4 Aug 2022 14:11:52 -0400 Subject: [PATCH 343/593] Reorganize documentation --- docs/additional-features/webhooks.md | 57 ----------- docs/administration/permissions.md | 71 ++++++++++++- docs/configuration/miscellaneous.md | 2 +- docs/configuration/napalm.md | 2 +- docs/customization/custom-fields.md | 75 +++++++++++++- .../custom-links.md} | 0 docs/customization/export-templates.md | 39 +++++++- docs/development/models.md | 8 +- .../change-logging.md | 0 docs/features/circuits.md | 3 + docs/features/contacts.md | 3 + .../context-data.md} | 0 docs/features/customization.md | 3 + docs/features/devices-cabling.md | 3 + docs/features/facilities.md | 3 + docs/features/ipam.md | 3 + .../journaling.md | 0 docs/features/l2vpn-overlay.md | 3 + docs/features/permissions.md | 3 + docs/features/power-tracking.md | 3 + docs/features/services.md | 3 + docs/features/sso.md | 3 + .../extras/tag.md => features/tags.md} | 0 docs/features/tenancy.md | 3 + docs/features/vlan-management.md | 3 + .../webhook.md => features/webhooks.md} | 56 +++++++++++ docs/features/wireless.md | 3 + docs/getting-started/populating-data.md | 2 +- docs/installation/3-netbox.md | 2 +- .../graphql-api.md} | 0 .../napalm.md | 0 .../prometheus-metrics.md | 0 .../overview.md => integrations/rest-api.md} | 99 ++++++++++++++++++- docs/models/extras/customfield.md | 73 -------------- docs/models/extras/exporttemplate.md | 37 ------- docs/models/extras/imageattachment.md | 3 - docs/models/users/objectpermission.md | 69 ------------- docs/models/users/token.md | 19 ---- docs/{rest-api => reference}/filtering.md | 0 docs/release-notes/version-3.0.md | 2 +- docs/rest-api/authentication.md | 73 -------------- mkdocs.yml | 47 +++++---- 42 files changed, 412 insertions(+), 366 deletions(-) delete mode 100644 docs/additional-features/webhooks.md rename docs/{models/extras/customlink.md => customization/custom-links.md} (100%) rename docs/{additional-features => features}/change-logging.md (100%) create mode 100644 docs/features/circuits.md create mode 100644 docs/features/contacts.md rename docs/{models/extras/configcontext.md => features/context-data.md} (100%) create mode 100644 docs/features/customization.md create mode 100644 docs/features/devices-cabling.md create mode 100644 docs/features/facilities.md create mode 100644 docs/features/ipam.md rename docs/{additional-features => features}/journaling.md (100%) create mode 100644 docs/features/l2vpn-overlay.md create mode 100644 docs/features/permissions.md create mode 100644 docs/features/power-tracking.md create mode 100644 docs/features/services.md create mode 100644 docs/features/sso.md rename docs/{models/extras/tag.md => features/tags.md} (100%) create mode 100644 docs/features/tenancy.md create mode 100644 docs/features/vlan-management.md rename docs/{models/extras/webhook.md => features/webhooks.md} (67%) create mode 100644 docs/features/wireless.md rename docs/{graphql-api/overview.md => integrations/graphql-api.md} (100%) rename docs/{additional-features => integrations}/napalm.md (100%) rename docs/{additional-features => integrations}/prometheus-metrics.md (100%) rename docs/{rest-api/overview.md => integrations/rest-api.md} (78%) delete mode 100644 docs/models/extras/customfield.md delete mode 100644 docs/models/extras/exporttemplate.md delete mode 100644 docs/models/extras/imageattachment.md delete mode 100644 docs/models/users/objectpermission.md delete mode 100644 docs/models/users/token.md rename docs/{rest-api => reference}/filtering.md (100%) delete mode 100644 docs/rest-api/authentication.md diff --git a/docs/additional-features/webhooks.md b/docs/additional-features/webhooks.md deleted file mode 100644 index 5077f3a68..000000000 --- a/docs/additional-features/webhooks.md +++ /dev/null @@ -1,57 +0,0 @@ -{!models/extras/webhook.md!} - -## Conditional Webhooks - -A webhook may include a set of conditional logic expressed in JSON used to control whether a webhook triggers for a specific object. For example, you may wish to trigger a webhook for devices only when the `status` field of an object is "active": - -```json -{ - "and": [ - { - "attr": "status.value", - "value": "active" - } - ] -} -``` - -For more detail, see the reference documentation for NetBox's [conditional logic](../reference/conditions.md). - -## Webhook Processing - -When a change is detected, any resulting webhooks are placed into a Redis queue for processing. This allows the user's request to complete without needing to wait for the outgoing webhook(s) to be processed. The webhooks are then extracted from the queue by the `rqworker` process and HTTP requests are sent to their respective destinations. The current webhook queue and any failed webhooks can be inspected in the admin UI under System > Background Tasks. - -A request is considered successful if the response has a 2XX status code; otherwise, the request is marked as having failed. Failed requests may be retried manually via the admin UI. - -## Troubleshooting - -To assist with verifying that the content of outgoing webhooks is rendered correctly, NetBox provides a simple HTTP listener that can be run locally to receive and display webhook requests. First, modify the target URL of the desired webhook to `http://localhost:9000/`. This will instruct NetBox to send the request to the local server on TCP port 9000. Then, start the webhook receiver service from the NetBox root directory: - -```no-highlight -$ python netbox/manage.py webhook_receiver -Listening on port http://localhost:9000. Stop with CONTROL-C. -``` - -You can test the receiver itself by sending any HTTP request to it. For example: - -```no-highlight -$ curl -X POST http://localhost:9000 --data '{"foo": "bar"}' -``` - -The server will print output similar to the following: - -```no-highlight -[1] Tue, 07 Apr 2020 17:44:02 GMT 127.0.0.1 "POST / HTTP/1.1" 200 - -Host: localhost:9000 -User-Agent: curl/7.58.0 -Accept: */* -Content-Length: 14 -Content-Type: application/x-www-form-urlencoded - -{"foo": "bar"} ------------- -``` - -Note that `webhook_receiver` does not actually _do_ anything with the information received: It merely prints the request headers and body for inspection. - -Now, when the NetBox webhook is triggered and processed, you should see its headers and content appear in the terminal where the webhook receiver is listening. If you don't, check that the `rqworker` process is running and that webhook events are being placed into the queue (visible under the NetBox admin UI). diff --git a/docs/administration/permissions.md b/docs/administration/permissions.md index 60717c28a..21f259979 100644 --- a/docs/administration/permissions.md +++ b/docs/administration/permissions.md @@ -1,8 +1,75 @@ -# Permissions +# Object-Based Permissions NetBox v2.9 introduced a new object-based permissions framework, which replaces Django's built-in permissions model. Object-based permissions enable an administrator to grant users or groups the ability to perform an action on arbitrary subsets of objects in NetBox, rather than all objects of a certain type. For example, it is possible to grant a user permission to view only sites within a particular region, or to modify only VLANs with a numeric ID within a certain range. -{!models/users/objectpermission.md!} +A permission in NetBox represents a relationship shared by several components: + +* Object type(s) - One or more types of object in NetBox +* User(s)/Group(s) - One or more users or groups of users +* Action(s) - The action(s) that can be performed on an object +* Constraints - An arbitrary filter used to limit the granted action(s) to a specific subset of objects + +At a minimum, a permission assignment must specify one object type, one user or group, and one action. The specification of constraints is optional: A permission without any constraints specified will apply to all instances of the selected model(s). + +## Actions + +There are four core actions that can be permitted for each type of object within NetBox, roughly analogous to the CRUD convention (create, read, update, and delete): + +* **View** - Retrieve an object from the database +* **Add** - Create a new object +* **Change** - Modify an existing object +* **Delete** - Delete an existing object + +In addition to these, permissions can also grant custom actions that may be required by a specific model or plugin. For example, the `napalm_read` permission on the device model allows a user to execute NAPALM queries on a device via NetBox's REST API. These can be specified when granting a permission in the "additional actions" field. + +!!! note + Internally, all actions granted by a permission (both built-in and custom) are stored as strings in an array field named `actions`. + +## Constraints + +Constraints are expressed as a JSON object or list representing a [Django query filter](https://docs.djangoproject.com/en/stable/ref/models/querysets/#field-lookups). This is the same syntax that you would pass to the QuerySet `filter()` method when performing a query using the Django ORM. As with query filters, double underscores can be used to traverse related objects or invoke lookup expressions. Some example queries and their corresponding definitions are shown below. + +All attributes defined within a single JSON object are applied with a logical AND. For example, suppose you assign a permission for the site model with the following constraints. + +```json +{ + "status": "active", + "region__name": "Americas" +} +``` + +The permission will grant access only to sites which have a status of "active" **and** which are assigned to the "Americas" region. + +To achieve a logical OR with a different set of constraints, define multiple objects within a list. For example, if you want to constrain the permission to VLANs with an ID between 100 and 199 _or_ a status of "reserved," do the following: + +```json +[ + { + "vid__gte": 100, + "vid__lt": 200 + }, + { + "status": "reserved" + } +] +``` + +Additionally, where multiple permissions have been assigned for an object type, their collective constraints will be merged using a logical "OR" operation. + +### User Token + +!!! info "This feature was introduced in NetBox v3.3" + +When defining a permission constraint, administrators may use the special token `$user` to reference the current user at the time of evaluation. This can be helpful to restrict users to editing only their own journal entries, for example. Such a constraint might be defined as: + +```json +{ + "created_by": "$user" +} +``` + +The `$user` token can be used only as a constraint value, or as an item within a list of values. It cannot be modified or extended to reference specific user attributes. + #### Example Constraint Definitions diff --git a/docs/configuration/miscellaneous.md b/docs/configuration/miscellaneous.md index 2aa21b7e5..614e90eac 100644 --- a/docs/configuration/miscellaneous.md +++ b/docs/configuration/miscellaneous.md @@ -127,7 +127,7 @@ A web user or API consumer can request an arbitrary number of objects by appendi Default: False -Toggle the availability Prometheus-compatible metrics at `/metrics`. See the [Prometheus Metrics](../additional-features/prometheus-metrics.md) documentation for more details. +Toggle the availability Prometheus-compatible metrics at `/metrics`. See the [Prometheus Metrics](../integrations/prometheus-metrics.md) documentation for more details. --- diff --git a/docs/configuration/napalm.md b/docs/configuration/napalm.md index 925ec17e6..253bea297 100644 --- a/docs/configuration/napalm.md +++ b/docs/configuration/napalm.md @@ -6,7 +6,7 @@ !!! tip "Dynamic Configuration Parameter" -NetBox will use these credentials when authenticating to remote devices via the supported [NAPALM integration](../additional-features/napalm.md), if installed. Both parameters are optional. +NetBox will use these credentials when authenticating to remote devices via the supported [NAPALM integration](../integrations/napalm.md), if installed. Both parameters are optional. !!! note If SSH public key authentication has been set up on the remote device(s) for the system account under which NetBox runs, these parameters are not needed. diff --git a/docs/customization/custom-fields.md b/docs/customization/custom-fields.md index 757416626..bfe412edc 100644 --- a/docs/customization/custom-fields.md +++ b/docs/customization/custom-fields.md @@ -1,4 +1,77 @@ -{!models/extras/customfield.md!} +# Custom Fields + +Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, sites are stored in the `dcim_site` table, which has columns named `name`, `facility`, `physical_address`, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows. + +However, some users might want to store additional object attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number correlating it with an internal support system record. This is certainly a legitimate use for NetBox, but it's not a common enough need to warrant including a field for _every_ NetBox installation. Instead, you can create a custom field to hold this data. + +Within the database, custom fields are stored as JSON data directly alongside each object. This alleviates the need for complex queries when retrieving objects. + +## Creating Custom Fields + +Custom fields may be created by navigating to Customization > Custom Fields. NetBox supports six types of custom field: + +* Text: Free-form text (intended for single-line use) +* Long text: Free-form of any length; supports Markdown rendering +* Integer: A whole number (positive or negative) +* Boolean: True or false +* Date: A date in ISO 8601 format (YYYY-MM-DD) +* URL: This will be presented as a link in the web UI +* JSON: Arbitrary data stored in JSON format +* Selection: A selection of one of several pre-defined custom choices +* Multiple selection: A selection field which supports the assignment of multiple values +* Object: A single NetBox object of the type defined by `object_type` +* Multiple object: One or more NetBox objects of the type defined by `object_type` + +Each custom field must have a name. This should be a simple database-friendly string (e.g. `tps_report`) and may contain only alphanumeric characters and underscores. You may also assign a corresponding human-friendly label (e.g. "TPS report"); the label will be displayed on web forms. A weight is also required: Higher-weight fields will be ordered lower within a form. (The default weight is 100.) If a description is provided, it will appear beneath the field in a form. + +Marking a field as required will force the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields, or the exact value of a choice for selection fields. + +A custom field must be assigned to one or more object types, or models, in NetBox. Once created, custom fields will automatically appear as part of these models in the web UI and REST API. Note that not all models support custom fields. + +### Filtering + +The filter logic controls how values are matched when filtering objects by the custom field. Loose filtering (the default) matches on a partial value, whereas exact matching requires a complete match of the given string to a field's value. For example, exact filtering with the string "red" will only match the exact value "red", whereas loose filtering will match on the values "red", "red-orange", or "bored". Setting the filter logic to "disabled" disables filtering by the field entirely. + +### Grouping + +!!! note + This feature was introduced in NetBox v3.3. + +Related custom fields can be grouped together within the UI by assigning each the same group name. When at least one custom field for an object type has a group defined, it will appear under the group heading within the custom fields panel under the object view. All custom fields with the same group name will appear under that heading. (Note that the group names must match exactly, or each will appear as a separate heading.) + +This parameter has no effect on the API representation of custom field data. + +### Visibility + +!!! note + This feature was introduced in NetBox v3.3. + +When creating a custom field, there are three options for UI visibility. These control how and whether the custom field is displayed within the NetBox UI. + +* **Read/write** (default): The custom field is included when viewing and editing objects. +* **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.) +* **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users. + +Note that this setting has no impact on the REST or GraphQL APIs: Custom field data will always be available via either API. + +### Validation + +NetBox supports limited custom validation for custom field values. Following are the types of validation enforced for each field type: + +* Text: Regular expression (optional) +* Integer: Minimum and/or maximum value (optional) +* Selection: Must exactly match one of the prescribed choices + +### Custom Selection Fields + +Each custom selection field must have at least two choices. These are specified as a comma-separated list. Choices appear in forms in the order they are listed. Note that choice values are saved exactly as they appear, so it's best to avoid superfluous punctuation or symbols where possible. + +If a default value is specified for a selection field, it must exactly match one of the provided choices. The value of a multiple selection field will always return a list, even if only one value is selected. + +### Custom Object Fields + +An object or multi-object custom field can be used to refer to a particular NetBox object or objects as the "value" for a custom field. These custom fields must define an `object_type`, which determines the type of object to which custom field instances point. + ## Custom Fields in Templates diff --git a/docs/models/extras/customlink.md b/docs/customization/custom-links.md similarity index 100% rename from docs/models/extras/customlink.md rename to docs/customization/custom-links.md diff --git a/docs/customization/export-templates.md b/docs/customization/export-templates.md index 3c7ff7d20..640a97531 100644 --- a/docs/customization/export-templates.md +++ b/docs/customization/export-templates.md @@ -1,4 +1,41 @@ -{!models/extras/exporttemplate.md!} +# Export Templates + +NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Templates. + +Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list. Each export template must have a name, and may optionally designate a specific export [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) and/or file extension. + +Export templates must be written in [Jinja2](https://jinja.palletsprojects.com/). + +!!! note + The name `table` is reserved for internal use. + +!!! warning + Export templates are rendered using user-submitted code, which may pose security risks under certain conditions. Only grant permission to create or modify export templates to trusted users. + +The list of objects returned from the database when rendering an export template is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example: + +```jinja2 +{% for rack in queryset %} +Rack: {{ rack.name }} +Site: {{ rack.site.name }} +Height: {{ rack.u_height }}U +{% endfor %} +``` + +To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`. + +If you need to use the config context data in an export template, you'll should use the function `get_config_context` to get all the config context data. For example: +``` +{% for server in queryset %} +{% set data = server.get_config_context() %} +{{ data.syslog }} +{% endfor %} +``` + +The `as_attachment` attribute of an export template controls its behavior when rendered. If true, the rendered content will be returned to the user as a downloadable file. If false, it will be displayed within the browser. (This may be handy e.g. for generating HTML content.) + +A MIME type and file extension can optionally be defined for each export template. The default MIME type is `text/plain`. + ## REST API Integration diff --git a/docs/development/models.md b/docs/development/models.md index b6b2e4da2..be3608a30 100644 --- a/docs/development/models.md +++ b/docs/development/models.md @@ -8,12 +8,12 @@ The Django [content types](https://docs.djangoproject.com/en/stable/ref/contrib/ ### Features Matrix -* [Change logging](../additional-features/change-logging.md) - Changes to these objects are automatically recorded in the change log -* [Webhooks](../additional-features/webhooks.md) - NetBox is capable of generating outgoing webhooks for these objects +* [Change logging](../features/change-logging.md) - Changes to these objects are automatically recorded in the change log +* [Webhooks](../features/webhooks.md) - NetBox is capable of generating outgoing webhooks for these objects * [Custom fields](../customization/custom-fields.md) - These models support the addition of user-defined fields * [Export templates](../customization/export-templates.md) - Users can create custom export templates for these models -* [Tagging](../models/extras/tag.md) - The models can be tagged with user-defined tags -* [Journaling](../additional-features/journaling.md) - These models support persistent historical commentary +* [Tagging](../features/tags.md) - The models can be tagged with user-defined tags +* [Journaling](../features/journaling.md) - These models support persistent historical commentary * Nesting - These models can be nested recursively to create a hierarchy | Type | Change Logging | Webhooks | Custom Fields | Export Templates | Tags | Journaling | Nesting | diff --git a/docs/additional-features/change-logging.md b/docs/features/change-logging.md similarity index 100% rename from docs/additional-features/change-logging.md rename to docs/features/change-logging.md diff --git a/docs/features/circuits.md b/docs/features/circuits.md new file mode 100644 index 000000000..63c8bc970 --- /dev/null +++ b/docs/features/circuits.md @@ -0,0 +1,3 @@ +# Circuits + +TODO diff --git a/docs/features/contacts.md b/docs/features/contacts.md new file mode 100644 index 000000000..fb23e53da --- /dev/null +++ b/docs/features/contacts.md @@ -0,0 +1,3 @@ +# Contacts + +TODO diff --git a/docs/models/extras/configcontext.md b/docs/features/context-data.md similarity index 100% rename from docs/models/extras/configcontext.md rename to docs/features/context-data.md diff --git a/docs/features/customization.md b/docs/features/customization.md new file mode 100644 index 000000000..ae775312e --- /dev/null +++ b/docs/features/customization.md @@ -0,0 +1,3 @@ +# Customization + +TODO diff --git a/docs/features/devices-cabling.md b/docs/features/devices-cabling.md new file mode 100644 index 000000000..ab09b4443 --- /dev/null +++ b/docs/features/devices-cabling.md @@ -0,0 +1,3 @@ +# Devices & Cabling + +TODO diff --git a/docs/features/facilities.md b/docs/features/facilities.md new file mode 100644 index 000000000..5ace5b18b --- /dev/null +++ b/docs/features/facilities.md @@ -0,0 +1,3 @@ +# Facilities + +TODO \ No newline at end of file diff --git a/docs/features/ipam.md b/docs/features/ipam.md new file mode 100644 index 000000000..f263f3ab3 --- /dev/null +++ b/docs/features/ipam.md @@ -0,0 +1,3 @@ +# IP Address Management + +TODO diff --git a/docs/additional-features/journaling.md b/docs/features/journaling.md similarity index 100% rename from docs/additional-features/journaling.md rename to docs/features/journaling.md diff --git a/docs/features/l2vpn-overlay.md b/docs/features/l2vpn-overlay.md new file mode 100644 index 000000000..002c483f9 --- /dev/null +++ b/docs/features/l2vpn-overlay.md @@ -0,0 +1,3 @@ +# L2VPN & Overlay + +TODO diff --git a/docs/features/permissions.md b/docs/features/permissions.md new file mode 100644 index 000000000..a422ca7b3 --- /dev/null +++ b/docs/features/permissions.md @@ -0,0 +1,3 @@ +# Object-Based Permissions + +TODO diff --git a/docs/features/power-tracking.md b/docs/features/power-tracking.md new file mode 100644 index 000000000..1267af1e6 --- /dev/null +++ b/docs/features/power-tracking.md @@ -0,0 +1,3 @@ +# Power Tracking + +TODO diff --git a/docs/features/services.md b/docs/features/services.md new file mode 100644 index 000000000..338fc349a --- /dev/null +++ b/docs/features/services.md @@ -0,0 +1,3 @@ +# Services + +TODO diff --git a/docs/features/sso.md b/docs/features/sso.md new file mode 100644 index 000000000..b4f9782c2 --- /dev/null +++ b/docs/features/sso.md @@ -0,0 +1,3 @@ +# Single Sign-On (SSO) + +TODO diff --git a/docs/models/extras/tag.md b/docs/features/tags.md similarity index 100% rename from docs/models/extras/tag.md rename to docs/features/tags.md diff --git a/docs/features/tenancy.md b/docs/features/tenancy.md new file mode 100644 index 000000000..20534b13c --- /dev/null +++ b/docs/features/tenancy.md @@ -0,0 +1,3 @@ +# Tenancy + +TODO diff --git a/docs/features/vlan-management.md b/docs/features/vlan-management.md new file mode 100644 index 000000000..3d4fd4d1f --- /dev/null +++ b/docs/features/vlan-management.md @@ -0,0 +1,3 @@ +# VLAN Management + +TODO diff --git a/docs/models/extras/webhook.md b/docs/features/webhooks.md similarity index 67% rename from docs/models/extras/webhook.md rename to docs/features/webhooks.md index 9f64401ae..4705243d1 100644 --- a/docs/models/extras/webhook.md +++ b/docs/features/webhooks.md @@ -81,3 +81,59 @@ If no body template is specified, the request body will be populated with a JSON } } ``` + +## Conditional Webhooks + +A webhook may include a set of conditional logic expressed in JSON used to control whether a webhook triggers for a specific object. For example, you may wish to trigger a webhook for devices only when the `status` field of an object is "active": + +```json +{ + "and": [ + { + "attr": "status.value", + "value": "active" + } + ] +} +``` + +For more detail, see the reference documentation for NetBox's [conditional logic](../reference/conditions.md). + +## Webhook Processing + +When a change is detected, any resulting webhooks are placed into a Redis queue for processing. This allows the user's request to complete without needing to wait for the outgoing webhook(s) to be processed. The webhooks are then extracted from the queue by the `rqworker` process and HTTP requests are sent to their respective destinations. The current webhook queue and any failed webhooks can be inspected in the admin UI under System > Background Tasks. + +A request is considered successful if the response has a 2XX status code; otherwise, the request is marked as having failed. Failed requests may be retried manually via the admin UI. + +## Troubleshooting + +To assist with verifying that the content of outgoing webhooks is rendered correctly, NetBox provides a simple HTTP listener that can be run locally to receive and display webhook requests. First, modify the target URL of the desired webhook to `http://localhost:9000/`. This will instruct NetBox to send the request to the local server on TCP port 9000. Then, start the webhook receiver service from the NetBox root directory: + +```no-highlight +$ python netbox/manage.py webhook_receiver +Listening on port http://localhost:9000. Stop with CONTROL-C. +``` + +You can test the receiver itself by sending any HTTP request to it. For example: + +```no-highlight +$ curl -X POST http://localhost:9000 --data '{"foo": "bar"}' +``` + +The server will print output similar to the following: + +```no-highlight +[1] Tue, 07 Apr 2020 17:44:02 GMT 127.0.0.1 "POST / HTTP/1.1" 200 - +Host: localhost:9000 +User-Agent: curl/7.58.0 +Accept: */* +Content-Length: 14 +Content-Type: application/x-www-form-urlencoded + +{"foo": "bar"} +------------ +``` + +Note that `webhook_receiver` does not actually _do_ anything with the information received: It merely prints the request headers and body for inspection. + +Now, when the NetBox webhook is triggered and processed, you should see its headers and content appear in the terminal where the webhook receiver is listening. If you don't, check that the `rqworker` process is running and that webhook events are being placed into the queue (visible under the NetBox admin UI). diff --git a/docs/features/wireless.md b/docs/features/wireless.md new file mode 100644 index 000000000..ff3d5d10b --- /dev/null +++ b/docs/features/wireless.md @@ -0,0 +1,3 @@ +# Wireless + +TODO diff --git a/docs/getting-started/populating-data.md b/docs/getting-started/populating-data.md index e182a9d52..bb0e8e17f 100644 --- a/docs/getting-started/populating-data.md +++ b/docs/getting-started/populating-data.md @@ -39,4 +39,4 @@ Sometimes you'll find that data you need to populate in NetBox can be easily red You can also use the REST API to facilitate the population of data in NetBox. The REST API offers full programmatic control over the creation of objects, subject to the same validation rules enforced by the UI forms. Additionally, the REST API supports the bulk creation of multiple objects using a single request. -For more information about this option, see the [REST API documentation](../rest-api/overview.md). +For more information about this option, see the [REST API documentation](../integrations/rest-api.md). diff --git a/docs/installation/3-netbox.md b/docs/installation/3-netbox.md index 7c4a60500..eeb5e6f20 100644 --- a/docs/installation/3-netbox.md +++ b/docs/installation/3-netbox.md @@ -201,7 +201,7 @@ All Python packages required by NetBox are listed in `requirements.txt` and will ### NAPALM -Integration with the [NAPALM automation](../additional-features/napalm.md) library allows NetBox to fetch live data from devices and return it to a requester via its REST API. The `NAPALM_USERNAME` and `NAPALM_PASSWORD` configuration parameters define the credentials to be used when connecting to a device. +Integration with the [NAPALM automation](../integrations/napalm.md) library allows NetBox to fetch live data from devices and return it to a requester via its REST API. The `NAPALM_USERNAME` and `NAPALM_PASSWORD` configuration parameters define the credentials to be used when connecting to a device. ```no-highlight sudo sh -c "echo 'napalm' >> /opt/netbox/local_requirements.txt" diff --git a/docs/graphql-api/overview.md b/docs/integrations/graphql-api.md similarity index 100% rename from docs/graphql-api/overview.md rename to docs/integrations/graphql-api.md diff --git a/docs/additional-features/napalm.md b/docs/integrations/napalm.md similarity index 100% rename from docs/additional-features/napalm.md rename to docs/integrations/napalm.md diff --git a/docs/additional-features/prometheus-metrics.md b/docs/integrations/prometheus-metrics.md similarity index 100% rename from docs/additional-features/prometheus-metrics.md rename to docs/integrations/prometheus-metrics.md diff --git a/docs/rest-api/overview.md b/docs/integrations/rest-api.md similarity index 78% rename from docs/rest-api/overview.md rename to docs/integrations/rest-api.md index 5fc4f18bb..3a5aed055 100644 --- a/docs/rest-api/overview.md +++ b/docs/integrations/rest-api.md @@ -91,7 +91,7 @@ Lists of objects can be filtered using a set of query parameters. For example, t GET /api/dcim/interfaces/?device_id=123 ``` -See the [filtering documentation](filtering.md) for more details. +See the [filtering documentation](../reference/filtering.md) for more details. ## Serialization @@ -269,7 +269,7 @@ The brief format is supported for both lists and individual objects. ### Excluding Config Contexts -When retrieving devices and virtual machines via the REST API, each will included its rendered [configuration context data](../models/extras/configcontext.md) by default. Users with large amounts of context data will likely observe suboptimal performance when returning multiple objects, particularly with very high page sizes. To combat this, context data may be excluded from the response data by attaching the query parameter `?exclude=config_context` to the request. This parameter works for both list and detail views. +When retrieving devices and virtual machines via the REST API, each will include its rendered [configuration context data](../features/context-data.md) by default. Users with large amounts of context data will likely observe suboptimal performance when returning multiple objects, particularly with very high page sizes. To combat this, context data may be excluded from the response data by attaching the query parameter `?exclude=config_context` to the request. This parameter works for both list and detail views. ## Pagination @@ -387,7 +387,7 @@ curl -s -X GET http://netbox/api/ipam/ip-addresses/5618/ | jq '.' ### Creating a New Object -To create a new object, make a `POST` request to the model's _list_ endpoint with JSON data pertaining to the object being created. Note that a REST API token is required for all write operations; see the [authentication documentation](authentication.md) for more information. Also be sure to set the `Content-Type` HTTP header to `application/json`. +To create a new object, make a `POST` request to the model's _list_ endpoint with JSON data pertaining to the object being created. Note that a REST API token is required for all write operations; see the [authentication section](#authenticating-to-the-api) for more information. Also be sure to set the `Content-Type` HTTP header to `application/json`. ```no-highlight curl -s -X POST \ @@ -561,3 +561,96 @@ http://netbox/api/dcim/sites/ \ !!! note The bulk deletion of objects is an all-or-none operation, meaning that if NetBox fails to delete any of the specified objects (e.g. due a dependency by a related object), the entire operation will be aborted and none of the objects will be deleted. + +## Authentication + +The NetBox REST API primarily employs token-based authentication. For convenience, cookie-based authentication can also be used when navigating the browsable API. + +### Tokens + +A token is a unique identifier mapped to a NetBox user account. Each user may have one or more tokens which he or she can use for authentication when making REST API requests. To create a token, navigate to the API tokens page under your user profile. + +!!! note + All users can create and manage REST API tokens under the user control panel in the UI. The ability to view, add, change, or delete tokens via the REST API itself is controlled by the relevant model permissions, assigned to users and/or groups in the admin UI. These permissions should be used with great care to avoid accidentally permitting a user to create tokens for other user accounts. + +Each token contains a 160-bit key represented as 40 hexadecimal characters. When creating a token, you'll typically leave the key field blank so that a random key will be automatically generated. However, NetBox allows you to specify a key in case you need to restore a previously deleted token to operation. + +By default, a token can be used to perform all actions via the API that a user would be permitted to do via the web UI. Deselecting the "write enabled" option will restrict API requests made with the token to read operations (e.g. GET) only. + +Additionally, a token can be set to expire at a specific time. This can be useful if an external client needs to be granted temporary access to NetBox. + +#### Client IP Restriction + +!!! note + This feature was introduced in NetBox v3.3. + +Each API token can optionally be restricted by client IP address. If one or more allowed IP prefixes/addresses is defined for a token, authentication will fail for any client connecting from an IP address outside the defined range(s). This enables restricting the use a token to a specific client. (By default, any client IP address is permitted.) + + +### Authenticating to the API + +An authentication token is attached to a request by setting the `Authorization` header to the string `Token` followed by a space and the user's token: + +``` +$ curl -H "Authorization: Token $TOKEN" \ +-H "Accept: application/json; indent=4" \ +https://netbox/api/dcim/sites/ +{ + "count": 10, + "next": null, + "previous": null, + "results": [...] +} +``` + +A token is not required for read-only operations which have been exempted from permissions enforcement (using the [`EXEMPT_VIEW_PERMISSIONS`](../configuration/security.md#exempt_view_permissions) configuration parameter). However, if a token _is_ required but not present in a request, the API will return a 403 (Forbidden) response: + +``` +$ curl https://netbox/api/dcim/sites/ +{ + "detail": "Authentication credentials were not provided." +} +``` + +When a token is used to authenticate a request, its `last_updated` time updated to the current time if its last use was recorded more than 60 seconds ago (or was never recorded). This allows users to determine which tokens have been active recently. + +!!! note + The "last used" time for tokens will not be updated while maintenance mode is enabled. + +### Initial Token Provisioning + +Ideally, each user should provision his or her own REST API token(s) via the web UI. However, you may encounter where a token must be created by a user via the REST API itself. NetBox provides a special endpoint to provision tokens using a valid username and password combination. + +To provision a token via the REST API, make a `POST` request to the `/api/users/tokens/provision/` endpoint: + +``` +$ curl -X POST \ +-H "Content-Type: application/json" \ +-H "Accept: application/json; indent=4" \ +https://netbox/api/users/tokens/provision/ \ +--data '{ + "username": "hankhill", + "password": "I<3C3H8", +}' +``` + +Note that we are _not_ passing an existing REST API token with this request. If the supplied credentials are valid, a new REST API token will be automatically created for the user. Note that the key will be automatically generated, and write ability will be enabled. + +```json +{ + "id": 6, + "url": "https://netbox/api/users/tokens/6/", + "display": "3c9cb9 (hankhill)", + "user": { + "id": 2, + "url": "https://netbox/api/users/users/2/", + "display": "hankhill", + "username": "hankhill" + }, + "created": "2021-06-11T20:09:13.339367Z", + "expires": null, + "key": "9fc9b897abec9ada2da6aec9dbc34596293c9cb9", + "write_enabled": true, + "description": "" +} +``` diff --git a/docs/models/extras/customfield.md b/docs/models/extras/customfield.md deleted file mode 100644 index 3f6860758..000000000 --- a/docs/models/extras/customfield.md +++ /dev/null @@ -1,73 +0,0 @@ -# Custom Fields - -Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, sites are stored in the `dcim_site` table, which has columns named `name`, `facility`, `physical_address`, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows. - -However, some users might want to store additional object attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number correlating it with an internal support system record. This is certainly a legitimate use for NetBox, but it's not a common enough need to warrant including a field for _every_ NetBox installation. Instead, you can create a custom field to hold this data. - -Within the database, custom fields are stored as JSON data directly alongside each object. This alleviates the need for complex queries when retrieving objects. - -## Creating Custom Fields - -Custom fields may be created by navigating to Customization > Custom Fields. NetBox supports six types of custom field: - -* Text: Free-form text (intended for single-line use) -* Long text: Free-form of any length; supports Markdown rendering -* Integer: A whole number (positive or negative) -* Boolean: True or false -* Date: A date in ISO 8601 format (YYYY-MM-DD) -* URL: This will be presented as a link in the web UI -* JSON: Arbitrary data stored in JSON format -* Selection: A selection of one of several pre-defined custom choices -* Multiple selection: A selection field which supports the assignment of multiple values -* Object: A single NetBox object of the type defined by `object_type` -* Multiple object: One or more NetBox objects of the type defined by `object_type` - -Each custom field must have a name. This should be a simple database-friendly string (e.g. `tps_report`) and may contain only alphanumeric characters and underscores. You may also assign a corresponding human-friendly label (e.g. "TPS report"); the label will be displayed on web forms. A weight is also required: Higher-weight fields will be ordered lower within a form. (The default weight is 100.) If a description is provided, it will appear beneath the field in a form. - -Marking a field as required will force the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields, or the exact value of a choice for selection fields. - -A custom field must be assigned to one or more object types, or models, in NetBox. Once created, custom fields will automatically appear as part of these models in the web UI and REST API. Note that not all models support custom fields. - -### Filtering - -The filter logic controls how values are matched when filtering objects by the custom field. Loose filtering (the default) matches on a partial value, whereas exact matching requires a complete match of the given string to a field's value. For example, exact filtering with the string "red" will only match the exact value "red", whereas loose filtering will match on the values "red", "red-orange", or "bored". Setting the filter logic to "disabled" disables filtering by the field entirely. - -### Grouping - -!!! note - This feature was introduced in NetBox v3.3. - -Related custom fields can be grouped together within the UI by assigning each the same group name. When at least one custom field for an object type has a group defined, it will appear under the group heading within the custom fields panel under the object view. All custom fields with the same group name will appear under that heading. (Note that the group names must match exactly, or each will appear as a separate heading.) - -This parameter has no effect on the API representation of custom field data. - -### Visibility - -!!! note - This feature was introduced in NetBox v3.3. - -When creating a custom field, there are three options for UI visibility. These control how and whether the custom field is displayed within the NetBox UI. - -* **Read/write** (default): The custom field is included when viewing and editing objects. -* **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.) -* **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users. - -Note that this setting has no impact on the REST or GraphQL APIs: Custom field data will always be available via either API. - -### Validation - -NetBox supports limited custom validation for custom field values. Following are the types of validation enforced for each field type: - -* Text: Regular expression (optional) -* Integer: Minimum and/or maximum value (optional) -* Selection: Must exactly match one of the prescribed choices - -### Custom Selection Fields - -Each custom selection field must have at least two choices. These are specified as a comma-separated list. Choices appear in forms in the order they are listed. Note that choice values are saved exactly as they appear, so it's best to avoid superfluous punctuation or symbols where possible. - -If a default value is specified for a selection field, it must exactly match one of the provided choices. The value of a multiple selection field will always return a list, even if only one value is selected. - -### Custom Object Fields - -An object or multi-object custom field can be used to refer to a particular NetBox object or objects as the "value" for a custom field. These custom fields must define an `object_type`, which determines the type of object to which custom field instances point. diff --git a/docs/models/extras/exporttemplate.md b/docs/models/extras/exporttemplate.md deleted file mode 100644 index e76a3ad47..000000000 --- a/docs/models/extras/exporttemplate.md +++ /dev/null @@ -1,37 +0,0 @@ -# Export Templates - -NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Templates. - -Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list. Each export template must have a name, and may optionally designate a specific export [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) and/or file extension. - -Export templates must be written in [Jinja2](https://jinja.palletsprojects.com/). - -!!! note - The name `table` is reserved for internal use. - -!!! warning - Export templates are rendered using user-submitted code, which may pose security risks under certain conditions. Only grant permission to create or modify export templates to trusted users. - -The list of objects returned from the database when rendering an export template is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example: - -```jinja2 -{% for rack in queryset %} -Rack: {{ rack.name }} -Site: {{ rack.site.name }} -Height: {{ rack.u_height }}U -{% endfor %} -``` - -To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`. - -If you need to use the config context data in an export template, you'll should use the function `get_config_context` to get all the config context data. For example: -``` -{% for server in queryset %} -{% set data = server.get_config_context() %} -{{ data.syslog }} -{% endfor %} -``` - -The `as_attachment` attribute of an export template controls its behavior when rendered. If true, the rendered content will be returned to the user as a downloadable file. If false, it will be displayed within the browser. (This may be handy e.g. for generating HTML content.) - -A MIME type and file extension can optionally be defined for each export template. The default MIME type is `text/plain`. diff --git a/docs/models/extras/imageattachment.md b/docs/models/extras/imageattachment.md deleted file mode 100644 index da15462ab..000000000 --- a/docs/models/extras/imageattachment.md +++ /dev/null @@ -1,3 +0,0 @@ -# Image Attachments - -Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. diff --git a/docs/models/users/objectpermission.md b/docs/models/users/objectpermission.md deleted file mode 100644 index 82dbc955a..000000000 --- a/docs/models/users/objectpermission.md +++ /dev/null @@ -1,69 +0,0 @@ -# Object Permissions - -A permission in NetBox represents a relationship shared by several components: - -* Object type(s) - One or more types of object in NetBox -* User(s)/Group(s) - One or more users or groups of users -* Action(s) - The action(s) that can be performed on an object -* Constraints - An arbitrary filter used to limit the granted action(s) to a specific subset of objects - -At a minimum, a permission assignment must specify one object type, one user or group, and one action. The specification of constraints is optional: A permission without any constraints specified will apply to all instances of the selected model(s). - -## Actions - -There are four core actions that can be permitted for each type of object within NetBox, roughly analogous to the CRUD convention (create, read, update, and delete): - -* **View** - Retrieve an object from the database -* **Add** - Create a new object -* **Change** - Modify an existing object -* **Delete** - Delete an existing object - -In addition to these, permissions can also grant custom actions that may be required by a specific model or plugin. For example, the `napalm_read` permission on the device model allows a user to execute NAPALM queries on a device via NetBox's REST API. These can be specified when granting a permission in the "additional actions" field. - -!!! note - Internally, all actions granted by a permission (both built-in and custom) are stored as strings in an array field named `actions`. - -## Constraints - -Constraints are expressed as a JSON object or list representing a [Django query filter](https://docs.djangoproject.com/en/stable/ref/models/querysets/#field-lookups). This is the same syntax that you would pass to the QuerySet `filter()` method when performing a query using the Django ORM. As with query filters, double underscores can be used to traverse related objects or invoke lookup expressions. Some example queries and their corresponding definitions are shown below. - -All attributes defined within a single JSON object are applied with a logical AND. For example, suppose you assign a permission for the site model with the following constraints. - -```json -{ - "status": "active", - "region__name": "Americas" -} -``` - -The permission will grant access only to sites which have a status of "active" **and** which are assigned to the "Americas" region. - -To achieve a logical OR with a different set of constraints, define multiple objects within a list. For example, if you want to constrain the permission to VLANs with an ID between 100 and 199 _or_ a status of "reserved," do the following: - -```json -[ - { - "vid__gte": 100, - "vid__lt": 200 - }, - { - "status": "reserved" - } -] -``` - -Additionally, where multiple permissions have been assigned for an object type, their collective constraints will be merged using a logical "OR" operation. - -### User Token - -!!! info "This feature was introduced in NetBox v3.3" - -When defining a permission constraint, administrators may use the special token `$user` to reference the current user at the time of evaluation. This can be helpful to restrict users to editing only their own journal entries, for example. Such a constraint might be defined as: - -```json -{ - "created_by": "$user" -} -``` - -The `$user` token can be used only as a constraint value, or as an item within a list of values. It cannot be modified or extended to reference specific user attributes. diff --git a/docs/models/users/token.md b/docs/models/users/token.md deleted file mode 100644 index f6c5bfe80..000000000 --- a/docs/models/users/token.md +++ /dev/null @@ -1,19 +0,0 @@ -## Tokens - -A token is a unique identifier mapped to a NetBox user account. Each user may have one or more tokens which he or she can use for authentication when making REST API requests. To create a token, navigate to the API tokens page under your user profile. - -!!! note - All users can create and manage REST API tokens under the user control panel in the UI. The ability to view, add, change, or delete tokens via the REST API itself is controlled by the relevant model permissions, assigned to users and/or groups in the admin UI. These permissions should be used with great care to avoid accidentally permitting a user to create tokens for other user accounts. - -Each token contains a 160-bit key represented as 40 hexadecimal characters. When creating a token, you'll typically leave the key field blank so that a random key will be automatically generated. However, NetBox allows you to specify a key in case you need to restore a previously deleted token to operation. - -By default, a token can be used to perform all actions via the API that a user would be permitted to do via the web UI. Deselecting the "write enabled" option will restrict API requests made with the token to read operations (e.g. GET) only. - -Additionally, a token can be set to expire at a specific time. This can be useful if an external client needs to be granted temporary access to NetBox. - -### Client IP Restriction - -!!! note - This feature was introduced in NetBox v3.3. - -Each API token can optionally be restricted by client IP address. If one or more allowed IP prefixes/addresses is defined for a token, authentication will fail for any client connecting from an IP address outside the defined range(s). This enables restricting the use a token to a specific client. (By default, any client IP address is permitted.) diff --git a/docs/rest-api/filtering.md b/docs/reference/filtering.md similarity index 100% rename from docs/rest-api/filtering.md rename to docs/reference/filtering.md diff --git a/docs/release-notes/version-3.0.md b/docs/release-notes/version-3.0.md index 93ff33d95..06b889c22 100644 --- a/docs/release-notes/version-3.0.md +++ b/docs/release-notes/version-3.0.md @@ -357,7 +357,7 @@ And the response: ... ``` -All GraphQL requests are made at the `/graphql` URL (which also serves the GraphiQL UI). The API is currently read-only, however users who wish to disable it until needed can do so by setting the `GRAPHQL_ENABLED` configuration parameter to False. For more detail on NetBox's GraphQL implementation, see [the GraphQL API documentation](../graphql-api/overview.md). +All GraphQL requests are made at the `/graphql` URL (which also serves the GraphiQL UI). The API is currently read-only, however users who wish to disable it until needed can do so by setting the `GRAPHQL_ENABLED` configuration parameter to False. For more detail on NetBox's GraphQL implementation, see [the GraphQL API documentation](../integrations/graphql-api.md). #### IP Ranges ([#834](https://github.com/netbox-community/netbox/issues/834)) diff --git a/docs/rest-api/authentication.md b/docs/rest-api/authentication.md deleted file mode 100644 index 411063338..000000000 --- a/docs/rest-api/authentication.md +++ /dev/null @@ -1,73 +0,0 @@ -# REST API Authentication - -The NetBox REST API primarily employs token-based authentication. For convenience, cookie-based authentication can also be used when navigating the browsable API. - -{!models/users/token.md!} - -## Authenticating to the API - -An authentication token is attached to a request by setting the `Authorization` header to the string `Token` followed by a space and the user's token: - -``` -$ curl -H "Authorization: Token $TOKEN" \ --H "Accept: application/json; indent=4" \ -https://netbox/api/dcim/sites/ -{ - "count": 10, - "next": null, - "previous": null, - "results": [...] -} -``` - -A token is not required for read-only operations which have been exempted from permissions enforcement (using the [`EXEMPT_VIEW_PERMISSIONS`](../configuration/security.md#exempt_view_permissions) configuration parameter). However, if a token _is_ required but not present in a request, the API will return a 403 (Forbidden) response: - -``` -$ curl https://netbox/api/dcim/sites/ -{ - "detail": "Authentication credentials were not provided." -} -``` - -When a token is used to authenticate a request, its `last_updated` time updated to the current time if its last use was recorded more than 60 seconds ago (or was never recorded). This allows users to determine which tokens have been active recently. - -!!! note - The "last used" time for tokens will not be updated while maintenance mode is enabled. - -## Initial Token Provisioning - -Ideally, each user should provision his or her own REST API token(s) via the web UI. However, you may encounter where a token must be created by a user via the REST API itself. NetBox provides a special endpoint to provision tokens using a valid username and password combination. - -To provision a token via the REST API, make a `POST` request to the `/api/users/tokens/provision/` endpoint: - -``` -$ curl -X POST \ --H "Content-Type: application/json" \ --H "Accept: application/json; indent=4" \ -https://netbox/api/users/tokens/provision/ \ ---data '{ - "username": "hankhill", - "password": "I<3C3H8", -}' -``` - -Note that we are _not_ passing an existing REST API token with this request. If the supplied credentials are valid, a new REST API token will be automatically created for the user. Note that the key will be automatically generated, and write ability will be enabled. - -```json -{ - "id": 6, - "url": "https://netbox/api/users/tokens/6/", - "display": "3c9cb9 (hankhill)", - "user": { - "id": 2, - "url": "https://netbox/api/users/users/2/", - "display": "hankhill", - "username": "hankhill" - }, - "created": "2021-06-11T20:09:13.339367Z", - "expires": null, - "key": "9fc9b897abec9ada2da6aec9dbc34596293c9cb9", - "write_enabled": true, - "description": "" -} -``` diff --git a/mkdocs.yml b/mkdocs.yml index 4c5279127..f76a91484 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -62,6 +62,26 @@ markdown_extensions: alternate_style: true nav: - Introduction: 'introduction.md' + - Features: + - Facilities: 'features/facilities.md' + - Tenancy: 'features/tenancy.md' + - Contacts: 'features/contacts.md' + - Devices & Cabling: 'features/devices-cabling.md' + - Power Tracking: 'features/power-tracking.md' + - IPAM: 'features/ipam.md' + - VLAN Management: 'features/vlan-management.md' + - Service Mapping: 'features/services.md' + - L2VPN & Overlay: 'features/l2vpn-overlay.md' + - Circuits: 'features/circuits.md' + - Wireless: 'features/wireless.md' + - Context Data: 'features/context-data.md' + - Change Logging: 'features/change-logging.md' + - Journaling: 'features/journaling.md' + - Webhooks: 'features/webhooks.md' + - Tags: 'features/tags.md' + - Customization: 'features/customization.md' + - Object-Based Permissions: 'features/permissions.md' + - Single Sign-On (SSO): 'features/sso.md' - Installation & Upgrade: - Installing NetBox: 'installation/index.md' - 1. PostgreSQL: 'installation/1-postgresql.md' @@ -90,19 +110,16 @@ nav: - Development: 'configuration/development.md' - Customization: - Custom Fields: 'customization/custom-fields.md' + - Custom Links: 'customization/custom-links.md' - Custom Validation: 'customization/custom-validation.md' - - Custom Links: 'models/extras/customlink.md' - Export Templates: 'customization/export-templates.md' - - Custom Scripts: 'customization/custom-scripts.md' - Reports: 'customization/reports.md' - - Additional Features: - - Change Logging: 'additional-features/change-logging.md' - - Context Data: 'models/extras/configcontext.md' - - Journaling: 'additional-features/journaling.md' - - NAPALM: 'additional-features/napalm.md' - - Prometheus Metrics: 'additional-features/prometheus-metrics.md' - - Tags: 'models/extras/tag.md' - - Webhooks: 'additional-features/webhooks.md' + - Custom Scripts: 'customization/custom-scripts.md' + - Integrations: + - REST API: 'integrations/rest-api.md' + - GraphQL API: 'integrations/graphql-api.md' + - NAPALM: 'integrations/napalm.md' + - Prometheus Metrics: 'integrations/prometheus-metrics.md' - Plugins: - Using Plugins: 'plugins/index.md' - Developing Plugins: @@ -128,12 +145,6 @@ nav: - Housekeeping: 'administration/housekeeping.md' - Replicating NetBox: 'administration/replicating-netbox.md' - NetBox Shell: 'administration/netbox-shell.md' - - REST API: - - Overview: 'rest-api/overview.md' - - Filtering & Ordering: 'rest-api/filtering.md' - - Authentication: 'rest-api/authentication.md' - - GraphQL API: - - Overview: 'graphql-api/overview.md' - Data Model: - Circuits: - Circuit: 'models/circuits/circuit.md' @@ -143,8 +154,6 @@ nav: - Provider Network: 'models/circuits/providernetwork.md' - DCIM: - Cable: 'models/dcim/cable.md' - - CablePath: 'models/dcim/cablepath.md' - - CableTermination: 'models/dcim/cabletermination.md' - ConsolePort: 'models/dcim/consoleport.md' - ConsolePortTemplate: 'models/dcim/consoleporttemplate.md' - ConsoleServerPort: 'models/dcim/consoleserverport.md' @@ -203,7 +212,6 @@ nav: - VRF: 'models/ipam/vrf.md' - Tenancy: - Contact: 'models/tenancy/contact.md' - - ContactAssignment: 'models/tenancy/contactassignment.md' - ContactGroup: 'models/tenancy/contactgroup.md' - ContactRole: 'models/tenancy/contactrole.md' - Tenant: 'models/tenancy/tenant.md' @@ -219,6 +227,7 @@ nav: - WirelessLANGroup: 'models/wireless/wirelesslangroup.md' - WirelessLink: 'models/wireless/wirelesslink.md' - Reference: + - Filtering: 'reference/filtering.md' - Conditions: 'reference/conditions.md' - Markdown: 'reference/markdown.md' - Development: From 4c899f151cce9fae6ae1596c481f2fa92e6a6cf9 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 4 Aug 2022 14:12:51 -0400 Subject: [PATCH 344/593] Drop markdown-include --- mkdocs.yml | 3 --- requirements.txt | 1 - 2 files changed, 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index f76a91484..78ca5031c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -47,9 +47,6 @@ extra_css: markdown_extensions: - admonition - attr_list - - markdown_include.include: - base_path: 'docs/' - headingOffset: 1 - pymdownx.emoji: emoji_index: !!python/name:materialx.emoji.twemoji emoji_generator: !!python/name:materialx.emoji.to_svg diff --git a/requirements.txt b/requirements.txt index 8a7dd79d4..facf925f4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -19,7 +19,6 @@ graphene-django==2.15.0 gunicorn==20.1.0 Jinja2==3.1.2 Markdown==3.4.1 -markdown-include==0.7.0 mkdocs-material==8.3.9 mkdocstrings[python-legacy]==0.19.0 netaddr==0.8.0 From 8c0ef1a0a2e324a8b46af2591a9f1b087fcecb4d Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 4 Aug 2022 16:35:32 -0400 Subject: [PATCH 345/593] Started on feature docs --- docs/features/contacts.md | 23 +++++++++- docs/features/devices-cabling.md | 78 +++++++++++++++++++++++++++++++- docs/features/facilities.md | 57 ++++++++++++++++++++++- docs/features/tenancy.md | 18 +++++++- 4 files changed, 172 insertions(+), 4 deletions(-) diff --git a/docs/features/contacts.md b/docs/features/contacts.md index fb23e53da..7d717b2de 100644 --- a/docs/features/contacts.md +++ b/docs/features/contacts.md @@ -1,3 +1,24 @@ # Contacts -TODO +Much like [tenancy](./tenancy.md), contact assignment enables you to track ownership of resources modeled in NetBox. A contact represents an individual responsible for a resource within the context of its assigned role. + +```mermaid +flowchart TD + ContactGroup --> ContactGroup & Contact + ContactRole & Contact --> assignment([Assignment]) + assignment --> Object +``` + +## Contact Groups + +Contacts can be grouped arbitrarily into a recursive hierarchy, and a contact can be assigned to a group at any level within the hierarchy. + +## Contact Roles + +A contact role defines the relationship of a contact to an assigned object. For example, you might define roles for administrative, operational, and emergency contacts. + +## Contacts + +A contact should represent an individual or permanent point of contact. Each contact must define a name, and may optionally include a title, phone number, email address, and related details. + +Contacts are reused for assignments, so each unique contact must be created only once and can be assigned to any number of NetBox objects, and there is no limit to the number of assigned contacts an object may have. Most core objects in NetBox can have contacts assigned to them. diff --git a/docs/features/devices-cabling.md b/docs/features/devices-cabling.md index ab09b4443..7297f79ac 100644 --- a/docs/features/devices-cabling.md +++ b/docs/features/devices-cabling.md @@ -1,3 +1,79 @@ # Devices & Cabling -TODO +At its heart, NetBox is a tool for modeling your network infrastructure, and the device object is pivotal to that function. A device can be any piece of physical hardware installed within your network, such as server, router, or switch, and may optionally be mounted within a rack. Within each device, resources such as network interfaces and console ports are modeled as discrete components, which may optionally be grouped into modules. + +NetBox uses device types to represent unique real-world device models. This allows a user to define a device type and all its components once, and easily replicate an unlimited number of device instances from it. + +```mermaid +flowchart TD + Manufacturer -.-> Platform & DeviceType & ModuleType + Manufacturer --> DeviceType & ModuleType + DeviceRole & Platform & DeviceType --> Device + Device & ModuleType ---> Module + Device & Module --> Interface & ConsolePort & PowerPort & ... +``` + +## Manufacturers + +A manufacturer generally represents an organization which produces hardware devices. These can be defined by users, however they should represent an actual entity rather than some abstract idea. + +## Device Types + +A device type represents a unique combination of manufacturer and hardware model which maps to discrete make and model of device which exists in the real world. Each device type typically has a number of components created on it, representing network interfaces, device bays, and so on. New devices of this type can then be created in NetBox, and any associated components will be automatically replicated from the device type. This avoids needing to tediously recreate components for each device as it is added in NetBox. + +!!! tip "The Device Type Library" + While users are always free to create their own device types in NetBox, many find it convenient to draw from our [community library](https://github.com/netbox-community/devicetype-library) of pre-defined device types. This is possible because a particular make and model of device is applicable universally and never changes. + +All the following can be modeled as components: + +* Interfaces +* Console ports +* Console server ports +* Power ports +* Power outlets +* Pass-through ports (front and rear) +* Module bays (which house modules) +* Device bays (which house child devices) + +For example, a Juniper EX4300-48T device type might have the following component templates defined: + +* One template for a console port ("Console") +* Two templates for power ports ("PSU0" and "PSU1") +* 48 templates for 1GE interfaces ("ge-0/0/0" through "ge-0/0/47") +* Four templates for 10GE interfaces ("xe-0/2/0" through "xe-0/2/3") + +Once component templates have been created, every new device that you create as an instance of this type will automatically be assigned each of the components listed above. + +!!! note "Component Instantiation is not Retroactive" + The instantiation of components from a device type definition occurs only at the time of device creation. If you modify the components assigned to a device type, it will not affect devices which have already been created. This guards against any inadvertent changes to existing devices. However, you always have the option of adding, modifying, or deleting components on existing devices. (These changes can easily be applied to multiple devices at once using the bulk operations available in the UI.) + +## Devices + +Whereas a device type defines the make and model of a device, a device itself represents an actual piece of installed hardware somewhere in the real world. A device can be installed at a particular position within an equipment rack, or simply associated with a site (and optionally with a location within that site). + +Each device can have an operational status, functional role, and software platform assigned. Device components are instantiated automatically from the assigned device type upon creation. + +### Virtual Chassis + +Sometimes it is necessary to model a set of physical devices as sharing a single management plane. Perhaps the most common example of such a scenario is stackable switches. These can be modeled as virtual chassis in NetBox, with one device acting as the chassis master and the rest as members. All components of member devices will appear on the master. + +## Module Types & Modules + +Much like device types and devices, module types can instantiate discrete modules, which are hardware components installed within devices. Modules often have their own child components, which become available to the parent device. For example, when modeling a chassis-based switch with multiple line cards in NetBox, the chassis would be created (from a device type) as a device, and each of its line cards would be instantiated from a module type as a module installed in one of the device's module bays. + +!!! tip "Device Bays vs. Module Bays" + What's the difference between device bays and module bays? Device bays are appropriate when the installed hardware has its own management plane, isolated from the parent device. A common example is a blade server chassis in which the blades share power but operate independently. In contrast, a module bay holds a module which does _not_ operate independently of its parent device, as with the chassis switch line card example mentioned above. + +One especially nice feature of modules is that templated components can be automatically renamed according to the module bay into which the parent module is installed. For example, if we create a module type with interfaces named `Gi{module}/0/1-48` and install a module of this type into module bay 7 of a device, NetBox will create interfaces named `Gi7/0/1-48`. + +## Cables + +NetBox models cables as connections among certain types of device components and other objects. Each cable can be assigned a type, color, length, and label. NetBox will enforce basic sanity checks to prevent invalid connections. (For example, a network interface cannot be connected to a power outlet.) + +Either end of a cable may terminate to multiple objects of the same type. For example, a network interface can be connected via a fiber optic cable to two discrete ports on a patch panel (each port attaching to an individual fiber strand in the patch cable). + +```mermaid +flowchart LR + Interface --> Cable + Cable --> fp1[Front Port] & fp2[Front Port] +``` diff --git a/docs/features/facilities.md b/docs/features/facilities.md index 5ace5b18b..0fb65aae7 100644 --- a/docs/features/facilities.md +++ b/docs/features/facilities.md @@ -1,3 +1,58 @@ # Facilities -TODO \ No newline at end of file +From global regions down to individual equipment racks, NetBox allows you to model your network's entire presence. This is accomplished through the use of several purpose-built models. The graph below illustrates these models and their relationships. + +```mermaid +flowchart TD + Region --> Region + SiteGroup --> SiteGroup + Region & SiteGroup --> Site + Site --> Location & Device + Location --> Location + Location --> Rack & Device + Rack --> Device + Site --> Rack + RackRole --> Rack +``` + +## Regions + +Regions represent geographic domains in which your network or its customers have a presence. These are typically used to model countries, states, and cities, although NetBox does not prescribe any precise uses and your needs may differ. + +Regions are self-nesting, so you can define child regions within a parent, and grandchildren within each child. For example, you might create a hierarchy like this: + +* Europe + * France + * Germany + * Spain +* North America + * Canada + * United States + * California + * New York + * Texas + +Regions will always be listed alphabetically by name within each parent, and there is no maximum depth for the hierarchy. + +## Site Groups + +Like regions, site groups can be arranged in a recursive hierarchy for grouping sites. However, whereas regions are intended for geographic organization, site groups may be used for functional grouping. For example, you might classify sites as corporate, branch, or customer sites in addition to where they are physically located. + +The use of both regions and site groups affords to independent but complementary dimensions across which sites can be organized. + +## Site + +A site typically represents a building within a region and/or site group. Each site is assigned an operational status (e.g. active or planned), and can have a discrete mailing address and GPS coordinates assigned to it. + +## Location + +A location can be any logical subdivision within a building, such as a floor or room. Like regions and site groups, locations can be nested into a self-recursive hierarchy for maximum flexibility. And like sites, each location has an operational status assigned to it. + +## Rack + +Finally, NetBox models each equipment rack as a discrete object within a site and location. These are physical objects into which devices are installed. Each rack can be assigned an operational status, type, facility ID, and other attributes related to inventory tracking. Each rack also must define a height (in rack units) and width, and may optionally specify its physical dimensions. + +Each rack must be associated to a site, but the assignment to a location within that site is optional. Users can also create custom roles to which racks can be assigned. + +!!! tip "Devices" + You'll notice in the diagram above that a device can be installed within a site, location, or rack. This approach affords plenty of flexibility as not all sites need to define child locations, and not all devices reside in racks. diff --git a/docs/features/tenancy.md b/docs/features/tenancy.md index 20534b13c..fe6d8e5a8 100644 --- a/docs/features/tenancy.md +++ b/docs/features/tenancy.md @@ -1,3 +1,19 @@ # Tenancy -TODO +Most core objects within NetBox's data model support _tenancy_. This is the association of an object with a particular tenant to convey ownership or dependency. For example, an enterprise might represent its internal business units as tenants, whereas a managed services provider might create a tenant in NetBox to represent each of its customers. + +```mermaid +flowchart TD + TenantGroup --> TenantGroup & Tenant + Tenant --> Site & Device & Prefix & Circuit & ... +``` + +## Tenant Groups + +Tenants can be grouped by any logic that your use case demands, and groups can nested recursively for maximum flexibility. For example, You might define a parent "Customers" group with child groups "Current" and "Past" within it. A tenant can be assigned to a group at any level within the hierarchy. + +## Tenants + +Typically, the tenant model is used to represent a customer or internal organization, however it can be used for whatever purpose meets your needs. + +Most core objects within NetBox can be assigned to particular tenant, so this model provides a very convenient way to correlate ownership across object types. For example, each of your customers might have its own racks, devices, IP addresses, circuits and so on: These can all be easily tracked via tenant assignment. From db38ed4f19e5943bf60434f4cfc08d232dbb5e6e Mon Sep 17 00:00:00 2001 From: Osamu-kj Date: Sat, 6 Aug 2022 15:10:31 +0200 Subject: [PATCH 346/593] Fixed the XSS protection code inside custom fields --- netbox/netbox/tables/columns.py | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index 7774a495f..277482512 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -1,5 +1,4 @@ from dataclasses import dataclass -from glob import escape from typing import Optional import django_tables2 as tables @@ -8,6 +7,7 @@ from django.contrib.auth.models import AnonymousUser from django.db.models import DateField, DateTimeField from django.template import Context, Template from django.urls import reverse +from django.utils.html import escape from django.utils.formats import date_format from django.utils.safestring import mark_safe from django_tables2.columns import library @@ -430,25 +430,28 @@ class CustomFieldColumn(tables.Column): def _likify_item(item): if hasattr(item, 'get_absolute_url'): return f'{item}' - return item + return escape(item) def render(self, value): if self.customfield.type == CustomFieldTypeChoices.TYPE_BOOLEAN and value is True: - return escape('') + return mark_safe('') if self.customfield.type == CustomFieldTypeChoices.TYPE_BOOLEAN and value is False: - return escape('') + return mark_safe('') if self.customfield.type == CustomFieldTypeChoices.TYPE_URL: - return escape(f'{value}') + return mark_safe(f'{escape(value)}') if self.customfield.type == CustomFieldTypeChoices.TYPE_MULTISELECT: return ', '.join(v for v in value) if self.customfield.type == CustomFieldTypeChoices.TYPE_MULTIOBJECT: - return escape(', '.join([ + print (mark_safe(', '.join([ + self._likify_item(obj) for obj in self.customfield.deserialize(value) + ]))) + return mark_safe(', '.join([ self._likify_item(obj) for obj in self.customfield.deserialize(value) ])) if value is not None: obj = self.customfield.deserialize(value) - return escape(self._likify_item(obj)) - return escape(self.default) + return mark_safe(self._likify_item(obj)) + return self.default def value(self, value): if isinstance(value, list): From 7141fc8eb03eeba0d751e7af374f7d6a92ea60cb Mon Sep 17 00:00:00 2001 From: Osamu-kj Date: Sat, 6 Aug 2022 17:17:43 +0200 Subject: [PATCH 347/593] Custom fields - removed the debug lines --- netbox/netbox/tables/columns.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index 277482512..573ac058c 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -429,7 +429,7 @@ class CustomFieldColumn(tables.Column): @staticmethod def _likify_item(item): if hasattr(item, 'get_absolute_url'): - return f'{item}' + return f'{escape(item)}' return escape(item) def render(self, value): @@ -442,9 +442,6 @@ class CustomFieldColumn(tables.Column): if self.customfield.type == CustomFieldTypeChoices.TYPE_MULTISELECT: return ', '.join(v for v in value) if self.customfield.type == CustomFieldTypeChoices.TYPE_MULTIOBJECT: - print (mark_safe(', '.join([ - self._likify_item(obj) for obj in self.customfield.deserialize(value) - ]))) return mark_safe(', '.join([ self._likify_item(obj) for obj in self.customfield.deserialize(value) ])) From 0e1947bc4bceaf01d519bc7cc2e9fc09768b0409 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 8 Aug 2022 09:58:58 -0400 Subject: [PATCH 348/593] PEP8 fix --- netbox/netbox/tables/columns.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index 573ac058c..e176b9af7 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -7,7 +7,7 @@ from django.contrib.auth.models import AnonymousUser from django.db.models import DateField, DateTimeField from django.template import Context, Template from django.urls import reverse -from django.utils.html import escape +from django.utils.html import escape from django.utils.formats import date_format from django.utils.safestring import mark_safe from django_tables2.columns import library From 135543683db21d2856f5b12311b348e7061ff743 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 8 Aug 2022 10:24:49 -0400 Subject: [PATCH 349/593] Changelog for #9919 --- docs/release-notes/version-3.2.md | 1 + netbox/netbox/tables/columns.py | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 1c7eb79e8..d13e8db75 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -20,6 +20,7 @@ * [#9884](https://github.com/netbox-community/netbox/issues/9884) - Prevent querying assigned VRF on prefix object init * [#9885](https://github.com/netbox-community/netbox/issues/9885) - Fix child prefix counts when editing/deleting aggregates in bulk * [#9891](https://github.com/netbox-community/netbox/issues/9891) - Ensure consistent ordering for tags during object serialization +* [#9919](https://github.com/netbox-community/netbox/issues/9919) - Fix potential XSS avenue via linked objects in tables --- diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index e176b9af7..f78b9f37c 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -442,9 +442,9 @@ class CustomFieldColumn(tables.Column): if self.customfield.type == CustomFieldTypeChoices.TYPE_MULTISELECT: return ', '.join(v for v in value) if self.customfield.type == CustomFieldTypeChoices.TYPE_MULTIOBJECT: - return mark_safe(', '.join([ + return mark_safe(', '.join( self._likify_item(obj) for obj in self.customfield.deserialize(value) - ])) + )) if value is not None: obj = self.customfield.deserialize(value) return mark_safe(self._likify_item(obj)) From 90317adae77c7aeab79d798c1e6f3a983d18fd8a Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 8 Aug 2022 10:47:07 -0400 Subject: [PATCH 350/593] Clean up usages of mark_safe() --- netbox/dcim/views.py | 5 ++--- netbox/netbox/views/generic/object_views.py | 6 +++--- netbox/utilities/templatetags/builtins/filters.py | 4 ++-- netbox/utilities/templatetags/helpers.py | 4 +--- 4 files changed, 8 insertions(+), 11 deletions(-) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 3bec02f5c..0bdca686d 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -3083,7 +3083,7 @@ class VirtualChassisAddMemberView(ObjectPermissionRequiredMixin, GetReturnURLMix if membership_form.is_valid(): membership_form.save() - msg = 'Added member {}'.format(device.get_absolute_url(), escape(device)) + msg = f'Added member {escape(device)}' messages.success(request, mark_safe(msg)) if '_addanother' in request.POST: @@ -3128,8 +3128,7 @@ class VirtualChassisRemoveMemberView(ObjectPermissionRequiredMixin, GetReturnURL # Protect master device from being removed virtual_chassis = VirtualChassis.objects.filter(master=device).first() if virtual_chassis is not None: - msg = 'Unable to remove master device {} from the virtual chassis.'.format(escape(device)) - messages.error(request, mark_safe(msg)) + messages.error(request, f'Unable to remove master device {device} from the virtual chassis.') return redirect(device.get_absolute_url()) if form.is_valid(): diff --git a/netbox/netbox/views/generic/object_views.py b/netbox/netbox/views/generic/object_views.py index 4ebfe71cc..88e078ae3 100644 --- a/netbox/netbox/views/generic/object_views.py +++ b/netbox/netbox/views/generic/object_views.py @@ -386,10 +386,10 @@ class ObjectEditView(GetReturnURLMixin, BaseObjectView): ) logger.info(f"{msg} {obj} (PK: {obj.pk})") if hasattr(obj, 'get_absolute_url'): - msg = '{} {}'.format(msg, obj.get_absolute_url(), escape(obj)) + msg = mark_safe(f'{msg} {escape(obj)}') else: - msg = '{} {}'.format(msg, escape(obj)) - messages.success(request, mark_safe(msg)) + msg = f'{msg} {obj}' + messages.success(request, msg) if '_addanother' in request.POST: redirect_url = request.path diff --git a/netbox/utilities/templatetags/builtins/filters.py b/netbox/utilities/templatetags/builtins/filters.py index 5a6841286..bc395e438 100644 --- a/netbox/utilities/templatetags/builtins/filters.py +++ b/netbox/utilities/templatetags/builtins/filters.py @@ -86,8 +86,8 @@ def placeholder(value): """ if value not in ('', None): return value - placeholder = '—' - return mark_safe(placeholder) + + return mark_safe('—') @register.filter() diff --git a/netbox/utilities/templatetags/helpers.py b/netbox/utilities/templatetags/helpers.py index db4d14c24..67ed553b2 100644 --- a/netbox/utilities/templatetags/helpers.py +++ b/netbox/utilities/templatetags/helpers.py @@ -109,9 +109,7 @@ def annotated_date(date_value): long_ts = date(date_value, 'DATETIME_FORMAT') short_ts = date(date_value, 'SHORT_DATETIME_FORMAT') - span = f'{short_ts}' - - return mark_safe(span) + return mark_safe(f'{short_ts}') @register.simple_tag From 36ac83a319f1dbd1df3752c9ab8f129eefb23f9b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 8 Aug 2022 11:43:27 -0400 Subject: [PATCH 351/593] Fixes #9949: Fix KeyError exception resulting from invalid API token provisioning request --- docs/release-notes/version-3.2.md | 1 + netbox/users/api/views.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 d13e8db75..0ee235a82 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -21,6 +21,7 @@ * [#9885](https://github.com/netbox-community/netbox/issues/9885) - Fix child prefix counts when editing/deleting aggregates in bulk * [#9891](https://github.com/netbox-community/netbox/issues/9891) - Ensure consistent ordering for tags during object serialization * [#9919](https://github.com/netbox-community/netbox/issues/9919) - Fix potential XSS avenue via linked objects in tables +* [#9949](https://github.com/netbox-community/netbox/issues/9949) - Fix KeyError exception resulting from invalid API token provisioning request --- diff --git a/netbox/users/api/views.py b/netbox/users/api/views.py index c3495afdf..e5c2bc8ab 100644 --- a/netbox/users/api/views.py +++ b/netbox/users/api/views.py @@ -74,11 +74,11 @@ class TokenProvisionView(APIView): serializer.is_valid() # Authenticate the user account based on the provided credentials - user = authenticate( - request=request, - username=serializer.data['username'], - password=serializer.data['password'] - ) + username = serializer.data.get('username') + password = serializer.data.get('password') + if not username or not password: + raise AuthenticationFailed("Username and password must be provided to provision a token.") + user = authenticate(request=request, username=username, password=password) if user is None: raise AuthenticationFailed("Invalid username/password") From 876251c1cf6da80894780d3856412a2918da9d0e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 8 Aug 2022 11:48:43 -0400 Subject: [PATCH 352/593] Fixes #9948: Fix TypeError exception when requesting API tokens list as non-authenticated user --- docs/release-notes/version-3.2.md | 1 + netbox/users/api/views.py | 2 ++ 2 files changed, 3 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 0ee235a82..745ace110 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -21,6 +21,7 @@ * [#9885](https://github.com/netbox-community/netbox/issues/9885) - Fix child prefix counts when editing/deleting aggregates in bulk * [#9891](https://github.com/netbox-community/netbox/issues/9891) - Ensure consistent ordering for tags during object serialization * [#9919](https://github.com/netbox-community/netbox/issues/9919) - Fix potential XSS avenue via linked objects in tables +* [#9948](https://github.com/netbox-community/netbox/issues/9948) - Fix TypeError exception when requesting API tokens list as non-authenticated user * [#9949](https://github.com/netbox-community/netbox/issues/9949) - Fix KeyError exception resulting from invalid API token provisioning request --- diff --git a/netbox/users/api/views.py b/netbox/users/api/views.py index e5c2bc8ab..66ef92ab7 100644 --- a/netbox/users/api/views.py +++ b/netbox/users/api/views.py @@ -58,6 +58,8 @@ class TokenViewSet(NetBoxModelViewSet): # Workaround for schema generation (drf_yasg) if getattr(self, 'swagger_fake_view', False): return queryset.none() + if not self.request.user.is_authenticated: + return queryset.none() if self.request.user.is_superuser: return queryset return queryset.filter(user=self.request.user) From 8721ad987cf178cc5421f64c28b1772bdabaa967 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 8 Aug 2022 12:22:22 -0400 Subject: [PATCH 353/593] Fixes #9952: Prevent InvalidMove when attempting to assign a nested child object as parent --- docs/release-notes/version-3.2.md | 1 + netbox/netbox/models/__init__.py | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 745ace110..f231b6e58 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -23,6 +23,7 @@ * [#9919](https://github.com/netbox-community/netbox/issues/9919) - Fix potential XSS avenue via linked objects in tables * [#9948](https://github.com/netbox-community/netbox/issues/9948) - Fix TypeError exception when requesting API tokens list as non-authenticated user * [#9949](https://github.com/netbox-community/netbox/issues/9949) - Fix KeyError exception resulting from invalid API token provisioning request +* [#9952](https://github.com/netbox-community/netbox/issues/9952) - Prevent InvalidMove when attempting to assign a nested child object as parent --- diff --git a/netbox/netbox/models/__init__.py b/netbox/netbox/models/__init__.py index b3bfe06c0..ea2feb8de 100644 --- a/netbox/netbox/models/__init__.py +++ b/netbox/netbox/models/__init__.py @@ -89,9 +89,9 @@ class NestedGroupModel(NetBoxFeatureSet, MPTTModel): super().clean() # An MPTT model cannot be its own parent - if self.pk and self.parent_id == self.pk: + if self.pk and self.parent and self.parent in self.get_descendants(include_self=True): raise ValidationError({ - "parent": "Cannot assign self as parent." + "parent": f"Cannot assign self or child {self._meta.verbose_name} as parent." }) From caca074161977fcbd7d3d0cd0e02b42efb3e8184 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 8 Aug 2022 14:21:42 -0400 Subject: [PATCH 354/593] Fixes #9950: Prevent redirection to arbitrary URLs via 'next' parameter on login URL --- docs/release-notes/version-3.2.md | 1 + netbox/users/views.py | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index f231b6e58..46718837e 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -23,6 +23,7 @@ * [#9919](https://github.com/netbox-community/netbox/issues/9919) - Fix potential XSS avenue via linked objects in tables * [#9948](https://github.com/netbox-community/netbox/issues/9948) - Fix TypeError exception when requesting API tokens list as non-authenticated user * [#9949](https://github.com/netbox-community/netbox/issues/9949) - Fix KeyError exception resulting from invalid API token provisioning request +* [#9950](https://github.com/netbox-community/netbox/issues/9950) - Prevent redirection to arbitrary URLs via `next` parameter on login URL * [#9952](https://github.com/netbox-community/netbox/issues/9952) - Prevent InvalidMove when attempting to assign a nested child object as parent --- diff --git a/netbox/users/views.py b/netbox/users/views.py index 344f375fc..f08cac844 100644 --- a/netbox/users/views.py +++ b/netbox/users/views.py @@ -10,6 +10,7 @@ from django.http import HttpResponseRedirect from django.shortcuts import get_object_or_404, redirect, render from django.urls import reverse from django.utils.decorators import method_decorator +from django.utils.http import url_has_allowed_host_and_scheme from django.views.decorators.debug import sensitive_post_parameters from django.views.generic import View from social_core.backends.utils import load_backends @@ -91,7 +92,7 @@ class LoginView(View): data = request.POST if request.method == "POST" else request.GET redirect_url = data.get('next', settings.LOGIN_REDIRECT_URL) - if redirect_url and redirect_url.startswith('/'): + if redirect_url and url_has_allowed_host_and_scheme(redirect_url, allowed_hosts=None): logger.debug(f"Redirecting user to {redirect_url}") else: if redirect_url: From ce7fb8ab17406a8eba02055c22ec0b6cbe8ef425 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 8 Aug 2022 15:17:36 -0400 Subject: [PATCH 355/593] Release v3.2.8 --- .github/ISSUE_TEMPLATE/bug_report.yaml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yaml | 2 +- base_requirements.txt | 2 +- docs/release-notes/version-3.2.md | 2 +- netbox/netbox/settings.py | 2 +- requirements.txt | 12 ++++++------ 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 332a0ad75..c26584f32 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.7 + placeholder: v3.2.8 validations: required: true - type: dropdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index ff9b5e358..e6be95e49 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.7 + placeholder: v3.2.8 validations: required: true - type: dropdown diff --git a/base_requirements.txt b/base_requirements.txt index 9dc85231b..672ce402c 100644 --- a/base_requirements.txt +++ b/base_requirements.txt @@ -4,7 +4,7 @@ bleach # The Python web framework on which NetBox is built # https://github.com/django/django -Django +Django<4.1 # Django middleware which permits cross-domain API requests # https://github.com/OttoYiu/django-cors-headers diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 46718837e..bf6f2f848 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.8 (FUTURE) +## v3.2.8 (2022-08-08) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index c7e49c1be..12ab44399 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.8-dev' +VERSION = '3.2.8' # Hostname HOSTNAME = platform.node() diff --git a/requirements.txt b/requirements.txt index f987ad7ba..59bd1e8cd 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,5 @@ bleach==5.0.1 -Django==4.0.6 +Django==4.0.7 django-cors-headers==3.13.0 django-debug-toolbar==3.5.0 django-filter==22.1 @@ -13,22 +13,22 @@ django-tables2==2.4.1 django-taggit==2.1.0 django-timezone-field==5.0 djangorestframework==3.13.1 -drf-yasg[validation]==1.20.0 +drf-yasg[validation]==1.21.3 graphene-django==2.15.0 gunicorn==20.1.0 Jinja2==3.1.2 -Markdown==3.3.7 -markdown-include==0.6.0 +Markdown==3.4.1 +markdown-include==0.7.0 mkdocs-material==8.3.9 mkdocstrings[python-legacy]==0.19.0 netaddr==0.8.0 Pillow==9.2.0 psycopg2-binary==2.9.3 PyYAML==6.0 -sentry-sdk==1.7.0 +sentry-sdk==1.9.2 social-auth-app-django==5.0.0 social-auth-core==4.3.0 -svgwrite==1.4.2 +svgwrite==1.4.3 tablib==3.2.1 tzdata==2022.1 From 064d7f3bd0a803ed55198455e54a29c8f7c0adc2 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 8 Aug 2022 15:34:13 -0400 Subject: [PATCH 356/593] 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 bf6f2f848..56a35cc02 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.9 (FUTURE) + +--- + ## v3.2.8 (2022-08-08) ### Enhancements diff --git a/netbox/netbox/settings.py b/netbox/netbox/settings.py index 12ab44399..d38289d43 100644 --- a/netbox/netbox/settings.py +++ b/netbox/netbox/settings.py @@ -29,7 +29,7 @@ django.utils.encoding.force_text = force_str # Environment setup # -VERSION = '3.2.8' +VERSION = '3.2.9-dev' # Hostname HOSTNAME = platform.node() From c7faca948016caa8ce30b3571c8a4e71dc33f70e Mon Sep 17 00:00:00 2001 From: gildarov Date: Tue, 9 Aug 2022 11:56:19 +0300 Subject: [PATCH 357/593] fix typo in virtualization/forms/filtersets.py --- netbox/virtualization/forms/filtersets.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/virtualization/forms/filtersets.py b/netbox/virtualization/forms/filtersets.py index 88aa1a6c2..2f52850bd 100644 --- a/netbox/virtualization/forms/filtersets.py +++ b/netbox/virtualization/forms/filtersets.py @@ -89,7 +89,7 @@ class VirtualMachineFilterForm( (None, ('q', 'tag')), ('Cluster', ('cluster_group_id', 'cluster_type_id', 'cluster_id')), ('Location', ('region_id', 'site_group_id', 'site_id')), - ('Attriubtes', ('status', 'role_id', 'platform_id', 'mac_address', 'has_primary_ip', 'local_context_data')), + ('Attributes', ('status', 'role_id', 'platform_id', 'mac_address', 'has_primary_ip', 'local_context_data')), ('Tenant', ('tenant_group_id', 'tenant_id')), ('Contacts', ('contact', 'contact_role', 'contact_group')), ) From 602cf8c5fa371d767af70c6d0d9333c5732e9c7f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 9 Aug 2022 11:29:42 -0400 Subject: [PATCH 358/593] Fixes #9939: Fix list of next nodes for split paths under trace view --- docs/release-notes/version-3.3.md | 17 ++--------------- netbox/dcim/models/cables.py | 4 ++-- 2 files changed, 4 insertions(+), 17 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 2a3935e5e..74ed7f10c 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -97,22 +97,9 @@ Custom field UI visibility has no impact on API operation. * [#9536](https://github.com/netbox-community/netbox/issues/9536) - Track API token usage times * [#9582](https://github.com/netbox-community/netbox/issues/9582) - Enable assigning config contexts based on device location -### Bug Fixes (from Beta1) +### Bug Fixes (from Beta2) -* [#9728](https://github.com/netbox-community/netbox/issues/9728) - Fix validation when assigning a virtual machine to a device -* [#9729](https://github.com/netbox-community/netbox/issues/9729) - Fix ordering of content type creation to ensure compatability with demo data -* [#9730](https://github.com/netbox-community/netbox/issues/9730) - Fix validation error when creating a new cable via UI form -* [#9733](https://github.com/netbox-community/netbox/issues/9733) - Handle split paths during trace when fanning out to front ports with differing cables -* [#9765](https://github.com/netbox-community/netbox/issues/9765) - Report correct segment count under cable trace UI view -* [#9778](https://github.com/netbox-community/netbox/issues/9778) - Fix exception during cable deletion after deleting a connected termination -* [#9788](https://github.com/netbox-community/netbox/issues/9788) - Ensure denormalized fields on CableTermination are kept in sync with related objects -* [#9789](https://github.com/netbox-community/netbox/issues/9789) - Fix rendering of cable traces ending at provider networks -* [#9794](https://github.com/netbox-community/netbox/issues/9794) - Fix link to connect a rear port to a circuit termination -* [#9818](https://github.com/netbox-community/netbox/issues/9818) - Fix circuit side selection when connecting a cable to a circuit termination -* [#9829](https://github.com/netbox-community/netbox/issues/9829) - Arrange custom fields by group when editing objects -* [#9843](https://github.com/netbox-community/netbox/issues/9843) - Fix rendering of custom field values (regression from #9647) -* [#9844](https://github.com/netbox-community/netbox/issues/9844) - Fix interface api request when creating/editing L2VPN termination -* [#9847](https://github.com/netbox-community/netbox/issues/9847) - Respect `desc_units` when ordering rack units +* [#9939](https://github.com/netbox-community/netbox/issues/9939) - Fix list of next nodes for split paths under trace view ### Plugins API diff --git a/netbox/dcim/models/cables.py b/netbox/dcim/models/cables.py index 321d808ff..2be64451f 100644 --- a/netbox/dcim/models/cables.py +++ b/netbox/dcim/models/cables.py @@ -677,6 +677,6 @@ class CablePath(models.Model): """ Return all available next segments in a split cable path. """ - rearport = path_node_to_object(self._nodes[-1]) + rearports = self.path_objects[-1] - return FrontPort.objects.filter(rear_port=rearport) + return FrontPort.objects.filter(rear_port__in=rearports) From 7dc2e02e226445cffc84deae682c8c9cdeed8dc3 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 9 Aug 2022 11:39:04 -0400 Subject: [PATCH 359/593] Fixes #9938: Exclude virtual interfaces from terminations list when connecting a cable --- docs/release-notes/version-3.3.md | 1 + netbox/dcim/forms/connections.py | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index 74ed7f10c..c7d1a30ff 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -99,6 +99,7 @@ Custom field UI visibility has no impact on API operation. ### Bug Fixes (from Beta2) +* [#9938](https://github.com/netbox-community/netbox/issues/9938) - Exclude virtual interfaces from terminations list when connecting a cable * [#9939](https://github.com/netbox-community/netbox/issues/9939) - Fix list of next nodes for split paths under trace view ### Plugins API diff --git a/netbox/dcim/forms/connections.py b/netbox/dcim/forms/connections.py index 7552c0c87..cc5cf362f 100644 --- a/netbox/dcim/forms/connections.py +++ b/netbox/dcim/forms/connections.py @@ -84,6 +84,7 @@ def get_cable_form(a_type, b_type): disabled_indicator='_occupied', query_params={ 'device_id': f'$termination_{cable_end}_device', + 'kind': 'physical', # Exclude virtual interfaces } ) From c1d9cace117fb593fd8e332c370e05096017dac5 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 9 Aug 2022 14:21:27 -0400 Subject: [PATCH 360/593] Fixes #9900: Pre-populate site & rack fields for cable connection form --- docs/release-notes/version-3.3.md | 1 + netbox/dcim/tables/template_code.py | 50 ++++++++++---------- netbox/templates/dcim/consoleport.html | 6 +-- netbox/templates/dcim/consoleserverport.html | 6 +-- netbox/templates/dcim/frontport.html | 12 ++--- netbox/templates/dcim/interface.html | 8 ++-- netbox/templates/dcim/powerfeed.html | 2 +- netbox/templates/dcim/poweroutlet.html | 2 +- netbox/templates/dcim/powerport.html | 4 +- netbox/templates/dcim/rearport.html | 8 ++-- 10 files changed, 50 insertions(+), 49 deletions(-) diff --git a/docs/release-notes/version-3.3.md b/docs/release-notes/version-3.3.md index c7d1a30ff..9ec4eb9b5 100644 --- a/docs/release-notes/version-3.3.md +++ b/docs/release-notes/version-3.3.md @@ -99,6 +99,7 @@ Custom field UI visibility has no impact on API operation. ### Bug Fixes (from Beta2) +* [#9900](https://github.com/netbox-community/netbox/issues/9900) - Pre-populate site & rack fields for cable connection form * [#9938](https://github.com/netbox-community/netbox/issues/9938) - Exclude virtual interfaces from terminations list when connecting a cable * [#9939](https://github.com/netbox-community/netbox/issues/9939) - Fix list of next nodes for split paths under trace view diff --git a/netbox/dcim/tables/template_code.py b/netbox/dcim/tables/template_code.py index 082df56df..04ef74192 100644 --- a/netbox/dcim/tables/template_code.py +++ b/netbox/dcim/tables/template_code.py @@ -121,9 +121,9 @@ CONSOLEPORT_BUTTONS = """ {% else %} @@ -153,9 +153,9 @@ CONSOLESERVERPORT_BUTTONS = """ {% else %} @@ -185,8 +185,8 @@ POWERPORT_BUTTONS = """ {% else %} @@ -212,7 +212,7 @@ POWEROUTLET_BUTTONS = """ {% if not record.mark_connected %} - + {% else %} @@ -262,10 +262,10 @@ INTERFACE_BUTTONS = """ {% else %} @@ -301,12 +301,12 @@ FRONTPORT_BUTTONS = """ {% else %} @@ -338,12 +338,12 @@ REARPORT_BUTTONS = """ {% else %} diff --git a/netbox/templates/dcim/consoleport.html b/netbox/templates/dcim/consoleport.html index f132a4ed8..39ffbf552 100644 --- a/netbox/templates/dcim/consoleport.html +++ b/netbox/templates/dcim/consoleport.html @@ -111,13 +111,13 @@ diff --git a/netbox/templates/dcim/consoleserverport.html b/netbox/templates/dcim/consoleserverport.html index f4da080e8..642e758a3 100644 --- a/netbox/templates/dcim/consoleserverport.html +++ b/netbox/templates/dcim/consoleserverport.html @@ -113,13 +113,13 @@ diff --git a/netbox/templates/dcim/frontport.html b/netbox/templates/dcim/frontport.html index e5f1df5ae..2ef955fe9 100644 --- a/netbox/templates/dcim/frontport.html +++ b/netbox/templates/dcim/frontport.html @@ -109,22 +109,22 @@ diff --git a/netbox/templates/dcim/interface.html b/netbox/templates/dcim/interface.html index 11e776872..7503e1be2 100644 --- a/netbox/templates/dcim/interface.html +++ b/netbox/templates/dcim/interface.html @@ -263,16 +263,16 @@ diff --git a/netbox/templates/dcim/powerfeed.html b/netbox/templates/dcim/powerfeed.html index 3972b30f3..584454df8 100644 --- a/netbox/templates/dcim/powerfeed.html +++ b/netbox/templates/dcim/powerfeed.html @@ -158,7 +158,7 @@ {% if not object.mark_connected and not object.cable %}
    {% if perms.dcim.add_cable %} - + Connect {% endif %} diff --git a/netbox/templates/dcim/poweroutlet.html b/netbox/templates/dcim/poweroutlet.html index 930d60996..26f4a07f8 100644 --- a/netbox/templates/dcim/poweroutlet.html +++ b/netbox/templates/dcim/poweroutlet.html @@ -111,7 +111,7 @@
    Not Connected {% if perms.dcim.add_cable %} - + Connect {% endif %} diff --git a/netbox/templates/dcim/powerport.html b/netbox/templates/dcim/powerport.html index 6da35617d..c5eccbf14 100644 --- a/netbox/templates/dcim/powerport.html +++ b/netbox/templates/dcim/powerport.html @@ -117,10 +117,10 @@ diff --git a/netbox/templates/dcim/rearport.html b/netbox/templates/dcim/rearport.html index ae7b55316..dc53746db 100644 --- a/netbox/templates/dcim/rearport.html +++ b/netbox/templates/dcim/rearport.html @@ -105,16 +105,16 @@ From 1a0b6d6cb03c144caf770f9ccd02ce0970b8c37e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 9 Aug 2022 16:49:28 -0400 Subject: [PATCH 361/593] Continued work on feature docs --- docs/features/facilities.md | 8 ++--- docs/features/ipam.md | 55 ++++++++++++++++++++++++++++++++- docs/features/power-tracking.md | 19 +++++++++++- 3 files changed, 76 insertions(+), 6 deletions(-) diff --git a/docs/features/facilities.md b/docs/features/facilities.md index 0fb65aae7..f105bd4c5 100644 --- a/docs/features/facilities.md +++ b/docs/features/facilities.md @@ -40,19 +40,19 @@ Like regions, site groups can be arranged in a recursive hierarchy for grouping The use of both regions and site groups affords to independent but complementary dimensions across which sites can be organized. -## Site +## Sites A site typically represents a building within a region and/or site group. Each site is assigned an operational status (e.g. active or planned), and can have a discrete mailing address and GPS coordinates assigned to it. -## Location +## Locations A location can be any logical subdivision within a building, such as a floor or room. Like regions and site groups, locations can be nested into a self-recursive hierarchy for maximum flexibility. And like sites, each location has an operational status assigned to it. -## Rack +## Racks Finally, NetBox models each equipment rack as a discrete object within a site and location. These are physical objects into which devices are installed. Each rack can be assigned an operational status, type, facility ID, and other attributes related to inventory tracking. Each rack also must define a height (in rack units) and width, and may optionally specify its physical dimensions. -Each rack must be associated to a site, but the assignment to a location within that site is optional. Users can also create custom roles to which racks can be assigned. +Each rack must be associated to a site, but the assignment to a location within that site is optional. Users can also create custom roles to which racks can be assigned. NetBox supports tracking rack space in half-unit increments, so it's possible to mount devices at e.g. position 2.5 within a rack. !!! tip "Devices" You'll notice in the diagram above that a device can be installed within a site, location, or rack. This approach affords plenty of flexibility as not all sites need to define child locations, and not all devices reside in racks. diff --git a/docs/features/ipam.md b/docs/features/ipam.md index f263f3ab3..7832fab44 100644 --- a/docs/features/ipam.md +++ b/docs/features/ipam.md @@ -1,3 +1,56 @@ # IP Address Management -TODO +IP address management (IPAM) is one of NetBox's core features. It supports full parity for IP4 and IPv6, advanced VRF assignment, automatic hierarchy formation, and much more. + +## IP Hierarchy + +NetBox employs several object types to represent a hierarchy of IP resources: + +* **Aggregate** - A prefix which represents the root of an addressing hierarchy. This is typically a large swath of public or private address space allocated for use by your organization. Each aggregate is assigned to an authoritative RIR. +* **Prefix** - A subnet defined within an aggregate. Prefixes extend the hierarchy by nesting within one another. (For example, 192.168.123.0/24 will appear within 192.168.0.0/16.) Each prefix can be assigned a functional role as well as an operational status. +* **IP Range** - An arbitrary range of individual IP addresses within a prefix, all sharing the same mask. Ranges are commonly affiliated with DHCP scopes, but can be used for any similar purpose. +* **IP Address** - An individual IP address along with its subnet mask, automatically arranged beneath its parent prefix. + +```mermaid +flowchart TD + RIR --> Aggregate + Aggregate & Role --> Prefix + Prefix --> Prefix + Prefix --> IPRange & IPAddress +``` + +!!! tip "Automatic Hierarchies" + IP objects in NetBox never need to be manually assigned to the parent objects. The construction of hierarchies is handled automatically by the application according to the inherent rules of IP addressing. + +An example hierarchy might look like this: + +* 100.64.0.0/10 (aggregate) + * 100.64.0.0/20 (prefix) + * 100.64.16.0/20 (prefix) + * 100.64.16.0/24 (prefix) + * 100.64.16.1/24 (address) + * 100.64.16.2/24 (address) + * 100.64.16.3/24 (address) + * 100.64.16.9/24 (prefix) + * 100.64.32.0/20 (prefix) + * 100.64.32.1/24 (address) + * 100.64.32.10-99/24 (range) + +## Utilization Stats + +The utilization rate for each prefix is calculated automatically depending on its status. _Container_ prefixes are those which house child prefixes; their utilization rate is determined based on how much of their available IP space is consumed by child prefixes. The utilization rate for any other type of prefix is determined by the aggregate usage of any child IP addresses and/or ranges defined. + +Similarly, utilization rates for aggregates is determined based on the space consumed by their child prefixes. + +## VRF Tracking + +NetBox supports the modeling of discrete virtual routing and forwarding (VRF) instances to represent multiple routing tables, including those with overlapping address space. Each type of IP object within an aggregate - prefix, IP range, and IP address - can be assigned to a particular VRF. Consequently, each VRF maintains its own isolated IP hierarchy. This makes it very easy to track overlapping IP space. + +VRF modeling in NetBox very closely follows what you find in real-world network configurations, with each VRF assigned a standards-compliant route distinguisher. You can even create route targets to manage the import and export of routing information among VRFs. + +!!! tip "Enforcing Unique IP Space" + Each VRF can be independently configured to permit or prohibit duplicate IP objects. For example, a VRF which has been configured to enforce unique IP space will not allow the creation of two 192.0.2.0/24 prefixes. The ability to toggle this restriction per VRF affords the user maximum flexibility in modeling their IP space. + +## AS Numbers + +An often overlooked component of IPAM, NetBox also tracks autonomous system (AS) numbers and their assignment to sites. Both 16- and 32-bit AS numbers are supported, and like aggregates each ASN is assigned to an authoritative RIR. diff --git a/docs/features/power-tracking.md b/docs/features/power-tracking.md index 1267af1e6..e19ec421b 100644 --- a/docs/features/power-tracking.md +++ b/docs/features/power-tracking.md @@ -1,3 +1,20 @@ # Power Tracking -TODO +As part of its DCIM feature set, NetBox supports modeling facility power as discrete power panels and feeds. These are most commonly used to document power distribution within a data center, but can serve more traditional environments as well. + +![Power distribution model](../media/power_distribution.png) + +## Power Panels + +A power panel is the furthest upstream power element modeled in NetBox. It typically represents a power distribution panel (or breaker panel) where facility power is split into multiple discrete circuits, which are modeled as feeds. + +Each power panel is associated with a site, and may optionally be associated with a particular location within that site. There is no limit to how many power feeds a single panel can supply, however both of these object types should map to real-world objects. + +## Power Feeds + +A power feed represents a discrete power circuit originating from an upstream power panel. Each power feed can be assigned a name, operational status, and various electrical characteristics such as supply (AC or DC), voltage, amperage, and so on. + +A device power port can be connected to a power feed via a cable. Only one port can be connected to a feed: Where multiple devices draw power from the same feed, a power distribution unit (PDU) must be modeled as an individual device mapping a power port to multiple power outlets to which the downstream devices can connect (as in the example above). + +!!! tip "Primary and Redundant Power" + Each power feed in NetBox is assigned a type: primary or redundant. This allows easily modeling redundant power distribution topologies. In scenarios involving only a single, non-redundant power supply, mark all power feeds as primary. From c24f1f14eccee2eecc67fc8d4df1db6d3e20b679 Mon Sep 17 00:00:00 2001 From: Barnabas Lovas Date: Wed, 10 Aug 2022 13:22:58 +0200 Subject: [PATCH 362/593] Closes #9625: Add Contact Phone/Email to quick view panes to save time --- netbox/templates/inc/panels/contacts.html | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/netbox/templates/inc/panels/contacts.html b/netbox/templates/inc/panels/contacts.html index 26961f04a..359ad8d7e 100644 --- a/netbox/templates/inc/panels/contacts.html +++ b/netbox/templates/inc/panels/contacts.html @@ -10,6 +10,8 @@
    		Name Role PriorityPhoneEmail
    {{ contact.contact|linkify }} {{ contact.role|placeholder }} {{ contact.get_priority_display|placeholder }} + {% if contact.contact.phone %} + {{ contact.contact.phone }} + {% else %} + {{ ''|placeholder }} + {% endif %} + + {% if contact.contact.email %} + {{ contact.contact.email }} + {% else %} + {{ ''|placeholder }} + {% endif %} + {% if perms.tenancy.change_contactassignment %} From 1c7ef73d1fcff334ff34dba2fff073c934a06c99 Mon Sep 17 00:00:00 2001 From: Dorian Bourgeoisat Date: Tue, 9 Aug 2022 14:20:42 +0200 Subject: [PATCH 363/593] Closes #8595: Added new PON interface types --- netbox/dcim/choices.py | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index 2e96f9c67..c91faf3da 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -814,6 +814,14 @@ class InterfaceTypeChoices(ChoiceSet): # ATM/DSL TYPE_XDSL = 'xdsl' + # PON + TYPE_GPON = 'gpon' + TYPE_XG_PON = 'xg-pon' + TYPE_XGS_PON = 'xgs-pon' + TYPE_TWDM_PON = 'twdm-pon' + TYPE_EPON = 'epon' + TYPE_10G_EPON = '10g-epon' + # Stacking TYPE_STACKWISE = 'cisco-stackwise' TYPE_STACKWISE_PLUS = 'cisco-stackwise-plus' @@ -950,6 +958,17 @@ class InterfaceTypeChoices(ChoiceSet): (TYPE_XDSL, 'xDSL'), ) ), + ( + 'PON', + ( + (TYPE_GPON, 'GPON (2.5 Gbps / 1.25 Gps)'), + (TYPE_XG_PON, 'XG-PON (10 Gbps / 2.5 Gbps)'), + (TYPE_XGS_PON, 'XGS-PON (10 Gbps)'), + (TYPE_TWDM_PON, 'TWDM-PON (NG-PON2) (4x10 Gbps)'), + (TYPE_EPON, 'EPON (1 Gbps)'), + (TYPE_10G_EPON, '10G-EPON (10 Gbps)'), + ) + ), ( 'Stacking', ( From e69be8f9a631e255caf08b838951d2041efbf4b1 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 10 Aug 2022 12:51:21 -0400 Subject: [PATCH 364/593] Continued work on feature docs --- docs/features/circuits.md | 26 +++++++++++++++++++++++++- docs/features/ipam.md | 6 ++++++ docs/features/l2vpn-overlay.md | 4 +++- docs/features/services.md | 3 --- docs/features/vlan-management.md | 19 ++++++++++++++++++- docs/features/wireless.md | 25 ++++++++++++++++++++++++- mkdocs.yml | 1 - 7 files changed, 76 insertions(+), 8 deletions(-) delete mode 100644 docs/features/services.md diff --git a/docs/features/circuits.md b/docs/features/circuits.md index 63c8bc970..f0c5832c4 100644 --- a/docs/features/circuits.md +++ b/docs/features/circuits.md @@ -1,3 +1,27 @@ # Circuits -TODO +NetBox is ideal for managing your network's transit and peering providers and circuits. It provides all the flexibility needed to model physical circuits in both data center and enterprise environments, and allows for "connecting" circuits directly to device interfaces via cables. + +```mermaid +flowchart TD + ASN --> Provider + Provider --> ProviderNetwork & Circuit + CircuitType --> Circuit +``` + +## Providers + +A provider is any organization which provides Internet or private connectivity. Typically, these are large carriers, however they might also include regional providers or even internal services. Each provider can be assigned account and contact details, and may have one or more AS numbers assigned to it. + +Sometimes you'll need to model provider networks into which you don't have full visibility; these are typically represented on topology diagrams with cloud icons. NetBox facilitates this through its provider network model: A provider network represents a "black box" network to which your circuits can connect. A common example is a provider MPLS network connecting multiple sites. + +## Circuits + +A circuit is a physical connection between two points, which is installed and maintained by an external provider. For example, an Internet connection delivered as a fiber optic cable would be modeled as a circuit in NetBox. + +Each circuit is associated with a provider and assigned a circuit ID, which must be unique to that provider. A circuit is also assigned a user-defined type, operational status, and various other operating characteristics. + +Each circuit may have up to two terminations (A and Z) defined. Each termination can be associated with a particular site or provider network. In the case of the former, a cable can be connected between the circuit termination and a device component to map its physical connectivity. + +!!! warning "Physical vs. Virtual Circuits" + The circuit model in NetBox represents **physical** connections. Don't confuse these with _virtual_ circuits which may be offered by providers overlaid on physical infrastructure. (For example, a VLAN-tagged subinterface would be a virtual circuit.) A good rule of thumb: If you can't point to it, it's not a physical circuit. diff --git a/docs/features/ipam.md b/docs/features/ipam.md index 7832fab44..45a6a0221 100644 --- a/docs/features/ipam.md +++ b/docs/features/ipam.md @@ -54,3 +54,9 @@ VRF modeling in NetBox very closely follows what you find in real-world network ## AS Numbers An often overlooked component of IPAM, NetBox also tracks autonomous system (AS) numbers and their assignment to sites. Both 16- and 32-bit AS numbers are supported, and like aggregates each ASN is assigned to an authoritative RIR. + +## Service Mapping + +NetBox models network applications as discrete service objects associated with devices and/or virtual machines, and optionally with specific IP addresses attached to those parent objects. These can be used to catalog the applications running on your network for reference by other objects or integrated tools. + +To model services in NetBox, begin by creating a service template defining the name, protocol, and port number(s) on which the service listens. This template can then be easily instantiated to "attach" new services to a device or virtual machine. It's also possible to create new services by hand, without a template, however this approach can be tedious. diff --git a/docs/features/l2vpn-overlay.md b/docs/features/l2vpn-overlay.md index 002c483f9..51fbf2a78 100644 --- a/docs/features/l2vpn-overlay.md +++ b/docs/features/l2vpn-overlay.md @@ -1,3 +1,5 @@ # L2VPN & Overlay -TODO +L2VPN and overlay networks, such as VXLAN and EVPN, can be defined in NetBox and tied to interfaces and VLANs. This allows for easy tracking of overlay assets and their relationships with underlay resources. + +Each L2VPN instance has a type and optional unique identifier. Like VRFs, L2VPNs can also have import and export route targets assigned to them. Terminations can then be created to assign VLANs and/or device and virtual machine interfaces to the overlay. diff --git a/docs/features/services.md b/docs/features/services.md deleted file mode 100644 index 338fc349a..000000000 --- a/docs/features/services.md +++ /dev/null @@ -1,3 +0,0 @@ -# Services - -TODO diff --git a/docs/features/vlan-management.md b/docs/features/vlan-management.md index 3d4fd4d1f..4af05dea3 100644 --- a/docs/features/vlan-management.md +++ b/docs/features/vlan-management.md @@ -1,3 +1,20 @@ # VLAN Management -TODO +Complementing its IPAM capabilities, NetBox also tracks VLAN information to assist with layer two network configurations. VLANs are defined per IEEE 802.1Q and related standards, and can be assigned to groups and functional roles. + +```mermaid +flowchart TD + VLANGroup & Role --> VLAN +``` + +## VLAN Groups + +A VLAN group is a collection of VLANs defined within a particular scope. Each VLAN group can be associated with a particular site, location, rack, or similar object to indicate its domain, and designates a minimum and maximum VLAN ID within the group. (By default, these are the standard minimum and maximum values of 1 and 4094, respectively.) + +Within a group, each VLAN must have a unique ID and name. There is no limit to how many groups can be created per scope. + +## VLANs + +NetBox models VLANs according to their definition under IEEE 802.1Q, with a 12-bit VLAN ID and a name. Each VLAN also has an operational status, and may be assigned a function role, just like prefixes. Each VLAN can be assigned to a VLAN group or site to convey the domain in which the VLAN exists. + +Once defined, VLANs can be associated with device and virtual machine interfaces. Each interface can be assigned an 802.1Q mode (access or tagged), and the relevant VLANs can be applied as tagged or untagged. diff --git a/docs/features/wireless.md b/docs/features/wireless.md index ff3d5d10b..215d1a682 100644 --- a/docs/features/wireless.md +++ b/docs/features/wireless.md @@ -1,3 +1,26 @@ # Wireless -TODO +Just as NetBox provides robust modeling for physical cable plants, it also supports modeling wireless LANs and point-to-point links. + +## Wireless LANs + +```mermaid +flowchart TD + WirelessLANGroup --> WirelessLANGroup & WirelessLAN +``` + +A wireless LAN is a multi-access network shared by multiple wireless clients, identified by a common service set identifier (SSID) and authentication parameters. Wireless LANs can be organized into self-nesting groups, and each wireless LAN may optionally be bound to a particular VLAN. This allows easily mapping wireless networks to their wired counterparts. + +Authentication attributes for wireless LANs include: + +* **Type** - Open, WEP, WPA, etc. +* **Cipher** - Auto, TKIP, or AES +* **Pre-shared key (PSK)** - The secret key configured on all participating clients + +The definition of authentication parameters is optional. + +## Wireless Links + +Whereas a wireless LAN represents a physical multi-access segment with any number of clients, a wireless link is a point-to-point connection between exactly two stations. These links behave much like cables, but more accurately model the nature of wireless communications. + +Like wireless LANs, wireless links also have an SSID and (optional) authentication attributes. diff --git a/mkdocs.yml b/mkdocs.yml index 78ca5031c..784e4498e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -67,7 +67,6 @@ nav: - Power Tracking: 'features/power-tracking.md' - IPAM: 'features/ipam.md' - VLAN Management: 'features/vlan-management.md' - - Service Mapping: 'features/services.md' - L2VPN & Overlay: 'features/l2vpn-overlay.md' - Circuits: 'features/circuits.md' - Wireless: 'features/wireless.md' From 9733cee3d208d017382c44d966e2ab8f80a1f31f Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 10 Aug 2022 14:07:51 -0400 Subject: [PATCH 365/593] Continued work on feature docs --- docs/development/models.md | 2 +- docs/features/context-data.md | 79 ++++++--------------- docs/features/customization.md | 38 ++++++++++ docs/features/integrations.md | 41 +++++++++++ docs/features/tags.md | 17 ----- docs/{features => integrations}/webhooks.md | 0 docs/models/extras/configcontext.md | 69 ++++++++++++++++++ docs/models/extras/tag.md | 17 +++++ mkdocs.yml | 6 +- 9 files changed, 193 insertions(+), 76 deletions(-) create mode 100644 docs/features/integrations.md rename docs/{features => integrations}/webhooks.md (100%) create mode 100644 docs/models/extras/configcontext.md create mode 100644 docs/models/extras/tag.md diff --git a/docs/development/models.md b/docs/development/models.md index be3608a30..3c7aaaa78 100644 --- a/docs/development/models.md +++ b/docs/development/models.md @@ -9,7 +9,7 @@ The Django [content types](https://docs.djangoproject.com/en/stable/ref/contrib/ ### Features Matrix * [Change logging](../features/change-logging.md) - Changes to these objects are automatically recorded in the change log -* [Webhooks](../features/webhooks.md) - NetBox is capable of generating outgoing webhooks for these objects +* [Webhooks](../integrations/webhooks.md) - NetBox is capable of generating outgoing webhooks for these objects * [Custom fields](../customization/custom-fields.md) - These models support the addition of user-defined fields * [Export templates](../customization/export-templates.md) - Users can create custom export templates for these models * [Tagging](../features/tags.md) - The models can be tagged with user-defined tags diff --git a/docs/features/context-data.md b/docs/features/context-data.md index 08b5f4fd5..d202482da 100644 --- a/docs/features/context-data.md +++ b/docs/features/context-data.md @@ -1,69 +1,34 @@ -# Configuration Contexts +# Context Data -Sometimes it is desirable to associate additional data with a group of devices or virtual machines to aid in automated configuration. For example, you might want to associate a set of syslog servers for all devices within a particular region. Context data enables the association of extra user-defined data with devices and virtual machines grouped by one or more of the following assignments: - -* Region -* Site group -* Site -* Location (devices only) -* Device type (devices only) -* Role -* Platform -* Cluster type (VMs only) -* Cluster group (VMs only) -* Cluster (VMs only) -* Tenant group -* Tenant -* Tag - -## Hierarchical Rendering - -Context data is arranged hierarchically, so that data with a higher weight can be entered to override lower-weight data. Multiple instances of data are automatically merged by NetBox to present a single dictionary for each object. - -For example, suppose we want to specify a set of syslog and NTP servers for all devices within a region. We could create a config context instance with a weight of 1000 assigned to the region, with the following JSON data: - -```json -{ - "ntp-servers": [ - "172.16.10.22", - "172.16.10.33" - ], - "syslog-servers": [ - "172.16.9.100", - "172.16.9.101" - ] -} -``` - -But suppose there's a problem at one particular site within this region preventing traffic from reaching the regional syslog server. Devices there need to use a local syslog server instead of the two defined above. We'll create a second config context assigned only to that site with a weight of 2000 and the following data: +Configuration context data (or "config contexts" for short) is a powerful feature that enables users to define arbitrary data that applies to device and virtual machines based on certain characteristics. For example, suppose you want to define syslog servers for devices assigned to sites within a particular region. In NetBox, you can create a config context instance containing this data and apply it to the desired region. All devices within this region will now include this data when fetched via an API. ```json { "syslog-servers": [ - "192.168.43.107" + "192.168.43.107", + "192.168.48.112" ] } ``` -When the context data for a device at this site is rendered, the second, higher-weight data overwrite the first, resulting in the following: +While this is handy on its own, the real power of context data stems from its ability to be merged and overridden using multiple instances. For example, perhaps you need to define _different_ syslog servers within the region for a particular device role. You can create a second config context with the appropriate data and a higher weight, and apply it to the desired role. This will override the lower-weight data that applies to the entire region. As you can imagine, this flexibility can cater to many complex use cases. -```json -{ - "ntp-servers": [ - "172.16.10.22", - "172.16.10.33" - ], - "syslog-servers": [ - "192.168.43.107" - ] -} -``` +There are no restrictions around what data can be stored in a configuration context, so long as it can be expressed in JSON. Additionally, each device and VM may have local context data defined: This data is stored directly on the assigned object, and applies to it only. This is a convenient way for "attaching" miscellaneous data to a single device or VM as needed. -Data from the higher-weight context overwrites conflicting data from the lower-weight context, while the non-conflicting portion of the lower-weight context (the list of NTP servers) is preserved. +Config contexts can be computed for objects based on the following criteria: -## Local Context Data - -Devices and virtual machines may also have a local config context defined. This local context will _always_ take precedence over any separate config context objects which apply to the device/VM. This is useful in situations where we need to call out a specific deviation in the data for a particular object. - -!!! warning - If you find that you're routinely defining local context data for many individual devices or virtual machines, custom fields may offer a more effective solution. +| Type | Devices | Virtual Machines | +|---------------|------------------|------------------| +| Region | :material-check: | :material-check: | +| Site group | :material-check: | :material-check: | +| Site | :material-check: | :material-check: | +| Location | :material-check: | | +| Device type | :material-check: | | +| Role | :material-check: | :material-check: | +| Platform | :material-check: | :material-check: | +| Cluster type | | :material-check: | +| Cluster group | | :material-check: | +| Cluster | | :material-check: | +| Tenant group | :material-check: | :material-check: | +| Tenant | :material-check: | :material-check: | +| Tag | :material-check: | :material-check: | diff --git a/docs/features/customization.md b/docs/features/customization.md index ae775312e..5b42d5e43 100644 --- a/docs/features/customization.md +++ b/docs/features/customization.md @@ -1,3 +1,41 @@ # Customization +While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built with this in mind, and can be customized in many ways to better suit your particular needs. + +## Custom Fields + +While NetBox provides a rather extensive data model out of the box, the need may arise to store certain additional data associated with NetBox objects. For example, you might need to record the invoice ID alongside an installed device, or record an approving authority when creating a new IP prefix. NetBox administrators can create custom fields on built-in objects to meet these needs. + +NetBox supports many types of custom field, from basic data types like strings and integers, to complex structures like selection lists or raw JSON. It's even possible to add a custom field which references other NetBox objects. Custom field data is stored directly alongside the object to which it is applied in the database, which ensures minimal performance impact. And custom field data can be written and read via the REST API, just like built-in fields. + +To learn more about this feature, check out the [custom field documentation](../customization/custom-fields.md). + +## Custom Links + TODO + +To learn more about this feature, check out the [custom link documentation](../customization/custom-links.md). + +## Custom Validation + +TODO + +To learn more about this feature, check out the [custom validation documentation](../customization/custom-validation.md). + +## Export Templates + +TODO + +To learn more about this feature, check out the [export template documentation](../customization/export-templates.md). + +## Reports + +TODO + +To learn more about this feature, check out the [documentation for reports](../customization/reports.md). + +## Custom Scripts + +TODO + +To learn more about this feature, check out the [documentation for custom scripts](../customization/custom-scripts.md). diff --git a/docs/features/integrations.md b/docs/features/integrations.md new file mode 100644 index 000000000..c2f68c5c8 --- /dev/null +++ b/docs/features/integrations.md @@ -0,0 +1,41 @@ +# Integrations + +NetBox includes a slew of features which enable integration with other tools and resources powering your network. + +## REST API + +NetBox's REST API, powered by the [Django REST Framework](https://www.django-rest-framework.org/), provides a robust yet accessible interface for creating, modifying, and deleting objects. Employing HTTP for transfer and JSON for data encapsulation, the REST API is easily consumed by clients on any platform and extremely well suited for automation tasks. + +```no-highlight +curl -s -X POST \ +-H "Authorization: Token $TOKEN" \ +-H "Content-Type: application/json" \ +http://netbox/api/ipam/prefixes/ \ +--data '{"prefix": "192.0.2.0/24", "site": {"name": "Branch 12"}}' +``` + +The REST API employs token-based authentication, which maps API clients to user accounts and their assigned permissions. The API endpoints are fully documented using OpenAPI, and NetBox even includes a convenient browser-based version of the API for exploration. The open source [pynetbox](https://github.com/netbox-community/pynetbox) and [go-netbox](https://github.com/netbox-community/go-netbox) API client libraries are also available for Python and Go, respectively. + +To learn more about this feature, check out the [REST API documentation](../integrations/rest-api.md). + +## GraphQL API + +NetBox also provides a [GraphQL](https://graphql.org/) API to complement its REST API. GraphQL enables complex queries for arbitrary objects and fields, enabling the client to retrieve only the specific data it needs from NetBox. This is a special-purpose read-only API intended for efficient queries. Like the REST API, the GraphQL API employs token-based authentication. + +To learn more about this feature, check out the [GraphQL API documentation](../integrations/graphql-api.md). + +## Webhooks + +A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver. Webhooks are an excellent mechanism for building event-based automation processes. + +To learn more about this feature, check out the [webhooks documentation](../integrations/webhooks.md). + +## NAPALM + +[NAPALM](https://github.com/napalm-automation/napalm) is a Python library which enables direct interaction with network devices of various platforms. When configured, NetBox supports fetching live operational and status data directly from network devices to be compared to what has been defined in NetBox. This allows for easily validating the device's operational state against its desired state. Additionally, NetBox's REST API can act as a sort of proxy for NAPALM commands, allowing external clients to interact with network devices by sending HTTP requests to the appropriate API endpoint. + +To learn more about this feature, check out the [NAPALM documentation](../integrations/napalm.md). + +## Prometheus Metrics + +NetBox includes a special `/metrics` view which exposes metrics for a [Prometheus](https://prometheus.io/) scraper, powered by the open source [django-prometheus](https://github.com/korfuri/django-prometheus) library. To learn more about this feature, check out the [Prometheus metrics documentation](../integrations/prometheus-metrics.md). diff --git a/docs/features/tags.md b/docs/features/tags.md index fe6a1ef36..e69de29bb 100644 --- a/docs/features/tags.md +++ b/docs/features/tags.md @@ -1,17 +0,0 @@ -# Tags - -Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the relationships built into NetBox. For example, you might create a tag to identify a particular ownership or condition across several types of objects. - -Each tag has a label, color, and a URL-friendly slug. For example, the slug for a tag named "Dunder Mifflin, Inc." would be `dunder-mifflin-inc`. The slug is generated automatically and makes tags easier to work with as URL parameters. Each tag can also be assigned a description indicating its purpose. - -Objects can be filtered by the tags they have applied. For example, the following API request will retrieve all devices tagged as "monitored": - -```no-highlight -GET /api/dcim/devices/?tag=monitored -``` - -The `tag` filter can be specified multiple times to match only objects which have _all_ of the specified tags assigned: - -```no-highlight -GET /api/dcim/devices/?tag=monitored&tag=deprecated -``` diff --git a/docs/features/webhooks.md b/docs/integrations/webhooks.md similarity index 100% rename from docs/features/webhooks.md rename to docs/integrations/webhooks.md diff --git a/docs/models/extras/configcontext.md b/docs/models/extras/configcontext.md new file mode 100644 index 000000000..08b5f4fd5 --- /dev/null +++ b/docs/models/extras/configcontext.md @@ -0,0 +1,69 @@ +# Configuration Contexts + +Sometimes it is desirable to associate additional data with a group of devices or virtual machines to aid in automated configuration. For example, you might want to associate a set of syslog servers for all devices within a particular region. Context data enables the association of extra user-defined data with devices and virtual machines grouped by one or more of the following assignments: + +* Region +* Site group +* Site +* Location (devices only) +* Device type (devices only) +* Role +* Platform +* Cluster type (VMs only) +* Cluster group (VMs only) +* Cluster (VMs only) +* Tenant group +* Tenant +* Tag + +## Hierarchical Rendering + +Context data is arranged hierarchically, so that data with a higher weight can be entered to override lower-weight data. Multiple instances of data are automatically merged by NetBox to present a single dictionary for each object. + +For example, suppose we want to specify a set of syslog and NTP servers for all devices within a region. We could create a config context instance with a weight of 1000 assigned to the region, with the following JSON data: + +```json +{ + "ntp-servers": [ + "172.16.10.22", + "172.16.10.33" + ], + "syslog-servers": [ + "172.16.9.100", + "172.16.9.101" + ] +} +``` + +But suppose there's a problem at one particular site within this region preventing traffic from reaching the regional syslog server. Devices there need to use a local syslog server instead of the two defined above. We'll create a second config context assigned only to that site with a weight of 2000 and the following data: + +```json +{ + "syslog-servers": [ + "192.168.43.107" + ] +} +``` + +When the context data for a device at this site is rendered, the second, higher-weight data overwrite the first, resulting in the following: + +```json +{ + "ntp-servers": [ + "172.16.10.22", + "172.16.10.33" + ], + "syslog-servers": [ + "192.168.43.107" + ] +} +``` + +Data from the higher-weight context overwrites conflicting data from the lower-weight context, while the non-conflicting portion of the lower-weight context (the list of NTP servers) is preserved. + +## Local Context Data + +Devices and virtual machines may also have a local config context defined. This local context will _always_ take precedence over any separate config context objects which apply to the device/VM. This is useful in situations where we need to call out a specific deviation in the data for a particular object. + +!!! warning + If you find that you're routinely defining local context data for many individual devices or virtual machines, custom fields may offer a more effective solution. diff --git a/docs/models/extras/tag.md b/docs/models/extras/tag.md new file mode 100644 index 000000000..fe6a1ef36 --- /dev/null +++ b/docs/models/extras/tag.md @@ -0,0 +1,17 @@ +# Tags + +Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the relationships built into NetBox. For example, you might create a tag to identify a particular ownership or condition across several types of objects. + +Each tag has a label, color, and a URL-friendly slug. For example, the slug for a tag named "Dunder Mifflin, Inc." would be `dunder-mifflin-inc`. The slug is generated automatically and makes tags easier to work with as URL parameters. Each tag can also be assigned a description indicating its purpose. + +Objects can be filtered by the tags they have applied. For example, the following API request will retrieve all devices tagged as "monitored": + +```no-highlight +GET /api/dcim/devices/?tag=monitored +``` + +The `tag` filter can be specified multiple times to match only objects which have _all_ of the specified tags assigned: + +```no-highlight +GET /api/dcim/devices/?tag=monitored&tag=deprecated +``` diff --git a/mkdocs.yml b/mkdocs.yml index 784e4498e..95672cede 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -73,8 +73,8 @@ nav: - Context Data: 'features/context-data.md' - Change Logging: 'features/change-logging.md' - Journaling: 'features/journaling.md' - - Webhooks: 'features/webhooks.md' - Tags: 'features/tags.md' + - Integrations: 'features/integrations.md' - Customization: 'features/customization.md' - Object-Based Permissions: 'features/permissions.md' - Single Sign-On (SSO): 'features/sso.md' @@ -114,6 +114,7 @@ nav: - Integrations: - REST API: 'integrations/rest-api.md' - GraphQL API: 'integrations/graphql-api.md' + - Webhooks: 'integrations/webhooks.md' - NAPALM: 'integrations/napalm.md' - Prometheus Metrics: 'integrations/prometheus-metrics.md' - Plugins: @@ -188,6 +189,9 @@ nav: - Site: 'models/dcim/site.md' - SiteGroup: 'models/dcim/sitegroup.md' - VirtualChassis: 'models/dcim/virtualchassis.md' + - Extras: + - ConfigContext: 'models/extras/configcontext.md' + - Tag: 'models/extras/tag.md' - IPAM: - ASN: 'models/ipam/asn.md' - Aggregate: 'models/ipam/aggregate.md' From 8f1e70f01d761f65382bb01d568e5f60ae47aa68 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 10 Aug 2022 15:24:45 -0400 Subject: [PATCH 366/593] Fixes #9961: Correct typo --- docs/models/dcim/frontport.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/models/dcim/frontport.md b/docs/models/dcim/frontport.md index 0b753c012..6f12e8cbf 100644 --- a/docs/models/dcim/frontport.md +++ b/docs/models/dcim/frontport.md @@ -1,3 +1,3 @@ ## Front Ports -Front ports are pass-through ports used to represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in NetBox as front ports. Each port is assigned a physical type, and must be mapped to a specific rear port on the same device. A single rear port may be mapped to multiple rear ports, using numeric positions to annotate the specific alignment of each. +Front ports are pass-through ports used to represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in NetBox as front ports. Each port is assigned a physical type, and must be mapped to a specific rear port on the same device. A single rear port may be mapped to multiple front ports, using numeric positions to annotate the specific alignment of each. From a9aaa8939c2bc15ff59f82d547ae4daa45234561 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 10 Aug 2022 16:08:52 -0400 Subject: [PATCH 367/593] Closes #9161: Pretty print JSON custom field data when editing --- docs/release-notes/version-3.2.md | 2 ++ netbox/extras/models/customfields.py | 4 ++-- netbox/project-static/dist/netbox-dark.css | Bin 374410 -> 374221 bytes netbox/project-static/dist/netbox-light.css | Bin 232175 -> 232088 bytes netbox/project-static/dist/netbox-print.css | Bin 727867 -> 727384 bytes netbox/project-static/styles/netbox.scss | 5 +---- netbox/utilities/forms/fields/fields.py | 1 + netbox/utilities/forms/forms.py | 2 +- 8 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 56a35cc02..a5bd05cde 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,6 +2,8 @@ ## v3.2.9 (FUTURE) +* [#9161](https://github.com/netbox-community/netbox/issues/9161) - Pretty print JSON custom field data when editing + --- ## v3.2.8 (2022-08-08) diff --git a/netbox/extras/models/customfields.py b/netbox/extras/models/customfields.py index b7d77e550..55b7a9f03 100644 --- a/netbox/extras/models/customfields.py +++ b/netbox/extras/models/customfields.py @@ -18,7 +18,7 @@ from netbox.models.features import ExportTemplatesMixin, WebhooksMixin from utilities import filters from utilities.forms import ( CSVChoiceField, CSVMultipleChoiceField, DatePicker, DynamicModelChoiceField, DynamicModelMultipleChoiceField, - LaxURLField, StaticSelectMultiple, StaticSelect, add_blank_choice, + JSONField, LaxURLField, StaticSelectMultiple, StaticSelect, add_blank_choice, ) from utilities.querysets import RestrictedQuerySet from utilities.validators import validate_regex @@ -343,7 +343,7 @@ class CustomField(ExportTemplatesMixin, WebhooksMixin, ChangeLoggedModel): # JSON elif self.type == CustomFieldTypeChoices.TYPE_JSON: - field = forms.JSONField(required=required, initial=initial) + field = JSONField(required=required, initial=initial) # Object elif self.type == CustomFieldTypeChoices.TYPE_OBJECT: diff --git a/netbox/project-static/dist/netbox-dark.css b/netbox/project-static/dist/netbox-dark.css index b929f176a6c67c2067c4f29044f724d50ccbd60b..c6e69db89fe9d6f02b4d9600fc1d70b2ca3c7bab 100644 GIT binary patch delta 44 zcmeBrD|Ys^SVIeA3sVbo3(FQ(>*>>Lrn8z%zQ2i=GdeFZH`O+|xNN)A3|0?00G8Pi A9{>OV delta 108 zcmX^6TCD4>SVIeA3sVbo3(FQ(>*-?3nJMu(`N@en@yYplC8-r9@hOQViIWdXs!Yy* z#xdPyI;$}+NKHX$Qch-ae0J*e##Ba?$$8I2r`Jqp<$@{{;fl^n%uTfg>D}Hsoz+7Q E0PR&NdH?_b diff --git a/netbox/project-static/dist/netbox-light.css b/netbox/project-static/dist/netbox-light.css index 341369adff9033ea697bf89ab50ae0c592c00e73..c3f8b80a69ea3e2cd756bc65c9a32709a7af0d4f 100644 GIT binary patch delta 40 wcmaDqm2bvWzJ?aY7N#xCyGuFsaubWPQ}WC6CKq;!O&2I*=Gtyu#=J!Y07M%O+5i9m delta 109 zcmbO+mGAvjzJ?aY7N#xCyG!krGgIPo@{<#D;*<09N>VFI;!_e!5_LeV#G=$hz1+m2 y?3DcSJh%u*LqTa$PG)j^c53D1!cMX2w@R70Kn$+vyu{p8TaW?UAD1$36#)QFI4eQ` diff --git a/netbox/project-static/dist/netbox-print.css b/netbox/project-static/dist/netbox-print.css index 61bcedf9c0ec303c353a88390cdb00e18b3f5aaf..3b10f5c27c1c4d3fea800feadc6b56b2fb229115 100644 GIT binary patch delta 101 zcmV-r0Gj{1wk+7PEP#XogaU*Egam{Iga(8Mgb0KQvuC6iz(2b1tR2bb{M3N(|@EeMw&-3kbox!ejgm#F7M2#)7Pc1l7LFFqEnLmF#FaBs;&bwo6LaE|^YcnlD@x*1 z5=#%n@fJW`fV=V=^FwWdAOqCj@~}+HrFm&09QI|KL7v# diff --git a/netbox/project-static/styles/netbox.scss b/netbox/project-static/styles/netbox.scss index a54b6c324..8ef280397 100644 --- a/netbox/project-static/styles/netbox.scss +++ b/netbox/project-static/styles/netbox.scss @@ -714,11 +714,8 @@ textarea.form-control[rows='10'] { height: 18rem; } -textarea#id_local_context_data, textarea.markdown, -textarea#id_public_key, -textarea.form-control[name='csv'], -textarea.form-control[name='data'] { +textarea.form-control[name='csv'] { font-family: $font-family-monospace; } diff --git a/netbox/utilities/forms/fields/fields.py b/netbox/utilities/forms/fields/fields.py index 9168189a1..df69339e5 100644 --- a/netbox/utilities/forms/fields/fields.py +++ b/netbox/utilities/forms/fields/fields.py @@ -99,6 +99,7 @@ class JSONField(_JSONField): if not self.help_text: self.help_text = 'Enter context data in JSON format.' self.widget.attrs['placeholder'] = '' + self.widget.attrs['class'] = 'font-monospace' def prepare_value(self, value): if isinstance(value, InvalidJSONInput): diff --git a/netbox/utilities/forms/forms.py b/netbox/utilities/forms/forms.py index 3b5cd8308..8ad6f103b 100644 --- a/netbox/utilities/forms/forms.py +++ b/netbox/utilities/forms/forms.py @@ -136,7 +136,7 @@ class ImportForm(BootstrapMixin, forms.Form): Generic form for creating an object from JSON/YAML data """ data = forms.CharField( - widget=forms.Textarea, + widget=forms.Textarea(attrs={'class': 'font-monospace'}), help_text="Enter object data in JSON or YAML format. Note: Only a single object/document is supported." ) format = forms.ChoiceField( From aabe8f7c5b4b61ca87623b496d127266aa443a52 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Wed, 10 Aug 2022 16:18:30 -0400 Subject: [PATCH 368/593] Changelog for #9625 --- docs/release-notes/version-3.2.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index a5bd05cde..598ee7874 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -2,7 +2,10 @@ ## v3.2.9 (FUTURE) +### Enhancements + * [#9161](https://github.com/netbox-community/netbox/issues/9161) - Pretty print JSON custom field data when editing +* [#9625](https://github.com/netbox-community/netbox/issues/9625) - Add phone & email details to contacts panel --- From 9a80a491c90bcdc3341a7c75f2f8bae93e32fba9 Mon Sep 17 00:00:00 2001 From: Christoph Schneider Date: Thu, 11 Aug 2022 14:11:41 +0200 Subject: [PATCH 369/593] re-enable markdown in custom columns --- netbox/netbox/tables/columns.py | 25 +++++++++++++++++++++++++ netbox/netbox/tables/tables.py | 3 ++- 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index f78b9f37c..cc20bdd0c 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -550,3 +550,28 @@ class MarkdownColumn(tables.TemplateColumn): def value(self, value): return value + + +class CustomFieldMarkdownColumn(tables.TemplateColumn): + """ + Render a Markdown string in a longtext custom column. + """ + template_code = """ + {% if value %} + {{ value|markdown }} + {% else %} + — + {% endif %} + """ + + def __init__(self, customfield, *args, **kwargs): + self.customfield = customfield + kwargs['accessor'] = Accessor(f'custom_field_data__{customfield.name}') + kwargs['template_code'] = self.template_code + if 'verbose_name' not in kwargs: + kwargs['verbose_name'] = customfield.label or customfield.name + + super().__init__(*args, **kwargs) + + def value(self, value): + return value diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index 8c5fb039c..d55038c4d 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -7,6 +7,7 @@ from django.db.models.fields.related import RelatedField from django_tables2.data import TableQuerysetData from extras.models import CustomField, CustomLink +from extras.choices import CustomFieldTypeChoices from netbox.tables import columns from utilities.paginator import EnhancedPaginator, get_paginate_count @@ -180,7 +181,7 @@ class NetBoxTable(BaseTable): content_type = ContentType.objects.get_for_model(self._meta.model) custom_fields = CustomField.objects.filter(content_types=content_type) extra_columns.extend([ - (f'cf_{cf.name}', columns.CustomFieldColumn(cf)) for cf in custom_fields + (f'cf_{cf.name}', columns.CustomFieldMarkdownColumn(cf) if cf.type == CustomFieldTypeChoices.TYPE_LONGTEXT else columns.CustomFieldColumn(cf)) for cf in custom_fields ]) custom_links = CustomLink.objects.filter(content_type=content_type, enabled=True) extra_columns.extend([ From f74b7aa7acb6ee9f84e9d4ff237c33bac92cc0d8 Mon Sep 17 00:00:00 2001 From: Jonathan Senecal Date: Tue, 9 Aug 2022 17:32:20 -0400 Subject: [PATCH 370/593] Add a "clear" button for quick search Fixes #9857 --- netbox/project-static/dist/netbox-dark.css | Bin 374221 -> 375157 bytes netbox/project-static/dist/netbox-light.css | Bin 232088 -> 232694 bytes netbox/project-static/dist/netbox-print.css | Bin 727384 -> 729266 bytes netbox/project-static/dist/netbox.js | Bin 375907 -> 376463 bytes netbox/project-static/dist/netbox.js.map | Bin 345348 -> 345789 bytes netbox/project-static/src/search.ts | 44 ++++++ netbox/project-static/styles/netbox.scss | 21 +++ netbox/project-static/styles/overrides.scss | 8 + netbox/project-static/styles/theme-dark.scss | 4 + netbox/project-static/styles/theme-light.scss | 3 +- netbox/project-static/styles/utilities.scss | 6 + netbox/templates/dcim/device/interfaces.html | 145 +++++++++--------- netbox/templates/inc/table_controls_htmx.html | 34 ++-- 13 files changed, 169 insertions(+), 96 deletions(-) diff --git a/netbox/project-static/dist/netbox-dark.css b/netbox/project-static/dist/netbox-dark.css index c6e69db89fe9d6f02b4d9600fc1d70b2ca3c7bab..94718ac407f4e5b8c9acba2d7c97c9936fc79765 100644 GIT binary patch delta 597 zcmb7=y-EW?0E9{IqJn~j_=8%U8Vk?tkwmoEpwFPCh~Q>#^_E~Y+5P~z3FHi+O4B!&X1yYpj>QO9d z|Dk~q!^8*8-G#OFKg0!*p|4~=zx9v&HyDfb&6PQ&#e$jDZDu4|&mFTJcN~wp1o%iQ zfIaHF798lPL?z8rpQ;M%#azPl4oZMl@1=Tu#5oNqE@W5s4GZfKQGU1RL3)yhMuu7YZ?zI|r1xqzp6Z^pML#|?q zxUB?YlJ?GKZ~$nfWr_y~_gF0_E3Nkdr1wUR)!m;=7W8*t%0)<@zwOs_p=$Ft(1P8a9>IA<6lW+wFx4Z2G Vh>n+>egzDdLUsZYw*!6!ayxcD8N>hp diff --git a/netbox/project-static/dist/netbox-light.css b/netbox/project-static/dist/netbox-light.css index c3f8b80a69ea3e2cd756bc65c9a32709a7af0d4f..bf0ba2f62028e5344fcee1c4c872304e047234d6 100644 GIT binary patch delta 560 zcma)2y-EW?7$kS3iJHP65UUjto9uZP5oAv-ZEXdy*xOsUk6d;yw|mhTBntWjBCEZR zpj_z-*yIuP39M|RG3qH6ru)8OW|*1ltLp1b_4K@SXZeF3h$Pedx|8rN#c9f-148g2 z4;rBH2*4p{GNl@%sExs9R4^XnAk%sb!6u7v%2gI?HLj#kT+UA~RTiO{$W&9Ib26~< z(uNa3$Z<@S#w>z3M5MU8ZBP(E47x+!X(1QBOeh<^?){5>OOeycfHg+V(cijVbJj1- znFr6BEPpV~_OrE6$7}WEs7T@;V-O)fBA)C1KxL+55S$1pxM}U$Gv;xpG-XyjYoe!9 zDijPyCPhZ%s@i8hF7M2#)7Pc1l7LF~PB~8;6^*DtmE4j!|SJ2}WQL@r4Pfg0s zEYU4aO)N^z&`nOvOHR$vO)4!Z$@np0AYp->!$!pVj%dN8YP z!3;5Ul@P0^H~KMZffe8~im(cxWg3$eSlM9~n!`D`EEQbMqK)5Df+{Ajb5Wi?t$|B^ zdciw3*6meIoI0$6dKsB1sk%9d#U;AQ8JRgL3ey|)Sv4kq;N;-PB4MD5uG|WtwYn^` zI5R0TC$pr|3aBh4HE()j8mCPiG%9ov7 zkidZulbSx!i$!$$0bX{l>GQkTM4>W;+MI?6rWQy~B-k8C0#SgZjOyIPqV&u>-JI04 z5-VL}qk;;>%-n+fqLReC66-46%)FG;3M)ec10>P>(vqCayi}{a{Jd0{@brXhED|6m zaBGzmCFT`pmSpDVSs^^CU{I`+Uyzs#^s|DVQLzHZfW+yB(u`ulm~K*-Zupl;3#)|S mVJ7VWEIO<*^2<_-s-ad`nHs2C6LyCok~>7Vzh2ChTM7Wc!7`fw delta 68 zcmV-K0K5OP!7SLaEP#XogaU*Egam{Iga(8Mgb1_=bb^-<;06Y_Cx!_u1((o|2?djh a1yYA~j0v}Oj0)}>mv62L2DeMA3TJgmrREbq?W&cZpT zAU^T#lKoO8GVOo89y!Hg^d;kTiZ7sYv6?BJKIl}ZBD`BPGD&0?A7)xnM#R{La-tn~ zpb_y1u3kQz5K<9gTLzkX)t)50P$@*xp-@BEsWyq9;73sK*sUzN9JL>--(QYUmpE{h zT{S$+w+v0tYIg{Rgj!SIGF0o!#-fQ-QmC|x=)gkp@%M^E;nun0*H>Lqo^c3GL)F!l zjYG8_S16<&)77op#p^WnRYSFYAtT-*T2YJmr8qXHahUHdbeo1jUcG(sYD<$sA@2Xt^>8G zO1$zwtbBBs?=N(#cL>2GbZ2o0Iq0^&e@N6FUe4+rYKyr2VDZe}VZKdn+$KK|cO7g* zJ>nAw7coW$dGaexz!l?aDB07Gg@Srizg?)T`Qs{Q5RheK?rQy4hLXV@?o(sF9A->rmw23EfT*~%4 z>g|OI&AzD%HH+uoRIN+uct>H_Oibvd!(?MZ3mvA3Bn-&m9iIM*HyDSG7;B5at5sDid#w;pG`dLmdcut zj<*!vN!gTT)#vGH^av?itvBjPhkcP09}$0i%Qh4dpSnf8*`wo)h4&IRp(+4l1#GhJ z^HH17M5W6(DP5Hb8>oB0CZ4!TgQBAKR#Sa4|CY-p1few_vI$*u_8yziLzgoRl+${@ zO<4plw5MfjEDwJh>di4gi=?f=8msfCBc4(9KY@6^+P&-xG>I0 zzDu`F7^RHNDXgd;o@C&Nt%2wkvt=a}Zdk+DCITl~I-HA-%nmf*_4D0yDLIY=h#qGdz%G;Kh;1n;oqv0&OP2CdHX!2Uuqv-LV zj;|`bngLpA-&vcY8%;65?XT|G0`RQ6vlt9Y^PMZJ-8#O%@P@-Cbkjj>`9TfvCS{yn zyzvrXK8b+O3ZRmKEurb;SHnl35a;1Erm`3rLyStHITz=2>yUjL!(3eX2 z5>3%WUC=fGE19UQK{*}YS0J||Pi9+8(9=a}&&y#KNH-;PIM1`@m|&;!8n+3}v0CVz zZ;|hO5q~t{@$ro|K`}IHdrI8&(}z*J_~lPkD_Rtx@I-2p(KNIhA6FOdg+@_(uVz7q zO*7_-G^8Q}zQ|4?5~=GFgZJLFAP(|46i8|cFAj^#?<-wu(($bY;+t%O)s+J4>I;Mb z7;X18uC21wHQ6*&lqY7LRc7tf@tuViM?s3I$?FxLxNj}nYg3Pkf4fhuvg`OAg*H9; zHr@F_!mcdeFADe9boa=rQlHnVNMx(Fp_|Tg4XB$|Q`b-Lry^G(Eb~1BQXHNzb!~b5 zZ?*|p%GW;e@%uL~Yg07Y6%m?k>S&}kbl5w9<6^Yc4w!Z5YHfiM{KMdG}l%|fkW!_hMV9DPTd0cY<$x)$W=?V|@5 z`LseSmD-e6Xrs#>(F!T?;s+hmeOehr#P=UGZqe)bP+{Kr1xUH=iD6;@V>NSZ$^~K0I_bZqH8&=kfCdD(ki;< z)Czt&ZM#<30n@G@npn3TfNH^?IRI{+_}MD(Yd`&2|4ye??T_$YkaL(!ZF0yJ9v}Bc zs;j+9K~r7rmRqRkBNbn%1;Ev+LlNE+;o(JDLGr+tO3U(T2IohnI!4DW5g$0fiVsWY zlm>NtxGQj~&@w9?{P{+}$rpdVT+EAcxRytz4-56)BxD6 zc|=t^tmCtV2No^3^3bPItN655t>QJAwThYr#j!{BS6Q`cU>qNd2u7`X2<}EAf<@+5 zI>N69Mnwd(sC~2y0)f^?A3$6j{FpG=zXBD{=um{I-Z8N@v&3zWEd-CU>oF78qT_8! zyJhVl%AgjtfQ}}YXNd383JFTsuvX|2UwUjY8Wul(tdeQhlA|ST8F{mWEiZ~H>(F$} z{CEj7XB3=|!n~@)@RMh^RB7`o7E}?sxFGl=&;wXU)a{D{IB34;<+3{Uoz5SgcIwl(Yco}8c zX^=sYcNv5@tq&PwH;(s+;iuOlk9hObKP^ccgo3A~k%LnR7(=4x*A0L#xBmKTlok*F z#*C8Ur@yhIfVlOUZThGI+#c$sOqiX1g*$yZzPmt^-=Ijk*C6bmm^qZ^k~b~*#Ydi5 zhla$H&r|}^%zJhlK(+1Jl~tWOzPa#z%%Fsw&66{)j2YCV@)%k~X3b^iiNAQZcl!>o zbcI*K1_e?F4T>U+09)wLZm6fzZv`bZs8wc@v!l!Auz@3y6FZ++|C$1_iyyy|@89s=61KBb(Uw;yNx8=cCFz z>MaJr4fNNV^MrLIqN!*q7xVGP{K8p5sOSvL2EiACYtSHcQzY*I%H17CgW6)?$0ELL zs?KUqoY!5nF)$M>77tUTa2zxYB*5e8FaQ`&Ff|0EK`fbw^RB`~+Qt1ZtptDS_)FfB zK%Dm!9(3hJd{|uj+b@f{4B#=)Xm!=gMlKrX-O6mvh=b};&#pz>`*LYnW1eC!3`A?2 z42lh^5+8fH7qSB-uZ*CUV^_SgkwJ~(Q@{JFw8@|bPz*-^6bHhQotk=IDCw(+izj}s z=aO;Wu8e|4#hO>kQLkuyb*ZNZWNolE2|i-Cd{^*A)y_dpy?wCY81x#{`b5H&<5luS z#TT?r3H`=;fMwtW@?(_yb;)1Q|_ zM_Ps*zRjRGC(Q;W3hT>jL#ycfgC0^5cl^PGP@nk4A5|4?29OvJIACzCk4Cn+BK4XH zSn@_7L|yyZO&dLN-cneG9eJ_x>4hC2&Z(&42s>PZAkq3k@Du9wg9ARj$iBY0Asy$9 zg*Q`rAwk6_5KIBvRo+ceSIlJmv_Iu6{W;aUhl7p>Zzr) zxrcq8l&r4_y@qCflKIRJ_|yT>`^FCB7axD4Y*{its!K1}C?;Dc7bGeE{SE3vmA|>9 zbSTaT3zYixN`M_4q^JCul9=HytNXA#qzh8LFLxBn^z3R`FNqv5xwF= zx$}MI#GBtPT`{7sjkyv@pBch-lU`VR&cK?QoekQ7zUKx9p|eGWMqH~G;GM`$#CSS+B8U`w3Uk$ zTLH!^t5-Xe&Z%dbIriK;OVAusobM@gWff2V=`0B2)bFmTaK`zz!UMBjNepxk%6>Hn zV^B=Kn`AolV)&}XSH0JUf}-WU6^0JE|GMr$wOJWy0zz692(icczCx$%um%u>*7r>= zb!EFAglUPm`RiHY@87H4or&|lkqPYV(kqxTtXGU>T(7un*0f?xTJ*Ac2jV&vGWkZm z&^!pNX@Zs%8LRX{D=qJk5#16Hnn0k#zLX1eVpI(=k89~Sq2RHDts`BZ@?&3WbQgT<#<-wHE^IZd%%o#G!qYOwd|Yh^SO1V}TFk9X<^ zTJ<~SLcuraP)w&I&L;}p?@+Xn_gR$gQx*jaA{L0m0v~T(8nHm?5u#+(_U(l+p~hz! z*dadgadC+aj9;O*ghlbY0^(;MZv_`c{Yf86i06N@9Bkf=pZx7CeVk7h8b|YulNKQ| z0yA@26lXaEWvaOzix8#tY4O=lpF$z=@;{#k_%rh_{on`r{$egpS|AkBXvQc^rX#Sn zgAu_cKJ}NK;7(P3_As)DZ+y0|%oyjxg(3a<*?C6<|FH``A3}4iV6h61z2ZN=NPr&{ zJlP0o;QLON^$%GTiHunkBruK0F%loPDE4d6BDg4&j#z|tO0(M{bkS=(tw?T5S_uMk z7GaRi#bi+|w^OV*l>`{O`jiockG+2CQv~?)tJ8kiG0^<=@?y6|?WR!{jhEzPuOR}t zqv!ux39;Dce|-!bwtN0o0nyouf7{3gA;^W$go^kl`3zn5=y zSOnXMY$0v(UBN=~2H^cjtsg>oUSGI1(}140Sb(*j5KXz4iog1M4>BAp`v-?03@ZQM zJ1a64$gF@6)5HVskPC{{1lS9B>n!3Y|GNUBv1wne28T!Yl@{5LxxZ>)*babsN_ClW zMB%IvmWFc9n&+rleDzc05}16ulzfAhPCEnpdmJbRlyZ|?jzXJFN=21L zC|HS6P$uvsqW+4(P}J=Tfsu^5#hd<93!cl%|EVkLu?VA<@$p`9{&&l@-LNz=QMIvx z1K1C2u+&bNc)rb|B%o++s98Mcy9$7(-QSfmeHJpi2>HZ+f7giGj&Darh-tQv$In0` z(h~^%7NJ(M52GWfk8EJk1x%-fbk0Jx%nl1Ve-^4N>9kNYUR~X9QL_9{5QJe;&Y`o= z4${M+8`j4yyb5ADYRn*O(Fip8lCtriux1g!o~Fs_hAJ3;HY!FfWa~7vd_}7zA4+zQ z$R6h~7^i~z`N+IEXffG04NVWGjQ`K#M2z2GoCGcZKZ_Hf^-~rnDwn4$PSQBJI4**w zqedoV6kqwzmNPs?!DSpDhm!89rFK4T{O`r^8-=uSaxuKd$;B9&xDQ15K8UU+^5&Yc zeAdom6!&~rf?{M=5%M!WBS{sZ?Z_(~FM`EFL(*esp#2OAla5(vEgB?yW+7Ec*r+Uv z-#BGiQsm)Tuq=b*)GTzvx`=V=vIKy-|7TgElhqAL^4M%tvNbWKYILM-4MYSzlL{6y zPGoA_@?yooR=X!`^$1<8O^e-A)~P8!T~MPOan3>I$V7I-iXtbuW)7-Ac7@X!h0|># zf*m*wCEzsKF&E81S>l_Ew8%jY&PD!3HlrY0v?+REAoJ#-2X%%i?B9_Vnn!AfTuECd z0ufWpmq_J!y^&TH^uzk(z>h*MW2zKEg_edNSqv|&b@kviZFk;njX&BF_cstm2?v-CY`#U@^Yp&_pVt?EXi0dIwN za^h{|{4z9(n#s3is0zTeatZnw8X>POK_3C#k1a*(H!IYPQJe(Y6w({?lL}m?Qca8l z&jmLq0=?#lW*G`pH@EPnf}**sa_W;0S(Q|Z$ExHQ)8yf0Xv0dEm69oQ0rK}DE1eom z+}*2kGJaT6lY*SHD$>{k&G${MOsu1-t6Es=Xwz0>SPyxncz>Lm6_% z3Ychyyto2AIxDNZ!CTxymRwzq{;(<4$Xg2?JFJSwW6L))SOuH4w#zqY%Es!glcPAS zG{=Gr58{7e=dKA(fSA5u;aLGLp7Rl0$!fK>KE^_W_Sdm^bx*FBN<@jo_+o49jx4^uf{K9sV&sU>2Q4e``4eAB`tl-hI zb?HXFyU?;TFHk$IiUIS7qR|BJGt<)@312Ma0(eZ32oJ~|A^UjbSrai&2yGM&uLz1> zK*Agt(rJ~`K#;0PnIWNOCd+HkUqOK8)uKBWJI(brKlq)AfGZRj^$B*fEU#|zN-Zib z&6y$H?umMR-CbrwG#raY=!Uq7d|QjQPIsDRwIo+wi`J5TI&=oftVQ*UOfU$Ddm>Wn z_0d=DR6#6E@nvPlKD6aCcyYY%JDB9xO}(xMR-WhCQ9 z9g@qAAfv{o|y1pUuUwJ|4~(nu3;$x%~k$rbdj)m&e|)>a89 z{4rW#R+=Z8c&pr8m4+-BO|W=Us(LH=-~dX`8dll_n)t4qoDtm`%n7P92f$Yak9FtR zx?L*1BPT?BnF>V>)j>#o4F(`2ZvS4jO08NGB*zb;cTgv}nxH0_&zl5oE$he?P?6>g z3smkP+H0UyJIP#w%<#^W*MRkCCx5;MT?N*1|MjR?yzjs?Las#**X*DR3CodpDOwbw zqfLDLzb6(aiK zQb9U{I^aNo0lhg|HAdzq*k$Bjx1yz>lEp`m1JrK#2(p68KYRpr&g@p2!MHtS(QRNj z+HOZPi0?M^F=`{0+tF@zG^h5FcW*|Ei@=ss*E&j0-HvWWRg!oIV$jn59H99?D6&(w zP;xFb5gCX=9=D%7a3}f=jGMU&X_hu7K%7zumj?`Kt{zHq3?j6_J$d9Vv}4Yna59l9Io5I7pYy$9(5Z07wGHLz_tbvLp96m>!U?LS3rn|kOxYSW1jY>(69 zUuso@N;9B^bbv}l_e3X0pJ+$1vXQ9oMVp|HbMHkwu;hw+0lOQ?>3dOp*#w2%kdOrP zOD$PmUmFtyox?4h0g3B)+Ly@HMacE{p)=vdC+|b&E}<_5Jak29YJ18Ch+e9{AI+&j zR;l$ZkfAwE3Bj5e$Ru|1t&j~Owr^1Nf~LeyNa$MwnlWQwjo^+9G?9zH0S~W<{Nfw% z6Pu*BzCnlB*?lHH8L9PzqDi07df-Avg*p%1$y97>O3-?6H396L^fux1CR`bz%})!| ziAl)Sa0gi)pAe8ssp#Nf$R~uzG{k&8FX9Aw?DxY@lHNt7c?`3ZMSh8&#ymQ6u?s5m zoY+O32osogIDX?ixPW;N?U3GIz(f&BOI?eYE(Ykmt%UhKM*SqWgxP_brB|0Qk0Z9t zq}GtR%bBIpgUgtUry-A2x03lC2Vgc^!`y)3dJoTBglBd`JK0k)MM&iqrdaCKG8eL7 zGXA)MxfAtEdp0tqn4}C0FFm!HIXZ)DrY{gzJ5wUa#Wu%$;CF+#; z7G`V?(0OMM^V}@P=OjrFa}1@VRbJ+wEQ&}K0p|Hx3x=G0%vlJHhMa3+(zj_Q#3FD% zMwz{w*U5*H&jqYXi7`dcJ_cIU(hosX7m{NxEILQh+r;2NsIn#i- zYY#Kq5v)k;M&{-sWS17)$rur8mwNAFS~>FO{m@jpkEucsuV^1*%A|kX&z#51%sP3W z-w!GAI)`-LgG>WP9nxdR84Ch1ohdP!kc}85=5i>#A~7*|sDGGQMIZk1=S&&7;O9)8 za<4)*>D`|*JqR1%^y&SFOG(Eg%#V9?6QU5?M*VUi4Lk(}=_ zwG_c9;pFc3nQqj6@B^kATCDnj`3aiS=$s-hP2`s!G9MA+C(7(SphGJ^W)>l~3R)5C zr%W|*eZo8pPS}!9nXRPg6f>V}e~c-mB)kn>p8aR$ZVY%a{R?I*T#R2ZB3xekg1Hco z7${jz#!fOoze zW)}I&x6H;FZO*)zY?d_tX2uX|mTvnG0}f!HQ_%U&;#=uuJsdy8; zT8tm@(BmlvuK?$T$agca4wOze6Tim*>@S>ybD(oq%)z4!R2R*MlhMmkcAB_=Eon&I zMjBjp#RveTYwD6xY5|^&P>5Wx5In2C#f@pZpmK#E6##pCaO+Oi=1Vz`aBgkYnBTtZT;2;$ToW2qllVCaSV#4-=ujB3HyK;OJJ7@>mZmqzp zHks&L(y3H5qT-$OK3O|av;$QzF()M^1CORmEK5)&UOnG2Nw?j;t7{J&N^q3AJD_q zAKk?Vf#hT;;Pq9FRV84YMz2!N7dzl_(3kT@Gm(5vJJf_Jfe=CX68XxmiOP`AH8RoF zFjS_ZY0nTGWK5*0$ZuESX}jYSmEmZiVar4vsMiD;P!)>?=nzxJZknu3$MP+!pblJv zL1hqS5~ENTin^4}s>b48m{>2=c|sOhs9>h~+8$usB*TZIAk%ORcLXG>8=lCFQStp# z8r8rKO}IwJfi`lZ8ZRzu{;#JI@DEjdA9+QMOBc1mHVv*p5wc5z%Ssc_YJi%E8h5fr*(-+}V1V4K!D>+TKWK0> z0;|7b4c>>q3%HNRn=vf>Cu{LGFjUoAe1H_`@GSC-7V81|&(Pu3U@|u7@F50S$cgoM zCF9GG|6Px(!8KjJ0dT32ys!bQ0CF$d0Bu{z(G9qae6ayfCnq-GWn|t)xcfWYf#sOL z5%+>w3v9$mK()6wQcMYw&(6Z6eRsrReod zJoiF{CnO6EG^iR&lD8Uh)9fKwjUk_+YcaCcfHyNO33B=hyiq!Az%wvF&|OVn6Xr_3_1Tk;8}4CUJ7PZ*MdJpfTJa?_zNa2KU*S|x8W5G@{?^=05TWh+F=QXq_%c^ zD}ruL*{}qcJ38>aaDfgMkw7Q#-b*g(#7{w0YZpvic_P48Q3&EddiuF7p>9bisVh5J zGB0FrsXoCjJB@6`uuqC^6}nig)DiWi7Mi3$lKz zcmo-B;Oz_aP+J>ujksNj8n^)Bkw>APHD-kP!EU^SwZaWqLGR4;ZfiHLV1xATT)11+ z0e9fNHmE`XpEXL?b*cni(0qw+r;YFE#^vBqJ=2Y2>~KaHBl`~HN^*7&KEQM->rK?X z_%5a^LyqnRaNm6dEaY&8>>UM>pVxC^^mrp}mwL$3|NOr4n|+;}~>v$wl(kShBEAI?zn(dD?5+~ULc z0Fmu}Y-R^DEi@m4JVbz{50kPgtnz|8xzlvC)VQSxcu$k5w(KDqX7JV#3H!+r!nzvnfm22K@|Y5Q>t{R7u2M#Co#4pOhcKtC)0_Jn$nB+JqE6fEOS(l;yqBg$MBru$<&df~{zX zyhHGg;#d|oH(iiQtr<8wQ?qk5-Hi?t>ou@WgXD^9V2MXa@wK>l(NLCdi^-c9jnODL zKM{49#ID69&<-w($o1FaG2|wt*I^BcN&4&XajH*W9l|{*N7`?|B_%n^@*J?7+I8q7 z6#(%!k?kpdR z#$a#G5RLc)gUW$U-XV?O4AdYS5pThoSq4~mc|pKsl%Bl>2M{FD08OqNg&*q?kYPu5 z63JlTy+`l^GXOgp?#CZPFH-eU{OU9y&|J1Bgw30zb(hll0uL@at%f z1x5i{z`;wXzz2QcX_%&wPSdGOv+&GH-g+9QX(r6C@n_&MocuLzgpgJD8~owScIZU$ z@w-UHGuXwLvofqQ7SOUIcq!8{mC~T}&NKK^#IC}7~^msC4f@x58{-WwpT8(+e6!L2d9gsZB% zfvPEHxPNL91cD~CRD7GX?;w?7NvoRUR@qXOL| z^hXH%ddV;Ui2GoelGk9J8zoSdbJ6^&tl~ROI8CGE^y^r?yBUT}x!mBjDom2^jY*k3 zeUv?|GF{aFlq0!Ln7iUP8L3;fLn+FBlU(6*OyGlDOy!G!4{|vITavBX7M8c3b;4R*}+o6evlNuD9_5a`J7gVNwnSbZg(i=Rw>n-TNnC6(HW6_i)Ml zfCIiW1yr5jm`mFD9snU5aqvkJd>@mg9-sz%sZaHOYJ&B9w$F<5%o*^s*;BZoXob34m8#lCQl`~6?S|Li$EG5(O zW4=lG!bbj{z!I(qL@FA!8rZvbrG*yq&o5wMn#h`y0Mx@IcoLUs`}5tmO?abt>?$mk)+G-tE-&& z`oo?-o!K}jw9w{u@~>04vBIVoEHG@XXULV%r+7pDkm~55^5veM419@~m0RHGrgAvj zDBr=60GMhM9Np`M!`XUr@Jn1?X3Og@zv88?Vv}3Qtok( z`BVTtlV8jGtP=Se&jzQ+N^buaS3&FB9tOS9Q!M{teM8%2*&t@X>3_h!YZuW zsD*UY=hN7gkXt76ir9NVD<3UlcS4&bXRsfDk^c|9z{B@vvIZt;g~OwZr21Lx67UbC zp4sfUc_SGMf?;JJLL6}F;jyB@dT zgeyq;s>SSP@G#F^%%)(E?0*)sZ%=QfCmQ%>^7As*v^!x|dJdSCUG%6~86jy_&Puz? z%1EtIWuy?arz3gH%1CLm&`(+FH_IdPUbC_bpYaP`Gi9;7{|!7IGEW}wicQ=HFnpUp z_AFs_;7dKYgbhs_F$7hv%d1g85o<3w&$IR*^(XL<{0K{S|*gcRkJiUT-L8tJY)S%Q?&i<>Drpe=M9fPvu ziX?kCI3#m=xy7U-#ZCt|t1rd=o~AYAI(|Pln{CAW<5`Rl{E7-*) za$W;+7&(3{2J}MykV3lngsrqv>E^$l!IA3(Jw{YrO-|g(Eh9JW;n)dT0eNG0!~Qfq zO<LA>GW?e2>_v{BY#pf49hIzLgAHMbtmgl3&Vt%B;!Vc^gSx%kE{G%ycuq znykK#?STOM{Oi~{h|3?njy(+9I|J9VSAjQr@_P1S@J2@tvFD?1^3OwTJ2f*mfCSq} z_y(2-47%)P&&dZA>bV+799&krnW#_ttdaW}DgscT%bFnj_H&D+Cym^XFk~N0Eu2Ub$FG|? z1KmDe-p;9UULvJ)Iyr9v`Y0Sq?{{%)Kwu>R!-e@L%gDAqZhYdE-}iB^o&mdJce=Sv z;7UvHdbm|!_f66ner{|Uq!Btsxl(c{#HpF6NsJ#XCU1r~4N4L&42+19^1w^rQ)df{&0baju+HoX>L7*HO*_$(0nhVD>=3#Jfy<$V9=1 z+&soDA=lJ%OQq}L+&2u9HWA%H0LptW=ZeTfDXw;QNIrC;?6LZ#Qz;I%+5OT_M!07f z$gg(fxHXU$7|(J0h;5YHGD|fn{cwnQlxv1e?lq%a=ZY}w+1JJ3haWOg-2?TWY&uA$ zk8wum$TG&QhBq=}T=`=84f-hweQUC9n%p1n5&#O zXyVf*K4;=hCO%_=G!e{7DllmfmH2!0PeOc z!N5uT0HX}_{@8+`BBOAs>%Y7v6~M1;KldnLiZn~)IEpO`uI6$~M_&4Gxti0G-UD0- z`SfalARA1KJh=-5bM*nh4Fl;rz_rZPPh~^9Nybp=*#lfTJpu9QHCz_8ORj6VRyZ|5 zj^4~wN-tf{9p{+g{215X%*~qBMTt~EAud6qpAz}+lm-+krZlM{S03Z81D9^iLxAI> zq~jrO-#JE@)MPKcbaCltS(8he$?-N5Z!q!U9Ph~S9usdi@l7G#XyQ9e{IH2{fuf18 mGV!A_G){#aD-n)!Vel*OInJ#FWBT%OPKSCW^fS&q?f(G$(Zq!S delta 19478 zcmZuZcYGYh)xX)x!>Fy+*bf=Sar;a18N~i1nPLeT@ zj}qg8S@2MdZF&pE7_%f0N+6-PgfD?mLJ1|I7^jf{f$z=k>14?FhjlY=-_E>w^ZLws z|9^_#|5x#BwYo;wHj#3~Dk2AF*D}H31C>QHeV#Z!GAvwvblO zZ^G4O-7z5%61Ld@)vb2L;e|>elnewKBg5*f_z`{xH6Oo`C3}$nc*B7e2z81>m)lew zV|?rA6s^N{K_64sG_;P^c`}i3ED;wfhedSdV)4;;3q;|@`QlfX|73;DE;Nr;S64QT z*0~&kfOt@dnX?#>6kgiFwg6zAry`TFhQii_+q)SFGC9I>z_r zA7qqSdAnWc3#)5*t6fm3>f(`rFVWCDO-Tj_=~!g9!@_C=L1jzCe4!Clqg8ZVS%;d$ z%dU*9XddGS^26%wfFh!lhHV%a6}5-USiN1X6Sp5Mnq4)G26-GU*cl%+=H{lFAugMv)Dw|R`!kY{rSNScA*mnZ|I+<&mit2JnB9E5Lt$b zd&c;1WQwi6h!AxEB^L41t2Q8uSaEf_a$t;)=MhYHq1y$c#UpvXo5TmNZmek^;~jY{ zzcMG^X&1&QwqqK*Q>?hA5&6Y)uIWTA$B$jpi%`E3J{V5FPgES`VZ zct*2b5veBerNc`WhqQb)k62|FH2k>u)!{+5%D#47>_1XI6w~syJVIY?UA=Z;oO0V3 z5&G#mdqAvce>fsDnIBNt$9KeqUb|YA_QzGgjJVKeud`)?&TxQlw+jQ}D@T^GJ@y7$ zenE4OcB6LjoTJrRpO&}hr%gwMJ~~Y%BDB(JTI_-=0>Axs!9d|{cA;OCj@n==W?%ov znJtthyeE`rN~=p|N?6P5^J8||1uGq6&@PYJpqGib_MtOSmsoy7F*9fv&%B|sHm>E( z`FA{4Wm|PQdYW8<$6DtOyOKdqD8VPh|G8lsN{CO~px)xp@`n6-A*)d3gSlc>S@(IL zRcNNtWtf((%8(V*J!TbOxx5DXM9YoFhH&n!xK;22Ht(X=~i$gb6&vR*ce|}+ZasN##XSl7@UWm_2)#BSXtyPWY z=#J#*>5K@ybeDoTdOIQqDvM_}bW_?!#nziw%?~PbcSh7PAR!`7-hBNAua+On&oh!6 zGG!IUDI=Wmo$TIW>+0PxgWc^Ny!cP}jy58YB)?AG$p{J4EC zp^CCJD?WG2Fv^N+Z#}beRLeKz5sbMV9|oRN-nK>rqjTg)Z9pp>J8e~Tqd5Y0`^#I;0`siBtq29hmfKcVk7)UU{2Ljo&_gG&=O(qno0M^S z@v_@W&d>n~bUd?o?`^9~4OYQ!t?TnR{1!)q?{Vql!?tLUr+Q67VJ`)%mv2Dr)YkS>(6Y zOgKV~iO`TIv_lAm>N`aLT}Ky(Zs%h+{>s$-!rm3m#q3zQxS1c&=eHf%TIOXaFa{AwH z6*82sE#jm1Y*{{_XtE-E7nHzWf;dF2!c_=f-NY z3bCNNrp^~~doorp-(?lXsPFX!!J!w53m%vQ&aUy;Dlm?oV=Z83?>e>)1o^FF2MY(S zLK~G@k49*x+n&$}9`WM)>@x>tBa#r`yU%czRm%tRlZQ02W9MTUp@qKT(+FL3gs?_7 z6b*r3-bIJR;p66k9~ z1>tN+<`#1Qg2fJbAUci<#^u9c1;q{buR(F~NB7qj>$JQ(KWb8=7;LY2{rz>7qnaVN zhRVl|=?xTwpr)}>Qx6tYh=^a@zieJo9=^V^(i7UryT#HIXCklId7`*tR3kLS>)ein zLzvjfN910I&Ti^83aSnj9~3V-QEM`5`O*CJo}}V$MwG<>u_=wBYfg=jrhA{&D7t3U z2wuAEVT~{d%WfE*+P6WlYW@f85Whb5z-owVKYn0fhf$;UhIlu~IV`3wKI#ZgPP#+Y z)o!IzQ(c{sF;w)Cim%jw!PTe(A>I|@;YC?Na)vLFl;zW)T)PU27cwCTVscITbl=QM$eVT2;Chg>8WtF()muI40G5kwoai5m&%#YZwQ7lB8 z`0Ot?*!trS6?BQc=*>Q6c#`JwGG9@txs*!`ScJ2(U4`z2Ms9PY1i^Sd76@XMbf=` zVUQY7w_XX0+({uRKJ?UjKn9M!8y z<#AL<=FDdoh(CY2Z+jcKz5FW?y<%U3dPNaNfGu?D6u{~7+k(P~Uac}2hdaBib}K{` zPOZ#d;$nMr>&Ryoz*VCMNYJpBgTD!o-jmWxT$|~gXgFzueW!8$6#*Hh)@aYEdKHNQc-#~!DRJf<<*PD?a!@S zk=9R6CPu)^$ug}dN8xiy(_xwf( zuj-#KLw2$M`SqM9%7>M8H0bn#6X>rq)~6oc@`uLsLK#nixvY?l*J z-jQEOr+DCnl@MH=c)?v9it?`fgN~etcZ=&@{Gy;k58(q%U01(k;9^nUsjTLVF;G1k z=0(MQFO`(G<|uZlsg8BwfHPfif+N!jY~19~M;Y1boAbNSm6NJLm;|Ib5mtg?yJG|dS~mhQ zLxXN)XizV*uWxA#M0rF0O^;59QR(pol;Tc8r(W zJ6_+4JmN>M4^;Vd)KOZUV;)yRR@acOhE{>%xhfFE*D=xkhe5DfkN%-_c{n#~Tqjtm zNw!SyM_By(A80(a;*F&x-YDFD zk`nLM2|ZN6MsfhR49*OeN{HP;3C8A2@MseMO9xtf}(s4yN-Z1}cq+cc21WJUekRjWs$d{v$d z8}NZ95$PNmncQNVM`+Hra*5(BzWnftjZKd}=Qwv!*%P5b1WbpSD}9Me&e zuOaUcu25Y3{x0#|_e#Xu-|t|0b>ibs7K`)$R6W1vv{!2;21LW3oo8TZup>UK7Ciw8a^*4Uza zBG0n+oc6YWY*1g&uM^r~$)|a@Hu3i#G}>Bpb+WY+1gJ?*PPXZW`gJ?xPCj<%R9tI1 z%E$7Bgc<6TkW#C*Z_m#OkU`y0m-yI+Ma7vY@5_%C zGAnUeO#I}-tq{VfKk7#z@%)ddH$3vu-_Eo~`D7m1mqQMlg-{As7B?%wv;+E7wF71$ zOyMr^>5rd44sp+)&jkZD`!54vaXf!96@|@^x75^3P&=9o!Pbw2gt+*`Uv@yaRr$$- z5Xb-Fll`T-C?CvEnar)uof4AAFZgs6%`<~X%Rlyt|N1NjagzV@CQzZfKQA3{n-zf_ zH7ka~n35AJK4Mn+>bzFaO?)tjA0L!69Jpihtf#VKYM+285VaDfo=s zQM@WxMW4G~Cw}zLa>&+Ze7OchK>MWz4Ig)Y*~qXa@B@_UQbS7NtQoe3a?X(Bs6~AB z->c6snUxxtUu3_!ZgrT19E^jB*Z7|eB^ki!}9 zz?kh}p;KhO-i*x0>%aav13}L}{=@I;HiPR3%l@rGDMNz?88d^uKRdp568=@K8{wn0 zKUBMRhbA+msXfb4>)ioxAKyyh8t0HktMr@Xei(2zD}ZLRkar?gW`RZ;VQ9{R;?ZyGAhLPs+xmh&vruK8oE#SyepjaHg{_f^s*B_U#2(mIbKO)7zz>*}Y85Rc zwTnOct^)OmyS^)7TFhi_0l4q~eAk2qPHaa7h-o*IN6$bh=`n;}MB>5k7L)5Sx*WBT zjV!u=X)}|qIjD~5GL!S?pvvMlGc|kF)jekAPyjlD&`nlw=uFf_dO396hA}g*f^3g^ zJ1BCr0#%;493M=%yAW8PrfG0vGf*%W6`?5EIs=uh=r`w*&7PDTlXigj$}8ZYnJk=# zO33~hXr|v|_dlhe+nW+GSR3mC-nzAHwfWKIF{ zGO*%A0osnd(uo4tFXWaUIRhPFP=s{OLF-VEoHqxliX#SPUy_E?_QgXUoCEt3Bq!&f z>((a>r|(M)sQZ8R#WxLZ43kIZqT;Qg(?H{?`n8ZW^iJ#8s9~zIbhf3Wx(Ll9#|u#dGLw^qF!Sz0R6{lvp=#7hhKdjzx>72F_HIK%%jq+_JpoU` zBaHn3ObLqq07eOF{Q-;;)I{2gfuLscL@`>84CIqy*t{w-y9CveStV#GhQY|15~L2Xx$ zV2TR;D>RPW-P0a((g%pTA{dJO><;Yh((8?S0Y8AK0 zwNTz+QEDpzi&AuSkq4KfjVt38N~X*OsO~!~bZNA#AF!w$(1Ik>CCx7bS>fATd0T$e zq(#XFy%yQuHrSkbN1C*#y~J0J;Ov_0Ek~uuMs6*Kh1$sT<>=u#Y2^*x>=e@EiWTU0 zn+IEYOMc*tMG0~2IW((9uv_Z7JtM|Uq`@*hOU6QrF33twRG{`sPZRIY524Qup_`h? zBIrnEB`Rd}%1dU_UWr^NLGGzUrGmktvm2~c39xo(hw!JE78i?oieX!u4N!Y zE74J8k-k}p)-j;4d^I{Bti;{bD7&!LlBfz_a z8gSF`CcZDvyuRGV_L5K6pf^w-d3r7C1O2Sv(em|yCcY<+*_IQiE{o!>yn%2y#t&NP z-H(_j5^#Vq^pFq_b~-`!^T@R}VVV-!FkEdB6up27IxwWoBG-kWc;PWYI%Xkdwdk)9 zBrK>yw=FT68mwLjG-EzTz&Gv@hE1}(rpU{6sHntgg8I8F?Dq6@oAlveBpjm0?9H56uH5)k)TsLt)7uTD;;Oys#OXbt&d9lD~zW}@XJ zkbg*a@~3Ij3Or17S3oWEK@BQIPU!^=O0mc$88#t1%T_h?slU~uIV+Cw)6G#q4k`9^Cl2W#(i65i=PV$Ty@zO>wda9BgXyT)}k<4hF zWVi(V?`*X>D?3h4Gq1~1$EnNa^{&O#kT)?c5>WU*sNABUCz^SKjIK&TS&WukTnSZ! zfxLeuO3vw4a6-*|M^-M8ZZ%~E)v6%~P9a3yF|mH9iuY%QkSATCsG-^fwXhK%q{yA$ z1FO`kwI*`nAbK0j*cAjdgFwGQ(AH9aHg6Sa5iw6?8_`?^Se+z&6*9p)k6#78qLcjj zDhMe%$boB7k$Cr&Gw4}Q8F^tTnnfPD8Xc%@qgx6alM5xH3i+{Se(b-OI7TL~L0^_P zDLB4nzV*LxTIozr7PQMatuaw67S?x}1WOi_Y0xBe)8FQ-5T(B!ztBW~6Mp%s78Km& z8(Pzh4@q|(LRA>Wq?eDNnV6}{63roY8TtDSXgAYkBIn(R^h*cj71RSS@~jxo(nU>> zg)w$H`S*=z87ODbO~?)kICc}Vfbu_h6Y84XtDwQWeWdVa)Pj1***Bw;Wawt#PR}hM zh*ep&hrDw=T2cT$oW|5Ka`F~*BWjk!TM>hn^<=@W4+TOyWM3thNn@d*FqC+E$i26r zU&FlV+fmK3)))v@BIa;`OU*VwPfkCC0cewlZbv((CnEMcAR@1>hK+UK3NR8dWtz8mI)QRP^k0 zdiE(iYBgJl`YyB?#yICL!~;wA-UU{?m7KZ@MJc^9g*{NL1V>DLT26CY$8 z??$Tt{qeieIZG+J&*i76-#-!2OAYs+d9}zOwY>?FGp{KoSYkuz*bcr8szb#3HL70J z6x#t6ev7YW!r)sgI735CRf?v+#~c~c_E`h zZCBpLRBUUCQ8)yaVC;rzGv;x}9BHB5OFJ}(3CUn+L0QKm#N=KgJTemS2o5p>F<&i6 z41*L7c;Qc&wtUh8hFQj{chcO-2o61@9yA_Y#Jr2Tr1usvVT4># zcOlcw0KGRCGrz?kOWCE&AZnLhUCKO)*a4%uhRiQxmPz+5XD*(B0#f}-<~JM|vAH$O zbr^o{|Vf=BNbzaRG!5YNnIM|LKa-c?>92Hp&seHO-u>q=x7tf(ZLjx{d#7h z^u!kC*epV}FuZhB&unB+i}b%n<|?@MMnWyjFG#S3DUdd_GKqOW?`^%zGjo_hBZ<41 z7$F8K7@Qy<4>4+ z4uz%heT)vHxb*M=2J&Brbm~f`gkb{1q#TwhRb0i)n*mH-cbM6ZU}qvnnClDBu(aql z#sHT$rM}ylHV!fr%_G1w>29V9k?Ze<_fFlzT)@mu5AzGIi^I!aoDJ2*DjHy@JDrA@5`5DuTuobSU z-gCHwbUwuV80pEY4>2zxt8~-D%%uqFBp_rinyt@ItRt^4Fg3QwKUoxQY7P^cz()=fx6&O0}o?_JGPfq~H6HhU7nT4id-kmFx z%C6f_E`Nr(c%FZl-mQVcDV5PqviezO7#MT$v&;t!Ob~nlsPs#xUSPH|s6(oInNHt9 znqOhcA=B}^!fXMg!>@oubW7d8VQ$0VJKnhu_NnN1%qbQ+Gv5G#8Y4&FU^<{)00gck z=YGu0l*-4M@~=Q$ybV zhM6O+{ST8xpxrlr%RngDGAw94XY&2@X9FK`2`Vu5p}3FU;`4;uD!z@J`i>b#Ehhr_ zafG@^9fQ9{{n8qGYZMX8>HV5N=Q}_t+GT8if}C_sYC@$;KpHbLbG zKnXy_C!y(#*X4RymvBy9)kM;^^Bmp_PvomNwT_5S#k)zU440cnZNfRS@voZ5x&SLO z)pzFrK^XvENbXlnc2%Qm;weoj?~mp-2hC4lde&?@EA)} zkr!9v8N0@&fWdGcF**eU^~w#{3ZO{XN2fS#?xtyIGLpk=1{eehBg!PoBB}ru2s@O) zswSdtSlBqgTmiEzRIt(D!%75q*^$f3D(MXV1OJ^ z<0Yl-|MfHk@u7-uAup?ONnt-c&aI@@lLDqu1M;;RuV%a830YKwRWmDm!4Vatgw`5d zixOmK4K6JSrJ*WIT|=!iUaOp&L$NPL?yA9R(Cy#VV6bfoseCQokHGQY&EqW?cKV}r zcpEsTY7M>;e89sRY$gwB@ElU8#VbgG7SE9ywHWH2I`YZ}ypkETk$-N$)nKg4Hew@L zunEs3uWZE2!O~u|5wC%mhKj{`ZhJ; z)hJGOG~sof5HX$;9}TBL0pqaqfm|0PSnj)^KPpSS+)XN7w`c0P7XYq+EGU3bH4!Fn zHsR*EZrG4fkD_0rWSt&wVWKf|YA@a-9oFMn7|hP?&EN^5ndfWl(AYs__lg>rwGd}PB7 ztu_FI^`N>6;HrrHFFicbSQl$c~h#b5wfK+?4bULvv}K{Ktv$GcHPO~N&|2+>7R0QLssNbGT4m^Z zRg7+EuE%#$cJ7VJ1tC*{fBWSIlC8M$#f|DP1Jq(cBUguj_m`3zUwCN zirs0lZyZE^K|lTly!>K6c5~S@BwJJn7E5gd*vUX#dDjsB0vV;lXJb8@Ih=+}6G8*W zF>WbgeuU3tQvf011`L_PkMID363U&!cn&i+lg@t;;7^n599T_0b>LWGI!(){jfQl+ zISp4~8%^nY3yC@L28dm6abiDJ^FHXJzl;H`9i+|=R-%LS_;H=`qh{OPdm+F&K6`0<}(u%TKpo#WzVG#_$@rvP2dp zF%Pz9TN1Z3V`=i(I$TC>OX9VlL9ZsUAAzCTp2meUn$sXjRb()Yw?i~|Z5rzr^eHk5 z-e;UTvR?9e8gGWEuR4R>XnGLeEXDD#ZBrt723QuANF@1`flgB>5 zGbC{*zMKJCtIxxY5G8ug!#ua#w^LIP&UHc6<$j#3-;1?% z4glvk3*f2=_bA{7rhs*BUp(lG$8+zv$br4!Rg&b+y;#L~GenyOC3$Zz-a(Vd?fdaH zh&1lU#pH|2@Q;{yhAPogY3u+tGmw8uB5Wud$nZ(B;!3=lab?K8KgO%2@RfKGV&SOP zD_wXH&jRmAE+g22+~jS72a85Ca8l`jN@?xT+3DIHYv}26gjlYE?Ff>+SHWhEkfN(` zOQAbM&$#3>il%TFBASpoLLyfKIpM1zc)a#%JOL+GCD-5@G%D$?!6&HFe0d1>A}8s% z4i^_YDQmO9TI#uBgoF=dJWIx}!>izY?&x(8q7F;Hxeh;xkd2TdU~a~UbOhY`7$JTr5O8GEH{CqW-`-e3Z~t66TWvAvPzBj;16L8srndxbq0{}wS=EVdg<2>;_WlRLd|>( zKhB`6^vo~u>u8=1<^W0{VvDIDsJ!<{SfrUQa#&ep{+WTi`6MjTLYQCSPYC)I@C^SN zVj4fu{u=*jb|;LZ#O)oV;wkK4EDEKJE<>z0;bn~fbYe}?+fU(-5!adFJ2GUa1i||3 zXYq3oU>0y-@=K~6tNHN^dG`+> z7Motc^C4_8zJRN$dx5Ic+-%S3U62S`u2S&>(*74f=)l^Qyo8T~(Rl79e2OO9zxWMg zB=dVRkfJFyGC23|C4t{VGB-|s@q644(-gl38{I0M_ZmJ2Eo{yxvC&jeR7Fm`j@7%` zVcLYl36ZG6B)M&f%j{{P?CF>3q9LZ7owdQ*mAJ@2!=^5!E5}7LV30CP4y)v@$F6k2 z5Xk)m^m7&f`c)G%`so}Ya`+E;{el>L_<9;geB_-!;B8FUE^9v7@CH7sBz`(do=Xn$ z<2P^@)1HB1Ex4+aZ{VAtzInx)po48>!CSZq4H7UI)g=2ChAi+caMk~L3mkFxTew)N zeH-tBJXX5vkH97{YxCa4#S3G0_`VcO=M=Z%(x!L8+OY{cA140yFj*D=N+3>3gyAw7 zL?4R14A@~cE>iYBF4>iYrOG)F)rhJIE47Q>JS>^Wf!qM{!dHrMAMi*<8l8fK^GFc@ zDO{H^f=XBBx(pZrfWmdTn}Y6K+MgQINgjJ20`)BUe?4FhR`@~{t(qD*n06$EDEZfCus86H^5mTjfO7(X(Hba-;B^J@h$K{6nrq@m7#Ehriae1Vk%q6YoFs4%)n`% zY^X+?DBT&LMv0f(a+j_3BZ3ufKQ^@K#kn6;lEg{8s?3qQcpK0uSJGTM!9;N!y2;4^ zdEg{2U**#A6Uk8A;q}y4PJQb!oV$wIG$OQ8^kMSvlenqEt`p2KZJle>5z{4jYwkws z_=xh+o}LVSftRn)!97joDz;f}!FfL{wHYqr^}$taJvsOVUQw!pJCxJ6toufI<>qj` zmAv=`Y>t`y^$W$oZe)${Cd-a4?-Bm%#@; zkkH**%(fLeEy}g@EF62oIWkapg4aY@ zEFW$IkKJ%gNWb%>H|IvD+CChDi0izitQI1!`z6VXkwi>39u*r#Y5_0@T7a3);37`=pj z6n@k{VPA)Q@A}=Wlel-YTM63Dx=8CDR!@%ZX8q*YrR+x1d?~a#_ps+cns#gtTSD&L z!xodb_pmb-8%(gD&KTTZZg4r`9+j$IPrls49$gArISl8lH4SOFLmE!k=^^fMMBp4P zN{;Pitq^*leQX#iG0}bOAc^c_)zaVgvFC75^tWHZN|2Pzxss}0H^nQKnh&xJQkhJ= z-^5!?e5Z-;Ht`*%9W{xNx@P(ic1#*0tezGn;H?tkzM4(ekC}2G&7Ovr0n+4q!b+K@ zBJ3TC{?}l3a`akuA0&J04zW8?FS+XwTMs7w<3sFW;PS=Sv6s^`fy3;@5boS?m^~lD zovI^j2UxK95q1^)Tz!P)Q4jg`5mpVXK6!*)4QC4_N7*56sTB@+;iNF>RBWJH1K$J6 z->zE8o}1a*Vf^qd>JEP4u3lqjp@mU8>K@$Jw$h zLs>TDR4m^F3tmt?X6^nV-Ft-GJunvo)t3fees2x3jxpiR5-xnBV?Ap&B6X z-_ELd1=y%ssnKXu^{SO#uU93X_9Tqd^qT1=^CsC0w@cbP*b7CbB}K z5V$I`#KRSl=55fOyN#PkE}8?EFZOTa&Vo~kXSQ+Ak*BwD-Q>eYZWmMtz1ulLk1M{_ zaZk<-`vo|e3?w~pUy3J>y}*_*d`SAZi7Q}02~Qb7(p#hwBliHcxi2 zYmJKUkC zdezNsMqJ3a10u$Ez1%YLxrLi4t@m<>A^*{FWm4xTcg_sRNsooNM(_=%=uenv!(1)& zhQr+JP(Xuc#l#xn>cMpEj&SpVcydjYbIb}GK`i9Y`$%1ctCXr^oEcRH=*cU+)jln) zF*unv@(!b-0OYQl&=Tp+I9H5GEY2+=73Z@Yc`e1AIX6yE$l(?YJ)cWT%hDVi&?cq( zGu%@Q6zC==xV4aX-ZsJQ2QLC-l@RMB$CJ&I+*u1kaE_#!)-4Bla+2#Rj{q_Cqwt4! z8|il}aNBGeCrCEzS{~$U{1xWs1qM^SCf_N|onxlL$h|!xwN{;pdGDxTRpK|9JsOo0p&q zfz9N{oDZ(r($2jQq26~P=YU6r7jeCS=)Z{5&vW}vTcwdad=b|UcUKE8=2ipWG#7Kv zf^Gl$Vs1SE>n`CcAilL;!WBW!a|ySlWR%iLuPMNnbJMii$o-dao=PL-C2%L62uJ8` zRmX@!{*O4|dr0{;FRA|tSGgc)p;-e!dQr~fD1%I=_FP?>3Iu)+eDpj7+_ z^bL-fKi5sex8p&#uQotYoXLQ*mYx@7eh5`fAD^elJ3rwx5PvV+4Xeo#!)|Uj@c*UV zTp2jS&vtW8a8aF?a)spRr5sB}FXdJe>!q;NG`ap#?ztsSKcDsQsPTlT*iEn1NXqsC z=B<0UBqaCH26vevRr|QZj17|RgKQCbeIK`Zp7C@(+e!I;Zsn?Bzw*WIwDj9xhVL7G zD}h}uglvFaME30G#)@^abb&bvlH^;n=WI(>GF6&2CfLb)e z_usKd@yj?CiWM@Mg=FsmFk2ZiaXGh~yng^pm7TVaFES~T2Umbjcgpop!k7@bhvCdY z+Hxhw(X)qb2e~X%8f1}v@gOieO|}y-2t|Zj10zFQPrf|}fU60&VV?DLj&xFcQY?Kz zxRvy*yzp8sgF2Az* zEmjbyK{ySiSy||BPH_JN;X~g8;0+!+0e0r{2e>S&gT;~P1Kje)p>&qF8+ogd4`%sH zmJb+ti;-^*@Ma_LH}c&^K5FEf0Al2;a#nAe46~oiy^^gUyTRl`9`Sn#*fVZalebK8 NWqw?$eUNj`_&>7kHAesd diff --git a/netbox/project-static/dist/netbox.js.map b/netbox/project-static/dist/netbox.js.map index 60656bc6d6f3450acca6ca6d4369da29b4749527..9b92d1489c63f744f04a6085c653d32bd45b6331 100644 GIT binary patch delta 495 zcmZ8e!AiqG5JioMc<|JlpD>{4p@^rq)1-v3)DUW#V;Xv>RIB2__7V>{37+#2f+wLT zKfvGcOPtvRQoJlPZ)e|o^R{~HeZTi!tDS1M+WYc8@^XA(CCV7kZ=**eU_?uUc)|5& z?iFQx8&K{Hi4{@ltRyNm17>pYvooAh2R<6`n*X~J*^K5!2#xwmlyBwM><=0sfs%>JYv=S42XU*m3KR!e7Ag%jYLgCCHKy { + const search = new Event('search'); + quicksearch.value = ''; + await new Promise(f => setTimeout(f, 100)); + quicksearch.dispatchEvent(search); + }, { + passive: true + }) + } + } +} + export function initSearch(): void { for (const func of [initSearchBar]) { func(); } + initQuickSearch(); } diff --git a/netbox/project-static/styles/netbox.scss b/netbox/project-static/styles/netbox.scss index 8ef280397..d78e9e9b9 100644 --- a/netbox/project-static/styles/netbox.scss +++ b/netbox/project-static/styles/netbox.scss @@ -416,6 +416,27 @@ nav.search { } } +// Styles for the quicksearch and its clear button; +// Overrides input-group styles and adds transition effects +.quicksearch { + input[type="search"] { + border-radius: $border-radius !important; + } + + button { + margin-left: -32px !important; + z-index: 100 !important; + outline: none !important; + border-radius: $border-radius !important; + transition: visibility 0s, opacity 0.2s linear; + } + + button :hover { + opacity: 50%; + transition: visibility 0s, opacity 0.1s linear; + } +} + main.layout { display: flex; flex-wrap: nowrap; diff --git a/netbox/project-static/styles/overrides.scss b/netbox/project-static/styles/overrides.scss index 03c72c6e6..7fa366df8 100644 --- a/netbox/project-static/styles/overrides.scss +++ b/netbox/project-static/styles/overrides.scss @@ -34,3 +34,11 @@ a[type='button'] { .badge { font-size: $font-size-xs; } + +/* clears the 'X' in search inputs from webkit browsers */ +input[type='search']::-webkit-search-decoration, +input[type='search']::-webkit-search-cancel-button, +input[type='search']::-webkit-search-results-button, +input[type='search']::-webkit-search-results-decoration { + -webkit-appearance: none !important; +} diff --git a/netbox/project-static/styles/theme-dark.scss b/netbox/project-static/styles/theme-dark.scss index c0933e991..4bbe5cea5 100644 --- a/netbox/project-static/styles/theme-dark.scss +++ b/netbox/project-static/styles/theme-dark.scss @@ -92,6 +92,10 @@ $input-focus-color: $input-color; $input-placeholder-color: $gray-700; $input-plaintext-color: $body-color; +input { + color-scheme: dark; +} + $form-check-input-active-filter: brightness(90%); $form-check-input-bg: $input-bg; $form-check-input-border: 1px solid rgba(255, 255, 255, 0.25); diff --git a/netbox/project-static/styles/theme-light.scss b/netbox/project-static/styles/theme-light.scss index d417e1bf6..c9478f1cc 100644 --- a/netbox/project-static/styles/theme-light.scss +++ b/netbox/project-static/styles/theme-light.scss @@ -22,7 +22,6 @@ $theme-colors: ( 'danger': $danger, 'light': $light, 'dark': $dark, - // General-purpose palette 'blue': $blue-500, 'indigo': $indigo-500, @@ -36,7 +35,7 @@ $theme-colors: ( 'cyan': $cyan-500, 'gray': $gray-500, 'black': $black, - 'white': $white, + 'white': $white ); $light: $gray-200; diff --git a/netbox/project-static/styles/utilities.scss b/netbox/project-static/styles/utilities.scss index cd8ccc46b..a5a4bf038 100644 --- a/netbox/project-static/styles/utilities.scss +++ b/netbox/project-static/styles/utilities.scss @@ -42,3 +42,9 @@ table td { visibility: visible !important; } } + +// Hides the last child of an element +.hide-last-child :last-child { + visibility: hidden; + opacity: 0; +} diff --git a/netbox/templates/dcim/device/interfaces.html b/netbox/templates/dcim/device/interfaces.html index 22f6d8be5..79a9d6b6f 100644 --- a/netbox/templates/dcim/device/interfaces.html +++ b/netbox/templates/dcim/device/interfaces.html @@ -4,84 +4,85 @@ {% load static %} {% block content %} -
    -
    -
    - -
    +
    +
    +
    + +
    -
    -
    - {% if request.user.is_authenticated %} - - {% endif %} - -
      - - -
    -
    +
    +
    +
    + {% if request.user.is_authenticated %} + + {% endif %} + +
      + + +
    +
    +
    +
    + +
    + {% csrf_token %} + + +
    +
    + {% include 'htmx/table.html' %}
    - - {% csrf_token %} - - -
    -
    - {% include 'htmx/table.html' %} -
    +
    +
    + {% if perms.dcim.change_interface %} + + + + {% endif %} + {% if perms.dcim.delete_interface %} + + {% endif %}
    - -
    -
    - {% if perms.dcim.change_interface %} - - - - {% endif %} - {% if perms.dcim.delete_interface %} - - {% endif %} -
    - {% if perms.dcim.add_interface %} -
    - - Add Interfaces - -
    - {% endif %} + {% if perms.dcim.add_interface %} +
    + + Add Interfaces +
    - + {% endif %} +
    + {% endblock %} {% block modals %} - {{ block.super }} - {% table_config_form table %} -{% endblock modals %} +{{ block.super }} +{% table_config_form table %} +{% endblock modals %} \ No newline at end of file diff --git a/netbox/templates/inc/table_controls_htmx.html b/netbox/templates/inc/table_controls_htmx.html index ab8167bc0..099ad537e 100644 --- a/netbox/templates/inc/table_controls_htmx.html +++ b/netbox/templates/inc/table_controls_htmx.html @@ -2,31 +2,21 @@
    -
    - +
    + +
    {% if request.user.is_authenticated and table_modal %} -
    - -
    +
    + +
    {% endif %}
    -
    +
    \ No newline at end of file From 8cd5a24409c993cc3533a1bfa03a95cf2a2f42b6 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 11 Aug 2022 09:58:37 -0400 Subject: [PATCH 371/593] #9414: Clean up clone_fields on all models --- netbox/circuits/models/circuits.py | 4 ++-- netbox/circuits/models/providers.py | 4 ++-- netbox/dcim/models/device_components.py | 23 +++++++++++++---------- netbox/dcim/models/devices.py | 11 ++++++----- netbox/dcim/models/power.py | 6 +++--- netbox/dcim/models/racks.py | 4 ++-- netbox/dcim/models/sites.py | 10 +++++----- netbox/ipam/models/fhrp.py | 2 +- netbox/ipam/models/ip.py | 18 +++++++++--------- netbox/ipam/models/vrfs.py | 4 ++-- netbox/tenancy/models/contacts.py | 8 ++++---- netbox/tenancy/models/tenants.py | 4 ++-- netbox/virtualization/models.py | 10 +++++----- netbox/wireless/models.py | 2 ++ 14 files changed, 58 insertions(+), 52 deletions(-) diff --git a/netbox/circuits/models/circuits.py b/netbox/circuits/models/circuits.py index d82878cde..c78ea81c7 100644 --- a/netbox/circuits/models/circuits.py +++ b/netbox/circuits/models/circuits.py @@ -125,9 +125,9 @@ class Circuit(NetBoxModel): null=True ) - clone_fields = [ + clone_fields = ( 'provider', 'type', 'status', 'tenant', 'install_date', 'termination_date', 'commit_rate', 'description', - ] + ) class Meta: ordering = ['provider', 'cid'] diff --git a/netbox/circuits/models/providers.py b/netbox/circuits/models/providers.py index 4211a54a6..e136e13ea 100644 --- a/netbox/circuits/models/providers.py +++ b/netbox/circuits/models/providers.py @@ -61,9 +61,9 @@ class Provider(NetBoxModel): to='tenancy.ContactAssignment' ) - clone_fields = [ + clone_fields = ( 'asn', 'account', 'portal_url', 'noc_contact', 'admin_contact', - ] + ) class Meta: ordering = ['name'] diff --git a/netbox/dcim/models/device_components.py b/netbox/dcim/models/device_components.py index 5e2fc348e..838336e21 100644 --- a/netbox/dcim/models/device_components.py +++ b/netbox/dcim/models/device_components.py @@ -263,7 +263,7 @@ class ConsolePort(ModularComponentModel, CabledObjectModel, PathEndpoint): help_text='Port speed in bits per second' ) - clone_fields = ['device', 'type', 'speed'] + clone_fields = ('device', 'module', 'type', 'speed') class Meta: ordering = ('device', '_name') @@ -290,7 +290,7 @@ class ConsoleServerPort(ModularComponentModel, CabledObjectModel, PathEndpoint): help_text='Port speed in bits per second' ) - clone_fields = ['device', 'type', 'speed'] + clone_fields = ('device', 'module', 'type', 'speed') class Meta: ordering = ('device', '_name') @@ -327,7 +327,7 @@ class PowerPort(ModularComponentModel, CabledObjectModel, PathEndpoint): help_text="Allocated power draw (watts)" ) - clone_fields = ['device', 'maximum_draw', 'allocated_draw'] + clone_fields = ('device', 'module', 'maximum_draw', 'allocated_draw') class Meta: ordering = ('device', '_name') @@ -441,7 +441,7 @@ class PowerOutlet(ModularComponentModel, CabledObjectModel, PathEndpoint): help_text="Phase (for three-phase feeds)" ) - clone_fields = ['device', 'type', 'power_port', 'feed_leg'] + clone_fields = ('device', 'module', 'type', 'power_port', 'feed_leg') class Meta: ordering = ('device', '_name') @@ -672,7 +672,10 @@ class Interface(ModularComponentModel, BaseInterface, CabledObjectModel, PathEnd related_query_name='interface', ) - clone_fields = ['device', 'parent', 'bridge', 'lag', 'type', 'mgmt_only', 'poe_mode', 'poe_type'] + clone_fields = ( + 'device', 'module', 'parent', 'bridge', 'lag', 'type', 'mgmt_only', 'mtu', 'mode', 'speed', 'duplex', 'rf_role', + 'rf_channel', 'rf_channel_frequency', 'rf_channel_width', 'tx_power', 'poe_mode', 'poe_type', 'vrf', + ) class Meta: ordering = ('device', CollateAsChar('_name')) @@ -890,7 +893,7 @@ class FrontPort(ModularComponentModel, CabledObjectModel): ] ) - clone_fields = ['device', 'type'] + clone_fields = ('device', 'type', 'color') class Meta: ordering = ('device', '_name') @@ -937,7 +940,7 @@ class RearPort(ModularComponentModel, CabledObjectModel): MaxValueValidator(REARPORT_POSITIONS_MAX) ] ) - clone_fields = ['device', 'type', 'positions'] + clone_fields = ('device', 'type', 'color', 'positions') class Meta: ordering = ('device', '_name') @@ -972,7 +975,7 @@ class ModuleBay(ComponentModel): help_text='Identifier to reference when renaming installed components' ) - clone_fields = ['device'] + clone_fields = ('device',) class Meta: ordering = ('device', '_name') @@ -994,7 +997,7 @@ class DeviceBay(ComponentModel): null=True ) - clone_fields = ['device'] + clone_fields = ('device',) class Meta: ordering = ('device', '_name') @@ -1131,7 +1134,7 @@ class InventoryItem(MPTTModel, ComponentModel): objects = TreeManager() - clone_fields = ['device', 'parent', 'role', 'manufacturer', 'part_id'] + clone_fields = ('device', 'parent', 'role', 'manufacturer', 'part_id',) class Meta: ordering = ('device__id', 'parent__id', '_name') diff --git a/netbox/dcim/models/devices.py b/netbox/dcim/models/devices.py index f21176d8d..136fcf6cf 100644 --- a/netbox/dcim/models/devices.py +++ b/netbox/dcim/models/devices.py @@ -135,9 +135,9 @@ class DeviceType(NetBoxModel): blank=True ) - clone_fields = [ + clone_fields = ( 'manufacturer', 'u_height', 'is_full_depth', 'subdevice_role', 'airflow', - ] + ) class Meta: ordering = ['manufacturer', 'model'] @@ -630,9 +630,10 @@ class Device(NetBoxModel, ConfigContextModel): objects = ConfigContextModelQuerySet.as_manager() - clone_fields = [ - 'device_type', 'device_role', 'tenant', 'platform', 'site', 'location', 'rack', 'status', 'airflow', 'cluster', - ] + clone_fields = ( + 'device_type', 'device_role', 'tenant', 'platform', 'site', 'location', 'rack', 'face', 'status', 'airflow', + 'cluster', 'virtual_chassis', + ) class Meta: ordering = ('_name', 'pk') # Name may be null diff --git a/netbox/dcim/models/power.py b/netbox/dcim/models/power.py index 94767c6c4..c275691c0 100644 --- a/netbox/dcim/models/power.py +++ b/netbox/dcim/models/power.py @@ -126,10 +126,10 @@ class PowerFeed(NetBoxModel, PathEndpoint, CabledObjectModel): blank=True ) - clone_fields = [ + clone_fields = ( 'power_panel', 'rack', 'status', 'type', 'mark_connected', 'supply', 'phase', 'voltage', 'amperage', - 'max_utilization', 'available_power', - ] + 'max_utilization', + ) class Meta: ordering = ['power_panel', 'name'] diff --git a/netbox/dcim/models/racks.py b/netbox/dcim/models/racks.py index 4dcfcde28..50c91b52e 100644 --- a/netbox/dcim/models/racks.py +++ b/netbox/dcim/models/racks.py @@ -183,10 +183,10 @@ class Rack(NetBoxModel): to='extras.ImageAttachment' ) - clone_fields = [ + clone_fields = ( 'site', 'location', 'tenant', 'status', 'role', 'type', 'width', 'u_height', 'desc_units', 'outer_width', 'outer_depth', 'outer_unit', - ] + ) class Meta: ordering = ('site', 'location', '_name', 'pk') # (site, location, name) may be non-unique diff --git a/netbox/dcim/models/sites.py b/netbox/dcim/models/sites.py index 9b7ffdcf4..67bcc6e4c 100644 --- a/netbox/dcim/models/sites.py +++ b/netbox/dcim/models/sites.py @@ -295,10 +295,10 @@ class Site(NetBoxModel): to='extras.ImageAttachment' ) - clone_fields = [ - 'status', 'region', 'group', 'tenant', 'facility', 'time_zone', 'description', 'physical_address', - 'shipping_address', 'latitude', 'longitude', - ] + clone_fields = ( + 'status', 'region', 'group', 'tenant', 'facility', 'time_zone', 'physical_address', 'shipping_address', + 'latitude', 'longitude', 'description', + ) class Meta: ordering = ('_name',) @@ -372,7 +372,7 @@ class Location(NestedGroupModel): to='extras.ImageAttachment' ) - clone_fields = ['site', 'parent', 'status', 'tenant', 'description'] + clone_fields = ('site', 'parent', 'status', 'tenant', 'description') class Meta: ordering = ['site', 'name'] diff --git a/netbox/ipam/models/fhrp.py b/netbox/ipam/models/fhrp.py index 2a8d1bdcd..286251444 100644 --- a/netbox/ipam/models/fhrp.py +++ b/netbox/ipam/models/fhrp.py @@ -48,7 +48,7 @@ class FHRPGroup(NetBoxModel): related_query_name='fhrpgroup' ) - clone_fields = ('protocol', 'auth_type', 'auth_key') + clone_fields = ('protocol', 'auth_type', 'auth_key', 'description') class Meta: ordering = ['protocol', 'group_id', 'pk'] diff --git a/netbox/ipam/models/ip.py b/netbox/ipam/models/ip.py index 9ad763920..26cee8100 100644 --- a/netbox/ipam/models/ip.py +++ b/netbox/ipam/models/ip.py @@ -175,9 +175,9 @@ class Aggregate(GetAvailablePrefixesMixin, NetBoxModel): blank=True ) - clone_fields = [ + clone_fields = ( 'rir', 'tenant', 'date_added', 'description', - ] + ) class Meta: ordering = ('prefix', 'pk') # prefix may be non-unique @@ -360,9 +360,9 @@ class Prefix(GetAvailablePrefixesMixin, NetBoxModel): objects = PrefixQuerySet.as_manager() - clone_fields = [ + clone_fields = ( 'site', 'vrf', 'tenant', 'vlan', 'status', 'role', 'is_pool', 'mark_utilized', 'description', - ] + ) class Meta: ordering = (F('vrf').asc(nulls_first=True), 'prefix', 'pk') # (vrf, prefix) may be non-unique @@ -608,9 +608,9 @@ class IPRange(NetBoxModel): blank=True ) - clone_fields = [ + clone_fields = ( 'vrf', 'tenant', 'status', 'role', 'description', - ] + ) class Meta: ordering = (F('vrf').asc(nulls_first=True), 'start_address', 'pk') # (vrf, start_address) may be non-unique @@ -836,9 +836,9 @@ class IPAddress(NetBoxModel): objects = IPAddressManager() - clone_fields = [ - 'vrf', 'tenant', 'status', 'role', 'description', - ] + clone_fields = ( + 'vrf', 'tenant', 'status', 'role', 'dns_name', 'description', + ) class Meta: ordering = ('address', 'pk') # address may be non-unique diff --git a/netbox/ipam/models/vrfs.py b/netbox/ipam/models/vrfs.py index fc34b5488..a926bec3e 100644 --- a/netbox/ipam/models/vrfs.py +++ b/netbox/ipam/models/vrfs.py @@ -55,9 +55,9 @@ class VRF(NetBoxModel): blank=True ) - clone_fields = [ + clone_fields = ( 'tenant', 'enforce_unique', 'description', - ] + ) class Meta: ordering = ('name', 'rd', 'pk') # (name, rd) may be non-unique diff --git a/netbox/tenancy/models/contacts.py b/netbox/tenancy/models/contacts.py index 75ec9f69c..41881f853 100644 --- a/netbox/tenancy/models/contacts.py +++ b/netbox/tenancy/models/contacts.py @@ -112,9 +112,9 @@ class Contact(NetBoxModel): blank=True ) - clone_fields = [ - 'group', - ] + clone_fields = ( + 'group', 'name', 'title', 'phone', 'email', 'address', 'link', + ) class Meta: ordering = ['name'] @@ -155,7 +155,7 @@ class ContactAssignment(WebhooksMixin, ChangeLoggedModel): blank=True ) - clone_fields = ('content_type', 'object_id') + clone_fields = ('content_type', 'object_id', 'role', 'priority') class Meta: ordering = ('priority', 'contact') diff --git a/netbox/tenancy/models/tenants.py b/netbox/tenancy/models/tenants.py index 88d8d52f1..b0ccd1cb2 100644 --- a/netbox/tenancy/models/tenants.py +++ b/netbox/tenancy/models/tenants.py @@ -76,9 +76,9 @@ class Tenant(NetBoxModel): to='tenancy.ContactAssignment' ) - clone_fields = [ + clone_fields = ( 'group', 'description', - ] + ) class Meta: ordering = ['name'] diff --git a/netbox/virtualization/models.py b/netbox/virtualization/models.py index f07b176e7..21bc799be 100644 --- a/netbox/virtualization/models.py +++ b/netbox/virtualization/models.py @@ -153,9 +153,9 @@ class Cluster(NetBoxModel): to='tenancy.ContactAssignment' ) - clone_fields = [ - 'type', 'group', 'tenant', 'site', - ] + clone_fields = ( + 'type', 'group', 'status', 'tenant', 'site', + ) class Meta: ordering = ['name'] @@ -299,9 +299,9 @@ class VirtualMachine(NetBoxModel, ConfigContextModel): objects = ConfigContextModelQuerySet.as_manager() - clone_fields = [ + clone_fields = ( 'site', 'cluster', 'device', 'tenant', 'platform', 'status', 'role', 'vcpus', 'memory', 'disk', - ] + ) class Meta: ordering = ('_name', 'pk') # Name may be non-unique diff --git a/netbox/wireless/models.py b/netbox/wireless/models.py index dd3945d50..0540e9c45 100644 --- a/netbox/wireless/models.py +++ b/netbox/wireless/models.py @@ -113,6 +113,8 @@ class WirelessLAN(WirelessAuthenticationBase, NetBoxModel): blank=True ) + clone_fields = ('ssid', 'group', 'tenant', 'description') + class Meta: ordering = ('ssid', 'pk') verbose_name = 'Wireless LAN' From 5f15f550c9fdf3603b5fd17816c929434f42b78e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 11 Aug 2022 11:37:07 -0400 Subject: [PATCH 372/593] Restore model documentation for all models under extras --- docs/customization/custom-fields.md | 109 ------------------- docs/customization/custom-links.md | 66 ------------ docs/customization/export-templates.md | 81 -------------- docs/integrations/webhooks.md | 139 ------------------------- docs/models/extras/customfield.md | 109 +++++++++++++++++++ docs/models/extras/customlink.md | 66 ++++++++++++ docs/models/extras/exporttemplate.md | 81 ++++++++++++++ docs/models/extras/imageattachment.md | 3 + docs/models/extras/webhook.md | 139 +++++++++++++++++++++++++ mkdocs.yml | 5 + 10 files changed, 403 insertions(+), 395 deletions(-) create mode 100644 docs/models/extras/customfield.md create mode 100644 docs/models/extras/customlink.md create mode 100644 docs/models/extras/exporttemplate.md create mode 100644 docs/models/extras/imageattachment.md create mode 100644 docs/models/extras/webhook.md diff --git a/docs/customization/custom-fields.md b/docs/customization/custom-fields.md index bfe412edc..e69de29bb 100644 --- a/docs/customization/custom-fields.md +++ b/docs/customization/custom-fields.md @@ -1,109 +0,0 @@ -# Custom Fields - -Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, sites are stored in the `dcim_site` table, which has columns named `name`, `facility`, `physical_address`, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows. - -However, some users might want to store additional object attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number correlating it with an internal support system record. This is certainly a legitimate use for NetBox, but it's not a common enough need to warrant including a field for _every_ NetBox installation. Instead, you can create a custom field to hold this data. - -Within the database, custom fields are stored as JSON data directly alongside each object. This alleviates the need for complex queries when retrieving objects. - -## Creating Custom Fields - -Custom fields may be created by navigating to Customization > Custom Fields. NetBox supports six types of custom field: - -* Text: Free-form text (intended for single-line use) -* Long text: Free-form of any length; supports Markdown rendering -* Integer: A whole number (positive or negative) -* Boolean: True or false -* Date: A date in ISO 8601 format (YYYY-MM-DD) -* URL: This will be presented as a link in the web UI -* JSON: Arbitrary data stored in JSON format -* Selection: A selection of one of several pre-defined custom choices -* Multiple selection: A selection field which supports the assignment of multiple values -* Object: A single NetBox object of the type defined by `object_type` -* Multiple object: One or more NetBox objects of the type defined by `object_type` - -Each custom field must have a name. This should be a simple database-friendly string (e.g. `tps_report`) and may contain only alphanumeric characters and underscores. You may also assign a corresponding human-friendly label (e.g. "TPS report"); the label will be displayed on web forms. A weight is also required: Higher-weight fields will be ordered lower within a form. (The default weight is 100.) If a description is provided, it will appear beneath the field in a form. - -Marking a field as required will force the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields, or the exact value of a choice for selection fields. - -A custom field must be assigned to one or more object types, or models, in NetBox. Once created, custom fields will automatically appear as part of these models in the web UI and REST API. Note that not all models support custom fields. - -### Filtering - -The filter logic controls how values are matched when filtering objects by the custom field. Loose filtering (the default) matches on a partial value, whereas exact matching requires a complete match of the given string to a field's value. For example, exact filtering with the string "red" will only match the exact value "red", whereas loose filtering will match on the values "red", "red-orange", or "bored". Setting the filter logic to "disabled" disables filtering by the field entirely. - -### Grouping - -!!! note - This feature was introduced in NetBox v3.3. - -Related custom fields can be grouped together within the UI by assigning each the same group name. When at least one custom field for an object type has a group defined, it will appear under the group heading within the custom fields panel under the object view. All custom fields with the same group name will appear under that heading. (Note that the group names must match exactly, or each will appear as a separate heading.) - -This parameter has no effect on the API representation of custom field data. - -### Visibility - -!!! note - This feature was introduced in NetBox v3.3. - -When creating a custom field, there are three options for UI visibility. These control how and whether the custom field is displayed within the NetBox UI. - -* **Read/write** (default): The custom field is included when viewing and editing objects. -* **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.) -* **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users. - -Note that this setting has no impact on the REST or GraphQL APIs: Custom field data will always be available via either API. - -### Validation - -NetBox supports limited custom validation for custom field values. Following are the types of validation enforced for each field type: - -* Text: Regular expression (optional) -* Integer: Minimum and/or maximum value (optional) -* Selection: Must exactly match one of the prescribed choices - -### Custom Selection Fields - -Each custom selection field must have at least two choices. These are specified as a comma-separated list. Choices appear in forms in the order they are listed. Note that choice values are saved exactly as they appear, so it's best to avoid superfluous punctuation or symbols where possible. - -If a default value is specified for a selection field, it must exactly match one of the provided choices. The value of a multiple selection field will always return a list, even if only one value is selected. - -### Custom Object Fields - -An object or multi-object custom field can be used to refer to a particular NetBox object or objects as the "value" for a custom field. These custom fields must define an `object_type`, which determines the type of object to which custom field instances point. - - -## Custom Fields in Templates - -Several features within NetBox, such as export templates and webhooks, utilize Jinja2 templating. For convenience, objects which support custom field assignment expose custom field data through the `cf` property. This is a bit cleaner than accessing custom field data through the actual field (`custom_field_data`). - -For example, a custom field named `foo123` on the Site model is accessible on an instance as `{{ site.cf.foo123 }}`. - -## Custom Fields and the REST API - -When retrieving an object via the REST API, all of its custom data will be included within the `custom_fields` attribute. For example, below is the partial output of a site with two custom fields defined: - -```json -{ - "id": 123, - "url": "http://localhost:8000/api/dcim/sites/123/", - "name": "Raleigh 42", - ... - "custom_fields": { - "deployed": "2018-06-19", - "site_code": "US-NC-RAL42" - }, - ... -``` - -To set or change these values, simply include nested JSON data. For example: - -```json -{ - "name": "New Site", - "slug": "new-site", - "custom_fields": { - "deployed": "2019-03-24" - } -} -``` diff --git a/docs/customization/custom-links.md b/docs/customization/custom-links.md index 16ba9d2af..e69de29bb 100644 --- a/docs/customization/custom-links.md +++ b/docs/customization/custom-links.md @@ -1,66 +0,0 @@ -# Custom Links - -Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related records in systems outside NetBox. For example, you might create a custom link on the device view which links to the current device in a Network Monitoring System (NMS). - -Custom links are created by navigating to Customization > Custom Links. Each link is associated with a particular NetBox object type (site, device, prefix, etc.) and will be displayed on relevant views. Each link has display text and a URL, and data from the NetBox item being viewed can be included in the link using [Jinja2 template code](https://jinja2docs.readthedocs.io/en/stable/) through the variable `obj`, and custom fields through `obj.cf`. - -For example, you might define a link like this: - -* Text: `View NMS` -* URL: `https://nms.example.com/nodes/?name={{ obj.name }}` - -When viewing a device named Router4, this link would render as: - -```no-highlight -View NMS -``` - -Custom links appear as buttons in the top right corner of the page. Numeric weighting can be used to influence the ordering of links, and each link can be enabled or disabled individually. - -!!! warning - Custom links rely on user-created code to generate arbitrary HTML output, which may be dangerous. Only grant permission to create or modify custom links to trusted users. - -## Context Data - -The following context data is available within the template when rendering a custom link's text or URL. - -| Variable | Description | -|-----------|-------------------------------------------------------------------------------------------------------------------| -| `object` | The NetBox object being displayed | -| `obj` | Same as `object`; maintained for backward compatability until NetBox v3.5 | -| `debug` | A boolean indicating whether debugging is enabled | -| `request` | The current WSGI request | -| `user` | The current user (if authenticated) | -| `perms` | The [permissions](https://docs.djangoproject.com/en/stable/topics/auth/default/#permissions) assigned to the user | - -While most of the context variables listed above will have consistent attributes, the object will be an instance of the specific object being viewed when the link is rendered. Different models have different fields and properties, so you may need to some research to determine the attributes available for use within your template for a specific object type. - -Checking the REST API representation of an object is generally a convenient way to determine what attributes are available. You can also reference the NetBox source code directly for a comprehensive list. - -## Conditional Rendering - -Only links which render with non-empty text are included on the page. You can employ conditional Jinja2 logic to control the conditions under which a link gets rendered. - -For example, if you only want to display a link for active devices, you could set the link text to - -```jinja2 -{% if obj.status == 'active' %}View NMS{% endif %} -``` - -The link will not appear when viewing a device with any status other than "active." - -As another example, if you wanted to show only devices belonging to a certain manufacturer, you could do something like this: - -```jinja2 -{% if obj.device_type.manufacturer.name == 'Cisco' %}View NMS{% endif %} -``` - -The link will only appear when viewing a device with a manufacturer name of "Cisco." - -## Link Groups - -Group names can be specified to organize links into groups. Links with the same group name will render as a dropdown menu beneath a single button bearing the name of the group. - -## Table Columns - -Custom links can also be included in object tables by selecting the desired links from the table configuration form. When displayed, each link will render as a hyperlink for its corresponding object. When exported (e.g. as CSV data), each link render only its URL. diff --git a/docs/customization/export-templates.md b/docs/customization/export-templates.md index 640a97531..e69de29bb 100644 --- a/docs/customization/export-templates.md +++ b/docs/customization/export-templates.md @@ -1,81 +0,0 @@ -# Export Templates - -NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Templates. - -Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list. Each export template must have a name, and may optionally designate a specific export [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) and/or file extension. - -Export templates must be written in [Jinja2](https://jinja.palletsprojects.com/). - -!!! note - The name `table` is reserved for internal use. - -!!! warning - Export templates are rendered using user-submitted code, which may pose security risks under certain conditions. Only grant permission to create or modify export templates to trusted users. - -The list of objects returned from the database when rendering an export template is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example: - -```jinja2 -{% for rack in queryset %} -Rack: {{ rack.name }} -Site: {{ rack.site.name }} -Height: {{ rack.u_height }}U -{% endfor %} -``` - -To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`. - -If you need to use the config context data in an export template, you'll should use the function `get_config_context` to get all the config context data. For example: -``` -{% for server in queryset %} -{% set data = server.get_config_context() %} -{{ data.syslog }} -{% endfor %} -``` - -The `as_attachment` attribute of an export template controls its behavior when rendered. If true, the rendered content will be returned to the user as a downloadable file. If false, it will be displayed within the browser. (This may be handy e.g. for generating HTML content.) - -A MIME type and file extension can optionally be defined for each export template. The default MIME type is `text/plain`. - - -## REST API Integration - -When it is necessary to provide authentication credentials (such as when [`LOGIN_REQUIRED`](../configuration/security.md#login_required) has been enabled), it is recommended to render export templates via the REST API. This allows the client to specify an authentication token. To render an export template via the REST API, make a `GET` request to the model's list endpoint and append the `export` parameter specifying the export template name. For example: - -``` -GET /api/dcim/sites/?export=MyTemplateName -``` - -Note that the body of the response will contain only the rendered export template content, as opposed to a JSON object or list. - -## Example - -Here's an example device export template that will generate a simple Nagios configuration from a list of devices. - -``` -{% for device in queryset %}{% if device.status and device.primary_ip %}define host{ - use generic-switch - host_name {{ device.name }} - address {{ device.primary_ip.address.ip }} -} -{% endif %}{% endfor %} -``` - -The generated output will look something like this: - -``` -define host{ - use generic-switch - host_name switch1 - address 192.0.2.1 -} -define host{ - use generic-switch - host_name switch2 - address 192.0.2.2 -} -define host{ - use generic-switch - host_name switch3 - address 192.0.2.3 -} -``` diff --git a/docs/integrations/webhooks.md b/docs/integrations/webhooks.md index 4705243d1..e69de29bb 100644 --- a/docs/integrations/webhooks.md +++ b/docs/integrations/webhooks.md @@ -1,139 +0,0 @@ -# Webhooks - -A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver. Webhooks are managed under Logging > Webhooks. - -!!! warning - Webhooks support the inclusion of user-submitted code to generate URL, custom headers and payloads, which may pose security risks under certain conditions. Only grant permission to create or modify webhooks to trusted users. - -## Configuration - -* **Name** - A unique name for the webhook. The name is not included with outbound messages. -* **Object type(s)** - The type or types of NetBox object that will trigger the webhook. -* **Enabled** - If unchecked, the webhook will be inactive. -* **Events** - A webhook may trigger on any combination of create, update, and delete events. At least one event type must be selected. -* **HTTP method** - The type of HTTP request to send. Options include `GET`, `POST`, `PUT`, `PATCH`, and `DELETE`. -* **URL** - The fully-qualified URL of the request to be sent. This may specify a destination port number if needed. Jinja2 templating is supported for this field. -* **HTTP content type** - The value of the request's `Content-Type` header. (Defaults to `application/json`) -* **Additional headers** - Any additional headers to include with the request (optional). Add one header per line in the format `Name: Value`. Jinja2 templating is supported for this field (see below). -* **Body template** - The content of the request being sent (optional). Jinja2 templating is supported for this field (see below). If blank, NetBox will populate the request body with a raw dump of the webhook context. (If the HTTP cotent type is set to `application/json`, this will be formatted as a JSON object.) -* **Secret** - A secret string used to prove authenticity of the request (optional). This will append a `X-Hook-Signature` header to the request, consisting of a HMAC (SHA-512) hex digest of the request body using the secret as the key. -* **Conditions** - An optional set of conditions evaluated to determine whether the webhook fires for a given object. -* **SSL verification** - Uncheck this option to disable validation of the receiver's SSL certificate. (Disable with caution!) -* **CA file path** - The file path to a particular certificate authority (CA) file to use when validating the receiver's SSL certificate (optional). - -## Jinja2 Template Support - -[Jinja2 templating](https://jinja.palletsprojects.com/) is supported for the `URL`, `additional_headers` and `body_template` fields. This enables the user to convey object data in the request headers as well as to craft a customized request body. Request content can be crafted to enable the direct interaction with external systems by ensuring the outgoing message is in a format the receiver expects and understands. - -For example, you might create a NetBox webhook to [trigger a Slack message](https://api.slack.com/messaging/webhooks) any time an IP address is created. You can accomplish this using the following configuration: - -* Object type: IPAM > IP address -* HTTP method: `POST` -* URL: Slack incoming webhook URL -* HTTP content type: `application/json` -* Body template: `{"text": "IP address {{ data['address'] }} was created by {{ username }}!"}` - -### Available Context - -The following data is available as context for Jinja2 templates: - -* `event` - The type of event which triggered the webhook: created, updated, or deleted. -* `model` - The NetBox model which triggered the change. -* `timestamp` - The time at which the event occurred (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format). -* `username` - The name of the user account associated with the change. -* `request_id` - The unique request ID. This may be used to correlate multiple changes associated with a single request. -* `data` - A detailed representation of the object in its current state. This is typically equivalent to the model's representation in NetBox's REST API. -* `snapshots` - Minimal "snapshots" of the object state both before and after the change was made; provided as a dictionary with keys named `prechange` and `postchange`. These are not as extensive as the fully serialized representation, but contain enough information to convey what has changed. - -### Default Request Body - -If no body template is specified, the request body will be populated with a JSON object containing the context data. For example, a newly created site might appear as follows: - -```json -{ - "event": "created", - "timestamp": "2021-03-09 17:55:33.968016+00:00", - "model": "site", - "username": "jstretch", - "request_id": "fdbca812-3142-4783-b364-2e2bd5c16c6a", - "data": { - "id": 19, - "name": "Site 1", - "slug": "site-1", - "status": - "value": "active", - "label": "Active", - "id": 1 - }, - "region": null, - ... - }, - "snapshots": { - "prechange": null, - "postchange": { - "created": "2021-03-09", - "last_updated": "2021-03-09T17:55:33.851Z", - "name": "Site 1", - "slug": "site-1", - "status": "active", - ... - } - } -} -``` - -## Conditional Webhooks - -A webhook may include a set of conditional logic expressed in JSON used to control whether a webhook triggers for a specific object. For example, you may wish to trigger a webhook for devices only when the `status` field of an object is "active": - -```json -{ - "and": [ - { - "attr": "status.value", - "value": "active" - } - ] -} -``` - -For more detail, see the reference documentation for NetBox's [conditional logic](../reference/conditions.md). - -## Webhook Processing - -When a change is detected, any resulting webhooks are placed into a Redis queue for processing. This allows the user's request to complete without needing to wait for the outgoing webhook(s) to be processed. The webhooks are then extracted from the queue by the `rqworker` process and HTTP requests are sent to their respective destinations. The current webhook queue and any failed webhooks can be inspected in the admin UI under System > Background Tasks. - -A request is considered successful if the response has a 2XX status code; otherwise, the request is marked as having failed. Failed requests may be retried manually via the admin UI. - -## Troubleshooting - -To assist with verifying that the content of outgoing webhooks is rendered correctly, NetBox provides a simple HTTP listener that can be run locally to receive and display webhook requests. First, modify the target URL of the desired webhook to `http://localhost:9000/`. This will instruct NetBox to send the request to the local server on TCP port 9000. Then, start the webhook receiver service from the NetBox root directory: - -```no-highlight -$ python netbox/manage.py webhook_receiver -Listening on port http://localhost:9000. Stop with CONTROL-C. -``` - -You can test the receiver itself by sending any HTTP request to it. For example: - -```no-highlight -$ curl -X POST http://localhost:9000 --data '{"foo": "bar"}' -``` - -The server will print output similar to the following: - -```no-highlight -[1] Tue, 07 Apr 2020 17:44:02 GMT 127.0.0.1 "POST / HTTP/1.1" 200 - -Host: localhost:9000 -User-Agent: curl/7.58.0 -Accept: */* -Content-Length: 14 -Content-Type: application/x-www-form-urlencoded - -{"foo": "bar"} ------------- -``` - -Note that `webhook_receiver` does not actually _do_ anything with the information received: It merely prints the request headers and body for inspection. - -Now, when the NetBox webhook is triggered and processed, you should see its headers and content appear in the terminal where the webhook receiver is listening. If you don't, check that the `rqworker` process is running and that webhook events are being placed into the queue (visible under the NetBox admin UI). diff --git a/docs/models/extras/customfield.md b/docs/models/extras/customfield.md new file mode 100644 index 000000000..bfe412edc --- /dev/null +++ b/docs/models/extras/customfield.md @@ -0,0 +1,109 @@ +# Custom Fields + +Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, sites are stored in the `dcim_site` table, which has columns named `name`, `facility`, `physical_address`, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows. + +However, some users might want to store additional object attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number correlating it with an internal support system record. This is certainly a legitimate use for NetBox, but it's not a common enough need to warrant including a field for _every_ NetBox installation. Instead, you can create a custom field to hold this data. + +Within the database, custom fields are stored as JSON data directly alongside each object. This alleviates the need for complex queries when retrieving objects. + +## Creating Custom Fields + +Custom fields may be created by navigating to Customization > Custom Fields. NetBox supports six types of custom field: + +* Text: Free-form text (intended for single-line use) +* Long text: Free-form of any length; supports Markdown rendering +* Integer: A whole number (positive or negative) +* Boolean: True or false +* Date: A date in ISO 8601 format (YYYY-MM-DD) +* URL: This will be presented as a link in the web UI +* JSON: Arbitrary data stored in JSON format +* Selection: A selection of one of several pre-defined custom choices +* Multiple selection: A selection field which supports the assignment of multiple values +* Object: A single NetBox object of the type defined by `object_type` +* Multiple object: One or more NetBox objects of the type defined by `object_type` + +Each custom field must have a name. This should be a simple database-friendly string (e.g. `tps_report`) and may contain only alphanumeric characters and underscores. You may also assign a corresponding human-friendly label (e.g. "TPS report"); the label will be displayed on web forms. A weight is also required: Higher-weight fields will be ordered lower within a form. (The default weight is 100.) If a description is provided, it will appear beneath the field in a form. + +Marking a field as required will force the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields, or the exact value of a choice for selection fields. + +A custom field must be assigned to one or more object types, or models, in NetBox. Once created, custom fields will automatically appear as part of these models in the web UI and REST API. Note that not all models support custom fields. + +### Filtering + +The filter logic controls how values are matched when filtering objects by the custom field. Loose filtering (the default) matches on a partial value, whereas exact matching requires a complete match of the given string to a field's value. For example, exact filtering with the string "red" will only match the exact value "red", whereas loose filtering will match on the values "red", "red-orange", or "bored". Setting the filter logic to "disabled" disables filtering by the field entirely. + +### Grouping + +!!! note + This feature was introduced in NetBox v3.3. + +Related custom fields can be grouped together within the UI by assigning each the same group name. When at least one custom field for an object type has a group defined, it will appear under the group heading within the custom fields panel under the object view. All custom fields with the same group name will appear under that heading. (Note that the group names must match exactly, or each will appear as a separate heading.) + +This parameter has no effect on the API representation of custom field data. + +### Visibility + +!!! note + This feature was introduced in NetBox v3.3. + +When creating a custom field, there are three options for UI visibility. These control how and whether the custom field is displayed within the NetBox UI. + +* **Read/write** (default): The custom field is included when viewing and editing objects. +* **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.) +* **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users. + +Note that this setting has no impact on the REST or GraphQL APIs: Custom field data will always be available via either API. + +### Validation + +NetBox supports limited custom validation for custom field values. Following are the types of validation enforced for each field type: + +* Text: Regular expression (optional) +* Integer: Minimum and/or maximum value (optional) +* Selection: Must exactly match one of the prescribed choices + +### Custom Selection Fields + +Each custom selection field must have at least two choices. These are specified as a comma-separated list. Choices appear in forms in the order they are listed. Note that choice values are saved exactly as they appear, so it's best to avoid superfluous punctuation or symbols where possible. + +If a default value is specified for a selection field, it must exactly match one of the provided choices. The value of a multiple selection field will always return a list, even if only one value is selected. + +### Custom Object Fields + +An object or multi-object custom field can be used to refer to a particular NetBox object or objects as the "value" for a custom field. These custom fields must define an `object_type`, which determines the type of object to which custom field instances point. + + +## Custom Fields in Templates + +Several features within NetBox, such as export templates and webhooks, utilize Jinja2 templating. For convenience, objects which support custom field assignment expose custom field data through the `cf` property. This is a bit cleaner than accessing custom field data through the actual field (`custom_field_data`). + +For example, a custom field named `foo123` on the Site model is accessible on an instance as `{{ site.cf.foo123 }}`. + +## Custom Fields and the REST API + +When retrieving an object via the REST API, all of its custom data will be included within the `custom_fields` attribute. For example, below is the partial output of a site with two custom fields defined: + +```json +{ + "id": 123, + "url": "http://localhost:8000/api/dcim/sites/123/", + "name": "Raleigh 42", + ... + "custom_fields": { + "deployed": "2018-06-19", + "site_code": "US-NC-RAL42" + }, + ... +``` + +To set or change these values, simply include nested JSON data. For example: + +```json +{ + "name": "New Site", + "slug": "new-site", + "custom_fields": { + "deployed": "2019-03-24" + } +} +``` diff --git a/docs/models/extras/customlink.md b/docs/models/extras/customlink.md new file mode 100644 index 000000000..16ba9d2af --- /dev/null +++ b/docs/models/extras/customlink.md @@ -0,0 +1,66 @@ +# Custom Links + +Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related records in systems outside NetBox. For example, you might create a custom link on the device view which links to the current device in a Network Monitoring System (NMS). + +Custom links are created by navigating to Customization > Custom Links. Each link is associated with a particular NetBox object type (site, device, prefix, etc.) and will be displayed on relevant views. Each link has display text and a URL, and data from the NetBox item being viewed can be included in the link using [Jinja2 template code](https://jinja2docs.readthedocs.io/en/stable/) through the variable `obj`, and custom fields through `obj.cf`. + +For example, you might define a link like this: + +* Text: `View NMS` +* URL: `https://nms.example.com/nodes/?name={{ obj.name }}` + +When viewing a device named Router4, this link would render as: + +```no-highlight +View NMS +``` + +Custom links appear as buttons in the top right corner of the page. Numeric weighting can be used to influence the ordering of links, and each link can be enabled or disabled individually. + +!!! warning + Custom links rely on user-created code to generate arbitrary HTML output, which may be dangerous. Only grant permission to create or modify custom links to trusted users. + +## Context Data + +The following context data is available within the template when rendering a custom link's text or URL. + +| Variable | Description | +|-----------|-------------------------------------------------------------------------------------------------------------------| +| `object` | The NetBox object being displayed | +| `obj` | Same as `object`; maintained for backward compatability until NetBox v3.5 | +| `debug` | A boolean indicating whether debugging is enabled | +| `request` | The current WSGI request | +| `user` | The current user (if authenticated) | +| `perms` | The [permissions](https://docs.djangoproject.com/en/stable/topics/auth/default/#permissions) assigned to the user | + +While most of the context variables listed above will have consistent attributes, the object will be an instance of the specific object being viewed when the link is rendered. Different models have different fields and properties, so you may need to some research to determine the attributes available for use within your template for a specific object type. + +Checking the REST API representation of an object is generally a convenient way to determine what attributes are available. You can also reference the NetBox source code directly for a comprehensive list. + +## Conditional Rendering + +Only links which render with non-empty text are included on the page. You can employ conditional Jinja2 logic to control the conditions under which a link gets rendered. + +For example, if you only want to display a link for active devices, you could set the link text to + +```jinja2 +{% if obj.status == 'active' %}View NMS{% endif %} +``` + +The link will not appear when viewing a device with any status other than "active." + +As another example, if you wanted to show only devices belonging to a certain manufacturer, you could do something like this: + +```jinja2 +{% if obj.device_type.manufacturer.name == 'Cisco' %}View NMS{% endif %} +``` + +The link will only appear when viewing a device with a manufacturer name of "Cisco." + +## Link Groups + +Group names can be specified to organize links into groups. Links with the same group name will render as a dropdown menu beneath a single button bearing the name of the group. + +## Table Columns + +Custom links can also be included in object tables by selecting the desired links from the table configuration form. When displayed, each link will render as a hyperlink for its corresponding object. When exported (e.g. as CSV data), each link render only its URL. diff --git a/docs/models/extras/exporttemplate.md b/docs/models/extras/exporttemplate.md new file mode 100644 index 000000000..b4b69108a --- /dev/null +++ b/docs/models/extras/exporttemplate.md @@ -0,0 +1,81 @@ +# Export Templates + +NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Templates. + +Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list. Each export template must have a name, and may optionally designate a specific export [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) and/or file extension. + +Export templates must be written in [Jinja2](https://jinja.palletsprojects.com/). + +!!! note + The name `table` is reserved for internal use. + +!!! warning + Export templates are rendered using user-submitted code, which may pose security risks under certain conditions. Only grant permission to create or modify export templates to trusted users. + +The list of objects returned from the database when rendering an export template is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example: + +```jinja2 +{% for rack in queryset %} +Rack: {{ rack.name }} +Site: {{ rack.site.name }} +Height: {{ rack.u_height }}U +{% endfor %} +``` + +To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`. + +If you need to use the config context data in an export template, you'll should use the function `get_config_context` to get all the config context data. For example: +``` +{% for server in queryset %} +{% set data = server.get_config_context() %} +{{ data.syslog }} +{% endfor %} +``` + +The `as_attachment` attribute of an export template controls its behavior when rendered. If true, the rendered content will be returned to the user as a downloadable file. If false, it will be displayed within the browser. (This may be handy e.g. for generating HTML content.) + +A MIME type and file extension can optionally be defined for each export template. The default MIME type is `text/plain`. + + +## REST API Integration + +When it is necessary to provide authentication credentials (such as when [`LOGIN_REQUIRED`](../../configuration/security.md#login_required) has been enabled), it is recommended to render export templates via the REST API. This allows the client to specify an authentication token. To render an export template via the REST API, make a `GET` request to the model's list endpoint and append the `export` parameter specifying the export template name. For example: + +``` +GET /api/dcim/sites/?export=MyTemplateName +``` + +Note that the body of the response will contain only the rendered export template content, as opposed to a JSON object or list. + +## Example + +Here's an example device export template that will generate a simple Nagios configuration from a list of devices. + +``` +{% for device in queryset %}{% if device.status and device.primary_ip %}define host{ + use generic-switch + host_name {{ device.name }} + address {{ device.primary_ip.address.ip }} +} +{% endif %}{% endfor %} +``` + +The generated output will look something like this: + +``` +define host{ + use generic-switch + host_name switch1 + address 192.0.2.1 +} +define host{ + use generic-switch + host_name switch2 + address 192.0.2.2 +} +define host{ + use generic-switch + host_name switch3 + address 192.0.2.3 +} +``` diff --git a/docs/models/extras/imageattachment.md b/docs/models/extras/imageattachment.md new file mode 100644 index 000000000..da15462ab --- /dev/null +++ b/docs/models/extras/imageattachment.md @@ -0,0 +1,3 @@ +# Image Attachments + +Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. diff --git a/docs/models/extras/webhook.md b/docs/models/extras/webhook.md new file mode 100644 index 000000000..427ae3dd1 --- /dev/null +++ b/docs/models/extras/webhook.md @@ -0,0 +1,139 @@ +# Webhooks + +A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver. Webhooks are managed under Logging > Webhooks. + +!!! warning + Webhooks support the inclusion of user-submitted code to generate URL, custom headers and payloads, which may pose security risks under certain conditions. Only grant permission to create or modify webhooks to trusted users. + +## Configuration + +* **Name** - A unique name for the webhook. The name is not included with outbound messages. +* **Object type(s)** - The type or types of NetBox object that will trigger the webhook. +* **Enabled** - If unchecked, the webhook will be inactive. +* **Events** - A webhook may trigger on any combination of create, update, and delete events. At least one event type must be selected. +* **HTTP method** - The type of HTTP request to send. Options include `GET`, `POST`, `PUT`, `PATCH`, and `DELETE`. +* **URL** - The fully-qualified URL of the request to be sent. This may specify a destination port number if needed. Jinja2 templating is supported for this field. +* **HTTP content type** - The value of the request's `Content-Type` header. (Defaults to `application/json`) +* **Additional headers** - Any additional headers to include with the request (optional). Add one header per line in the format `Name: Value`. Jinja2 templating is supported for this field (see below). +* **Body template** - The content of the request being sent (optional). Jinja2 templating is supported for this field (see below). If blank, NetBox will populate the request body with a raw dump of the webhook context. (If the HTTP cotent type is set to `application/json`, this will be formatted as a JSON object.) +* **Secret** - A secret string used to prove authenticity of the request (optional). This will append a `X-Hook-Signature` header to the request, consisting of a HMAC (SHA-512) hex digest of the request body using the secret as the key. +* **Conditions** - An optional set of conditions evaluated to determine whether the webhook fires for a given object. +* **SSL verification** - Uncheck this option to disable validation of the receiver's SSL certificate. (Disable with caution!) +* **CA file path** - The file path to a particular certificate authority (CA) file to use when validating the receiver's SSL certificate (optional). + +## Jinja2 Template Support + +[Jinja2 templating](https://jinja.palletsprojects.com/) is supported for the `URL`, `additional_headers` and `body_template` fields. This enables the user to convey object data in the request headers as well as to craft a customized request body. Request content can be crafted to enable the direct interaction with external systems by ensuring the outgoing message is in a format the receiver expects and understands. + +For example, you might create a NetBox webhook to [trigger a Slack message](https://api.slack.com/messaging/webhooks) any time an IP address is created. You can accomplish this using the following configuration: + +* Object type: IPAM > IP address +* HTTP method: `POST` +* URL: Slack incoming webhook URL +* HTTP content type: `application/json` +* Body template: `{"text": "IP address {{ data['address'] }} was created by {{ username }}!"}` + +### Available Context + +The following data is available as context for Jinja2 templates: + +* `event` - The type of event which triggered the webhook: created, updated, or deleted. +* `model` - The NetBox model which triggered the change. +* `timestamp` - The time at which the event occurred (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format). +* `username` - The name of the user account associated with the change. +* `request_id` - The unique request ID. This may be used to correlate multiple changes associated with a single request. +* `data` - A detailed representation of the object in its current state. This is typically equivalent to the model's representation in NetBox's REST API. +* `snapshots` - Minimal "snapshots" of the object state both before and after the change was made; provided as a dictionary with keys named `prechange` and `postchange`. These are not as extensive as the fully serialized representation, but contain enough information to convey what has changed. + +### Default Request Body + +If no body template is specified, the request body will be populated with a JSON object containing the context data. For example, a newly created site might appear as follows: + +```json +{ + "event": "created", + "timestamp": "2021-03-09 17:55:33.968016+00:00", + "model": "site", + "username": "jstretch", + "request_id": "fdbca812-3142-4783-b364-2e2bd5c16c6a", + "data": { + "id": 19, + "name": "Site 1", + "slug": "site-1", + "status": + "value": "active", + "label": "Active", + "id": 1 + }, + "region": null, + ... + }, + "snapshots": { + "prechange": null, + "postchange": { + "created": "2021-03-09", + "last_updated": "2021-03-09T17:55:33.851Z", + "name": "Site 1", + "slug": "site-1", + "status": "active", + ... + } + } +} +``` + +## Conditional Webhooks + +A webhook may include a set of conditional logic expressed in JSON used to control whether a webhook triggers for a specific object. For example, you may wish to trigger a webhook for devices only when the `status` field of an object is "active": + +```json +{ + "and": [ + { + "attr": "status.value", + "value": "active" + } + ] +} +``` + +For more detail, see the reference documentation for NetBox's [conditional logic](../../reference/conditions.md). + +## Webhook Processing + +When a change is detected, any resulting webhooks are placed into a Redis queue for processing. This allows the user's request to complete without needing to wait for the outgoing webhook(s) to be processed. The webhooks are then extracted from the queue by the `rqworker` process and HTTP requests are sent to their respective destinations. The current webhook queue and any failed webhooks can be inspected in the admin UI under System > Background Tasks. + +A request is considered successful if the response has a 2XX status code; otherwise, the request is marked as having failed. Failed requests may be retried manually via the admin UI. + +## Troubleshooting + +To assist with verifying that the content of outgoing webhooks is rendered correctly, NetBox provides a simple HTTP listener that can be run locally to receive and display webhook requests. First, modify the target URL of the desired webhook to `http://localhost:9000/`. This will instruct NetBox to send the request to the local server on TCP port 9000. Then, start the webhook receiver service from the NetBox root directory: + +```no-highlight +$ python netbox/manage.py webhook_receiver +Listening on port http://localhost:9000. Stop with CONTROL-C. +``` + +You can test the receiver itself by sending any HTTP request to it. For example: + +```no-highlight +$ curl -X POST http://localhost:9000 --data '{"foo": "bar"}' +``` + +The server will print output similar to the following: + +```no-highlight +[1] Tue, 07 Apr 2020 17:44:02 GMT 127.0.0.1 "POST / HTTP/1.1" 200 - +Host: localhost:9000 +User-Agent: curl/7.58.0 +Accept: */* +Content-Length: 14 +Content-Type: application/x-www-form-urlencoded + +{"foo": "bar"} +------------ +``` + +Note that `webhook_receiver` does not actually _do_ anything with the information received: It merely prints the request headers and body for inspection. + +Now, when the NetBox webhook is triggered and processed, you should see its headers and content appear in the terminal where the webhook receiver is listening. If you don't, check that the `rqworker` process is running and that webhook events are being placed into the queue (visible under the NetBox admin UI). diff --git a/mkdocs.yml b/mkdocs.yml index 95672cede..a5eb36d81 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -191,7 +191,12 @@ nav: - VirtualChassis: 'models/dcim/virtualchassis.md' - Extras: - ConfigContext: 'models/extras/configcontext.md' + - CustomField: 'models/extras/customfield.md' + - CustomLink: 'models/extras/customlink.md' + - ExportTemplate: 'models/extras/exporttemplate.md' + - ImageAttachment: 'models/extras/imageattachment.md' - Tag: 'models/extras/tag.md' + - Webhook: 'models/extras/webhook.md' - IPAM: - ASN: 'models/ipam/asn.md' - Aggregate: 'models/ipam/aggregate.md' From a7b78565a199c6c5d1459decdd0d0019a743e974 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 11 Aug 2022 11:55:45 -0400 Subject: [PATCH 373/593] Split webhooks documentation --- docs/integrations/webhooks.md | 127 ++++++++++++++++++++++++++++++++++ docs/models/extras/webhook.md | 122 +------------------------------- 2 files changed, 128 insertions(+), 121 deletions(-) diff --git a/docs/integrations/webhooks.md b/docs/integrations/webhooks.md index e69de29bb..3ef28fb11 100644 --- a/docs/integrations/webhooks.md +++ b/docs/integrations/webhooks.md @@ -0,0 +1,127 @@ +# Webhooks + +NetBox can be configured to transmit outgoing webhooks to remote systems in response to internal object changes. The receiver can act on the data in these webhook messages to perform related tasks. + +For example, suppose you want to automatically configure a monitoring system to start monitoring a device when its operational status is changed to active, and remove it from monitoring for any other status. You can create a webhook in NetBox for the device model and craft its content and destination URL to effect the desired change on the receiving system. Webhooks will be sent automatically by NetBox whenever the configured constraints are met. + +Each webhook must be associated with at least one NetBox object type and at least one event (create, update, or delete). Users can specify the receiver URL, HTTP request type (`GET`, `POST`, etc.), content type, and headers. A request body can also be specified; if left blank, this will default to a serialized representation of the affected object. + +!!! warning "Security Notice" + Webhooks support the inclusion of user-submitted code to generate the URL, custom headers, and payloads, which may pose security risks under certain conditions. Only grant permission to create or modify webhooks to trusted users. + +## Jinja2 Template Support + +[Jinja2 templating](https://jinja.palletsprojects.com/) is supported for the `URL`, `additional_headers` and `body_template` fields. This enables the user to convey object data in the request headers as well as to craft a customized request body. Request content can be crafted to enable the direct interaction with external systems by ensuring the outgoing message is in a format the receiver expects and understands. + +For example, you might create a NetBox webhook to [trigger a Slack message](https://api.slack.com/messaging/webhooks) any time an IP address is created. You can accomplish this using the following configuration: + +* Object type: IPAM > IP address +* HTTP method: `POST` +* URL: Slack incoming webhook URL +* HTTP content type: `application/json` +* Body template: `{"text": "IP address {{ data['address'] }} was created by {{ username }}!"}` + +### Available Context + +The following data is available as context for Jinja2 templates: + +* `event` - The type of event which triggered the webhook: created, updated, or deleted. +* `model` - The NetBox model which triggered the change. +* `timestamp` - The time at which the event occurred (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format). +* `username` - The name of the user account associated with the change. +* `request_id` - The unique request ID. This may be used to correlate multiple changes associated with a single request. +* `data` - A detailed representation of the object in its current state. This is typically equivalent to the model's representation in NetBox's REST API. +* `snapshots` - Minimal "snapshots" of the object state both before and after the change was made; provided as a dictionary with keys named `prechange` and `postchange`. These are not as extensive as the fully serialized representation, but contain enough information to convey what has changed. + +### Default Request Body + +If no body template is specified, the request body will be populated with a JSON object containing the context data. For example, a newly created site might appear as follows: + +```json +{ + "event": "created", + "timestamp": "2021-03-09 17:55:33.968016+00:00", + "model": "site", + "username": "jstretch", + "request_id": "fdbca812-3142-4783-b364-2e2bd5c16c6a", + "data": { + "id": 19, + "name": "Site 1", + "slug": "site-1", + "status": + "value": "active", + "label": "Active", + "id": 1 + }, + "region": null, + ... + }, + "snapshots": { + "prechange": null, + "postchange": { + "created": "2021-03-09", + "last_updated": "2021-03-09T17:55:33.851Z", + "name": "Site 1", + "slug": "site-1", + "status": "active", + ... + } + } +} +``` + +## Conditional Webhooks + +A webhook may include a set of conditional logic expressed in JSON used to control whether a webhook triggers for a specific object. For example, you may wish to trigger a webhook for devices only when the `status` field of an object is "active": + +```json +{ + "and": [ + { + "attr": "status.value", + "value": "active" + } + ] +} +``` + +For more detail, see the reference documentation for NetBox's [conditional logic](../../reference/conditions.md). + +## Webhook Processing + +When a change is detected, any resulting webhooks are placed into a Redis queue for processing. This allows the user's request to complete without needing to wait for the outgoing webhook(s) to be processed. The webhooks are then extracted from the queue by the `rqworker` process and HTTP requests are sent to their respective destinations. The current webhook queue and any failed webhooks can be inspected in the admin UI under System > Background Tasks. + +A request is considered successful if the response has a 2XX status code; otherwise, the request is marked as having failed. Failed requests may be retried manually via the admin UI. + +## Troubleshooting + +To assist with verifying that the content of outgoing webhooks is rendered correctly, NetBox provides a simple HTTP listener that can be run locally to receive and display webhook requests. First, modify the target URL of the desired webhook to `http://localhost:9000/`. This will instruct NetBox to send the request to the local server on TCP port 9000. Then, start the webhook receiver service from the NetBox root directory: + +```no-highlight +$ python netbox/manage.py webhook_receiver +Listening on port http://localhost:9000. Stop with CONTROL-C. +``` + +You can test the receiver itself by sending any HTTP request to it. For example: + +```no-highlight +$ curl -X POST http://localhost:9000 --data '{"foo": "bar"}' +``` + +The server will print output similar to the following: + +```no-highlight +[1] Tue, 07 Apr 2020 17:44:02 GMT 127.0.0.1 "POST / HTTP/1.1" 200 - +Host: localhost:9000 +User-Agent: curl/7.58.0 +Accept: */* +Content-Length: 14 +Content-Type: application/x-www-form-urlencoded + +{"foo": "bar"} +------------ +``` + +Note that `webhook_receiver` does not actually _do_ anything with the information received: It merely prints the request headers and body for inspection. + +Now, when the NetBox webhook is triggered and processed, you should see its headers and content appear in the terminal where the webhook receiver is listening. If you don't, check that the `rqworker` process is running and that webhook events are being placed into the queue (visible under the NetBox admin UI). diff --git a/docs/models/extras/webhook.md b/docs/models/extras/webhook.md index 427ae3dd1..2d598f8ae 100644 --- a/docs/models/extras/webhook.md +++ b/docs/models/extras/webhook.md @@ -2,10 +2,7 @@ A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver. Webhooks are managed under Logging > Webhooks. -!!! warning - Webhooks support the inclusion of user-submitted code to generate URL, custom headers and payloads, which may pose security risks under certain conditions. Only grant permission to create or modify webhooks to trusted users. - -## Configuration +## Model Fields * **Name** - A unique name for the webhook. The name is not included with outbound messages. * **Object type(s)** - The type or types of NetBox object that will trigger the webhook. @@ -20,120 +17,3 @@ A webhook is a mechanism for conveying to some external system a change that too * **Conditions** - An optional set of conditions evaluated to determine whether the webhook fires for a given object. * **SSL verification** - Uncheck this option to disable validation of the receiver's SSL certificate. (Disable with caution!) * **CA file path** - The file path to a particular certificate authority (CA) file to use when validating the receiver's SSL certificate (optional). - -## Jinja2 Template Support - -[Jinja2 templating](https://jinja.palletsprojects.com/) is supported for the `URL`, `additional_headers` and `body_template` fields. This enables the user to convey object data in the request headers as well as to craft a customized request body. Request content can be crafted to enable the direct interaction with external systems by ensuring the outgoing message is in a format the receiver expects and understands. - -For example, you might create a NetBox webhook to [trigger a Slack message](https://api.slack.com/messaging/webhooks) any time an IP address is created. You can accomplish this using the following configuration: - -* Object type: IPAM > IP address -* HTTP method: `POST` -* URL: Slack incoming webhook URL -* HTTP content type: `application/json` -* Body template: `{"text": "IP address {{ data['address'] }} was created by {{ username }}!"}` - -### Available Context - -The following data is available as context for Jinja2 templates: - -* `event` - The type of event which triggered the webhook: created, updated, or deleted. -* `model` - The NetBox model which triggered the change. -* `timestamp` - The time at which the event occurred (in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format). -* `username` - The name of the user account associated with the change. -* `request_id` - The unique request ID. This may be used to correlate multiple changes associated with a single request. -* `data` - A detailed representation of the object in its current state. This is typically equivalent to the model's representation in NetBox's REST API. -* `snapshots` - Minimal "snapshots" of the object state both before and after the change was made; provided as a dictionary with keys named `prechange` and `postchange`. These are not as extensive as the fully serialized representation, but contain enough information to convey what has changed. - -### Default Request Body - -If no body template is specified, the request body will be populated with a JSON object containing the context data. For example, a newly created site might appear as follows: - -```json -{ - "event": "created", - "timestamp": "2021-03-09 17:55:33.968016+00:00", - "model": "site", - "username": "jstretch", - "request_id": "fdbca812-3142-4783-b364-2e2bd5c16c6a", - "data": { - "id": 19, - "name": "Site 1", - "slug": "site-1", - "status": - "value": "active", - "label": "Active", - "id": 1 - }, - "region": null, - ... - }, - "snapshots": { - "prechange": null, - "postchange": { - "created": "2021-03-09", - "last_updated": "2021-03-09T17:55:33.851Z", - "name": "Site 1", - "slug": "site-1", - "status": "active", - ... - } - } -} -``` - -## Conditional Webhooks - -A webhook may include a set of conditional logic expressed in JSON used to control whether a webhook triggers for a specific object. For example, you may wish to trigger a webhook for devices only when the `status` field of an object is "active": - -```json -{ - "and": [ - { - "attr": "status.value", - "value": "active" - } - ] -} -``` - -For more detail, see the reference documentation for NetBox's [conditional logic](../../reference/conditions.md). - -## Webhook Processing - -When a change is detected, any resulting webhooks are placed into a Redis queue for processing. This allows the user's request to complete without needing to wait for the outgoing webhook(s) to be processed. The webhooks are then extracted from the queue by the `rqworker` process and HTTP requests are sent to their respective destinations. The current webhook queue and any failed webhooks can be inspected in the admin UI under System > Background Tasks. - -A request is considered successful if the response has a 2XX status code; otherwise, the request is marked as having failed. Failed requests may be retried manually via the admin UI. - -## Troubleshooting - -To assist with verifying that the content of outgoing webhooks is rendered correctly, NetBox provides a simple HTTP listener that can be run locally to receive and display webhook requests. First, modify the target URL of the desired webhook to `http://localhost:9000/`. This will instruct NetBox to send the request to the local server on TCP port 9000. Then, start the webhook receiver service from the NetBox root directory: - -```no-highlight -$ python netbox/manage.py webhook_receiver -Listening on port http://localhost:9000. Stop with CONTROL-C. -``` - -You can test the receiver itself by sending any HTTP request to it. For example: - -```no-highlight -$ curl -X POST http://localhost:9000 --data '{"foo": "bar"}' -``` - -The server will print output similar to the following: - -```no-highlight -[1] Tue, 07 Apr 2020 17:44:02 GMT 127.0.0.1 "POST / HTTP/1.1" 200 - -Host: localhost:9000 -User-Agent: curl/7.58.0 -Accept: */* -Content-Length: 14 -Content-Type: application/x-www-form-urlencoded - -{"foo": "bar"} ------------- -``` - -Note that `webhook_receiver` does not actually _do_ anything with the information received: It merely prints the request headers and body for inspection. - -Now, when the NetBox webhook is triggered and processed, you should see its headers and content appear in the terminal where the webhook receiver is listening. If you don't, check that the `rqworker` process is running and that webhook events are being placed into the queue (visible under the NetBox admin UI). From e2d53139403218ce47b46b8808580b174f1b3dc6 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 11 Aug 2022 13:02:37 -0400 Subject: [PATCH 374/593] Changelog for #9857 --- 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 598ee7874..e57cea3b3 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -6,6 +6,7 @@ * [#9161](https://github.com/netbox-community/netbox/issues/9161) - Pretty print JSON custom field data when editing * [#9625](https://github.com/netbox-community/netbox/issues/9625) - Add phone & email details to contacts panel +* [#9857](https://github.com/netbox-community/netbox/issues/9857) - Add clear button to quick search fields --- From 6a687a9ed1027e2819391076195138c7babf9400 Mon Sep 17 00:00:00 2001 From: Craig Pund Date: Thu, 11 Aug 2022 15:16:01 -0400 Subject: [PATCH 375/593] not necessary to prefetch --- netbox/dcim/views.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py index 28325bcfc..bd693e392 100644 --- a/netbox/dcim/views.py +++ b/netbox/dcim/views.py @@ -1787,7 +1787,7 @@ class DeviceBulkDeleteView(generic.BulkDeleteView): class DeviceBulkRenameView(generic.BulkRenameView): - queryset = Device.objects.prefetch_related('tenant', 'site', 'rack', 'device_role', 'device_type__manufacturer') + queryset = Device.objects.all() filterset = filtersets.DeviceFilterSet table = tables.DeviceTable From 5873ad95dc16db127298037b1af5093543583eff Mon Sep 17 00:00:00 2001 From: Craig Pund Date: Thu, 11 Aug 2022 15:16:42 -0400 Subject: [PATCH 376/593] handle objects without names --- netbox/netbox/views/generic/bulk_views.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/netbox/netbox/views/generic/bulk_views.py b/netbox/netbox/views/generic/bulk_views.py index f17bc179d..e1f73b225 100644 --- a/netbox/netbox/views/generic/bulk_views.py +++ b/netbox/netbox/views/generic/bulk_views.py @@ -632,7 +632,7 @@ class BulkRenameView(GetReturnURLMixin, BaseMultiObjectView): replace = form.cleaned_data['replace'] if form.cleaned_data['use_regex']: try: - obj.new_name = re.sub(find, replace, obj.name) + obj.new_name = re.sub(find, replace, obj.name or '') # Catch regex group reference errors except re.error: obj.new_name = obj.name @@ -676,9 +676,6 @@ class BulkRenameView(GetReturnURLMixin, BaseMultiObjectView): else: form = self.form(initial={'pk': request.POST.getlist('pk')}) selected_objects = self.queryset.filter(pk__in=form.initial['pk']) - for object in selected_objects: - # Do something to raise error message to user - pass return render(request, self.template_name, { 'form': form, From f9fb2cc69827559d7934718b3eb84806c278510b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 11 Aug 2022 15:29:26 -0400 Subject: [PATCH 377/593] Finish features documentation --- docs/development/models.md | 2 +- .../{integrations.md => api-integration.md} | 2 +- docs/features/authentication-permissions.md | 49 +++++++++++++++++++ docs/features/customization.md | 41 ++++++++++++++-- docs/features/permissions.md | 3 -- docs/features/sso.md | 3 -- docs/features/tags.md | 0 docs/integrations/webhooks.md | 2 +- mkdocs.yml | 10 ++-- 9 files changed, 92 insertions(+), 20 deletions(-) rename docs/features/{integrations.md => api-integration.md} (99%) create mode 100644 docs/features/authentication-permissions.md delete mode 100644 docs/features/permissions.md delete mode 100644 docs/features/sso.md delete mode 100644 docs/features/tags.md diff --git a/docs/development/models.md b/docs/development/models.md index 3c7aaaa78..3b03c8935 100644 --- a/docs/development/models.md +++ b/docs/development/models.md @@ -12,7 +12,7 @@ The Django [content types](https://docs.djangoproject.com/en/stable/ref/contrib/ * [Webhooks](../integrations/webhooks.md) - NetBox is capable of generating outgoing webhooks for these objects * [Custom fields](../customization/custom-fields.md) - These models support the addition of user-defined fields * [Export templates](../customization/export-templates.md) - Users can create custom export templates for these models -* [Tagging](../features/tags.md) - The models can be tagged with user-defined tags +* [Tagging](../models/extras/tag.md) - The models can be tagged with user-defined tags * [Journaling](../features/journaling.md) - These models support persistent historical commentary * Nesting - These models can be nested recursively to create a hierarchy diff --git a/docs/features/integrations.md b/docs/features/api-integration.md similarity index 99% rename from docs/features/integrations.md rename to docs/features/api-integration.md index c2f68c5c8..50c31ec4f 100644 --- a/docs/features/integrations.md +++ b/docs/features/api-integration.md @@ -1,4 +1,4 @@ -# Integrations +# API & Integration NetBox includes a slew of features which enable integration with other tools and resources powering your network. diff --git a/docs/features/authentication-permissions.md b/docs/features/authentication-permissions.md new file mode 100644 index 000000000..14e13d5cd --- /dev/null +++ b/docs/features/authentication-permissions.md @@ -0,0 +1,49 @@ +# Authentication & Permissions + +## Object-Based Permissions + +NetBox boasts a very robust permissions system which extends well beyond the model-based permissions of the underlying Django framework. Assigning permissions in NetBox involves several dimensions: + +* The type(s) of object to which the permission applies +* The users and/or groups being granted the permissions +* The action(s) permitted by the permission (e.g. view, add, change, etc.) +* Any constraints limiting application of the permission to a particular subset of objects + +The implementation of constrains is what enables NetBox administrators to assign per-object permissions: Users can be limited to viewing or interacting with arbitrary subsets of objects based on the objects' attributes. For example, you might restrict a particular user to viewing only those prefixes or IP addresses within a particular VRF. Or you might restrict a group to modifying devices within a particular region. + +Permission constraints are declared in JSON format when creating a permission, and operate very similarly to Django ORM queries. For instance, here's a constraint that matches reserved VLANs with a VLAN ID between 100 and 199: + +```json +[ + { + "vid__gte": 100, + "vid__lt": 200 + }, + { + "status": "reserved" + } +] +``` + +Check out the [permissions documentation](../administration/permissions.md) for more information about permission constraints. + +## LDAP Authentication + +NetBox includes a built-in authentication backend for authenticating users against a remote LDAP server. The [installation documentation](../installation/6-ldap.md) provides more detail on this capability. + +## Single Sign-On (SSO) + +NetBox integrates with the open source [python-social-auth](https://github.com/python-social-auth) library to provide [myriad options](https://python-social-auth.readthedocs.io/en/latest/backends/index.html#supported-backends) for single sign-on (SSO) authentication. These include: + +* Cognito +* GitHub & GitHub Enterprise +* GitLab +* Google +* Hashicorp Vault +* Keycloak +* Microsoft Azure AD +* Microsoft Graph +* Okta +* OIDC + +...and many others. It's also possible to build your own custom backends as needed using python-social-auth's base OAuth, OpenID, and SAML classes. You can find some examples of configuring SSO in NetBox' [authentication documentation](../administration/authentication/overview.md). diff --git a/docs/features/customization.md b/docs/features/customization.md index 5b42d5e43..d7f2cf40a 100644 --- a/docs/features/customization.md +++ b/docs/features/customization.md @@ -2,6 +2,10 @@ While NetBox strives to meet the needs of every network, the needs of users to cater to their own unique environments cannot be ignored. NetBox was built with this in mind, and can be customized in many ways to better suit your particular needs. +## Tags + +Most objects in NetBox can be assigned user-created tags to aid with organization and filtering. Tag values are completely arbitrary: They may be used to store data in key-value pairs, or they may be employed simply as labels against which objects can be filtered. Each tag can also be assigned a color for quicker differentiation in the user interface. + ## Custom Fields While NetBox provides a rather extensive data model out of the box, the need may arise to store certain additional data associated with NetBox objects. For example, you might need to record the invoice ID alongside an installed device, or record an approving authority when creating a new IP prefix. NetBox administrators can create custom fields on built-in objects to meet these needs. @@ -12,30 +16,57 @@ To learn more about this feature, check out the [custom field documentation](../ ## Custom Links -TODO +Custom links allow you to conveniently reference external resources related to NetBox objects from within the NetBox UI. For example, you might wish to link each virtual machine modeled in NetBox to its corresponding view in some orchestration application. You can do this by creating a templatized custom link for the virtual machine model, specifying something like the following for the link URL: + +```no-highlight +http://server.local/vms/?name={{ object.name }} +``` + +Now, when viewing a virtual machine in NetBox, a user will see a handy button with the chosen title and link (complete with the name of the VM being viewed). Both the text and URL of custom links can be templatized in this manner, and custom links can be grouped together into dropdowns for more efficient display. To learn more about this feature, check out the [custom link documentation](../customization/custom-links.md). ## Custom Validation -TODO +While NetBox employs robust built-in object validation to ensure the integrity of its database, you might wish to enforce additional rules governing the creation and modification of certain objects. For example, perhaps you require that every device defined in NetBox adheres to a particular naming scheme and includes an asset tag. You can configure a custom validation rule in NetBox to enforce these requirements for the device model: + +```python +CUSTOM_VALIDATORS = { + "dcim.device": [ + { + "name": { + "regex": "[a-z]+\d{3}" + }, + "asset_tag": { + "required": True + } + } + ] +} +``` To learn more about this feature, check out the [custom validation documentation](../customization/custom-validation.md). ## Export Templates -TODO +Most NetBox objects can be exported in bulk in two built-in CSV formats: The current view (what the user currently sees in the objects list), or all available data. NetBox also provides the capability to define your own custom data export formats via export templates. An export template is essentially [Jinja2](https://jinja.palletsprojects.com/) template code associated with a particular object type. From the objects list in the NetBox UI, a user can select any of the created export templates to export the objects according to the template logic. + +An export template doesn't have to render CSV data: Its output can be in any character-based format. For example, you might want to render data using tabs as delimiters, or even create DNS address records directly from the IP addresses list. Export templates are a great way to get the data you need in the format you need quickly. To learn more about this feature, check out the [export template documentation](../customization/export-templates.md). ## Reports -TODO +NetBox administrators can install custom Python scripts, known as _reports_, which run within NetBox and can be executed and analyzed within the NetBox UI. Reports are a great way to evaluate NetBox objects against a set of arbitrary rules. For example, you could write a report to check that every router has a loopback interface with an IP address assigned, or that every site has a minimum set of VLANs defined. + +When a report runs, its logs messages pertaining to the operations being performed, and will ultimately result in either a pass or fail. Reports can be executed via the UI, REST API, or CLI (as a management command). To learn more about this feature, check out the [documentation for reports](../customization/reports.md). ## Custom Scripts -TODO +Custom scripts are similar to reports, but more powerful. A custom script can prompt the user for input via a form (or API data), and is built to do much more than just reporting. Custom scripts are generally used to automate tasks, such as the population of new objects in NetBox, or exchanging data with external systems. + +The complete Python environment is available to a custom script, including all of NetBox's internal mechanisms: There are no artificial restrictions on what a script can do. As such, custom scripting is considered an advanced feature and requires sufficient familiarity with Python and NetBox's data model. To learn more about this feature, check out the [documentation for custom scripts](../customization/custom-scripts.md). diff --git a/docs/features/permissions.md b/docs/features/permissions.md deleted file mode 100644 index a422ca7b3..000000000 --- a/docs/features/permissions.md +++ /dev/null @@ -1,3 +0,0 @@ -# Object-Based Permissions - -TODO diff --git a/docs/features/sso.md b/docs/features/sso.md deleted file mode 100644 index b4f9782c2..000000000 --- a/docs/features/sso.md +++ /dev/null @@ -1,3 +0,0 @@ -# Single Sign-On (SSO) - -TODO diff --git a/docs/features/tags.md b/docs/features/tags.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/integrations/webhooks.md b/docs/integrations/webhooks.md index 3ef28fb11..9a1094988 100644 --- a/docs/integrations/webhooks.md +++ b/docs/integrations/webhooks.md @@ -85,7 +85,7 @@ A webhook may include a set of conditional logic expressed in JSON used to contr } ``` -For more detail, see the reference documentation for NetBox's [conditional logic](../../reference/conditions.md). +For more detail, see the reference documentation for NetBox's [conditional logic](../reference/conditions.md). ## Webhook Processing diff --git a/mkdocs.yml b/mkdocs.yml index a5eb36d81..8bcf6cebf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -61,8 +61,6 @@ nav: - Introduction: 'introduction.md' - Features: - Facilities: 'features/facilities.md' - - Tenancy: 'features/tenancy.md' - - Contacts: 'features/contacts.md' - Devices & Cabling: 'features/devices-cabling.md' - Power Tracking: 'features/power-tracking.md' - IPAM: 'features/ipam.md' @@ -70,14 +68,14 @@ nav: - L2VPN & Overlay: 'features/l2vpn-overlay.md' - Circuits: 'features/circuits.md' - Wireless: 'features/wireless.md' + - Tenancy: 'features/tenancy.md' + - Contacts: 'features/contacts.md' - Context Data: 'features/context-data.md' - Change Logging: 'features/change-logging.md' - Journaling: 'features/journaling.md' - - Tags: 'features/tags.md' - - Integrations: 'features/integrations.md' + - Auth & Permissions: 'features/authentication-permissions.md' + - API & Integration: 'features/api-integration.md' - Customization: 'features/customization.md' - - Object-Based Permissions: 'features/permissions.md' - - Single Sign-On (SSO): 'features/sso.md' - Installation & Upgrade: - Installing NetBox: 'installation/index.md' - 1. PostgreSQL: 'installation/1-postgresql.md' From 0750e27351db01161b74fa7417410ae9bdead423 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 11 Aug 2022 16:14:06 -0400 Subject: [PATCH 378/593] Finish customization docs --- docs/customization/custom-fields.md | 108 +++++++++++++++++++++ docs/customization/custom-links.md | 66 +++++++++++++ docs/customization/export-templates.md | 81 ++++++++++++++++ docs/models/extras/customfield.md | 128 +++++++++++-------------- docs/models/extras/customlink.md | 94 ++++++++---------- docs/models/extras/exporttemplate.md | 80 +++------------- 6 files changed, 365 insertions(+), 192 deletions(-) diff --git a/docs/customization/custom-fields.md b/docs/customization/custom-fields.md index e69de29bb..c443fa9f6 100644 --- a/docs/customization/custom-fields.md +++ b/docs/customization/custom-fields.md @@ -0,0 +1,108 @@ +# Custom Fields + +Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, sites are stored in the `dcim_site` table, which has columns named `name`, `facility`, `physical_address`, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows. + +However, some users might want to store additional object attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number correlating it with an internal support system record. This is certainly a legitimate use for NetBox, but it's not a common enough need to warrant including a field for _every_ NetBox installation. Instead, you can create a custom field to hold this data. + +Within the database, custom fields are stored as JSON data directly alongside each object. This alleviates the need for complex queries when retrieving objects. + +## Creating Custom Fields + +Custom fields may be created by navigating to Customization > Custom Fields. NetBox supports many types of custom field: + +* Text: Free-form text (intended for single-line use) +* Long text: Free-form of any length; supports Markdown rendering +* Integer: A whole number (positive or negative) +* Boolean: True or false +* Date: A date in ISO 8601 format (YYYY-MM-DD) +* URL: This will be presented as a link in the web UI +* JSON: Arbitrary data stored in JSON format +* Selection: A selection of one of several pre-defined custom choices +* Multiple selection: A selection field which supports the assignment of multiple values +* Object: A single NetBox object of the type defined by `object_type` +* Multiple object: One or more NetBox objects of the type defined by `object_type` + +Each custom field must have a name. This should be a simple database-friendly string (e.g. `tps_report`) and may contain only alphanumeric characters and underscores. You may also assign a corresponding human-friendly label (e.g. "TPS report"); the label will be displayed on web forms. A weight is also required: Higher-weight fields will be ordered lower within a form. (The default weight is 100.) If a description is provided, it will appear beneath the field in a form. + +Marking a field as required will force the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields, or the exact value of a choice for selection fields. + +A custom field must be assigned to one or more object types, or models, in NetBox. Once created, custom fields will automatically appear as part of these models in the web UI and REST API. Note that not all models support custom fields. + +### Filtering + +The filter logic controls how values are matched when filtering objects by the custom field. Loose filtering (the default) matches on a partial value, whereas exact matching requires a complete match of the given string to a field's value. For example, exact filtering with the string "red" will only match the exact value "red", whereas loose filtering will match on the values "red", "red-orange", or "bored". Setting the filter logic to "disabled" disables filtering by the field entirely. + +### Grouping + +!!! note + This feature was introduced in NetBox v3.3. + +Related custom fields can be grouped together within the UI by assigning each the same group name. When at least one custom field for an object type has a group defined, it will appear under the group heading within the custom fields panel under the object view. All custom fields with the same group name will appear under that heading. (Note that the group names must match exactly, or each will appear as a separate heading.) + +This parameter has no effect on the API representation of custom field data. + +### Visibility + +!!! note + This feature was introduced in NetBox v3.3. + +When creating a custom field, there are three options for UI visibility. These control how and whether the custom field is displayed within the NetBox UI. + +* **Read/write** (default): The custom field is included when viewing and editing objects. +* **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.) +* **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users. + +Note that this setting has no impact on the REST or GraphQL APIs: Custom field data will always be available via either API. + +### Validation + +NetBox supports limited custom validation for custom field values. Following are the types of validation enforced for each field type: + +* Text: Regular expression (optional) +* Integer: Minimum and/or maximum value (optional) +* Selection: Must exactly match one of the prescribed choices + +### Custom Selection Fields + +Each custom selection field must have at least two choices. These are specified as a comma-separated list. Choices appear in forms in the order they are listed. Note that choice values are saved exactly as they appear, so it's best to avoid superfluous punctuation or symbols where possible. + +If a default value is specified for a selection field, it must exactly match one of the provided choices. The value of a multiple selection field will always return a list, even if only one value is selected. + +### Custom Object Fields + +An object or multi-object custom field can be used to refer to a particular NetBox object or objects as the "value" for a custom field. These custom fields must define an `object_type`, which determines the type of object to which custom field instances point. + +## Custom Fields in Templates + +Several features within NetBox, such as export templates and webhooks, utilize Jinja2 templating. For convenience, objects which support custom field assignment expose custom field data through the `cf` property. This is a bit cleaner than accessing custom field data through the actual field (`custom_field_data`). + +For example, a custom field named `foo123` on the Site model is accessible on an instance as `{{ site.cf.foo123 }}`. + +## Custom Fields and the REST API + +When retrieving an object via the REST API, all of its custom data will be included within the `custom_fields` attribute. For example, below is the partial output of a site with two custom fields defined: + +```json +{ + "id": 123, + "url": "http://localhost:8000/api/dcim/sites/123/", + "name": "Raleigh 42", + ... + "custom_fields": { + "deployed": "2018-06-19", + "site_code": "US-NC-RAL42" + }, + ... +``` + +To set or change these values, simply include nested JSON data. For example: + +```json +{ + "name": "New Site", + "slug": "new-site", + "custom_fields": { + "deployed": "2019-03-24" + } +} +``` diff --git a/docs/customization/custom-links.md b/docs/customization/custom-links.md index e69de29bb..16ba9d2af 100644 --- a/docs/customization/custom-links.md +++ b/docs/customization/custom-links.md @@ -0,0 +1,66 @@ +# Custom Links + +Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related records in systems outside NetBox. For example, you might create a custom link on the device view which links to the current device in a Network Monitoring System (NMS). + +Custom links are created by navigating to Customization > Custom Links. Each link is associated with a particular NetBox object type (site, device, prefix, etc.) and will be displayed on relevant views. Each link has display text and a URL, and data from the NetBox item being viewed can be included in the link using [Jinja2 template code](https://jinja2docs.readthedocs.io/en/stable/) through the variable `obj`, and custom fields through `obj.cf`. + +For example, you might define a link like this: + +* Text: `View NMS` +* URL: `https://nms.example.com/nodes/?name={{ obj.name }}` + +When viewing a device named Router4, this link would render as: + +```no-highlight +View NMS +``` + +Custom links appear as buttons in the top right corner of the page. Numeric weighting can be used to influence the ordering of links, and each link can be enabled or disabled individually. + +!!! warning + Custom links rely on user-created code to generate arbitrary HTML output, which may be dangerous. Only grant permission to create or modify custom links to trusted users. + +## Context Data + +The following context data is available within the template when rendering a custom link's text or URL. + +| Variable | Description | +|-----------|-------------------------------------------------------------------------------------------------------------------| +| `object` | The NetBox object being displayed | +| `obj` | Same as `object`; maintained for backward compatability until NetBox v3.5 | +| `debug` | A boolean indicating whether debugging is enabled | +| `request` | The current WSGI request | +| `user` | The current user (if authenticated) | +| `perms` | The [permissions](https://docs.djangoproject.com/en/stable/topics/auth/default/#permissions) assigned to the user | + +While most of the context variables listed above will have consistent attributes, the object will be an instance of the specific object being viewed when the link is rendered. Different models have different fields and properties, so you may need to some research to determine the attributes available for use within your template for a specific object type. + +Checking the REST API representation of an object is generally a convenient way to determine what attributes are available. You can also reference the NetBox source code directly for a comprehensive list. + +## Conditional Rendering + +Only links which render with non-empty text are included on the page. You can employ conditional Jinja2 logic to control the conditions under which a link gets rendered. + +For example, if you only want to display a link for active devices, you could set the link text to + +```jinja2 +{% if obj.status == 'active' %}View NMS{% endif %} +``` + +The link will not appear when viewing a device with any status other than "active." + +As another example, if you wanted to show only devices belonging to a certain manufacturer, you could do something like this: + +```jinja2 +{% if obj.device_type.manufacturer.name == 'Cisco' %}View NMS{% endif %} +``` + +The link will only appear when viewing a device with a manufacturer name of "Cisco." + +## Link Groups + +Group names can be specified to organize links into groups. Links with the same group name will render as a dropdown menu beneath a single button bearing the name of the group. + +## Table Columns + +Custom links can also be included in object tables by selecting the desired links from the table configuration form. When displayed, each link will render as a hyperlink for its corresponding object. When exported (e.g. as CSV data), each link render only its URL. diff --git a/docs/customization/export-templates.md b/docs/customization/export-templates.md index e69de29bb..640a97531 100644 --- a/docs/customization/export-templates.md +++ b/docs/customization/export-templates.md @@ -0,0 +1,81 @@ +# Export Templates + +NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Templates. + +Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list. Each export template must have a name, and may optionally designate a specific export [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) and/or file extension. + +Export templates must be written in [Jinja2](https://jinja.palletsprojects.com/). + +!!! note + The name `table` is reserved for internal use. + +!!! warning + Export templates are rendered using user-submitted code, which may pose security risks under certain conditions. Only grant permission to create or modify export templates to trusted users. + +The list of objects returned from the database when rendering an export template is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example: + +```jinja2 +{% for rack in queryset %} +Rack: {{ rack.name }} +Site: {{ rack.site.name }} +Height: {{ rack.u_height }}U +{% endfor %} +``` + +To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`. + +If you need to use the config context data in an export template, you'll should use the function `get_config_context` to get all the config context data. For example: +``` +{% for server in queryset %} +{% set data = server.get_config_context() %} +{{ data.syslog }} +{% endfor %} +``` + +The `as_attachment` attribute of an export template controls its behavior when rendered. If true, the rendered content will be returned to the user as a downloadable file. If false, it will be displayed within the browser. (This may be handy e.g. for generating HTML content.) + +A MIME type and file extension can optionally be defined for each export template. The default MIME type is `text/plain`. + + +## REST API Integration + +When it is necessary to provide authentication credentials (such as when [`LOGIN_REQUIRED`](../configuration/security.md#login_required) has been enabled), it is recommended to render export templates via the REST API. This allows the client to specify an authentication token. To render an export template via the REST API, make a `GET` request to the model's list endpoint and append the `export` parameter specifying the export template name. For example: + +``` +GET /api/dcim/sites/?export=MyTemplateName +``` + +Note that the body of the response will contain only the rendered export template content, as opposed to a JSON object or list. + +## Example + +Here's an example device export template that will generate a simple Nagios configuration from a list of devices. + +``` +{% for device in queryset %}{% if device.status and device.primary_ip %}define host{ + use generic-switch + host_name {{ device.name }} + address {{ device.primary_ip.address.ip }} +} +{% endif %}{% endfor %} +``` + +The generated output will look something like this: + +``` +define host{ + use generic-switch + host_name switch1 + address 192.0.2.1 +} +define host{ + use generic-switch + host_name switch2 + address 192.0.2.2 +} +define host{ + use generic-switch + host_name switch3 + address 192.0.2.3 +} +``` diff --git a/docs/models/extras/customfield.md b/docs/models/extras/customfield.md index bfe412edc..0b2bc29f9 100644 --- a/docs/models/extras/customfield.md +++ b/docs/models/extras/customfield.md @@ -1,109 +1,93 @@ # Custom Fields -Each model in NetBox is represented in the database as a discrete table, and each attribute of a model exists as a column within its table. For example, sites are stored in the `dcim_site` table, which has columns named `name`, `facility`, `physical_address`, and so on. As new attributes are added to objects throughout the development of NetBox, tables are expanded to include new rows. +## Fields -However, some users might want to store additional object attributes that are somewhat esoteric in nature, and that would not make sense to include in the core NetBox database schema. For instance, suppose your organization needs to associate each device with a ticket number correlating it with an internal support system record. This is certainly a legitimate use for NetBox, but it's not a common enough need to warrant including a field for _every_ NetBox installation. Instead, you can create a custom field to hold this data. +### Model(s) -Within the database, custom fields are stored as JSON data directly alongside each object. This alleviates the need for complex queries when retrieving objects. +Select the NetBox object type or types to which this custom field applies. -## Creating Custom Fields +### Name -Custom fields may be created by navigating to Customization > Custom Fields. NetBox supports six types of custom field: +The raw field name. This will be used in the database and API, and should consist only of alphanumeric characters and underscores. (Use the `label` field to designate a human-friendly name for the custom field.) -* Text: Free-form text (intended for single-line use) -* Long text: Free-form of any length; supports Markdown rendering -* Integer: A whole number (positive or negative) -* Boolean: True or false -* Date: A date in ISO 8601 format (YYYY-MM-DD) -* URL: This will be presented as a link in the web UI -* JSON: Arbitrary data stored in JSON format -* Selection: A selection of one of several pre-defined custom choices -* Multiple selection: A selection field which supports the assignment of multiple values -* Object: A single NetBox object of the type defined by `object_type` -* Multiple object: One or more NetBox objects of the type defined by `object_type` +### Label -Each custom field must have a name. This should be a simple database-friendly string (e.g. `tps_report`) and may contain only alphanumeric characters and underscores. You may also assign a corresponding human-friendly label (e.g. "TPS report"); the label will be displayed on web forms. A weight is also required: Higher-weight fields will be ordered lower within a form. (The default weight is 100.) If a description is provided, it will appear beneath the field in a form. +An optional human-friendly name for the custom field. If not defined, the field's `name` attribute will be used. -Marking a field as required will force the user to provide a value for the field when creating a new object or when saving an existing object. A default value for the field may also be provided. Use "true" or "false" for boolean fields, or the exact value of a choice for selection fields. +### Group Name -A custom field must be assigned to one or more object types, or models, in NetBox. Once created, custom fields will automatically appear as part of these models in the web UI and REST API. Note that not all models support custom fields. +If this custom field should be grouped with others, specify the name of the group here. Custom fields with no group defined will be ordered only by weight and name. -### Filtering +### Type -The filter logic controls how values are matched when filtering objects by the custom field. Loose filtering (the default) matches on a partial value, whereas exact matching requires a complete match of the given string to a field's value. For example, exact filtering with the string "red" will only match the exact value "red", whereas loose filtering will match on the values "red", "red-orange", or "bored". Setting the filter logic to "disabled" disables filtering by the field entirely. +The type of data this field holds. This must be one of the following: -### Grouping +| Type | Description | +|--------------------|--------------------------------------------------------------------| +| Text | Free-form text (intended for single-line use) | +| Long text | Free-form of any length; supports Markdown rendering | +| Integer | A whole number (positive or negative) | +| Boolean | True or false | +| Date | A date in ISO 8601 format (YYYY-MM-DD) | +| URL | This will be presented as a link in the web UI | +| JSON | Arbitrary data stored in JSON format | +| Selection | A selection of one of several pre-defined custom choices | +| Multiple selection | A selection field which supports the assignment of multiple values | +| Object | A single NetBox object of the type defined by `object_type` | +| Multiple object | One or more NetBox objects of the type defined by `object_type` | -!!! note - This feature was introduced in NetBox v3.3. +### Object Type -Related custom fields can be grouped together within the UI by assigning each the same group name. When at least one custom field for an object type has a group defined, it will appear under the group heading within the custom fields panel under the object view. All custom fields with the same group name will appear under that heading. (Note that the group names must match exactly, or each will appear as a separate heading.) +For object and multiple-object fields only. Designates the type of NetBox object being referenced. -This parameter has no effect on the API representation of custom field data. +### Weight -### Visibility +A numeric weight used to override alphabetic ordering of fields by name. Custom fields with a lower weight will be listed before those with a higher weight. (Note that weight applies within the context of a custom field group, if defined.) -!!! note - This feature was introduced in NetBox v3.3. +### Required -When creating a custom field, there are three options for UI visibility. These control how and whether the custom field is displayed within the NetBox UI. +If checked, this custom field must be populated with a valid value for the object to pass validation. -* **Read/write** (default): The custom field is included when viewing and editing objects. -* **Read-only**: The custom field is displayed when viewing an object, but it cannot be edited via the UI. (It will appear in the form as a read-only field.) -* **Hidden**: The custom field will never be displayed within the UI. This option is recommended for fields which are not intended for use by human users. +### Description -Note that this setting has no impact on the REST or GraphQL APIs: Custom field data will always be available via either API. +A brief description of the field's purpose (optional). -### Validation +### Filter Logic -NetBox supports limited custom validation for custom field values. Following are the types of validation enforced for each field type: +Defines how filters are evaluated against custom field values. -* Text: Regular expression (optional) -* Integer: Minimum and/or maximum value (optional) -* Selection: Must exactly match one of the prescribed choices +| Option | Description | +|----------|-------------------------------------| +| Disabled | Filtering disabled | +| Loose | Match any occurrence of the value | +| Exact | Match only the complete field value | -### Custom Selection Fields +### UI Visibility -Each custom selection field must have at least two choices. These are specified as a comma-separated list. Choices appear in forms in the order they are listed. Note that choice values are saved exactly as they appear, so it's best to avoid superfluous punctuation or symbols where possible. +Controls how and whether the custom field is displayed within the NetBox user interface. -If a default value is specified for a selection field, it must exactly match one of the provided choices. The value of a multiple selection field will always return a list, even if only one value is selected. +| Option | Description | +|------------|--------------------------------------| +| Read/write | Display and permit editing (default) | +| Read-only | Display field but disallow editing | +| Hidden | Do not display field in the UI | -### Custom Object Fields +### Default -An object or multi-object custom field can be used to refer to a particular NetBox object or objects as the "value" for a custom field. These custom fields must define an `object_type`, which determines the type of object to which custom field instances point. +The default value to populate for the custom field when creating new objects (optional). This value must be expressed as JSON. If this is a choice or multi-choice field, this must be one of the available choices. +### Choices -## Custom Fields in Templates +For choice and multi-choice custom fields only. A comma-delimited list of the available choices. -Several features within NetBox, such as export templates and webhooks, utilize Jinja2 templating. For convenience, objects which support custom field assignment expose custom field data through the `cf` property. This is a bit cleaner than accessing custom field data through the actual field (`custom_field_data`). +### Minimum Value -For example, a custom field named `foo123` on the Site model is accessible on an instance as `{{ site.cf.foo123 }}`. +For numeric custom fields only. The minimum valid value (optional). -## Custom Fields and the REST API +### Maximum Value -When retrieving an object via the REST API, all of its custom data will be included within the `custom_fields` attribute. For example, below is the partial output of a site with two custom fields defined: +For numeric custom fields only. The maximum valid value (optional). -```json -{ - "id": 123, - "url": "http://localhost:8000/api/dcim/sites/123/", - "name": "Raleigh 42", - ... - "custom_fields": { - "deployed": "2018-06-19", - "site_code": "US-NC-RAL42" - }, - ... -``` +### Validation Regex -To set or change these values, simply include nested JSON data. For example: - -```json -{ - "name": "New Site", - "slug": "new-site", - "custom_fields": { - "deployed": "2019-03-24" - } -} -``` +For string-based custom fields only. A regular expression used to validate the field's value (optional). diff --git a/docs/models/extras/customlink.md b/docs/models/extras/customlink.md index 16ba9d2af..458007ab1 100644 --- a/docs/models/extras/customlink.md +++ b/docs/models/extras/customlink.md @@ -1,66 +1,54 @@ # Custom Links -Custom links allow users to display arbitrary hyperlinks to external content within NetBox object views. These are helpful for cross-referencing related records in systems outside NetBox. For example, you might create a custom link on the device view which links to the current device in a Network Monitoring System (NMS). +## Fields -Custom links are created by navigating to Customization > Custom Links. Each link is associated with a particular NetBox object type (site, device, prefix, etc.) and will be displayed on relevant views. Each link has display text and a URL, and data from the NetBox item being viewed can be included in the link using [Jinja2 template code](https://jinja2docs.readthedocs.io/en/stable/) through the variable `obj`, and custom fields through `obj.cf`. +### Name -For example, you might define a link like this: +The name of the custom link. This is used primarily for administrative purposes only, although custom links of the same weight are ordered alphabetically by name when being rendered in the UI. -* Text: `View NMS` -* URL: `https://nms.example.com/nodes/?name={{ obj.name }}` +### Content Type -When viewing a device named Router4, this link would render as: +The type of NetBox object to which this custom link applies. -```no-highlight -View NMS -``` +### Weight -Custom links appear as buttons in the top right corner of the page. Numeric weighting can be used to influence the ordering of links, and each link can be enabled or disabled individually. +A numeric weight used to override alphabetic ordering of links by name. Custom fields with a lower weight will be listed before those with a higher weight. (Note that weight applies within the context of a custom link group, if defined.) -!!! warning - Custom links rely on user-created code to generate arbitrary HTML output, which may be dangerous. Only grant permission to create or modify custom links to trusted users. +### Group Name + +If this custom link should be grouped with others, specify the name of the group here. Grouped custom links will be listed in a dropdown menu attached to a single button bearing the group name. + +### Button Class + +The color of the UI button. + +### Enabled + +If not selected, the custom link will not be rendered. This can be useful for temporarily disabling a custom link. + +### New Window + +If selected, this will force the link to open in a new browser tab or window. + +### Link Text + +Jinja2 template code for rendering the button text. (Note that this does not _need_ to contain any template variables.) See below for available context data. + +!!! note + Custom links which render an empty text value will not be displayed in the UI. This can be used to toggle the inclusion of a link based on object attributes. + +### Link URL + +Jinja2 template code for rendering the hyperlink. See below for available context data. ## Context Data -The following context data is available within the template when rendering a custom link's text or URL. +The following context variables are available in to the text and link templates. -| Variable | Description | -|-----------|-------------------------------------------------------------------------------------------------------------------| -| `object` | The NetBox object being displayed | -| `obj` | Same as `object`; maintained for backward compatability until NetBox v3.5 | -| `debug` | A boolean indicating whether debugging is enabled | -| `request` | The current WSGI request | -| `user` | The current user (if authenticated) | -| `perms` | The [permissions](https://docs.djangoproject.com/en/stable/topics/auth/default/#permissions) assigned to the user | - -While most of the context variables listed above will have consistent attributes, the object will be an instance of the specific object being viewed when the link is rendered. Different models have different fields and properties, so you may need to some research to determine the attributes available for use within your template for a specific object type. - -Checking the REST API representation of an object is generally a convenient way to determine what attributes are available. You can also reference the NetBox source code directly for a comprehensive list. - -## Conditional Rendering - -Only links which render with non-empty text are included on the page. You can employ conditional Jinja2 logic to control the conditions under which a link gets rendered. - -For example, if you only want to display a link for active devices, you could set the link text to - -```jinja2 -{% if obj.status == 'active' %}View NMS{% endif %} -``` - -The link will not appear when viewing a device with any status other than "active." - -As another example, if you wanted to show only devices belonging to a certain manufacturer, you could do something like this: - -```jinja2 -{% if obj.device_type.manufacturer.name == 'Cisco' %}View NMS{% endif %} -``` - -The link will only appear when viewing a device with a manufacturer name of "Cisco." - -## Link Groups - -Group names can be specified to organize links into groups. Links with the same group name will render as a dropdown menu beneath a single button bearing the name of the group. - -## Table Columns - -Custom links can also be included in object tables by selecting the desired links from the table configuration form. When displayed, each link will render as a hyperlink for its corresponding object. When exported (e.g. as CSV data), each link render only its URL. +| Variable | Description | +|-----------|-----------------------------------------------------------------------------| +| `object` | The NetBox object being displayed | +| `debug` | A boolean indicating whether debugging is enabled | +| `request` | The current WSGI request | +| `user` | The current user (if authenticated) | +| `perms` | The [permissions](../../administration/permissions.md) assigned to the user | diff --git a/docs/models/extras/exporttemplate.md b/docs/models/extras/exporttemplate.md index b4b69108a..347184324 100644 --- a/docs/models/extras/exporttemplate.md +++ b/docs/models/extras/exporttemplate.md @@ -1,81 +1,27 @@ # Export Templates -NetBox allows users to define custom templates that can be used when exporting objects. To create an export template, navigate to Customization > Export Templates. +## Fields -Each export template is associated with a certain type of object. For instance, if you create an export template for VLANs, your custom template will appear under the "Export" button on the VLANs list. Each export template must have a name, and may optionally designate a specific export [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) and/or file extension. +### Name -Export templates must be written in [Jinja2](https://jinja.palletsprojects.com/). +The name of the export template. This will appear in the "export" dropdown list in the NetBox UI. -!!! note - The name `table` is reserved for internal use. +### Content Type -!!! warning - Export templates are rendered using user-submitted code, which may pose security risks under certain conditions. Only grant permission to create or modify export templates to trusted users. +The type of NetBox object to which the export template applies. -The list of objects returned from the database when rendering an export template is stored in the `queryset` variable, which you'll typically want to iterate through using a `for` loop. Object properties can be access by name. For example: +### Template Code -```jinja2 -{% for rack in queryset %} -Rack: {{ rack.name }} -Site: {{ rack.site.name }} -Height: {{ rack.u_height }}U -{% endfor %} -``` +Jinja2 template code for rendering the exported data. -To access custom fields of an object within a template, use the `cf` attribute. For example, `{{ obj.cf.color }}` will return the value (if any) for a custom field named `color` on `obj`. +### MIME Type -If you need to use the config context data in an export template, you'll should use the function `get_config_context` to get all the config context data. For example: -``` -{% for server in queryset %} -{% set data = server.get_config_context() %} -{{ data.syslog }} -{% endfor %} -``` +The MIME type to indicate in the response when rendering the export template (optional). Defaults to `text/plain`. -The `as_attachment` attribute of an export template controls its behavior when rendered. If true, the rendered content will be returned to the user as a downloadable file. If false, it will be displayed within the browser. (This may be handy e.g. for generating HTML content.) +### File Extension -A MIME type and file extension can optionally be defined for each export template. The default MIME type is `text/plain`. +The file extension to append to the file name in the response (optional). +### As Attachment -## REST API Integration - -When it is necessary to provide authentication credentials (such as when [`LOGIN_REQUIRED`](../../configuration/security.md#login_required) has been enabled), it is recommended to render export templates via the REST API. This allows the client to specify an authentication token. To render an export template via the REST API, make a `GET` request to the model's list endpoint and append the `export` parameter specifying the export template name. For example: - -``` -GET /api/dcim/sites/?export=MyTemplateName -``` - -Note that the body of the response will contain only the rendered export template content, as opposed to a JSON object or list. - -## Example - -Here's an example device export template that will generate a simple Nagios configuration from a list of devices. - -``` -{% for device in queryset %}{% if device.status and device.primary_ip %}define host{ - use generic-switch - host_name {{ device.name }} - address {{ device.primary_ip.address.ip }} -} -{% endif %}{% endfor %} -``` - -The generated output will look something like this: - -``` -define host{ - use generic-switch - host_name switch1 - address 192.0.2.1 -} -define host{ - use generic-switch - host_name switch2 - address 192.0.2.2 -} -define host{ - use generic-switch - host_name switch3 - address 192.0.2.3 -} -``` +If selected, the rendered content will be returned as a file attachment, rather than displayed directly in-browser (where supported). From 7e3050cf83e729ed43a9e591e7dd937c7a98febb Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 11 Aug 2022 16:34:29 -0400 Subject: [PATCH 379/593] Add "getting started" links --- docs/index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/index.md b/docs/index.md index a6bbcecff..d412d1a49 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,7 +24,7 @@ Unlike general-purpose CMDBs, NetBox has curated a data model which caters speci ## Customizable & Extensible -In addition to its expansive and robust data model, NetBox offers myriad mechanisms through it can be customized and extended. +In addition to its expansive and robust data model, NetBox offers myriad mechanisms through which it can be customized and extended. * Custom fields * Custom model validation @@ -39,10 +39,10 @@ Because NetBox is an open source application licensed under [Apache 2](https://w ## Getting Started -* Public Demo -* Installation Guide -* Docker install -* NetBox Cloud +* Try out our [public demo](https://demo.netbox.dev/) if you want to jump right in +* The [installation guide](./installation/index.md) will help you get your own deployment up and running +* Or try the community [Docker image](https://github.com/netbox-community/netbox-docker) for a low-touch approach +* [NetBox Cloud](https://www.getnetbox.io/) is a hosted solution offered by NS1 !!! tip "NetBox Development" Interested in contributing to NetBox? Check out our [GitHub repository](https://github.com/netbox-community/netbox) to get started! From 693ad700e83a49f8f9852bc4a952ed57811c10d4 Mon Sep 17 00:00:00 2001 From: Dorian Bourgeoisat <33571477+DorianXGH@users.noreply.github.com> Date: Fri, 12 Aug 2022 00:49:13 +0200 Subject: [PATCH 380/593] Swapping NG-PON2 as main name instead of TWDM-PON --- netbox/dcim/choices.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/netbox/dcim/choices.py b/netbox/dcim/choices.py index c91faf3da..1831ee8ae 100644 --- a/netbox/dcim/choices.py +++ b/netbox/dcim/choices.py @@ -818,7 +818,7 @@ class InterfaceTypeChoices(ChoiceSet): TYPE_GPON = 'gpon' TYPE_XG_PON = 'xg-pon' TYPE_XGS_PON = 'xgs-pon' - TYPE_TWDM_PON = 'twdm-pon' + TYPE_NG_PON2 = 'ng-pon2' TYPE_EPON = 'epon' TYPE_10G_EPON = '10g-epon' @@ -964,7 +964,7 @@ class InterfaceTypeChoices(ChoiceSet): (TYPE_GPON, 'GPON (2.5 Gbps / 1.25 Gps)'), (TYPE_XG_PON, 'XG-PON (10 Gbps / 2.5 Gbps)'), (TYPE_XGS_PON, 'XGS-PON (10 Gbps)'), - (TYPE_TWDM_PON, 'TWDM-PON (NG-PON2) (4x10 Gbps)'), + (TYPE_NG_PON2, 'NG-PON2 (TWDM-PON) (4x10 Gbps)'), (TYPE_EPON, 'EPON (1 Gbps)'), (TYPE_10G_EPON, '10G-EPON (10 Gbps)'), ) From c635f09e058877a462c7f8e8a44aa1fad1f0997e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 09:21:28 -0400 Subject: [PATCH 381/593] Closes #9994: Disable search indexing for local documentation builds --- docs/_theme/main.html | 9 +++++++++ mkdocs.yml | 2 ++ 2 files changed, 11 insertions(+) create mode 100644 docs/_theme/main.html diff --git a/docs/_theme/main.html b/docs/_theme/main.html new file mode 100644 index 000000000..4dfc4e14e --- /dev/null +++ b/docs/_theme/main.html @@ -0,0 +1,9 @@ +{% extends "base.html" %} + +{% block site_meta %} + {{ super() }} + {# Disable search indexing unless we're building for ReadTheDocs #} + {% if not config.extra.readthedocs %} + + {% endif %} +{% endblock %} diff --git a/mkdocs.yml b/mkdocs.yml index 34c65ed01..b13ab6c49 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,6 +5,7 @@ repo_name: netbox-community/netbox repo_url: https://github.com/netbox-community/netbox theme: name: material + custom_dir: docs/_theme/ icon: repo: fontawesome/brands/github palette: @@ -37,6 +38,7 @@ plugins: show_root_toc_entry: false show_source: false extra: + readthedocs: !ENV READTHEDOCS social: - icon: fontawesome/brands/github link: https://github.com/netbox-community/netbox From 41ad9b242c468fd3b868037320df7f4fd6123e0b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 10:12:01 -0400 Subject: [PATCH 382/593] Fixes #9986: Workaround for upstream timezone data bug --- docs/release-notes/version-3.2.md | 4 ++++ requirements.txt | 3 +++ 2 files changed, 7 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index e57cea3b3..c572328bc 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -8,6 +8,10 @@ * [#9625](https://github.com/netbox-community/netbox/issues/9625) - Add phone & email details to contacts panel * [#9857](https://github.com/netbox-community/netbox/issues/9857) - Add clear button to quick search fields +### Bug Fixes + +* [#9986](https://github.com/netbox-community/netbox/issues/9986) - Workaround for upstream timezone data bug + --- ## v3.2.8 (2022-08-08) diff --git a/requirements.txt b/requirements.txt index 59bd1e8cd..a227971fa 100644 --- a/requirements.txt +++ b/requirements.txt @@ -34,3 +34,6 @@ tzdata==2022.1 # Workaround for #7401 jsonschema==3.2.0 + +# Workaround for #9986 +pytz==2022.1 From e4fa8af47f7ae449bc490d927e5ac329a419e79b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 10:48:16 -0400 Subject: [PATCH 383/593] Changelog for #8595 --- 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 c572328bc..824e99778 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -4,6 +4,7 @@ ### Enhancements +* [#8595](https://github.com/netbox-community/netbox/issues/8595) - Add PON interface types * [#9161](https://github.com/netbox-community/netbox/issues/9161) - Pretty print JSON custom field data when editing * [#9625](https://github.com/netbox-community/netbox/issues/9625) - Add phone & email details to contacts panel * [#9857](https://github.com/netbox-community/netbox/issues/9857) - Add clear button to quick search fields From ca0b21bef5723aedfffaacd90df32a41e965a1cb Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 11:25:03 -0400 Subject: [PATCH 384/593] Closes #9980: Use standard table controls template for device interfaces list --- .../device/inc/interface_table_controls.html | 11 +++++++ netbox/templates/dcim/device/interfaces.html | 29 +------------------ netbox/templates/inc/table_controls_htmx.html | 26 ++++++++--------- 3 files changed, 25 insertions(+), 41 deletions(-) create mode 100644 netbox/templates/dcim/device/inc/interface_table_controls.html diff --git a/netbox/templates/dcim/device/inc/interface_table_controls.html b/netbox/templates/dcim/device/inc/interface_table_controls.html new file mode 100644 index 000000000..14e552439 --- /dev/null +++ b/netbox/templates/dcim/device/inc/interface_table_controls.html @@ -0,0 +1,11 @@ +{% extends 'inc/table_controls_htmx.html' %} + +{% block extra_table_controls %} + +
      + + +
    +{% endblock extra_table_controls %} diff --git a/netbox/templates/dcim/device/interfaces.html b/netbox/templates/dcim/device/interfaces.html index 79a9d6b6f..94e38dbf3 100644 --- a/netbox/templates/dcim/device/interfaces.html +++ b/netbox/templates/dcim/device/interfaces.html @@ -4,34 +4,7 @@ {% load static %} {% block content %} -
    -
    -
    - - -
    -
    -
    -
    - {% if request.user.is_authenticated %} - - {% endif %} - -
      - - -
    -
    -
    -
    + {% include 'dcim/device/inc/interface_table_controls.html' with table_modal="DeviceInterfaceTable_config" %}
    {% csrf_token %} diff --git a/netbox/templates/inc/table_controls_htmx.html b/netbox/templates/inc/table_controls_htmx.html index 099ad537e..6d6926d5d 100644 --- a/netbox/templates/inc/table_controls_htmx.html +++ b/netbox/templates/inc/table_controls_htmx.html @@ -1,22 +1,22 @@ {% load helpers %} -
    -
    -
    +
    +
    +
    - +
    + {% block extra_table_controls %}{% endblock %}
    -
    +
    {% if request.user.is_authenticated and table_modal %} -
    - -
    +
    + +
    {% endif %}
    -
    \ No newline at end of file +
    From 642fe422c458d4e5f3409c827100c2f2ac60c920 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 13:39:07 -0400 Subject: [PATCH 385/593] Touch up intro page --- docs/index.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/docs/index.md b/docs/index.md index d412d1a49..c233dedb7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,16 +2,16 @@ # The Premiere Network Source of Truth -NetBox is the leading solution for modeling modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation. +NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation. Read on to discover why thousands of organizations worldwide put NetBox at the heart of their infrastructure. -## Built for Networks +## :material-server-network: Built for Networks -Unlike general-purpose CMDBs, NetBox has curated a data model which caters specifically to the needs of network engineers and operators. It delivers a wide assortment of object types carefully crafted to best serve the needs of network engineers and operators. These cover all facets of network design, from IP address managements to cabling to overlays and more: +Unlike general-purpose CMDBs, NetBox has curated a data model which caters specifically to the needs of network engineers and operators. It delivers a wide assortment of object types carefully crafted to best serve the needs of infrastructure design and documentation. These cover all facets of network technology, from IP address managements to cabling to overlays and more: -* Hierarchical regions, site groups, sites, and locations +* Hierarchical regions, sites, and locations * Racks, devices, and device components * Cables and wireless connections -* Power distribution +* Power distribution tracking * Data circuits and providers * Virtual machines and clusters * IP prefixes, ranges, and addresses @@ -20,11 +20,12 @@ Unlike general-purpose CMDBs, NetBox has curated a data model which caters speci * AS numbers * VLANs and scoped VLAN groups * L2VPN overlays -* Organizational tenants and contacts +* Tenancy assignments +* Contact management -## Customizable & Extensible +## :material-hammer-wrench: Customizable & Extensible -In addition to its expansive and robust data model, NetBox offers myriad mechanisms through which it can be customized and extended. +In addition to its expansive and robust data model, NetBox offers myriad mechanisms through which it can be customized and extended. Its powerful plugins architecture enables users to extend the application to meet their needs with minimal development effort. * Custom fields * Custom model validation @@ -33,16 +34,20 @@ In addition to its expansive and robust data model, NetBox offers myriad mechani * Plugins * REST & GraphQL APIs -## Always Open +## :material-lock-open: Always Open -Because NetBox is an open source application licensed under [Apache 2](https://www.apache.org/licenses/LICENSE-2.0.html), its entire code base is completely accessible to the end user, and there's never a risk of vendor lock-out. Additionally, NetBox development is an entirely public, community-driven process to which everyone can provide input. +Because NetBox is an open source application licensed under [Apache 2](https://www.apache.org/licenses/LICENSE-2.0.html), its entire code base is completely accessible to the end user, and there's never a risk of vendor lock-in. Additionally, NetBox development is an entirely public, community-driven process to which everyone can provide input. -## Getting Started +!!! tip "NetBox Development" + Interested in contributing to NetBox? Check out our [GitHub repository](https://github.com/netbox-community/netbox) to get started! + +## :material-language-python: Powered by Python + +NetBox is built on the enormously popular [Django](http://www.djangoproject.com/) framework for the Python programming language, already a favorite among network engineers. Users can leverage their existing skills coding Python tools to extend NetBox's already vast functionality via custom scripts and plugins. + +## :material-flag: Getting Started * Try out our [public demo](https://demo.netbox.dev/) if you want to jump right in * The [installation guide](./installation/index.md) will help you get your own deployment up and running * Or try the community [Docker image](https://github.com/netbox-community/netbox-docker) for a low-touch approach * [NetBox Cloud](https://www.getnetbox.io/) is a hosted solution offered by NS1 - -!!! tip "NetBox Development" - Interested in contributing to NetBox? Check out our [GitHub repository](https://github.com/netbox-community/netbox) to get started! From 8c5779c8642f5984fd101508d11b4d4e80a7d9f9 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 14:11:58 -0400 Subject: [PATCH 386/593] Add feature docs for virtualization --- docs/features/virtualization.md | 26 ++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 27 insertions(+) create mode 100644 docs/features/virtualization.md diff --git a/docs/features/virtualization.md b/docs/features/virtualization.md new file mode 100644 index 000000000..8e1bf35ef --- /dev/null +++ b/docs/features/virtualization.md @@ -0,0 +1,26 @@ +# Virtualization + +Virtual machines and clusters can be modeled in NetBox alongside physical infrastructure. IP addresses and other resources are assigned to these objects just like physical objects, providing a seamless integration between physical and virtual networks. + +```mermaid +flowchart TD + ClusterGroup & ClusterType --> Cluster + Cluster --> VirtualMachine + Platform --> VirtualMachine + VirtualMachine --> VMInterface + +click Cluster "../../models/virtualization/cluster/" +click ClusterGroup "../../models/virtualization/clustergroup/" +click ClusterType "../../models/virtualization/clustertype/" +click Platform "../../models/dcim/platform/" +click VirtualMachine "../../models/virtualization/virtualmachine/" +click VMInterface "../../models/virtualization/vminterface/" +``` + +## Clusters + +A cluster is one or more physical host devices on which virtual machines can run. Each cluster must have a type and operational status, and may be assigned to a group. (Both types and groups are user-defined.) Each cluster may designate one or more devices as hosts, however this is optional. + +## Virtual Machines + +A virtual machine is a virtualized compute instance. These behave in NetBox very similarly to device objects, but without any physical attributes. For example, a VM may have interfaces assigned to it with IP addresses and VLANs, however its interfaces cannot be connected via cables (because they are virtual). Each VM may also define its compute, memory, and storage resources as well. diff --git a/mkdocs.yml b/mkdocs.yml index 9eea20397..be9c31651 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -70,6 +70,7 @@ nav: - L2VPN & Overlay: 'features/l2vpn-overlay.md' - Circuits: 'features/circuits.md' - Wireless: 'features/wireless.md' + - Virtualization: 'features/virtualization.md' - Tenancy: 'features/tenancy.md' - Contacts: 'features/contacts.md' - Context Data: 'features/context-data.md' From 9c667bb3af7fb8339acfd04ee586f98526ccf71e Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 14:14:56 -0400 Subject: [PATCH 387/593] Add hyperlinks to Mermaid graphs --- docs/features/circuits.md | 6 ++++ docs/features/contacts.md | 4 +++ docs/features/devices-cabling.md | 8 ++++++ docs/features/facilities.md | 8 ++++++ docs/features/ipam.md | 9 +++++- docs/features/tenancy.md | 3 ++ docs/features/vlan-management.md | 4 +++ docs/features/wireless.md | 3 ++ docs/getting-started/planning.md | 49 ++++++++++++++++++++++++++++++-- 9 files changed, 91 insertions(+), 3 deletions(-) diff --git a/docs/features/circuits.md b/docs/features/circuits.md index f0c5832c4..7739efb4c 100644 --- a/docs/features/circuits.md +++ b/docs/features/circuits.md @@ -7,6 +7,12 @@ flowchart TD ASN --> Provider Provider --> ProviderNetwork & Circuit CircuitType --> Circuit + +click ASN "../../models/circuits/asn/" +click Circuit "../../models/circuits/circuit/" +click CircuitType "../../models/circuits/circuittype/" +click Provider "../../models/circuits/provider/" +click ProviderNetwork "../../models/circuits/providernetwork/" ``` ## Providers diff --git a/docs/features/contacts.md b/docs/features/contacts.md index 7d717b2de..6bbd217fc 100644 --- a/docs/features/contacts.md +++ b/docs/features/contacts.md @@ -7,6 +7,10 @@ flowchart TD ContactGroup --> ContactGroup & Contact ContactRole & Contact --> assignment([Assignment]) assignment --> Object + +click Contact "../../models/tenancy/contact/" +click ContactGroup "../../models/tenancy/contactgroup/" +click ContactRole "../../models/tenancy/contactrole/" ``` ## Contact Groups diff --git a/docs/features/devices-cabling.md b/docs/features/devices-cabling.md index 7297f79ac..bec3e56de 100644 --- a/docs/features/devices-cabling.md +++ b/docs/features/devices-cabling.md @@ -11,6 +11,14 @@ flowchart TD DeviceRole & Platform & DeviceType --> Device Device & ModuleType ---> Module Device & Module --> Interface & ConsolePort & PowerPort & ... + +click Device "../../models/dcim/device/" +click DeviceRole "../../models/dcim/devicerole/" +click DeviceType "../../models/dcim/devicetype/" +click Manufacturer "../../models/dcim/manufacturer/" +click Module "../../models/dcim/module/" +click ModuleType "../../models/dcim/moduletype/" +click Platform "../../models/dcim/platform/" ``` ## Manufacturers diff --git a/docs/features/facilities.md b/docs/features/facilities.md index f105bd4c5..84c7c5733 100644 --- a/docs/features/facilities.md +++ b/docs/features/facilities.md @@ -13,6 +13,14 @@ flowchart TD Rack --> Device Site --> Rack RackRole --> Rack + +click Device "../../models/dcim/device/" +click Location "../../models/dcim/location/" +click Rack "../../models/dcim/rack/" +click RackRole "../../models/dcim/rackrole/" +click Region "../../models/dcim/region/" +click Site "../../models/dcim/site/" +click SiteGroup "../../models/dcim/sitegroup/" ``` ## Regions diff --git a/docs/features/ipam.md b/docs/features/ipam.md index 45a6a0221..d67645b17 100644 --- a/docs/features/ipam.md +++ b/docs/features/ipam.md @@ -17,8 +17,15 @@ flowchart TD Aggregate & Role --> Prefix Prefix --> Prefix Prefix --> IPRange & IPAddress + +click Aggregate "../../models/ipam/aggregate/" +click IPAddress "../../models/ipam/ipaddress/" +click IPRange "../../models/ipam/iprange/" +click Prefix "../../models/ipam/prefix/" +click RIR "../../models/ipam/rir/" +click Role "../../models/ipam/role/" ``` - + !!! tip "Automatic Hierarchies" IP objects in NetBox never need to be manually assigned to the parent objects. The construction of hierarchies is handled automatically by the application according to the inherent rules of IP addressing. diff --git a/docs/features/tenancy.md b/docs/features/tenancy.md index fe6d8e5a8..a278dc4c2 100644 --- a/docs/features/tenancy.md +++ b/docs/features/tenancy.md @@ -6,6 +6,9 @@ Most core objects within NetBox's data model support _tenancy_. This is the asso flowchart TD TenantGroup --> TenantGroup & Tenant Tenant --> Site & Device & Prefix & Circuit & ... + +click Tenant "../../models/tenancy/tenant/" +click TenantGroup "../../models/tenancy/tenantgroup/" ``` ## Tenant Groups diff --git a/docs/features/vlan-management.md b/docs/features/vlan-management.md index 4af05dea3..c74c9015c 100644 --- a/docs/features/vlan-management.md +++ b/docs/features/vlan-management.md @@ -5,6 +5,10 @@ Complementing its IPAM capabilities, NetBox also tracks VLAN information to assi ```mermaid flowchart TD VLANGroup & Role --> VLAN + +click Role "../../models/ipam/role/" +click VLAN "../../models/ipam/vlan/" +click VLANGroup "../../models/ipam/vlangroup/" ``` ## VLAN Groups diff --git a/docs/features/wireless.md b/docs/features/wireless.md index 215d1a682..c78387efb 100644 --- a/docs/features/wireless.md +++ b/docs/features/wireless.md @@ -7,6 +7,9 @@ Just as NetBox provides robust modeling for physical cable plants, it also suppo ```mermaid flowchart TD WirelessLANGroup --> WirelessLANGroup & WirelessLAN + +click WirelessLAN "../../models/wireless/wirelesslan/" +click WirelessLANGroup "../../models/wireless/wirelesslangroup/" ``` A wireless LAN is a multi-access network shared by multiple wireless clients, identified by a common service set identifier (SSID) and authentication parameters. Wireless LANs can be organized into self-nesting groups, and each wireless LAN may optionally be bound to a particular VLAN. This allows easily mapping wireless networks to their wired counterparts. diff --git a/docs/getting-started/planning.md b/docs/getting-started/planning.md index 5c431a4d2..5dbe6e54e 100644 --- a/docs/getting-started/planning.md +++ b/docs/getting-started/planning.md @@ -78,9 +78,15 @@ The graphs below illustrate some of the core dependencies among different models ```mermaid flowchart TD - TenantGroup --> TenantGroup - TenantGroup --> Tenant + TenantGroup --> TenantGroup & Tenant Tenant --> Site & Device & Prefix & VLAN & ... + +click Device "../../models/dcim/device/" +click Prefix "../../models/ipam/prefix/" +click Site "../../models/dcim/site/" +click Tenant "../../models/tenancy/tenant/" +click TenantGroup "../../models/tenancy/tenantgroup/" +click VLAN "../../models/ipam/vlan/" ``` ### Sites, Racks, and Devices @@ -99,6 +105,21 @@ flowchart TD DeviceType --> Device Device & ModuleType ---> Module Device & Module --> Interface + +click Device "../../models/dcim/device/" +click DeviceRole "../../models/dcim/devicerole/" +click DeviceType "../../models/dcim/devicetype/" +click Interface "../../models/dcim/interface/" +click Location "../../models/dcim/location/" +click Manufacturer "../../models/dcim/manufacturer/" +click Module "../../models/dcim/module/" +click ModuleType "../../models/dcim/moduletype/" +click Platform "../../models/dcim/platform/" +click Rack "../../models/dcim/rack/" +click RackRole "../../models/dcim/rackrole/" +click Region "../../models/dcim/region/" +click Site "../../models/dcim/site/" +click SiteGroup "../../models/dcim/sitegroup/" ``` ### VRFs, Prefixes, IP Addresses, and VLANs @@ -112,6 +133,16 @@ flowchart TD Aggregate & VRF --> Prefix VRF --> IPRange & IPAddress Prefix --> VLAN & IPRange & IPAddress + +click Aggregate "../../models/ipam/aggregate/" +click IPAddress "../../models/ipam/ipaddress/" +click IPRange "../../models/ipam/iprange/" +click Prefix "../../models/ipam/prefix/" +click RIR "../../models/ipam/rir/" +click Role "../../models/ipam/role/" +click VLAN "../../models/ipam/vlan/" +click VLANGroup "../../models/ipam/vlangroup/" +click VRF "../../models/ipam/vrf/" ``` ### Circuits @@ -121,6 +152,12 @@ flowchart TD Provider & CircuitType --> Circuit Provider --> ProviderNetwork Circuit --> CircuitTermination + +click Circuit "../../models/circuits/circuit/" +click CircuitTermination "../../models/circuits/circuittermination/" +click CircuitType "../../models/circuits/circuittype/" +click Provider "../../models/circuits/provider/" +click ProviderNetwork "../../models/circuits/providernetwork/" ``` ### Clusters and Virtual Machines @@ -132,4 +169,12 @@ flowchart TD Site --> Cluster & VirtualMachine Device & Platform --> VirtualMachine VirtualMachine --> VMInterface + +click Cluster "../../models/virtualization/cluster/" +click ClusterGroup "../../models/virtualization/clustergroup/" +click ClusterType "../../models/virtualization/clustertype/" +click Device "../../models/dcim/device/" +click Platform "../../models/dcim/platform/" +click VirtualMachine "../../models/virtualization/virtualmachine/" +click VMInterface "../../models/virtualization/vminterface/" ``` From fafc464d932bed1a03aaba959286f1fe66ada931 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 15:00:45 -0400 Subject: [PATCH 388/593] Refreshed circuits model documentation --- docs/models/circuits/circuit.md | 54 +++++++++++++++++----- docs/models/circuits/circuittermination.md | 42 +++++++++++++++-- docs/models/circuits/circuittype.md | 12 ++++- docs/models/circuits/provider.md | 39 +++++++++++++++- docs/models/circuits/providernetwork.md | 14 +++++- 5 files changed, 142 insertions(+), 19 deletions(-) diff --git a/docs/models/circuits/circuit.md b/docs/models/circuits/circuit.md index 3aaa4e99f..50637ab4e 100644 --- a/docs/models/circuits/circuit.md +++ b/docs/models/circuits/circuit.md @@ -1,19 +1,49 @@ # Circuits -A communications circuit represents a single _physical_ link connecting exactly two endpoints, commonly referred to as its A and Z terminations. A circuit in NetBox may have zero, one, or two terminations defined. It is common to have only one termination defined when you don't necessarily care about the details of the provider side of the circuit, e.g. for Internet access circuits. Both terminations would likely be modeled for circuits which connect one customer site to another. +A circuit represents a physical point-to-point data connection, typically used to interconnect sites across considerable distances (e.g. to deliver Internet connectivity). -Each circuit is associated with a provider and a user-defined type. For example, you might have Internet access circuits delivered to each site by one provider, and private MPLS circuits delivered by another. Each circuit must be assigned a circuit ID, each of which must be unique per provider. +## Fields -Each circuit is also assigned one of the following operational statuses: +### Provider -* Planned -* Provisioning -* Active -* Offline -* Deprovisioning -* Decommissioned +The [provider](./provider.md) to which this circuit belongs. -Circuits also have optional fields for annotating their installation and termination dates and commit rate, and may be assigned to NetBox tenants. +### Circuit ID -!!! note - NetBox currently models only physical circuits: those which have exactly two endpoints. It is common to layer virtualized constructs (_virtual circuits_) such as MPLS or EVPN tunnels on top of these, however NetBox does not yet support virtual circuit modeling. +An identifier for this circuit. This must be unique to the assigned provider. (Circuits assigned to different providers may have the same circuit ID.) + +### Circuit Type + +Each circuit is classified by a user-defined [circuit type](./circuittype.md). Generally this is something like "Internet access," "MPLS/VPN," etc. + +### Status + +The operational status of the circuit. By default, the following statuses are available: + +| Name | +|----------------| +| Planned | +| Provisioning | +| Active | +| Offline | +| Deprovisioning | +| Decommissioned | + +!!! tip "Custom circuit statuses" + Additional circuit statuses may be defined by setting `Circuit.status` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter. + +### Description + +A brief description of the circuit. + +### Installation Date + +The date on which the circuit was installed. + +### Termination Date + +The date on which the circuit is scheduled to be disconnected. + +### Commit Rate + +The committed rate (throughput) of the circuit, in kilobits per second. diff --git a/docs/models/circuits/circuittermination.md b/docs/models/circuits/circuittermination.md index beea2f85a..c6aa966d0 100644 --- a/docs/models/circuits/circuittermination.md +++ b/docs/models/circuits/circuittermination.md @@ -1,10 +1,46 @@ # Circuit Terminations -The association of a circuit with a particular site and/or device is modeled separately as a circuit termination. A circuit may have up to two terminations, labeled A and Z. A single-termination circuit can be used when you don't know (or care) about the far end of a circuit (for example, an Internet access circuit which connects to a transit provider). A dual-termination circuit is useful for tracking circuits which connect two sites. - -Each circuit termination is attached to either a site or to a provider network. Site terminations may optionally be connected via a cable to a specific device interface or port within that site. Each termination must be assigned a port speed, and can optionally be assigned an upstream speed if it differs from the downstream speed (a common scenario with e.g. DOCSIS cable modems). Fields are also available to track cross-connect and patch panel details. +Each circuit may have up to two terminations, designated A and Z. At either termination, a circuit may connect to a site, device interface (via a cable), or to a provider network. In adherence with NetBox's philosophy of closely modeling the real world, a circuit may be connected only to a physical interface. For example, circuits may not terminate to LAG interfaces, which are virtual in nature. In such cases, a separate physical circuit is associated with each LAG member interface and each needs to be modeled discretely. !!! note A circuit in NetBox represents a physical link, and cannot have more than two endpoints. When modeling a multi-point topology, each leg of the topology must be defined as a discrete circuit, with one end terminating within the provider's infrastructure. The provider network model is ideal for representing these networks. + +## Fields + +### Circuit + +The [circuit](./circuit.md) to which this termination belongs. + +### Termination Side + +Designates the termination as forming either the A or Z end of the circuit. + +### Mark Connected + +If selected, the circuit termination will be considered "connected" even if no cable has been connected to it in NetBox. + +### Site + +The [site](../dcim/site.md) with which this circuit termination is associated. Once created, a cable can be connected between the circuit termination and a device interface (or similar component). + +### Provider Network + +Circuits which do not connect to a site modeled by NetBox can instead be terminated to a [provider network](./providernetwork.md) representing an unknown network operated by a [provider](./provider.md). + +### Port Speed + +The operating speed of the terminated interface, in kilobits per second. This is useful for documenting the speed of a circuit when the actual interface to which it terminates is not being modeled in NetBox. + +### Upstream Speed + +The upstream speed of the terminated interface (in kilobits per second), if different from the downstream speed (a common scenario with e.g. DOCSIS cable modems). + +### Cross-connect ID + +In a data center environment, circuits are often delivered via a local cross-connect. While it may not be appropriate to model the cross-connect itself in NetBox, it's a good idea to record its ID for reference where applicable. + +### Patch Panel & Port(s) + +Similar to the cross-connect ID, this field can be used to track physical connection details which may be outside the scope of what is being modeled in NetBox. diff --git a/docs/models/circuits/circuittype.md b/docs/models/circuits/circuittype.md index aa8258e04..d0baa0f89 100644 --- a/docs/models/circuits/circuittype.md +++ b/docs/models/circuits/circuittype.md @@ -1,8 +1,18 @@ # Circuit Types -Circuits are classified by functional type. These types are completely customizable, and are typically used to convey the type of service being delivered over a circuit. For example, you might define circuit types for: +[Circuits](./circuit.md) are classified by functional type. These types are completely customizable, and are typically used to convey the type of service being delivered over a circuit. For example, you might define circuit types for: * Internet transit * Out-of-band connectivity * Peering * Private backhaul + +## Fields + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) diff --git a/docs/models/circuits/provider.md b/docs/models/circuits/provider.md index e0847b72f..a4835199e 100644 --- a/docs/models/circuits/provider.md +++ b/docs/models/circuits/provider.md @@ -1,5 +1,40 @@ # Providers -A circuit provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which offer Internet and private transit service, it might also include Internet exchange (IX) points and even organizations with whom you peer directly. Each circuit within NetBox must be assigned a provider and a circuit ID which is unique to that provider. +A provider is any entity which provides some form of connectivity of among sites or organizations within a site. While this obviously includes carriers which offer Internet and private transit service, it might also include Internet exchange (IX) points and even organizations with whom you peer directly. Each [circuit](./circuit.md) within NetBox must be assigned a provider and a circuit ID which is unique to that provider. -Each provider may be assigned an autonomous system number (ASN), an account number, and contact information. +## Fields + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) + +### ASN + +The AS number assigned to this provider. + +!!! warning "Legacy field" + This field is being removed in NetBox v3.4. Users are highly encouraged to use the [ASN model](../ipam/asn.md) to track AS number assignment for providers. + +### ASNs + +The [AS numbers](../ipam/asn.md) assigned to this provider (optional). + +### Account Number + +The administrative account identifier tied to this provider for your organization. + +### Portal URL + +The URL for the provider's customer service portal. + +### NOC Contact + +Contact details for the provider's network operations center (NOC). + +### Admin Contact + +Administrative contact details for the provider. diff --git a/docs/models/circuits/providernetwork.md b/docs/models/circuits/providernetwork.md index 42c46e13c..90db02573 100644 --- a/docs/models/circuits/providernetwork.md +++ b/docs/models/circuits/providernetwork.md @@ -2,4 +2,16 @@ This model can be used to represent the boundary of a provider network, the details of which are unknown or unimportant to the NetBox user. For example, it might represent a provider's regional MPLS network to which multiple circuits provide connectivity. -Each provider network must be assigned to a provider, and may optionally be assigned an arbitrary service ID. A circuit may terminate to either a provider network or to a site. +## Fields + +### Provider + +The [provider](./provider.md) responsible for the operation of this network. + +### Name + +A human-friendly name, unique to the provider. + +### Service ID + +An arbitrary identifier used as an alternate reference for the type of connectivity or service being delivered. From cff6b81f1fdfbc888e60e97be570262182d30fed Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 16:00:04 -0400 Subject: [PATCH 389/593] Refreshed extras model documentation --- docs/features/context-data.md | 58 ++++++++++++++-- docs/features/customization.md | 12 ++++ docs/models/extras/configcontext.md | 68 ++++--------------- docs/models/extras/customfield.md | 2 + docs/models/extras/customlink.md | 2 + docs/models/extras/exporttemplate.md | 2 + docs/models/extras/imageattachment.md | 10 +++ docs/models/extras/tag.md | 18 ++--- docs/models/extras/webhook.md | 95 ++++++++++++++++++++++----- 9 files changed, 184 insertions(+), 83 deletions(-) diff --git a/docs/features/context-data.md b/docs/features/context-data.md index d202482da..04e795fd5 100644 --- a/docs/features/context-data.md +++ b/docs/features/context-data.md @@ -11,10 +11,6 @@ Configuration context data (or "config contexts" for short) is a powerful featur } ``` -While this is handy on its own, the real power of context data stems from its ability to be merged and overridden using multiple instances. For example, perhaps you need to define _different_ syslog servers within the region for a particular device role. You can create a second config context with the appropriate data and a higher weight, and apply it to the desired role. This will override the lower-weight data that applies to the entire region. As you can imagine, this flexibility can cater to many complex use cases. - -There are no restrictions around what data can be stored in a configuration context, so long as it can be expressed in JSON. Additionally, each device and VM may have local context data defined: This data is stored directly on the assigned object, and applies to it only. This is a convenient way for "attaching" miscellaneous data to a single device or VM as needed. - Config contexts can be computed for objects based on the following criteria: | Type | Devices | Virtual Machines | @@ -32,3 +28,57 @@ Config contexts can be computed for objects based on the following criteria: | Tenant group | :material-check: | :material-check: | | Tenant | :material-check: | :material-check: | | Tag | :material-check: | :material-check: | + +There are no restrictions around what data can be stored in a configuration context, so long as it can be expressed in JSON. + +## Hierarchical Rendering + +While this is handy on its own, the real power of context data stems from its ability to be merged and overridden using multiple instances. For example, perhaps you need to define _different_ syslog servers within the region for a particular device role. You can create a second config context with the appropriate data and a higher weight, and apply it to the desired role. This will override the lower-weight data that applies to the entire region. As you can imagine, this flexibility can cater to many complex use cases. + +For example, suppose we want to specify a set of syslog and NTP servers for all devices within a region. We could create a config context instance with a weight of 1000 assigned to the region, with the following JSON data: + +```json +{ + "ntp-servers": [ + "172.16.10.22", + "172.16.10.33" + ], + "syslog-servers": [ + "172.16.9.100", + "172.16.9.101" + ] +} +``` + +But suppose there's a problem at one particular site within this region preventing traffic from reaching the regional syslog server. Devices there need to use a local syslog server instead of the two defined above. We'll create a second config context assigned only to that site with a weight of 2000 and the following data: + +```json +{ + "syslog-servers": [ + "192.168.43.107" + ] +} +``` + +When the context data for a device at this site is rendered, the second, higher-weight data overwrite the first, resulting in the following: + +```json +{ + "ntp-servers": [ + "172.16.10.22", + "172.16.10.33" + ], + "syslog-servers": [ + "192.168.43.107" + ] +} +``` + +Data from the higher-weight context overwrites conflicting data from the lower-weight context, while the non-conflicting portion of the lower-weight context (the list of NTP servers) is preserved. + +## Local Context Data + +Devices and virtual machines may also have a local context data defined. This local context will _always_ take precedence over any separate config context objects which apply to the device/VM. This is useful in situations where we need to call out a specific deviation in the data for a particular object. + +!!! warning + If you find that you're routinely defining local context data for many individual devices or virtual machines, [custom fields](./customization.md#custom-fields) may offer a more effective solution. diff --git a/docs/features/customization.md b/docs/features/customization.md index d7f2cf40a..813914ae2 100644 --- a/docs/features/customization.md +++ b/docs/features/customization.md @@ -6,6 +6,18 @@ While NetBox strives to meet the needs of every network, the needs of users to c Most objects in NetBox can be assigned user-created tags to aid with organization and filtering. Tag values are completely arbitrary: They may be used to store data in key-value pairs, or they may be employed simply as labels against which objects can be filtered. Each tag can also be assigned a color for quicker differentiation in the user interface. +Objects can be filtered by the tags they have applied. For example, the following API request will retrieve all devices tagged as "monitored": + +```no-highlight +GET /api/dcim/devices/?tag=monitored +``` + +The `tag` filter can be specified multiple times to match only objects which have _all_ the specified tags assigned: + +```no-highlight +GET /api/dcim/devices/?tag=monitored&tag=deprecated +``` + ## Custom Fields While NetBox provides a rather extensive data model out of the box, the need may arise to store certain additional data associated with NetBox objects. For example, you might need to record the invoice ID alongside an installed device, or record an approving authority when creating a new IP prefix. NetBox administrators can create custom fields on built-in objects to meet these needs. diff --git a/docs/models/extras/configcontext.md b/docs/models/extras/configcontext.md index 08b5f4fd5..156b2d784 100644 --- a/docs/models/extras/configcontext.md +++ b/docs/models/extras/configcontext.md @@ -1,69 +1,27 @@ # Configuration Contexts -Sometimes it is desirable to associate additional data with a group of devices or virtual machines to aid in automated configuration. For example, you might want to associate a set of syslog servers for all devices within a particular region. Context data enables the association of extra user-defined data with devices and virtual machines grouped by one or more of the following assignments: +Context data is made available to [devices](../dcim/device.md) and/or [virtual machines](../virtualization/virtualmachine.md) based on their relationships to other objects in NetBox. For example, context data can be associated only with devices assigned to a particular site, or only to virtual machines in a certain cluster. -* Region -* Site group -* Site -* Location (devices only) -* Device type (devices only) -* Role -* Platform -* Cluster type (VMs only) -* Cluster group (VMs only) -* Cluster (VMs only) -* Tenant group -* Tenant -* Tag +See the [context data documentation](../../features/context-data.md) for more information. -## Hierarchical Rendering +## Fields -Context data is arranged hierarchically, so that data with a higher weight can be entered to override lower-weight data. Multiple instances of data are automatically merged by NetBox to present a single dictionary for each object. +### Name -For example, suppose we want to specify a set of syslog and NTP servers for all devices within a region. We could create a config context instance with a weight of 1000 assigned to the region, with the following JSON data: +A unique human-friendly name. -```json -{ - "ntp-servers": [ - "172.16.10.22", - "172.16.10.33" - ], - "syslog-servers": [ - "172.16.9.100", - "172.16.9.101" - ] -} -``` +### Weight -But suppose there's a problem at one particular site within this region preventing traffic from reaching the regional syslog server. Devices there need to use a local syslog server instead of the two defined above. We'll create a second config context assigned only to that site with a weight of 2000 and the following data: +A numeric value which influences the order in which context data is merged. Contexts with a lower weight are merged before those with a higher weight. -```json -{ - "syslog-servers": [ - "192.168.43.107" - ] -} -``` +### Data -When the context data for a device at this site is rendered, the second, higher-weight data overwrite the first, resulting in the following: +The context data expressed in JSON format. -```json -{ - "ntp-servers": [ - "172.16.10.22", - "172.16.10.33" - ], - "syslog-servers": [ - "192.168.43.107" - ] -} -``` +### Is Active -Data from the higher-weight context overwrites conflicting data from the lower-weight context, while the non-conflicting portion of the lower-weight context (the list of NTP servers) is preserved. +If not selected, this config context will be excluded from rendering. This can be convenient to temporarily disable a config context. -## Local Context Data +### Object Assignment -Devices and virtual machines may also have a local config context defined. This local context will _always_ take precedence over any separate config context objects which apply to the device/VM. This is useful in situations where we need to call out a specific deviation in the data for a particular object. - -!!! warning - If you find that you're routinely defining local context data for many individual devices or virtual machines, custom fields may offer a more effective solution. +Each configuration context may be assigned with any number of objects of the supported types. If no related objects are selected, it will be considered a "global" config context and apply to all devices and virtual machines. diff --git a/docs/models/extras/customfield.md b/docs/models/extras/customfield.md index 0b2bc29f9..ee1fde2b7 100644 --- a/docs/models/extras/customfield.md +++ b/docs/models/extras/customfield.md @@ -1,5 +1,7 @@ # Custom Fields +NetBox administrators can extend NetBox's built-in data model by adding custom fields to most object types. See the [custom fields documentation](../../customization/custom-fields.md) for more information. + ## Fields ### Model(s) diff --git a/docs/models/extras/customlink.md b/docs/models/extras/customlink.md index 458007ab1..dae9978aa 100644 --- a/docs/models/extras/customlink.md +++ b/docs/models/extras/customlink.md @@ -1,5 +1,7 @@ # Custom Links +Users can add custom links to object views in NetBox to reference external resources. For example, you might create a custom link for devices pointing to a monitoring system. See the [custom links documentation](../../customization/custom-links.md) for more information. + ## Fields ### Name diff --git a/docs/models/extras/exporttemplate.md b/docs/models/extras/exporttemplate.md index 347184324..3215201b3 100644 --- a/docs/models/extras/exporttemplate.md +++ b/docs/models/extras/exporttemplate.md @@ -1,5 +1,7 @@ # Export Templates +Export templates are used to render arbitrary data from a set of NetBox objects. For example, you might want to automatically generate a network monitoring service configuration from a list of device objects. See the [export templates documentation](../../customization/export-templates.md) for more information. + ## Fields ### Name diff --git a/docs/models/extras/imageattachment.md b/docs/models/extras/imageattachment.md index da15462ab..b8c48f055 100644 --- a/docs/models/extras/imageattachment.md +++ b/docs/models/extras/imageattachment.md @@ -1,3 +1,13 @@ # Image Attachments Certain objects in NetBox support the attachment of uploaded images. These will be saved to the NetBox server and made available whenever the object is viewed. + +## Fields + +### Name + +The name of the image being attached. If not defined, this will be inferred from the name of the uploaded file. + +### Image + +The image file to upload. Note that the uploaded file **must** be a supported image type, or validation will fail. diff --git a/docs/models/extras/tag.md b/docs/models/extras/tag.md index fe6a1ef36..97ebd9d72 100644 --- a/docs/models/extras/tag.md +++ b/docs/models/extras/tag.md @@ -2,16 +2,16 @@ Tags are user-defined labels which can be applied to a variety of objects within NetBox. They can be used to establish dimensions of organization beyond the relationships built into NetBox. For example, you might create a tag to identify a particular ownership or condition across several types of objects. -Each tag has a label, color, and a URL-friendly slug. For example, the slug for a tag named "Dunder Mifflin, Inc." would be `dunder-mifflin-inc`. The slug is generated automatically and makes tags easier to work with as URL parameters. Each tag can also be assigned a description indicating its purpose. +## Fields -Objects can be filtered by the tags they have applied. For example, the following API request will retrieve all devices tagged as "monitored": +### Name -```no-highlight -GET /api/dcim/devices/?tag=monitored -``` +A unique human-friendly label for the tag. -The `tag` filter can be specified multiple times to match only objects which have _all_ of the specified tags assigned: +### Slug -```no-highlight -GET /api/dcim/devices/?tag=monitored&tag=deprecated -``` +A unique URL-friendly identifier. (This value will be used for filtering.) This is automatically generated from the tag's name, but can be altered as needed. + +### Color + +The color to use when displaying the tag in the NetBox UI. diff --git a/docs/models/extras/webhook.md b/docs/models/extras/webhook.md index 2d598f8ae..1ca6ec191 100644 --- a/docs/models/extras/webhook.md +++ b/docs/models/extras/webhook.md @@ -1,19 +1,84 @@ # Webhooks -A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver. Webhooks are managed under Logging > Webhooks. +A webhook is a mechanism for conveying to some external system a change that took place in NetBox. For example, you may want to notify a monitoring system whenever the status of a device is updated in NetBox. This can be done by creating a webhook for the device model in NetBox and identifying the webhook receiver. When NetBox detects a change to a device, an HTTP request containing the details of the change and who made it be sent to the specified receiver. -## Model Fields +See the [webhooks documentation](../../integrations/webhooks.md) for more information. -* **Name** - A unique name for the webhook. The name is not included with outbound messages. -* **Object type(s)** - The type or types of NetBox object that will trigger the webhook. -* **Enabled** - If unchecked, the webhook will be inactive. -* **Events** - A webhook may trigger on any combination of create, update, and delete events. At least one event type must be selected. -* **HTTP method** - The type of HTTP request to send. Options include `GET`, `POST`, `PUT`, `PATCH`, and `DELETE`. -* **URL** - The fully-qualified URL of the request to be sent. This may specify a destination port number if needed. Jinja2 templating is supported for this field. -* **HTTP content type** - The value of the request's `Content-Type` header. (Defaults to `application/json`) -* **Additional headers** - Any additional headers to include with the request (optional). Add one header per line in the format `Name: Value`. Jinja2 templating is supported for this field (see below). -* **Body template** - The content of the request being sent (optional). Jinja2 templating is supported for this field (see below). If blank, NetBox will populate the request body with a raw dump of the webhook context. (If the HTTP cotent type is set to `application/json`, this will be formatted as a JSON object.) -* **Secret** - A secret string used to prove authenticity of the request (optional). This will append a `X-Hook-Signature` header to the request, consisting of a HMAC (SHA-512) hex digest of the request body using the secret as the key. -* **Conditions** - An optional set of conditions evaluated to determine whether the webhook fires for a given object. -* **SSL verification** - Uncheck this option to disable validation of the receiver's SSL certificate. (Disable with caution!) -* **CA file path** - The file path to a particular certificate authority (CA) file to use when validating the receiver's SSL certificate (optional). +## Fields + +### Name + +A unique human-friendly name. + +### Content Types + +The type(s) of object in NetBox that will trigger the webhook. + +### Enabled + +If not selected, the webhook will be inactive. + +### Events + +The events which will trigger the webhook. At least one event type must be selected. + +| Name | Description | +|-----------|--------------------------------------| +| Creations | A new object has been created | +| Updates | An existing object has been modified | +| Deletions | An object has been deleted | + +### URL + +The URL to which the webhook HTTP request will be made. + +### HTTP Method + +The type of HTTP request to send. Options are: + +* `GET` +* `POST` +* `PUT` +* `PATCH` +* `DELETE` + +### HTTP Content Type + +The content type to indicate in the outgoing HTTP request header. See [this list](https://www.iana.org/assignments/media-types/media-types.xhtml) of known types for reference. + +### Additional Headers + +Any additional header to include with the outgoing HTTP request. These should be defined in the format `Name: Value`, with each header on a separate line. Jinja2 templating is supported for this field. + +### Body Template + +Jinja2 template for a custom request body, if desired. If not defined, NetBox will populate the request body with a raw dump of the webhook context. + +### Secret + +A secret string used to prove authenticity of the request (optional). This will append a `X-Hook-Signature` header to the request, consisting of a HMAC (SHA-512) hex digest of the request body using the secret as the key. + +### SSL Verification + +Controls whether validation of the receiver's SSL certificate is enforced when HTTPS is used. + +!!! warning + Disabling this can expose your webhooks to man-in-the-middle attacks. + +### CA File Path + +The file path to a particular certificate authority (CA) file to use when validating the receiver's SSL certificate (if not using the system defaults). + +## Context Data + +The following context variables are available in to the text and link templates. + +| Variable | Description | +|--------------|----------------------------------------------------| +| `event` | The event type (`create`, `update`, or `delete`) | +| `timestamp` | The time at which the event occured | +| `model` | The type of object impacted | +| `username` | The name of the user associated with the change | +| `request_id` | The unique request ID | +| `data` | A complete serialized representation of the object | +| `snapshots` | Pre- and post-change snapshots of the object | From 040feddcf1ee29c65c1a0515d23b3412cf89b217 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 16:19:34 -0400 Subject: [PATCH 390/593] Refreshed tenancy model documentation --- docs/features/contacts.md | 17 ++++++++++ docs/features/tenancy.md | 18 ++++++++++- docs/models/tenancy/contact.md | 48 +++++++++++++++-------------- docs/models/tenancy/contactgroup.md | 16 +++++++++- docs/models/tenancy/contactrole.md | 12 +++++++- docs/models/tenancy/tenant.md | 26 ++++++++-------- docs/models/tenancy/tenantgroup.md | 16 +++++++++- 7 files changed, 113 insertions(+), 40 deletions(-) diff --git a/docs/features/contacts.md b/docs/features/contacts.md index 6bbd217fc..40e8dd12c 100644 --- a/docs/features/contacts.md +++ b/docs/features/contacts.md @@ -26,3 +26,20 @@ A contact role defines the relationship of a contact to an assigned object. For A contact should represent an individual or permanent point of contact. Each contact must define a name, and may optionally include a title, phone number, email address, and related details. Contacts are reused for assignments, so each unique contact must be created only once and can be assigned to any number of NetBox objects, and there is no limit to the number of assigned contacts an object may have. Most core objects in NetBox can have contacts assigned to them. + +The following models support the assignment of contacts: + +* circuits.Circuit +* circuits.Provider +* dcim.Device +* dcim.Location +* dcim.Manufacturer +* dcim.PowerPanel +* dcim.Rack +* dcim.Region +* dcim.Site +* dcim.SiteGroup +* tenancy.Tenant +* virtualization.Cluster +* virtualization.ClusterGroup +* virtualization.VirtualMachine diff --git a/docs/features/tenancy.md b/docs/features/tenancy.md index a278dc4c2..470905f20 100644 --- a/docs/features/tenancy.md +++ b/docs/features/tenancy.md @@ -13,10 +13,26 @@ click TenantGroup "../../models/tenancy/tenantgroup/" ## Tenant Groups -Tenants can be grouped by any logic that your use case demands, and groups can nested recursively for maximum flexibility. For example, You might define a parent "Customers" group with child groups "Current" and "Past" within it. A tenant can be assigned to a group at any level within the hierarchy. +Tenants can be grouped by any logic that your use case demands, and groups can be nested recursively for maximum flexibility. For example, You might define a parent "Customers" group with child groups "Current" and "Past" within it. A tenant can be assigned to a group at any level within the hierarchy. ## Tenants Typically, the tenant model is used to represent a customer or internal organization, however it can be used for whatever purpose meets your needs. Most core objects within NetBox can be assigned to particular tenant, so this model provides a very convenient way to correlate ownership across object types. For example, each of your customers might have its own racks, devices, IP addresses, circuits and so on: These can all be easily tracked via tenant assignment. + +The following objects can be assigned to tenants: + +* Sites +* Racks +* Rack reservations +* Devices +* VRFs +* Prefixes +* IP addresses +* VLANs +* Circuits +* Clusters +* Virtual machines + +Tenant assignment is used to signify the ownership of an object in NetBox. As such, each object may only be owned by a single tenant. For example, if you have a firewall dedicated to a particular customer, you would assign it to the tenant which represents that customer. However, if the firewall serves multiple customers, it doesn't *belong* to any particular customer, so tenant assignment would not be appropriate. diff --git a/docs/models/tenancy/contact.md b/docs/models/tenancy/contact.md index 9d81e2d85..eac630180 100644 --- a/docs/models/tenancy/contact.md +++ b/docs/models/tenancy/contact.md @@ -1,31 +1,33 @@ # Contacts -A contact represent an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one or more operational contacts to each site. Contacts can be arranged within nested contact groups. +A contact represents an individual or group that has been associated with an object in NetBox for administrative reasons. For example, you might assign one or more operational contacts to each site. -Each contact must include a name, which is unique to its parent group (if any). The following optional descriptors are also available: +## Fields -* Title -* Phone -* Email -* Address +### Group -## Contact Assignment +The [contact group](./contactgroup.md) to which this contact is assigned (if any). -Each contact can be assigned to one or more objects, allowing for the efficient reuse of contact information. When assigning a contact to an object, the user may optionally specify a role and/or priority (primary, secondary, tertiary, or inactive) to better convey the nature of the contact's relationship to the assigned object. +### Name -The following models support the assignment of contacts: +The name of the contact. This may be an individual or a team/department. (This is the only required contact detail; all others are optional.) -* circuits.Circuit -* circuits.Provider -* dcim.Device -* dcim.Location -* dcim.Manufacturer -* dcim.PowerPanel -* dcim.Rack -* dcim.Region -* dcim.Site -* dcim.SiteGroup -* tenancy.Tenant -* virtualization.Cluster -* virtualization.ClusterGroup -* virtualization.VirtualMachine +### Title + +The contact's title or role. + +### Phone + +The contact's phone number. (Note that NetBox does _not_ enforce a particular numbering format.) + +### Email + +The contact's email address. + +### Address + +The contact's physical or mailing address. + +### Link + +A URL to reach the contact via some other means. diff --git a/docs/models/tenancy/contactgroup.md b/docs/models/tenancy/contactgroup.md index ea566c58a..49efb7c18 100644 --- a/docs/models/tenancy/contactgroup.md +++ b/docs/models/tenancy/contactgroup.md @@ -1,3 +1,17 @@ # Contact Groups -Contacts can be organized into arbitrary groups. These groups can be recursively nested for convenience. Each contact within a group must have a unique name, but other attributes can be repeated. +[Contacts](./contact.md) can be organized into arbitrary groups. These groups can be recursively nested for convenience. Each contact within a group must have a unique name, but other attributes can be repeated. + +## Fields + +### Parent + +The parent contact group (if any). + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) diff --git a/docs/models/tenancy/contactrole.md b/docs/models/tenancy/contactrole.md index 23642ca03..bc8e1c802 100644 --- a/docs/models/tenancy/contactrole.md +++ b/docs/models/tenancy/contactrole.md @@ -1,3 +1,13 @@ # Contact Roles -Contacts can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for administrative, operational, or emergency contacts. +[Contacts](./contact.md) can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for administrative, operational, or emergency contacts. + +## Fields + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) diff --git a/docs/models/tenancy/tenant.md b/docs/models/tenancy/tenant.md index 60a160b9e..7df6992d1 100644 --- a/docs/models/tenancy/tenant.md +++ b/docs/models/tenancy/tenant.md @@ -1,17 +1,17 @@ # Tenants -A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or internal departments within an organization. The following objects can be assigned to tenants: +A tenant represents a discrete grouping of resources used for administrative purposes. Typically, tenants are used to represent individual customers or internal departments within an organization. -* Sites -* Racks -* Rack reservations -* Devices -* VRFs -* Prefixes -* IP addresses -* VLANs -* Circuits -* Clusters -* Virtual machines +## Fields -Tenant assignment is used to signify the ownership of an object in NetBox. As such, each object may only be owned by a single tenant. For example, if you have a firewall dedicated to a particular customer, you would assign it to the tenant which represents that customer. However, if the firewall serves multiple customers, it doesn't *belong* to any particular customer, so tenant assignment would not be appropriate. +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) + +### Group + +The [tenant group](./tenantgroup.md) to which this tenant belongs (if any). diff --git a/docs/models/tenancy/tenantgroup.md b/docs/models/tenancy/tenantgroup.md index 078a71a72..f9929ff66 100644 --- a/docs/models/tenancy/tenantgroup.md +++ b/docs/models/tenancy/tenantgroup.md @@ -1,5 +1,19 @@ # Tenant Groups -Tenants can be organized by custom groups. For instance, you might create one group called "Customers" and one called "Departments." The assignment of a tenant to a group is optional. +[Tenants](./tenant.md) can be organized by custom groups. For instance, you might create one group called "Customers" and one called "Departments." The assignment of a tenant to a group is optional. Tenant groups may be nested recursively to achieve a multi-level hierarchy. For example, you might have a group called "Customers" containing subgroups of individual tenants grouped by product or account team. + +## Fields + +### Parent + +The parent tenant group (if any). + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) From d4f976ac8dd2cd39f4e41520c003f77a7eac6210 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Fri, 12 Aug 2022 16:37:47 -0400 Subject: [PATCH 391/593] Refreshed wireless model documentation --- docs/models/wireless/wirelesslan.md | 39 +++++++++++++++++---- docs/models/wireless/wirelesslangroup.md | 16 ++++++++- docs/models/wireless/wirelesslink.md | 43 +++++++++++++++++++++--- 3 files changed, 86 insertions(+), 12 deletions(-) diff --git a/docs/models/wireless/wirelesslan.md b/docs/models/wireless/wirelesslan.md index cb478664c..5bb3dbd65 100644 --- a/docs/models/wireless/wirelesslan.md +++ b/docs/models/wireless/wirelesslan.md @@ -1,11 +1,38 @@ # Wireless LANs -A wireless LAN is a set of interfaces connected via a common wireless channel. Each instance must have an SSID, and may optionally be correlated to a VLAN. Wireless LANs can be arranged into hierarchical groups, and each may be associated with a particular tenant. +A wireless LAN is a set of interfaces connected via a common wireless channel, identified by its SSID and authentication parameters. Wireless [interfaces](../dcim/interface.md) can be associated with wireless LANs to model multi-acess wireless segments. -An interface may be attached to multiple wireless LANs, provided they are all operating on the same channel. Only wireless interfaces may be attached to wireless LANs. +## Fields -Each wireless LAN may have authentication attributes associated with it, including: +### SSID -* Authentication type -* Cipher -* Pre-shared key +The service set identifier (SSID) for the wireless network. + +### Group + +The [wireless LAN group](./wirelesslangroup.md) to which this wireless LAN is assigned (if any). + +### VLAN + +Each wireless LAN can optionally be mapped to a [VLAN](../ipam/vlan.md), to model a bridge between wired and wireless segments. + +### Authentication Type + +The type of wireless authentication in use. Options include: + +* Open +* WEP +* WPA Personal (PSK) +* WPA Enterprise + +### Authentication Cipher + +The security cipher used to apply wireless authentication. Options include: + +* Auto (automatic) +* TKIP +* AES + +### Pre-Shared Key + +The security key configured on each client to grant access to the secured wireless LAN. This applies only to certain authentication types. diff --git a/docs/models/wireless/wirelesslangroup.md b/docs/models/wireless/wirelesslangroup.md index e477abd0b..37871f208 100644 --- a/docs/models/wireless/wirelesslangroup.md +++ b/docs/models/wireless/wirelesslangroup.md @@ -1,3 +1,17 @@ # Wireless LAN Groups -Wireless LAN groups can be used to organize and classify wireless LANs. These groups are hierarchical: groups can be nested within parent groups. However, each wireless LAN may assigned only to one group. +Wireless LAN groups can be used to organize and classify [wireless LANs](./wirelesslan.md). These groups are hierarchical: groups can be nested within parent groups. However, each wireless LAN may be assigned only to one group. + +## Fields + +### Parent + +The parent wireless LAN group (if any). + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) diff --git a/docs/models/wireless/wirelesslink.md b/docs/models/wireless/wirelesslink.md index f52dc7191..c9b331570 100644 --- a/docs/models/wireless/wirelesslink.md +++ b/docs/models/wireless/wirelesslink.md @@ -1,9 +1,42 @@ # Wireless Links -A wireless link represents a connection between exactly two wireless interfaces. It may optionally be assigned an SSID and a description. It may also have a status assigned to it, similar to the cable model. Each wireless link may also be assigned to a particular tenant. +A wireless link represents a connection between exactly two wireless interfaces. Unlike a [wireless LAN](./wirelesslan.md), which permit an arbitrary number of client associations, wireless links are used to model point-to-point wireless connections. -Each wireless link may have authentication attributes associated with it, including: +## Fields -* Authentication type -* Cipher -* Pre-shared key +### Interfaces + +Select two interfaces: One for side A and one for side B. (Both must be wireless interfaces.) + +### Status + +The operational status of the link. Options include: + +* Connected +* Planned +* Decommissioning + +### SSID + +The service set identifier (SSID) for the wireless link (optional). + +### Authentication Type + +The type of wireless authentication in use. Options include: + +* Open +* WEP +* WPA Personal (PSK) +* WPA Enterprise + +### Authentication Cipher + +The security cipher used to apply wireless authentication. Options include: + +* Auto (automatic) +* TKIP +* AES + +### Pre-Shared Key + +The security key configured on each client to grant access to the secured wireless LAN. This applies only to certain authentication types. From f942216f3f4931c0d1e835948478e976172713ab Mon Sep 17 00:00:00 2001 From: Christoph Schneider Date: Sat, 13 Aug 2022 13:54:38 +0200 Subject: [PATCH 392/593] re-enable markup in longtext custom columns --- netbox/netbox/tables/columns.py | 10 ++++++++++ netbox/netbox/tables/tables.py | 3 ++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index cc20bdd0c..8b961219f 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -418,6 +418,14 @@ class CustomFieldColumn(tables.Column): """ Display custom fields in the appropriate format. """ + template_code = """ + {% if value %} + {{ value|markdown }} + {% else %} + — + {% endif %} + """ + def __init__(self, customfield, *args, **kwargs): self.customfield = customfield kwargs['accessor'] = Accessor(f'custom_field_data__{customfield.name}') @@ -445,6 +453,8 @@ class CustomFieldColumn(tables.Column): return mark_safe(', '.join( self._likify_item(obj) for obj in self.customfield.deserialize(value) )) + if self.customfield.type == CustomFieldTypeChoices.TYPE_LONGTEXT: + return Template(self.template_code).render(Context({"value": value})) if value is not None: obj = self.customfield.deserialize(value) return mark_safe(self._likify_item(obj)) diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index d55038c4d..deb0d8b90 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -181,7 +181,8 @@ class NetBoxTable(BaseTable): content_type = ContentType.objects.get_for_model(self._meta.model) custom_fields = CustomField.objects.filter(content_types=content_type) extra_columns.extend([ - (f'cf_{cf.name}', columns.CustomFieldMarkdownColumn(cf) if cf.type == CustomFieldTypeChoices.TYPE_LONGTEXT else columns.CustomFieldColumn(cf)) for cf in custom_fields + # (f'cf_{cf.name}', columns.CustomFieldMarkdownColumn(cf) if cf.type == CustomFieldTypeChoices.TYPE_LONGTEXT else columns.CustomFieldColumn(cf)) for cf in custom_fields + (f'cf_{cf.name}', columns.CustomFieldColumn(cf)) for cf in custom_fields ]) custom_links = CustomLink.objects.filter(content_type=content_type, enabled=True) extra_columns.extend([ From 6f09d94e2a99330ecd09e7d3ee0600fba8386716 Mon Sep 17 00:00:00 2001 From: Christoph Schneider Date: Sat, 13 Aug 2022 13:56:51 +0200 Subject: [PATCH 393/593] remove commented line --- netbox/netbox/tables/tables.py | 1 - 1 file changed, 1 deletion(-) diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index deb0d8b90..63aae1d19 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -181,7 +181,6 @@ class NetBoxTable(BaseTable): content_type = ContentType.objects.get_for_model(self._meta.model) custom_fields = CustomField.objects.filter(content_types=content_type) extra_columns.extend([ - # (f'cf_{cf.name}', columns.CustomFieldMarkdownColumn(cf) if cf.type == CustomFieldTypeChoices.TYPE_LONGTEXT else columns.CustomFieldColumn(cf)) for cf in custom_fields (f'cf_{cf.name}', columns.CustomFieldColumn(cf)) for cf in custom_fields ]) custom_links = CustomLink.objects.filter(content_type=content_type, enabled=True) From ac540b6183bd5bf8db57b1941de24aafc7b04f3c Mon Sep 17 00:00:00 2001 From: Christoph Schneider Date: Sat, 13 Aug 2022 13:59:19 +0200 Subject: [PATCH 394/593] remove import --- netbox/netbox/tables/tables.py | 1 - 1 file changed, 1 deletion(-) diff --git a/netbox/netbox/tables/tables.py b/netbox/netbox/tables/tables.py index 63aae1d19..8c5fb039c 100644 --- a/netbox/netbox/tables/tables.py +++ b/netbox/netbox/tables/tables.py @@ -7,7 +7,6 @@ from django.db.models.fields.related import RelatedField from django_tables2.data import TableQuerysetData from extras.models import CustomField, CustomLink -from extras.choices import CustomFieldTypeChoices from netbox.tables import columns from utilities.paginator import EnhancedPaginator, get_paginate_count From 36491b13d86b26a0e75d84b8b5db64403f3fbe89 Mon Sep 17 00:00:00 2001 From: Christoph Schneider Date: Sat, 13 Aug 2022 14:01:07 +0200 Subject: [PATCH 395/593] remove class definition --- netbox/netbox/tables/columns.py | 27 +-------------------------- 1 file changed, 1 insertion(+), 26 deletions(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index 8b961219f..4918dd3b9 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -559,29 +559,4 @@ class MarkdownColumn(tables.TemplateColumn): ) def value(self, value): - return value - - -class CustomFieldMarkdownColumn(tables.TemplateColumn): - """ - Render a Markdown string in a longtext custom column. - """ - template_code = """ - {% if value %} - {{ value|markdown }} - {% else %} - — - {% endif %} - """ - - def __init__(self, customfield, *args, **kwargs): - self.customfield = customfield - kwargs['accessor'] = Accessor(f'custom_field_data__{customfield.name}') - kwargs['template_code'] = self.template_code - if 'verbose_name' not in kwargs: - kwargs['verbose_name'] = customfield.label or customfield.name - - super().__init__(*args, **kwargs) - - def value(self, value): - return value + return value \ No newline at end of file From 15f4b1fd5daa5c8dd4338352d37049b47e4bf7de Mon Sep 17 00:00:00 2001 From: Christoph Schneider Date: Sat, 13 Aug 2022 14:02:26 +0200 Subject: [PATCH 396/593] add newline --- netbox/netbox/tables/columns.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index 4918dd3b9..113c8416b 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -559,4 +559,4 @@ class MarkdownColumn(tables.TemplateColumn): ) def value(self, value): - return value \ No newline at end of file + return value From f76ce172e04c1f8561d48416083e72f99a992c37 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 15 Aug 2022 11:57:38 -0400 Subject: [PATCH 397/593] Update model docs for device components --- docs/models/dcim/consoleport.md | 37 ++++- docs/models/dcim/consoleporttemplate.md | 4 +- docs/models/dcim/consoleserverport.md | 37 ++++- docs/models/dcim/consoleserverporttemplate.md | 4 +- docs/models/dcim/devicebay.md | 18 ++- docs/models/dcim/devicebaytemplate.md | 4 +- docs/models/dcim/frontport.md | 41 ++++- docs/models/dcim/frontporttemplate.md | 4 +- docs/models/dcim/interface.md | 140 +++++++++++++++--- docs/models/dcim/interfacetemplate.md | 4 +- docs/models/dcim/inventoryitem.md | 40 ++++- docs/models/dcim/inventoryitemtemplate.md | 2 +- docs/models/dcim/modulebay.md | 25 +++- docs/models/dcim/modulebaytemplate.md | 4 +- docs/models/dcim/poweroutlet.md | 38 ++++- docs/models/dcim/poweroutlettemplate.md | 4 +- docs/models/dcim/powerport.md | 40 ++++- docs/models/dcim/powerporttemplate.md | 4 +- docs/models/dcim/rearport.md | 38 ++++- docs/models/dcim/rearporttemplate.md | 4 +- 20 files changed, 432 insertions(+), 60 deletions(-) diff --git a/docs/models/dcim/consoleport.md b/docs/models/dcim/consoleport.md index 1a0782f25..e9cd09836 100644 --- a/docs/models/dcim/consoleport.md +++ b/docs/models/dcim/consoleport.md @@ -1,5 +1,36 @@ -## Console Ports +# Console Ports -A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the device, or for remote out-of-band access provided via a networked console server. Each console port may be assigned a physical type. +A console port provides connectivity to the physical console of a device. These are typically used for temporary access by someone who is physically near the device, or for remote out-of-band access provided via a networked console server. -Cables can connect console ports to console server ports or pass-through ports. +!!! tip + Like most device components, console ports are instantiated automatically from [console port templates](./consoleporttemplate.md) assigned to the selected device type when a device is created. + +## Fields + +### Device + +The device to which this console port belongs. + +### Module + +The installed module within the assigned device to which this console port belongs (optional). + +### Name + +The name of the console port. Must be unique to the parent device. + +### Label + +An alternative physical label identifying the console port. + +### Type + +The type of console port. + +### Speed + +Operating speed, in bits per second (bps). + +### Mark Connected + +If selected, this component will be treated as if a cable has been connected. diff --git a/docs/models/dcim/consoleporttemplate.md b/docs/models/dcim/consoleporttemplate.md index 3462ff253..67d91de68 100644 --- a/docs/models/dcim/consoleporttemplate.md +++ b/docs/models/dcim/consoleporttemplate.md @@ -1,3 +1,3 @@ -## Console Port Templates +# Console Port Templates -A template for a console port that will be created on all instantiations of the parent device type. Each console port can be assigned a physical type. +A template for a console port that will be created on all instantiations of the parent device type. See the [console port](./consoleport.md) documentation for more detail. diff --git a/docs/models/dcim/consoleserverport.md b/docs/models/dcim/consoleserverport.md index da1ee8986..1fbb653a8 100644 --- a/docs/models/dcim/consoleserverport.md +++ b/docs/models/dcim/consoleserverport.md @@ -1,5 +1,36 @@ -## Console Server Ports +# Console Server Ports -A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band access to network devices. Each console server port may be assigned a physical type. +A console server is a device which provides remote access to the local consoles of connected devices. They are typically used to provide remote out-of-band access to network devices, and generally connect to [console ports](./consoleport.md). -Cables can connect console server ports to console ports or pass-through ports. +!!! tip + Like most device components, console server ports are instantiated automatically from [console server port templates](./consoleserverporttemplate.md) assigned to the selected device type when a device is created. + +## Fields + +### Device + +The device to which this console server port belongs. + +### Module + +The installed module within the assigned device to which this console server port belongs (optional). + +### Name + +The name of the console server port. Must be unique to the parent device. + +### Label + +An alternative physical label identifying the console server port. + +### Type + +The type of console server port. + +### Speed + +Operating speed, in bits per second (bps). + +### Mark Connected + +If selected, this component will be treated as if a cable has been connected. \ No newline at end of file diff --git a/docs/models/dcim/consoleserverporttemplate.md b/docs/models/dcim/consoleserverporttemplate.md index cc4e8bcd3..c599e738a 100644 --- a/docs/models/dcim/consoleserverporttemplate.md +++ b/docs/models/dcim/consoleserverporttemplate.md @@ -1,3 +1,3 @@ -## Console Server Port Templates +# Console Server Port Templates -A template for a console server port that will be created on all instantiations of the parent device type. Each console server port can be assigned a physical type. +A template for a console server port that will be created on all instantiations of the parent device type. See the [console server port](./consoleserverport.md) documentation for more detail. diff --git a/docs/models/dcim/devicebay.md b/docs/models/dcim/devicebay.md index e79c426dc..f4f807c4a 100644 --- a/docs/models/dcim/devicebay.md +++ b/docs/models/dcim/devicebay.md @@ -1,8 +1,22 @@ -## Device Bays +# Device Bays Device bays represent a space or slot within a parent device in which a child device may be installed. For example, a 2U parent chassis might house four individual blade servers. The chassis would appear in the rack elevation as a 2U device with four device bays, and each server within it would be defined as a 0U device installed in one of the device bays. Child devices do not appear within rack elevations or count as consuming rack units. Child devices are first-class Devices in their own right: That is, they are fully independent managed entities which don't share any control plane with the parent. Just like normal devices, child devices have their own platform (OS), role, tags, and components. LAG interfaces may not group interfaces belonging to different child devices. !!! note - Device bays are **not** suitable for modeling line cards (such as those commonly found in chassis-based routers and switches), as these components depend on the control plane of the parent device to operate. Instead, these should be modeled as modules installed within module bays. + Device bays are **not** suitable for modeling line cards (such as those commonly found in chassis-based routers and switches), as these components depend on the control plane of the parent device to operate. Instead, these should be modeled as [modules](./module.md) installed within [module bays](./modulebay.md). + +## Fields + +### Device + +The device to which this device bay belongs. + +### Name + +The device bay's name. Must be unique to the parent device. + +### Label + +An alternative physical label identifying the device bay. diff --git a/docs/models/dcim/devicebaytemplate.md b/docs/models/dcim/devicebaytemplate.md index a4c50067a..060b799c0 100644 --- a/docs/models/dcim/devicebaytemplate.md +++ b/docs/models/dcim/devicebaytemplate.md @@ -1,3 +1,3 @@ -## Device Bay Templates +# Device Bay Templates -A template for a device bay that will be created on all instantiations of the parent device type. Device bays hold child devices, such as blade servers. +A template for a device bay that will be created on all instantiations of the parent device type. See the [device bay](./devicebay.md) documentation for more detail. diff --git a/docs/models/dcim/frontport.md b/docs/models/dcim/frontport.md index 6f12e8cbf..0b291c9ed 100644 --- a/docs/models/dcim/frontport.md +++ b/docs/models/dcim/frontport.md @@ -1,3 +1,40 @@ -## Front Ports +# Front Ports -Front ports are pass-through ports used to represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in NetBox as front ports. Each port is assigned a physical type, and must be mapped to a specific rear port on the same device. A single rear port may be mapped to multiple front ports, using numeric positions to annotate the specific alignment of each. +Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in NetBox as front ports. Each port is assigned a physical type, and must be mapped to a specific [rear port](./rearport.md) on the same device. A single rear port may be mapped to multiple front ports, using numeric positions to annotate the specific alignment of each. + +## Fields + +### Device + +The device to which this port belongs. + +### Module + +The installed module within the assigned device to which this port belongs (optional). + +### Name + +The port's name. Must be unique to the parent device. + +### Label + +An alternative physical label identifying the port. + +### Type + +The port's termination type. + +### Rear Ports + +The rear port and position to which this front port maps. + +!!! tip + When creating multiple front ports using a patterned name (e.g. `Port [1-12]`), you may select the equivalent number of rear port-position mappings from the list. + +### Color + +The port's color (optional). + +### Mark Connected + +If selected, this component will be treated as if a cable has been connected. diff --git a/docs/models/dcim/frontporttemplate.md b/docs/models/dcim/frontporttemplate.md index 03de0eae4..09535e3b6 100644 --- a/docs/models/dcim/frontporttemplate.md +++ b/docs/models/dcim/frontporttemplate.md @@ -1,3 +1,3 @@ -## Front Port Templates +# Front Port Templates -A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. Front ports may have a physical type assigned, and must be associated with a corresponding rear port and position. This association will be automatically replicated when the device type is instantiated. +A template for a front-facing pass-through port that will be created on all instantiations of the parent device type. See the [front port](./frontport.md) documentation for more detail. diff --git a/docs/models/dcim/interface.md b/docs/models/dcim/interface.md index 87a1411b9..b69f7c6b1 100644 --- a/docs/models/dcim/interface.md +++ b/docs/models/dcim/interface.md @@ -1,34 +1,138 @@ -## Interfaces +# Interfaces -Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but other types are supported as well. Each interface must be assigned a type, and may optionally be assigned a MAC address, MTU, and IEEE 802.1Q mode (tagged or access). Each interface can also be enabled or disabled, and optionally designated as management-only (for out-of-band management). Additionally, each interface may optionally be assigned to a VRF. +Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but other types are supported as well. IP addresses and VLANs can be assigned to interfaces. !!! note - Although devices and virtual machines both can have interfaces, a separate model is used for each. Thus, device interfaces have some properties that are not present on virtual machine interfaces and vice versa. + Although both devices and virtual machines both can have interfaces assigned, a separate model is used for each. Thus, device interfaces have some properties that are not present on virtual machine interfaces and vice versa. -### Interface Types +## Fields -Interfaces may be physical or virtual in nature, but only physical interfaces may be connected via cables. Cables can connect interfaces to pass-through ports, circuit terminations, or other interfaces. Virtual interfaces, such as 802.1Q-tagged subinterfaces, may be assigned to physical parent interfaces. +### Device -Physical interfaces may be arranged into a link aggregation group (LAG) and associated with a parent LAG (virtual) interface. LAG interfaces can be recursively nested to model bonding of trunk groups. Like all virtual interfaces, LAG interfaces cannot be connected physically. +The device to which this interface belongs. -### Power over Ethernet (PoE) +### Module + +The installed module within the assigned device to which this interface belongs (optional). + +### Name + +The name of the interface, as reported by the device's operating system. Must be unique to the parent device. + +### Label + +An alternative physical label identifying the interface. + +### Type + +The type of interface. Interfaces may be physical or virtual in nature, but only physical interfaces may be connected via cables. !!! note - This feature was added in NetBox v3.3. + The interface type refers to the physical termination or port on the device. Interfaces which employ a removable optic or similar transceiver should be defined to represent the type of transceiver in use, irrespective of the physical termination to that transceiver. -Physical interfaces can be assigned a PoE mode to indicate PoE capability: power supplying equipment (PSE) or powered device (PD). Additionally, a PoE mode may be specified. This can be one of the listed IEEE 802.3 standards, or a passive setting (24 or 48 volts across two or four pairs). +### Speed -### Wireless Interfaces +The operating speed, in kilobits per second (kbps). -Wireless interfaces may additionally track the following attributes: +### Duplex -* **Role** - AP or station -* **Channel** - One of several standard wireless channels -* **Channel Frequency** - The transmit frequency -* **Channel Width** - Channel bandwidth +The operation duplex (full, half, or auto). -If a predefined channel is selected, the frequency and width attributes will be assigned automatically. If no channel is selected, these attributes may be defined manually. +### VRF -### IP Address Assignment +The [virtual routing and forwarding](../ipam/vrf.md) instance to which this interface is assigned. -IP addresses can be assigned to interfaces. VLANs can also be assigned to each interface as either tagged or untagged. (An interface may have only one untagged VLAN.) +### MAC Address + +The 48-bit MAC address (for Ethernet interfaces). + +### WWN + +The 64-bit world-wide name (for Fibre Channel interfaces). + +### MTU + +The interface's configured maximum transmissible unit (MTU). + +### Transmit Power + +The interface's configured output power, in dBm (for optical interfaces). + +### Enabled + +If not selected, this interface will be treated as disabled/inoperative. + +### Management Only + +Designates the interface as handling management traffic only (e.g. for out-of-band management connections). + +### Mark Connected + +If selected, this component will be treated as if a cable has been connected. + +### Parent Interface + +Virtual interfaces can be bound to a physical parent interface. This is helpful for modeling virtual interfaces which employ encapsulation on a physical interface, such as an 802.1Q VLAN-tagged subinterface. + +### Bridged Interface + +Interfaces can be bridged to other interfaces on a device in two manners: symmetric or grouped. + +* **Symmetric:** For example, eth0 is bridged to eth1, and eth1 is bridged to eth0. This effects a point-to-point bridge between the two interfaces, which NetBox will follow when tracing cable paths. +* **Grouped:** Multiple interfaces are each bridged to a common virtual bridge interface, effecting a multiaccess bridged segment. NetBox cannot follow these relationships when tracing cable paths, because no forwarding information is available. + +### LAG Interface + +Physical interfaces may be arranged into link aggregation groups (LAGs, also known as "trunks") and associated with a parent LAG (virtual) interface. LAG interfaces can be recursively nested to model bonding of trunk groups. Like all virtual interfaces, LAG interfaces cannot be connected physically. + +### PoE Mode + +The power over Ethernet (PoE) mode for this interface. (This field must be left empty for interfaces which do not support PoE.) Choices include: + +* Powered device (PD) +* Power-supplying equipment (PSE) + +### PoE Type + +The classification of PoE transmission supported, for PoE-enabled interfaces. This can be one of the listed IEEE 802.3 standards, or a passive setting (24 or 48 volts across two or four pairs). + +### 802.1Q Mode + +For switched Ethernet interfaces, this identifies the 802.1Q encapsulation strategy in effect. Options include: + +* **Access:** All traffic is assigned to a single VLAN, with no tagging. +* **Tagged:** One untagged "native" VLAN is allowed, as well as any number of tagged VLANs. +* **Tagged (all):** Implies that all VLANs are carried by the interface. One untagged VLAN may be designated. + +This field must be left blank for routed interfaces which do employ 802.1Q encapsulation. + +### Untagged VLAN + +The "native" (untagged) VLAN for the interface. Valid only when one of the above 802.1Q mode is selected. + +### Tagged VLANs + +The tagged VLANs which are configured to be carried by this interface. Valid only for the "tagged" 802.1Q mode above. + +### Wireless Role + +Indicates the configured role for wireless interfaces (access point or station). + +### Wireless Channel + +The configured channel for wireless interfaces. + +!!! tip + Selecting one of the pre-defined wireless channels will automatically populate the channel frequency and width upon saving the interface. + +### Channel Frequency + +The configured operation frequency of a wireless interface, in MHz. This is typically inferred by the configured channel above, but may be set manually e.g. to identify a licensed channel not available for general use. + +### Channel Width + +The configured channel width of a wireless interface, in MHz. This is typically inferred by the configured channel above, but may be set manually e.g. to identify a licensed channel not available for general use. + +### Wireless LANs + +The [wireless LANs](../wireless/wirelesslan.md) for which this interface carries traffic. (Valid for wireless interfaces only.) diff --git a/docs/models/dcim/interfacetemplate.md b/docs/models/dcim/interfacetemplate.md index e11abcce4..898c4843f 100644 --- a/docs/models/dcim/interfacetemplate.md +++ b/docs/models/dcim/interfacetemplate.md @@ -1,3 +1,3 @@ -## Interface Templates +# Interface Templates -A template for a network interface that will be created on all instantiations of the parent device type. Each interface may be assigned a physical or virtual type, and may be designated as "management-only." Power over Ethernet (PoE) mode and type may also be assigned to interface templates. +A template for a network interface that will be created on all instantiations of the parent device type. See the [interface](./interface.md) documentation for more detail. diff --git a/docs/models/dcim/inventoryitem.md b/docs/models/dcim/inventoryitem.md index fbd3172bb..1c2e894ed 100644 --- a/docs/models/dcim/inventoryitem.md +++ b/docs/models/dcim/inventoryitem.md @@ -2,6 +2,42 @@ Inventory items represent hardware components installed within a device, such as a power supply or CPU or line card. They are intended to be used primarily for inventory purposes. -Each inventory item can be assigned a functional role, manufacturer, part ID, serial number, and asset tag (all optional). A boolean toggle is also provided to indicate whether each item was entered manually or discovered automatically (by some process outside NetBox). - Inventory items are hierarchical in nature, such that any individual item may be designated as the parent for other items. For example, an inventory item might be created to represent a line card which houses several SFP optics, each of which exists as a child item within the device. An inventory item may also be associated with a specific component within the same device. For example, you may wish to associate a transceiver with an interface. + +## Fields + +### Device + +The device in which the inventory item is installed. + +### Parent + +The parent inventory item to which this item is assigned (optional). + +### Name + +The inventory item's name. Must be unique to the parent device. + +### Label + +An alternative physical label identifying the inventory item. + +### Role + +The functional [role](./inventoryitemrole.md) assigned to this inventory item. + +### Manufacturer + +The [manufacturer](./manufacturer.md) that produced the item. + +### Part ID + +The part identification or model number assigned by the manufacturer. + +### Serial Number + +The serial number assigned by the manufacturer. + +### Asset Tag + +A unique, locally-administered label used to identify hardware resources. diff --git a/docs/models/dcim/inventoryitemtemplate.md b/docs/models/dcim/inventoryitemtemplate.md index 3167ed4ab..02fde5995 100644 --- a/docs/models/dcim/inventoryitemtemplate.md +++ b/docs/models/dcim/inventoryitemtemplate.md @@ -1,3 +1,3 @@ # Inventory Item Templates -A template for an inventory item that will be automatically created when instantiating a new device. All attributes of this object will be copied to the new inventory item, including the associations with a parent item and assigned component, if any. +A template for an inventory item that will be automatically created when instantiating a new device. All attributes of this object will be copied to the new inventory item, including the associations with a parent item and assigned component, if any. See the [inventory item](./inventoryitem.md) documentation for more detail. diff --git a/docs/models/dcim/modulebay.md b/docs/models/dcim/modulebay.md index 6c6f94598..9291ff554 100644 --- a/docs/models/dcim/modulebay.md +++ b/docs/models/dcim/modulebay.md @@ -1,3 +1,24 @@ -## Module Bays +# Module Bays -Module bays represent a space or slot within a device in which a field-replaceable module may be installed. A common example is that of a chassis-based switch such as the Cisco Nexus 9000 or Juniper EX9200. Modules in turn hold additional components that become available to the parent device. +Module bays represent a space or slot within a device in which a field-replaceable [module](./module.md) may be installed. A common example is that of a chassis-based switch such as the Cisco Nexus 9000 or Juniper EX9200. Modules in turn hold additional components that become available to the parent device. + +!!! note + If you need to model child devices rather than modules, use a [device bay](./devicebay.md) instead. + +## Fields + +### Device + +The device to which this module bay belongs. + +### Name + +The module bay's name. Must be unique to the parent device. + +### Label + +An alternative physical label identifying the module bay. + +### Position + +The numeric position in which this module bay is situated. For example, this would be the number assigned to a slot within a chassis-based switch. diff --git a/docs/models/dcim/modulebaytemplate.md b/docs/models/dcim/modulebaytemplate.md index 463789305..3d5845d2e 100644 --- a/docs/models/dcim/modulebaytemplate.md +++ b/docs/models/dcim/modulebaytemplate.md @@ -1,3 +1,3 @@ -## Module Bay Templates +# Module Bay Templates -A template for a module bay that will be created on all instantiations of the parent device type. Module bays hold installed modules that do not have an independent management plane, such as line cards. +A template for a module bay that will be created on all instantiations of the parent device type. See the [module bay](./modulebay.md) documentation for more detail. diff --git a/docs/models/dcim/poweroutlet.md b/docs/models/dcim/poweroutlet.md index e9ef307bd..f6ca2c143 100644 --- a/docs/models/dcim/poweroutlet.md +++ b/docs/models/dcim/poweroutlet.md @@ -1,7 +1,39 @@ -## Power Outlets +# Power Outlets -Power outlets represent the outlets on a power distribution unit (PDU) or other device that supply power to dependent devices. Each power port may be assigned a physical type, and may be associated with a specific feed leg (where three-phase power is used) and/or a specific upstream power port. This association can be used to model the distribution of power within a device. +Power outlets represent the outlets on a power distribution unit (PDU) or other device that supplies power to dependent devices. Each power port may be assigned a physical type, and may be associated with a specific feed leg (where three-phase power is used) and/or a specific upstream power port. This association can be used to model the distribution of power within a device. For example, imagine a PDU with one power port which draws from a three-phase feed and 48 power outlets arranged into three banks of 16 outlets each. Outlets 1-16 would be associated with leg A on the port, and outlets 17-32 and 33-48 would be associated with legs B and C, respectively. -Cables can connect power outlets only to downstream power ports. (Pass-through ports cannot be used to model power distribution.) +## Fields + +### Device + +The device to which this power outlet belongs. + +### Module + +The installed module within the assigned device to which this power outlet belongs (optional). + +### Name + +The name of the power outlet. Must be unique to the parent device. + +### Label + +An alternative physical label identifying the power outlet. + +### Type + +The type of power outlet. + +### Power Port + +When modeling a device which redistributes power from an upstream supply, such as a power distribution unit (PDU), each power outlet should be mapped to the respective [power port](./powerport.md) on the device which supplies power. For example, a 24-outlet PDU may two power ports, each distributing power to 12 of its outlets. + +### Feed Leg + +This field is used to indicate to which leg of three-phase power circuit the outlet is bound. (This should be left blank for single-phase applications.) + +### Mark Connected + +If selected, this component will be treated as if a cable has been connected. diff --git a/docs/models/dcim/poweroutlettemplate.md b/docs/models/dcim/poweroutlettemplate.md index 6f81891f1..0803ede97 100644 --- a/docs/models/dcim/poweroutlettemplate.md +++ b/docs/models/dcim/poweroutlettemplate.md @@ -1,3 +1,3 @@ -## Power Outlet Templates +# Power Outlet Templates -A template for a power outlet that will be created on all instantiations of the parent device type. Each power outlet can be assigned a physical type, and its power source may be mapped to a specific feed leg and power port template. This association will be automatically replicated when the device type is instantiated. +A template for a power outlet that will be created on all instantiations of the parent device type. See the [power outlet](./poweroutlet.md) documentation for more detail. diff --git a/docs/models/dcim/powerport.md b/docs/models/dcim/powerport.md index 1948920d0..cfe513fbd 100644 --- a/docs/models/dcim/powerport.md +++ b/docs/models/dcim/powerport.md @@ -1,8 +1,40 @@ -## Power Ports +# Power Ports -A power port represents the inlet of a device where it draws its power, i.e. the connection port(s) on a device's power supply. Each power port may be assigned a physical type, as well as allocated and maximum draw values (in watts). These values can be used to calculate the overall utilization of an upstream power feed. +A power port is a device component which draws power from some external source (e.g. an upstream [power outlet](./poweroutlet.md)), and generally represents a power supply internal to a device. + +## Fields + +### Device + +The device to which this power port belongs. + +### Module + +The installed module within the assigned device to which this power port belongs (optional). + +### Name + +The name of the power port. Must be unique to the parent device. + +### Label + +An alternative physical label identifying the power port. + +### Type + +The type of power port. + +### Maximum Draw + +The maximum amount of power this port consumes (in watts). !!! info - When creating a power port on a device which supplies power to downstream devices, the allocated and maximum draw numbers should be left blank. Utilization will be calculated by taking the sum of all power ports of devices connected downstream. + When creating a power port on a device which is mapped to outlets and supplies power to downstream devices, the maximum and allocated draw numbers should be left blank. Utilization will be calculated by taking the sum of all power ports of devices connected downstream. -Cables can connect power ports only to power outlets or power feeds. (Pass-through ports cannot be used to model power distribution.) +### Allocated Draw + +The budgeted amount of power this port consumes (in watts). + +### Mark Connected + +If selected, this component will be treated as if a cable has been connected. diff --git a/docs/models/dcim/powerporttemplate.md b/docs/models/dcim/powerporttemplate.md index 947f146ae..32579f4d5 100644 --- a/docs/models/dcim/powerporttemplate.md +++ b/docs/models/dcim/powerporttemplate.md @@ -1,3 +1,3 @@ -## Power Port Templates +# Power Port Templates -A template for a power port that will be created on all instantiations of the parent device type. Each power port can be assigned a physical type, as well as a maximum and allocated draw in watts. +A template for a power port that will be created on all instantiations of the parent device type. See the [power port](./powerport.md) documentation for more detail. diff --git a/docs/models/dcim/rearport.md b/docs/models/dcim/rearport.md index 41c5b3037..3d161f65d 100644 --- a/docs/models/dcim/rearport.md +++ b/docs/models/dcim/rearport.md @@ -1,6 +1,40 @@ -## Rear Ports +# Rear Ports -Like front ports, rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its physical type and a number of positions: Rear ports with more than one position can be mapped to multiple front ports. This can be useful for modeling instances where multiple paths share a common cable (for example, six discrete two-strand fiber connections sharing a 12-strand MPO cable). +Like [front ports](./frontport.md), rear ports are pass-through ports which represent the continuation of a path from one cable to the next. Each rear port is defined with its physical type and a number of positions: Rear ports with more than one position can be mapped to multiple front ports. This can be useful for modeling instances where multiple paths share a common cable (for example, six discrete two-strand fiber connections sharing a 12-strand MPO cable). !!! note Front and rear ports need not necessarily reside on the actual front or rear device face. This terminology is used primarily to distinguish between the two components in a pass-through port pairing. + +## Fields + +### Device + +The device to which this port belongs. + +### Module + +The installed module within the assigned device to which this port belongs (optional). + +### Name + +The port's name. Must be unique to the parent device. + +### Label + +An alternative physical label identifying the port. + +### Type + +The port's termination type. + +### Color + +The port's color (optional). + +### Positions + +The number of [front ports](./frontport.md) to which this rear port can be mapped. For example, an MPO fiber termination cassette might have a single 12-strand rear port mapped to 12 discrete front ports, each terminating a single fiber strand. (For rear ports which map directly to a single front port, set this to `1`.) + +### Mark Connected + +If selected, this component will be treated as if a cable has been connected. diff --git a/docs/models/dcim/rearporttemplate.md b/docs/models/dcim/rearporttemplate.md index 01ba02ac0..00cdfa5d2 100644 --- a/docs/models/dcim/rearporttemplate.md +++ b/docs/models/dcim/rearporttemplate.md @@ -1,3 +1,3 @@ -## Rear Port Templates +# Rear Port Templates -A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. Each rear port may have a physical type and one or more front port templates assigned to it. The number of positions associated with a rear port determines how many front ports can be assigned to it (the maximum is 1024). +A template for a rear-facing pass-through port that will be created on all instantiations of the parent device type. See the [rear port](./rearport.md) documentation for more detail. From 4307f078edf8f94137b451150eeacf932d98f8b6 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Mon, 15 Aug 2022 15:16:02 -0400 Subject: [PATCH 398/593] Finish refreshing DCIM models documentation --- docs/models/dcim/cable.md | 36 +++++++++--- docs/models/dcim/consoleserverport.md | 2 +- docs/models/dcim/device.md | 82 ++++++++++++++++++++++++++- docs/models/dcim/devicebay.md | 3 + docs/models/dcim/devicerole.md | 18 ++++++ docs/models/dcim/devicetype.md | 44 +++++++++++--- docs/models/dcim/frontport.md | 3 + docs/models/dcim/interface.md | 3 + docs/models/dcim/inventoryitem.md | 3 + docs/models/dcim/inventoryitemrole.md | 14 +++++ docs/models/dcim/location.md | 27 ++++++++- docs/models/dcim/manufacturer.md | 12 +++- docs/models/dcim/module.md | 32 ++++++++++- docs/models/dcim/modulebay.md | 3 + docs/models/dcim/moduletype.md | 18 +++++- docs/models/dcim/platform.md | 28 ++++++++- docs/models/dcim/powerfeed.md | 58 +++++++++++++++---- docs/models/dcim/poweroutlet.md | 3 + docs/models/dcim/powerpanel.md | 18 +++++- docs/models/dcim/powerport.md | 3 + docs/models/dcim/rack.md | 63 +++++++++++++++++--- docs/models/dcim/rackreservation.md | 20 ++++++- docs/models/dcim/rackrole.md | 16 +++++- docs/models/dcim/rearport.md | 3 + docs/models/dcim/region.md | 16 +++++- docs/models/dcim/site.md | 52 ++++++++++++++--- docs/models/dcim/sitegroup.md | 16 +++++- docs/models/dcim/virtualchassis.md | 21 +++++-- 28 files changed, 547 insertions(+), 70 deletions(-) diff --git a/docs/models/dcim/cable.md b/docs/models/dcim/cable.md index 43c0abfab..20f6c03c7 100644 --- a/docs/models/dcim/cable.md +++ b/docs/models/dcim/cable.md @@ -1,24 +1,42 @@ # Cables -All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two termination points, such as between a console port and a patch panel port, or between two network interfaces. +All connections between device components in NetBox are represented using cables. A cable represents a direct physical connection between two sets of endpoints (A and B), such as a console port and a patch panel port, or between two network interfaces. Cables may be connected to the following objects: -Each cable must have two endpoints defined. These endpoints are sometimes referenced as A and B for clarity, however cables are direction-agnostic and the order in which terminations are made has no meaning. Cables may be connected to the following objects: - -* Circuit terminations +* Network interfaces * Console ports * Console server ports -* Interfaces * Pass-through ports (front and rear) -* Power feeds -* Power outlets +* Circuit terminations * Power ports +* Power outlets +* Power feeds -Each cable may be assigned a type, label, length, and color. Each cable is also assigned one of three operational statuses: +## Fields + +### Status + +The cable's operational status. Choices include: * Active (default) * Planned * Decommissioning +### Type + +The cable's physical medium or classification. + +### Label + +An arbitrary label used to identify the cable. + +### Color + +The color of the cable. + +### Length + +The numeric length of the cable, including a unit designation (e.g. 100 meters or 25 feet). + ## Tracing Cables -A cable may be traced from either of its endpoints by clicking the "trace" button. (A REST API endpoint also provides this functionality.) NetBox will follow the path of connected cables from this termination across the directly connected cable to the far-end termination. If the cable connects to a pass-through port, and the peer port has another cable connected, NetBox will continue following the cable path until it encounters a non-pass-through or unconnected termination point. The entire path will be displayed to the user. +A cable may be traced from any of its endpoints by clicking the "trace" button. (A REST API endpoint also provides this functionality.) NetBox will follow the path of connected cables from this termination across the directly connected cable to the far-end termination. If the cable connects to a pass-through port, and the peer port has another cable connected, NetBox will continue following the cable path until it encounters a non-pass-through or unconnected termination point. The entire path will be displayed to the user. diff --git a/docs/models/dcim/consoleserverport.md b/docs/models/dcim/consoleserverport.md index 1fbb653a8..5c45451db 100644 --- a/docs/models/dcim/consoleserverport.md +++ b/docs/models/dcim/consoleserverport.md @@ -33,4 +33,4 @@ Operating speed, in bits per second (bps). ### Mark Connected -If selected, this component will be treated as if a cable has been connected. \ No newline at end of file +If selected, this component will be treated as if a cable has been connected. diff --git a/docs/models/dcim/device.md b/docs/models/dcim/device.md index a99078472..ddf1bfb09 100644 --- a/docs/models/dcim/device.md +++ b/docs/models/dcim/device.md @@ -8,8 +8,86 @@ A device is said to be full-depth if its installation on one rack face prevents Each device must be instantiated from a pre-created device type, and its default components (console ports, power ports, interfaces, etc.) will be created automatically. (The device type associated with a device may be changed after its creation, however its components will not be updated retroactively.) -Each device must be assigned a site, device role, and operational status, and may optionally be assigned to a specific location and/or rack within a site. A platform, serial number, and asset tag may optionally be assigned to each device. - Device names must be unique within a site, unless the device has been assigned to a tenant. Devices may also be unnamed. When a device has one or more interfaces with IP addresses assigned, a primary IP for the device can be designated, for both IPv4 and IPv6. + +## Fields + +### Name + +The device's configured name. This field is optional; devices can be unnamed. However, if set, the name must be unique to the assigned site and tenant. + +### Device Role + +The functional [role](./devicerole.md) assigned to this device. + +### Device Type + +The hardware [device type](./devicetype.md) which defines the device's make & model. Upon creating, all templated components assigned to the device type will be replicated on the new device. + +### Airflow + +The direction in which air circulates through the device chassis for cooling. + +### Serial Number + +The unique physical serial number assigned to this device by its manufacturer. + +### Asset Tag + +A unique, locally-administered label used to identify hardware resources. + +### Site + +The [site](./site.md) in which this device is located. + +### Location + +A specific [location](./location.md) where this device resides within the assigned site (optional). + +### Rack + +The [rack](./rack.md) within which this device is installed (optional). + +### Rack Face + +If installed in a rack, this field denotes the primary face on which the device is mounted. + +### Position + +If installed in a rack, this field indicates the base rack unit in which the device is mounted. + +!!! tip + Devices with a height of more than one rack unit should be set to the lowest-numbered rack unit that they occupy. + +### Status + +The device's operational status. + +!!! tip + Additional statuses may be defined by setting `Device.status` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter. + +### Platform + +A device may be associated with a particular [platform](./platform.md) to indicate its operating system. Note that only platforms assigned to the associated manufacturer (or to no manufacturer) will be available for selection. + +### Cluster + +If this device will serve as a host for a virtualization [cluster](../virtualization/cluster.md), it can be assigned here. (Host devices can also be assigned by editing the cluster.) + +### Virtual Chassis + +The [virtual chassis](./virtualchassis.md) of which this device is a member, if any. + +### VC Position + +If assigned to a [virtual chassis](./virtualchassis.md), this field indicates the device's member position. + +### VC Priority + +If assigned to a [virtual chassis](./virtualchassis.md), this field indicates the device's priority for master election. + +### Local Config Context Data + +Any unique [context data](../../features/context-data.md) to be associated with the device. diff --git a/docs/models/dcim/devicebay.md b/docs/models/dcim/devicebay.md index f4f807c4a..5bbb125f8 100644 --- a/docs/models/dcim/devicebay.md +++ b/docs/models/dcim/devicebay.md @@ -7,6 +7,9 @@ Child devices are first-class Devices in their own right: That is, they are full !!! note Device bays are **not** suitable for modeling line cards (such as those commonly found in chassis-based routers and switches), as these components depend on the control plane of the parent device to operate. Instead, these should be modeled as [modules](./module.md) installed within [module bays](./modulebay.md). +!!! tip + Like most device components, device bays are instantiated automatically from [device bay templates](./devicebaytemplate.md) assigned to the selected device type when a device is created. + ## Fields ### Device diff --git a/docs/models/dcim/devicerole.md b/docs/models/dcim/devicerole.md index 13b8f021e..e9bdc0fa6 100644 --- a/docs/models/dcim/devicerole.md +++ b/docs/models/dcim/devicerole.md @@ -1,3 +1,21 @@ # Device Roles Devices can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for core switches, distribution switches, and access switches within your network. + +## Fields + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) + +### Color + +The color used when displaying the role in the NetBox UI. + +### VM Role + +If selected, this role may be assigned to [virtual machines](../virtualization/virtualmachine.md) diff --git a/docs/models/dcim/devicetype.md b/docs/models/dcim/devicetype.md index cf42185f4..050f93244 100644 --- a/docs/models/dcim/devicetype.md +++ b/docs/models/dcim/devicetype.md @@ -4,13 +4,43 @@ A device type represents a particular make and model of hardware that exists in Device types are instantiated as devices installed within sites and/or equipment racks. For example, you might define a device type to represent a Juniper EX4300-48T network switch with 48 Ethernet interfaces. You can then create multiple _instances_ of this type named "switch1," "switch2," and so on. Each device will automatically inherit the components (such as interfaces) of its device type at the time of creation. However, changes made to a device type will **not** apply to instances of that device type retroactively. -Some devices house child devices which share physical resources, like space and power, but which function independently. A common example of this is blade server chassis. Each device type is designated as one of the following: - -* A parent device (which has device bays) -* A child device (which must be installed within a device bay) -* Neither - !!! note This parent/child relationship is **not** suitable for modeling chassis-based devices, wherein child members share a common control plane. Instead, line cards and similarly non-autonomous hardware should be modeled as modules or inventory items within a device. -A device type may optionally specify an airflow direction, such as front-to-rear, rear-to-front, or passive. Airflow direction may also be set separately per device. If it is not defined for a device at the time of its creation, it will inherit the airflow setting of its device type. +## Fields + +### Manufacturer + +The [manufacturer](./manufacturer.md) which produces this type of device. + +### Model + +The model number assigned to this device type by its manufacturer. Must be unique to the manufacturer. + +### Slug + +A unique URL-friendly representation of the model identifier. (This value can be used for filtering.) + +### Part Number + +An alternative part number to uniquely identify the device type. + +### Height + +The height of the physical device in rack units. (For device types that are not rack-mountable, this should be `0`.) + +### Is Full Depth + +If selected, this device type is considered to occupy both the front and rear faces of a rack, regardless of which face it is assigned. + +### Parent/Child Status + +Indicates whether this is a parent type (capable of housing child devices), a child type (which must be installed within a device bay), or neither. + +### Airflow + +The default direction in which airflow circulates within the device chassis. This may be configured differently for instantiated devices (e.g. because of different fan modules). + +### Front & Rear Images + +Users can upload illustrations of the device's front and rear panels. If present, these will be used to render the device in [rack](./rack.md) elevation diagrams. diff --git a/docs/models/dcim/frontport.md b/docs/models/dcim/frontport.md index 0b291c9ed..7ea617250 100644 --- a/docs/models/dcim/frontport.md +++ b/docs/models/dcim/frontport.md @@ -2,6 +2,9 @@ Front ports are pass-through ports which represent physical cable connections that comprise part of a longer path. For example, the ports on the front face of a UTP patch panel would be modeled in NetBox as front ports. Each port is assigned a physical type, and must be mapped to a specific [rear port](./rearport.md) on the same device. A single rear port may be mapped to multiple front ports, using numeric positions to annotate the specific alignment of each. +!!! tip + Like most device components, front ports are instantiated automatically from [front port templates](./frontporttemplate.md) assigned to the selected device type when a device is created. + ## Fields ### Device diff --git a/docs/models/dcim/interface.md b/docs/models/dcim/interface.md index b69f7c6b1..42b570964 100644 --- a/docs/models/dcim/interface.md +++ b/docs/models/dcim/interface.md @@ -2,6 +2,9 @@ Interfaces in NetBox represent network interfaces used to exchange data with connected devices. On modern networks, these are most commonly Ethernet, but other types are supported as well. IP addresses and VLANs can be assigned to interfaces. +!!! tip + Like most device components, interfaces are instantiated automatically from [interface templates](./interfacetemplate.md) assigned to the selected device type when a device is created. + !!! note Although both devices and virtual machines both can have interfaces assigned, a separate model is used for each. Thus, device interfaces have some properties that are not present on virtual machine interfaces and vice versa. diff --git a/docs/models/dcim/inventoryitem.md b/docs/models/dcim/inventoryitem.md index 1c2e894ed..f61586eda 100644 --- a/docs/models/dcim/inventoryitem.md +++ b/docs/models/dcim/inventoryitem.md @@ -4,6 +4,9 @@ Inventory items represent hardware components installed within a device, such as Inventory items are hierarchical in nature, such that any individual item may be designated as the parent for other items. For example, an inventory item might be created to represent a line card which houses several SFP optics, each of which exists as a child item within the device. An inventory item may also be associated with a specific component within the same device. For example, you may wish to associate a transceiver with an interface. +!!! tip + Like most device components, inventory items can be instantiated automatically from [templates](./inventoryitemtemplate.md) assigned to the selected device type when a device is created. + ## Fields ### Device diff --git a/docs/models/dcim/inventoryitemrole.md b/docs/models/dcim/inventoryitemrole.md index 8ed31481a..50eb61abd 100644 --- a/docs/models/dcim/inventoryitemrole.md +++ b/docs/models/dcim/inventoryitemrole.md @@ -1,3 +1,17 @@ # Inventory Item Roles Inventory items can be organized by functional roles, which are fully customizable by the user. For example, you might create roles for power supplies, fans, interface optics, etc. + +## Fields + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) + +### Color + +The color used when displaying the role in the NetBox UI. diff --git a/docs/models/dcim/location.md b/docs/models/dcim/location.md index fb72c218d..96ab13039 100644 --- a/docs/models/dcim/location.md +++ b/docs/models/dcim/location.md @@ -1,5 +1,28 @@ # Locations -Racks and devices can be grouped by location within a site. A location may represent a floor, room, cage, or similar organizational unit. Locations can be nested to form a hierarchy. For example, you may have floors within a site, and rooms within a floor. +[Racks](./rack.md) and [devices](./device.md) can be grouped by location within a [site](./site.md). A location may represent a floor, room, cage, or similar organizational unit. Locations can be nested to form a hierarchy. For example, you may have floors within a site, and rooms within a floor. -Each location must have a name that is unique within its parent site and location, if any, and must be assigned an operational status. (The set of available statuses is configurable.) +## Fields + +### Site + +The parent [site](./site.md) to which this location belongs. + +### Parent + +The parent location of which this location is a child (optional). + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) + +### Status + +The location's operational status. + +!!! tip + Additional statuses may be defined by setting `Location.status` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter. diff --git a/docs/models/dcim/manufacturer.md b/docs/models/dcim/manufacturer.md index df227ee17..6beee5a90 100644 --- a/docs/models/dcim/manufacturer.md +++ b/docs/models/dcim/manufacturer.md @@ -1,3 +1,13 @@ # Manufacturers -A manufacturer represents the "make" of a device; e.g. Cisco or Dell. Each device type must be assigned to a manufacturer. (Inventory items and platforms may also be associated with manufacturers.) Each manufacturer must have a unique name and may have a description assigned to it. +A manufacturer represents the "make" of a device; e.g. Cisco or Dell. Each [device type](./devicetype.md) must be assigned to a manufacturer. ([Inventory items](./inventoryitem.md) and [platforms](./platform.md) may also be associated with manufacturers.) + +## Fields + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) diff --git a/docs/models/dcim/module.md b/docs/models/dcim/module.md index bc9753ecc..c90430faa 100644 --- a/docs/models/dcim/module.md +++ b/docs/models/dcim/module.md @@ -2,4 +2,34 @@ A module is a field-replaceable hardware component installed within a device which houses its own child components. The most common example is a chassis-based router or switch. -Similar to devices, modules are instantiated from module types, and any components associated with the module type are automatically instantiated on the new model. Each module must be installed within a module bay on a device, and each module bay may have only one module installed in it. A module may optionally be assigned a serial number and asset tag. +Similar to devices, modules are instantiated from [module types](./moduletype.md), and any components associated with the module type are automatically instantiated on the new model. Each module must be installed within a [module bay](./modulebay.md) on a [device](./device.md), and each module bay may have only one module installed in it. + +## Fields + +### Device + +The parent [device](./device.md) into which the module is installed. + +### Module Bay + +The [module bay](./modulebay.md) into which the module is installed. + +### Module Type + +The [module type](./moduletype.md) which represents the physical make & model of hardware. By default, module components will be instantiated automatically from the module type when creating a new module. + +### Serial Number + +The unique physical serial number assigned to this module by its manufacturer. + +### Asset Tag + +A unique, locally-administered label used to identify hardware resources. + +### Replicate Components + +Controls whether templates module type components are automatically added when creating a new module. + +### Adopt Components + +Controls whether pre-existing components assigned to the device with the same names as components that would be created automatically will be assigned to the new module. diff --git a/docs/models/dcim/modulebay.md b/docs/models/dcim/modulebay.md index 9291ff554..c77909511 100644 --- a/docs/models/dcim/modulebay.md +++ b/docs/models/dcim/modulebay.md @@ -5,6 +5,9 @@ Module bays represent a space or slot within a device in which a field-replaceab !!! note If you need to model child devices rather than modules, use a [device bay](./devicebay.md) instead. +!!! tip + Like most device components, module bays are instantiated automatically from [module bay templates](./modulebaytemplate.md) assigned to the selected device type when a device is created. + ## Fields ### Device diff --git a/docs/models/dcim/moduletype.md b/docs/models/dcim/moduletype.md index c1c8c5079..b8ec0ac6e 100644 --- a/docs/models/dcim/moduletype.md +++ b/docs/models/dcim/moduletype.md @@ -1,8 +1,8 @@ # Module Types -A module type represent a specific make and model of hardware component which is installable within a device and has its own child components. For example, consider a chassis-based switch or router with a number of field-replaceable line cards. Each line card has its own model number and includes a certain set of components such as interfaces. Each module type may have a manufacturer, model number, and part number assigned to it. +A module type represents a specific make and model of hardware component which is installable within a device's [module bay](./modulebay.md) and has its own child components. For example, consider a chassis-based switch or router with a number of field-replaceable line cards. Each line card has its own model number and includes a certain set of components such as interfaces. Each module type may have a manufacturer, model number, and part number assigned to it. -Similar to device types, each module type can have any of the following component templates associated with it: +Similar to [device types](./devicetype.md), each module type can have any of the following component templates associated with it: * Interfaces * Console ports @@ -21,3 +21,17 @@ When adding component templates to a module type, the string `{module}` can be u For example, you can create a module type with interface templates named `Gi{module}/0/[1-48]`. When a new module of this type is "installed" to a module bay with a position of "3", NetBox will automatically name these interfaces `Gi3/0/[1-48]`. Automatic renaming is supported for all modular component types (those listed above). + +## Fields + +### Manufacturer + +The [manufacturer](./manufacturer.md) which produces this type of module. + +### Model + +The model number assigned to this module type by its manufacturer. Must be unique to the manufacturer. + +### Part Number + +An alternative part number to uniquely identify the module type. diff --git a/docs/models/dcim/platform.md b/docs/models/dcim/platform.md index 347abc5b8..d080f74a4 100644 --- a/docs/models/dcim/platform.md +++ b/docs/models/dcim/platform.md @@ -1,9 +1,31 @@ # Platforms -A platform defines the type of software running on a device or virtual machine. This can be helpful to model when it is necessary to distinguish between different versions or feature sets. Note that two devices of the same type may be assigned different platforms: For example, one Juniper MX240 might run Junos 14 while another runs Junos 15. +A platform defines the type of software running on a [device](./device.md) or [virtual machine](../virtualization/virtualmachine.md). This can be helpful to model when it is necessary to distinguish between different versions or feature sets. Note that two devices of the same type may be assigned different platforms: For example, one Juniper MX240 might run Junos 14 while another runs Junos 15. -Platforms may optionally be limited by manufacturer: If a platform is assigned to a particular manufacturer, it can only be assigned to devices with a type belonging to that manufacturer. +Platforms may optionally be limited by [manufacturer](./manufacturer.md): If a platform is assigned to a particular manufacturer, it can only be assigned to devices with a type belonging to that manufacturer. -The platform model is also used to indicate which NAPALM driver (if any) and any associated arguments NetBox should use when connecting to a remote device. The name of the driver along with optional parameters are stored with the platform. +The platform model is also used to indicate which [NAPALM driver](../../integrations/napalm.md) (if any) and any associated arguments NetBox should use when connecting to a remote device. The name of the driver along with optional parameters are stored with the platform. The assignment of platforms to devices is an optional feature, and may be disregarded if not desired. + +## Fields + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) + +### Manufacturer + +If designated, this platform will be available for use only to devices assigned to this [manufacturer](./manufacturer.md). This can be handy e.g. for limiting network operating systems to use on hardware produced by the relevant vendor. However, it should not be used when defining general-purpose software platforms. + +### NAPALM Driver + +The [NAPALM driver](https://napalm.readthedocs.io/en/latest/support/index.html) associated with this platform. + +### NAPALM Arguments + +Any additional arguments to send when invoking the NAPALM driver assigned to this platform. diff --git a/docs/models/dcim/powerfeed.md b/docs/models/dcim/powerfeed.md index bac7214f1..f98c758ff 100644 --- a/docs/models/dcim/powerfeed.md +++ b/docs/models/dcim/powerfeed.md @@ -1,21 +1,55 @@ # Power Feed -A power feed represents the distribution of power from a power panel to a particular device, typically a power distribution unit (PDU). The power port (inlet) on a device can be connected via a cable to a power feed. A power feed may optionally be assigned to a rack to allow more easily tracking the distribution of power among racks. +A power feed represents the distribution of power from a [power panel](./powerpanel.md) to a particular [device](./device.md), typically a power distribution unit (PDU). The [power port](./powerport.md) (inlet) on a device can be connected via a cable to a power feed. A power feed may optionally be assigned to a rack to allow more easily tracking the distribution of power among racks. -Each power feed is assigned an operational type (primary or redundant) and one of the following statuses: +## Fields -* Offline -* Active -* Planned -* Failed +### Power Panel -Each power feed also defines the electrical characteristics of the circuit which it represents. These include the following: +The [power panel](./powerpanel.md) which supplies upstream power to this feed. -* Supply type (AC or DC) -* Phase (single or three-phase) -* Voltage -* Amperage -* Maximum utilization (percentage) +### Rack + +The [rack](./rack.md) within which this feed delivers power (optional). + +### Name + +The feed's name or other identifier. Must be unique to the assigned power panel. + +### Status + +The feed's operational status. + +!!! tip + Additional statuses may be defined by setting `PowerFeed.status` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter. + +### Type + +In redundant environments, each power feed can be designated as providing either primary or redundant power. (In environment with only one power source, all power feeds should be designated as primary.) + +### Mark Connected + +If selected, the power feed will be treated as if a cable has been connected. + +### Supply + +Electrical current type (AC or DC). + +### Voltage + +Operating circuit voltage, in volts. + +### Amperage + +Operation circuit amperage, in amperes. + +### Phase + +Indicates whether the circuit provides single- or three-phase power. + +### Max Utilization + +The maximum safe utilization of the feed, expressed as a percentage of the total available power. (Typically this will be set to around 80%, to avoid tripping a breaker during heaving spikes in current draw.) !!! info The power utilization of a rack is calculated when one or more power feeds are assigned to the rack and connected to devices that draw power. diff --git a/docs/models/dcim/poweroutlet.md b/docs/models/dcim/poweroutlet.md index f6ca2c143..5c8bd6ff0 100644 --- a/docs/models/dcim/poweroutlet.md +++ b/docs/models/dcim/poweroutlet.md @@ -4,6 +4,9 @@ Power outlets represent the outlets on a power distribution unit (PDU) or other For example, imagine a PDU with one power port which draws from a three-phase feed and 48 power outlets arranged into three banks of 16 outlets each. Outlets 1-16 would be associated with leg A on the port, and outlets 17-32 and 33-48 would be associated with legs B and C, respectively. +!!! tip + Like most device components, power outlets are instantiated automatically from [power outlet templates](./poweroutlettemplate.md) assigned to the selected device type when a device is created. + ## Fields ### Device diff --git a/docs/models/dcim/powerpanel.md b/docs/models/dcim/powerpanel.md index 813321179..dd02a57f0 100644 --- a/docs/models/dcim/powerpanel.md +++ b/docs/models/dcim/powerpanel.md @@ -1,8 +1,20 @@ # Power Panel -A power panel represents the origin point in NetBox for electrical power being disseminated by one or more power feeds. In a data center environment, one power panel often serves a group of racks, with an individual power feed extending to each rack, though this is not always the case. It is common to have two sets of panels and feeds arranged in parallel to provide redundant power to each rack. - -Each power panel must be assigned to a site, and may optionally be assigned to a particular location within that site. +A power panel represents the origin point in NetBox for electrical power being disseminated by one or more [power feeds](./powerfeed.md). In a data center environment, one power panel often serves a group of racks, with an individual power feed extending to each rack, though this is not always the case. It is common to have two sets of panels and feeds arranged in parallel to provide redundant power to each rack. !!! note NetBox does not model the mechanism by which power is delivered to a power panel. Power panels define the root level of the power distribution hierarchy in NetBox. + +## Fields + +### Site + +The [site](./site.md) in which the power panel resides. + +### Location + +A specific [location](./location.md) within the assigned site where the power panel is installed. + +### Name + +The power panel's name. Must be unique to the assigned site. diff --git a/docs/models/dcim/powerport.md b/docs/models/dcim/powerport.md index cfe513fbd..7cc1dd60a 100644 --- a/docs/models/dcim/powerport.md +++ b/docs/models/dcim/powerport.md @@ -2,6 +2,9 @@ A power port is a device component which draws power from some external source (e.g. an upstream [power outlet](./poweroutlet.md)), and generally represents a power supply internal to a device. +!!! tip + Like most device components, power ports are instantiated automatically from [power port templates](./powerporttemplate.md) assigned to the selected device type when a device is created. + ## Fields ### Device diff --git a/docs/models/dcim/rack.md b/docs/models/dcim/rack.md index 9465a828c..57e7bec98 100644 --- a/docs/models/dcim/rack.md +++ b/docs/models/dcim/rack.md @@ -1,12 +1,51 @@ # Racks -The rack model represents a physical two- or four-post equipment rack in which devices can be installed. Each rack must be assigned to a site, and may optionally be assigned to a location and/or tenant. Racks can also be organized by user-defined functional roles. The name and facility ID of each rack within a location must be unique. +The rack model represents a physical two- or four-post equipment rack in which [devices](./device.md) can be installed. Each rack must be assigned to a [site](./site.md), and may optionally be assigned to a [location](./location.md) within that site. Racks can also be organized by user-defined functional roles. The name and facility ID of each rack within a location must be unique. Rack height is measured in *rack units* (U); racks are commonly between 42U and 48U tall, but NetBox allows you to define racks of arbitrary height. A toggle is provided to indicate whether rack units are in ascending (from the ground up) or descending order. Each rack is assigned a name and (optionally) a separate facility ID. This is helpful when leasing space in a data center your organization does not own: The facility will often assign a seemingly arbitrary ID to a rack (for example, "M204.313") whereas internally you refer to is simply as "R113." A unique serial number and asset tag may also be associated with each rack. -A rack must be designated as one of the following types: +## Fields + +### Site + +The [site](./site.md) to which the rack is assigned. + +### Location + +The [location](./location.md) within a site where the rack has been installed (optional). + +### Name + +The rack's name or identifier. Must be unique to the rack's location, if assigned. + +### Status + +Operational status. + +!!! tip + Additional statuses may be defined by setting `Rack.status` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter. + +### Role + +The functional [role](./rackrole.md) fulfilled by the rack. + +### Facility ID + +An alternative identifier assigned to the rack e.g. by the facility operator. This is helpful for tracking datacenter rack designations in a colocation facility. + +### Serial Number + +The unique physical serial number assigned to this rack. + +### Asset Tag + +A unique, locally-administered label used to identify hardware resources. + +### Type + +A rack can be designated as one of the following types: * 2-post frame * 4-post frame @@ -14,12 +53,18 @@ A rack must be designated as one of the following types: * Wall-mounted frame * Wall-mounted cabinet -Similarly, each rack must be assigned an operational status, which is one of the following: +### Width -* Reserved -* Available -* Planned -* Active -* Deprecated +The canonical distance between the two vertical rails on a face. (This is typically 19 inches, however other standard widths exist.) -Each rack has two faces (front and rear) on which devices can be mounted. Rail-to-rail width may be 10, 19, 21, or 23 inches. The outer width and depth of a rack or cabinet can also be annotated in millimeters or inches. +### Height + +The height of the rack, measured in units. + +### Outer Dimensions + +The external width and depth of the rack can be tracked to aid in floorplan calculations. These measurements must be designated in either millimeters or inches. + +### Descending Units + +If selected, the rack's elevation will display unit 1 at the top of the rack. (Most racks use asceneding numbering, with unit 1 assigned to the bottommost position.) diff --git a/docs/models/dcim/rackreservation.md b/docs/models/dcim/rackreservation.md index 0ed9651a0..32d52c9d7 100644 --- a/docs/models/dcim/rackreservation.md +++ b/docs/models/dcim/rackreservation.md @@ -1,3 +1,21 @@ # Rack Reservations -Users can reserve specific units within a rack for future use. An arbitrary set of units within a rack can be associated with a single reservation, but reservations cannot span multiple racks. A description is required for each reservation, reservations may optionally be associated with a specific tenant. +Users can reserve specific units within a [rack](./rackreservation.md) for future use. An arbitrary set of units within a rack can be associated with a single reservation, but reservations cannot span multiple racks. A description is required for each reservation, reservations may optionally be associated with a specific tenant. + +## Fields + +### Rack + +The [rack](./rack.md) being reserved. + +### Units + +The rack unit or units being reserved. Multiple units can be expressed using commas and/or hyphens. For example, `1,3,5-7` specifies units 1, 3, 5, 6, and 7. + +### User + +The NetBox user account associated with the reservation. Note that users with sufficient permission can make rack reservations for other users. + +### Description + +Every rack reservation must include a description of its purpose. diff --git a/docs/models/dcim/rackrole.md b/docs/models/dcim/rackrole.md index 1375ce692..88f171af8 100644 --- a/docs/models/dcim/rackrole.md +++ b/docs/models/dcim/rackrole.md @@ -1,3 +1,17 @@ # Rack Roles -Each rack can optionally be assigned a user-defined functional role. For example, you might designate a rack for compute or storage resources, or to house colocated customer devices. Rack roles are fully customizable and may be color-coded. +Each rack can optionally be assigned a user-defined functional role. For example, you might designate a rack for compute or storage resources, or to house colocated customer devices. + +## Fields + +### Name + +A unique human-friendly name. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) + +### Color + +The color used when displaying the role in the NetBox UI. diff --git a/docs/models/dcim/rearport.md b/docs/models/dcim/rearport.md index 3d161f65d..b23d4a29b 100644 --- a/docs/models/dcim/rearport.md +++ b/docs/models/dcim/rearport.md @@ -5,6 +5,9 @@ Like [front ports](./frontport.md), rear ports are pass-through ports which repr !!! note Front and rear ports need not necessarily reside on the actual front or rear device face. This terminology is used primarily to distinguish between the two components in a pass-through port pairing. +!!! tip + Like most device components, rear ports are instantiated automatically from [rear port templates](./rearporttemplate.md) assigned to the selected device type when a device is created. + ## Fields ### Device diff --git a/docs/models/dcim/region.md b/docs/models/dcim/region.md index bac186264..27673b2df 100644 --- a/docs/models/dcim/region.md +++ b/docs/models/dcim/region.md @@ -1,5 +1,17 @@ # Regions -Sites can be arranged geographically using regions. A region might represent a continent, country, city, campus, or other area depending on your use case. Regions can be nested recursively to construct a hierarchy. For example, you might define several country regions, and within each of those several state or city regions to which sites are assigned. +[Sites](./site.md) can be arranged geographically using regions. A region might represent a continent, country, city, campus, or other area depending on your use case. Regions can be nested recursively to construct a hierarchy. For example, you might define several country regions, and within each of those several state or city regions to which sites are assigned. -Each region must have a name that is unique within its parent region, if any. +## Fields + +### Parent + +The parent region, if any. + +### Name + +The region's name. Must be unique to the parent region, if one is assigned. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) diff --git a/docs/models/dcim/site.md b/docs/models/dcim/site.md index 6617b950c..c74c209e1 100644 --- a/docs/models/dcim/site.md +++ b/docs/models/dcim/site.md @@ -2,14 +2,50 @@ How you choose to employ sites when modeling your network may vary depending on the nature of your organization, but generally a site will equate to a building or campus. For example, a chain of banks might create a site to represent each of its branches, a site for its corporate headquarters, and two additional sites for its presence in two colocation facilities. -Each site must be assigned a unique name and may optionally be assigned to a region and/or tenant. The following operational statuses are available: +## Fields -* Planned -* Staging -* Active -* Decommissioning -* Retired +### Name -The site model also provides a facility ID field which can be used to annotate a facility ID (such as a datacenter name) associated with the site. Each site may also have an autonomous system (AS) number and time zone associated with it. (Time zones are provided by the [pytz](https://pypi.org/project/pytz/) package.) +The site's unique name. -The site model also includes several fields for storing contact and address information as well as geolocation data (GPS coordinates). +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) + +### Status + +The site's operational status. + +!!! tip + Additional statuses may be defined by setting `Site.status` under the [`FIELD_CHOICES`](../../configuration/data-validation.md#field_choices) configuration parameter. + +### Region + +The parent [region](./region.md) to which the site belongs, if any. + +### Facility + +Data center or facility designation for identifying the site. + +### ASNs + +Each site can have multiple [AS numbers](../ipam/asn.md) assigned to it. + +### Time Zone + +The site's local time zone. (Time zones are provided by the [pytz](https://pypi.org/project/pytz/) package.) + +### Physical Address + +The site's physical address, used for mapping. + +### Shipping Address + +The address to use for deliveries destined for the site. + +!!! tip + You can also designate [points of contact](../../features/contacts.md) for each site to provide additional contact details. + +### Latitude & Longitude + +GPS coordinates of the site for geolocation. diff --git a/docs/models/dcim/sitegroup.md b/docs/models/dcim/sitegroup.md index 04ebcc1a5..e1c5215d9 100644 --- a/docs/models/dcim/sitegroup.md +++ b/docs/models/dcim/sitegroup.md @@ -1,5 +1,17 @@ # Site Groups -Like regions, site groups can be used to organize sites. Whereas regions are intended to provide geographic organization, site groups can be used to classify sites by role or function. Also like regions, site groups can be nested to form a hierarchy. Sites which belong to a child group are also considered to be members of any of its parent groups. +Like [regions](./region.md), site groups can be used to organize [sites](./site.md). Whereas regions are intended to provide geographic organization, site groups can be used to classify sites by role or function. Also like regions, site groups can be nested to form a hierarchy. Sites which belong to a child group are also considered to be members of all its parent groups. -Each site group must have a name that is unique within its parent group, if any. +## Fields + +### Parent + +The parent site group, if any. + +### Name + +The site group's name. Must be unique to the parent group, if one is assigned. + +### Slug + +A unique URL-friendly identifier. (This value can be used for filtering.) diff --git a/docs/models/dcim/virtualchassis.md b/docs/models/dcim/virtualchassis.md index 2466b065d..e68b2fda6 100644 --- a/docs/models/dcim/virtualchassis.md +++ b/docs/models/dcim/virtualchassis.md @@ -1,9 +1,22 @@ # Virtual Chassis -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. +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 managed device. 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. -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. +One of the member 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 management-only interfaces belonging to other members. !!! 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. + 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. Instead, use [modules](./module.md) for these. + +## Fields + +### Name + +The virtual chassis' name. + +### Domain + +The domain assigned for VC member devices. + +### Master + +The member device which has been designated as the chassis master (optional). From 30ab1e5a5e1f12c3e88b145c511741f75b5d460b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 16 Aug 2022 09:14:19 -0400 Subject: [PATCH 399/593] Changelog for #8723, #9505, #9979 --- docs/release-notes/version-3.2.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/release-notes/version-3.2.md b/docs/release-notes/version-3.2.md index 824e99778..f515e4d35 100644 --- a/docs/release-notes/version-3.2.md +++ b/docs/release-notes/version-3.2.md @@ -5,12 +5,15 @@ ### Enhancements * [#8595](https://github.com/netbox-community/netbox/issues/8595) - Add PON interface types +* [#8723](https://github.com/netbox-community/netbox/issues/8723) - Enable bulk renaming of devices * [#9161](https://github.com/netbox-community/netbox/issues/9161) - Pretty print JSON custom field data when editing +* [#9505](https://github.com/netbox-community/netbox/issues/9505) - Display extra addressing details for IPv4 prefixes * [#9625](https://github.com/netbox-community/netbox/issues/9625) - Add phone & email details to contacts panel * [#9857](https://github.com/netbox-community/netbox/issues/9857) - Add clear button to quick search fields ### Bug Fixes +* [#9979](https://github.com/netbox-community/netbox/issues/9979) - Fix Markdown rendering for custom fields in table columns * [#9986](https://github.com/netbox-community/netbox/issues/9986) - Workaround for upstream timezone data bug --- From 0ef1bc8490dc2f6d6623a3b209406d57bc278efd Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 16 Aug 2022 09:49:51 -0400 Subject: [PATCH 400/593] Clean up bulk edit buttons --- .../templates/dcim/device/consoleports.html | 54 ++++++++++--------- .../dcim/device/consoleserverports.html | 54 ++++++++++--------- netbox/templates/dcim/device/devicebays.html | 44 +++++++-------- netbox/templates/dcim/device/frontports.html | 54 ++++++++++--------- netbox/templates/dcim/device/interfaces.html | 51 ++++++++++-------- netbox/templates/dcim/device/inventory.html | 44 +++++++-------- netbox/templates/dcim/device/modulebays.html | 44 +++++++-------- .../templates/dcim/device/poweroutlets.html | 54 ++++++++++--------- netbox/templates/dcim/device/powerports.html | 54 ++++++++++--------- netbox/templates/dcim/device/rearports.html | 54 ++++++++++--------- netbox/templates/dcim/device_list.html | 16 ++++-- .../virtualmachine/interfaces.html | 43 +++++++-------- 12 files changed, 311 insertions(+), 255 deletions(-) diff --git a/netbox/templates/dcim/device/consoleports.html b/netbox/templates/dcim/device/consoleports.html index afc306bd4..6f8b383c3 100644 --- a/netbox/templates/dcim/device/consoleports.html +++ b/netbox/templates/dcim/device/consoleports.html @@ -16,31 +16,37 @@
    -
    - {% if perms.dcim.change_consoleport %} - - - - {% endif %} - {% if perms.dcim.delete_consoleport %} - - {% endif %} -
    - {% if perms.dcim.add_consoleport %} -
    - - Add Console Port - -
    +
    + {% if perms.dcim.change_consoleport %} +
    + + +
    {% endif %} +
    + {% if perms.dcim.delete_consoleport %} + + {% endif %} + {% if perms.dcim.change_consoleport %} + + {% endif %} +
    +
    + {% if perms.dcim.add_consoleport %} +
    + + Add Console Port + +
    + {% endif %}
    {% endblock %} diff --git a/netbox/templates/dcim/device/consoleserverports.html b/netbox/templates/dcim/device/consoleserverports.html index 5f244cdc7..f246d4a82 100644 --- a/netbox/templates/dcim/device/consoleserverports.html +++ b/netbox/templates/dcim/device/consoleserverports.html @@ -16,31 +16,37 @@
    -
    - {% if perms.dcim.change_consoleserverport %} - - - - {% endif %} - {% if perms.dcim.delete_consoleserverport %} - - {% endif %} -
    - {% if perms.dcim.add_consoleserverport %} -
    - - Add Console Server Ports - -
    +
    + {% if perms.dcim.change_consoleserverport %} +
    + + +
    {% endif %} +
    + {% if perms.dcim.delete_consoleserverport %} + + {% endif %} + {% if perms.dcim.change_consoleserverport %} + + {% endif %} +
    +
    + {% if perms.dcim.add_consoleserverport %} +
    + + Add Console Server Ports + +
    + {% endif %}
    {% endblock %} diff --git a/netbox/templates/dcim/device/devicebays.html b/netbox/templates/dcim/device/devicebays.html index 5e33bdae0..d84408962 100644 --- a/netbox/templates/dcim/device/devicebays.html +++ b/netbox/templates/dcim/device/devicebays.html @@ -16,28 +16,30 @@
    -
    - {% if perms.dcim.change_devicebay %} - - - {% endif %} - {% if perms.dcim.delete_devicebay %} - - {% endif %} -
    - {% if perms.dcim.add_devicebay %} -
    - - Add Device Bays - -
    +
    + {% if perms.dcim.change_devicebay %} +
    + + +
    {% endif %} + {% if perms.dcim.delete_devicebay %} + + {% endif %} +
    + {% if perms.dcim.add_devicebay %} +
    + + Add Device Bays + +
    + {% endif %}
    {% endblock %} diff --git a/netbox/templates/dcim/device/frontports.html b/netbox/templates/dcim/device/frontports.html index 0d0f9577c..513d02090 100644 --- a/netbox/templates/dcim/device/frontports.html +++ b/netbox/templates/dcim/device/frontports.html @@ -16,31 +16,37 @@
    -
    - {% if perms.dcim.change_frontport %} - - - - {% endif %} - {% if perms.dcim.delete_frontport %} - - {% endif %} -
    - {% if perms.dcim.add_frontport %} -
    - - Add front ports - -
    +
    + {% if perms.dcim.change_frontport %} +
    + + +
    {% endif %} +
    + {% if perms.dcim.delete_frontport %} + + {% endif %} + {% if perms.dcim.change_frontport %} + + {% endif %} +
    +
    + {% if perms.dcim.add_frontport %} +
    + + Add front ports + +
    + {% endif %}
    {% endblock %} diff --git a/netbox/templates/dcim/device/interfaces.html b/netbox/templates/dcim/device/interfaces.html index 94e38dbf3..2019d9135 100644 --- a/netbox/templates/dcim/device/interfaces.html +++ b/netbox/templates/dcim/device/interfaces.html @@ -9,7 +9,6 @@
    {% csrf_token %} -
    {% include 'htmx/table.html' %} @@ -19,29 +18,35 @@
    {% if perms.dcim.change_interface %} - - - - {% endif %} - {% if perms.dcim.delete_interface %} - +
    + + +
    {% endif %} +
    + {% if perms.dcim.delete_interface %} + + {% endif %} + {% if perms.dcim.change_interface %} + + {% endif %} +
    {% if perms.dcim.add_interface %}
    diff --git a/netbox/templates/dcim/device/inventory.html b/netbox/templates/dcim/device/inventory.html index 18a0712f3..8b74acaae 100644 --- a/netbox/templates/dcim/device/inventory.html +++ b/netbox/templates/dcim/device/inventory.html @@ -16,28 +16,30 @@
    -
    - {% if perms.dcim.change_inventoryitem %} - - - {% endif %} - {% if perms.dcim.delete_inventoryitem %} - - {% endif %} -
    - {% if perms.dcim.add_inventoryitem %} -
    - - Add Inventory Item - -
    +
    + {% if perms.dcim.change_inventoryitem %} +
    + + +
    {% endif %} + {% if perms.dcim.delete_inventoryitem %} + + {% endif %} +
    + {% if perms.dcim.add_inventoryitem %} +
    + + Add Inventory Item + +
    + {% endif %}
    {% endblock %} diff --git a/netbox/templates/dcim/device/modulebays.html b/netbox/templates/dcim/device/modulebays.html index fc1c9a60d..67b9d88d4 100644 --- a/netbox/templates/dcim/device/modulebays.html +++ b/netbox/templates/dcim/device/modulebays.html @@ -16,28 +16,30 @@
    -
    - {% if perms.dcim.change_modulebay %} - - - {% endif %} - {% if perms.dcim.delete_modulebay %} - - {% endif %} -
    - {% if perms.dcim.add_modulebay %} -
    - - Add Module Bays - -
    +
    + {% if perms.dcim.change_modulebay %} +
    + + +
    {% endif %} + {% if perms.dcim.delete_modulebay %} + + {% endif %} +
    + {% if perms.dcim.add_modulebay %} +
    + + Add Module Bays + +
    + {% endif %}
    {% table_config_form table %} diff --git a/netbox/templates/dcim/device/poweroutlets.html b/netbox/templates/dcim/device/poweroutlets.html index d312fbbd0..61c2b61f4 100644 --- a/netbox/templates/dcim/device/poweroutlets.html +++ b/netbox/templates/dcim/device/poweroutlets.html @@ -16,31 +16,37 @@
    -
    - {% if perms.dcim.change_powerport %} - - - - {% endif %} - {% if perms.dcim.delete_poweroutlet %} - - {% endif %} -
    - {% if perms.dcim.add_poweroutlet %} -
    - - Add Power Outlets - -
    +
    + {% if perms.dcim.change_powerport %} +
    + + +
    {% endif %} +
    + {% if perms.dcim.delete_poweroutlet %} + + {% endif %} + {% if perms.dcim.change_powerport %} + + {% endif %} +
    +
    + {% if perms.dcim.add_poweroutlet %} +
    + + Add Power Outlets + +
    + {% endif %}
    {% endblock %} diff --git a/netbox/templates/dcim/device/powerports.html b/netbox/templates/dcim/device/powerports.html index cf71e81ba..cd8597e63 100644 --- a/netbox/templates/dcim/device/powerports.html +++ b/netbox/templates/dcim/device/powerports.html @@ -16,31 +16,37 @@
    -
    - {% if perms.dcim.change_powerport %} - - - - {% endif %} - {% if perms.dcim.delete_powerport %} - - {% endif %} -
    - {% if perms.dcim.add_powerport %} -
    - - Add Power Port - -
    +
    + {% if perms.dcim.change_powerport %} +
    + + +
    {% endif %} +
    + {% if perms.dcim.delete_powerport %} + + {% endif %} + {% if perms.dcim.change_powerport %} + + {% endif %} +
    +
    + {% if perms.dcim.add_powerport %} +
    + + Add Power Port + +
    + {% endif %}
    {% endblock %} diff --git a/netbox/templates/dcim/device/rearports.html b/netbox/templates/dcim/device/rearports.html index 73341990f..b370de189 100644 --- a/netbox/templates/dcim/device/rearports.html +++ b/netbox/templates/dcim/device/rearports.html @@ -16,31 +16,37 @@
    -
    - {% if perms.dcim.change_rearport %} - - - - {% endif %} - {% if perms.dcim.delete_rearport %} - - {% endif %} -
    - {% if perms.dcim.add_rearport %} -
    - - Add rear ports - -
    +
    + {% if perms.dcim.change_rearport %} +
    + + +
    {% endif %} +
    + {% if perms.dcim.delete_rearport %} + + {% endif %} + {% if perms.dcim.change_rearport %} + + {% endif %} +
    +
    + {% if perms.dcim.add_rearport %} +
    + + Add rear ports + +
    + {% endif %}
    {% endblock %} diff --git a/netbox/templates/dcim/device_list.html b/netbox/templates/dcim/device_list.html index a576a1f9e..50af50525 100644 --- a/netbox/templates/dcim/device_list.html +++ b/netbox/templates/dcim/device_list.html @@ -1,10 +1,8 @@ {% extends 'generic/object_list.html' %} +{% load buttons %} {% block bulk_buttons %} {% if perms.dcim.change_device %} -
    {% endif %} - {{ block.super }} + {% if 'bulk_edit' in actions %} +
    + {% bulk_edit_button model query_params=request.GET %} + +
    + {% endif %} + {% if 'bulk_delete' in actions %} + {% bulk_delete_button model query_params=request.GET %} + {% endif %} {% endblock %} diff --git a/netbox/templates/virtualization/virtualmachine/interfaces.html b/netbox/templates/virtualization/virtualmachine/interfaces.html index e3ffb84d4..eff98cdd6 100644 --- a/netbox/templates/virtualization/virtualmachine/interfaces.html +++ b/netbox/templates/virtualization/virtualmachine/interfaces.html @@ -15,27 +15,28 @@
    - {% if perms.virtualization.change_vminterface %} - - - {% endif %} - {% if perms.virtualization.delete_vminterface %} - - {% endif %} - {% if perms.virtualization.add_vminterface %} -
    - - Add interfaces - -
    - {% endif %} -
    + {% if perms.virtualization.change_vminterface %} +
    + + +
    + {% endif %} + {% if perms.virtualization.delete_vminterface %} + + {% endif %} + {% if perms.virtualization.add_vminterface %} +
    + + Add interfaces + +
    + {% endif %}
    {% endblock content %} From dedee0f9d9d3abded2a6665aea43283be7cc1a8b Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 16 Aug 2022 09:53:13 -0400 Subject: [PATCH 401/593] #9979: Fix fallback to default value --- netbox/netbox/tables/columns.py | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/netbox/netbox/tables/columns.py b/netbox/netbox/tables/columns.py index 113c8416b..6ab50d4c2 100644 --- a/netbox/netbox/tables/columns.py +++ b/netbox/netbox/tables/columns.py @@ -14,6 +14,7 @@ from django_tables2.columns import library from django_tables2.utils import Accessor from extras.choices import CustomFieldTypeChoices +from utilities.templatetags.builtins.filters import render_markdown from utilities.utils import content_type_identifier, content_type_name, get_viewname __all__ = ( @@ -418,14 +419,6 @@ class CustomFieldColumn(tables.Column): """ Display custom fields in the appropriate format. """ - template_code = """ - {% if value %} - {{ value|markdown }} - {% else %} - — - {% endif %} - """ - def __init__(self, customfield, *args, **kwargs): self.customfield = customfield kwargs['accessor'] = Accessor(f'custom_field_data__{customfield.name}') @@ -435,7 +428,7 @@ class CustomFieldColumn(tables.Column): super().__init__(*args, **kwargs) @staticmethod - def _likify_item(item): + def _linkify_item(item): if hasattr(item, 'get_absolute_url'): return f'{escape(item)}' return escape(item) @@ -451,13 +444,13 @@ class CustomFieldColumn(tables.Column): return ', '.join(v for v in value) if self.customfield.type == CustomFieldTypeChoices.TYPE_MULTIOBJECT: return mark_safe(', '.join( - self._likify_item(obj) for obj in self.customfield.deserialize(value) + self._linkify_item(obj) for obj in self.customfield.deserialize(value) )) - if self.customfield.type == CustomFieldTypeChoices.TYPE_LONGTEXT: - return Template(self.template_code).render(Context({"value": value})) + if self.customfield.type == CustomFieldTypeChoices.TYPE_LONGTEXT and value: + return render_markdown(value) if value is not None: obj = self.customfield.deserialize(value) - return mark_safe(self._likify_item(obj)) + return mark_safe(self._linkify_item(obj)) return self.default def value(self, value): From 6d328a82e9dac52821bba08841caa2e1188c310c Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Tue, 16 Aug 2022 10:04:47 -0400 Subject: [PATCH 402/593] Cleanup for #9505 --- netbox/templates/ipam/prefix.html | 95 +++++++++++++------------------ 1 file changed, 40 insertions(+), 55 deletions(-) diff --git a/netbox/templates/ipam/prefix.html b/netbox/templates/ipam/prefix.html index ed2c3339b..b15aa60bb 100644 --- a/netbox/templates/ipam/prefix.html +++ b/netbox/templates/ipam/prefix.html @@ -144,15 +144,14 @@
    + {% if object.prefix.version == 4 %} +
    + + Addressing Details + +
    + {% endif %}
    - {% if object.prefix.version == 4 %} -
    - - - Details - -
    - {% endif %}
    {% include 'inc/panels/custom_fields.html' %} {% include 'inc/panels/tags.html' %} @@ -168,54 +167,40 @@ {% plugin_full_width_page object %}
    -{% if object.prefix.version == 4 %} -