ipfabric_netbox 4.3.2b8__py3-none-any.whl → 4.3.2b10__py3-none-any.whl

ipfabric_netbox/__init__.py

@@ -6,9 +6,9 @@ class NetboxIPFabricConfig(PluginConfig):
     name = "ipfabric_netbox"
     verbose_name = "NetBox IP Fabric SoT Plugin"
     description = "Sync IP Fabric into NetBox"
-    version = "4.3.2b8"
+    version = "4.3.2b10"
     base_url = "ipfabric"
-    min_version = "4.4.0"
+    min_version = "4.4.9"
 
     def ready(self):
         super().ready()

ipfabric_netbox/api/serializers.py

@@ -8,6 +8,9 @@ from rest_framework import serializers
 
 from ipfabric_netbox.choices import IPFabricSourceStatusChoices
 from ipfabric_netbox.choices import IPFabricSyncStatusChoices
+from ipfabric_netbox.models import IPFabricEndpoint
+from ipfabric_netbox.models import IPFabricFilter
+from ipfabric_netbox.models import IPFabricFilterExpression
 from ipfabric_netbox.models import IPFabricIngestion
 from ipfabric_netbox.models import IPFabricIngestionIssue
 from ipfabric_netbox.models import IPFabricRelationshipField
@@ -21,18 +24,41 @@ from ipfabric_netbox.models import IPFabricTransformMap
 from ipfabric_netbox.models import IPFabricTransformMapGroup
 
 __all__ = (
-    "IPFabricSyncSerializer",
-    "IPFabricSnapshotSerializer",
+    "IPFabricEndpointSerializer",
+    "IPFabricFilterSerializer",
+    "IPFabricFilterExpressionSerializer",
+    "IPFabricIngestionSerializer",
+    "IPFabricIngestionIssueSerializer",
     "IPFabricRelationshipFieldSerializer",
+    "IPFabricSnapshotSerializer",
+    "IPFabricSourceSerializer",
+    "IPFabricSyncSerializer",
     "IPFabricTransformFieldSerializer",
     "IPFabricTransformMapSerializer",
     "IPFabricTransformMapGroupSerializer",
-    "IPFabricIngestionSerializer",
-    "IPFabricIngestionIssueSerializer",
-    "IPFabricSourceSerializer",
 )
 
 
+class IPFabricEndpointSerializer(NestedGroupModelSerializer):
+    class Meta:
+        model = IPFabricEndpoint
+        fields = (
+            "id",
+            "name",
+            "display",
+            "description",
+            "endpoint",
+            "created",
+            "last_updated",
+        )
+        brief_fields = (
+            "id",
+            "name",
+            "display",
+            "endpoint",
+        )
+
+
 class IPFabricTransformMapGroupSerializer(NestedGroupModelSerializer):
     transform_maps_count = RelatedObjectCountField("transform_maps")
 
