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

catalystwan/models/policy/list/geo_location.py

@@ -0,0 +1,33 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Optional
+
+from pydantic import BaseModel, Field, model_validator
+
+from catalystwan.models.common import check_fields_exclusive
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class GeoLocationListEntry(BaseModel):
+    country: Optional[str] = Field(default=None, description="ISO-3166 alpha-3 country code eg: FRA")
+    continent: Optional[str] = Field(
+        default=None, description="One of 2-letter continent codes: AF, NA, OC, AN, AS, EU, SA"
+    )
+
+    @model_validator(mode="after")
+    def check_country_xor_continent(self):
+        check_fields_exclusive(self.__dict__, {"country", "continent"}, True)
+        return self
+
+
+class GeoLocationList(PolicyListBase):
+    type: Literal["geoLocation"] = "geoLocation"
+    entries: List[GeoLocationListEntry] = []
+
+
+class GeoLocationListEditPayload(GeoLocationList, PolicyListId):
+    pass
+
+
+class GeoLocationListInfo(GeoLocationList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/identity.py

@@ -0,0 +1,29 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class IdentityListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    user: str
+    user_group: str = Field(validation_alias="userGroup", serialization_alias="userGroup")
+
+
+class IdentityList(PolicyListBase):
+    type: Literal["identity"] = "identity"
+    entries: List[IdentityListEntry] = Field(default_factory=list)
+
+    def add_entry(self, user: str, user_group: str) -> None:
+        self._add_entry(IdentityListEntry(user=user, user_group=user_group))
+
+
+class IdentityListEditPayload(IdentityList, PolicyListId):
+    pass
+
+
+class IdentityListInfo(IdentityList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/ips_signature.py

@@ -0,0 +1,27 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class IPSSignatureListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    generator_id: str = Field(serialization_alias="generatorId", validation_alias="generatorId")
+    signature_id: str = Field(serialization_alias="signatureId", validation_alias="signatureId")
+
+
+class IPSSignatureList(PolicyListBase):
+    type: Literal["ipsSignature"] = "ipsSignature"
+    entries: List[IPSSignatureListEntry] = []
+
+
+class IPSSignatureListEditPayload(IPSSignatureList, PolicyListId):
+    pass
+
+
+class IPSSignatureListInfo(IPSSignatureList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/ipv6_prefix.py

@@ -0,0 +1,33 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from ipaddress import IPv6Interface
+from typing import List, Literal, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.common import IntStr
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class IPv6PrefixListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    ipv6_prefix: IPv6Interface = Field(serialization_alias="ipv6Prefix", validation_alias="ipv6Prefix")
+    ge: Optional[IntStr] = Field(default=None, ge=0, le=128)
+    le: Optional[IntStr] = Field(default=None, ge=0, le=128)
+
+
+class IPv6PrefixList(PolicyListBase):
+    type: Literal["ipv6prefix"] = "ipv6prefix"
+    entries: List[IPv6PrefixListEntry] = []
+
+    def add_prefix(self, prefix: IPv6Interface, ge: Optional[int] = None, le: Optional[int] = None) -> None:
+        self._add_entry(IPv6PrefixListEntry(ipv6_prefix=prefix, ge=ge, le=le))
+
+
+class IPv6PrefixListEditPayload(IPv6PrefixList, PolicyListId):
+    pass
+
+
+class IPv6PrefixListInfo(IPv6PrefixList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/local_app.py

@@ -0,0 +1,45 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Optional
+
+from pydantic import BaseModel, ConfigDict, Field, model_validator
+
+from catalystwan.models.common import check_fields_exclusive
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class LocalAppListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    app_family: Optional[str] = Field(default=None, serialization_alias="appFamily", validation_alias="appFamily")
+    app: Optional[str] = None
+
+    @model_validator(mode="after")
+    def check_app_xor_appfamily(self):
+        check_fields_exclusive(self.__dict__, {"app", "app_family"}, True)
+        return self
+
+
+class LocalAppList(PolicyListBase):
+    type: Literal["localApp"] = "localApp"
+    entries: List[LocalAppListEntry] = []
+
+    def add_app(self, app: str) -> None:
+        self._add_entry(LocalAppListEntry(app=app))
+
+    def add_app_family(self, app_family: str) -> None:
+        self._add_entry(LocalAppListEntry(app_family=app_family))
+
+    def list_all_app(self) -> List[str]:
+        return [e.app for e in self.entries if e.app is not None]
+
+    def list_all_app_family(self) -> List[str]:
+        return [e.app_family for e in self.entries if e.app_family is not None]
+
+
+class LocalAppListEditPayload(LocalAppList, PolicyListId):
+    pass
+
+
+class LocalAppListInfo(LocalAppList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/local_domain.py

@@ -0,0 +1,36 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class LocalDomainListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    name_server: str = Field(
+        pattern="^[^*+].*",
+        serialization_alias="nameServer",
+        validation_alias="nameServer",
+        max_length=240,
+        description="Must be valid std regex."
+        "String cannot start with a '*' or a '+', be empty, or be more than 240 characters",
+    )
+
+
+class LocalDomainList(PolicyListBase):
+    type: Literal["localDomain"] = "localDomain"
+    entries: List[LocalDomainListEntry] = []
+
+    def add_domain(self, name_server: str) -> None:
+        self.entries.append(LocalDomainListEntry(name_server=name_server))
+
+
+class LocalDomainListEditPayload(LocalDomainList, PolicyListId):
+    pass
+
+
+class LocalDomainListInfo(LocalDomainList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/media_profile.py

@@ -0,0 +1,44 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Union
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing_extensions import Annotated
+
+from catalystwan.models.common import IntStr, SpaceSeparatedMpDtmfList
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class CodecEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    type: Literal["codec"] = "codec"
+    pref_num: IntStr = Field(ge=1, serialization_alias="prefNum", validation_alias="prefNum")
+    value: str
+
+
+class DtmfEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    type: Literal["dtmf"] = "dtmf"
+    value: SpaceSeparatedMpDtmfList
+
+
+AnyMediaProfileListEntry = Annotated[
+    Union[
+        CodecEntry,
+        DtmfEntry,
+    ],
+    Field(discriminator="type"),
+]
+
+
+class MediaProfileList(PolicyListBase):
+    type: Literal["mediaProfile", "mediaprofile"] = "mediaProfile"
+    entries: List[AnyMediaProfileListEntry] = Field(default_factory=list)
+
+
+class MediaProfileListEditPayload(MediaProfileList, PolicyListId):
+    pass
+
+
+class MediaProfileListInfo(MediaProfileList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/mirror.py

@@ -0,0 +1,27 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal
+
+from pydantic import BaseModel, ConfigDict, Field, IPvAnyAddress
+
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class MirrorListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    remote_dest: IPvAnyAddress = Field(serialization_alias="remoteDest", validation_alias="remoteDest")
+    source: IPvAnyAddress
+
+
+class MirrorList(PolicyListBase):
+    type: Literal["mirror"] = "mirror"
+    entries: List[MirrorListEntry] = []
+
+
+class MirrorListEditPayload(MirrorList, PolicyListId):
+    pass
+
+
+class MirrorListInfo(MirrorList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/modem_pass_through.py

@@ -0,0 +1,27 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.common import FaxFallBackProtocols
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class ModemPassThroughListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+    protocol: FaxFallBackProtocols
+
+
+class ModemPassThroughList(PolicyListBase):
+    model_config = ConfigDict(populate_by_name=True)
+    type: Literal["modemPassthrough", "modempassthrough"] = "modemPassthrough"
+    entries: List[ModemPassThroughListEntry] = Field(default_factory=list, max_length=1)
+
+
+class ModemPassThroughListEditPayload(ModemPassThroughList, PolicyListId):
+    pass
+
+
+class ModemPassThroughListInfo(ModemPassThroughList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/policer.py

@@ -0,0 +1,39 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.common import IntStr
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+PolicerExceedAction = Literal[
+    "drop",
+    "remark",
+]
+
+
+class PolicerListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    burst: IntStr = Field(description="bytes", ge=15_000, le=10_000_000)
+    exceed: PolicerExceedAction = "drop"
+    rate: IntStr = Field(description="bps", ge=8, le=100_000_000_000)
+
+
+class PolicerList(PolicyListBase):
+    type: Literal["policer"] = "policer"
+    entries: List[PolicerListEntry] = []
+
+    def police(self, burst: int, rate: int, exceed: PolicerExceedAction = "drop") -> None:
+        # Policer list must have only single entry!
+        entry = PolicerListEntry(burst=burst, exceed=exceed, rate=rate)
+        self._add_entry(entry, single=True)
+
+
+class PolicerListEditPayload(PolicerList, PolicyListId):
+    pass
+
+
+class PolicerListInfo(PolicerList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/port.py

@@ -0,0 +1,33 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal
+
+from pydantic import BaseModel, field_validator
+
+from catalystwan.models.common import IntRangeStr
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class PortListEntry(BaseModel):
+    port: IntRangeStr
+
+    @field_validator("port")
+    @classmethod
+    def check_port(cls, port: IntRangeStr):
+        for i in port:
+            if i is not None:
+                assert 0 <= i <= 65_535
+        return port
+
+
+class PortList(PolicyListBase):
+    type: Literal["port"] = "port"
+    entries: List[PortListEntry] = []
+
+
+class PortListEditPayload(PortList, PolicyListId):
+    pass
+
+
+class PortListInfo(PortList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/preferred_color_group.py

@@ -0,0 +1,82 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Optional, Set, Tuple
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
+
+from catalystwan.models.common import TLOCColor, str_as_str_list
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+PathPreference = Literal[
+    "direct-path",
+    "multi-hop-path",
+    "all-paths",
+]
+
+
+class ColorGroupPreference(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    color_preference: Set[TLOCColor] = Field(serialization_alias="colorPreference", validation_alias="colorPreference")
+    path_preference: Optional[PathPreference] = Field(
+        default=None, serialization_alias="pathPreference", validation_alias="pathPreference"
+    )
+
+    _color_pref = field_validator("color_preference", mode="before")(str_as_str_list)
+
+    @staticmethod
+    def from_color_set_and_path(
+        color_preference: Set[TLOCColor], path_preference: Optional[PathPreference] = None
+    ) -> "ColorGroupPreference":
+        return ColorGroupPreference(color_preference=color_preference, path_preference=path_preference)
+
+
+class PreferredColorGroupListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    primary_preference: ColorGroupPreference = Field(
+        serialization_alias="primaryPreference", validation_alias="primaryPreference"
+    )
+    secondary_preference: Optional[ColorGroupPreference] = Field(
+        default=None, serialization_alias="secondaryPreference", validation_alias="secondaryPreference"
+    )
+    tertiary_preference: Optional[ColorGroupPreference] = Field(
+        default=None, serialization_alias="tertiaryPreference", validation_alias="tertiaryPreference"
+    )
+
+    @model_validator(mode="after")
+    def check_optional_preferences_order(self):
+        assert not (self.secondary_preference is None and self.tertiary_preference is not None)
+        return self
+
+
+class PreferredColorGroupList(PolicyListBase):
+    type: Literal["preferredColorGroup"] = "preferredColorGroup"
+    entries: List[PreferredColorGroupListEntry] = []
+
+    def assign_color_groups(
+        self,
+        primary: Tuple[Set[TLOCColor], Optional[PathPreference]],
+        secondary: Optional[Tuple[Set[TLOCColor], Optional[PathPreference]]] = None,
+        tertiary: Optional[Tuple[Set[TLOCColor], Optional[PathPreference]]] = None,
+    ) -> PreferredColorGroupListEntry:
+        primary_preference = ColorGroupPreference.from_color_set_and_path(*primary)
+        secondary_preference = (
+            ColorGroupPreference.from_color_set_and_path(*secondary) if secondary is not None else None
+        )
+        tertiary_preference = ColorGroupPreference.from_color_set_and_path(*tertiary) if tertiary is not None else None
+        entry = PreferredColorGroupListEntry(
+            primary_preference=primary_preference,
+            secondary_preference=secondary_preference,
+            tertiary_preference=tertiary_preference,
+        )
+        self._add_entry(entry=entry, single=True)
+        return entry
+
+
+class PreferredColorGroupListEditPayload(PreferredColorGroupList, PolicyListId):
+    pass
+
+
+class PreferredColorGroupListInfo(PreferredColorGroupList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/prefix.py

@@ -0,0 +1,33 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from ipaddress import IPv4Network
+from typing import List, Literal, Optional
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.common import IntStr
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class PrefixListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    ip_prefix: IPv4Network = Field(serialization_alias="ipPrefix", validation_alias="ipPrefix")
+    ge: Optional[IntStr] = Field(default=None, ge=0, le=32)
+    le: Optional[IntStr] = Field(default=None, ge=0, le=32)
+
+
+class PrefixList(PolicyListBase):
+    type: Literal["prefix"] = "prefix"
+    entries: List[PrefixListEntry] = []
+
+    def add_prefix(self, prefix: IPv4Network, ge: Optional[int] = None, le: Optional[int] = None) -> None:
+        self._add_entry(PrefixListEntry(ip_prefix=prefix, ge=ge, le=le))
+
+
+class PrefixListEditPayload(PrefixList, PolicyListId):
+    pass
+
+
+class PrefixListInfo(PrefixList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/protocol_name.py

@@ -0,0 +1,26 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class ProtocolNameListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    protocol_name: str = Field(serialization_alias="protocolName", validation_alias="protocolName")
+
+
+class ProtocolNameList(PolicyListBase):
+    type: Literal["protocolName"] = "protocolName"
+    entries: List[ProtocolNameListEntry] = []
+
+
+class ProtocolNameListEditPayload(ProtocolNameList, PolicyListId):
+    pass
+
+
+class ProtocolNameListInfo(ProtocolNameList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/region.py

@@ -0,0 +1,45 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Set, Tuple
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator
+
+from catalystwan.models.common import IntRangeStr
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class RegionListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    region_id: IntRangeStr = Field(
+        serialization_alias="regionId", validation_alias="regionId", description="Number in range 0-63"
+    )
+
+    @field_validator("region_id")
+    @classmethod
+    def check_region_range(cls, region_ids: IntRangeStr):
+        for i in region_ids:
+            if i is not None:
+                assert 0 <= i <= 63
+        return region_ids
+
+
+class RegionList(PolicyListBase):
+    type: Literal["region"] = "region"
+    entries: List[RegionListEntry] = []
+
+    def add_regions(self, regions: Set[int]):
+        for region in regions:
+            self._add_entry(RegionListEntry(region_id=(region, None)))
+
+    def add_region_range(self, region_range: Tuple[int, int]):
+        entry = RegionListEntry(region_id=region_range)
+        self._add_entry(entry)
+
+
+class RegionListEditPayload(RegionList, PolicyListId):
+    pass
+
+
+class RegionListInfo(RegionList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/scalable_group_tag.py

@@ -0,0 +1,30 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class ScalableGroupTagListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    sgt_name: str = Field(serialization_alias="sgtName", validation_alias="sgtName")
+    tag: str = Field(serialization_alias="tag", validation_alias="tag")
+
+
+class ScalableGroupTagList(PolicyListBase):
+    type: Literal["scalablegrouptag", "scalableGroupTag"] = "scalableGroupTag"
+    entries: List[ScalableGroupTagListEntry] = Field(default_factory=list)
+
+    def add_entry(self, sgt_name: str, tag: str) -> None:
+        self._add_entry(ScalableGroupTagListEntry(sgt_name=sgt_name, tag=tag))
+
+
+class ScalableGroupTagListEditPayload(ScalableGroupTagList, PolicyListId):
+    pass
+
+
+class ScalableGroupTagListInfo(ScalableGroupTagList, PolicyListInfo):
+    pass

catalystwan/models/policy/list/site.py

@@ -0,0 +1,34 @@
+# Copyright 2022 Cisco Systems, Inc. and its affiliates
+
+from typing import List, Literal, Set, Tuple
+
+from pydantic import BaseModel, ConfigDict, Field
+
+from catalystwan.models.policy.policy_list import PolicyListBase, PolicyListId, PolicyListInfo
+
+
+class SiteListEntry(BaseModel):
+    model_config = ConfigDict(populate_by_name=True)
+
+    site_id: str = Field(serialization_alias="siteId", validation_alias="siteId")
+
+
+class SiteList(PolicyListBase):
+    type: Literal["site"] = "site"
+    entries: List[SiteListEntry] = []
+
+    def add_sites(self, sites: Set[int]):
+        for site in sites:
+            self._add_entry(SiteListEntry(site_id=str(site)))
+
+    def add_site_range(self, site_range: Tuple[int, int]):
+        entry = SiteListEntry(site_id=f"{site_range[0]}-{site_range[1]}")
+        self._add_entry(entry)
+
+
+class SiteListEditPayload(SiteList, PolicyListId):
+    pass
+
+
+class SiteListInfo(SiteList, PolicyListInfo):
+    pass