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

catalystwan/models/configuration/feature_profile/sdwan/system/__init__.py

@@ -1,59 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from typing import List, Union
-
-from pydantic import Field
-from typing_extensions import Annotated
-
-from .aaa import AAAParcel
-from .banner import BannerParcel
-from .basic import BasicParcel
-from .bfd import BFDParcel
-from .device_access import DeviceAccessIPv4Parcel
-from .device_access_ipv6 import DeviceAccessIPv6Parcel
-from .global_parcel import GlobalParcel
-from .logging_parcel import LoggingParcel
-from .mrf import MRFParcel
-from .ntp import NtpParcel
-from .omp import OMPParcel
-from .security import SecurityParcel
-from .snmp import SNMPParcel
-
-AnySystemParcel = Annotated[
-    Union[
-        AAAParcel,
-        BFDParcel,
-        LoggingParcel,
-        BannerParcel,
-        BasicParcel,
-        DeviceAccessIPv4Parcel,
-        DeviceAccessIPv6Parcel,
-        GlobalParcel,
-        NtpParcel,
-        MRFParcel,
-        OMPParcel,
-        SecurityParcel,
-        SNMPParcel,
-    ],
-    Field(discriminator="type_"),
-]
-
-__all__ = [
-    "AAAParcel",
-    "BFDParcel",
-    "LoggingParcel",
-    "BannerParcel",
-    "BasicParcel",
-    "DeviceAccessIPv4Parcel",
-    "DeviceAccessIPv6Parcel",
-    "GlobalParcel",
-    "NtpParcel",
-    "MRFParcel",
-    "OMPParcel",
-    "SecurityParcel",
-    "SNMPParcel",
-    "AnySystemParcel",
-]
-
-
-def __dir__() -> "List[str]":
-    return list(__all__)

catalystwan/models/configuration/feature_profile/sdwan/system/banner.py

@@ -1,30 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from __future__ import annotations
-
-from typing import Literal, Union
-
-from pydantic import AliasPath, ConfigDict, Field
-
-from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase, as_default, as_global
-
-EmptyString = Literal[""]
-
-
-class BannerParcel(_ParcelBase):
-    type_: Literal["banner"] = Field(default="banner", exclude=True)
-
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-    login: Union[Variable, Global[str], Default[EmptyString], str] = Field(
-        default=as_default("", EmptyString), validation_alias=AliasPath("data", "login")
-    )
-    motd: Union[Variable, Global[str], Default[EmptyString]] = Field(
-        default=as_default("", EmptyString),
-        validation_alias=AliasPath("data", "motd"),
-        description="Message of the day",
-    )
-
-    def add_login(self, value: str):
-        self.login = as_global(value)
-
-    def add_motd(self, value: str):
-        self.motd = as_global(value)

catalystwan/models/configuration/feature_profile/sdwan/system/basic.py

