Add support for VlanRanges to NSISTP and

- update netbox sap payload function and create a new vlan group payload function.
- rename CustomVlanRange to OrchestratorVlanRange
- update validate vlan in use validation

Author: tjeerddie

products/product_blocks/port.py

@@ -73,8 +73,8 @@ def vlans(self) -> List[int]:
 
     @computed_field  # type: ignore[misc]
     @property
-    def vlan_ims_ids(self) -> List[int]:
-        """Get list of active VLAN IMS IDs by looking at SAPBlock's that use this PortBlock."""
+    def vlan_group_ims_ids(self) -> List[int]:
+        """Get list of active IMS VLAN GROUP IDs by looking at SAPBlock's that use this PortBlock."""
         return [sap_block.ims_id for sap_block in self._active_sap_blocks()]
 
     @computed_field  # type: ignore[misc]

products/product_blocks/sap.py

@@ -17,17 +17,18 @@
 from pydantic import computed_field
 
 from products.product_blocks.port import PortBlock, PortBlockInactive, PortBlockProvisioning
+from workflows.nsistp.shared.shared import OrchestratorVlanRanges
 
 
 class SAPBlockInactive(ProductBlockModel, product_block_name="SAP"):
     port: PortBlockInactive | None = None
-    vlan: int | None = None
+    vlan: OrchestratorVlanRanges | None = None
     ims_id: int | None = None
 
 
 class SAPBlockProvisioning(SAPBlockInactive, lifecycle=[SubscriptionLifecycle.PROVISIONING]):
     port: PortBlockProvisioning
-    vlan: int  # TODO: refactor to CustomVlanRanges together with L2VPN product and workflow
+    vlan: OrchestratorVlanRanges
     ims_id: int | None = None
 
     @computed_field  # type: ignore[misc]
