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

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

@@ -1,120 +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
-
-SiteTypesForTransportGateway = Literal["type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke"]
-TransportGateway = Literal["prefer", "ecmp-with-direct-path"]
-
-
-class AdvertiseIp(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-    )
-    bgp: Union[Variable, Global[bool], Default[bool]] = Field(default=Default[bool](value=False), description="BGP")
-    ospf: Union[Variable, Global[bool], Default[bool]] = Field(default=Default[bool](value=False), description="OSPF")
-    connected: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=Default[bool](value=False), description="Variable"
-    )
-    static: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=Default[bool](value=False), description="Variable"
-    )
-    eigrp: Union[Variable, Global[bool], Default[bool]] = Field(default=Default[bool](value=False), description="EIGRP")
-    lisp: Union[Variable, Global[bool], Default[bool]] = Field(default=Default[bool](value=False), description="LISP")
-    isis: Union[Variable, Global[bool], Default[bool]] = Field(default=Default[bool](value=False), description="ISIS")
-
-
-class AdvertiseIpv6(AdvertiseIp):
-    pass
-
-
-class AdvertiseIpv4(AdvertiseIp):
-    ospfv3: Union[Variable, Global[bool], Default[bool]] = Field(default=Default[bool](value=False), description="OSPF")
-
-
-class OMPParcel(_ParcelBase):
-    type_: Literal["omp"] = Field(default="omp", exclude=True)
-
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    graceful_restart: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=Default[bool](value=True),
-        validation_alias=AliasPath("data", "gracefulRestart"),
-        description="Graceful Restart for OMP",
-    )
-    overlay_as: Union[Variable, Global[float], Default[None]] = Field(
-        default=Default[None](value=None),
-        validation_alias=AliasPath("data", "overlayAs"),
-        description="Overlay AS Number",
-    )
-    send_path_limit: Union[Variable, Global[int], Default[int]] = Field(
-        default=Default[int](value=4),
-        validation_alias=AliasPath("data", "sendPathLimit"),
-        description="Number of Paths Advertised per Prefix",
-    )
-    ecmp_limit: Union[Variable, Global[float], Default[int]] = Field(
-        default=Default[int](value=4),
-        validation_alias=AliasPath("data", "ecmpLimit"),
-        description="Set maximum number of OMP paths to install in cEdge route table",
-    )
-    shutdown: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=Default[bool](value=False), validation_alias=AliasPath("data", "shutdown"), description="Variable"
-    )
-    omp_admin_distance_ipv4: Union[Variable, Global[int], Default[int]] = Field(
-        default=Default[int](value=251),
-        validation_alias=AliasPath("data", "ompAdminDistanceIpv4"),
-        description="OMP Admin Distance IPv4",
-    )
-    omp_admin_distance_ipv6: Union[Variable, Global[int], Default[int]] = Field(
-        default=Default[int](value=251),
-        validation_alias=AliasPath("data", "ompAdminDistanceIpv6"),
-        description="OMP Admin Distance IPv6",
-    )
-    advertisement_interval: Union[Variable, Global[int], Default[int]] = Field(
-        default=Default[int](value=1),
-        validation_alias=AliasPath("data", "advertisementInterval"),
-        description="Advertisement Interval (seconds)",
-    )
-    graceful_restart_timer: Union[Variable, Global[int], Default[int]] = Field(
-        default=Default[int](value=43200),
-        validation_alias=AliasPath("data", "gracefulRestartTimer"),
-        description="Graceful Restart Timer (seconds)",
-    )
-    eor_timer: Union[Variable, Global[int], Default[int]] = Field(
-        default=Default[int](value=300), validation_alias=AliasPath("data", "eorTimer"), description="EOR Timer"
-    )
-    holdtime: Union[Variable, Global[int], Default[int]] = Field(
-        default=Default[int](value=60),
-        validation_alias=AliasPath("data", "holdtime"),
-        description="Hold Time (seconds)",
-    )
-    advertise_ipv4: AdvertiseIpv4 = Field(
-        default_factory=AdvertiseIpv4, validation_alias=AliasPath("data", "advertiseIpv4")
-    )
-    advertise_ipv6: AdvertiseIpv6 = Field(
-        default_factory=AdvertiseIpv6, validation_alias=AliasPath("data", "advertiseIpv6")
-    )
-    ignore_region_path_length: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
-        None,
-        validation_alias=AliasPath("data", "ignoreRegionPathLength"),
-        description="Treat hierarchical and direct (secondary region) paths equally",
-    )
-    transport_gateway: Optional[Union[Variable, Global[TransportGateway], Default[None]]] = Field(
-        None, validation_alias=AliasPath("data", "transportGateway"), description="Transport Gateway Path Behavior"
-    )
-    site_types_for_transport_gateway: Optional[
-        Union[
-            Variable,
-            Global[List[SiteTypesForTransportGateway]],
-            Default[None],
-        ]
-    ] = Field(None, validation_alias=AliasPath("data", "siteTypesForTransportGateway"), description="Site Types")
-    site_types: Optional[Union[Global[List[SiteTypesForTransportGateway]], Variable, Default[None]]] = Field(
-        default=None, validation_alias=AliasPath("data", "siteTypes")
-    )

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

