netbox-plugin-dns 1.0.7__py3-none-any.whl → 1.1.0__py3-none-any.whl

netbox_dns/__init__.py

@@ -1,6 +1,11 @@
+from django.conf import settings
+
 from netbox.plugins import PluginConfig
+from ipam.choices import IPAddressStatusChoices
+
+from netbox_dns.choices import RecordTypeChoices
 
-__version__ = "1.0.7"
+__version__ = "1.1.0"
 
 
 class DNSConfig(PluginConfig):
@@ -20,13 +25,20 @@ class DNSConfig(PluginConfig):
         "zone_soa_retry": 7200,
         "zone_soa_expire": 2419200,
         "zone_soa_minimum": 3600,
-        "feature_ipam_coupling": False,
+        "dnssync_disabled": False,
+        "dnssync_ipaddress_active_status": [
+            IPAddressStatusChoices.STATUS_ACTIVE,
+            IPAddressStatusChoices.STATUS_DHCP,
+            IPAddressStatusChoices.STATUS_SLAAC,
+        ],
+        "dnssync_conflict_deactivate": False,
+        "dnssync_minimum_zone_labels": 2,
         "tolerate_characters_in_zone_labels": "",
         "tolerate_underscores_in_labels": False,
         "tolerate_underscores_in_hostnames": False,  # Deprecated, will be removed in 1.2.0
         "tolerate_leading_underscore_types": [
-            "TXT",
-            "SRV",
+            RecordTypeChoices.TXT,
+            RecordTypeChoices.SRV,
         ],
         "tolerate_non_rfc1035_types": [],
         "enable_root_zones": False,
@@ -37,6 +49,13 @@ class DNSConfig(PluginConfig):
     }
     base_url = "netbox-dns"
 
+    def ready(self):
+        super().ready()
+
+        if not settings.PLUGINS_CONFIG["netbox_dns"].get("dnssync_disabled"):
+            import netbox_dns.signals.ipam_dnssync
+            import netbox_dns.tables.ipam_dnssync
+
 
 #
 # Initialize plugin config

netbox_dns/api/serializers.py

@@ -1,10 +1,11 @@
-from .serializers_.contact import *
 from .serializers_.nameserver import *
 from .serializers_.record import *
 from .serializers_.registrar import *
+from .serializers_.registration_contact import *
 from .serializers_.view import *
 from .serializers_.zone import *
 from .serializers_.zone_template import *
 from .serializers_.record_template import *
+from .serializers_.prefix import *
 
 from .nested_serializers import *

netbox_dns/api/serializers_/prefix.py

@@ -0,0 +1,18 @@
+from rest_framework.serializers import HyperlinkedIdentityField
+
+from ipam.api.serializers import PrefixSerializer as IPAMPrefixSerializer
+
+
+__all__ = ("PrefixSerializer",)
+
+
+class PrefixSerializer(IPAMPrefixSerializer):
+    url = HyperlinkedIdentityField(view_name="plugins-api:netbox_dns-api:prefix-detail")
+
+    def to_representation(self, instance):
+        representation = super().to_representation(instance)
+
+        if instance.vrf is not None:
+            representation["display"] += f" [{instance.vrf.name}]"
+
+        return representation

netbox_dns/api/serializers_/{contact.py → registration_contact.py}

@@ -2,19 +2,19 @@ from rest_framework import serializers
 
 from netbox.api.serializers import NetBoxModelSerializer
 
-from netbox_dns.models import Contact
+from netbox_dns.models import RegistrationContact
 
 
-__all__ = ("ContactSerializer",)
+__all__ = ("RegistrationContactSerializer",)
 
 
-class ContactSerializer(NetBoxModelSerializer):
+class RegistrationContactSerializer(NetBoxModelSerializer):
     url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:contact-detail"
+        view_name="plugins-api:netbox_dns-api:registrationcontact-detail"
     )
 
     class Meta:
-        model = Contact
+        model = RegistrationContact
         fields = (
             "id",
             "url",

netbox_dns/api/serializers_/view.py

@@ -1,7 +1,8 @@
 from rest_framework import serializers
 
 from netbox.api.serializers import NetBoxModelSerializer
-from tenancy.api.serializers_.tenants import TenantSerializer
+from tenancy.api.serializers import TenantSerializer
+from ipam.api.serializers import PrefixSerializer
 
 from netbox_dns.models import View
 
@@ -16,8 +17,38 @@ class ViewSerializer(NetBoxModelSerializer):
     default_view = serializers.BooleanField(
         read_only=True,
     )
+    prefixes = PrefixSerializer(
+        many=True,
+        nested=True,
+        read_only=False,
+        required=False,
+        help_text="IPAM Prefixes assigned to the View",
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )
+
+    def create(self, validated_data):
+        prefixes = validated_data.pop("prefixes", None)
+
+        view = super().create(validated_data)
+
+        if prefixes is not None:
+            view.prefixes.set(prefixes)
+
+        return view
+
+    def update(self, instance, validated_data):
+        prefixes = validated_data.pop("prefixes", None)
+
+        view = super().update(instance, validated_data)
+
+        if prefixes is not None:
+            view.prefixes.set(prefixes)
 
-    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+        return view
 
     class Meta:
         model = View
@@ -33,5 +64,6 @@ class ViewSerializer(NetBoxModelSerializer):
             "last_updated",
             "custom_fields",
             "tenant",
+            "prefixes",
         )
         brief_fields = ("id", "url", "display", "name", "default_view", "description")

netbox_dns/api/serializers_/zone.py

@@ -6,7 +6,7 @@ from tenancy.api.serializers import TenantSerializer
 from .view import ViewSerializer
 from .nameserver import NameServerSerializer
 from .registrar import RegistrarSerializer
-from .contact import ContactSerializer
+from .registration_contact import RegistrationContactSerializer
 from .zone_template import ZoneTemplateSerializer
 
 from ..nested_serializers import NestedZoneSerializer
@@ -62,28 +62,28 @@ class ZoneSerializer(NetBoxModelSerializer):
         required=False,
         help_text="The registrar the domain is registered with",
     )
