catalystwan 0.33.7.dev2__tar.gz → 0.33.7.dev3__tar.gz

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: catalystwan
-Version: 0.33.7.dev2
+Version: 0.33.7.dev3
 Summary: Cisco Catalyst WAN SDK for Python
 Home-page: https://github.com/cisco-open/cisco-catalyst-wan-sdk
 Author: kagorski

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/api/feature_profile_api.py

@@ -74,7 +74,7 @@ from catalystwan.models.configuration.feature_profile.common import (
     FeatureProfileCreationPayload,
     FeatureProfileCreationResponse,
     FeatureProfileInfo,
-    GetFeatureProfilesPayload,
+    GetFeatureProfilesParams,
     GetReferenceCountFeatureProfilesPayload,
 )
 from catalystwan.models.configuration.feature_profile.parcel import (
@@ -216,7 +216,7 @@ class TransportFeatureProfileAPI:
         """
         Get all Transport Feature Profiles
         """
-        payload = GetFeatureProfilesPayload(limit=limit if limit else None, offset=offset if offset else None)
+        payload = GetFeatureProfilesParams(limit=limit if limit else None, offset=offset if offset else None)
 
         return self.endpoint.get_transport_feature_profiles(payload)
 
@@ -322,7 +322,7 @@ class OtherFeatureProfileAPI:
         """
         Get all Other Feature Profiles
         """
-        payload = GetFeatureProfilesPayload(limit=limit if limit else None, offset=offset if offset else None)
+        payload = GetFeatureProfilesParams(limit=limit if limit else None, offset=offset if offset else None)
 
         return self.endpoint.get_sdwan_other_feature_profiles(payload)
 
@@ -389,7 +389,7 @@ class ServiceFeatureProfileAPI:
         """
         Get all Service Feature Profiles
         """
-        payload = GetFeatureProfilesPayload(limit=limit if limit else None, offset=offset if offset else None)
+        payload = GetFeatureProfilesParams(limit=limit if limit else None, offset=offset if offset else None)
 
         return self.endpoint.get_sdwan_service_feature_profiles(payload)
 
@@ -445,7 +445,7 @@ class SystemFeatureProfileAPI:
         """
         Get all System Feature Profiles
         """
-        payload = GetFeatureProfilesPayload(limit=limit if limit else None, offset=offset if offset else None)
+        payload = GetFeatureProfilesParams(limit=limit if limit else None, offset=offset if offset else None)
 
         return self.endpoint.get_sdwan_system_feature_profiles(payload)
 
@@ -813,6 +813,12 @@ class PolicyObjectFeatureProfileAPI:
     def get_profiles(self) -> DataSequence[FeatureProfileInfo]:
         return self.endpoint.get_profiles()
 
+    def create_profile(self, profile: FeatureProfileCreationPayload) -> FeatureProfileCreationResponse:
+        return self.endpoint.create_profile()
+
+    def delete_profile(self, profile_id: UUID) -> None:
+        return self.endpoint.delete_profile(profile_id=profile_id)
+
     @overload
     def get(
         self, profile_id: UUID, parcel_type: Type[AdvancedInspectionProfileParcel]
@@ -1202,7 +1208,7 @@ class EmbeddedSecurityFeatureProfileAPI:
         """
         Get all Embedded Security Feature Profiles
         """
-        payload = GetFeatureProfilesPayload(limit=limit if limit else None, offset=offset if offset else None)
+        payload = GetFeatureProfilesParams(limit=limit if limit else None, offset=offset if offset else None)
 
         return self.endpoint.get_embedded_security_feature_profiles(payload)
 
@@ -1312,7 +1318,7 @@ class CliFeatureProfileAPI:
         """
         Get all CLI Feature Profiles
         """
-        payload = GetFeatureProfilesPayload(limit=limit if limit else None, offset=offset if offset else None)
+        payload = GetFeatureProfilesParams(limit=limit if limit else None, offset=offset if offset else None)
 
         return self.endpoint.get_profiles(payload)
 
@@ -1373,7 +1379,7 @@ class DnsSecurityFeatureProfileAPI:
         """
         Get all DNS Security Feature Profiles
         """
-        payload = GetFeatureProfilesPayload(limit=limit if limit else None, offset=offset if offset else None)
+        payload = GetFeatureProfilesParams(limit=limit if limit else None, offset=offset if offset else None)
 
         return self.endpoint.get_dns_security_feature_profiles(payload)
 
@@ -1486,7 +1492,7 @@ class ApplicationPriorityFeatureProfileAPI:
         """
         Get all Application Priority Feature Profiles
         """
-        payload = GetFeatureProfilesPayload(limit=limit if limit else None, offset=offset if offset else None)
+        payload = GetFeatureProfilesParams(limit=limit if limit else None, offset=offset if offset else None)
 
         return self.endpoint.get_application_priority_feature_profiles(payload)
 
@@ -1613,7 +1619,7 @@ class TopologyFeatureProfileAPI:
         """
         Get all Topology Feature Profiles
         """
-        payload = GetFeatureProfilesPayload(limit=limit, offset=offset)
+        payload = GetFeatureProfilesParams(limit=limit, offset=offset)
         return self.endpoint.get_topology_feature_profiles(payload)
 
     def create_profile(self, name: str, description: str) -> FeatureProfileCreationResponse:

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/endpoints/configuration/feature_profile/sdwan/application_priority.py

@@ -10,7 +10,7 @@ from catalystwan.models.configuration.feature_profile.common import (
     FeatureProfileDetail,
     FeatureProfileEditPayload,
     FeatureProfileInfo,
-    GetFeatureProfilesPayload,
+    GetFeatureProfilesParams,
 )
 from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelCreationResponse
 from catalystwan.models.configuration.feature_profile.sdwan.application_priority import AnyApplicationPriorityParcel
@@ -28,14 +28,14 @@ class ApplicationPriorityFeatureProfile(APIEndpoints):
     @versions(supported_versions=(">=20.12"), raises=False)
     @get("/v1/feature-profile/sdwan/application-priority")
     def get_application_priority_feature_profiles(
-        self, params: GetFeatureProfilesPayload
+        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: GetFeatureProfilesPayload
+        self, profile_id: str, params: GetFeatureProfilesParams
     ) -> FeatureProfileDetail:
         ...
 

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/endpoints/configuration/feature_profile/sdwan/cli.py

@@ -9,7 +9,7 @@ from catalystwan.models.configuration.feature_profile.common import (
     FeatureProfileCreationPayload,
     FeatureProfileCreationResponse,
     FeatureProfileInfo,
-    GetFeatureProfilesPayload,
+    GetFeatureProfilesParams,
 )
 from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelId
 from catalystwan.models.configuration.feature_profile.sdwan.cli import ConfigParcel
@@ -19,7 +19,7 @@ from catalystwan.typed_list import DataSequence
 class CliFeatureProfile(APIEndpoints):
     # @versions(supported_versions=(">=20.9"), raises=False)
     @get("/v1/feature-profile/sdwan/cli")
-    def get_profiles(self, payload: Optional[GetFeatureProfilesPayload]) -> DataSequence[FeatureProfileInfo]:
+    def get_profiles(self, payload: Optional[GetFeatureProfilesParams]) -> DataSequence[FeatureProfileInfo]:
         ...
 
     # @versions(supported_versions=(">=20.9"), raises=False)

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/endpoints/configuration/feature_profile/sdwan/dns_security.py

@@ -10,7 +10,7 @@ from catalystwan.models.configuration.feature_profile.common import (
     FeatureProfileDetail,
     FeatureProfileEditPayload,
     FeatureProfileInfo,
-    GetFeatureProfilesPayload,
+    GetFeatureProfilesParams,
 )
 from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelCreationResponse
 from catalystwan.models.configuration.feature_profile.sdwan.dns_security import AnyDnsSecurityParcel
@@ -27,13 +27,13 @@ class DnsSecurityFeatureProfile(APIEndpoints):
 
     @versions(supported_versions=(">=20.12"), raises=False)
     @get("/v1/feature-profile/sdwan/dns-security")
-    def get_dns_security_feature_profiles(self, params: GetFeatureProfilesPayload) -> DataSequence[FeatureProfileInfo]:
+    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: GetFeatureProfilesPayload
+        self, profile_id: str, params: GetFeatureProfilesParams
     ) -> FeatureProfileDetail:
         ...
 

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/endpoints/configuration/feature_profile/sdwan/embedded_security.py

@@ -10,7 +10,7 @@ from catalystwan.models.configuration.feature_profile.common import (
     FeatureProfileDetail,
     FeatureProfileEditPayload,
     FeatureProfileInfo,
-    GetFeatureProfilesPayload,
+    GetFeatureProfilesParams,
 )
 from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelCreationResponse
 from catalystwan.models.configuration.feature_profile.sdwan.embedded_security import (
@@ -31,14 +31,14 @@ class EmbeddedSecurityFeatureProfile(APIEndpoints):
     @versions(supported_versions=(">=20.12"), raises=False)
     @get("/v1/feature-profile/sdwan/embedded-security")
     def get_embedded_security_feature_profiles(
-        self, params: GetFeatureProfilesPayload
+        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: GetFeatureProfilesPayload
+        self, profile_id: str, params: GetFeatureProfilesParams
     ) -> FeatureProfileDetail:
         ...
 

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/endpoints/configuration/feature_profile/sdwan/other.py

@@ -10,7 +10,7 @@ from catalystwan.models.configuration.feature_profile.common import (
     FeatureProfileCreationPayload,
     FeatureProfileCreationResponse,
     FeatureProfileInfo,
-    GetFeatureProfilesPayload,
+    GetFeatureProfilesParams,
 )
 from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelId
 from catalystwan.typed_list import DataSequence
@@ -20,7 +20,7 @@ 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[GetFeatureProfilesPayload]
+        self, payload: Optional[GetFeatureProfilesParams]
     ) -> DataSequence[FeatureProfileInfo]:
         ...
 

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/endpoints/configuration/feature_profile/sdwan/policy_object.py

@@ -4,7 +4,12 @@
 from uuid import UUID
 
 from catalystwan.endpoints import APIEndpoints, delete, get, post, put, versions
-from catalystwan.models.configuration.feature_profile.common import FeatureProfileInfo, GetFeatureProfilesPayload
+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.policy_object import AnyPolicyObjectParcel
 from catalystwan.typed_list import DataSequence
@@ -14,10 +19,20 @@ class PolicyObjectFeatureProfile(APIEndpoints):
     @versions(supported_versions=(">=20.12"), raises=False)
     @get("/v1/feature-profile/sdwan/policy-object")
     def get_profiles(
-        self, params: GetFeatureProfilesPayload = GetFeatureProfilesPayload()
+        self, params: GetFeatureProfilesParams = GetFeatureProfilesParams()
     ) -> DataSequence[FeatureProfileInfo]:
         ...
 
+    @versions(supported_versions=(">=20.12"), raises=False)
+    @post("/v1/feature-profile/sdwan/policy-object")
+    def create_profile(self, payload: FeatureProfileCreationPayload) -> FeatureProfileCreationResponse:
+        ...
+
+    @versions(supported_versions=(">=20.12"), raises=False)
+    @delete("/v1/feature-profile/sdwan/policy-object/{profile_id}")
+    def delete_profile(self, profile_id: UUID) -> None:
+        ...
+
     @versions(supported_versions=(">=20.12"), raises=False)
     @post("/v1/feature-profile/sdwan/policy-object/{profile_id}/{policy_object_list_type}")
     def create(

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/endpoints/configuration/feature_profile/sdwan/service.py

@@ -9,7 +9,7 @@ from catalystwan.models.configuration.feature_profile.common import (
     FeatureProfileCreationPayload,
     FeatureProfileCreationResponse,
     FeatureProfileInfo,
-    GetFeatureProfilesPayload,
+    GetFeatureProfilesParams,
 )
 from catalystwan.models.configuration.feature_profile.parcel import ParcelAssociationPayload, ParcelCreationResponse
 from catalystwan.models.configuration.feature_profile.sdwan.service import (
@@ -23,7 +23,7 @@ class ServiceFeatureProfile(APIEndpoints):
     @versions(supported_versions=(">=20.9"), raises=False)
     @get("/v1/feature-profile/sdwan/service")
     def get_sdwan_service_feature_profiles(
-        self, payload: Optional[GetFeatureProfilesPayload]
+        self, payload: Optional[GetFeatureProfilesParams]
     ) -> DataSequence[FeatureProfileInfo]:
         ...
 

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/endpoints/configuration/feature_profile/sdwan/system.py

@@ -10,7 +10,7 @@ from catalystwan.models.configuration.feature_profile.common import (
     FeatureProfileCreationPayload,
     FeatureProfileCreationResponse,
     FeatureProfileInfo,
-    GetFeatureProfilesPayload,
+    GetFeatureProfilesParams,
     SchemaTypeQuery,
 )
 from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelId
@@ -38,7 +38,7 @@ class SystemFeatureProfile(APIEndpoints):
     @versions(supported_versions=(">=20.9"), raises=False)
     @get("/v1/feature-profile/sdwan/system")
     def get_sdwan_system_feature_profiles(
-        self, payload: Optional[GetFeatureProfilesPayload]
+        self, payload: Optional[GetFeatureProfilesParams]
     ) -> DataSequence[FeatureProfileInfo]:
         ...
 

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/endpoints/configuration/feature_profile/sdwan/topology.py

@@ -11,7 +11,7 @@ from catalystwan.models.configuration.feature_profile.common import (
     FeatureProfileDetail,
     FeatureProfileEditPayload,
     FeatureProfileInfo,
-    GetFeatureProfilesPayload,
+    GetFeatureProfilesParams,
     SchemaTypeQuery,
 )
 from catalystwan.models.configuration.feature_profile.parcel import Parcel, ParcelCreationResponse
@@ -27,12 +27,12 @@ class TopologyFeatureProfile(APIEndpoints):
 
     @versions(supported_versions=(">=20.12"), raises=False)
     @get("/v1/feature-profile/sdwan/topology")
-    def get_topology_feature_profiles(self, params: GetFeatureProfilesPayload) -> DataSequence[FeatureProfileInfo]:
+    def get_topology_feature_profiles(self, params: GetFeatureProfilesParams) -> DataSequence[FeatureProfileInfo]:
         ...
 
     @versions(supported_versions=(">=20.12"), raises=False)
     @get("/v1/feature-profile/sdwan/topology/{profile_id}")
-    def get_topology_feature_profile(self, profile_id: str, params: GetFeatureProfilesPayload) -> FeatureProfileDetail:
+    def get_topology_feature_profile(self, profile_id: str, params: GetFeatureProfilesParams) -> FeatureProfileDetail:
         ...
 
     @versions(supported_versions=(">=20.12"), raises=False)

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/endpoints/configuration/feature_profile/sdwan/transport.py

@@ -12,7 +12,7 @@ from catalystwan.models.configuration.feature_profile.common import (
     FeatureProfileDetail,
     FeatureProfileEditPayload,
     FeatureProfileInfo,
-    GetFeatureProfilesPayload,
+    GetFeatureProfilesParams,
     SchemaTypeQuery,
 )
 from catalystwan.models.configuration.feature_profile.parcel import (
@@ -39,14 +39,12 @@ class TransportFeatureProfile(APIEndpoints):
 
     @versions(supported_versions=(">=20.12"), raises=False)
     @get("/v1/feature-profile/sdwan/transport")
-    def get_transport_feature_profiles(self, params: GetFeatureProfilesPayload) -> DataSequence[FeatureProfileInfo]:
+    def get_transport_feature_profiles(self, params: GetFeatureProfilesParams) -> DataSequence[FeatureProfileInfo]:
         ...
 
     @versions(supported_versions=(">=20.12"), raises=False)
     @get("/v1/feature-profile/sdwan/transport/{profile_id}")
-    def get_transport_feature_profile(
-        self, profile_id: UUID, params: GetFeatureProfilesPayload
-    ) -> FeatureProfileDetail:
+    def get_transport_feature_profile(self, profile_id: UUID, params: GetFeatureProfilesParams) -> FeatureProfileDetail:
         ...
 
     @versions(supported_versions=(">=20.12"), raises=False)
@@ -125,7 +123,7 @@ class TransportFeatureProfile(APIEndpoints):
     @versions(supported_versions=(">=20.9"), raises=False)
     @get("/v1/feature-profile/sdwan/transport")
     def get_sdwan_transport_feature_profiles(
-        self, payload: Optional[GetFeatureProfilesPayload]
+        self, payload: Optional[GetFeatureProfilesParams]
     ) -> DataSequence[FeatureProfileInfo]:
         ...
 

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/models/configuration/config_migration.py

@@ -476,7 +476,6 @@ class PolicyConvertContext:
     def from_configs(
         network_hierarchy: List[NodeInfo],
         transformed_parcels: List[TransformedParcel],
-        policy_list_infos: List[AnyPolicyListInfo],
     ) -> "PolicyConvertContext":
         context = PolicyConvertContext()
         for node in network_hierarchy:

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/models/configuration/feature_profile/common.py

@@ -112,12 +112,12 @@ class SchemaTypeQuery(BaseModel):
     schema_type: SchemaType = Field(alias="schemaType")
 
 
-class GetFeatureProfilesPayload(BaseModel):
+class GetFeatureProfilesParams(BaseModel):
     limit: Optional[int] = None
     offset: Optional[int] = None
 
 
-class GetReferenceCountFeatureProfilesPayload(GetFeatureProfilesPayload):
+class GetReferenceCountFeatureProfilesPayload(GetFeatureProfilesParams):
     model_config = ConfigDict(populate_by_name=True)
 
     reference_count: Optional[bool] = Field(serialization_alias="referenceCount", validation_alias="referenceCount")

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/utils/config_migration/creators/config_pusher.py

@@ -14,7 +14,7 @@ from catalystwan.models.configuration.config_migration import (
     UX2Config,
     UX2ConfigPushResult,
 )
-from catalystwan.models.configuration.feature_profile.common import ProfileType
+from catalystwan.models.configuration.feature_profile.common import FeatureProfileCreationPayload, ProfileType
 from catalystwan.models.configuration.feature_profile.parcel import AnyParcel, Parcel, list_types
 from catalystwan.models.configuration.feature_profile.sdwan.policy_object import AnyPolicyObjectParcel
 from catalystwan.models.configuration.feature_profile.sdwan.topology.custom_control import CustomControlParcel
@@ -54,7 +54,7 @@ class UX2ConfigPusher:
     def push(self) -> UX2ConfigPushResult:
         self._create_cloud_credentials()
         self._create_config_groups()
-        dpop = self._get_default_policy_object_profile()
+        dpop = self._get_or_create_default_policy_object_profile()
         self._insert_groups_of_interest_in_default_policy_object_profile(dpop)
         self._create_topology_groups(dpop)  # needs to be executed after vpn parcels and groups of interests are created
         self._push_result.report.set_failed_push_parcels_flat_list()
@@ -102,9 +102,14 @@ class UX2ConfigPusher:
                     feature_profiles=created_profiles,
                 )
 
-    def _get_default_policy_object_profile(self) -> UUID:
+    def _get_or_create_default_policy_object_profile(self) -> UUID:
         api = self._session.api.sdwan_feature_profiles.policy_object
-        profile_id = api.get_profiles().find(solution="sdwan", created_by="system").profile_id
+        profiles = api.get_profiles()
+        if len(profiles) >= 1:
+            return profiles[0].profile_id
+        profile_id = api.create_profile(
+            FeatureProfileCreationPayload(name="Policy_Profile_Global", description="Policy_Profile_Global_description")
+        ).id
         return profile_id
 
     def _insert_groups_of_interest_in_default_policy_object_profile(self, profile_id: UUID):

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/catalystwan/workflows/config_migration.py

@@ -392,9 +392,7 @@ def transform(ux1: UX1Config, add_suffix: bool = True) -> ConfigTransformResult:
         ux2.cloud_credentials = create_cloud_credentials_from_templates(cloud_credential_templates)
 
     # Prepare Context for Policy Conversion (VPN Parcels must be already transformed)
-    policy_context = PolicyConvertContext.from_configs(
-        ux1.network_hierarchy, ux2.profile_parcels, ux1.policies.policy_lists
-    )
+    policy_context = PolicyConvertContext.from_configs(ux1.network_hierarchy, ux2.profile_parcels)
 
     # Policy Lists
     for policy_list in ux1.policies.policy_lists:

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "catalystwan"
-version = "0.33.7dev2"
+version = "0.33.7dev3"
 description = "Cisco Catalyst WAN SDK for Python"
 authors = ["kagorski <kagorski@cisco.com>"]
 readme = "README.md"

{catalystwan-0.33.7.dev2 → catalystwan-0.33.7.dev3}/setup.py

@@ -101,7 +101,7 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'catalystwan',
-    'version': '0.33.7.dev2',
+    'version': '0.33.7.dev3',
     'description': 'Cisco Catalyst WAN SDK for Python',
     'long_description': '<p align="center">\n  <a href="#"><img src="docs/images/catalystwan.svg" alt="Cisco Catalyst WAN SDK Logo" style="height:150px" />\n</p>\n\n[![Python-Supported](https://img.shields.io/static/v1?label=Python&logo=Python&color=3776AB&message=3.8%20|%203.9%20|%203.10%20|%203.11%20|%203.12)](https://www.python.org/)\n\nCisco Catalyst WAN SDK is a package for creating simple and parallel automatic requests via official SD-WAN Manager API. It is intended to serve as a multiple session handler (provider, provider as a tenant, tenant). The library is not dependent on environment which is being run in, you just need a connection to any SD-WAN Manager.\n\n## Important Notice: Early Beta Release\n\nWelcome to the Cisco Catalyst WAN SDK!\n\nWe are thrilled to announce that Cisco Catalyst WAN SDK is now available in early beta. This is an exciting step forward in enabling developers to harness the full potential of Cisco\'s networking solutions.  Please be aware that, as an early beta release, this version of the SDK is still undergoing development and testing. As such, it is provided "as is" and support to address any issues are limited and best effort.\n\n## Not recommend to use in production environments.\nWe encourage developers to explore and test the SDK\'s capabilities, but please exercise caution when using it in production environments.  We are dedicated to improving the Cisco Catalyst WAN SDK and we value your input. Your feedback is crucial to us-it will guide us in refining and enhancing the SDK to better meet your needs.\nTo report any issues, share your insights, or suggest improvements, please visit our Issues page on GitHub or reach out to us through the provided communication channels.\n\nThank you for being a part of our development journey!\n\n## Installation\n```console\npip install catalystwan\n```\n\n## Manager Session\nIn order to execute SDK APIs **ManagerSession** needs to be created. The fastest way to get started is to use `create_manager_session()` method which configures session, performs authentication for given credentials and returns **ManagerSession** instance in operational state. **ManagerSession** provides a collection of supported APIs in `api` instance variable.\nPlease check example below:\n\n```python\nfrom catalystwan.session import create_manager_session\n\nurl = "example.com"\nusername = "admin"\npassword = "password123"\n\nwith create_manager_session(url=url, username=username, password=password) as session:\n    devices = session.api.devices.get()\n    print(devices)\n```\n**ManagerSession** extends [requests.Session](https://requests.readthedocs.io/en/latest/user/advanced/#session-objects) so all functionality from [requests](https://requests.readthedocs.io/en/latest/) library is avaiable to user, it also implements python [contextmanager](https://docs.python.org/3.8/library/contextlib.html#contextlib.contextmanager) and automatically frees server resources on exit.\n\n<details>\n    <summary> <b>Configure Manager Session before using</b> <i>(click to expand)</i></summary>\n\nIt is possible to configure **ManagerSession** prior sending any request.\n\n```python\nfrom catalystwan.session import ManagerSession\n\nurl = "example.com"\nusername = "admin"\npassword = "password123"\n\n# configure session using constructor - nothing will be sent to target server yet\nsession = ManagerSession(url=url, username=username, password=password)\n# login and send requests\nsession.login()\nsession.get("/dataservice/device")\nsession.close()\n```\nWhen interacting with the SDWAN Manager API without using a context manager, it\'s important \nto manually execute the `close()` method to release the user session resource.\nEnsure that the `close()` method is called after you have finished using the session to maintain optimal resource management and avoid potential errors.\n\n</details>\n\n<details>\n    <summary> <b>Login as Tenant</b> <i>(click to expand)</i></summary>\n\nTenant domain needs to be provided in url together with Tenant credentials.\n\n```python\nfrom catalystwan.session import create_manager_session\n\nurl = "tenant.example.com"\nusername = "tenant_user"\npassword = "password123"\n\nwith create_manager_session(url=url, username=username, password=password) as session:\n    print(session.session_type)\n```\n\n</details>\n\n<details>\n    <summary> <b>Login as Provider-as-Tenant</b> <i>(click to expand)</i></summary>\n\nTenant `subdomain` needs to be provided as additional argument together with Provider credentials.\n\n```python\nfrom catalystwan.session import create_manager_session\n\nurl = "example.com"\nusername = "provider"\npassword = "password123"\nsubdomain = "tenant.example.com"\n\nwith create_manager_session(url=url, username=username, password=password, subdomain=subdomain) as session:\n    print(session.session_type)\n```\n\n</details>\n\n\n\n## API usage examples\nAll examples below assumes `session` variable contains logged-in [Manager Session](#Manager-Session) instance.\n\n<details>\n    <summary> <b>Get devices</b> <i>(click to expand)</i></summary>\n\n```python\ndevices = session.api.devices.get()\n```\n\n</details>\n\n<details>\n    <summary> <b>Admin Tech</b> <i>(click to expand)</i></summary>\n\n```Python\nadmin_tech_file = session.api.admin_tech.generate("172.16.255.11")\nsession.api.admin_tech.download(admin_tech_file)\nsession.api.admin_tech.delete(admin_tech_file)\n```\n</details>\n\n<details>\n    <summary> <b>Speed test</b> <i>(click to expand)</i></summary>\n\n```python\ndevices = session.api.devices.get()\nspeedtest = session.api.speedtest.speedtest(devices[0], devices[1])\n```\n\n</details>\n\n<details>\n    <summary> <b>Upgrade device</b> <i>(click to expand)</i></summary>\n\n```python\n# Prepare devices list\ncontrollers = session.endpoints.configuration_device_inventory.get_device_details(\'controllers\')\nvsmarts = controllers.filter(personality=Personality.VSMART)\nimage = "viptela-20.7.2-x86_64.tar.gz"\n\n# Upload image\nsession.api.repository.upload_image(image)\n\n# Install software\n\ninstall_task = session.api.software.install(devices=vsmarts, image=image)\n\n# Check action status\ninstall_task.wait_for_completed()\n```\n\n</details>\n\n<details>\n    <summary> <b>Get alarms</b> <i>(click to expand)</i></summary>\nTo get all alarms:\n\n```python\nalarms = session.api.alarms.get()\n```\n\nTo get all not viewed alarms:\n\n```python\nnot_viewed_alarms = session.api.alarms.get().filter(viewed=False)\n```\n\nTo get all alarms from past `n` hours:\n\n```python\nn = 24\nalarms_from_n_hours = session.api.alarms.get(from_time=n)\n```\n\nTo get all critical alarms from past `n` hours:\n\n```python\nn = 48\ncritical_alarms = session.api.alarms.get(from_time=n).filter(severity=Severity.CRITICAL)\n```\n\n</details>\n\n<details>\n    <summary> <b>Users</b> <i>(click to expand)</i></summary>\n\n```python\n# Get all users\nsession.api.users.get()\n\n# Create user\nnew_user = User(username="new_user", password="new_user", group=["netadmin"], description="new user")\nsession.api.users.create(new_user)\n\n# Update user data\nnew_user_update = UserUpdateRequest(username="new_user", group=["netadmin", "netops"], locale="en_US", description="updated-new_user-description")\nsession.api.users.update(new_user_update)\n\n# Update user password\nsession.api.users.update_password("new_user", "n3W-P4s$w0rd")\n\n# Reset user\nsession.api.users.reset("new_user")\n\n# Delete user\nsession.api.users.delete("new_user")\n\n# Get current user authentication type and role\nsession.api.users.get_auth_type()\nsession.api.users.get_role()\n```\n\n</details>\n\n<details>\n    <summary> <b>User Groups</b> <i>(click to expand)</i></summary>\n\n```python\n# Get all user groups\nsession.api.user_groups.get()\n\n# Create user group\ngroup = UserGroup("new_user_group", [])\ngroup.enable_read({"Audit Log", "Alarms"})\ngroup.enable_read_and_write({"Device Inventory"})\nsession.api.user_groups.create(group)\n\n# Update user group\ngroup.disable({"Alarms"})\nsession.api.user_groups.update(group)\n\n# Delete user group\nsession.api.user_groups.delete(group.group_name)\n```\n\n</details>\n\n</details>\n\n<details>\n    <summary> <b>Sessions</b> <i>(click to expand)</i></summary>\n\n```python\n# Get all active sessions\nactive_sessions = session.api.sessions.get()\n\n# Invalidate sessions for given user\nnew_user_sessions = active_sessions.filter(raw_username="new_user")\nsession.api.sessions.invalidate(new_user_sessions)\n```\n\n</details>\n\n<details>\n    <summary> <b>Resource Groups</b> <i>(click to expand)</i></summary>\n\n```python\n# get resource groups\nsession.api.resource_groups.get()\n\n# create resource group\nnew_resource_group = ResourceGroup(\n    name="new_resource_group",\n    desc="Custom Resource Group #1",\n    siteIds=[]\n)\nsession.api.resource_groups.create(new_resource_group)\n\n# update resource group\nresource_group = session.api.resource_groups.get().filter(name="new_resource_group").single_or_default()\nupdated_resource_group = ResourceGroupUpdateRequest(\n    id=resource_group.id,\n    name=resource_group.name,\n    desc="Custom Resource Group #1 with updated description and site ids",\n    siteIds=[200]\n)\n\n# switch to resource group view\nsession.api.resource_groups.switch("new_resource_group")\n\n# delete resource group\nsession.api.resource_groups.delete(resource_group.id)\n```\n\n</details>\n\n<details>\n    <summary> <b>Tenant management</b> <i>(click to expand)</i></summary>\n\n```python\napi = session.api.tenant_management\n# create tenants\ntenants = [\n    Tenant(\n        name="tenant1",\n        org_name="CiscoDevNet",\n        subdomain="alpha.bravo.net",\n        desc="This is tenant for unit tests",\n        edge_connector_enable=True,\n        edge_connector_system_ip="172.16.255.81",\n        edge_connector_tunnel_interface_name="GigabitEthernet1",\n        wan_edge_forecast=1,\n    )\n]\ncreate_task = api.create(tenants)\ncreate_task.wait_for_completed()\n# list all tenants\ntenants_data = api.get_all()\n# pick tenant from list by name\ntenant = tenants_data.filter(name="tenant1").single_or_default()\n# get selected tenant id\ntenant_id = tenant.tenant_id\n# get vsession id of selected tenant\nvsessionid = api.vsession_id(tenant_id)\n# delete tenant by ids\ndelete_task = api.delete([tenant_id])\ndelete_task.wait_for_completed()\n# others\napi.get_hosting_capacity_on_vsmarts()\napi.get_statuses()\napi.get_vsmart_mapping()\n```\n</details>\n\n<details>\n    <summary> <b>Tenant migration</b> <i>(click to expand)</i></summary>\n\n```python\nfrom pathlib import Path\nfrom catalystwan.session import create_manager_session\nfrom catalystwan.models.tenant import TenantExport\nfrom catalystwan.workflows.tenant_migration import migration_workflow\n\ntenant = TenantExport(\n    name="mango",\n    desc="Mango tenant description",\n    org_name="Provider Org-Mango Inc",\n    subdomain="mango.fruits.com",\n    wan_edge_forecast=100,\n    migration_key="MangoTenantMigrationKey",   # only for SDWAN Manager >= 20.13\n    is_destination_overlay_mt=True,            # only for SDWAN Manager >= 20.13\n)\n\nwith create_manager_session(url="10.0.1.15", username="st-admin", password="") as origin_session, \\\n     create_manager_session(url="10.9.0.16", username="mt-provider-admin", password="") as target_session:\n    migration_workflow(\n        origin_session=origin_session,\n        target_session=target_session,\n        workdir=Path("workdir"),\n        tenant=tenant,\n        validator="10.9.12.26"\n    )\n```\n\n`migration_workflow` performs multi-step migration procedure according to [Migrate Single-Tenant Cisco SD-WAN Overlay to Multitenant Cisco SD-WAN Deployment](https://www.cisco.com/c/en/us/td/docs/routers/sdwan/configuration/system-interface/vedge-20-x/systems-interfaces-book/sdwan-multitenancy.html#concept_sjj_jmm_z4b)\n\n\nSince 20.13 also MT to ST is supported (just provide suitable origin/target sessions, and `is_destination_overlay_mt` parameter)\n\n\nEach step of the `migration_workflow` procedure can be executed independently using api methods: `export_tenant`, `download`, `import_tenant`, `store_token`, `migrate_network`\n\n```python\norigin_api = origin_session.api.tenant_migration_api\ntarget_api = target_session.api.tenant_migration_api\ntenant_file = Path("~/tenant.tar.gz")\ntoken_file = Path("~/tenant-token.txt")\n# export\nexport_task = origin_api.export_tenant(tenant=tenant)\nremote_filename = export_task.wait_for_file()\n# download\norigin_api.download(export_path, remote_filename)\n# import\nimport_task = target_api.import_tenant(export_path, tenant.migration_key)\nimport_task.wait_for_completed()\n# get token\nmigration_id = import_task.import_info.migration_token_query_params.migration_id\ntarget_api.store_token(migration_id, token_path)\n# migrate network\nmigrate_task = origin_api.migrate_network(token_path)\nmigrate_task.wait_for_completed()\n```\n</details>\n\n### Note:\nTo remove `InsecureRequestWarning`, you can include in your scripts (warning is suppressed when `catalystwan_devel` environment variable is set):\n```Python\nimport urllib3\nurllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)\n```\n\n## Catching Exceptions\n```python\ntry:\n    session.api.users.delete("bogus-user-name")\nexcept ManagerHTTPError as error:\n    # Process an error.\n    print(error.response.status_code)\n    print(error.info.code)\n    print(error.info.message)\n    print(error.info.details)\n\n```\n\n## [Supported API endpoints](https://github.com/cisco-open/cisco-catalyst-wan-sdk/blob/main/ENDPOINTS.md)\n\n\n## [Contributing, bug reporting and feature requests](https://github.com/cisco-open/cisco-catalyst-wan-sdk/blob/main/CONTRIBUTING.md)\n\n## Seeking support\n\nYou can contact us by submitting [issues](https://github.com/cisco-open/cisco-catalyst-wan-sdk/issues), or directly via mail on catalystwan@cisco.com.\n',
     'author': 'kagorski',