catalystwan 0.41.1.dev0__tar.gz → 0.41.1.dev2__tar.gz

{catalystwan-0.41.1.dev0 → catalystwan-0.41.1.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: catalystwan
-Version: 0.41.1.dev0
+Version: 0.41.1.dev2
 Summary: Cisco Catalyst WAN SDK for Python
 Author: kagorski
 Author-email: kagorski@cisco.com

{catalystwan-0.41.1.dev0 → catalystwan-0.41.1.dev2}/catalystwan/api/configuration_groups/parcel.py

@@ -117,6 +117,9 @@ class Global(BaseModel, Generic[T]):
             return self.value <= other
         return False
 
+    def __hash__(self) -> int:
+        return hash(self.value)
+
 
 class Variable(BaseModel):
     model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)

{catalystwan-0.41.1.dev0 → catalystwan-0.41.1.dev2}/catalystwan/integration_tests/feature_profile/sdwan/test_transport.py

@@ -22,6 +22,7 @@ from catalystwan.models.common import (
     IkeGroup,
     IpsecCiphersuite,
     LineMode,
+    PfsGroup,
     SecondaryRegion,
     T1Framing,
     T1Linecode,
@@ -134,10 +135,7 @@ from catalystwan.models.configuration.feature_profile.sdwan.transport.wan.interf
     Tunnel as TunnelEthernet,
 )
 from catalystwan.models.configuration.feature_profile.sdwan.transport.wan.interface.gre import Basic, InterfaceGreParcel
-from catalystwan.models.configuration.feature_profile.sdwan.transport.wan.interface.ipsec import (
-    InterfaceIpsecParcel,
-    PerfectForwardSecrecy,
-)
+from catalystwan.models.configuration.feature_profile.sdwan.transport.wan.interface.ipsec import InterfaceIpsecParcel
 from catalystwan.models.configuration.feature_profile.sdwan.transport.wan.interface.multilink import (
     InterfaceMultilinkParcel,
 )
@@ -1130,7 +1128,7 @@ class TestTransportFeatureProfileWanInterfaceModels(TestCaseBase):
             ipsec_rekey_interval=Default[int](value=3600),
             ipsec_replay_window=Default[int](value=512),
             mtu=Default[int](value=1500),
-            perfect_forward_secrecy=Global[PerfectForwardSecrecy](value="group-16"),
+            perfect_forward_secrecy=Global[PfsGroup](value="group-16"),
             pre_shared_secret=Global[str](value="iEKeBeVb"),
             shutdown=Default[bool](value=True),
             tcp_mss_adjust=Default[None](value=None),

{catalystwan-0.41.1.dev0 → catalystwan-0.41.1.dev2}/catalystwan/models/common.py

@@ -879,6 +879,12 @@ IpsecCiphersuite = Literal[
     "null-sha512",
 ]
 