@@ -1,179 +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
-
-IntegrityType = Literal["esp", "ip-udp-esp", "none", "ip-udp-esp-no-id"]
-ReplayWindow = Literal["64", "128", "256", "512", "1024", "2048", "4096", "8192"]
-DefaultReplayWindow = Literal["512"]
-Tcp = Literal["aes-128-cmac", "hmac-sha-1", "hmac-sha-256"]
-
-
-class KeychainItem(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    name: Global[str] = Field(..., description="Specify the name of the Keychain")
-    id: Global[int] = Field(..., description="Specify the Key ID")
-
-
-class OneOfendChoice1(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    infinite: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=as_default(True), description="Infinite lifetime"
-    )
-
-
-class OneOfendChoice2(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    duration: Union[Global[int], Variable] = Field(..., description="Send lifetime Duration (seconds)")
-
-
-class OneOfendChoice3(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    exact: Global[int] = Field(..., description="Configure Key lifetime end time")
-
-
-class SendLifetime(BaseModel):
-    """
-    Send Lifetime Settings
-    """
-
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    local: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
-        default=None, description="Configure Send lifetime Local"
-    )
-    start_epoch: Global[int] = Field(
-        ...,
-        serialization_alias="startEpoch",
-        validation_alias="startEpoch",
-        description="Configure Key lifetime start time",
-    )
-    one_ofend_choice: Optional[Union[OneOfendChoice1, OneOfendChoice2, OneOfendChoice3]] = Field(
-        default=None, serialization_alias="oneOfendChoice", validation_alias="oneOfendChoice"
-    )
-
-
-class AcceptLifetime(BaseModel):
-    """
-    Accept Lifetime Settings
-    """
-
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    local: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
-        default=None, description="Configure Send lifetime Local"
-    )
-    start_epoch: Global[int] = Field(
-        ...,
-        serialization_alias="startEpoch",
-        validation_alias="startEpoch",
-        description="Configure Key lifetime start time",
-    )
-    one_ofend_choice: Optional[Union[OneOfendChoice1, OneOfendChoice2, OneOfendChoice3]] = Field(
-        default=None, serialization_alias="oneOfendChoice", validation_alias="oneOfendChoice"
-    )
-
-
-class KeyItem(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    id: Global[int] = Field(..., description="Select the Key ID")
-    name: Global[str] = Field(..., description="Select the chain name")
-    send_id: Union[Global[int], Variable] = Field(
-        ..., serialization_alias="sendId", validation_alias="sendId", description="Specify the Send ID"
-    )
-    recv_id: Union[Global[int], Variable] = Field(
-        ..., serialization_alias="recvId", validation_alias="recvId", description="Specify the Receiver ID"
-    )
-    include_tcp_options: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
-        default=None,
-        serialization_alias="includeTcpOptions",
-        validation_alias="includeTcpOptions",
-        description="Configure Include TCP Options",
-    )
-    accept_ao_mismatch: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
-        default=None,
-        serialization_alias="acceptAoMismatch",
-        validation_alias="acceptAoMismatch",
-        description="Configure Accept AO Mismatch",
-    )
-    tcp: Global[Tcp] = Field(..., description="Crypto Algorithm")
-    key_string: Union[Global[str], Variable] = Field(
-        ...,
-        serialization_alias="keyString",
-        validation_alias="keyString",
-        description="Specify the Key String [Note: Catalyst SD-WAN Manager will encrypt this field before saving."
-        "Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]",
-    )
-    send_lifetime: Optional[SendLifetime] = Field(
-        default=None,
-        serialization_alias="sendLifetime",
-        validation_alias="sendLifetime",
-        description="Send Lifetime Settings",
-    )
-    accept_lifetime: Optional[AcceptLifetime] = Field(
-        default=None,
-        serialization_alias="acceptLifetime",
-        validation_alias="acceptLifetime",
-        description="Accept Lifetime Settings",
-    )
-
-
-class SecurityParcel(_ParcelBase):
-    type_: Literal["security"] = Field(default="security", exclude=True)
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    rekey: Union[Global[int], Variable, Default[int]] = Field(
-        default=as_default(86400),
-        validation_alias=AliasPath("data", "rekey"),
-        description="Set how often to change the AES key for DTLS connections",
-    )
-    replay_window: Optional[Union[Global[ReplayWindow], Variable, Default[DefaultReplayWindow]]] = Field(
-        default=as_default("512", DefaultReplayWindow),
-        validation_alias=AliasPath("data", "replayWindow"),
-        description="Set the sliding replay window size",
-    )
-    extended_ar_window: Optional[Union[Global[int], Variable, Default[int]]] = Field(
-        default=None,
-        validation_alias=AliasPath("data", "extendedArWindow"),
-        description="Extended Anti-Replay Window",
-    )
-    integrity_type: Union[Global[List[IntegrityType]], Variable] = Field(
-        validation_alias=AliasPath("data", "integrityType"),
-        description="Set the authentication type for DTLS connections",
-    )
-    pairwise_keying: Union[Variable, Global[bool], Default[bool]] = Field(
-        default=as_default(False),
-        validation_alias=AliasPath("data", "pairwiseKeying"),
-        description="Enable or disable IPsec pairwise-keying",
-    )
-    keychain: List[KeychainItem] = Field(
-        default_factory=list, validation_alias=AliasPath("data", "keychain"), description="Configure a Keychain"
-    )
-    key: List[KeyItem] = Field(
-        default_factory=list, validation_alias=AliasPath("data", "key"), description="Configure a Key"
-    )

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

