netbox-plugin-dns 0.22.9__py3-none-any.whl → 1.0.0__py3-none-any.whl

netbox_dns/__init__.py

@@ -1,31 +1,20 @@
-import sys
+from netbox.plugins import PluginConfig
 
-from extras.plugins import PluginConfig
-from django.db.utils import OperationalError
-
-try:
-    # NetBox 3.5.0 - 3.5.7, 3.5.9+
-    from extras.plugins import get_plugin_config
-except ImportError:
-    # NetBox 3.5.8
-    from extras.plugins.utils import get_plugin_config
-
-__version__ = "0.22.9"
+__version__ = "1.0.0"
 
 
 class DNSConfig(PluginConfig):
     name = "netbox_dns"
     verbose_name = "NetBox DNS"
     description = "NetBox plugin for DNS data"
-    min_version = "3.5.0"
-    max_version = "3.99.0"
+    min_version = "4.0.0"
     version = __version__
     author = "Peter Eckel"
     author_email = "pete@netbox-dns.org"
     required_settings = []
     default_settings = {
         "zone_default_ttl": 86400,
-        "zone_soa_serial_auto": True,
+        "zone_soa_ttl": 86400,
         "zone_soa_serial": 1,
         "zone_soa_refresh": 43200,
         "zone_soa_retry": 7200,

netbox_dns/api/nested_serializers.py

@@ -2,25 +2,10 @@ from rest_framework import serializers
 
 from netbox.api.serializers import WritableNestedSerializer
 
-from netbox_dns.models import View, Zone, NameServer, Record, Registrar, Contact
+from netbox_dns.models import Zone, Record
+from netbox_dns.api.serializers_.view import ViewSerializer
 
 
-#
-# Views
-#
-class NestedViewSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:view-detail"
-    )
-
-    class Meta:
-        model = View
-        fields = ["id", "url", "display", "name"]
-
-
-#
-# Zones
-#
 class NestedZoneSerializer(WritableNestedSerializer):
     def to_representation(self, instance):
         # +
@@ -39,7 +24,8 @@ class NestedZoneSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:zone-detail"
     )
-    view = NestedViewSerializer(
+    view = ViewSerializer(
+        nested=True,
         many=False,
         required=False,
         read_only=True,
@@ -65,22 +51,6 @@ class NestedZoneSerializer(WritableNestedSerializer):
         ]
 
 
-#
-# Nameservers
-#
-class NestedNameServerSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:nameserver-detail"
-    )
-
-    class Meta:
-        model = NameServer
-        fields = ["id", "url", "display", "name"]
-
-
-#
-# Records
-#
 class NestedRecordSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:record-detail"
@@ -110,29 +80,3 @@ class NestedRecordSerializer(WritableNestedSerializer):
             "zone",
             "active",
         ]
-
-
-#
-# Registrars
-#
-class NestedRegistrarSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:registrar-detail"
-    )
-
-    class Meta:
-        model = Registrar
-        fields = ["display", "id", "url", "name", "iana_id"]
-
-
-#
-# Contacts
-#
-class NestedContactSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:contact-detail"
-    )
-
-    class Meta:
-        model = Contact
-        fields = ["display", "id", "url", "name", "contact_id"]

netbox_dns/api/serializers.py