+IpsecTunnelMode = Literal[
+    "ipv4",
+    "ipv6",
+    "ipv4-v6overlay",
+]
+
 LossProtectionType = Literal[
     "fecAdaptive",
     "fecAlways",

{catalystwan-0.41.1.dev0 → catalystwan-0.41.1.dev2}/catalystwan/models/configuration/feature_profile/common.py

@@ -130,6 +130,11 @@ class AddressWithMask(BaseModel):
     mask: Union[Variable, Global[SubnetMask]]
 
 
+class AddressAndMaskWithDefault(BaseModel):
+    address: Union[Variable, Global[IPv4Address], Global[IPv6Address], Default[None]]
+    mask: Union[Variable, Global[SubnetMask], Default[None]]
+
+
 class SchemaTypeQuery(BaseModel):
     model_config = ConfigDict(populate_by_name=True)
 
@@ -310,7 +315,10 @@ class RefIdItem(BaseModel):
 
     @classmethod
     def from_uuid(cls, ref_id: UUID):
-        return cls(ref_id=as_global(str(ref_id)))
+        return cls(ref_id=Global[str](value=str(ref_id)))
+
+    def __hash__(self) -> int:
+        return hash(self.ref_id.value)
 
 
 class RefIdList(BaseModel):

{catalystwan-0.41.1.dev0 → catalystwan-0.41.1.dev2}/catalystwan/models/configuration/feature_profile/sdwan/service/lan/ipsec.py

@@ -6,15 +6,9 @@ from typing import Literal, Optional, Union
 from pydantic import AliasPath, ConfigDict, Field
 
 from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase
-from catalystwan.models.common import IkeCiphersuite, IkeGroup, IkeMode, IpsecCiphersuite, PfsGroup
+from catalystwan.models.common import IkeCiphersuite, IkeGroup, IkeMode, IpsecCiphersuite, IpsecTunnelMode, PfsGroup
 from catalystwan.models.configuration.feature_profile.common import AddressWithMask, TunnelApplication
 
-IpsecTunnelMode = Literal[
-    "ipv4",
-    "ipv6",
-    "ipv4-v6overlay",
-]
-
 
 class InterfaceIpsecParcel(_ParcelBase):
     type_: Literal["lan/vpn/interface/ipsec"] = Field(default="lan/vpn/interface/ipsec", exclude=True)
@@ -31,9 +25,18 @@ class InterfaceIpsecParcel(_ParcelBase):
     ipsec_description: Union[Global[str], Variable, Default[None]] = Field(
         default=Default[None](value=None), validation_alias=AliasPath("data", "description")
     )
-    address: Optional[AddressWithMask] = Field(default=None, validation_alias=AliasPath("data", "address"))
+    address: Optional[AddressWithMask] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "address"),
+        description="""
+            This filed is required in version < 20.14 (default: 1500).
+            In version >=20.14 it is optional, as it can be replaced by ipv6_address
+        """,
+    )
     ipv6_address: Optional[Union[Global[str], Global[IPv6Interface], Variable]] = Field(
-        validation_alias=AliasPath("data", "ipv6Address"), default=None
+        default=None,
+        validation_alias=AliasPath("data", "ipv6Address"),
+        description="This field is supported from version 20.14",
     )
     tunnel_source: Optional[AddressWithMask] = Field(validation_alias=AliasPath("data", "tunnelSource"), default=None)
     tunnel_source_v6: Optional[Union[Global[str], Variable]] = Field(
@@ -49,21 +52,30 @@ class InterfaceIpsecParcel(_ParcelBase):
         validation_alias=AliasPath("data", "tunnelDestinationV6"), default=None
     )
     application: Union[Global[TunnelApplication], Variable] = Field(validation_alias=AliasPath("data", "application"))
