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

netbox_dns/management/commands/setup_autodns.py

@@ -0,0 +1,120 @@
+from django.core.management.base import BaseCommand
+
+from core.models import ObjectType
+from extras.models import CustomField
+from extras.choices import CustomFieldTypeChoices
+from ipam.models import IPAddress
+
+
+class Command(BaseCommand):
+    help = "Setup IPAddress custom fields for IPAM AutoDNS"
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--remove", action="store_true", default=False, help="Remove custom fields"
+        )
+
+    def handle(self, *model_names, **options):
+        ipaddress_object_type = ObjectType.objects.get_for_model(IPAddress)
+
+        if options.get("remove"):
+            if options.get("verbosity"):
+                self.stdout.write(f"Trying to remove IPAM AutoDNS custom fields")
+            for cf in (
+                "ipaddress_dns_disabled",
+                "ipaddress_dns_record_ttl",
+                "ipaddress_dns_record_disable_ptr",
+            ):
+                try:
+                    CustomField.objects.get(
+                        name=cf, object_types=ipaddress_object_type
+                    ).delete()
+                    if options.get("verbosity") >= 2:
+                        self.stdout.write(f"Custom field '{cf}' removed")
+                except CustomField.DoesNotExist:
+                    pass
+            return
+
+        # +
+        # Remove pre-existing IPAM Coupling custom fields
+        # -
+        if options.get("verbosity"):
+            self.stdout.write(f"Trying to remove obsolete IPAM Coupling custom fields")
+        for cf in (
+            "ipaddress_dns_record_name",
+            "ipaddress_dns_zone_id",
+        ):
+            try:
+                CustomField.objects.get(
+                    name=cf, object_types=ipaddress_object_type
+                ).delete()
+                if options.get("verbosity") >= 2:
+                    self.stdout.write(f"Removed custom field '{cf}'")
+            except CustomField.DoesNotExist:
+                pass
+
+        if options.get("verbosity"):
+            self.stdout.write(f"Creating IPAM AutoDNS custom fields")
+
+        if not CustomField.objects.filter(
+            name="ipaddress_dns_disabled",
+            type=CustomFieldTypeChoices.TYPE_BOOLEAN,
+            object_types=ipaddress_object_type,
+        ).exists():
+            cf_disable_ptr = CustomField.objects.create(
+                name="ipaddress_dns_disabled",
+                label="Disable AutoDNS",
+                description="Disable DNS address and pointer record generation for this address",
+                type=CustomFieldTypeChoices.TYPE_BOOLEAN,
+                required=False,
+                default=False,
+                group_name="AutoDNS",
+                is_cloneable=True,
+                weight=100,
+            )
+            cf_disable_ptr.object_types.set([ipaddress_object_type])
+            if options.get("verbosity") >= 2:
+                self.stdout.write("Created custom field 'ipaddress_dns_disabled'")
+
+        if not CustomField.objects.filter(
+            name="ipaddress_dns_record_ttl",
+            type=CustomFieldTypeChoices.TYPE_INTEGER,
+            object_types=ipaddress_object_type,
+        ).exists():
+            cf_ttl = CustomField.objects.create(
+                name="ipaddress_dns_record_ttl",
+                description="TTL for DNS records created for this address",
+                label="TTL",
+                type=CustomFieldTypeChoices.TYPE_INTEGER,
+                validation_minimum=0,
+                validation_maximum=2147483647,
+                required=False,
+                group_name="AutoDNS",
+                is_cloneable=True,
+                weight=200,
+            )
+            cf_ttl.object_types.set([ipaddress_object_type])
+            if options.get("verbosity") >= 2:
+                self.stdout.write("Created custom field 'ipaddress_dns_record_ttl'")
+
+        if not CustomField.objects.filter(
+            name="ipaddress_dns_record_disable_ptr",
+            type=CustomFieldTypeChoices.TYPE_BOOLEAN,
+            object_types=ipaddress_object_type,
+        ).exists():
+            cf_disable_ptr = CustomField.objects.create(
+                name="ipaddress_dns_record_disable_ptr",
+                description="Disable DNS PTR record generation for this address",
+                label="Disable PTR",
+                type=CustomFieldTypeChoices.TYPE_BOOLEAN,
+                required=False,
+                default=False,
+                group_name="AutoDNS",
+                is_cloneable=True,
+                weight=300,
+            )
+            cf_disable_ptr.object_types.set([ipaddress_object_type])
+            if options.get("verbosity") >= 2:
+                self.stdout.write(
+                    "Created custom field 'ipaddress_dns_record_disable_ptr'"
+                )