@@ -41,6 +67,7 @@ class IPFabricTransformMapGroupSerializer(NestedGroupModelSerializer):
         fields = (
             "id",
             "name",
+            "display",
             "description",
             "transform_maps_count",
             "created",
@@ -49,6 +76,7 @@ class IPFabricTransformMapGroupSerializer(NestedGroupModelSerializer):
         brief_fields = (
             "id",
             "name",
+            "display",
             "description",
         )
 
@@ -57,17 +85,26 @@ class IPFabricTransformMapSerializer(NestedGroupModelSerializer):
     group = IPFabricTransformMapGroupSerializer(
         nested=True, required=False, allow_null=True
     )
+    source_endpoint = IPFabricEndpointSerializer(nested=True, required=True)
     target_model = ContentTypeField(
         queryset=ContentType.objects.filter(IPFabricSupportedSyncModels)
     )
+    parents = serializers.PrimaryKeyRelatedField(
+        queryset=IPFabricTransformMap.objects.all(),
+        many=True,
+        required=False,
+        allow_null=True,
+    )
 
     class Meta:
         model = IPFabricTransformMap
         fields = (
             "id",
             "name",
+            "display",
             "group",
-            "source_model",
+            "parents",
+            "source_endpoint",
             "target_model",
             "created",
             "last_updated",
@@ -75,8 +112,9 @@ class IPFabricTransformMapSerializer(NestedGroupModelSerializer):
         brief_fields = (
             "id",
             "name",
+            "display",
             "group",
-            "source_model",
+            "source_endpoint",
             "target_model",
         )
 
@@ -89,6 +127,7 @@ class IPFabricTransformFieldSerializer(NestedGroupModelSerializer):
         fields = (
             "id",
             "transform_map",
+            "display",
             "source_field",
             "target_field",
             "coalesce",
@@ -107,6 +146,7 @@ class IPFabricRelationshipFieldSerializer(NestedGroupModelSerializer):
         fields = (
             "id",
             "transform_map",
+            "display",
             "source_model",
             "target_field",
             "coalesce",
@@ -185,6 +225,7 @@ class IPFabricSyncSerializer(NestedGroupModelSerializer):
         fields = (
             "id",
             "name",
+            "display",
             "snapshot_data",
             "status",
             "parameters",
@@ -193,17 +234,77 @@ class IPFabricSyncSerializer(NestedGroupModelSerializer):
             "scheduled",
             "interval",
             "user",
+            "filters",
         )
         brief_fields = (
             "auto_merge",
             "id",
             "last_synced",
             "name",
+            "display",
             "parameters",
             "status",
         )
 
 
+class IPFabricFilterSerializer(NestedGroupModelSerializer):
+    expressions = serializers.SerializerMethodField(read_only=True)
+
+    def get_expressions(self, obj):
+        """Return the related expressions for this filter."""
+        return [{"id": expr.id, "name": expr.name} for expr in obj.expressions.all()]
+
+    class Meta:
+        model = IPFabricFilter
+        fields = (
+            "id",
+            "name",
+            "display",
+            "description",
+            "endpoints",
+            "filter_type",
+            "syncs",
+            "expressions",
+            "created",
+            "last_updated",
+            "tags",
+        )
+        brief_fields = (
+            "id",
+            "name",
+            "display",
+            "endpoints",
+            "filter_type",
+            "syncs",
+            "expressions",
+        )
+
+
+class IPFabricFilterExpressionSerializer(NestedGroupModelSerializer):
+    expression = serializers.JSONField()
+
+    class Meta:
+        model = IPFabricFilterExpression
+        fields = (
+            "id",
+            "name",
+            "display",
+            "description",
+            "filters",
+            "expression",
+            "created",
+            "last_updated",
+            "tags",
+        )
+        brief_fields = (
+            "id",
+            "name",
+            "display",
+            "filters",
+            "expression",
+        )
+
+
 class IPFabricIngestionSerializer(NestedGroupModelSerializer):
     branch = BranchSerializer(read_only=True)
     sync = IPFabricSyncSerializer(nested=True)
@@ -213,12 +314,14 @@ class IPFabricIngestionSerializer(NestedGroupModelSerializer):
         fields = (
             "id",
             "name",
+            "display",
             "branch",
             "sync",
         )
         brief_fields = (
             "id",
             "name",
+            "display",
             "branch",
             "sync",
         )
@@ -232,6 +335,7 @@ class IPFabricIngestionIssueSerializer(NestedGroupModelSerializer):
         fields = (
             "id",
             "ingestion",
+            "display",
             "timestamp",
             "model",
             "message",
@@ -244,6 +348,7 @@ class IPFabricIngestionIssueSerializer(NestedGroupModelSerializer):
             "exception",
             "id",
             "ingestion",
+            "display",
             "message",
             "model",
         )

ipfabric_netbox/api/urls.py

@@ -1,6 +1,9 @@
 # api/urls.py
 from netbox.api.routers import NetBoxRouter
 
+from ipfabric_netbox.api.views import IPFabricEndpointViewSet
+from ipfabric_netbox.api.views import IPFabricFilterExpressionViewSet
+from ipfabric_netbox.api.views import IPFabricFilterViewSet
 from ipfabric_netbox.api.views import IPFabricIngestionIssueViewSet
 from ipfabric_netbox.api.views import IPFabricIngestionViewSet
 from ipfabric_netbox.api.views import IPFabricRelationshipFieldViewSet
@@ -15,9 +18,12 @@ from ipfabric_netbox.api.views import IPFabricTransformMapViewSet
 router = NetBoxRouter()
 router.register("source", IPFabricSourceViewSet)
 router.register("snapshot", IPFabricSnapshotViewSet)
+router.register("endpoint", IPFabricEndpointViewSet)
 router.register("transform-map-group", IPFabricTransformMapGroupViewSet)
 router.register("transform-map", IPFabricTransformMapViewSet)
 router.register("sync", IPFabricSyncViewSet)
+router.register("filter", IPFabricFilterViewSet)
+router.register("filter-expression", IPFabricFilterExpressionViewSet)
 router.register("ingestion", IPFabricIngestionViewSet)
 router.register("ingestion-issues", IPFabricIngestionIssueViewSet)
 router.register("transform-field", IPFabricTransformFieldViewSet)

ipfabric_netbox/api/views.py

@@ -10,6 +10,9 @@ from rest_framework.response import Response
 from utilities.query import count_related
 
 from .serializers import EmptySerializer
+from .serializers import IPFabricEndpointSerializer
+from .serializers import IPFabricFilterExpressionSerializer
+from .serializers import IPFabricFilterSerializer
 from .serializers import IPFabricIngestionIssueSerializer
 from .serializers import IPFabricIngestionSerializer
 from .serializers import IPFabricRelationshipFieldSerializer
@@ -23,7 +26,11 @@ from ipfabric_netbox.filtersets import IPFabricRelationshipFieldFilterSet
 from ipfabric_netbox.filtersets import IPFabricSnapshotFilterSet
 from ipfabric_netbox.filtersets import IPFabricSourceFilterSet
 from ipfabric_netbox.filtersets import IPFabricTransformFieldFilterSet
+from ipfabric_netbox.filtersets import IPFabricTransformMapFilterSet
 from ipfabric_netbox.models import IPFabricData
+from ipfabric_netbox.models import IPFabricEndpoint
+from ipfabric_netbox.models import IPFabricFilter
+from ipfabric_netbox.models import IPFabricFilterExpression
 from ipfabric_netbox.models import IPFabricIngestion
 from ipfabric_netbox.models import IPFabricIngestionIssue
 from ipfabric_netbox.models import IPFabricRelationshipField
@@ -35,6 +42,11 @@ from ipfabric_netbox.models import IPFabricTransformMap
 from ipfabric_netbox.models import IPFabricTransformMapGroup
 
 
+class IPFabricEndpointViewSet(NetBoxReadOnlyModelViewSet):
+    queryset = IPFabricEndpoint.objects.all()
+    serializer_class = IPFabricEndpointSerializer
+
+
 class IPFabricTransformMapGroupViewSet(NetBoxModelViewSet):
     queryset = IPFabricTransformMapGroup.objects.all()
     serializer_class = IPFabricTransformMapGroupSerializer
@@ -43,6 +55,7 @@ class IPFabricTransformMapGroupViewSet(NetBoxModelViewSet):
 class IPFabricTransformMapViewSet(NetBoxModelViewSet):
     queryset = IPFabricTransformMap.objects.all()
     serializer_class = IPFabricTransformMapSerializer
+    filterset_class = IPFabricTransformMapFilterSet
 
 
 class IPFabricTransformFieldViewSet(NetBoxModelViewSet):
@@ -83,6 +96,16 @@ class IPFabricSyncViewSet(NetBoxModelViewSet):
         )
 
 
+class IPFabricFilterViewSet(NetBoxModelViewSet):
+    queryset = IPFabricFilter.objects.all()
+    serializer_class = IPFabricFilterSerializer
+
+
+class IPFabricFilterExpressionViewSet(NetBoxModelViewSet):
+    queryset = IPFabricFilterExpression.objects.all()
+    serializer_class = IPFabricFilterExpressionSerializer
+
+
 class IPFabricIngestionViewSet(NetBoxReadOnlyModelViewSet):
     queryset = IPFabricIngestion.objects.all()
     serializer_class = IPFabricIngestionSerializer

ipfabric_netbox/choices.py

@@ -2,7 +2,7 @@ from django.utils.translation import gettext_lazy as _
 from utilities.choices import ChoiceSet
 
 transform_field_source_columns = {
-    "site": [
+    "/inventory/sites/overview": [
         "id",
         "siteName",
         "devicesCount",
@@ -14,7 +14,7 @@ transform_field_source_columns = {
         "routersCount",
         "networksCount",
     ],
-    "device": [
+    "/inventory/devices": [
         "id",
         "sn",
         "hostname",
@@ -45,7 +45,7 @@ transform_field_source_columns = {
         "domain",
         "fqdn",
     ],
-    "inventory": [
+    "/inventory/part-numbers": [
         "id",
         "deviceSn",
         "hostname",
@@ -60,7 +60,7 @@ transform_field_source_columns = {
         "platform",
         "model",
     ],
-    "interface": [
+    "/inventory/interfaces": [
         "id",
         "dscr",
         "duplex",
@@ -88,25 +88,34 @@ transform_field_source_columns = {
         "transceiverSn",
         "transceiverType",
     ],
-    "part_number": [
+    "/technology/vlans/site-summary": [
         "id",
-        "deviceSn",
-        "hostname",
         "siteName",
-        "deviceId",
-        "name",
+        "vlanId",
+        "vlanName",
         "dscr",
-        "pid",
+        "devCount",
+    ],
+    "/technology/routing/vrf/detail": [
+        "id",
         "sn",
-        "vid",
-        "vendor",
-        "platform",
-        "model",
+        "hostname",
+        "siteName",
+        "vrf",
+        "rd",
+        "intCount",
+    ],
+    "/technology/networks/managed-networks": [
+        "id",
+        "siteName",
+        "net",
+        "hosts",
+        "gw",
+        "gwV",
+        "vrf",
+        "vlanId",
     ],
-    "vlan": ["id", "siteName", "vlanId", "vlanName", "dscr", "devCount"],
-    "vrf": ["id", "sn", "hostname", "siteName", "vrf", "rd", "intCount"],
-    "prefix": ["id", "siteName", "net", "hosts", "gw", "gwV", "vrf", "vlanId"],
-    "virtualchassis": [
+    "/technology/platforms/stack/members": [
         "id",
         "sn",
         "master",
@@ -123,7 +132,7 @@ transform_field_source_columns = {
         "image",
         "hwVer",
     ],
-    "ipaddress": [
+    "/technology/addressing/managed-ip/ipv4": [
         "hostname",
         "sn",
         "intName",
@@ -160,29 +169,37 @@ required_transform_map_contenttypes = [
 ]
 
 
-class IPFabricTransformMapSourceModelChoices(ChoiceSet):
-    SITE = "site"
-    INVENTORY = "inventory"
-    DEVICE = "device"
-    VIRTUALCHASSIS = "virtualchassis"
-    INTERFACE = "interface"
-    VLAN = "vlan"
-    VRF = "vrf"
-    PREFIX = "prefix"
-    IPADDRESS = "ipaddress"
-    PARTNUMBERS = "part_number"
+class IPFabricEndpointChoices(ChoiceSet):
+    SITES = "/inventory/sites/overview"
+    DEVICES = "/inventory/devices"
+    VIRTUALCHASSIS = "/technology/platforms/stack/members"
+    INTERFACES = "/inventory/interfaces"
+    PARTNUMBERS = "/inventory/part-numbers"
+    VLANS = "/technology/vlans/site-summary"
+    VRFS = "/technology/routing/vrf/detail"
+    PREFIXES = "/technology/networks/managed-networks"
+    IPADDRESSES = "/technology/addressing/managed-ip/ipv4"
 
     CHOICES = (
-        (SITE, _("Site"), "cyan"),
-        (INVENTORY, _("Inventory"), "gray"),
-        (DEVICE, _("Device"), "gray"),
-        (VIRTUALCHASSIS, _("Virtual Chassis"), "grey"),
-        (INTERFACE, _("Interface"), "gray"),
-        (VLAN, _("VLAN"), "gray"),
-        (VRF, _("VRF"), "gray"),
-        (PREFIX, _("Prefix"), "gray"),
-        (IPADDRESS, _("IP Address"), "gray"),
-        (PARTNUMBERS, _("Part Number"), "gray"),
+        (SITES, SITES, "cyan"),
+        (DEVICES, DEVICES, "gray"),
+        (VIRTUALCHASSIS, VIRTUALCHASSIS, "grey"),
+        (INTERFACES, INTERFACES, "gray"),
+        (PARTNUMBERS, PARTNUMBERS, "gray"),
+        (VLANS, VLANS, "gray"),
+        (VRFS, VRFS, "gray"),
+        (PREFIXES, PREFIXES, "gray"),
+        (IPADDRESSES, IPADDRESSES, "gray"),
+    )
+
+
+class IPFabricFilterTypeChoices(ChoiceSet):
+    AND = "and"
+    OR = "or"
+
+    CHOICES = (
+        (AND, _("AND"), "blue"),
+        (OR, _("OR"), "orange"),
     )
 
 
@@ -208,6 +225,21 @@ class IPFabricSourceTypeChoices(ChoiceSet):
     )
 
 
+class IPFabricSyncParameterChoices(ChoiceSet):
+    SITE = "dcim.site"
+    DEVICE = "dcim.device"
+    INTERFACE = "dcim.interface"
+    VLAN = "ipam.vlan"
+    VRF = "ipam.vrf"
+    PREFIX = "ipam.prefix"
+    IPADDRESS = "ipam.ipaddress"
+    INVENTORYITEM = "dcim.inventoryitem"
+    VIRTUALCHASSIS = "dcim.virtualchassis"
+    PARTNUMBER = "dcim.partnumber"
+
+    CHOICES = ()
+
+
 class IPFabricRawDataTypeChoices(ChoiceSet):
     DEVICE = "device"
     VLAN = "vlan"

ipfabric_netbox/data/endpoint.json

@@ -0,0 +1,47 @@
+[
+  {
+    "name": "Default Sites Endpoint",
+    "description": "",
+    "endpoint": "/inventory/sites/overview"
+  },
+  {
+    "name": "Default Devices Endpoint",
+    "description": "",
+    "endpoint": "/inventory/devices"
+  },
+  {
+    "name": "Default Stack Members Endpoint",
+    "description": "",
+    "endpoint": "/technology/platforms/stack/members"
+  },
+  {
+    "name": "Default Interfaces Endpoint",
+    "description": "",
+    "endpoint": "/inventory/interfaces"
+  },
+  {
+    "name": "Default Part Numbers Endpoint",
+    "description": "",
+    "endpoint": "/inventory/part-numbers"
+  },
+  {
+    "name": "Default VLANs Endpoint",
+    "description": "",
+    "endpoint": "/technology/vlans/site-summary"
+  },
+  {
+    "name": "Default VRFs Endpoint",
+    "description": "",
+    "endpoint": "/technology/routing/vrf/detail"
+  },
+  {
+    "name": "Default Networks Endpoint",
+    "description": "",
+    "endpoint": "/technology/networks/managed-networks"
+  },
+  {
+    "name": "Default Managed IPv4 Endpoint",
+    "description": "",
+    "endpoint": "/technology/addressing/managed-ip/ipv4"
+  }
+]

ipfabric_netbox/data/filters.json

@@ -0,0 +1,51 @@
+{
+  "expressions": [
+    {
+      "name": "Default Devices Filter Expression",
+      "expression": [{"vendor":["neq","aws"]},{"vendor":["neq","azure"]}]
+    },
+    {
+      "name": "Default Device Child Filter Expression",
+      "expression": [{"device.vendor":["neq","aws"]},{"device.vendor":["neq","azure"]}]
+    },
+    {
+      "name": "Default Part Numbers Filter Expression",
+      "expression": [{"sn":["empty", false]},{"name":["empty", false]}]
+    },
+    {
+      "name": "Default VLANs Filter Expression",
+      "expression": [{"vlanId":["neq",0]}]
+    },
+    {
+      "name": "Default Networks Filter Expression",
+      "expression": [{"net":["empty",false]}]
+    }
+  ],
+  "filters": [
+    {
+      "name": "Default Devices Filter",
+      "endpoints": ["/inventory/devices"],
+      "expressions": ["Default Devices Filter Expression"]
+    },
+    {
+      "name": "Default Child Devices Filter",
+      "endpoints": ["/technology/platforms/stack/members", "/inventory/interfaces", "/technology/routing/vrf/detail", "/technology/addressing/managed-ip/ipv4"],
+      "expressions": ["Default Device Child Filter Expression"]
+    },
+    {
+      "name": "Default Part Numbers Filter",
+      "endpoints": ["/inventory/part-numbers"],
+      "expressions": ["Default Device Child Filter Expression", "Default Part Numbers Filter Expression"]
+    },
+    {
+      "name": "Default VLANs Filter",
+      "endpoints": ["/technology/vlans/site-summary"],
+      "expressions": ["Default VLANs Filter Expression"]
+    },
+    {
+      "name": "Default Prefix Filter",
+      "endpoints": ["/technology/networks/managed-networks"],
+      "expressions": ["Default Device Child Filter Expression", "Default Networks Filter Expression"]
+    }
+  ]
+}