@@ -1,314 +1,8 @@
-from rest_framework import serializers
-
-from netbox.api.serializers import NetBoxModelSerializer
-from ipam.api.nested_serializers import NestedIPAddressSerializer
-from tenancy.api.nested_serializers import NestedTenantSerializer
-
-from netbox_dns.api.nested_serializers import (
-    NestedViewSerializer,
-    NestedZoneSerializer,
-    NestedNameServerSerializer,
-    NestedRecordSerializer,
-    NestedRegistrarSerializer,
-    NestedContactSerializer,
-)
-from netbox_dns.models import View, Zone, NameServer, Record, Registrar, Contact
-
-
-class ViewSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:view-detail"
-    )
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-
-    class Meta:
-        model = View
-        fields = (
-            "id",
-            "url",
-            "display",
-            "name",
-            "tags",
-            "description",
-            "created",
-            "last_updated",
-            "custom_fields",
-            "tenant",
-        )
-
-
-class ZoneSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:zone-detail"
-    )
-    view = NestedViewSerializer(
-        many=False,
-        read_only=False,
-        required=False,
-        default=None,
-        help_text="View the zone belongs to",
-    )
-    nameservers = NestedNameServerSerializer(
-        many=True, read_only=False, required=False, help_text="Nameservers for the zone"
-    )
-    soa_mname = NestedNameServerSerializer(
-        many=False,
-        read_only=False,
-        required=False,
-        help_text="Primary nameserver for the zone",
-    )
-    rfc2317_parent_zone = NestedZoneSerializer(
-        many=False,
-        read_only=True,
-        required=False,
-        help_text="RFC2317 arent zone for the zone",
-    )
-    rfc2317_child_zones = NestedZoneSerializer(
-        many=True,
-        read_only=True,
-        required=False,
-        help_text="RFC2317 child zones of the zone",
-    )
-    registrar = NestedRegistrarSerializer(
-        many=False,
-        read_only=False,
-        required=False,
-        help_text="The registrar the domain is registered with",
-    )
-    registrant = NestedContactSerializer(
-        many=False,
-        read_only=False,
-        required=False,
-        help_text="The owner of the domain",
-    )
-    admin_c = NestedContactSerializer(
-        many=False,
-        read_only=False,
-        required=False,
-        help_text="The administrative contact for the domain",
-    )
-    tech_c = NestedContactSerializer(
-        many=False,
-        read_only=False,
-        required=False,
-        help_text="The technical contact for the domain",
-    )
-    billing_c = NestedContactSerializer(
-        many=False,
-        read_only=False,
-        required=False,
-        help_text="The billing contact for the domain",
-    )
-    active = serializers.BooleanField(
-        required=False,
-        read_only=True,
-        allow_null=True,
-    )
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-
-    def create(self, validated_data):
-        nameservers = validated_data.pop("nameservers", None)
-
-        zone = super().create(validated_data)
-
-        if nameservers is not None:
-            zone.nameservers.set(nameservers)
-
-        return zone
-
-    def update(self, instance, validated_data):
-        nameservers = validated_data.pop("nameservers", None)
-
-        zone = super().update(instance, validated_data)
-
-        if nameservers is not None:
-            zone.nameservers.set(nameservers)
-
-        return zone
-
-    class Meta:
-        model = Zone
-        fields = (
-            "id",
-            "url",
-            "name",
-            "view",
-            "display",
-            "nameservers",
-            "status",
-            "description",
-            "tags",
-            "created",
-            "last_updated",
-            "default_ttl",
-            "soa_ttl",
-            "soa_mname",
-            "soa_rname",
-            "soa_serial",
-            "soa_serial_auto",
-            "soa_refresh",
-            "soa_retry",
-            "soa_expire",
-            "soa_minimum",
-            "rfc2317_prefix",
-            "rfc2317_parent_managed",
-            "rfc2317_parent_zone",
-            "rfc2317_child_zones",
-            "registrar",
-            "registry_domain_id",
-            "registrant",
-            "tech_c",
-            "admin_c",
-            "billing_c",
-            "active",
-            "custom_fields",
-            "tenant",
-        )
-
-
-class NameServerSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:nameserver-detail"
-    )
-    zones = NestedZoneSerializer(
-        many=True,
-        read_only=True,
-        required=False,
-        default=None,
-        help_text="Zones served by the authoritative nameserver",
-    )
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-
-    class Meta:
-        model = NameServer
-        fields = (
-            "id",
-            "url",
-            "display",
-            "name",
-            "description",
-            "tags",
-            "zones",
-            "created",
-            "last_updated",
-            "custom_fields",
-            "tenant",
-        )
-
-
-class RecordSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:record-detail"
-    )
-    ptr_record = NestedRecordSerializer(
-        many=False,
-        read_only=True,
-        required=False,
-        allow_null=True,
-        help_text="PTR record generated from an address",
-    )
-    address_record = NestedRecordSerializer(
-        many=False,
-        read_only=True,
-        required=False,
-        allow_null=True,
-        help_text="Address record defining the PTR",
-    )
-    zone = NestedZoneSerializer(
-        many=False,
-        required=False,
-        help_text="Zone the record belongs to",
-    )
-    active = serializers.BooleanField(
-        required=False,
-        read_only=True,
-    )
-    ipam_ip_address = NestedIPAddressSerializer(
-        many=False,
-        read_only=True,
-        required=False,
-        allow_null=True,
-        help_text="IPAddress linked to the record",
-    )
-    tenant = NestedTenantSerializer(required=False, allow_null=True)
-
-    class Meta:
-        model = Record
-        fields = (
-            "id",
-            "url",
-            "zone",
-            "display",
-            "type",
-            "name",
-            "fqdn",
-            "value",
-            "status",
-            "ttl",
-            "description",
-            "tags",
-            "created",
-            "last_updated",
-            "managed",
-            "disable_ptr",
-            "ptr_record",
-            "address_record",
-            "active",
-            "custom_fields",
-            "tenant",
-            "ipam_ip_address",
-        )
-
-
-class RegistrarSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:registrar-detail"
-    )
-
-    class Meta:
-        model = Registrar
-        fields = (
-            "id",
-            "url",
-            "display",
-            "name",
-            "iana_id",
-            "address",
-            "referral_url",
-            "whois_server",
-            "abuse_email",
-            "abuse_phone",
-            "created",
-            "last_updated",
-            "custom_fields",
-        )
-
-
-class ContactSerializer(NetBoxModelSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:contact-detail"
-    )
-
-    class Meta:
-        model = Contact
-        fields = (
-            "id",
-            "url",
-            "display",
-            "name",
-            "contact_id",
-            "organization",
-            "street",
-            "city",
-            "state_province",
-            "postal_code",
-            "country",
-            "phone",
-            "phone_ext",
-            "fax",
-            "fax_ext",
-            "email",
-            "created",
-            "last_updated",
-            "custom_fields",
-        )
+from .serializers_.contact import *
+from .serializers_.nameserver import *
+from .serializers_.record import *
+from .serializers_.registrar import *
+from .serializers_.view import *
+from .serializers_.zone import *
+
+from .nested_serializers import *

