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

catalystwan/api/templates/models/vpn_vsmart_model.py

@@ -1,124 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-from pathlib import Path
-from typing import ClassVar, List, Literal, Optional
-
-from pydantic import ConfigDict, Field
-
-from catalystwan.api.templates.bool_str import BoolStr
-from catalystwan.api.templates.feature_template import FeatureTemplate, FeatureTemplateValidator
-
-VpnId = Literal["0", "512"]
-Role = Literal["primary", "secondary"]
-
-
-class Dns(FeatureTemplateValidator):
-    dns_addr: Optional[str] = Field(
-        default=None, json_schema_extra={"vmanage_key": "dns-addr"}, description="The IP address of the DNS server."
-    )
-    role: Role = Field(description="The role of the DNS server, either 'PRIMARY' or 'SECONDARY'.")
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class Host(FeatureTemplateValidator):
-    hostname: str = Field(..., description="The hostname of the device.")
-    ip: List[str] = Field(..., description="A list of IP addresses associated with the hostname.")
-
-
-class NextHop(FeatureTemplateValidator):
-    address: Optional[str] = Field(default=None, description="The IP address of the next hop for the route.")
-    distance: Optional[int] = Field(default=1, description="The administrative distance of the next hop.")
-
-
-class RouteInterface(FeatureTemplateValidator):
-    interface_name: str = Field(
-        description="The name of the interface used for routing.", json_schema_extra={"vmanage_key": "interface-name"}
-    )
-    interface_next_hop: Optional[List[NextHop]] = Field(
-        default=None,
-        description="A list of next hops associated with the interface for routing purposes.",
-        json_schema_extra={"vmanage_key": "interface-next-hop", "priority_order": ["address", "distance"]},
-    )
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class Routev4(FeatureTemplateValidator):
-    prefix: Optional[str] = Field(default=None, description="The IPv4 network prefix for the static route.")
-    next_hop: Optional[List[NextHop]] = Field(
-        default=None,
-        description="A list of IPv4 next hops for the route.",
-        json_schema_extra={"vmanage_key": "next-hop", "priority_order": ["address", "distance"]},
-    )
-    route_interface: Optional[RouteInterface] = Field(
-        default=None,
-        description="The interface configuration for the IPv4 static route.",
-        json_schema_extra={"vmanage_key": "route-interface"},
-    )
-    null0: Optional[BoolStr] = Field(
-        default=None, description="A flag indicating whether to route traffic to null0 for this static route."
-    )
-    distance: Optional[int] = Field(default=None, description="The administrative distance for the static route.")
-    vpn: Optional[int] = Field(
-        default=None, description="The VPN instance identifier associated with the static route."
-    )
-
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class NextHopv6(FeatureTemplateValidator):
-    address: str = Field(description="The IPv6 address of the next hop for the route.")
-    distance: Optional[int] = Field(default=1, description="The administrative distance of the IPv6 next hop.")
-
-
-class Routev6(FeatureTemplateValidator):
-    prefix: str = Field(description="The IPv6 network prefix for the static route.")
-    next_hop: Optional[List[NextHopv6]] = Field(
-        default=None,
-        description="A list of IPv6 next hops for the route.",
-        json_schema_extra={"vmanage_key": "next-hop"},
-    )
-    null0: Optional[BoolStr] = Field(
-        default=None, description="A flag indicating whether to route IPv6 traffic to null0 for this static route."
-    )
-    distance: Optional[int] = Field(default=1, description="The administrative distance for the static route.")
-    vpn: Optional[int] = Field(default=0, description="The VPN instance identifier associated with the static route.")
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class VpnVsmartModel(FeatureTemplate):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-    _docs_description: str = "vSmart VPN Feature Template configuration."
-
-    vpn_id: VpnId = Field(
-        description="The unique identifier for the VPN, only 0 and 512 are allowed on vsmart",
-        json_schema_extra={"vmanage_key": "vpn-id"},
-    )
-    name: Optional[str] = Field(
-        default=None, description="The name of the VPN.", json_schema_extra={"vmanage_key": "name"}
-    )
-    dns: Optional[List[Dns]] = Field(
-        default=None,
-        description="A list of DNS configurations for the VPN instance.",
-    )
-    host: Optional[List[Host]] = Field(
-        default=None,
-        description="Static DNS mapping",
-        json_schema_extra={"priority_order": ["hostname", "ip"]},
-    )
-    route_v4: Optional[List[Routev4]] = Field(
-        default=None,
-        description="A list of IPv4 route configurations within the VPN instance.",
-        json_schema_extra={
-            "data_path": ["ip"],
-            "vmanage_key": "route",
-            "priority_order": ["prefix", "next-hop", "next-hop-with-track"],
-        },
-    )
-    route_v6: Optional[List[Routev6]] = Field(
-        default=None,
-        description="A list of IPv6 route configurations within the VPN instance.",
-        json_schema_extra={"data_path": ["ipv6"], "vmanage_key": "route"},
-    )
-
-    payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
-    type: ClassVar[str] = "vpn-vsmart"

