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

catalystwan/models/configuration/network_hierarchy/cflowd.py

@@ -1,128 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from typing import List, Literal, Optional
-
-from pydantic import AliasPath, BaseModel, ConfigDict, Field
-
-from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase, as_optional_global
-
-Protocol = Literal[
-    "both",
-    "ipv4",
-    "ipv6",
-]
-
-
-class CustomizedIpv4RecordFields(BaseModel):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-    collect_dscp_output: Optional[Global[bool]] = Field(
-        default=Global[bool](value=False), validation_alias="collectDscpOutput", serialization_alias="collectDscpOutput"
-    )
-    collect_tos: Optional[Global[bool]] = Field(
-        default=Global[bool](value=False), validation_alias="collectTos", serialization_alias="collectTos"
-    )
-
-
-class Collectors(BaseModel):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-    address: Optional[Global[str]] = Field(default=None)
-    bfd_metrics_export: Optional[Global[bool]] = Field(
-        default=Global[bool](value=False), validation_alias="bfdMetricsExport", serialization_alias="bfdMetricsExport"
-    )
-    export_interval: Optional[Global[int]] = Field(
-        default=None, validation_alias="exportInterval", serialization_alias="exportInterval"
-    )
-    export_spread: Optional[Global[bool]] = Field(
-        default=Global[bool](value=False), validation_alias="exportSpread", serialization_alias="exportSpread"
-    )
-    udp_port: Optional[Global[int]] = Field(
-        default=Global[int](value=4739), validation_alias="udpPort", serialization_alias="udpPort"
-    )
-    vpn_id: Optional[Global[int]] = Field(default=None, validation_alias="vpnId", serialization_alias="vpnId")
-
-
-class CflowdParcel(_ParcelBase):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-    type_: Literal["cflowd"] = Field(default="cflowd", exclude=True)
-    parcel_name: str = Field(
-        default="Cflowd",
-        exclude=True,
-        description="This field is not defined for this model",
-        serialization_alias="name",
-        validation_alias="name",
-    )
-    collect_tloc_loopback: Optional[Global[bool]] = Field(
-        default=Global[bool](value=False), validation_alias=AliasPath("data", "collectTlocLoopback")
-    )
-    collectors: Optional[List[Collectors]] = Field(
-        default=None, description="Collectors list", validation_alias=AliasPath("data", "collectors")
-    )
-    customized_ipv4_record_fields: Optional[CustomizedIpv4RecordFields] = Field(
-        default=None,
-        validation_alias=AliasPath("data", "customizedIpv4RecordFields"),
-        description="Custom IPV4 flow record fields",
-    )
-    flow_active_timeout: Optional[Global[int]] = Field(
-        default=Global[int](value=600), validation_alias=AliasPath("data", "flowActiveTimeout")
-    )
-    flow_inactive_timeout: Optional[Global[int]] = Field(
-        default=Global[int](value=60), validation_alias=AliasPath("data", "flowInactiveTimeout")
-    )
-    flow_refresh_time: Optional[Global[int]] = Field(
-        default=Global[int](value=600), validation_alias=AliasPath("data", "flowRefreshTime")
-    )
-    flow_sampling_interval: Optional[Global[int]] = Field(
-        default=Global[int](value=1), validation_alias=AliasPath("data", "flowSamplingInterval")
-    )
-    protocol: Optional[Global[Protocol]] = Field(
-        default=Global[Protocol](value="ipv4"), validation_alias=AliasPath("data", "protocol")
-    )
-
-    def add_collector(
-        self,
-        address: Optional[str] = None,
-        bfd_metrics_export: Optional[bool] = False,
-        export_interval: Optional[int] = None,
-        export_spread: Optional[bool] = False,
-        udp_port: Optional[int] = 4739,
-        vpn_id: Optional[int] = None,
-    ):
-        if self.collectors is None:
-            self.collectors = []
-        if export_interval is not None:
-            # bfd_metrics_export must be True if export_interval is set
-            bfd_metrics_export = True
-        if bfd_metrics_export and export_interval is None:
-            # export_interval should be default 600 only if bfd_metrics_export is True
-            export_interval = 600
-
-        self.collectors.append(
-            Collectors(
-                address=as_optional_global(address),
-                udp_port=as_optional_global(udp_port),
-                vpn_id=as_optional_global(vpn_id),
-                export_spread=as_optional_global(export_spread),
-                bfd_metrics_export=as_optional_global(bfd_metrics_export),
-                export_interval=as_optional_global(export_interval),
-            )
-        )
-
-    def set_customized_ipv4_record_fields(self, collect_dscp_output: bool = False, collect_tos: bool = False):
-        self.customized_ipv4_record_fields = CustomizedIpv4RecordFields(
-            collect_dscp_output=Global[bool](value=collect_dscp_output),
-            collect_tos=Global[bool](value=collect_tos),
-        )
-
-    def set_flow(
-        self,
-        active_timeout: Optional[int],
-        inactive_timeout: Optional[int],
-        refresh_time: Optional[int],
-        sampling_interval: Optional[int],
-    ):
-        self.flow_active_timeout = Global[int](value=active_timeout or 600)
-        self.flow_inactive_timeout = Global[int](value=inactive_timeout or 60)
-        self.flow_refresh_time = Global[int](value=refresh_time or 600)
-        self.flow_sampling_interval = Global[int](value=sampling_interval or 1)
-
-    def set_protocol(self, protocol: Protocol):
-        self.protocol = Global[Protocol](value=protocol)

