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

catalystwan/models/policy/{definition → definitions}/traffic_data.py

@@ -1,26 +1,15 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
-from ipaddress import IPv4Address, IPv4Network, IPv6Address, IPv6Network
-from typing import List, Literal, Optional, Set, Tuple, Union, overload
+from ipaddress import IPv4Address, IPv4Network
+from typing import Any, List, Literal, Optional, Set, Tuple, Union, overload
 from uuid import UUID
 
 from pydantic import ConfigDict, Field
 from typing_extensions import Annotated
 
-from catalystwan.models.common import (
-    AcceptDropActionType,
-    DestinationRegion,
-    DNSEntryType,
-    EncapType,
-    IcmpMsgType,
-    SequenceIpType,
-    ServiceChainNumber,
-    ServiceType,
-    TLOCColor,
-    TrafficTargetType,
-)
+from catalystwan.models.common import ServiceChainNumber, TLOCColor
+from catalystwan.models.policy.lists_entries import EncapType
 from catalystwan.models.policy.policy_definition import (
-    ActionSet,
     AppListEntry,
     CFlowDAction,
     CountAction,
@@ -28,7 +17,6 @@ from catalystwan.models.policy.policy_definition import (
     DestinationDataIPv6PrefixListEntry,
     DestinationDataPrefixListEntry,
     DestinationIPEntry,
-    DestinationIPv6Entry,
     DestinationPortEntry,
     DestinationRegionEntry,
     DNSAppListEntry,
@@ -38,7 +26,6 @@ from catalystwan.models.policy.policy_definition import (
     DSCPEntry,
     FallBackToRoutingAction,
     ForwardingClassEntry,
-    ICMPMessageEntry,
     LocalTLOCListEntry,
     LocalTLOCListEntryValue,
     LogAction,
@@ -48,17 +35,13 @@ from catalystwan.models.policy.policy_definition import (
     LossProtectionType,
     Match,
     NATAction,
-    NextHopActionEntry,
-    NextHopIpv6ActionEntry,
+    NextHopEntry,
     NextHopLooseEntry,
     PacketLengthEntry,
     PLPEntry,
-    PLPEntryType,
     PolicerListEntry,
-    PolicyAcceptDropAction,
+    PolicyActionType,
     PolicyDefinitionBase,
-    PolicyDefinitionGetResponse,
-    PolicyDefinitionId,
     PolicyDefinitionSequenceBase,
     PrefferedColorGroupListEntry,
     ProtocolEntry,
@@ -66,13 +49,10 @@ from catalystwan.models.policy.policy_definition import (
     SecureInternetGatewayAction,
     ServiceChainEntry,
     ServiceChainEntryValue,
-    ServiceEntry,
-    ServiceEntryValue,
     ServiceNodeGroupAction,
     SourceDataIPv6PrefixListEntry,
     SourceDataPrefixListEntry,
     SourceIPEntry,
-    SourceIPv6Entry,
     SourcePortEntry,
     TCPEntry,
     TCPOptimizationAction,
@@ -86,50 +66,29 @@ from catalystwan.models.policy.policy_definition import (
 
 TrafficDataPolicySequenceEntry = Annotated[
     Union[
-        AppListEntry,
-        DestinationDataIPv6PrefixListEntry,
-        DestinationDataPrefixListEntry,
-        DestinationIPEntry,
-        DestinationIPv6Entry,
-        DestinationPortEntry,
-        DestinationRegionEntry,
-        DNSAppListEntry,
-        DNSEntry,
-        DSCPEntry,
-        ICMPMessageEntry,
         PacketLengthEntry,
         PLPEntry,
         ProtocolEntry,
-        SourceDataIPv6PrefixListEntry,
-        SourceDataPrefixListEntry,
+        DSCPEntry,
         SourceIPEntry,
-        SourceIPv6Entry,
         SourcePortEntry,
+        DestinationIPEntry,
+        DestinationPortEntry,
         TCPEntry,
+        DNSEntry,
         TrafficToEntry,
+        SourceDataPrefixListEntry,
+        DestinationDataPrefixListEntry,
+        SourceDataIPv6PrefixListEntry,
+        DestinationDataIPv6PrefixListEntry,
+        DestinationRegionEntry,
+        DNSAppListEntry,
+        AppListEntry,
     ],
     Field(discriminator="field"),
 ]
 
-TrafficDataPolicySequenceActionEntry = Annotated[
-    Union[
-        ActionSet,
-        CFlowDAction,
-        CountAction,
-        DREOptimizationAction,
-        FallBackToRoutingAction,
-        LogAction,
-        LossProtectionAction,
-        LossProtectionFECAction,
-        LossProtectionPacketDuplicationAction,
-        NATAction,
-        RedirectDNSAction,
-        SecureInternetGatewayAction,
-        ServiceNodeGroupAction,
-        TCPOptimizationAction,
-    ],
-    Field(discriminator="type"),
-]
+TrafficDataPolicySequenceActions = Any  # TODO
 
 
 class TrafficDataPolicyHeader(PolicyDefinitionBase):
@@ -141,61 +100,63 @@ class TrafficDataPolicySequenceMatch(Match):
 
 
 class TrafficDataPolicySequence(PolicyDefinitionSequenceBase):
-    sequence_type: Literal["applicationFirewall", "qos", "serviceChaining", "trafficEngineering", "data"] = Field(
+    sequence_type: Literal["data"] = Field(
         default="data", serialization_alias="sequenceType", validation_alias="sequenceType"
     )
-    base_action: AcceptDropActionType = Field(serialization_alias="baseAction", validation_alias="baseAction")
     match: TrafficDataPolicySequenceMatch = TrafficDataPolicySequenceMatch()
-    actions: List[TrafficDataPolicySequenceActionEntry] = []
+    actions: List[TrafficDataPolicySequenceActions] = []
     model_config = ConfigDict(populate_by_name=True)
 
     def match_app_list(self, app_list_id: UUID) -> None:
-        self._insert_match(AppListEntry(ref=[app_list_id]))
+        self._insert_match(AppListEntry(ref=app_list_id))
 
     def match_dns_app_list(self, dns_app_list_id: UUID) -> None:
         self._insert_match(DNSAppListEntry(ref=dns_app_list_id))
 
-    def match_dns(self, dns: DNSEntryType) -> None:
-        self._insert_match(DNSEntry(value=dns))
+    def match_dns_request(self) -> None:
+        self._insert_match(DNSEntry(value="request"))
 
-    def match_dscp(self, dscp: List[int]) -> None:
-        self._insert_match(DSCPEntry(value=dscp))
+    def match_dns_response(self) -> None:
+        self._insert_match(DNSEntry(value="response"))
 
-    def match_icmp(self, icmp_message_types: List[IcmpMsgType]) -> None:
-        self._insert_match(ICMPMessageEntry(value=icmp_message_types))
+    def match_dscp(self, dscp: int) -> None:
+        self._insert_match(DSCPEntry(value=str(dscp)))
 
     def match_packet_length(self, packet_lengths: Tuple[int, int]) -> None:
         self._insert_match(PacketLengthEntry.from_range(packet_lengths))
 
-    def match_plp(self, plp: PLPEntryType) -> None:
-        self._insert_match(PLPEntry(value=plp))
+    def match_low_plp(self) -> None:
+        self._insert_match(PLPEntry(value="low"))
+
+    def match_high_plp(self) -> None:
+        self._insert_match(PLPEntry(value="high"))
 
     def match_protocols(self, protocols: Set[int]) -> None:
         self._insert_match(ProtocolEntry.from_protocol_set(protocols))
 
     def match_source_data_prefix_list(self, data_prefix_list_id: UUID) -> None:
-        self._insert_match(SourceDataPrefixListEntry(ref=[data_prefix_list_id]))
+        self._insert_match(SourceDataPrefixListEntry(ref=data_prefix_list_id))
 
     def match_source_ip(self, networks: List[IPv4Network]) -> None:
         self._insert_match(SourceIPEntry.from_ipv4_networks(networks))
 
-    def match_source_ipv6(self, networks: List[IPv6Network]) -> None:
-        self._insert_match(SourceIPv6Entry.from_ipv6_networks(networks))
-
     def match_source_port(self, ports: Set[int] = set(), port_ranges: List[Tuple[int, int]] = []) -> None:
         self._insert_match(SourcePortEntry.from_port_set_and_ranges(ports, port_ranges))
 
     def match_destination_data_prefix_list(self, data_prefix_list_id: UUID) -> None:
-        self._insert_match(DestinationDataPrefixListEntry(ref=[data_prefix_list_id]))
+        self._insert_match(DestinationDataPrefixListEntry(ref=data_prefix_list_id))
 
     def match_destination_ip(self, networks: List[IPv4Network]) -> None:
         self._insert_match(DestinationIPEntry.from_ipv4_networks(networks))
 
-    def match_destination_ipv6(self, networks: List[IPv6Network]) -> None:
-        self._insert_match(DestinationIPv6Entry.from_ipv6_networks(networks))
+    def match_primary_destination_region(self) -> None:
+        self._insert_match(DestinationRegionEntry(value="primary-region"))
 
-    def match_destination_region(self, region: DestinationRegion) -> None:
-        self._insert_match(DestinationRegionEntry(value=region))
+    def match_secondary_destination_region(self) -> None:
+        self._insert_match(DestinationRegionEntry(value="secondary-region"))
+
+    def match_other_destination_region(self) -> None:
+        self._insert_match(DestinationRegionEntry(value="other-region"))
 
     def match_destination_port(self, ports: Set[int] = set(), port_ranges: List[Tuple[int, int]] = []) -> None:
         self._insert_match(DestinationPortEntry.from_port_set_and_ranges(ports, port_ranges))
@@ -203,8 +164,14 @@ class TrafficDataPolicySequence(PolicyDefinitionSequenceBase):
     def match_tcp(self) -> None:
         self._insert_match(TCPEntry())
 
-    def match_traffic_to(self, traffic_to: TrafficTargetType) -> None:
-        self._insert_match(TrafficToEntry(value=traffic_to))
+    def match_traffic_to_access(self) -> None:
+        self._insert_match(TrafficToEntry(value="access"))
+
+    def match_traffic_to_core(self) -> None:
+        self._insert_match(TrafficToEntry(value="core"))
+
+    def match_traffic_to_service(self) -> None:
+        self._insert_match(TrafficToEntry(value="service"))
 
     def associate_count_action(self, counter_name: str) -> None:
         self._insert_action(CountAction(parameter=counter_name))
@@ -214,14 +181,14 @@ class TrafficDataPolicySequence(PolicyDefinitionSequenceBase):
 
     @accept_action
     def associate_dscp_action(self, dscp: int) -> None:
-        self._insert_action_in_set(DSCPEntry(value=[dscp]))
+        self._insert_action_in_set(DSCPEntry(value=str(dscp)))
 
     @accept_action
     def associate_forwarding_class_action(self, fwclass: str) -> None:
         self._insert_action_in_set(ForwardingClassEntry(value=fwclass))
 
     @accept_action
-    def associate_local_tloc_action(self, color: List[TLOCColor], encap: EncapType, restrict: bool = False) -> None:
+    def associate_local_tloc_action(self, color: TLOCColor, encap: EncapType, restrict: bool = False) -> None:
         tloc_entry = LocalTLOCListEntry(
             value=LocalTLOCListEntryValue(
                 color=color,
@@ -240,47 +207,25 @@ class TrafficDataPolicySequence(PolicyDefinitionSequenceBase):
         self._insert_action(CFlowDAction())
 
     @overload
-    def associate_nat_action(self, *, nat_pool: int = 0) -> None:
+    def associate_nat_action(self, *, nat_pool: int) -> None:
         ...
 
     @overload
-    def associate_nat_action(
-        self,
-        *,
-        use_vpn: int = 0,
-        fallback: bool = False,
-        bypass: bool = False,
-        dia_pool: List[int] = [],
-        dia_interface: List[str] = []
-    ) -> None:
+    def associate_nat_action(self, *, vpn_fallback: bool = False, vpn: int = 0) -> None:
         ...
 
     @accept_action
-    def associate_nat_action(
-        self,
-        *,
-        nat_pool: Optional[int] = None,
-        use_vpn: int = 0,
-        fallback: bool = False,
-        bypass: bool = False,
-        dia_pool: List[int] = [],
-        dia_interface: List[str] = []
-    ) -> None:
+    def associate_nat_action(self, *, nat_pool: Optional[int] = None, vpn_fallback: bool = False, vpn: int = 0) -> None:
         if nat_pool:
             nat_action = NATAction.from_nat_pool(nat_pool=nat_pool)
         else:
-            nat_action = NATAction.from_nat_vpn(
-                use_vpn=use_vpn, fallback=fallback, bypass=bypass, dia_pool=dia_pool, dia_interface=dia_interface
-            )
+            nat_action = NATAction.from_nat_vpn(fallback=vpn_fallback, vpn=vpn)
         self._insert_action(nat_action)
 
     @accept_action
-    def associate_next_hop_action(self, next_hop: Union[IPv4Address, IPv6Address], loose: bool = False) -> None:
-        if isinstance(next_hop, IPv6Address):
-            self._insert_action_in_set(NextHopIpv6ActionEntry(value=next_hop))
-        else:
-            self._insert_action_in_set(NextHopActionEntry(value=next_hop))
-        self._insert_action_in_set(NextHopLooseEntry(value=loose))
+    def associate_next_hop_action(self, next_hop: IPv4Address, loose: bool = False) -> None:
+        self._insert_action_in_set(NextHopEntry(value=next_hop))
+        self._insert_action_in_set(NextHopLooseEntry(value="true" if loose else "false"))
 
     @accept_action
     def associate_policer_list_action(self, policer_list_id: UUID) -> None:
@@ -411,86 +356,18 @@ class TrafficDataPolicySequence(PolicyDefinitionSequenceBase):
         else:
             self._remove_action(FallBackToRoutingAction().type)
 
-    @overload
-    def associate_service_action(
-        self,
-        service_type: ServiceType,
-        vpn: Optional[int] = None,
-        *,
-        tloc_list_id: UUID,
-        local: bool = False,
-        restrict: bool = False
-    ) -> None:
-        ...
-
-    @overload
-    def associate_service_action(
-        self,
-        service_type: ServiceType,
-        vpn: int,
-        *,
-        ip: IPv4Address,
-        color: TLOCColor,
-        encap: EncapType,
-        local: bool = False,
-        restrict: bool = False
-    ) -> None:
-        ...
-
-    @accept_action
-    def associate_service_action(
-        self,
-        service_type=None,
-        vpn=None,
-        *,
-        tloc_list_id=None,
-        ip=None,
-        color=None,
-        encap=None,
-        local=None,
-        restrict=None
-    ) -> None:
-        if tloc_list_id is None:
-            tloc_entry = TLOCEntryValue(ip=ip, color=color, encap=encap)
-            tloc_list_entry = None
-        else:
-            tloc_entry = None
-            tloc_list_entry = TLOCListEntry(ref=tloc_list_id)
-        _local = "" if local else None
-        _restrict = "" if restrict else None
-        service_value = ServiceEntryValue(
-            type=service_type, vpn=vpn, tloc=tloc_entry, tloc_list=tloc_list_entry, local=_local, restrict=_restrict
-        )
-        self._insert_action_in_set(ServiceEntry(value=service_value))
-
 
 class TrafficDataPolicy(TrafficDataPolicyHeader, DefinitionWithSequencesCommonBase):
     sequences: List[TrafficDataPolicySequence] = []
-    default_action: PolicyAcceptDropAction = Field(
-        default=PolicyAcceptDropAction(type="drop"),
-        serialization_alias="defaultAction",
-        validation_alias="defaultAction",
-    )
     model_config = ConfigDict(populate_by_name=True)
 
-    def add_sequence(
-        self,
-        name: str = "Custom",
-        base_action: AcceptDropActionType = "drop",
-        sequence_ip_type: SequenceIpType = "ipv4",
+    def add_ipv4_sequence(
+        self, name: str = "Custom", base_action: PolicyActionType = "drop", log: bool = False
     ) -> TrafficDataPolicySequence:
         seq = TrafficDataPolicySequence(
             sequence_name=name,
             base_action=base_action,
-            sequence_ip_type=sequence_ip_type,
+            sequence_ip_type="ipv4",
         )
         self.add(seq)
         return seq
-
-
-class TrafficDataPolicyEditPayload(TrafficDataPolicy, PolicyDefinitionId):
-    pass
-
-
-class TrafficDataPolicyGetResponse(TrafficDataPolicy, PolicyDefinitionGetResponse):
-    pass

catalystwan/models/policy/{definition → definitions}/vpn_membership.py

@@ -5,11 +5,7 @@ from uuid import UUID
 
 from pydantic import BaseModel, ConfigDict, Field
 
-from catalystwan.models.policy.policy_definition import (
-    PolicyDefinitionBase,
-    PolicyDefinitionGetResponse,
-    PolicyDefinitionId,
-)
+from catalystwan.models.policy.policy_definition import PolicyDefinitionBase
 
 
 class Site(BaseModel):
@@ -32,11 +28,3 @@ class VPNMembershipPolicy(PolicyDefinitionBase):
         site = Site(site_list=site_list, vpn_list=vpn_lists)
         self.definition.sites.append(site)
         return site
-
-
-class VPNMembershipPolicyEditPayload(VPNMembershipPolicy, PolicyDefinitionId):
-    pass
-
-
-class VPNMembershipPolicyGetResponse(VPNMembershipPolicy, PolicyDefinitionGetResponse):
-    pass