netbox_dns/migrations/0007_view_prefixes.py

@@ -0,0 +1,18 @@
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("ipam", "0067_ipaddress_index_host"),
+        ("netbox_dns", "0006_templating"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="view",
+            name="prefixes",
+            field=models.ManyToManyField(
+                blank=True, related_name="netbox_dns_views", to="ipam.prefix"
+            ),
+        ),
+    ]

netbox_dns/models/__init__.py

@@ -11,5 +11,3 @@ from .record_template import *
 # Backwards compatibility fix, will be removed in version 1.1
 # -
 from netbox_dns.choices import *
-
-from netbox_dns.signals import ipam_coupling

netbox_dns/models/contact.py

@@ -87,7 +87,7 @@ class Contact(NetBoxModel):
         related_name="netbox_dns_contact_set",
     )
 
-    clone_fields = (
+    clone_fields = [
         "name",
         "description",
         "organization",
@@ -102,7 +102,7 @@ class Contact(NetBoxModel):
         "fax_ext",
         "email",
         "tags",
-    )
+    ]
 
     def get_absolute_url(self):
         return reverse("plugins:netbox_dns:contact", kwargs={"pk": self.pk})
@@ -114,13 +114,7 @@ class Contact(NetBoxModel):
         return self.contact_id
 
     class Meta:
-        verbose_name = "Contact"
-        verbose_name_plural = "Contacts"
-
-        ordering = (
-            "name",
-            "contact_id",
-        )
+        ordering = ("name", "contact_id")
 
     @property
     def zones(self):

netbox_dns/models/nameserver.py

@@ -7,7 +7,6 @@ from django.urls import reverse
 
 from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