-    registrant = ContactSerializer(
+    registrant = RegistrationContactSerializer(
         nested=True,
         many=False,
         read_only=False,
         required=False,
         help_text="The owner of the domain",
     )
-    admin_c = ContactSerializer(
+    admin_c = RegistrationContactSerializer(
         nested=True,
         many=False,
         read_only=False,
         required=False,
         help_text="The administrative contact for the domain",
     )
-    tech_c = ContactSerializer(
+    tech_c = RegistrationContactSerializer(
         nested=True,
         many=False,
         read_only=False,
         required=False,
         help_text="The technical contact for the domain",
     )
-    billing_c = ContactSerializer(
+    billing_c = RegistrationContactSerializer(
         nested=True,
         many=False,
         read_only=False,

netbox_dns/api/serializers_/zone_template.py

@@ -8,7 +8,7 @@ from netbox_dns.api.nested_serializers import NestedRecordTemplateSerializer
 
 from .nameserver import NameServerSerializer
 from .registrar import RegistrarSerializer
-from .contact import ContactSerializer
+from .registration_contact import RegistrationContactSerializer
 
 
 __all__ = ("ZoneTemplateSerializer",)
@@ -38,28 +38,28 @@ class ZoneTemplateSerializer(NetBoxModelSerializer):
         required=False,
         help_text="The registrar the domain is registered with",
     )
-    registrant = ContactSerializer(
+    registrant = RegistrationContactSerializer(
         nested=True,
         many=False,
         read_only=False,
         required=False,
         help_text="The owner of the domain",
     )
-    admin_c = ContactSerializer(
+    admin_c = RegistrationContactSerializer(
         nested=True,
         many=False,
         read_only=False,
         required=False,
         help_text="The administrative contact for the domain",
     )
-    tech_c = ContactSerializer(
+    tech_c = RegistrationContactSerializer(
         nested=True,
         many=False,
         read_only=False,
         required=False,
         help_text="The technical contact for the domain",
     )
-    billing_c = ContactSerializer(
+    billing_c = RegistrationContactSerializer(
         nested=True,
         many=False,
         read_only=False,

netbox_dns/api/urls.py

@@ -7,9 +7,10 @@ from netbox_dns.api.views import (
     NameServerViewSet,
     RecordViewSet,
     RegistrarViewSet,
-    ContactViewSet,
+    RegistrationContactViewSet,
     ZoneTemplateViewSet,
     RecordTemplateViewSet,
+    PrefixViewSet,
 )
 
 router = NetBoxRouter()
@@ -20,8 +21,10 @@ router.register("zones", ZoneViewSet)
 router.register("nameservers", NameServerViewSet)
 router.register("records", RecordViewSet)
 router.register("registrars", RegistrarViewSet)
-router.register("contacts", ContactViewSet)
+router.register("contacts", RegistrationContactViewSet)
 router.register("zonetemplates", ZoneTemplateViewSet)
 router.register("recordtemplates", RecordTemplateViewSet)
 
+router.register("prefixes", PrefixViewSet)
+
 urlpatterns = router.urls

netbox_dns/api/views.py

@@ -1,6 +1,9 @@
 from rest_framework import serializers
 from rest_framework.routers import APIRootView
 
+from ipam.models import Prefix
+from ipam.filtersets import PrefixFilterSet
+
 from netbox.api.viewsets import NetBoxModelViewSet
 
 from netbox_dns.api.serializers import (
@@ -9,9 +12,10 @@ from netbox_dns.api.serializers import (
     NameServerSerializer,
     RecordSerializer,
     RegistrarSerializer,
-    ContactSerializer,
+    RegistrationContactSerializer,
     ZoneTemplateSerializer,
     RecordTemplateSerializer,
+    PrefixSerializer,
 )
 from netbox_dns.filtersets import (
     ViewFilterSet,
@@ -19,7 +23,7 @@ from netbox_dns.filtersets import (
     NameServerFilterSet,
     RecordFilterSet,
     RegistrarFilterSet,
-    ContactFilterSet,
+    RegistrationContactFilterSet,
     ZoneTemplateFilterSet,
     RecordTemplateFilterSet,
 )
@@ -29,7 +33,7 @@ from netbox_dns.models import (
     NameServer,
     Record,
     Registrar,
-    Contact,
+    RegistrationContact,
     ZoneTemplate,
     RecordTemplate,
 )
@@ -108,10 +112,10 @@ class RegistrarViewSet(NetBoxModelViewSet):
     filterset_class = RegistrarFilterSet
 
 
-class ContactViewSet(NetBoxModelViewSet):
-    queryset = Contact.objects.all()
-    serializer_class = ContactSerializer
-    filterset_class = ContactFilterSet
+class RegistrationContactViewSet(NetBoxModelViewSet):
+    queryset = RegistrationContact.objects.all()
+    serializer_class = RegistrationContactSerializer
+    filterset_class = RegistrationContactFilterSet
 
 
 class ZoneTemplateViewSet(NetBoxModelViewSet):
@@ -124,3 +128,9 @@ class RecordTemplateViewSet(NetBoxModelViewSet):
     queryset = RecordTemplate.objects.all()
     serializer_class = RecordTemplateSerializer
     filterset_class = RecordTemplateFilterSet
+
+
+class PrefixViewSet(NetBoxModelViewSet):
+    queryset = Prefix.objects.all()
+    serializer_class = PrefixSerializer
+    filterset_class = PrefixFilterSet

netbox_dns/fields/__init__.py

@@ -1,3 +1,4 @@
 from .network import *
 from .address import *
 from .rfc2317 import *
+from .ipam import *

netbox_dns/fields/ipam.py

@@ -0,0 +1,15 @@
+from utilities.forms.fields import DynamicModelMultipleChoiceField
+from utilities.forms.widgets import APISelectMultiple
+
+
+__all__ = ("PrefixDynamicModelMultipleChoiceField",)
+
+
+class PrefixDynamicModelMultipleChoiceField(DynamicModelMultipleChoiceField):
+    widget = APISelectMultiple(api_url="/api/plugins/netbox-dns/prefixes")
+
+    def label_from_instance(self, obj):
+        if obj.vrf:
+            return f"{str(obj.prefix)} [{obj.vrf.name}]"
+
+        return str(obj.prefix)

netbox_dns/filtersets/__init__.py

@@ -2,7 +2,7 @@ from .view import *
 from .zone import *
 from .nameserver import *
 from .record import *
-from .contact import *
+from .registration_contact import *
 from .registrar import *
 
 from .zone_template import *

netbox_dns/filtersets/{contact.py → registration_contact.py}

@@ -2,15 +2,15 @@ from django.db.models import Q
 
 from netbox.filtersets import NetBoxModelFilterSet
 
-from netbox_dns.models import Contact
+from netbox_dns.models import RegistrationContact
 
 
-__all__ = ("ContactFilterSet",)
+__all__ = ("RegistrationContactFilterSet",)
 
 
-class ContactFilterSet(NetBoxModelFilterSet):
+class RegistrationContactFilterSet(NetBoxModelFilterSet):
     class Meta:
-        model = Contact
+        model = RegistrationContact
         fields = (
             "id",
             "name",

netbox_dns/filtersets/view.py

@@ -1,7 +1,10 @@
+import django_filters
+
 from django.db.models import Q
 
 from netbox.filtersets import NetBoxModelFilterSet
 from tenancy.filtersets import TenancyFilterSet
+from ipam.models import Prefix
 
 from netbox_dns.models import View
 
@@ -10,6 +13,19 @@ __all__ = ("ViewFilterSet",)
 
 
 class ViewFilterSet(NetBoxModelFilterSet, TenancyFilterSet):
+    prefix_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=Prefix.objects.all(),
+        field_name="prefixes",
+        to_field_name="id",
+        label="Prefixes ID",
+    )
+    prefix = django_filters.ModelMultipleChoiceFilter(
+        queryset=Prefix.objects.all(),
+        field_name="prefixes__prefix",
+        to_field_name="prefix",
+        label="Prefix",
+    )
+
     class Meta:
         model = View
         fields = ("id", "name", "default_view", "description")

netbox_dns/filtersets/zone.py

@@ -7,7 +7,7 @@ from netbox.filtersets import NetBoxModelFilterSet
 from tenancy.filtersets import TenancyFilterSet
 from utilities.filters import MultiValueCharFilter
 
-from netbox_dns.models import View, Zone, Registrar, Contact, NameServer
+from netbox_dns.models import View, Zone, Registrar, RegistrationContact, NameServer
 from netbox_dns.choices import ZoneStatusChoices
 
 
@@ -95,44 +95,44 @@ class ZoneFilterSet(TenancyFilterSet, NetBoxModelFilterSet):
         label="Registrar",
     )
     registrant_id = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         label="Registrant ID",
     )
     registrant = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         field_name="registrant__contact_id",
         to_field_name="contact_id",
         label="Registrant",
     )
     admin_c_id = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
-        label="Administrative Contact ID",
+        queryset=RegistrationContact.objects.all(),
+        label="Administrative RegistrationContact ID",
     )
     admin_c = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         field_name="admin_c__contact_id",
         to_field_name="contact_id",
-        label="Administrative Contact",
+        label="Administrative RegistrationContact",
     )
     tech_c_id = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
-        label="Technical Contact ID",
+        queryset=RegistrationContact.objects.all(),
+        label="Technical RegistrationContact ID",
     )
     tech_c = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         field_name="tech_c__contact_id",
         to_field_name="contact_id",
-        label="Technical Contact",
+        label="Technical RegistrationContact",
     )
     billing_c_id = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
-        label="Billing Contact ID",
+        queryset=RegistrationContact.objects.all(),
+        label="Billing RegistrationContact ID",
     )
     billing_c = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         field_name="billing_c__contact_id",
         to_field_name="contact_id",
-        label="Billing Contact",
+        label="Billing RegistrationContact",
     )
     active = django_filters.BooleanFilter(
         label="Zone is active",

netbox_dns/filtersets/zone_template.py

@@ -9,7 +9,7 @@ from netbox_dns.models import (
     ZoneTemplate,
     RecordTemplate,
     Registrar,
-    Contact,
+    RegistrationContact,
     NameServer,
 )
 
@@ -53,44 +53,44 @@ class ZoneTemplateFilterSet(TenancyFilterSet, NetBoxModelFilterSet):
         label="Registrar",
     )
     registrant_id = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         label="Registrant ID",
     )
     registrant = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         field_name="registrant__contact_id",
         to_field_name="contact_id",
         label="Registrant",
     )
     admin_c_id = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