catalystwan/endpoints/configuration/feature_profile/sdwan/application_priority.py

@@ -1,107 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from uuid import UUID
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put, versions
-from catalystwan.models.configuration.feature_profile.common import (
-    FeatureProfileCreationPayload,
-    FeatureProfileCreationResponse,
-    FeatureProfileDetail,
-    FeatureProfileEditPayload,
-    FeatureProfileInfo,
-    GetFeatureProfilesParams,
-)
-from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelCreationResponse
-from catalystwan.models.configuration.feature_profile.sdwan.application_priority import AnyApplicationPriorityParcel
-from catalystwan.models.configuration.feature_profile.sdwan.application_priority.policy_settings import (
-    PolicySettingsParcel,
-)
-from catalystwan.typed_list import DataSequence
-
-
-class ApplicationPriorityFeatureProfile(APIEndpoints):
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @post("/v1/feature-profile/sdwan/application-priority")
-    def create_application_priority_feature_profile(
-        self, payload: FeatureProfileCreationPayload
-    ) -> FeatureProfileCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/application-priority")
-    def get_application_priority_feature_profiles(
-        self, params: GetFeatureProfilesParams
-    ) -> DataSequence[FeatureProfileInfo]:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/application-priority/{profile_id}")
-    def get_application_priority_feature_profile(
-        self, profile_id: str, params: GetFeatureProfilesParams
-    ) -> FeatureProfileDetail:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @put("/v1/feature-profile/sdwan/application-priority/{profile_id}")
-    def edit_application_priority_feature_profile(
-        self, profile_id: str, payload: FeatureProfileEditPayload
-    ) -> FeatureProfileCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @delete("/v1/feature-profile/sdwan/application-priority/{profile_id}")
-    def delete_application_priority_feature_profile(self, profile_id: str) -> None:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @post("/v1/feature-profile/sdwan/application-priority/{profile_id}/{application_priority_list_type}")
-    def create(
-        self, profile_id: UUID, application_priority_list_type: str, payload: AnyApplicationPriorityParcel
-    ) -> ParcelCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @delete(
-        "/v1/feature-profile/sdwan/application-priority/{profile_id}/{application_priority_list_type}/{list_object_id}"
-    )
-    def delete(self, profile_id: UUID, application_priority_list_type: str, list_object_id: UUID) -> None:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @put(
-        "/v1/feature-profile/sdwan/application-priority/{profile_id}/{application_priority_list_type}/{list_object_id}"
-    )
-    def update(
-        self,
-        profile_id: UUID,
-        application_priority_list_type: str,
-        list_object_id: UUID,
-        payload: AnyApplicationPriorityParcel,
-    ) -> ParcelCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get(
-        "/v1/feature-profile/sdwan/application-priority/{profile_id}/{application_priority_list_type}/{list_object_id}"
-    )
-    def get_by_id(self, profile_id: UUID, application_priority_list_type: str, list_object_id: UUID) -> Parcel:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get(
-        "/v1/feature-profile/sdwan/application-priority/{profile_id}/{application_priority_list_type}",
-        resp_json_key="data",
-    )
-    def get_all(self, profile_id: UUID, application_priority_list_type: str) -> DataSequence[Parcel]:
-        ...
-
-    @versions(supported_versions=(">20.12"), raises=False)
-    @post("/v1/feature-profile/sdwan/application-priority/{profile_id}/policy-settings")
-    def create_policy_settings(self, profile_id: UUID, payload: PolicySettingsParcel) -> ParcelCreationResponse:
-        ...
-
-    @versions(supported_versions=(">20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/application-priority/{profile_id}/policy-settings/{list_object_id}")
-    def get_policy_settings(self, profile_id: UUID, list_object_id: UUID) -> Parcel:
-        ...

catalystwan/endpoints/configuration/feature_profile/sdwan/cli.py

@@ -1,60 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from typing import Optional
-from uuid import UUID
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put, versions
-from catalystwan.models.configuration.feature_profile.common import (
-    FeatureProfileCreationPayload,
-    FeatureProfileCreationResponse,
-    FeatureProfileInfo,
-    GetFeatureProfilesParams,
-)
-from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelCreationResponse
-from catalystwan.models.configuration.feature_profile.sdwan.cli import AnyCliParcel
-from catalystwan.typed_list import DataSequence
-
-
-class CliFeatureProfile(APIEndpoints):
-    @versions(">=20.9")
-    @get("/v1/feature-profile/sdwan/cli")
-    def get_profiles(self, payload: Optional[GetFeatureProfilesParams]) -> DataSequence[FeatureProfileInfo]:
-        ...
-
-    @versions(">=20.9")
-    @post("/v1/feature-profile/sdwan/cli")
-    def create_profile(self, payload: FeatureProfileCreationPayload) -> FeatureProfileCreationResponse:
-        ...
-
-    @versions(">=20.9")
-    @delete("/v1/feature-profile/sdwan/cli/{profile_id}")
-    def delete_profile(self, profile_id: UUID) -> None:
-        ...
-
-    @versions(">=20.9")
-    @get("/v1/feature-profile/sdwan/cli/{profile_id}/{parcel_type}")
-    def get_all(self, profile_id: UUID, parcel_type: str) -> DataSequence[Parcel[AnyCliParcel]]:
-        ...
-
-    @versions(">=20.9")
-    @get("/v1/feature-profile/sdwan/cli/{profile_id}/{parcel_type}/{parcel_id}")
-    def get_by_id(self, profile_id: UUID, parcel_type: str, parcel_id: UUID) -> Parcel[AnyCliParcel]:
-        ...
-
-    @versions(">=20.9")
-    @post("/v1/feature-profile/sdwan/cli/{profile_id}/{parcel_type}")
-    def create(self, profile_id: UUID, parcel_type: str, payload: AnyCliParcel) -> ParcelCreationResponse:
-        ...
-
-    @versions(">=20.9")
-    @put("/v1/feature-profile/sdwan/cli/{profile_id}/{parcel_type}/{parcel_id}")
-    def update(
-        self, profile_id: UUID, parcel_type: str, parcel_id: UUID, payload: AnyCliParcel
-    ) -> ParcelCreationResponse:
-        ...
-
-    @versions(">=20.9")
-    @delete("/v1/feature-profile/sdwan/cli/{profile_id}/{parcel_type}/{parcel_id}")
-    def delete(self, profile_id: UUID, parcel_type: str, parcel_id: UUID) -> None:
-        ...

catalystwan/endpoints/configuration/feature_profile/sdwan/dns_security.py

@@ -1,83 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from uuid import UUID
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put, versions
-from catalystwan.models.configuration.feature_profile.common import (
-    FeatureProfileCreationPayload,
-    FeatureProfileCreationResponse,
-    FeatureProfileDetail,
-    FeatureProfileEditPayload,
-    FeatureProfileInfo,
-    GetFeatureProfilesParams,
-)
-from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelCreationResponse
-from catalystwan.models.configuration.feature_profile.sdwan.dns_security import AnyDnsSecurityParcel
-from catalystwan.typed_list import DataSequence
-
-
-class DnsSecurityFeatureProfile(APIEndpoints):
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @post("/v1/feature-profile/sdwan/dns-security")
-    def create_dns_security_feature_profile(
-        self, payload: FeatureProfileCreationPayload
-    ) -> FeatureProfileCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/dns-security")
-    def get_dns_security_feature_profiles(self, params: GetFeatureProfilesParams) -> DataSequence[FeatureProfileInfo]:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/dns-security/{profile_id}")
-    def get_dns_security_feature_profile(
-        self, profile_id: str, params: GetFeatureProfilesParams
-    ) -> FeatureProfileDetail:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @put("/v1/feature-profile/sdwan/dns-security/{profile_id}")
-    def edit_dns_security_feature_profile(
-        self, profile_id: str, payload: FeatureProfileEditPayload
-    ) -> FeatureProfileCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @delete("/v1/feature-profile/sdwan/dns-security/{profile_id}")
-    def delete_dns_security_feature_profile(self, profile_id: str) -> None:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @post("/v1/feature-profile/sdwan/dns-security/{profile_id}/{dns_security_list_type}")
-    def create(
-        self, profile_id: UUID, dns_security_list_type: str, payload: AnyDnsSecurityParcel
-    ) -> ParcelCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @delete("/v1/feature-profile/sdwan/dns-security/{profile_id}/{dns_security_list_type}/{list_object_id}")
-    def delete(self, profile_id: UUID, dns_security_list_type: str, list_object_id: UUID) -> None:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @put("/v1/feature-profile/sdwan/dns-security/{profile_id}/{dns_security_list_type}/{list_object_id}")
-    def update(
-        self,
-        profile_id: UUID,
-        dns_security_list_type: str,
-        list_object_id: UUID,
-        payload: AnyDnsSecurityParcel,
-    ) -> ParcelCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/dns-security/{profile_id}/{dns_security_list_type}/{list_object_id}")
-    def get_by_id(self, profile_id: UUID, dns_security_list_type: str, list_object_id: UUID) -> Parcel:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/dns-security/{profile_id}/{dns_security_list_type}", resp_json_key="data")
-    def get_all(self, profile_id: UUID, dns_security_list_type: str) -> DataSequence[Parcel]:
-        ...

catalystwan/endpoints/configuration/feature_profile/sdwan/embedded_security.py

@@ -1,88 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from uuid import UUID
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put, versions
-from catalystwan.models.configuration.feature_profile.common import (
-    FeatureProfileCreationPayload,
-    FeatureProfileCreationResponse,
-    FeatureProfileDetail,
-    FeatureProfileEditPayload,
-    FeatureProfileInfo,
-    GetFeatureProfilesParams,
-)
-from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelCreationResponse
-from catalystwan.models.configuration.feature_profile.sdwan.embedded_security import (
-    AnyEmbeddedSecurityParcel,
-    PolicyParcel,
-)
-from catalystwan.typed_list import DataSequence
-
-
-class EmbeddedSecurityFeatureProfile(APIEndpoints):
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @post("/v1/feature-profile/sdwan/embedded-security")
-    def create_embedded_security_feature_profile(
-        self, payload: FeatureProfileCreationPayload
-    ) -> FeatureProfileCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/embedded-security")
-    def get_embedded_security_feature_profiles(
-        self, params: GetFeatureProfilesParams
-    ) -> DataSequence[FeatureProfileInfo]:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/embedded-security/{profile_id}")
-    def get_embedded_security_feature_profile(
-        self, profile_id: str, params: GetFeatureProfilesParams
-    ) -> FeatureProfileDetail:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @put("/v1/feature-profile/sdwan/embedded-security/{profile_id}")
-    def edit_embedded_security_feature_profile(
-        self, profile_id: str, payload: FeatureProfileEditPayload
-    ) -> FeatureProfileCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @delete("/v1/feature-profile/sdwan/embedded-security/{profile_id}")
-    def delete_embedded_security_feature_profile(self, profile_id: str) -> None:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @post("/v1/feature-profile/sdwan/embedded-security/{profile_id}/{embedded_security_list_type}")
-    def create(
-        self, profile_id: UUID, embedded_security_list_type: str, payload: PolicyParcel
-    ) -> ParcelCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @delete("/v1/feature-profile/sdwan/embedded-security/{profile_id}/{embedded_security_list_type}/{list_object_id}")
-    def delete(self, profile_id: UUID, embedded_security_list_type: str, list_object_id: UUID) -> None:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @put("/v1/feature-profile/sdwan/embedded-security/{profile_id}/{embedded_security_list_type}/{list_object_id}")
-    def update(
-        self,
-        profile_id: UUID,
-        embedded_security_list_type: str,
-        list_object_id: UUID,
-        payload: AnyEmbeddedSecurityParcel,
-    ) -> ParcelCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/embedded-security/{profile_id}/{embedded_security_list_type}/{list_object_id}")
-    def get_by_id(self, profile_id: UUID, embedded_security_list_type: str, list_object_id: UUID) -> Parcel:
-        ...
-
-    @versions(supported_versions=(">=20.12"), raises=False)
-    @get("/v1/feature-profile/sdwan/embedded-security/{profile_id}/{embedded_security_list_type}", resp_json_key="data")
-    def get_all(self, profile_id: UUID, embedded_security_list_type: str) -> DataSequence[Parcel]:
-        ...

catalystwan/endpoints/configuration/feature_profile/sdwan/other.py

@@ -1,62 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from typing import Optional
-from uuid import UUID
-
-from catalystwan.api.configuration_groups.parcel import _ParcelBase
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put, versions
-from catalystwan.models.configuration.feature_profile.common import (
-    FeatureProfileCreationPayload,
-    FeatureProfileCreationResponse,
-    FeatureProfileInfo,
-    GetFeatureProfilesParams,
-)
-from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelId
-from catalystwan.typed_list import DataSequence
-
-
-class OtherFeatureProfile(APIEndpoints):
-    @versions(supported_versions=(">=20.9"), raises=False)
-    @get("/v1/feature-profile/sdwan/other")
-    def get_sdwan_other_feature_profiles(
-        self, payload: Optional[GetFeatureProfilesParams]
-    ) -> DataSequence[FeatureProfileInfo]:
-        ...
-
-    @versions(supported_versions=(">=20.9"), raises=False)
-    @post("/v1/feature-profile/sdwan/other")
-    def create_sdwan_other_feature_profile(
-        self, payload: FeatureProfileCreationPayload
-    ) -> FeatureProfileCreationResponse:
-        ...
-
-    @versions(supported_versions=(">=20.9"), raises=False)
-    @delete("/v1/feature-profile/sdwan/other/{profile_id}")
-    def delete_sdwan_other_feature_profile(self, profile_id: UUID) -> None:
-        ...
-
-    @versions(supported_versions=(">=20.9"), raises=False)
-    @get("/v1/feature-profile/sdwan/other/{profile_id}/{parcel_type}")
-    def get_all(self, profile_id: UUID, parcel_type: UUID) -> DataSequence[Parcel]:
-        ...
-
-    @versions(supported_versions=(">=20.9"), raises=False)
-    @get("/v1/feature-profile/sdwan/other/{profile_id}/{parcel_type}/{parcel_id}")
-    def get_by_id(self, profile_id: UUID, parcel_type: str, parcel_id: UUID) -> Parcel:
-        ...
-
-    @versions(supported_versions=(">=20.9"), raises=False)
-    @put("/v1/feature-profile/sdwan/other/{profile_id}/{parcel_type}/{parcel_id}")
-    def update(self, profile_id: UUID, parcel_type: str, parcel_id: UUID, payload: _ParcelBase) -> None:
-        ...
-
-    @versions(supported_versions=(">=20.9"), raises=False)
-    @delete("/v1/feature-profile/sdwan/other/{profile_id}/{parcel_type}/{parcel_id}")
-    def delete(self, profile_id: UUID, parcel_type: str, parcel_id: UUID) -> None:
-        ...
-
-    @versions(supported_versions=(">=20.9"), raises=False)
-    @post("/v1/feature-profile/sdwan/other/{profile_id}/{parcel_type}")
-    def create(self, profile_id: UUID, parcel_type: str, payload: _ParcelBase) -> ParcelId:
-        ...