@@ -1,290 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from __future__ import annotations
-
-from typing import List, Literal, Optional, Union
-
-from pydantic import AliasPath, BaseModel, ConfigDict, Field
-
-from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase, as_default
-from catalystwan.models.common import Timezone
-
-ConsoleBaudRate = Literal["1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200"]
-DefaultConsoleBaudRate = Literal["9600"]
-Epfr = Literal["disabled", "aggressive", "moderate", "conservative"]
-DefaultEpfr = Literal["disabled"]
-SiteType = Literal["type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke"]
-DefaultTimezone = Literal["UTC"]
-
-
-class Clock(BaseModel):
-    timezone: Union[Variable, Global[Timezone], Default[DefaultTimezone]] = Field(
-        default=as_default("UTC", DefaultTimezone), description="Set the timezone"
-    )
-
-
-class MobileNumberItem(BaseModel):
-    number: Union[Global[str], Variable] = Field(..., description="Mobile number, ex: 1231234414")
-
-
-class Sms(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    enable: Union[Global[bool], Default[bool]] = Field(
-        default=as_default(False), description="Enable device’s geo fencing SMS"
-    )
-    mobile_number: Optional[List[MobileNumberItem]] = Field(
-        None,
-        serialization_alias="MobileNumber",
-        validation_alias="MobileNumber",
-        description="Set device’s geo fencing SMS phone number",
-    )
-
-
-class GeoFencing(BaseModel):
-    enable: Union[Global[bool], Default[bool]] = Field(default=as_default(False), description="Enable Geo fencing")
-    range: Union[Global[int], Variable, Default[int]] = Field(
-        default=as_default(100), description="Set the device’s geo fencing range"
-    )
-    sms: Sms = Field(default_factory=Sms, description="Set device’s geo fencing SMS")  # type: ignore
-
-
-class GpsVariable(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    longitude: Union[Variable, Global[float], Default[None]] = Field(
-        default=Default[None](value=None), description="Set the device physical longitude"
-    )
-    latitude: Union[Variable, Global[float], Default[None]] = Field(
-        default=Default[None](value=None), description="Set the device physical latitude"
-    )
-    geo_fencing: GeoFencing = Field(
-        default_factory=GeoFencing,
-        serialization_alias="geoFencing",
-        validation_alias="geoFencing",
-    )
-
-
-class OnDemand(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    on_demand_enable: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=as_default(False),
-        serialization_alias="onDemandEnable",
-        validation_alias="onDemandEnable",
-        description="Enable or disable On-demand Tunnel",
-    )
-    on_demand_idle_timeout: Union[
-        Variable,
-        Global[int],
-        Default[int],
-    ] = Field(
-        default=as_default(10),
-        serialization_alias="onDemandIdleTimeout",
-        validation_alias="onDemandIdleTimeout",
-        description="Set the idle timeout for on-demand tunnels",
-    )
-
-
-class AffinityPerVrfItem(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    affinity_group_number: Union[
-        Variable,
-        Global[int],
-        Default[None],
-    ] = Field(
-        default=Default[None](value=None),
-        serialization_alias="affinityGroupNumber",
-        validation_alias="affinityGroupNumber",
-        description="Affinity Group Number",
-    )
-    vrf_range: Union[Variable, Global[str], Default[None]] = Field(
-        default=Default[None](value=None),
-        serialization_alias="vrfRange",
-        validation_alias="vrfRange",
-        description="Range of VRFs",
-    )
-
-
-class BasicParcel(_ParcelBase):
-    type_: Literal["basic"] = Field(default="basic", exclude=True)
-
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    clock: Clock = Field(default_factory=Clock, validation_alias=AliasPath("data", "clock"))
-    device_description: Union[Variable, Global[str], Default[None]] = Field(
-        default=Default[None](value=None),
-        validation_alias=AliasPath("data", "description"),
-        description="Set a text description of the device",
-    )
-    location: Union[Variable, Global[str], Default[None]] = Field(
-        default=Default[None](value=None),
-        validation_alias=AliasPath("data", "location"),
-        description="Set the location of the device",
-    )
-    gps_location: GpsVariable = Field(
-        default_factory=GpsVariable,
-        validation_alias=AliasPath("data", "gpsLocation"),
-    )
-    device_groups: Union[Variable, Global[List[str]], Default[None]] = Field(
-        default=Default[None](value=None),
-        validation_alias=AliasPath("data", "deviceGroups"),
-        description="Device groups",
-    )
-    controller_group_list: Optional[
-        Union[
-            Variable,
-            Global[List[int]],
-            Default[None],
-        ]
-    ] = Field(
-        None,
-        validation_alias=AliasPath("data", "controllerGroupList"),
-        description="Configure a list of comma-separated controller groups",
-    )
-    overlay_id: Union[Variable, Global[int], Default[int]] = Field(
-        default=as_default(1),
-        validation_alias=AliasPath("data", "overlayId"),
-        description="Set the Overlay ID",
-    )
-    port_offset: Union[Variable, Global[int], Default[int]] = Field(
-        default=as_default(0),
-        validation_alias=AliasPath("data", "portOffset"),
-        description="Set the TLOC port offset when multiple devices are behind a NAT",
-    )
-    port_hop: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=as_default(True),
-        validation_alias=AliasPath("data", "portHop"),
-        description="Enable port hopping",
-    )
-    control_session_pps: Optional[Union[Variable, Global[int], Default[int]]] = Field(
-        None,
-        validation_alias=AliasPath("data", "controlSessionPps"),
-        description="Set the policer rate for control sessions",
-    )
-    track_transport: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
-        None,
-        validation_alias=AliasPath("data", "trackTransport"),
-        description="Configure tracking of transport",
-    )
-    track_interface_tag: Optional[Union[Variable, Global[int], Default[None]]] = Field(
-        None,
-        validation_alias=AliasPath("data", "trackInterfaceTag"),
-        description="OMP Tag attached to routes based on interface tracking",
-    )
-    console_baud_rate: Union[Variable, Global[ConsoleBaudRate], Default[DefaultConsoleBaudRate]] = Field(
-        default=as_default("9600", DefaultConsoleBaudRate),
-        validation_alias=AliasPath("data", "consoleBaudRate"),
-        description="Set the console baud rate",
-    )
-    max_omp_sessions: Union[Variable, Global[int], Default[None]] = Field(
-        default=Default[None](value=None),
-        validation_alias=AliasPath("data", "maxOmpSessions"),
-        description="Set the maximum number of OMP sessions <1..100> the device can have",
-    )
-    multi_tenant: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
-        None,
-        validation_alias=AliasPath("data", "multiTenant"),
-        description="Device is multi-tenant",
-    )
-    track_default_gateway: Optional[
-        Union[
-            Variable,
-            Global[bool],
-            Default[bool],
-        ]
-    ] = Field(
-        None,
-        validation_alias=AliasPath("data", "trackDefaultGateway"),
-        description="Enable or disable default gateway tracking",
-    )
-    tracker_dia_stabilize_status: Optional[
-        Union[
-            Variable,
-            Global[bool],
-            Default[bool],
-        ]
-    ] = Field(
-        None,
-        validation_alias=AliasPath("data", "trackerDiaStabilizeStatus"),
-        description="Enable or disable endpoint tracker diaStabilize status",
-    )
-    admin_tech_on_failure: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=as_default(True),
-        validation_alias=AliasPath("data", "adminTechOnFailure"),
-        description="Collect admin-tech before reboot due to daemon failure",
-    )
-    idle_timeout: Optional[Union[Variable, Global[int], Default[None]]] = Field(
-        None,
-        validation_alias=AliasPath("data", "idleTimeout"),
-        description="Idle CLI timeout in minutes",
-    )
-    on_demand: OnDemand = Field(
-        default_factory=OnDemand,
-        validation_alias=AliasPath("data", "onDemand"),
-    )
-    transport_gateway: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(
-        None,
-        validation_alias=AliasPath("data", "transportGateway"),
-        description="Enable transport gateway",
-    )
-    epfr: Optional[Union[Global[Epfr], Default[DefaultEpfr], Variable]] = Field(
-        None,
-        validation_alias=AliasPath("data", "epfr"),
-        description="Enable SLA Dampening and Enhanced App Routing.",
-    )
-    site_type: Optional[Union[Variable, Global[List[SiteType]], Default[None]]] = Field(
-        None,
-        validation_alias=AliasPath("data", "siteType"),
-        description="Site Type",
-    )
-    affinity_group_number: Optional[
-        Union[
-            Variable,
-            Global[int],
-            Default[None],
-        ]
-    ] = Field(
-        None,
-        validation_alias=AliasPath("data", "affinityGroupNumber"),
-        description="Affinity Group Number",
-    )
-    affinity_group_preference: Optional[
-        Union[
-            Variable,
-            Global[List[int]],
-            Default[None],
-        ]
-    ] = Field(
-        None,
-        validation_alias=AliasPath("data", "affinityGroupPreference"),
-        description="Affinity Group Preference",
-    )
-    affinity_preference_auto: Optional[
-        Union[
-            Variable,
-            Global[bool],
-            Default[bool],
-        ]
-    ] = Field(
-        None,
-        validation_alias=AliasPath("data", "affinityPreferenceAuto"),
-        description="Affinity Group Preference Auto",
-    )
-    affinity_per_vrf: Optional[List[AffinityPerVrfItem]] = Field(
-        None,
-        validation_alias=AliasPath("data", "affinityPerVrf"),
-        description="Affinity Group Range for VRFs",
-        max_length=4,
-        min_length=0,
-    )