netbox_dns/api/serializers_/contact.py

@@ -0,0 +1,37 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+
+from netbox_dns.models import Contact
+
+
+class ContactSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:contact-detail"
+    )
+
+    class Meta:
+        model = Contact
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "contact_id",
+            "organization",
+            "street",
+            "city",
+            "state_province",
+            "postal_code",
+            "country",
+            "phone",
+            "phone_ext",
+            "fax",
+            "fax_ext",
+            "email",
+            "created",
+            "last_updated",
+            "custom_fields",
+        )
+        brief_fields = ("id", "url", "display", "name", "description", "contact_id")

netbox_dns/api/serializers_/nameserver.py

@@ -0,0 +1,39 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_dns.models import NameServer
+
+from netbox_dns.api.nested_serializers import NestedZoneSerializer
+
+
+class NameServerSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:nameserver-detail"
+    )
+    zones = NestedZoneSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        default=None,
+        help_text="Zones served by the authoritative nameserver",
+    )
+    tenant = TenantSerializer(required=False, allow_null=True)
+
+    class Meta:
+        model = NameServer
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "tags",
+            "zones",
+            "created",
+            "last_updated",
+            "custom_fields",
+            "tenant",
+        )
+        brief_fields = ("id", "url", "display", "name", "description")

netbox_dns/api/serializers_/record.py

@@ -0,0 +1,90 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from ipam.api.serializers import IPAddressSerializer
+from tenancy.api.serializers import TenantSerializer
+
+from netbox_dns.models import Record
+from netbox_dns.api.nested_serializers import (
+    NestedZoneSerializer,
+    NestedRecordSerializer,
+)
+
+
+class RecordSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:record-detail"
+    )
+    ptr_record = NestedRecordSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text="PTR record generated from an address",
+    )
+    address_record = NestedRecordSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text="Address record defining the PTR",
+    )
+    zone = NestedZoneSerializer(
+        many=False,
+        required=False,
+        help_text="Zone the record belongs to",
+    )
+    active = serializers.BooleanField(
+        required=False,
+        read_only=True,
+    )
+    ipam_ip_address = IPAddressSerializer(
+        nested=True,
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text="IPAddress linked to the record",
+    )
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = Record
+        fields = (
+            "id",
+            "url",
+            "zone",
+            "display",
+            "type",
+            "name",
+            "fqdn",
+            "value",
+            "status",
+            "ttl",
+            "description",
+            "tags",
+            "created",
+            "last_updated",
+            "managed",
+            "disable_ptr",
+            "ptr_record",
+            "address_record",
+            "active",
+            "custom_fields",
+            "tenant",
+            "ipam_ip_address",
+        )
+        brief_fields = (
+            "id",
+            "url",
+            "zone",
+            "display",
+            "type",
+            "name",
+            "fqdn",
+            "value",
+            "status",
+            "ttl",
+            "description",
+            "active",
+        )

netbox_dns/api/serializers_/registrar.py

@@ -0,0 +1,31 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+
+from netbox_dns.models import Registrar
+
+
+class RegistrarSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:registrar-detail"
+    )
+
+    class Meta:
+        model = Registrar
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "iana_id",
+            "address",
+            "referral_url",
+            "whois_server",
+            "abuse_email",
+            "abuse_phone",
+            "created",
+            "last_updated",
+            "custom_fields",
+        )
+        brief_fields = ("id", "url", "display", "name", "description", "iana_id")

netbox_dns/api/serializers_/view.py

@@ -0,0 +1,34 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_dns.models import View
+
+
+class ViewSerializer(NetBoxModelSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:view-detail"
+    )
+    default_view = serializers.BooleanField(
+        read_only=True,
+    )
+
+    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+
+    class Meta:
+        model = View
+        fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "default_view",
+            "tags",
+            "description",
+            "created",
+            "last_updated",
+            "custom_fields",
+            "tenant",
+        )
+        brief_fields = ("id", "url", "display", "name", "default_view", "description")