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

netbox_dns/graphql/schema.py

@@ -8,7 +8,7 @@ from netbox_dns.models import (
     View,
     Zone,
     Record,
-    Contact,
+    RegistrationContact,
     Registrar,
     ZoneTemplate,
     RecordTemplate,
@@ -18,86 +18,66 @@ from .types import (
     NetBoxDNSViewType,
     NetBoxDNSZoneType,
     NetBoxDNSRecordType,
-    NetBoxDNSContactType,
+    NetBoxDNSRegistrationContactType,
     NetBoxDNSRegistrarType,
     NetBoxDNSZoneTemplateType,
     NetBoxDNSRecordTemplateType,
 )
 
 
-@strawberry.type
+@strawberry.type(name="Query")
 class NetBoxDNSNameServerQuery:
-    @strawberry.field
-    def netbox_dns_nameserver(self, id: int) -> NetBoxDNSNameServerType:
-        return NameServer.objects.get(pk=id)
-
+    netbox_dns_nameserver: NetBoxDNSNameServerType = strawberry_django.field()
     netbox_dns_nameserver_list: List[NetBoxDNSNameServerType] = (
         strawberry_django.field()
     )
 
 
-@strawberry.type
+@strawberry.type(name="Query")
 class NetBoxDNSViewQuery:
-    @strawberry.field
-    def netbox_dns_view(self, id: int) -> NetBoxDNSViewType:
-        return View.objects.get(pk=id)
-
+    netbox_dns_view: NetBoxDNSViewType = strawberry_django.field()
     netbox_dns_view_list: List[NetBoxDNSViewType] = strawberry_django.field()
 
 
-@strawberry.type
+@strawberry.type(name="Query")
 class NetBoxDNSZoneQuery:
-    @strawberry.field
-    def netbox_dns_zone(self, id: int) -> NetBoxDNSZoneType:
-        return Zone.objects.get(pk=id)
-
+    netbox_dns_zone: NetBoxDNSZoneType = strawberry_django.field()
     netbox_dns_zone_list: List[NetBoxDNSZoneType] = strawberry_django.field()
 
 
-@strawberry.type
+@strawberry.type(name="Query")
 class NetBoxDNSRecordQuery:
-    @strawberry.field
-    def netbox_dns_record(self, id: int) -> NetBoxDNSRecordType:
-        return Record.objects.get(pk=id)
-
+    netbox_dns_record: NetBoxDNSRecordType = strawberry_django.field()
     netbox_dns_record_list: List[NetBoxDNSRecordType] = strawberry_django.field()
 
 
-@strawberry.type
-class NetBoxDNSContactQuery:
-    @strawberry.field
-    def netbox_dns_contact(self, id: int) -> NetBoxDNSContactType:
-        return Contact.objects.get(pk=id)
-
-    netbox_dns_contact_list: List[NetBoxDNSContactType] = strawberry_django.field()
+@strawberry.type(name="Query")
+class NetBoxDNSRegistrationContactQuery:
+    netbox_dns_registration_contact: NetBoxDNSRegistrationContactType = (
+        strawberry_django.field()
+    )
+    netbox_dns_registration_contact_list: List[NetBoxDNSRegistrationContactType] = (
+        strawberry_django.field()
+    )
 
 
-@strawberry.type
+@strawberry.type(name="Query")
 class NetBoxDNSRegistrarQuery:
-    @strawberry.field
-    def netbox_dns_registrar(self, id: int) -> NetBoxDNSRegistrarType:
-        return Registrar.objects.get(pk=id)
-
+    netbox_dns_registrar: NetBoxDNSRegistrarType = strawberry_django.field()
     netbox_dns_registrar_list: List[NetBoxDNSRegistrarType] = strawberry_django.field()
 
 
-@strawberry.type
+@strawberry.type(name="Query")
 class NetBoxDNSZoneTemplateQuery:
-    @strawberry.field
-    def netbox_dns_zone_template(self, id: int) -> NetBoxDNSZoneTemplateType:
-        return ZoneTemplate.objects.get(pk=id)
-
+    netbox_dns_zone_template: NetBoxDNSZoneTemplateType = strawberry_django.field()
     netbox_dns_zone_template_list: List[NetBoxDNSZoneTemplateType] = (
         strawberry_django.field()
     )
 
 
-@strawberry.type
+@strawberry.type(name="Query")
 class NetBoxDNSRecordTemplateQuery:
-    @strawberry.field
-    def netbox_dns_record_template(self, id: int) -> NetBoxDNSRecordTemplateType:
-        return RecordTemplate.objects.get(pk=id)
-
+    netbox_dns_record_template: NetBoxDNSRecordTemplateType = strawberry_django.field()
     netbox_dns_record_template_list: List[NetBoxDNSRecordTemplateType] = (
         strawberry_django.field()
     )

netbox_dns/graphql/types.py

@@ -4,6 +4,8 @@ import strawberry
 import strawberry_django
 
 from netbox.graphql.types import NetBoxObjectType
+from tenancy.graphql.types import TenantType
+from ipam.graphql.types import IPAddressType, PrefixType
 from netbox.graphql.scalars import BigInt
 
 from netbox_dns.models import (
@@ -11,7 +13,7 @@ from netbox_dns.models import (
     View,
     Zone,
     Record,
-    Contact,
+    RegistrationContact,
     Registrar,
     ZoneTemplate,
     RecordTemplate,
@@ -21,7 +23,7 @@ from .filters import (
     NetBoxDNSViewFilter,
     NetBoxDNSZoneFilter,
     NetBoxDNSRecordFilter,
-    NetBoxDNSContactFilter,
+    NetBoxDNSRegistrationContactFilter,
     NetBoxDNSRegistrarFilter,
     NetBoxDNSZoneTemplateFilter,
     NetBoxDNSRecordTemplateFilter,
@@ -40,6 +42,7 @@ class NetBoxDNSViewType(NetBoxObjectType):
     name: str
     description: str
     tenant: Annotated["TenantType", strawberry.lazy("tenancy.graphql.types")] | None
+    prefixes: List[Annotated["PrefixType", strawberry.lazy("ipam.graphql.types")]]
 
 
 @strawberry_django.type(Zone, fields="__all__", filters=NetBoxDNSZoneFilter)
@@ -74,19 +77,31 @@ class NetBoxDNSZoneType(NetBoxObjectType):
     )
     registry_domain_id: str | None
     registrant: (
-        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        Annotated[
+            "NetBoxDNSRegistrationContactType",
+            strawberry.lazy("netbox_dns.graphql.types"),
+        ]
         | None
     )
     admin_c: (
-        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        Annotated[
+            "NetBoxDNSRegistrationContactType",
+            strawberry.lazy("netbox_dns.graphql.types"),
+        ]
         | None
     )
     tech_c: (
-        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        Annotated[
+            "NetBoxDNSRegistrationContactType",
+            strawberry.lazy("netbox_dns.graphql.types"),
+        ]
         | None
     )
     billing_c: (
-        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        Annotated[
+            "NetBoxDNSRegistrationContactType",
+            strawberry.lazy("netbox_dns.graphql.types"),
+        ]
         | None
     )
     rfc2317_prefix: str | None
@@ -123,8 +138,10 @@ class NetBoxDNSRecordType(NetBoxObjectType):
     )
 
 
-@strawberry_django.type(Contact, fields="__all__", filters=NetBoxDNSContactFilter)
-class NetBoxDNSContactType(NetBoxObjectType):
+@strawberry_django.type(
+    RegistrationContact, fields="__all__", filters=NetBoxDNSRegistrationContactFilter
+)
+class NetBoxDNSRegistrationContactType(NetBoxObjectType):
     name: str
     contact_id: str
     description: str
@@ -175,19 +192,31 @@ class NetBoxDNSZoneTemplateType(NetBoxObjectType):
         | None
     )
     registrant: (
-        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        Annotated[
+            "NetBoxDNSRegistrationContactType",
+            strawberry.lazy("netbox_dns.graphql.types"),
+        ]
         | None
     )
     admin_c: (
-        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        Annotated[
+            "NetBoxDNSRegistrationContactType",
+            strawberry.lazy("netbox_dns.graphql.types"),
+        ]
         | None
     )
     tech_c: (
-        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        Annotated[
+            "NetBoxDNSRegistrationContactType",
+            strawberry.lazy("netbox_dns.graphql.types"),
+        ]
         | None
     )
     billing_c: (
-        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        Annotated[
+            "NetBoxDNSRegistrationContactType",
+            strawberry.lazy("netbox_dns.graphql.types"),
+        ]
         | None
     )
 

netbox_dns/management/commands/rebuild_dnssync.py

@@ -0,0 +1,18 @@
+from django.core.management.base import BaseCommand
+
+from ipam.models import IPAddress
+
+from netbox_dns.utilities import update_dns_records
+
+
+class Command(BaseCommand):
+    help = "Rebuild DNSsync relationships between IP addresses and records"
+
+    def handle(self, *model_names, **options):
+        ip_addresses = IPAddress.objects.all()
+        for ip_address in ip_addresses:
+            if options.get("verbosity") >= 2:
+                self.stdout.write(
+                    f"Updating DNS records for IP Address {ip_address}, VRF {ip_address.vrf}"
+                )
+            update_dns_records(ip_address)

netbox_dns/management/commands/setup_dnssync.py

@@ -0,0 +1,140 @@
+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 DNSsync"
+
+    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("Trying to remove IPAM DNSsync 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"):
+                        self.stdout.write(f"Removed custom field '{cf}'")
+                except CustomField.DoesNotExist:
+                    pass
+            return
+
+        # +
+        # Remove pre-existing IPAM Coupling custom fields
+        # -
+        if options.get("verbosity") >= 2:
+            self.stdout.write("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"):
+                    self.stdout.write(f"Removed custom field '{cf}'")
+            except CustomField.DoesNotExist:
+                pass
+
+        if options.get("verbosity") >= 2:
+            self.stdout.write("Creating IPAM DNSsync custom fields")
+
+        if not CustomField.objects.filter(
+            name="ipaddress_dns_disabled",
+            type=CustomFieldTypeChoices.TYPE_BOOLEAN,
+            object_types=ipaddress_object_type,
+        ).exists():
+            cf_dnssync_disabled = CustomField.objects.create(
+                name="ipaddress_dns_disabled",
+                label="Disable DNSsync",
+                description="Disable DNS address and pointer record generation for this address",
+                type=CustomFieldTypeChoices.TYPE_BOOLEAN,
+                required=False,
+                default=False,
+                group_name="DNSsync",
+                is_cloneable=True,
+                weight=100,
+            )
+            cf_dnssync_disabled.object_types.set([ipaddress_object_type])
+            if options.get("verbosity"):
+                self.stdout.write("Created custom field 'ipaddress_dns_disabled'")
+
+        try:
+            cf_ttl = CustomField.objects.get(
+                name="ipaddress_dns_record_ttl",
+                type=CustomFieldTypeChoices.TYPE_INTEGER,
+                object_types=ipaddress_object_type,
+            )
+            if cf_ttl.group_name != "DNSsync":
+                cf_ttl.group_name = "DNSsync"
+                cf_ttl.description = ("TTL for DNS records created for this address",)
+                cf_ttl.save()
+                if options.get("verbosity"):
+                    self.stdout.write("Updated custom field 'ipaddress_dns_record_ttl'")
+        except CustomField.DoesNotExist:
+            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="DNSsync",
+                is_cloneable=True,
+                weight=200,
+            )
+            cf_ttl.object_types.set([ipaddress_object_type])
+            if options.get("verbosity"):
+                self.stdout.write("Created custom field 'ipaddress_dns_record_ttl'")
+
+        try:
+            cf_disable_ptr = CustomField.objects.get(
+                name="ipaddress_dns_record_disable_ptr",
+                type=CustomFieldTypeChoices.TYPE_BOOLEAN,
+                object_types=ipaddress_object_type,
+            )
+            if cf_disable_ptr.group_name != "DNSsync":
+                cf_disable_ptr.group_name = "DNSsync"
+                cf_disable_ptr.description = (
+                    "Disable DNS PTR record generation for this address",
+                )
+                cf_disable_ptr.save()
+                if options.get("verbosity"):
+                    self.stdout.write(
+                        "Updated custom field 'ipaddress_dns_record_disable_ptr'"
+                    )
+        except CustomField.DoesNotExist:
+            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="DNSsync",
+                is_cloneable=True,
+                weight=300,
+            )
+            cf_disable_ptr.object_types.set([ipaddress_object_type])
+            if options.get("verbosity"):
+                self.stdout.write(
+                    "Created custom field 'ipaddress_dns_record_disable_ptr'"
+                )

