catalystwan 0.41.2.dev9__py3-none-any.whl → 0.41.3__py3-none-any.whl

catalystwan/models/configuration/feature_profile/sdwan/{routing → service}/ospfv3.py

@@ -1,13 +1,12 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
 
-from ipaddress import IPv4Address, IPv6Interface
 from typing import List, Literal, Optional, Union
+from uuid import UUID
 
-from pydantic import AliasPath, BaseModel, ConfigDict, Field
+from pydantic import BaseModel, ConfigDict, Field
 
-from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase, as_default
-from catalystwan.models.common import MetricType
-from catalystwan.models.configuration.feature_profile.common import AddressWithMask, RefIdItem
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable
+from catalystwan.models.configuration.feature_profile.common import Prefix
 
 NetworkType = Literal[
     "broadcast",
@@ -41,10 +40,11 @@ RedistributeProtocolIPv6 = Literal[
     "omp",
     "eigrp",
 ]
+MetricType = Literal["type1", "type2"]
 
 
 class NoAuth(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     auth_type: Union[Global[NoAuthType], Default[NoAuthType]] = Field(
         serialization_alias="authType",
@@ -54,7 +54,7 @@ class NoAuth(BaseModel):
 
 
 class IpsecSha1Auth(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     auth_type: Global[IpsecSha1AuthType] = Field(
         serialization_alias="authType",
@@ -66,7 +66,7 @@ class IpsecSha1Auth(BaseModel):
 
 
 class Ospfv3InterfaceParametres(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     name: Optional[Union[Global[str], Variable]] = Field(serialization_alias="ifName", validation_alias="ifName")
     hello_interval: Optional[Union[Global[int], Variable, Default[int]]] = Field(
@@ -92,27 +92,27 @@ class Ospfv3InterfaceParametres(BaseModel):
 
 
 class SummaryRouteIPv6(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
-    network: Union[Global[str], Global[IPv6Interface], Variable]
+    network: Union[Global[str], Variable]
     no_advertise: Union[Global[bool], Variable, Default[bool]] = Field(
-        serialization_alias="noAdvertise", validation_alias="noAdvertise", default=Default[bool](value=False)
+        serialization_alias="noAdvertise", validation_alias="noAdvertise"
     )
     cost: Optional[Union[Global[int], Variable, Default[None]]] = None
 
 
 class SummaryRoute(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
-    network: Optional[AddressWithMask] = None
+    network: Optional[Prefix] = None
     cost: Optional[Union[Global[int], Variable, Default[None]]] = None
     no_advertise: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
-        serialization_alias="noAdvertise", validation_alias="noAdvertise", default=as_default(False)
+        serialization_alias="noAdvertise", validation_alias="noAdvertise", default=None
     )
 
 
 class StubArea(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     area_type: Global[str] = Field(
         serialization_alias="areaType", validation_alias="areaType", default=Global[str](value="stub")
@@ -123,7 +123,7 @@ class StubArea(BaseModel):
 
 
 class NssaArea(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     area_type: Global[str] = Field(
         serialization_alias="areaType", validation_alias="areaType", default=Global[str](value="nssa")
@@ -137,7 +137,7 @@ class NssaArea(BaseModel):
 
 
 class NormalArea(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     area_type: Global[str] = Field(
         serialization_alias="areaType", validation_alias="areaType", default=Global[str](value="normal")
@@ -145,7 +145,7 @@ class NormalArea(BaseModel):
 
 
 class DefaultArea(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     area_type: Default[None] = Field(
         serialization_alias="areaType", validation_alias="areaType", default=Default[None](value=None)
@@ -153,29 +153,29 @@ class DefaultArea(BaseModel):
 
 
 class Ospfv3IPv4Area(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     area_number: Union[Global[int], Variable] = Field(serialization_alias="areaNum", validation_alias="areaNum")
     area_type_config: Optional[Union[StubArea, NssaArea, NormalArea, DefaultArea]] = Field(
         serialization_alias="areaTypeConfig", validation_alias="areaTypeConfig", default=None
     )
-    interfaces: List[Ospfv3InterfaceParametres] = Field(min_length=1)
+    interfaces: List[Ospfv3InterfaceParametres]
     ranges: Optional[List[SummaryRoute]] = None
 
 
 class Ospfv3IPv6Area(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     area_number: Union[Global[int], Variable] = Field(serialization_alias="areaNum", validation_alias="areaNum")
     area_type_config: Optional[Union[StubArea, NssaArea, NormalArea, DefaultArea]] = Field(
         serialization_alias="areaTypeConfig", validation_alias="areaTypeConfig", default=None
     )
-    interfaces: List[Ospfv3InterfaceParametres] = Field(min_length=1)
-    ranges: Optional[List[SummaryRouteIPv6]] = None
+    interfaces: List[Ospfv3InterfaceParametres]
+    ranges: Optional[List[SummaryRoute]] = None
 
 
 class MaxMetricRouterLsa(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     action: Global[MaxMetricRouterLsaAction]
     on_startup_time: Optional[Union[Global[int], Variable]] = Field(
@@ -184,58 +184,45 @@ class MaxMetricRouterLsa(BaseModel):
 
 
 class RedistributedRoute(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     protocol: Union[Global[RedistributeProtocol], Variable]
     nat_dia: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
         serialization_alias="natDia", validation_alias="natDia", default=None
     )
-    route_policy: Optional[Union[Default[None], RefIdItem]] = Field(
-        default=Default[None](value=None),
-        serialization_alias="routePolicy",
-        validation_alias="routePolicy",
-    )
-    translate_rib_metric: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
-        default=None, validation_alias="translateRibMetric", serialization_alias="translateRibMetric"
+    route_policy: Optional[Union[Default[None], Global[UUID]]] = Field(
+        serialization_alias="routePolicy", validation_alias="routePolicy", default=None
     )
 
 
 class RedistributedRouteIPv6(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     protocol: Union[Global[RedistributeProtocolIPv6], Variable]
-    route_policy: Optional[Union[Default[None], RefIdItem]] = Field(
-        default=Default[None](value=None),
-        serialization_alias="routePolicy",
-        validation_alias="routePolicy",
+    route_policy: Optional[Union[Default[None], Global[UUID]]] = Field(
+        serialization_alias="routePolicy", validation_alias="routePolicy", default=None
     )
 
 
 class DefaultOriginate(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     originate: Union[Global[bool], Default[bool]]
     always: Optional[Union[Global[bool], Variable, Default[bool]]] = None
     metric: Optional[Union[Global[str], Variable, Default[None]]] = None
-    metric_type: Optional[Union[Global[MetricType], Variable, Default[None]]] = Field(
-        default=None, serialization_alias="metricType", validation_alias="metricType"
-    )
+    metricType: Optional[Union[Global[MetricType], Variable, Default[None]]] = None
 
 
 class SpfTimers(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     delay: Optional[Union[Global[int], Variable, Default[int]]] = None
-    initial_hold: Optional[Union[Global[int], Variable, Default[int]]] = Field(
-        default=None, validation_alias="initialHold", serialization_alias="initialHold"
-    )
-    max_hold: Optional[Union[Global[int], Variable, Default[int]]] = Field(
-        default=None, validation_alias="maxHold", serialization_alias="maxHold"
-    )
+    initial_hold: Optional[Union[Global[int], Variable, Default[int]]] = None
+    max_hold: Optional[Union[Global[int], Variable, Default[int]]] = None
 
 
 class AdvancedOspfv3Attributes(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
     reference_bandwidth: Optional[Union[Global[int], Variable, Default[int]]] = Field(
         serialization_alias="referenceBandwidth", validation_alias="referenceBandwidth", default=None
@@ -247,16 +234,16 @@ class AdvancedOspfv3Attributes(BaseModel):
         serialization_alias="defaultOriginate", validation_alias="defaultOriginate", default=None
     )
     spf_timers: Optional[SpfTimers] = Field(serialization_alias="spfTimers", validation_alias="spfTimers", default=None)
-    policy_name: Optional[Union[Default[None], RefIdItem]] = Field(
-        default=Default[None](value=None), serialization_alias="policyName", validation_alias="policyName"
+    policy_name: Optional[Union[Default[None], Global[UUID]]] = Field(
+        serialization_alias="policyName", validation_alias="policyName", default=None
     )
     filter: Optional[Union[Global[bool], Variable, Default[bool]]] = None
 
 
 class BasicOspfv3Attributes(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
-    router_id: Optional[Union[Global[str], Global[IPv4Address], Variable, Default[None]]] = Field(
+    router_id: Optional[Union[Global[str], Variable, Default[None]]] = Field(
         serialization_alias="routerId", validation_alias="routerId", default=None
     )
     distance: Optional[Union[Global[int], Variable, Default[int]]] = None
@@ -271,31 +258,42 @@ class BasicOspfv3Attributes(BaseModel):
     )
 
 
-class RoutingOspfv3IPv4Parcel(_ParcelBase):
-    type_: Literal["routing/ospfv3/ipv4"] = Field(default="routing/ospfv3/ipv4", exclude=True)
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+class Ospfv3IPv4Data(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
-    basic: Optional[BasicOspfv3Attributes] = Field(default=None, validation_alias=AliasPath("data", "basic"))
-    advanced: Optional[AdvancedOspfv3Attributes] = Field(default=None, validation_alias=AliasPath("data", "advanced"))
-    redistribute: Optional[List[RedistributedRoute]] = Field(
-        default=None, validation_alias=AliasPath("data", "redistribute")
-    )
+    basic: Optional[BasicOspfv3Attributes] = None
+    advanced: Optional[AdvancedOspfv3Attributes] = None
+    redistribute: Optional[RedistributedRoute] = None
     max_metric_router_lsa: Optional[MaxMetricRouterLsa] = Field(
-        validation_alias=AliasPath("data", "maxMetricRouterLsa"), default=None
+        serialization_alias="maxMetricRouterLsa", validation_alias="maxMetricRouterLsa", default=None
     )
-    area: List[Ospfv3IPv4Area] = Field(validation_alias=AliasPath("data", "area"))
+    area: List[Ospfv3IPv4Area]
 
 
-class RoutingOspfv3IPv6Parcel(_ParcelBase):
-    type_: Literal["routing/ospfv3/ipv6"] = Field(default="routing/ospfv3/ipv6", exclude=True)
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+class Ospfv3IPv6Data(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
 
-    basic: Optional[BasicOspfv3Attributes] = Field(default=None, validation_alias=AliasPath("data", "basic"))
-    advanced: Optional[AdvancedOspfv3Attributes] = Field(default=None, validation_alias=AliasPath("data", "advanced"))
-    redistribute: Optional[List[RedistributedRouteIPv6]] = Field(
-        default=None, validation_alias=AliasPath("data", "redistribute")
-    )
+    basic: Optional[BasicOspfv3Attributes] = None
+    advanced: Optional[AdvancedOspfv3Attributes] = None
+    redistribute: Optional[RedistributedRouteIPv6] = None
     max_metric_router_lsa: Optional[MaxMetricRouterLsa] = Field(
-        validation_alias=AliasPath("data", "maxMetricRouterLsa"), default=None
+        serialization_alias="maxMetricRouterLsa", validation_alias="maxMetricRouterLsa", default=None
     )
-    area: List[Ospfv3IPv6Area] = Field(validation_alias=AliasPath("data", "area"))
+    area: List[Ospfv3IPv6Area]
+
+
+class Ospfv3IPv4CreationPayload(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    name: str
+    description: Optional[str] = None
+    data: Ospfv3IPv4Data
+
+
+class Ospfv3IPv6CreationPayload(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+
+    name: str
+    description: Optional[str] = None
+    data: Ospfv3IPv6Data
+    metadata: Optional[dict] = None