-    tcp_mss_adjust: Union[Global[int], Variable, Default[None]] = Field(
-        validation_alias=AliasPath("data", "tcpMssAdjust"), default=Default[None](value=None)
+    tcp_mss_adjust: Optional[Union[Global[int], Variable, Default[None]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "tcpMssAdjust"),
+        description="Required if address is provided (default: Default[None]). None otherwise.",
     )
     tcp_mss_adjust_v6: Optional[Union[Global[int], Variable, Default[None]]] = Field(
-        validation_alias=AliasPath("data", "tcpMssAdjustV6"), default=None
+        default=None,
+        validation_alias=AliasPath("data", "tcpMssAdjustV6"),
+        description="Required if ipv6_address is provided (default: Default[None]). None otherwise.",
     )
     clear_dont_fragment: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
+        default=None,
         validation_alias=AliasPath("data", "clearDontFragment"),
-        default=Default[bool](value=False),
+        description="Required if address is provided (default: False). None otherwise.",
     )
     mtu: Optional[Union[Global[int], Variable, Default[int]]] = Field(
-        default=Default[int](value=1500), validation_alias=AliasPath("data", "mtu")
+        default=None,
+        validation_alias=AliasPath("data", "mtu"),
+        description="Required if address is provided (default: 1500). None otherwise.",
     )
     mtu_v6: Optional[Union[Global[int], Variable, Default[None]]] = Field(
-        validation_alias=AliasPath("data", "mtuV6"), default=None
+        default=None,
+        validation_alias=AliasPath("data", "mtuV6"),
+        description="Required if ipv6_address is provided (default: Default[None]). None otherwise.",
     )
     dpd_interval: Union[Global[int], Variable, Default[int]] = Field(
         validation_alias=AliasPath("data", "dpdInterval"), default=Default[int](value=10)

catalystwan-0.41.1.dev2/catalystwan/models/configuration/feature_profile/sdwan/transport/wan/interface/ipsec.py

@@ -0,0 +1,137 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from __future__ import annotations
+
+from ipaddress import IPv4Address, IPv4Interface, IPv6Address, IPv6Interface
+from typing import Literal, Optional, Union
+
+from pydantic import AliasPath, ConfigDict, Field
+
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase
+from catalystwan.models.common import IkeCiphersuite, IkeGroup, IkeMode, IpsecCiphersuite, IpsecTunnelMode, PfsGroup
+from catalystwan.models.configuration.feature_profile.common import (
+    AddressAndMaskWithDefault,
+    AddressWithMask,
+    TunnelApplication,
+)
+
+
+class InterfaceIpsecParcel(_ParcelBase):
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+    type_: Literal["wan/vpn/interface/ipsec"] = Field(default="wan/vpn/interface/ipsec", exclude=True, frozen=True)
+    address: Optional[AddressAndMaskWithDefault] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "address"),
+        description="""
+            This filed is required in version < 20.14 (default: 1500).
+            In version >=20.14 it is optional, as it can be replaced by ipv6_address.
+        """,
+    )
+    ipv6_address: Optional[Union[Global[str], Global[IPv6Interface], Variable]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "ipv6Address"),
+        description="This field is supported from version 20.14",
+    )
+    application: Union[Variable, Global[TunnelApplication]] = Field(validation_alias=AliasPath("data", "application"))
+    clear_dont_fragment: Union[Variable, Global[bool], Default[bool]] = Field(
+        default=Default[bool](value=False),
+        validation_alias=AliasPath("data", "clearDontFragment"),
+        description="Required if address is provided (default: False). None otherwise.",
+    )
+    if_description: Union[Variable, Global[str], Default[None]] = Field(
+        default=Default[None](value=None), validation_alias=AliasPath("data", "description")
+    )
+    dpd_interval: Union[Variable, Default[int], Global[int]] = Field(
+        default=Default[int](value=10), validation_alias=AliasPath("data", "dpdInterval")
+    )
+    dpd_retries: Union[Variable, Default[int], Global[int]] = Field(
+        default=Default[int](value=3), validation_alias=AliasPath("data", "dpdRetries")
+    )
+    if_name: Union[Variable, Global[str]] = Field(validation_alias=AliasPath("data", "ifName"))
+    ike_ciphersuite: Union[Variable, Global[IkeCiphersuite], Default[IkeCiphersuite]] = Field(
+        default=Default[IkeCiphersuite](value="aes256-cbc-sha1"), validation_alias=AliasPath("data", "ikeCiphersuite")
+    )
+    ike_group: Union[Global[IkeGroup], Default[IkeGroup], Variable] = Field(
+        default=Default[IkeGroup](value="16"), validation_alias=AliasPath("data", "ikeGroup")
+    )
+    ike_local_id: Union[Variable, Global[str], Default[None]] = Field(
+        validation_alias=AliasPath("data", "ikeLocalId"), default=Default[None](value=None)
+    )
+    ike_rekey_interval: Union[Variable, Default[int], Global[int]] = Field(
+        default=Default[int](value=14400), validation_alias=AliasPath("data", "ikeRekeyInterval")
+    )
+    ike_remote_id: Union[Variable, Global[str], Default[None], Global[IPv4Address]] = Field(
+        default=Default[None](value=None), validation_alias=AliasPath("data", "ikeRemoteId")
+    )
+    ike_version: Union[Global[int], Default[int]] = Field(
+        default=Default[int](value=1), validation_alias=AliasPath("data", "ikeVersion")
+    )
+    ipsec_ciphersuite: Union[Variable, Global[IpsecCiphersuite], Default[IpsecCiphersuite]] = Field(
+        default=Default[IpsecCiphersuite](value="aes256-gcm"), validation_alias=AliasPath("data", "ipsecCiphersuite")
+    )
+    ipsec_rekey_interval: Union[Variable, Default[int], Global[int]] = Field(
+        default=Default[int](value=3600), validation_alias=AliasPath("data", "ipsecRekeyInterval")
+    )
+    ipsec_replay_window: Union[Variable, Default[int], Global[int]] = Field(
+        default=Default[int](value=512), validation_alias=AliasPath("data", "ipsecReplayWindow")
+    )
+    mtu: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "mtu"),
+        description="Required if address is provided (default: 1500). None otherwise.",
+    )
+    mtu_v6: Optional[Union[Global[int], Variable, Default[None]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "mtuV6"),
+        description="Required if ipv6_address is provided (default: Default[None]). None otherwise.",
+    )
+    multiplexing: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "multiplexing"),
+        description="This field is supported from version 20.14 (default False)",
+    )
+    perfect_forward_secrecy: Union[Variable, Default[PfsGroup], Global[PfsGroup]] = Field(
+        default=Default[PfsGroup](value="group-16"),
+        validation_alias=AliasPath("data", "perfectForwardSecrecy"),
+    )
+    pre_shared_secret: Union[Variable, Global[str]] = Field(validation_alias=AliasPath("data", "preSharedSecret"))
+    shutdown: Union[Variable, Global[bool], Default[bool]] = Field(
+        default=Default[bool](value=True), validation_alias=AliasPath("data", "shutdown")
+    )
+    tcp_mss_adjust: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "tcpMssAdjust"),
+        description="Required if address is provided (default: Default[None]). None otherwise.",
+    )
+    tcp_mss_adjust_v6: Optional[Union[Global[int], Variable, Default[None]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "tcpMssAdjustV6"),
+        description="Required if ipv6_address is provided (default: Default[None]). None otherwise.",
+    )
+    tunnel_mode: Optional[Union[Global[IpsecTunnelMode], Default[IpsecTunnelMode]]] = Field(
+        validation_alias=AliasPath("data", "tunnelMode"),
+        default=None,
+    )
+    tunnel_destination: Optional[AddressWithMask] = Field(
+        validation_alias=AliasPath("data", "tunnelDestination"), default=None
+    )
+    tunnel_destination_v6: Optional[Union[Global[str], Global[IPv6Address], Variable]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "tunnelDestinationV6"),
+        description="Required if ipv6_address is provided. None otherwise.",
+    )
+    tunnel_source: Optional[AddressWithMask] = Field(default=None, validation_alias=AliasPath("data", "tunnelSource"))
+    tunnel_source_v6: Optional[Union[Global[str], Variable]] = Field(
+        validation_alias=AliasPath("data", "tunnelSourceV6"), default=None
+    )
+    ike_mode: Optional[Union[Variable, Global[IkeMode], Default[IkeMode]]] = Field(
+        default=Default[IkeMode](value="main"), validation_alias=AliasPath("data", "ikeMode")
+    )
+    tracker: Optional[Union[Variable, Global[str], Default[None]]] = Field(
+        default=None, validation_alias=AliasPath("data", "tracker")
+    )
+    tunnel_route_via: Optional[Union[Variable, Global[str], Default[None]]] = Field(
+        default=None, validation_alias=AliasPath("data", "tunnelRouteVia")
+    )
+    tunnel_source_interface: Optional[Union[Variable, Global[str], Global[IPv4Interface]]] = Field(
+        default=None, validation_alias=AliasPath("data", "tunnelSourceInterface")
+    )