catalystwan/models/configuration/feature_profile/sdwan/system/bfd.py

@@ -1,69 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from typing import List, Literal, Optional, Union
-
-from pydantic import AliasPath, BaseModel, ConfigDict, Field
-
-from catalystwan.api.configuration_groups.parcel import Default, Global, _ParcelBase, as_default, as_global
-from catalystwan.models.common import TLOCColor
-
-
-class Color(BaseModel):
-    color: Global[TLOCColor]
-    hello_interval: Optional[Union[Global[int], Default[int]]] = Field(
-        default=as_default(1000), validation_alias="helloInterval", serialization_alias="helloInterval"
-    )
-    multiplier: Optional[Union[Global[int], Default[int]]] = as_default(7)
-    pmtu_discovery: Optional[Union[Global[bool], Default[bool]]] = Field(
-        default=as_default(True), validation_alias="pmtuDiscovery", serialization_alias="pmtuDiscovery"
-    )
-    dscp: Optional[Union[Global[int], Default[int]]] = as_default(48)
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class BFDParcel(_ParcelBase):
-    type_: Literal["bfd"] = Field(default="bfd", exclude=True)
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-
-    multiplier: Optional[Union[Global[int], Default[int]]] = Field(
-        default=as_default(6), validation_alias=AliasPath("data", "multiplier")
-    )
-    poll_interval: Optional[Union[Global[int], Default[int]]] = Field(
-        default=as_default(600000),
-        validation_alias=AliasPath("data", "pollInterval"),
-        description="Poll Interval (In Millisecond)",
-    )
-    default_dscp: Optional[Union[Global[int], Default[int]]] = Field(
-        default=as_default(48),
-        validation_alias=AliasPath("data", "defaultDscp"),
-        description="DSCP Values for BFD Packets (decimal)",
-    )
-    colors: Optional[List[Color]] = Field(default=None, validation_alias=AliasPath("data", "colors"))
-
-    def set_muliplier(self, value: int):
-        self.multiplier = as_global(value)
-
-    def set_poll_interval(self, value: int):
-        self.poll_interval = as_global(value)
-
-    def set_default_dscp(self, value: int):
-        self.default_dscp = as_global(value)
-
-    def add_color(
-        self,
-        color: TLOCColor,
-        hello_interval: int = 1000,
-        multiplier: int = 7,
-        pmtu_discovery: bool = True,
-        dscp: int = 48,
-    ):
-        if not self.colors:
-            self.colors = []
-        self.colors.append(
-            Color(
-                color=Global[TLOCColor](value=color),
-                hello_interval=as_global(hello_interval),
-                multiplier=as_global(multiplier),
-                pmtu_discovery=as_global(pmtu_discovery),
-                dscp=as_global(dscp),
-            )
-        )