-from netbox.models.features import ContactsMixin
 
 from netbox_dns.utilities import (
     name_to_unicode,
@@ -27,7 +26,7 @@ __all__ = (
 )
 
 
-class NameServer(ObjectModificationMixin, ContactsMixin, NetBoxModel):
+class NameServer(ObjectModificationMixin, NetBoxModel):
     name = models.CharField(
         unique=True,
         max_length=255,
@@ -44,17 +43,13 @@ class NameServer(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         null=True,
     )
 
-    clone_fields = (
-        "name",
-        "description",
-    )
+    clone_fields = ["name", "description"]
 
     class Meta:
+        ordering = ("name",)
         verbose_name = "Nameserver"
         verbose_name_plural = "Nameservers"
 
-        ordering = ("name",)
-
     def __str__(self):
         try:
             return dns_name.from_text(self.name, origin=None).to_unicode()

netbox_dns/models/record.py

@@ -7,9 +7,9 @@ from django.core.exceptions import ValidationError
 from django.db import transaction, models
 from django.db.models import Q, ExpressionWrapper, BooleanField, Min
 from django.urls import reverse
+from django.conf import settings
 
 from netbox.models import NetBoxModel
-from netbox.models.features import ContactsMixin
 from netbox.search import SearchIndex, register_search
 from netbox.plugins.utils import get_plugin_config
 from utilities.querysets import RestrictedQuerySet
@@ -36,6 +36,43 @@ def min_ttl(*ttl_list):
     return min((ttl for ttl in ttl_list if ttl is not None), default=None)
 
 
+def record_data_from_ip_address(ip_address, zone):
+    cf_data = ip_address.custom_field_data
+
+    if cf_data.get("ipaddress_dns_disabled"):
+        return None
+
+    data = {
+        "name": (
+            dns_name.from_text(ip_address.dns_name)
+            .relativize(dns_name.from_text(zone.name))
+            .to_text()
+        ),
+        "type": (
+            RecordTypeChoices.A
+            if ip_address.address.version == 4
+            else RecordTypeChoices.AAAA
+        ),
+        "value": str(ip_address.address.ip),
+        "status": (
+            RecordStatusChoices.STATUS_ACTIVE
+            if ip_address.status
+            in settings.PLUGINS_CONFIG["netbox_dns"].get(
+                "autodns_ipaddress_active_status", []
+            )
+            else RecordStatusChoices.STATUS_INACTIVE
+        ),
+    }
+
+    if "ipaddress_dns_record_ttl" in cf_data:
+        data["ttl"] = cf_data.get("ipaddress_dns_record_ttl")
+
+    if (disable_ptr := cf_data.get("ipaddress_dns_record_disable_ptr")) is not None:
+        data["disable_ptr"] = disable_ptr
+
+    return data
+
+
 class RecordManager(models.Manager.from_queryset(RestrictedQuerySet)):
     """
     Custom manager for records providing the activity status annotation
@@ -63,7 +100,7 @@ class RecordManager(models.Manager.from_queryset(RestrictedQuerySet)):
         )
 
 
-class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
+class Record(ObjectModificationMixin, NetBoxModel):
     ACTIVE_STATUS_LIST = (RecordStatusChoices.STATUS_ACTIVE,)
 
     unique_ptr_qs = Q(
@@ -156,7 +193,7 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     objects = RecordManager()
     raw_objects = RestrictedQuerySet.as_manager()
 
-    clone_fields = (
+    clone_fields = [
         "zone",
         "type",
         "name",
@@ -165,20 +202,10 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         "ttl",
         "disable_ptr",
         "description",
-    )
+    ]
 
     class Meta:
-        verbose_name = "Record"
-        verbose_name_plural = "Records"
-
-        ordering = (
-            "fqdn",
-            "zone",
-            "name",
-            "type",
-            "value",
-            "status",
-        )
+        ordering = ("zone", "name", "type", "value", "status")
 
     def __str__(self):
         try:
@@ -434,6 +461,35 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                 self.rfc2317_cname_record.delete(save_zone_serial=save_zone_serial)
                 self.rfc2317_cname_record = None
 
+    def update_from_ip_address(self, ip_address):
+        data = record_data_from_ip_address(ip_address, self.zone)
+
+        if data is None:
+            self.delete()
+            return
+
+        if all((getattr(self, attr) == data[attr] for attr in data.keys())):
+            return
+
+        for attr, value in data.items():
+            setattr(self, attr, value)
+
+        return self
+
+    @classmethod
+    def create_from_ip_address(cls, ip_address, zone):
+        data = record_data_from_ip_address(ip_address, zone)
+
+        if data is None:
+            return
+
+        return Record(
+            zone=zone,
+            managed=True,
+            ipam_ip_address=ip_address,
+            **data,
+        )
+
     def validate_name(self):
         try:
             _zone = dns_name.from_text(self.zone.name, origin=dns_name.root)
@@ -531,7 +587,6 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             )
             .exclude(ttl=self.ttl)
             .exclude(type=RecordTypeChoices.PTR, managed=True)
-            .exclude(status=RecordStatusChoices.STATUS_INACTIVE)
         )
 
         if not records.exists():
@@ -566,7 +621,6 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             .exclude(pk=self.pk)
             .exclude(ttl=ttl)
             .exclude(type=RecordTypeChoices.PTR, managed=True)
-            .exclude(status=RecordStatusChoices.STATUS_INACTIVE)
         )
 
         for record in records:

netbox_dns/models/record_template.py

@@ -85,10 +85,7 @@ class RecordTemplate(NetBoxModel):
     )
 
     class Meta:
-        verbose_name = "Record Template"
-        verbose_name_plural = "Record Templates"
-
-        ordering = ("name",)
+        ordering = ["name"]
 
     def __str__(self):
         return str(self.name)

netbox_dns/models/registrar.py

@@ -59,13 +59,7 @@ class Registrar(NetBoxModel):
         return str(self.name)
 
     class Meta:
-        verbose_name = "Registrar"
-        verbose_name_plural = "Registrars"
-
-        ordering = (
-            "name",
-            "iana_id",
-        )
+        ordering = ("name", "iana_id")
 
 
 @register_search

netbox_dns/models/view.py

@@ -3,7 +3,6 @@ from django.urls import reverse
 from django.core.exceptions import ValidationError
 
 from netbox.models import NetBoxModel
-from netbox.models.features import ContactsMixin
 from netbox.search import SearchIndex, register_search
 from netbox.context import current_request
 from utilities.exceptions import AbortRequest
@@ -17,7 +16,7 @@ __all__ = (
 )
 
 
-class View(ObjectModificationMixin, ContactsMixin, NetBoxModel):
+class View(ObjectModificationMixin, NetBoxModel):
     name = models.CharField(
         unique=True,
         max_length=255,
@@ -29,6 +28,11 @@ class View(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     default_view = models.BooleanField(
         default=False,
     )
+    prefixes = models.ManyToManyField(
+        to="ipam.Prefix",
+        related_name="netbox_dns_views",
+        blank=True,
+    )
     tenant = models.ForeignKey(
         to="tenancy.Tenant",
         on_delete=models.PROTECT,
@@ -37,10 +41,7 @@ class View(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         null=True,
     )
 
-    clone_fields = (
-        "name",
-        "description",
-    )
+    clone_fields = ["name", "description"]
 
     @classmethod
     def get_default_view(cls):
@@ -53,9 +54,6 @@ class View(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         return str(self.name)
 
     class Meta:
-        verbose_name = "View"
-        verbose_name_plural = "Views"
-
         ordering = ("name",)
 
     def delete(self, *args, **kwargs):

netbox_dns/models/zone.py

@@ -19,7 +19,6 @@ from django.dispatch import receiver
 from django.conf import settings
 
 from netbox.models import NetBoxModel
-from netbox.models.features import ContactsMixin
 from netbox.search import SearchIndex, register_search
 from netbox.plugins.utils import get_plugin_config
 from utilities.querysets import RestrictedQuerySet
@@ -28,6 +27,8 @@ from ipam.models import IPAddress
 from netbox_dns.choices import RecordClassChoices, RecordTypeChoices, ZoneStatusChoices
 from netbox_dns.fields import NetworkField, RFC2317NetworkField
 from netbox_dns.utilities import (
+    update_dns_records,
+    get_ip_addresses_by_zone,
     arpa_to_prefix,
     name_to_unicode,
     normalize_name,
@@ -35,7 +36,6 @@ from netbox_dns.utilities import (
 )
 from netbox_dns.validators import (
     validate_fqdn,
-    validate_rname,
     validate_domain_name,
 )
 from netbox_dns.mixins import ObjectModificationMixin
@@ -68,7 +68,7 @@ class ZoneManager(models.Manager.from_queryset(RestrictedQuerySet)):
         )
 
 
-class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
+class Zone(ObjectModificationMixin, NetBoxModel):
     ACTIVE_STATUS_LIST = (ZoneStatusChoices.STATUS_ACTIVE,)
 
     def __init__(self, *args, **kwargs):
@@ -247,7 +247,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
 
     objects = ZoneManager()
 
-    clone_fields = (
+    clone_fields = [
         "view",
         "name",
         "status",
@@ -261,12 +261,9 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         "soa_expire",
         "soa_minimum",
         "description",
-    )
+    ]
 
     class Meta:
-        verbose_name = "Zone"
-        verbose_name_plural = "Zones"
-
         ordering = (
             "view",
             "name",
@@ -623,7 +620,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             raise ValidationError("soa_rname not set and no default value defined")
         try:
             dns_name.from_text(self.soa_rname, origin=dns_name.root)
-            validate_rname(self.soa_rname)
+            validate_fqdn(self.soa_rname)
         except (DNSException, ValidationError) as exc:
             raise ValidationError(
                 {
@@ -643,7 +640,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             old_zone = Zone.objects.get(pk=self.pk)
             if not self.soa_serial_auto:
                 self.check_soa_serial_increment(old_zone.soa_serial, self.soa_serial)
-            elif not old_zone.soa_serial_auto:
+            else:
                 try:
                     self.check_soa_serial_increment(
                         old_zone.soa_serial, self.get_auto_serial()
@@ -773,17 +770,6 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             ):
                 address_record.save(update_fields=["ptr_record"])
 
-            # Fix name in IP Address when zone name is changed
-            if (
-                get_plugin_config("netbox_dns", "feature_ipam_coupling")
-                and "name" in changed_fields
-            ):
-                for ip in IPAddress.objects.filter(
-                    custom_field_data__ipaddress_dns_zone_id=self.pk
-                ):
-                    ip.dns_name = f'{ip.custom_field_data["ipaddress_dns_record_name"]}.{self.name}'
-                    ip.save(update_fields=["dns_name"])
-
         if changed_fields is not None and "name" in changed_fields:
             for _record in self.record_set.all():
                 _record.save(
@@ -793,6 +779,16 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                     update_rfc2317_cname=False,
                 )
 
+        if changed_fields is None or {"name", "view"} & changed_fields:
+            update_ip_addresses = IPAddress.objects.filter(
+                pk__in=self.record_set.filter(
+                    ipam_ip_address__isnull=False
+                ).values_list("ipam_ip_address", flat=True)
+            )
+            update_ip_addresses |= get_ip_addresses_by_zone(self)
+            for ip_address in update_ip_addresses:
+                update_dns_records(ip_address)
+
         self.save_soa_serial()
         self.update_soa_record()
 
@@ -828,14 +824,13 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                 self.rfc2317_child_zones.all().values_list("pk", flat=True)
             )
 
-            if get_plugin_config("netbox_dns", "feature_ipam_coupling"):
-                for ip in IPAddress.objects.filter(
-                    custom_field_data__ipaddress_dns_zone_id=self.pk
-                ):
-                    ip.dns_name = ""
-                    ip.custom_field_data["ipaddress_dns_record_name"] = None
-                    ip.custom_field_data["ipaddress_dns_zone_id"] = None
-                    ip.save(update_fields=["dns_name", "custom_field_data"])
+            ipam_ip_addresses = list(
+                IPAddress.objects.filter(
+                    netbox_dns_records__in=self.record_set.filter(
+                        ipam_ip_address__isnull=False
+                    )
+                ).values_list("pk", flat=True)
+            )
 
             super().delete(*args, **kwargs)
 
@@ -849,6 +844,10 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             address_zone.save_soa_serial()
             address_zone.update_soa_record()
 
+        ip_addresses = IPAddress.objects.filter(pk__in=ipam_ip_addresses)
+        for ip_address in ip_addresses:
+            update_dns_records(ip_address)
+
         rfc2317_child_zones = Zone.objects.filter(pk__in=rfc2317_child_zones)
         if rfc2317_child_zones:
             for child_zone in rfc2317_child_zones:

netbox_dns/models/zone_template.py

@@ -82,7 +82,7 @@ class ZoneTemplate(NetBoxModel):
         null=True,
     )
 
-    clone_fields = (
+    clone_fields = [
         "description",
         "nameservers",
         "record_templates",
@@ -92,22 +92,19 @@ class ZoneTemplate(NetBoxModel):
         "admin_c",
         "tech_c",
         "billing_c",
-    )
+    ]
 
-    template_fields = (
+    template_fields = [
         "tenant",
         "registrar",
         "registrant",
         "admin_c",
         "tech_c",
         "billing_c",
-    )
+    ]
 
     class Meta:
-        verbose_name = "Zone Template"
-        verbose_name_plural = "Zone Templates"
-
-        ordering = ("name",)
+        ordering = ["name"]
 
     def __str__(self):
         return str(self.name)