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

catalystwan/models/configuration/network_hierarchy/cflowd.py

@@ -0,0 +1,120 @@
+# 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_global, 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=Global[int](value=600), 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=None, validation_alias=AliasPath("data", "protocol"))
+
+    def add_collector(
+        self,
+        address: Optional[str] = None,
+        bfd_metrics_export: Optional[bool] = False,
+        export_interval: Optional[int] = 600,
+        export_spread: Optional[bool] = False,
+        udp_port: Optional[int] = 4739,
+        vpn_id: Optional[int] = None,
+    ):
+        if self.collectors is None:
+            self.collectors = []
+        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: Optional[bool] = False, collect_tos: Optional[bool] = False
+    ):
+        self.customized_ipv4_record_fields = CustomizedIpv4RecordFields(
+            collect_dscp_output=as_optional_global(collect_dscp_output), collect_tos=as_optional_global(collect_tos)
+        )
+
+    def set_flow(
+        self,
+        active_timeout: Optional[int] = 600,
+        inactive_timeout: Optional[int] = 60,
+        refresh_time: Optional[int] = 600,
+        sampling_interval: Optional[int] = 1,
+    ):
+        self.flow_active_timeout = as_optional_global(active_timeout)
+        self.flow_inactive_timeout = as_optional_global(inactive_timeout)
+        self.flow_refresh_time = as_optional_global(refresh_time)
+        self.flow_sampling_interval = as_optional_global(sampling_interval)
+
+    def set_protocol(self, protocol: Protocol):
+        self.protocol = as_global(protocol, Protocol)

catalystwan/models/configuration/network_hierarchy/node.py

@@ -0,0 +1,88 @@
+# 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/policy_group.py

@@ -0,0 +1,74 @@
+# 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/profile_type.py

@@ -2,9 +2,4 @@
 
 from typing import Literal
 
-ProfileType = Literal[
-    "transport",
-    "system",
-    "cli",
-    "service",
-]
+ProfileType = Literal["transport", "system", "cli", "service", "other"]

catalystwan/models/configuration/topology_group.py

@@ -0,0 +1,52 @@
+# 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