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

netbox_dns/api/serializers_/record.py

@@ -0,0 +1,105 @@
+from django.utils.translation import gettext as _
+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 ..nested_serializers import NestedZoneSerializer, NestedRecordSerializer
+from ..field_serializers import TimePeriodField
+
+
+__all__ = ("RecordSerializer",)
+
+
+class RecordSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = Record
+        fields = (
+            "id",
+            "url",
+            "zone",
+            "display",
+            "display_url",
+            "type",
+            "name",
+            "fqdn",
+            "value",
+            "status",
+            "ttl",
+            "description",
+            "tags",
+            "created",
+            "last_updated",
+            "managed",
+            "disable_ptr",
+            "ptr_record",
+            "address_records",
+            "active",
+            "custom_fields",
+            "tenant",
+            "ipam_ip_address",
+            "absolute_value",
+        )
+
+        brief_fields = (
+            "id",
+            "url",
+            "zone",
+            "display",
+            "type",
+            "name",
+            "fqdn",
+            "value",
+            "status",
+            "ttl",
+            "description",
+            "managed",
+            "active",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:record-detail"
+    )
+    ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    ptr_record = NestedRecordSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text=_("PTR record related to an address"),
+    )
+    address_records = NestedRecordSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        allow_null=True,
+        help_text=_("Address records related to 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,
+    )

netbox_dns/api/serializers_/record_template.py

@@ -0,0 +1,71 @@
+from django.utils.translation import gettext as _
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers import TenantSerializer
+
+from netbox_dns.models import RecordTemplate
+
+from ..nested_serializers import NestedZoneTemplateSerializer
+from ..field_serializers import TimePeriodField
+
+
+__all__ = ("RecordTemplateSerializer",)
+
+
+class RecordTemplateSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = RecordTemplate
+
+        fields = (
+            "id",
+            "url",
+            "display",
+            "display_url",
+            "type",
+            "name",
+            "record_name",
+            "value",
+            "status",
+            "ttl",
+            "description",
+            "tags",
+            "created",
+            "last_updated",
+            "disable_ptr",
+            "custom_fields",
+            "tenant",
+            "zone_templates",
+        )
+
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "type",
+            "name",
+            "record_name",
+            "value",
+            "status",
+            "ttl",
+            "description",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:recordtemplate-detail"
+    )
+    ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )
+    zone_templates = NestedZoneTemplateSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        help_text=_("Zone templates using the record template"),
+    )

netbox_dns/api/serializers_/registrar.py

@@ -0,0 +1,45 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+
+from netbox_dns.models import Registrar
+
+
+__all__ = ("RegistrarSerializer",)
+
+
+class RegistrarSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = Registrar
+
+        fields = (
+            "id",
+            "url",
+            "display",
+            "display_url",
+            "name",
+            "description",
+            "tags",
+            "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",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:registrar-detail"
+    )

netbox_dns/api/serializers_/registration_contact.py

@@ -0,0 +1,50 @@
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+
+from netbox_dns.models import RegistrationContact
+
+
+__all__ = ("RegistrationContactSerializer",)
+
+
+class RegistrationContactSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = RegistrationContact
+
+        fields = (
+            "id",
+            "url",
+            "display",
+            "display_url",
+            "name",
+            "description",
+            "tags",
+            "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",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:registrationcontact-detail"
+    )

netbox_dns/api/serializers_/view.py

@@ -0,0 +1,81 @@
+from django.utils.translation import gettext as _
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers import TenantSerializer
+from ipam.api.serializers import PrefixSerializer
+
+from netbox_dns.models import View
+
+
+__all__ = ("ViewSerializer",)
+
+
+class ViewSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = View
+
+        fields = (
+            "id",
+            "url",
+            "display",
+            "display_url",
+            "name",
+            "default_view",
+            "description",
+            "tags",
+            "created",
+            "last_updated",
+            "custom_fields",
+            "tenant",
+            "prefixes",
+            "ip_address_filter",
+        )
+
+        brief_fields = (
+            "id",
+            "url",
+            "display",
+            "name",
+            "default_view",
+            "description",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:view-detail"
+    )
+    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)
+
+        return view

netbox_dns/api/serializers_/zone.py