catalystwan/models/configuration/network_hierarchy/node.py

@@ -1,88 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from typing import Literal, Optional
-from uuid import UUID
-
-from pydantic import BaseModel, ConfigDict, Field, model_validator
-
-from catalystwan.models.common import check_fields_exclusive
-
-Label = Literal[
-    "GLOBAL",
-    "REGION",
-    "SITE",
-    "SUB_REGION",
-]
-
-
-class HierarchyId(BaseModel):
-    model_config = ConfigDict(populate_by_name=True, validate_assignment=True)
-    site_id: Optional[int] = Field(
-        ge=0,
-        le=4294967295,
-        default=None,
-        validation_alias="siteId",
-        serialization_alias="siteId",
-        description="Site ID",
-    )
-    region_id: Optional[int] = Field(
-        ge=0, le=63, default=None, validation_alias="regionId", serialization_alias="regionId", description="Region ID"
-    )
-    sub_region_id: Optional[int] = Field(
-        ge=0,
-        le=63,
-        default=None,
-        validation_alias="subRegionId",
-        serialization_alias="subRegionId",
-        description="Sub Region ID",
-    )
-
-    @model_validator(mode="after")
-    def one_of_site_region_subregion(self):
-        check_fields_exclusive(self.__dict__, {"site_id", "region_id", "sub_region_id"}, True)
-        return self
-
-
-class Address(BaseModel):
-    city: str
-    country: str
-    state: str
-    street: str
-    zipcode: str
-
-
-class GpsLocation(BaseModel):
-    latitude: float = Field(ge=-90, le=90, description="Set the site physical latitude")
-    longitude: float = Field(ge=-180, le=180, description="Set the site physical longitude")
-
-
-class Node(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    address: Optional[Address] = Field(default=None, description="Site Address")
-    gps_location: Optional[GpsLocation] = Field(
-        default=None, validation_alias="gpsLocation", serialization_alias="gpsLocation"
-    )
-    hierarchy_id: Optional[HierarchyId] = Field(
-        default=None, validation_alias="hierarchyId", serialization_alias="hierarchyId"
-    )
-    is_secondary: Optional[bool] = Field(
-        default=None,
-        validation_alias="isSecondary",
-        serialization_alias="isSecondary",
-    )
-    label: Optional[Label] = Field(default=None)
-    parent_uuid: Optional[UUID] = Field(
-        default=None, validation_alias="parentUuid", serialization_alias="parentUuid", description="Parent UUID"
-    )
-
-
-class NodeInfo(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    data: Node
-    description: Optional[str] = None
-    direct_child_count: int = Field(validation_alias="directChildCount", serialization_alias="directChildCount")
-    hierarchy_path: Optional[str] = Field(
-        default=None, validation_alias="hierarchyPath", serialization_alias="hierarchyPath"
-    )
-    id: str
-    name: str
-    uuid: Optional[UUID] = None

catalystwan/models/configuration/network_hierarchy/security_logging.py

@@ -1,91 +0,0 @@
-# Copyright 2026 Cisco Systems, Inc. and its affiliates
-from ipaddress import IPv4Address, IPv6Address
-from typing import List, Literal, Optional, Tuple, Union, get_args
-
-from pydantic import AliasPath, BaseModel, ConfigDict, Field
-
-from catalystwan.api.configuration_groups.parcel import Global, _ParcelBase
-
-HSLName = Literal[
-    "server1",
-    "server2",
-    "server3",
-    "server4",
-]
-SERVER_NAMES: Tuple[HSLName, ...] = get_args(HSLName)
-
-
-class HSLEntry(BaseModel):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-    name: Optional[HSLName] = Field(
-        default=None,
-        validation_alias="name",
-        serialization_alias="name",
-        description="This field is required in version >=20.16. In versions <20.16 it must be None",
-    )
-    vrf: Global[str] = Field(validation_alias="vrf", serialization_alias="vrf")
-    serverIp: Global[Union[IPv4Address, IPv6Address]] = Field(
-        validation_alias="serverIp", serialization_alias="serverIp"
-    )
-    port: Global[int] = Field(validation_alias="port", serialization_alias="port")
-
-
-class UTDSyslog(BaseModel):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-    vpn: Global[str] = Field(validation_alias="vpn", serialization_alias="vpn")
-    server_ip: Global[IPv4Address] = Field(validation_alias="serverIp", serialization_alias="serverIp")
-
-
-class SecurityLoggingParcel(_ParcelBase):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-    type_: Literal["security-logging"] = Field(default="security-logging", exclude=True)
-    parcel_name: str = Field(
-        default="SecurityLogging",
-        exclude=True,
-        description="This field is not defined for this model",
-        serialization_alias="name",
-        validation_alias="name",
-    )
-    high_speed_logging: List[HSLEntry] = Field(
-        default_factory=list,
-        max_length=4,
-        validation_alias=AliasPath("data", "highSpeedLogging"),
-        description="High Speed Logging",
-    )
-    utd_syslog: List[UTDSyslog] = Field(
-        default_factory=list,
-        validation_alias=AliasPath("data", "utdSyslog"),
-        description="UTD Syslog",
-    )
-
-    def add_hsl_server(
-        self,
-        vrf: str,
-        serverIp: Union[IPv4Address, IPv6Address],
-        port: int,
-        name: Optional[HSLName] = None,
-    ):
-        if self.high_speed_logging is None:
-            self.high_speed_logging = []
-
-        if len(self.high_speed_logging) >= 4:
-            raise ValueError("Max 4 servers allowed")
-
-        taken_server_names = {entry.name for entry in self.high_speed_logging}
-
-        if name is not None and name in taken_server_names:
-            raise ValueError(f"{name} is already used")
-
-        self.high_speed_logging.append(
-            HSLEntry(
-                name=name,
-                vrf=Global[str](value=vrf),
-                serverIp=Global[Union[IPv4Address, IPv6Address]](value=serverIp),
-                port=Global[int](value=port),
-            )
-        )
-
-    def get_next_server_name(self) -> Optional[HSLName]:
-        taken_server_names = {entry.name for entry in self.high_speed_logging}
-        name: Optional[HSLName] = next((name for name in SERVER_NAMES if name not in taken_server_names), None)
-        return name

catalystwan/models/configuration/packages.py

@@ -1,57 +0,0 @@
-# Copyright 2026 Cisco Systems, Inc. and its affiliates
-from typing import Iterable, List, Literal, Optional
-from uuid import UUID
-
-from pydantic import BaseModel, ConfigDict, Field
-from typing_extensions import Self
-
-CatalogObjectType = Literal[
-    "config-group",
-    "policy-group",
-    "topology-group",
-]
-
-
-class CatalogPackageContents(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    object_list: List[UUID] = Field(
-        default_factory=list,
-        validation_alias="objectList",
-        serialization_alias="objectList",
-        description="list of object uuids",
-    )
-    object_type: Optional[CatalogObjectType] = Field(
-        default=None, validation_alias="objectType", serialization_alias="objectType"
-    )
-
-
-class CatalogPackageExportRequest(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    package_contents: List[CatalogPackageContents] = Field(
-        default_factory=list,
-        validation_alias="packageContents",
-        serialization_alias="packageContents",
-        description="package contents",
-    )
-
-    def add_objects(self, object_type: CatalogObjectType, ids: Iterable[UUID]) -> Self:
-        contents = CatalogPackageContents(object_type=object_type, object_list=list(ids))
-        self.package_contents.append(contents)
-        return self
-
-
-class CatalogPackageImportResponse(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    task_id: UUID = Field(validation_alias="taskId", serialization_alias="taskId")
-
-
-class TemplatePackageExportRequest(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    template_ids: Optional[List[UUID]] = Field(
-        default=list(),
-        validation_alias="templateIds",
-        serialization_alias="templateIds",
-        description="Select Device Templates for export by providing list of Ids"
-        "when list empty or parameter is missing all templates will be provided",
-    )
-    extras: bool = Field(default=True, description="Include extra items for Config Migration Tool")

catalystwan/models/configuration/policy_group.py

@@ -1,74 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from typing import List, Literal, Optional
-from uuid import UUID
-
-from pydantic import BaseModel, ConfigDict, Field
-
-
-class Profile(BaseModel):
-    id: UUID
-
-
-Solution = Literal[
-    "sd-routing",
-    "sdwan",
-]
-
-
-class FromPolicyGroup(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    copy_: UUID = Field(validation_alias="copy", serialization_alias="copy")
-
-
-class PolicyGroup(BaseModel):
-    """Payload for creating a policy group.
-    Policy Object Profile is required to create a policy group."""
-
-    model_config = ConfigDict(populate_by_name=True)
-    description: str = Field(
-        description="description of the policy group. Max length is ulimited. (>500 000 for 20.12)"
-    )
-    name: str = Field(pattern='^[^&<>! "]+$', max_length=128)
-    from_policy_group: Optional[FromPolicyGroup] = Field(
-        default=None, validation_alias="fromPolicyGroup", serialization_alias="fromPolicyGroup"
-    )
-    profiles: Optional[List[Profile]] = Field(
-        default=None, description="list of profile ids that belongs to the policy group"
-    )
-    solution: Optional[Solution] = Field(default=None)
-
-    def add_profile(self, profile_uuid: UUID) -> None:
-        if self.profiles is None:
-            self.profiles = []
-        self.profiles.append(Profile(id=profile_uuid))
-
-
-class ProfileInfo(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    id: str = Field()
-    profile_type: Optional[Literal["global"]] = Field(
-        default=None, validation_alias="profileType", serialization_alias="profileType"
-    )
-    name: str
-
-
-class PolicyGroupId(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    id: UUID
-    profiles: Optional[List[ProfileInfo]] = Field(
-        default=None,
-        description="(Optional - only applicable for AON) List of profile ids that belongs to the policy group",
-    )
-
-    def get_profile_by_name(self, name: str) -> Optional[ProfileInfo]:
-        if self.profiles is None:
-            return None
-
-        for profile in self.profiles:
-            if profile.name == name:
-                return profile
-        return None
-
-
-class PolicyGroupInfo(PolicyGroupId):
-    name: str

catalystwan/models/configuration/topology_group.py

@@ -1,52 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from typing import List, Literal, Optional
-from uuid import UUID
-
-from pydantic import BaseModel, ConfigDict, Field
-
-
-class Profile(BaseModel):
-    id: UUID
-
-
-class FromTopologyGroup(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    copy_: UUID = Field(validation_alias="copy", serialization_alias="copy")
-
-
-class TopologyGroup(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    description: str
-    name: str = Field(pattern='^[^&<>! "]+$')
-    from_topology_group: Optional[FromTopologyGroup] = Field(
-        default=None, validation_alias="fromTopologyGroup", serialization_alias="fromTopologyGroup"
-    )
-    profiles: Optional[List[Profile]] = Field(
-        default=None, description="list of profile ids that belongs to the topology group"
-    )
-    solution: Optional[Literal["sdwan"]] = Field(default=None)
-
-    def add_profiles(self, ids: List[UUID]):
-        if self.profiles is None:
-            self.profiles = []
-        self.profiles.extend([Profile(id=i) for i in ids])
-
-
-class ActivateRequest(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    deactivate_topology: bool = Field(validation_alias="deactivateTopology", serialization_alias="deactivateTopology")
-
-
-class DeployResponse(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    parent_task_id: str = Field(validation_alias="parentTaskId", serialization_alias="parentTaskId")
-
-
-class Preview(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    existing_config: str = Field(validation_alias="existingConfig", serialization_alias="existingConfig")
-    new_config: str = Field(validation_alias="newConfig", serialization_alias="newConfig")
-
-
-class TopologyGroupId(BaseModel):
-    id: UUID

catalystwan/models/policy/definition/aip.py

@@ -1,60 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-from typing import Literal, Optional
-
-from pydantic import BaseModel, ConfigDict, Field, model_validator
-from typing_extensions import Self
-
-from catalystwan.models.policy.policy_definition import (
-    PolicyDefinitionBase,
-    PolicyDefinitionGetResponse,
-    PolicyDefinitionId,
-    Reference,
-)
-
-TlsDecryptionAction = Literal["decrypt", "neverDecrypt", "skipDecrypt"]
-
-
-class AdvancedInspectionProfileDefinition(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    tls_decryption_action: TlsDecryptionAction = Field(
-        validation_alias="tlsDecryptionAction", serialization_alias="tlsDecryptionAction"
-    )
-
-    advanced_malware_protection: Optional[Reference] = Field(
-        default=None, validation_alias="advancedMalwareProtection", serialization_alias="advancedMalwareProtection"
-    )
-
-    intrusion_prevention: Optional[Reference] = Field(
-        default=None, validation_alias="intrusionPrevention", serialization_alias="intrusionPrevention"
-    )
-    url_filtering: Optional[Reference] = Field(
-        default=None, validation_alias="urlFiltering", serialization_alias="urlFiltering"
-    )
-
-    ssl_utd_decrypt_profile: Optional[Reference] = Field(
-        default=None, validation_alias="sslUtdDecryptProfile", serialization_alias="sslUtdDecryptProfile"
-    )
-
-    @model_validator(mode="after")
-    def check_at_least_one_optional_filled(self) -> Self:
-        if not any([self.advanced_malware_protection, self.intrusion_prevention, self.url_filtering]):
-            raise ValueError(
-                "At least one of Intrusion Prevention, URL Filtering, Advanced Malware Protection shall be filled."
-            )
-        return self
-
-
-class AdvancedInspectionProfilePolicy(PolicyDefinitionBase):
-    type: Literal["advancedInspectionProfile"] = "advancedInspectionProfile"
-    mode: Literal["unified"] = "unified"
-    definition: AdvancedInspectionProfileDefinition
-
-
-class AdvancedInspectionProfilePolicyEditPayload(AdvancedInspectionProfilePolicy, PolicyDefinitionId):
-    pass
-
-
-class AdvancedInspectionProfilePolicyGetResponse(AdvancedInspectionProfilePolicy, PolicyDefinitionGetResponse):
-    pass

catalystwan/models/policy/definition/amp.py

@@ -1,65 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-from typing import List, Literal, Optional
-
-from pydantic import BaseModel, ConfigDict, Field
-
-from catalystwan.models.common import (
-    AmpFileAlertLevel,
-    AmpFileAnalysisFileTypes,
-    AmpFileAnalysisServer,
-    AmpFileReputationServer,
-    PolicyModeType,
-    VpnId,
-)
-from catalystwan.models.policy.policy_definition import (
-    PolicyDefinitionBase,
-    PolicyDefinitionGetResponse,
-    PolicyDefinitionId,
-)
-
-OptionalAmpFileAnalysisServer = Literal["", AmpFileAnalysisServer]
-OptionalAmpFileAlertLevel = Literal["", AmpFileAlertLevel]
-
-
-class AdvancedMalwareProtectionDefinition(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    match_all_vpn: bool = Field(validation_alias="matchAllVpn", serialization_alias="matchAllVpn")
-    file_reputation_cloud_server: AmpFileReputationServer = Field(
-        validation_alias="fileReputationCloudServer", serialization_alias="fileReputationCloudServer"
-    )
-    file_reputation_est_server: AmpFileReputationServer = Field(
-        validation_alias="fileReputationEstServer", serialization_alias="fileReputationEstServer"
-    )
-    file_reputation_alert: AmpFileAlertLevel = Field(
-        validation_alias="fileReputationAlert", serialization_alias="fileReputationAlert"
-    )
-    file_analysis_enabled: Optional[bool] = Field(
-        default=False, validation_alias="fileAnalysisEnabled", serialization_alias="fileAnalysisEnabled"
-    )
-    file_analysis_file_types: List[AmpFileAnalysisFileTypes] = Field(
-        default_factory=list, validation_alias="fileAnalysisFileTypes", serialization_alias="fileAnalysisFileTypes"
-    )
-    file_analysis_alert: OptionalAmpFileAlertLevel = Field(
-        default="", validation_alias="fileAnalysisAlert", serialization_alias="fileAnalysisAlert"
-    )
-    file_analysis_cloud_server: OptionalAmpFileAnalysisServer = Field(
-        default="", validation_alias="fileAnalysisCloudServer", serialization_alias="fileAnalysisCloudServer"
-    )
-    target_vpns: List[VpnId] = Field(
-        default_factory=list, validation_alias="targetVpns", serialization_alias="targetVpns"
-    )
-
-
-class AdvancedMalwareProtectionPolicy(PolicyDefinitionBase):
-    type: Literal["advancedMalwareProtection"] = "advancedMalwareProtection"
-    mode: PolicyModeType = "security"
-    definition: AdvancedMalwareProtectionDefinition
-
-
-class AdvancedMalwareProtectionPolicyEditPayload(AdvancedMalwareProtectionPolicy, PolicyDefinitionId):
-    pass
-
-
-class AdvancedMalwareProtectionPolicyGetResponse(AdvancedMalwareProtectionPolicy, PolicyDefinitionGetResponse):
-    pass