catalystwan 0.41.2__py3-none-any.whl → 0.41.2.dev0__py3-none-any.whl

catalystwan/models/configuration/feature_profile/sdwan/service/lan/svi.py

@@ -1,44 +1,44 @@
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
 
-from typing import List, Optional, Union
-from uuid import UUID
+from ipaddress import IPv4Address, IPv6Interface
+from typing import List, Literal, Optional, Union
 
-from pydantic import BaseModel, ConfigDict, Field
+from pydantic import AliasPath, BaseModel, ConfigDict, Field
 
-from catalystwan.api.configuration_groups.parcel import Default, Global, Variable
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase
+from catalystwan.models.configuration.feature_profile.common import Arp, RefIdItem, StaticIPv4Address, StaticIPv6Address
 from catalystwan.models.configuration.feature_profile.sdwan.service.lan.common import (
-    Arp,
-    StaticIPv4Address,
-    StaticIPv6Address,
     VrrpIPv6Address,
     VrrpTrackingObject,
 )
 
 
 class VrrpIPv4SecondaryAddress(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
 
     address: Union[Variable, Global[str]]
 
 
 class VrrpIPv6SecondaryAddress(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
 
-    prefix: Union[Global[str], Variable]
+    prefix: Union[Global[str], Global[IPv6Interface], Variable]
 
 
 class VrrpIPv4(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
 
-    group_id: Union[Variable, Global[int]] = Field(serialization_alias="groupId", validation_alias="groupId")
+    group_id: Union[Variable, Global[int]] = Field()
     priority: Union[Variable, Global[int], Default[int]] = Default[int](value=100)
     timer: Union[Variable, Global[int], Default[int]] = Default[int](value=1000)
     track_omp: Union[Global[bool], Default[bool]] = Field(
         serialization_alias="trackOmp", validation_alias="trackOmp", default=Default[bool](value=False)
     )
-    ip_address: Union[Global[str], Variable] = Field(serialization_alias="ipAddress", validation_alias="ipAddress")
+    ip_address: Union[Global[str], Global[IPv4Address], Variable] = Field(
+        serialization_alias="ipAddress", validation_alias="ipAddress"
+    )
     ip_address_secondary: Optional[List[VrrpIPv4SecondaryAddress]] = Field(
-        serialization_alias="ipAddressSecondary", validation_alias="ipAddressSecondary"
+        serialization_alias="ipAddressSecondary", validation_alias="ipAddressSecondary", default=None
     )
     tloc_pref_change: Union[Global[bool], Default[bool]] = Field(
         serialization_alias="tlocPrefChange", validation_alias="tlocPrefChange", default=Default[bool](value=False)
@@ -50,11 +50,18 @@ class VrrpIPv4(BaseModel):
         serialization_alias="trackingObject", validation_alias="trackingObject", default=None
     )
 
-    prefix_list: Optional[Union[Global[str], Variable, Default[None]]] = Default[None](value=None)
+    prefix_list: Optional[Union[Global[str], Variable, Default[None]]] = Field(
+        serialization_alias="prefixList", validation_alias="prefixList", default=None
+    )
+    follow_dual_router_h_a_availability: Optional[Union[Global[bool], Default[bool]]] = Field(
+        default=None,
+        validation_alias="followDualRouterHAAvailability",
+        serialization_alias="followDualRouterHAAvailability",
+    )
 
 
 class VrrpIPv6(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
 
     group_id: Union[Variable, Global[int]] = Field(serialization_alias="groupId", validation_alias="groupId")
     priority: Union[Variable, Global[int], Default[int]] = Default[int](value=100)
@@ -67,17 +74,22 @@ class VrrpIPv6(BaseModel):
     )
     ipv6: List[VrrpIPv6Address]
     ipv6_secondary: Optional[List[VrrpIPv6SecondaryAddress]]
+    follow_dual_router_h_a_availability: Optional[Union[Global[bool], Default[bool]]] = Field(
+        default=None,
+        validation_alias="followDualRouterHAAvailability",
+        serialization_alias="followDualRouterHAAvailability",
+    )
 
 
 class Dhcpv6Helper(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
 
     address: Union[Global[str], Variable] = Field(serialization_alias="address", validation_alias="address")
     vpn: Optional[Union[Global[int], Variable, Default[None]]] = None
 
 
 class AdvancedSviAttributes(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
 
     tcp_mss: Optional[Union[Global[int], Variable, Default[None]]] = Field(
         serialization_alias="tcpMss", validation_alias="tcpMss", default=Default[None](value=None)
@@ -97,8 +109,8 @@ class AdvancedSviAttributes(BaseModel):
     )
 
 
-class IPv4Address(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+class IPv4AddressConfiguration(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
 
     address: StaticIPv4Address = Field(serialization_alias="addressV4", validation_alias="addressV4")
     secondary_address: Optional[List[StaticIPv4Address]] = Field(
@@ -109,10 +121,10 @@ class IPv4Address(BaseModel):
     )
 
 
-class IPv6Address(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+class IPv6AddressConfiguration(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
 
-    address: Union[Global[str], Variable, Default[None]] = Field(
+    address: Union[Global[str], Global[IPv6Interface], Variable, Default[None]] = Field(
         serialization_alias="addressV6", validation_alias="addressV6"
     )
     secondary_address: Optional[List[StaticIPv6Address]] = Field(
@@ -124,54 +136,48 @@ class IPv6Address(BaseModel):
 
 
 class AclQos(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
 
-    ipv4_acl_egress: Optional[Global[UUID]] = Field(
+    ipv4_acl_egress: Optional[RefIdItem] = Field(
         serialization_alias="ipv4AclEgress", validation_alias="ipv4AclEgress", default=None
     )
-    ipv4_acl_ingress: Optional[Global[UUID]] = Field(
+    ipv4_acl_ingress: Optional[RefIdItem] = Field(
         serialization_alias="ipv4AclIngress", validation_alias="ipv4AclIngress", default=None
     )
-    ipv6_acl_egress: Optional[Global[UUID]] = Field(
+    ipv6_acl_egress: Optional[RefIdItem] = Field(
         serialization_alias="ipv6AclEgress", validation_alias="ipv6AclEgress", default=None
     )
-    ipv6_acl_ingress: Optional[Global[UUID]] = Field(
+    ipv6_acl_ingress: Optional[RefIdItem] = Field(
         serialization_alias="ipv6AclIngress", validation_alias="ipv6AclIngress", default=None
     )
 
 
-class InterfaceSviData(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+class InterfaceSviParcel(_ParcelBase):
+    type_: Literal["lan/vpn/interface/svi"] = Field(default="lan/vpn/interface/svi", exclude=True)
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
 
-    shutdown: Union[Global[bool], Variable, Default[bool]] = Default[bool](value=True)
-    interface_name: Optional[Union[Global[str], Variable]] = Field(
-        serialization_alias="interfaceName", validation_alias="interfaceName"
+    shutdown: Union[Global[bool], Variable, Default[bool]] = Field(
+        default=Default[bool](value=True), validation_alias=AliasPath("data", "shutdown")
+    )
+    interface_name: Union[Global[str], Variable] = Field(validation_alias=AliasPath("data", "interfaceName"))
+    svi_description: Optional[Union[Global[str], Variable, Default[None]]] = Field(
+        default=Default[None](value=None), validation_alias=AliasPath("data", "description")
     )
-    description: Optional[Union[Global[str], Variable, Default[None]]] = Default[None](value=None)
     interface_mtu: Optional[Union[Global[int], Variable, Default[int]]] = Field(
-        serialization_alias="ifMtu", validation_alias="ifMtu", default=Default[int](value=1500)
+        validation_alias=AliasPath("data", "ifMtu"), default=Default[int](value=1500)
     )
     ip_mtu: Optional[Union[Global[int], Variable, Default[int]]] = Field(
-        serialization_alias="ipMtu", validation_alias="ipMtu", default=Default[int](value=1500)
-    )
-    ipv4: Optional[IPv4Address] = None
-    ipv6: Optional[IPv6Address] = None
-    acl_qos: Optional[AclQos] = Field(serialization_alias="aclQos", validation_alias="aclQos", default=None)
-    arp: Optional[List[Arp]] = None
-    vrrp: Optional[List[VrrpIPv4]] = None
-    vrrp_ipv6: Optional[List[VrrpIPv6]] = Field(
-        serialization_alias="vrrpIpv6", validation_alias="vrrpIpv6", default=None
-    )
+        validation_alias=AliasPath("data", "ipMtu"), default=Default[int](value=1500)
+    )
+    ipv4: Optional[IPv4AddressConfiguration] = Field(default=None, validation_alias=AliasPath("data", "ipv4"))
+    ipv6: Optional[IPv6AddressConfiguration] = Field(default=None, validation_alias=AliasPath("data", "ipv6"))
+    acl_qos: Optional[AclQos] = Field(validation_alias=AliasPath("data", "aclQos"), default=None)
+    arp: Optional[List[Arp]] = Field(default=None, validation_alias=AliasPath("data", "arp"))
+    vrrp: Optional[List[VrrpIPv4]] = Field(default=None, validation_alias=AliasPath("data", "vrrp"))
+    vrrp_ipv6: Optional[List[VrrpIPv6]] = Field(validation_alias=AliasPath("data", "vrrpIpv6"), default=None)
     dhcp_client_v6: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
-        serialization_alias="dhcpClientV6", validation_alias="dhcpClientV6", default=Default[bool](value=False)
+        validation_alias=AliasPath("data", "dhcpClientV6"), default=Default[bool](value=False)
+    )
+    advanced: AdvancedSviAttributes = Field(
+        default_factory=AdvancedSviAttributes, validation_alias=AliasPath("data", "advanced")
     )
-    advanced: AdvancedSviAttributes = AdvancedSviAttributes()
-
-
-class InterfaceSviCreationPayload(BaseModel):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-
-    name: str
-    description: Optional[str] = None
-    data: InterfaceSviData
-    metadata: Optional[dict] = None