catalystwan/models/configuration/feature_profile/sdwan/system/device_access.py

@@ -1,157 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from ipaddress import IPv4Interface
-from typing import List, Literal, Optional, Union
-from uuid import UUID
-
-from pydantic import AliasPath, BaseModel, ConfigDict, Field
-
-from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase, as_global, as_variable
-from catalystwan.models.common import AcceptDropActionType, DeviceAccessProtocolPort
-from catalystwan.models.configuration.feature_profile.common import RefIdItem
-
-
-class SourceDataPrefix(BaseModel):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-
-    source_data_prefix_list: RefIdItem = Field(
-        validation_alias="sourceDataPrefixList", serialization_alias="sourceDataPrefixList"
-    )
-
-
-class SourceIPPrefix(BaseModel):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-
-    source_ip_prefix_list: Union[Global[List[IPv4Interface]], Variable] = Field(
-        validation_alias="sourceIpPrefixList", serialization_alias="sourceIpPrefixList"
-    )
-
-
-class DestinationDataPrefix(BaseModel):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-
-    destination_data_prefix_list: RefIdItem = Field(
-        validation_alias="destinationDataPrefixList", serialization_alias="destinationDataPrefixList"
-    )
-
-
-class DestinationIPPrefix(BaseModel):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-
-    destination_ip_prefix_list: Union[Global[List[IPv4Interface]], Variable] = Field(
-        validation_alias="destinationIpPrefixList", serialization_alias="destinationIpPrefixList"
-    )
-
-
-class MatchEntries(BaseModel):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True, validate_assignment=True)
-
-    destination_data_prefix: Optional[Union[DestinationIPPrefix, DestinationDataPrefix]] = Field(
-        default=None, validation_alias="destinationDataPrefix", serialization_alias="destinationDataPrefix"
-    )
-    destination_port: Global[DeviceAccessProtocolPort] = Field(
-        validation_alias="destinationPort", serialization_alias="destinationPort"
-    )
-    source_data_prefix: Optional[Union[SourceIPPrefix, SourceDataPrefix]] = Field(
-        default=None, validation_alias="sourceDataPrefix", serialization_alias="sourceDataPrefix"
-    )
-    source_ports: Optional[Global[List[int]]] = Field(
-        default=None, validation_alias="sourcePorts", serialization_alias="sourcePorts"
-    )
-
-
-class Sequence(BaseModel):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True, validate_assignment=True)
-
-    base_action: Union[Global[AcceptDropActionType], Default[Literal[AcceptDropActionType]]] = Field(
-        default=Default[Literal[AcceptDropActionType]](value="accept"),
-        validation_alias="baseAction",
-        serialization_alias="baseAction",
-    )
-    match_entries: MatchEntries = Field(
-        validation_alias="matchEntries", serialization_alias="matchEntries", description="Define match conditions"
-    )
-    sequence_id: Global[int] = Field(validation_alias="sequenceId", serialization_alias="sequenceId")
-    sequence_name: Global[str] = Field(validation_alias="sequenceName", serialization_alias="sequenceName")
-
-    def set_base_action(self, base_action: AcceptDropActionType):
-        self.base_action = Global[AcceptDropActionType](value=base_action)
-
-    def match_destination_data_prefixes(self, prefixes: List[IPv4Interface]):
-        self.match_entries.destination_data_prefix = DestinationIPPrefix(
-            destination_ip_prefix_list=Global[List[IPv4Interface]](value=prefixes)
-        )
-
-    def match_destination_data_prefix_list(self, list_id: UUID):
-        self.match_entries.destination_data_prefix = DestinationDataPrefix(
-            destination_data_prefix_list=RefIdItem.from_uuid(list_id)
-        )
-
-    def match_destination_data_prefix_variable(self, variable_name: str):
-        self.match_entries.destination_data_prefix = DestinationIPPrefix(
-            destination_ip_prefix_list=as_variable(value=variable_name)
-        )
-
-    def match_destination_port(self, port: DeviceAccessProtocolPort):
-        self.match_entries.destination_port = Global[DeviceAccessProtocolPort](value=port)
-
-    def match_source_data_prefixes(self, prefixes: List[IPv4Interface]):
-        self.match_entries.source_data_prefix = SourceIPPrefix(
-            source_ip_prefix_list=Global[List[IPv4Interface]](value=prefixes)
-        )
-
-    def match_source_data_prefix_list(self, list_id: UUID):
-        self.match_entries.source_data_prefix = SourceDataPrefix(source_data_prefix_list=RefIdItem.from_uuid(list_id))
-
-    def match_source_data_prefix_variable(self, variable_name: str):
-        self.match_entries.source_data_prefix = SourceIPPrefix(source_ip_prefix_list=as_variable(value=variable_name))
-
-    def match_source_ports(self, ports: List[int]):
-        self.match_entries.source_ports = Global[List[int]](value=ports)
-
-    @classmethod
-    def create(
-        cls,
-        sequence_id: int,
-        sequence_name: str,
-        base_action: AcceptDropActionType,
-        match_entries: MatchEntries,
-    ) -> "Sequence":
-        return cls(
-            base_action=Global[AcceptDropActionType](value=base_action),
-            match_entries=match_entries,
-            sequence_id=Global[int](value=sequence_id),
-            sequence_name=Global[str](value=sequence_name),
-        )
-
-
-class DeviceAccessIPv4Parcel(_ParcelBase):
-    model_config = ConfigDict(extra="forbid", populate_by_name=True)
-
-    type_: Literal["ipv4-device-access-policy"] = Field(default="ipv4-device-access-policy", exclude=True)
-
-    default_action: Union[Global[AcceptDropActionType], Default[AcceptDropActionType]] = Field(
-        default=Default[AcceptDropActionType](value="drop"), validation_alias=AliasPath("data", "defaultAction")
-    )
-    sequences: List[Sequence] = Field(
-        default_factory=list, validation_alias=AliasPath("data", "sequences"), description="Device Access Control List"
-    )
-
-    def set_default_action(self, default_action: AcceptDropActionType) -> None:
-        self.default_action = Global[AcceptDropActionType](value=default_action)
-
-    def add_sequence(
-        self,
-        id_: int,
-        name: str,
-        destination_port: DeviceAccessProtocolPort,
-        base_action: AcceptDropActionType,
-    ) -> Sequence:
-        match_entries = MatchEntries(destination_port=as_global(destination_port, DeviceAccessProtocolPort))
-        sequence = Sequence.create(
-            sequence_id=id_,
-            sequence_name=name,
-            base_action=base_action,
-            match_entries=match_entries,
-        )
-        self.sequences.append(sequence)
-        return sequence