@@ -0,0 +1,247 @@
+from django.utils.translation import gettext as _
+from rest_framework import serializers
+
+from netbox.api.serializers import NetBoxModelSerializer
+from tenancy.api.serializers import TenantSerializer
+
+from .view import ViewSerializer
+from .nameserver import NameServerSerializer
+from .registrar import RegistrarSerializer
+from .registration_contact import RegistrationContactSerializer
+from .zone_template import ZoneTemplateSerializer
+from .dnssec_policy import DNSSECPolicySerializer
+
+from ..nested_serializers import NestedZoneSerializer
+from ..field_serializers import TimePeriodField
+
+from netbox_dns.models import Zone
+
+
+__all__ = ("ZoneSerializer",)
+
+
+class ZoneSerializer(NetBoxModelSerializer):
+    class Meta:
+        model = Zone
+
+        fields = (
+            "id",
+            "url",
+            "name",
+            "view",
+            "display",
+            "display_url",
+            "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",
+            "dnssec_policy",
+            "inline_signing",
+            "parental_agents",
+            "registrar",
+            "registry_domain_id",
+            "expiration_date",
+            "domain_status",
+            "registrant",
+            "tech_c",
+            "admin_c",
+            "billing_c",
+            "comments",
+            "active",
+            "custom_fields",
+            "tenant",
+            "template",
+        )
+
+        brief_fields = (
+            "id",
+            "url",
+            "name",
+            "view",
+            "display",
+            "status",
+            "description",
+            "rfc2317_prefix",
+            "active",
+        )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:zone-detail"
+    )
+    view = ViewSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        default=None,
+        help_text=_("View the zone belongs to"),
+    )
+    nameservers = NameServerSerializer(
+        nested=True,
+        many=True,
+        read_only=False,
+        required=False,
+        help_text=_("Nameservers for the zone"),
+    )
+    default_ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    soa_ttl = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    soa_mname = NameServerSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text=_("Primary nameserver for the zone"),
+    )
+    soa_rname = serializers.CharField(
+        max_length=255,
+        read_only=False,
+        required=False,
+        help_text=_("Contact email for the zone"),
+    )
+    soa_refresh = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    soa_retry = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    soa_expire = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    soa_minimum = TimePeriodField(
+        required=False,
+        allow_null=True,
+    )
+    rfc2317_parent_zone = NestedZoneSerializer(
+        many=False,
+        read_only=True,
+        required=False,
+        help_text=_("RFC2317 parent zone of the zone"),
+    )
+    rfc2317_child_zones = NestedZoneSerializer(
+        many=True,
+        read_only=True,
+        required=False,
+        help_text=_("RFC2317 child zones of the zone"),
+    )
+    dnssec_policy = DNSSECPolicySerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text=_("DNSSEC policy to apply to the zone"),
+    )
+    registrar = RegistrarSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text=_("Registrar the domain is registered with"),
+    )
+    registrant = RegistrationContactSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text=_("Registrant of the domain"),
+    )
+    admin_c = RegistrationContactSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text=_("Administrative contact for the domain"),
+    )
+    tech_c = RegistrationContactSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text=_("Technical contact for the domain"),
+    )
+    billing_c = RegistrationContactSerializer(
+        nested=True,
+        many=False,
+        read_only=False,
+        required=False,
+        help_text=_("Billing contact for the domain"),
+    )
+    template = ZoneTemplateSerializer(
+        nested=True,
+        write_only=True,
+        required=False,
+        default=None,
+        help_text=_("Template to apply to the zone"),
+    )
+    inline_signing = serializers.SerializerMethodField()
+    active = serializers.BooleanField(
+        required=False,
+        read_only=True,
+        allow_null=True,
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )
+
+    def validate(self, data):
+        if isinstance(data, dict) and (template := data.get("template")) is not None:
+            template.apply_to_zone_data(data)
+
+        return super().validate(data)
+
+    def get_inline_signing(self, instance):
+        return instance.inline_signing
+
+    def create(self, validated_data):
+        template = validated_data.pop("template", None)
+        nameservers = validated_data.pop("nameservers", None)
+
+        zone = super().create(validated_data)
+
+        if nameservers is not None:
+            zone.nameservers.set(nameservers)
+
+        if template is not None:
+            template.apply_to_zone_relations(zone)
+
+        return zone
+
+    def update(self, instance, validated_data):
+        template = validated_data.pop("template", None)
+        nameservers = validated_data.pop("nameservers", None)
+
+        zone = super().update(instance, validated_data)
+
+        if nameservers is not None:
+            zone.nameservers.set(nameservers)
+
+        if template is not None:
+            template.apply_to_zone_relations(zone)
+
+        return zone