@@ -38,5 +39,5 @@ def title(self) -> str:
 
 class SAPBlock(SAPBlockProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
     port: PortBlock
-    vlan: int  # TODO: refactor to CustomVlanRanges together with L2VPN product and workflow
+    vlan: OrchestratorVlanRanges
     ims_id: int

products/product_types/nsistp.py

@@ -16,7 +16,7 @@
 from orchestrator.types import SubscriptionLifecycle
 
 from products.product_blocks.nsistp import NsistpBlock, NsistpBlockInactive, NsistpBlockProvisioning
-from workflows.nsistp.shared.shared import CustomVlanRanges
+from workflows.nsistp.shared.shared import OrchestratorVlanRanges
 
 
 class NsistpInactive(SubscriptionModel, is_base=True):
@@ -31,5 +31,5 @@ class Nsistp(NsistpProvisioning, lifecycle=[SubscriptionLifecycle.ACTIVE]):
     nsistp: NsistpBlock
 
     @property
-    def vlan_range(self) -> CustomVlanRanges:
+    def vlan_range(self) -> OrchestratorVlanRanges:
         return self.nsistp.sap.vlan

products/services/netbox/payload/port.py

@@ -44,11 +44,13 @@ def build_port_payload(model: PortBlockProvisioning, subscription: SubscriptionM
     Returns: :class:`netbox.InterfacePayload`
 
     """
+    print(model.vlan_group_ims_ids)
+    vlan_ids = [vlan.id for group_id in model.vlan_group_ims_ids for vlan in netbox.get_vlans(group_id=group_id)]
     return netbox.InterfacePayload(
         device=model.node.ims_id,
         name=model.port_name,
         type=model.port_type,
-        tagged_vlans=sorted(model.vlan_ims_ids),
+        tagged_vlans=sorted(vlan_ids),
         mode="tagged" if model.port_mode == PortMode.TAGGED else "",
         description=model.port_description,
         enabled=model.enabled,

products/services/netbox/payload/sap.py

@@ -16,17 +16,19 @@
 
 from products.product_blocks.sap import SAPBlockProvisioning
 from services import netbox
+import itertools
 
 
-def build_sap_payload(model: SAPBlockProvisioning, subscription: SubscriptionModel) -> netbox.VlanPayload:
+def build_sap_payload(model: SAPBlockProvisioning, subscription: SubscriptionModel) -> list[netbox.VlanPayload]:
     """Create and return a Netbox payload object for a :class:`~products.product_blocks.sap.SAPBlockProvisioning`.
 
     Example payload::
 
        {
           "vid": 4,
           "name": "paris01a 0/0/1 vlan 4",
-          "status": "active"
+          "status": "active",
+          "group": 1
        }
 
     Args:
@@ -36,4 +38,28 @@ def build_sap_payload(model: SAPBlockProvisioning, subscription: SubscriptionMod
     Returns: :class:`netbox.VlanPayload`
 
     """
-    return netbox.VlanPayload(vid=int(model.vlan), name=f"{model.port.node.node_name} {model.port.port_name}")
+    name = f"{model.port.node.node_name} {model.port.port_name}"
+    vlan_list = [vlan for vlan_start, vlan_end in model.vlan.to_list_of_tuples() for vlan in range(vlan_start, vlan_end+1)]
+    return [netbox.VlanPayload(vid=vlan, group=model.ims_id, name=f"{name} - {vlan}") for vlan in vlan_list]
+
+
+def build_sap_vlan_group_payload(model: SAPBlockProvisioning, subscription: SubscriptionModel) -> netbox.VlanGroupPayload:
+    """Create
+
+    Example payload::
+
+       {
+          "name": "paris01a 0/0/1 vlan 4",
+          "vid_ranges": "5, 10, 15-20",
+       }
+
+    Args:
+        model: SAPBlockProvisioning
+        subscription: The Subscription that will be provisioned
+
+    Returns: :class:`netbox.VlanGroupPayload`
+
+    """
+    name = f"{model.port.node.node_name} {model.port.port_name}"
+    slug = name.replace(" ", "-").replace("/", "-")
+    return netbox.VlanGroupPayload(name=name, slug=slug, vid_ranges=model.vlan.to_list_of_tuples())

pyproject.toml

@@ -4,7 +4,7 @@ version = "0.1.0"
 requires-python = ">=3.12,<3.14"
 dependencies = [
   "deepdiff==8.6.1",
-  "orchestrator-core==4.0.4",
+  "orchestrator-core==4.5.3",
   "pynetbox==7.4.1",
   "rich==13.9.4",
 ]

services/netbox.py

@@ -25,6 +25,7 @@
 
 from settings import settings
 from utils.singledispatch import single_dispatch_base
+from workflows.nsistp.shared.shared import OrchestratorVlanRanges
 
 logger = structlog.get_logger(__name__)
 
@@ -129,11 +130,19 @@ class AvailableIpPayload:
 
 @dataclass
 class VlanPayload(NetboxPayload):
-    vid: int
+    vid: OrchestratorVlanRanges
     name: str
+    group: int
     status: str | None = "active"
 
 
+@dataclass
+class VlanGroupPayload(NetboxPayload):
+    name: str
+    slug: str
+    vid_ranges: list[list[int, int]]
+
+
 @dataclass
 class L2vpnPayload(NetboxPayload):
     name: str
@@ -271,6 +280,9 @@ def delete_l2vpn(**kwargs) -> None:
 def delete_vlan(**kwargs) -> None:
     delete_from_netbox(api.ipam.vlans, **kwargs)
 
+def delete_vlan_group(**kwargs) -> None:
+    delete_from_netbox(api.ipam.vlan_groups, **kwargs)
+
 
 def skip_network_address(ip_prefix: Prefixes) -> None:
     """Assign placeholders for network address(es) in available IPS of the prefix.
@@ -416,6 +428,11 @@ def _(payload: VlanPayload, **kwargs: Any) -> int:
     return _create_object(payload, endpoint=api.ipam.vlans)
 
 
+@create.register
+def _(payload: VlanGroupPayload, **kwargs: Any) -> int:
+    return _create_object(payload, endpoint=api.ipam.vlan_groups)
+
+
 @create.register
 def _(payload: L2vpnPayload, **kwargs: Any) -> int:
     return _create_object(payload, endpoint=api.vpn.l2vpns)