@@ -1,173 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-from __future__ import annotations
-
-from ipaddress import IPv4Address, IPv6Address
-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
-
-Authorization = Literal["read-only", "read-write"]
-Priv = Literal["aes-cfb-128", "aes-256-cfb-128"]
-SecurityLevel = Literal["no-auth-no-priv", "auth-no-priv", "auth-priv"]
-
-
-class OidItem(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    id: Union[Global[str], Variable] = Field(..., description="Configure identifier of subtree of MIB objects")
-    exclude: Optional[Union[Global[bool], Variable, Default[bool]]] = Field(default=None, description="Exclude the OID")
-
-
-class ViewItem(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    name: Global[str] = Field(..., description="Set the name of the SNMP view")
-    oid: Optional[List[OidItem]] = Field(default=None, description="Configure SNMP object identifier")
-
-
-class CommunityItem(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    name: Global[str] = Field(
-        ...,
-        description="Set name of the SNMP community"
-        "[Note: Catalyst SD-WAN Manager will encrypt this field before saving."
-        "Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]",
-    )
-    user_label: Optional[Global[str]] = Field(
-        default=None,
-        serialization_alias="userLabel",
-        validation_alias="userLabel",
-        description="Set user label of the SNMP community",
-    )
-    view: Union[Global[str], Variable] = Field(..., description="Set name of the SNMP view")
-    authorization: Optional[Union[Global[Authorization], Variable]] = Field(
-        default=None, description="Configure access permissions"
-    )
-
-
-class GroupItem(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    name: Global[str] = Field(..., description="Name of the SNMP group")
-    security_level: Global[SecurityLevel] = Field(
-        ...,
-        serialization_alias="securityLevel",
-        validation_alias="securityLevel",
-        description="Configure security level",
-    )
-    view: Union[Global[str], Variable] = Field(..., description="Name of the SNMP view")
-
-
-class UserItem(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    name: Global[str] = Field(..., description="Name of the SNMP user")
-    auth: Optional[Union[Global[Literal["sha", "sha256"]], Variable, Default[None]]] = Field(
-        default=None, description="Configure authentication protocol"
-    )
-    auth_password: Optional[Union[Global[str], Variable, Default[None]]] = Field(
-        default=None,
-        serialization_alias="authPassword",
-        validation_alias="authPassword",
-        description="Specify authentication protocol password",
-    )
-    priv: Optional[Union[Global[Priv], Variable, Default[None]]] = Field(
-        default=None, description="Configure privacy protocol"
-    )
-    priv_password: Optional[Union[Global[str], Variable, Default[None]]] = Field(
-        default=None,
-        serialization_alias="privPassword",
-        validation_alias="privPassword",
-        description="Specify privacy protocol password",
-    )
-    group: Union[Global[str], Variable] = Field(..., description="Name of the SNMP group")
-
-
-class TargetItem(BaseModel):
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    vpn_id: Union[Global[int], Variable] = Field(
-        ...,
-        serialization_alias="vpnId",
-        validation_alias="vpnId",
-        description="Set VPN in which SNMP server is located",
-    )
-    ip: Union[Global[IPv4Address], Global[IPv6Address], Variable] = Field(
-        ..., description="Set IPv4/IPv6 address of SNMP server"
-    )
-    port: Union[Global[int], Variable] = Field(..., description="Set UDP port number to connect to SNMP server")
-    user_label: Optional[Global[str]] = Field(
-        default=None,
-        serialization_alias="userLabel",
-        validation_alias="userLabel",
-        description="Set user label of the SNMP community",
-    )
-    community_name: Optional[Union[Global[str], Variable]] = Field(
-        default=None,
-        serialization_alias="communityName",
-        validation_alias="communityName",
-        description="Set name of the SNMP community"
-        "[Note: Catalyst SD-WAN Manager will encrypt this field before saving."
-        "Cleartext strings will not be returned back to the user in GET responses for sensitive fields.]."
-        "DEPRECATED. Use userLabel field instead",
-    )
-    user: Optional[Union[Global[str], Variable]] = Field(default=None, description="Set name of the SNMP user")
-    source_interface: Optional[Union[Global[str], Variable]] = Field(
-        default=None,
-        serialization_alias="sourceInterface",
-        validation_alias="sourceInterface",
-        description="Source interface for outgoing SNMP traps",
-    )
-
-
-class SNMPParcel(_ParcelBase):
-    type_: Literal["snmp"] = Field(default="snmp", exclude=True)
-    model_config = ConfigDict(
-        extra="forbid",
-        populate_by_name=True,
-    )
-    shutdown: Union[Global[bool], Variable, Default[bool]] = Field(
-        default=as_default(False), validation_alias=AliasPath("data", "shutdown"), description="Enable or disable SNMP"
-    )
-    contact: Union[Global[str], Variable, Default[None]] = Field(
-        default=Default[None](value=None),
-        validation_alias=AliasPath("data", "contact"),
-        description="Set the contact for this managed node",
-    )
-    location: Union[Global[str], Variable, Default[None]] = Field(
-        default=Default[None](value=None),
-        validation_alias=AliasPath("data", "location"),
-        description="Set the physical location of this managed node",
-    )
-    view: List[ViewItem] = Field(
-        default_factory=list, validation_alias=AliasPath("data", "view"), description="Configure a view record"
-    )
-    community: List[CommunityItem] = Field(
-        default_factory=list, validation_alias=AliasPath("data", "community"), description="Configure SNMP community"
-    )
-    group: List[GroupItem] = Field(
-        default_factory=list, validation_alias=AliasPath("data", "group"), description="Configure an SNMP group"
-    )
-    user: List[UserItem] = Field(
-        default_factory=list, validation_alias=AliasPath("data", "user"), description="Configure an SNMP user"
-    )
-    target: List[TargetItem] = Field(
-        default_factory=list,
-        validation_alias=AliasPath("data", "target"),
-        description="Configure SNMP server to receive SNMP traps",
-    )

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

@@ -1,29 +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 catalystwan.models.configuration.feature_profile.sdwan.topology.custom_control import CustomControlParcel
-from catalystwan.models.configuration.feature_profile.sdwan.topology.hubspoke import HubSpokeParcel
-from catalystwan.models.configuration.feature_profile.sdwan.topology.mesh import MeshParcel
-
-AnyTopologyParcel = Annotated[
-    Union[
-        MeshParcel,
-        HubSpokeParcel,
-        CustomControlParcel,
-    ],
-    Field(discriminator="type_"),
-]
-
-__all__ = [
-    "AnyTopologyParcel",
-    "HubSpokeParcel",
-    "MeshParcel",
-    "CustomControlParcel",
-]
-
-
-def __dir__() -> "List[str]":
-    return list(__all__)