-        label="Administrative Contact ID",
+        queryset=RegistrationContact.objects.all(),
+        label="Administrative RegistrationContact ID",
     )
     admin_c = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         field_name="admin_c__contact_id",
         to_field_name="contact_id",
-        label="Administrative Contact",
+        label="Administrative RegistrationContact",
     )
     tech_c_id = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
-        label="Technical Contact ID",
+        queryset=RegistrationContact.objects.all(),
+        label="Technical RegistrationContact ID",
     )
     tech_c = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         field_name="tech_c__contact_id",
         to_field_name="contact_id",
-        label="Technical Contact",
+        label="Technical RegistrationContact",
     )
     billing_c_id = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
-        label="Billing Contact ID",
+        queryset=RegistrationContact.objects.all(),
+        label="Billing RegistrationContact ID",
     )
     billing_c = django_filters.ModelMultipleChoiceFilter(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         field_name="billing_c__contact_id",
         to_field_name="contact_id",
-        label="Billing Contact",
+        label="Billing RegistrationContact",
     )
 
     class Meta:

netbox_dns/forms/__init__.py

@@ -2,7 +2,7 @@ from .view import *
 from .zone import *
 from .nameserver import *
 from .record import *
-from .contact import *
+from .registration_contact import *
 from .registrar import *
 from .zone_template import *
 from .record_template import *

