netbox-plugin-dns 0.21.4__py3-none-any.whl → 1.4.7__py3-none-any.whl

netbox_dns/api/serializers.py

@@ -1,296 +1,14 @@
-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",
-    )
-    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",
-            "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",
-            "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",
-            "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_.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_.dnssec_key_template import *
+from .serializers_.dnssec_policy import *
+
+from .serializers_.prefix import *
+
+from .nested_serializers import *

netbox_dns/api/serializers_/dnssec_key_template.py

@@ -0,0 +1,69 @@
+from django.utils.translation import gettext as _
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_dns.models import DNSSECKeyTemplate
+
+from ..nested_serializers import NestedDNSSECPolicySerializer
+from ..field_serializers import TimePeriodField
+
+
+__all__ = ("DNSSECKeyTemplateSerializer",)
+
+
+class DNSSECKeyTemplateSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = DNSSECKeyTemplate
+
+        fields = (
+            "id",
+            "url",
+            "display",
+            "display_url",
+            "name",
+            "description",
+            "tags",
+            "policies",
+            "type",
+            "lifetime",
+            "algorithm",
+            "key_size",
+            "created",
+            "last_updated",
+            "custom_fields",
+            "tenant",
+        )
+
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "type",
+            "lifetime",
+            "algorithm",
+            "key_size",
+            "description",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:dnsseckeytemplate-detail"
+    )
+    lifetime = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    policies = NestedDNSSECPolicySerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        default=None,
+        help_text=_("Policies using this Key Template"),
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )

netbox_dns/api/serializers_/dnssec_policy.py

@@ -0,0 +1,165 @@
+from django.utils.translation import gettext as _
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers_.tenants import TenantSerializer
+
+from netbox_dns.models import DNSSECPolicy
+
+from .dnssec_key_template import DNSSECKeyTemplateSerializer
+from ..nested_serializers import NestedZoneSerializer, NestedZoneTemplateSerializer
+from ..field_serializers import TimePeriodField
+
+
+__all__ = ("DNSSECPolicySerializer",)
+
+
+class DNSSECPolicySerializer(NetBoxModelSerializer):
+    class Meta:
+        model = DNSSECPolicy
+
+        fields = (
+            "id",
+            "url",
+            "display",
+            "display_url",
+            "name",
+            "description",
+            "tags",
+            "status",
+            "inline_signing",
+            "key_templates",
+            "zones",
+            "zone_templates",
+            "dnskey_ttl",
+            "purge_keys",
+            "publish_safety",
+            "retire_safety",
+            "signatures_jitter",
+            "signatures_refresh",
+            "signatures_validity",
+            "signatures_validity_dnskey",
+            "max_zone_ttl",
+            "zone_propagation_delay",
+            "create_cdnskey",
+            "cds_digest_types",
+            "parent_ds_ttl",
+            "parent_propagation_delay",
+            "use_nsec3",
+            "nsec3_iterations",
+            "nsec3_opt_out",
+            "nsec3_salt_size",
+            "created",
+            "last_updated",
+            "custom_fields",
+            "tenant",
+        )
+
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+            "status",
+            "inline_signing",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:dnssecpolicy-detail"
+    )
+    key_templates = DNSSECKeyTemplateSerializer(
+        nested=True,
+        many=True,
+        read_only=False,
+        required=False,
+        default=None,
+        help_text=_("Key templates assigned to the policy"),
+    )
+    dnskey_ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    purge_keys = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    publish_safety = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    retire_safety = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    signatures_jitter = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    signatures_refresh = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    signatures_validity = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    signatures_validity_dnskey = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    max_zone_ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    zone_propagation_delay = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    parent_ds_ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    parent_propagation_delay = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    zones = NestedZoneSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        default=None,
+        help_text=_("Zones this policy is assigned to"),
+    )
+    zone_templates = NestedZoneTemplateSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        default=None,
+        help_text=_("Zone templates this policy is assigned to"),
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )
+
+    def create(self, validated_data):
+        dnssec_key_templates = validated_data.pop("key_templates", None)
+
+        dnssec_policy = super().create(validated_data)
+
+        if dnssec_key_templates is not None:
+            dnssec_policy.key_templates.set(dnssec_key_templates)
+
+        return dnssec_policy
+
+    def update(self, instance, validated_data):
+        dnssec_key_templates = validated_data.pop("key_templates", None)
+
+        dnssec_policy = super().update(instance, validated_data)
+
+        if dnssec_key_templates is not None:
+            dnssec_policy.key_templates.set(dnssec_key_templates)
+
+        return dnssec_policy

netbox_dns/api/serializers_/nameserver.py

@@ -0,0 +1,56 @@
+from django.utils.translation import gettext as _
+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 ..nested_serializers import NestedZoneSerializer
+
+
+__all__ = ("NameServerSerializer",)
+
+
+class NameServerSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = NameServer
+
+        fields = (
+            "id",
+            "url",
+            "display",
+            "display_url",
+            "name",
+            "description",
+            "tags",
+            "zones",
+            "created",
+            "last_updated",
+            "custom_fields",
+            "tenant",
+        )
+
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "description",
+        )
+
+    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(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )

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