netbox_dns/migrations/0007_alter_ordering_options.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.0.7 on 2024-08-27 09:29
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("netbox_dns", "0006_templating"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="record",
+            options={"ordering": ("fqdn", "zone", "name", "type", "value", "status")},
+        ),
+        migrations.AlterModelOptions(
+            name="recordtemplate",
+            options={"ordering": ("name",)},
+        ),
+        migrations.AlterModelOptions(
+            name="zonetemplate",
+            options={"ordering": ("name",)},
+        ),
+    ]

netbox_dns/migrations/0008_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", "0007_alter_ordering_options"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="view",
+            name="prefixes",
+            field=models.ManyToManyField(
+                blank=True, related_name="netbox_dns_views", to="ipam.prefix"
+            ),
+        ),
+    ]

netbox_dns/migrations/0009_rename_contact_registrationcontact.py

@@ -0,0 +1,27 @@
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("netbox_dns", "0008_view_prefixes"),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name="Contact",
+            new_name="RegistrationContact",
+        ),
+        migrations.RunSQL(
+            "ALTER TABLE netbox_dns_contact_id_seq RENAME TO netbox_dns_registrationcontact_id_seq"
+        ),
+        migrations.RunSQL(
+            "ALTER INDEX netbox_dns_contact_pkey RENAME TO netbox_dns_registrationcontact_pkey"
+        ),
+        migrations.RunSQL(
+            "ALTER INDEX netbox_dns_contact_contact_id_50e9d89d_like RENAME TO netbox_dns_registrationcontact_contact_id_6ff98464_like"
+        ),
+        migrations.RunSQL(
+            "ALTER INDEX netbox_dns_contact_contact_id_key RENAME TO netbox_dns_contact_registrationcontact_id_key"
+        ),
+    ]

netbox_dns/models/__init__.py

@@ -2,7 +2,7 @@ from .zone import *
 from .nameserver import *
 from .record import *
 from .view import *
-from .contact import *
+from .registration_contact import *
 from .registrar import *
 from .zone_template import *
 from .record_template import *
@@ -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/nameserver.py

@@ -7,6 +7,7 @@ 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,
@@ -26,7 +27,7 @@ __all__ = (
 )
 
 
-class NameServer(ObjectModificationMixin, NetBoxModel):
+class NameServer(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     name = models.CharField(
         unique=True,
         max_length=255,
@@ -43,13 +44,17 @@ class NameServer(ObjectModificationMixin, 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()