netbox_dns/forms/{contact.py → registration_contact.py}

@@ -9,18 +9,18 @@ from netbox.forms import (
 from utilities.forms.fields import TagFilterField
 from utilities.forms.rendering import FieldSet
 
-from netbox_dns.models import Contact
+from netbox_dns.models import RegistrationContact
 
 
 __all__ = (
-    "ContactForm",
-    "ContactFilterForm",
-    "ContactImportForm",
-    "ContactBulkEditForm",
+    "RegistrationContactForm",
+    "RegistrationContactFilterForm",
+    "RegistrationContactImportForm",
+    "RegistrationContactBulkEditForm",
 )
 
 
-class ContactForm(NetBoxModelForm):
+class RegistrationContactForm(NetBoxModelForm):
     fieldsets = (
         FieldSet(
             "name",
@@ -37,13 +37,13 @@ class ContactForm(NetBoxModelForm):
             "fax",
             "fax_ext",
             "email",
-            name="Contact",
+            name="RegistrationContact",
         ),
         FieldSet("tags", name="Tags"),
     )
 
     class Meta:
-        model = Contact
+        model = RegistrationContact
         fields = (
             "name",
             "description",
@@ -63,8 +63,8 @@ class ContactForm(NetBoxModelForm):
         )
 
 
-class ContactFilterForm(NetBoxModelFilterSetForm):
-    model = Contact
+class RegistrationContactFilterForm(NetBoxModelFilterSetForm):
+    model = RegistrationContact
 
     fieldsets = (
         FieldSet("q", "filter_id", "tag"),
@@ -89,7 +89,7 @@ class ContactFilterForm(NetBoxModelFilterSetForm):
     )
     contact_id = forms.CharField(
         required=False,
-        label="Contact ID",
+        label="RegistrationContact ID",
     )
     organization = forms.CharField(
         required=False,
@@ -128,12 +128,12 @@ class ContactFilterForm(NetBoxModelFilterSetForm):
     email = forms.CharField(
         required=False,
     )
-    tag = TagFilterField(Contact)
+    tag = TagFilterField(RegistrationContact)
 
 
-class ContactImportForm(NetBoxModelImportForm):
+class RegistrationContactImportForm(NetBoxModelImportForm):
     class Meta:
-        model = Contact
+        model = RegistrationContact
         fields = (
             "name",
             "description",
@@ -153,8 +153,8 @@ class ContactImportForm(NetBoxModelImportForm):
         )
 
 
-class ContactBulkEditForm(NetBoxModelBulkEditForm):
-    model = Contact
+class RegistrationContactBulkEditForm(NetBoxModelBulkEditForm):
+    model = RegistrationContact
 
     name = forms.CharField(
         required=False,