{catalystwan-0.41.1.dev0 → catalystwan-0.41.1.dev2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "catalystwan"
-version = "0.41.1.dev0"
+version = "0.41.1.dev2"
 description = "Cisco Catalyst WAN SDK for Python"
 authors = ["kagorski <kagorski@cisco.com>"]
 readme = "README.md"

catalystwan-0.41.1.dev0/catalystwan/models/configuration/feature_profile/sdwan/transport/wan/interface/ipsec.py

@@ -1,98 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from __future__ import annotations
-
-from ipaddress import IPv4Address
-from typing import Literal, Optional, Union
-
-from pydantic import AliasPath, ConfigDict, Field
-
-from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase, as_default
-from catalystwan.models.common import IkeCiphersuite, IkeGroup, IkeMode, IpsecCiphersuite
-from catalystwan.models.configuration.feature_profile.common import AddressWithMask, TunnelApplication
-
-PerfectForwardSecrecy = Literal[
-    "group-1",
-    "group-14",
-    "group-15",
-    "group-16",
-    "group-19",
-    "group-2",
-    "group-20",
-    "group-21",
-    "group-24",
-    "group-5",
-    "none",
-]
-
-
-class InterfaceIpsecParcel(_ParcelBase):
-    model_config = ConfigDict(populate_by_name=True, extra="forbid")
-    type_: Literal["wan/vpn/interface/ipsec"] = Field(default="wan/vpn/interface/ipsec", exclude=True, frozen=True)
-    address: AddressWithMask = Field(validation_alias=AliasPath("data", "address"))
-    application: Union[Variable, Global[TunnelApplication]] = Field(validation_alias=AliasPath("data", "application"))
-    clear_dont_fragment: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=as_default(False), validation_alias=AliasPath("data", "clearDontFragment")
-    )
-    if_description: Union[Variable, Global[str], Default[None]] = Field(
-        default=Default[None](value=None), validation_alias=AliasPath("data", "description")
-    )
-    dpd_interval: Union[Variable, Default[int], Global[int]] = Field(
-        default=as_default(10), validation_alias=AliasPath("data", "dpdInterval")
-    )
-    dpd_retries: Union[Variable, Default[int], Global[int]] = Field(
-        default=as_default(3), validation_alias=AliasPath("data", "dpdRetries")
-    )
-    if_name: Union[Variable, Global[str]] = Field(validation_alias=AliasPath("data", "ifName"))
-    ike_ciphersuite: Union[Variable, Global[IkeCiphersuite], Default[IkeCiphersuite]] = Field(
-        default=as_default("aes256-cbc-sha1", IkeCiphersuite), validation_alias=AliasPath("data", "ikeCiphersuite")
-    )
-    ike_group: Union[Global[IkeGroup], Default[IkeGroup], Variable] = Field(
-        default=as_default("16", IkeGroup), validation_alias=AliasPath("data", "ikeGroup")
-    )
-    ike_local_id: Union[Variable, Global[str], Default[None]] = Field(validation_alias=AliasPath("data", "ikeLocalId"))
-    ike_rekey_interval: Union[Variable, Default[int], Global[int]] = Field(
-        default=as_default(14400), validation_alias=AliasPath("data", "ikeRekeyInterval")
-    )
-    ike_remote_id: Union[Variable, Global[str], Default[None], Global[IPv4Address]] = Field(
-        default=Default[None](value=None), validation_alias=AliasPath("data", "ikeRemoteId")
-    )
-    ike_version: Union[Global[int], Default[int]] = Field(
-        default=as_default(1), validation_alias=AliasPath("data", "ikeVersion")
-    )
-    ipsec_ciphersuite: Union[Variable, Global[IpsecCiphersuite], Default[IpsecCiphersuite]] = Field(
-        default=as_default("aes256-gcm", IpsecCiphersuite), validation_alias=AliasPath("data", "ipsecCiphersuite")
-    )
-    ipsec_rekey_interval: Union[Variable, Default[int], Global[int]] = Field(
-        default=as_default(3600), validation_alias=AliasPath("data", "ipsecRekeyInterval")
-    )
-    ipsec_replay_window: Union[Variable, Default[int], Global[int]] = Field(
-        default=as_default(512), validation_alias=AliasPath("data", "ipsecReplayWindow")
-    )
-    mtu: Union[Variable, Default[int], Global[int]] = Field(
-        default=as_default(1500), validation_alias=AliasPath("data", "mtu")
-    )
-    perfect_forward_secrecy: Union[Variable, Default[PerfectForwardSecrecy], Global[PerfectForwardSecrecy]] = Field(
-        default=as_default("group-16", PerfectForwardSecrecy),
-        validation_alias=AliasPath("data", "perfectForwardSecrecy"),
-    )
-    pre_shared_secret: Union[Variable, Global[str]] = Field(validation_alias=AliasPath("data", "preSharedSecret"))
-    shutdown: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=as_default(True), validation_alias=AliasPath("data", "shutdown")
-    )
-    tcp_mss_adjust: Union[Variable, Global[int], Default[None]] = Field(
-        default=Default[None](value=None), validation_alias=AliasPath("data", "tcpMssAdjust")
-    )
-    tunnel_destination: AddressWithMask = Field(validation_alias=AliasPath("data", "tunnelDestination"))
-    tunnel_source: AddressWithMask = Field(validation_alias=AliasPath("data", "tunnelSource"))
-    ike_mode: Optional[Union[Variable, Global[IkeMode], Default[Literal["main"]]]] = Field(
-        default=None, validation_alias=AliasPath("data", "ikeMode")
-    )
-    tracker: Optional[Union[Variable, Global[str], Default[None]]] = Field(
-        default=None, validation_alias=AliasPath("data", "tracker")
-    )
-    tunnel_route_via: Optional[Union[Variable, Global[str], Default[None]]] = Field(
-        default=None, validation_alias=AliasPath("data", "tunnelRouteVia")
-    )
-    tunnel_source_interface: Optional[Union[Variable, Global[str]]] = Field(
-        default=None, validation_alias=AliasPath("data", "tunnelSourceInterface")
-    )