catalystwan 0.30.0.dev1__tar.gz → 0.30.0.dev2__tar.gz

{catalystwan-0.30.0.dev1 → catalystwan-0.30.0.dev2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: catalystwan
-Version: 0.30.0.dev1
-Summary: Cisco Catalyst SD-WAN SDK for Python
+Version: 0.30.0.dev2
+Summary: Cisco Catalyst WAN SDK for Python
 Home-page: https://github.com/CiscoDevNet/catalystwan
 Author: kagorski
 Author-email: kagorski@cisco.com

{catalystwan-0.30.0.dev1 → catalystwan-0.30.0.dev2}/catalystwan/api/policy_api.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Dict, List, Mapping, Optional, Type, Union, overload
+from typing import TYPE_CHECKING, Any, Dict, List, Mapping, Optional, Type, overload
 from uuid import UUID
 
 from catalystwan.api.task_status_api import Task
@@ -139,6 +139,7 @@ from catalystwan.endpoints.configuration.policy.vsmart_template import (
     VSmartConnectivityStatus,
 )
 from catalystwan.models.misc.application_protocols import ApplicationProtocol
+from catalystwan.models.policy import AnyPolicyDefinition, AnyPolicyList
 from catalystwan.models.policy.centralized import CentralizedPolicy, CentralizedPolicyEditPayload, CentralizedPolicyInfo
 from catalystwan.models.policy.definitions.access_control_list import AclPolicy
 from catalystwan.models.policy.definitions.access_control_list_ipv6 import AclIPv6Policy
@@ -154,7 +155,6 @@ from catalystwan.models.policy.definitions.security_group import SecurityGroup
 from catalystwan.models.policy.definitions.vpn_membership import VPNMembershipPolicy
 from catalystwan.models.policy.definitions.zone_based_firewall import ZoneBasedFWPolicy
 from catalystwan.models.policy.lists import (
-    AnyPolicyList,
     AppList,
     AppProbeClassList,
     ASPathList,
@@ -261,23 +261,6 @@ POLICY_DEFINITION_ENDPOINTS_MAP: Mapping[type, type] = {
     DeviceAccessIPv6Policy: ConfigurationPolicyDeviceAccessIPv6Definition,
 }
 
-AnyPolicyDefinition = Union[
-    RuleSet,
-    SecurityGroup,
-    ZoneBasedFWPolicy,
-    TrafficDataPolicy,
-    QoSMapPolicy,
-    RewritePolicy,
-    ControlPolicy,
-    VPNMembershipPolicy,
-    HubAndSpokePolicy,
-    MeshPolicy,
-    AclPolicy,
-    AclIPv6Policy,
-    DeviceAccessPolicy,
-    DeviceAccessIPv6Policy,
-]
-
 
 class CentralizedPolicyAPI:
     def __init__(self, session: ManagerSession):

catalystwan-0.30.0.dev2/catalystwan/endpoints/configuration/config_migration.py

@@ -0,0 +1,34 @@
+from typing import List
+
+from pydantic import BaseModel, Field
+
+from catalystwan.models.policy import (
+    AnyPolicyDefinition,
+    AnyPolicyList,
+    CentralizedPolicy,
+    LocalizedPolicy,
+    SecurityPolicy,
+)
+
+
+class UX1Policies(BaseModel):
+    centralized_policies: List[CentralizedPolicy] = Field(default=[], serialization_alias="centralizedPolicies")
+    localized_policies: List[LocalizedPolicy] = Field(default=[], serialization_alias="localizedPolicies")
+    security_policies: List[SecurityPolicy] = Field(default=[], serialization_alias="securityPolicies")
+    policy_definitions: List[AnyPolicyDefinition] = Field(default=[], serialization_alias="policyDefinitions")
+    policy_lists: List[AnyPolicyList] = Field(default=[], serialization_alias="policyLists")
+
+
+class UX1Templates(BaseModel):
+    pass
+
+
+class UX1Config(BaseModel):
+    # All UX1 Configuration items - Mega Model
+    policies: UX1Policies
+    templates: UX1Templates
+
+
+class UX2Config(BaseModel):
+    # All UX2 Configuration items - Mega Model
+    pass

{catalystwan-0.30.0.dev1 → catalystwan-0.30.0.dev2}/catalystwan/models/policy/__init__.py

@@ -1,5 +1,10 @@
 # This stub provide top-level "public" policy models and enums to be used with PolicyAPI()
 # TODO: explore model attribute access customization with https://peps.python.org/pep-0562/
+from typing import Union
+
+from pydantic import Field
+from typing_extensions import Annotated
+
 from .centralized import CentralizedPolicy as CentralizedPolicy
 from .centralized import TrafficDataDirectionEnum as TrafficDataDirectionEnum
 from .definitions.access_control_list import AclPolicy as AclPolicy
@@ -61,3 +66,58 @@ from .policy_definition import ServiceTypeEnum as ServiceTypeEnum
 from .policy_definition import TLOCActionEnum as TLOCActionEnum
 from .security import SecurityPolicy as SecurityPolicy
 from .security import UnifiedSecurityPolicy as UnifiedSecurityPolicy
+
+AnyPolicyDefinition = Annotated[
+    Union[
+        RuleSet,
+        SecurityGroup,
+        ZoneBasedFWPolicy,
+        TrafficDataPolicy,
+        QoSMapPolicy,
+        RewritePolicy,
+        ControlPolicy,
+        VPNMembershipPolicy,
+        HubAndSpokePolicy,
+        MeshPolicy,
+        AclPolicy,
+        AclIPv6Policy,
+        DeviceAccessPolicy,
+        DeviceAccessIPv6Policy,
+    ],
+    Field(discriminator="type"),
+]
+
+AnyPolicyList = Annotated[
+    Union[
+        AppList,
+        AppProbeClassList,
+        ASPathList,
+        ClassMapList,
+        ColorList,
+        CommunityList,
+        DataIPv6PrefixList,
+        DataPrefixList,
+        ExpandedCommunityList,
+        FQDNList,
+        GeoLocationList,
+        IPSSignatureList,
+        IPv6PrefixList,
+        LocalAppList,
+        LocalDomainList,
+        MirrorList,
+        PolicerList,
+        PortList,
+        PreferredColorGroupList,
+        PrefixList,
+        ProtocolNameList,
+        RegionList,
+        SiteList,
+        SLAClassList,
+        TLOCList,
+        URLBlackList,
+        URLWhiteList,
+        VPNList,
+        ZoneList,
+    ],
+    Field(discriminator="type"),
+]

{catalystwan-0.30.0.dev1 → catalystwan-0.30.0.dev2}/catalystwan/models/policy/lists.py

@@ -1,9 +1,8 @@
 from ipaddress import IPv4Address, IPv4Network, IPv6Network
-from typing import Any, List, Literal, Optional, Set, Tuple, Union
+from typing import Any, List, Literal, Optional, Set, Tuple
 from uuid import UUID
 
 from pydantic import BaseModel, Field
-from typing_extensions import Annotated
 
 from catalystwan.models.common import InterfaceTypeEnum, TLOCColorEnum, WellKnownBGPCommunitiesEnum
 from catalystwan.models.policy.lists_entries import (
@@ -329,39 +328,3 @@ class RegionList(PolicyListBase):
     def add_region_range(self, region_range: Tuple[int, int]):
         entry = RegionListEntry(region_id=f"{region_range[0]}-{region_range[1]}")
         self._add_entry(entry)
-
-
-AnyPolicyList = Annotated[
-    Union[
-        AppList,
-        AppProbeClassList,
-        ASPathList,
-        ClassMapList,
-        ColorList,
-        CommunityList,
-        DataIPv6PrefixList,
-        DataPrefixList,
-        ExpandedCommunityList,
-        FQDNList,
-        GeoLocationList,
-        IPSSignatureList,
-        IPv6PrefixList,
-        LocalAppList,
-        LocalDomainList,
-        MirrorList,
-        PolicerList,
-        PortList,
-        PreferredColorGroupList,
-        PrefixList,
-        ProtocolNameList,
-        RegionList,
-        SiteList,
-        SLAClassList,
-        TLOCList,
-        URLBlackList,
-        URLWhiteList,
-        VPNList,
-        ZoneList,
-    ],
-    Field(discriminator="type"),
-]

{catalystwan-0.30.0.dev1 → catalystwan-0.30.0.dev2}/catalystwan/models/policy/policy_list.py

@@ -4,7 +4,7 @@ from uuid import UUID
 
 from pydantic import BaseModel, Field
 
-from catalystwan.models.policy.lists import AnyPolicyList
+from catalystwan.models.policy import AnyPolicyList
 from catalystwan.typed_list import DataSequence
 
 

{catalystwan-0.30.0.dev1 → catalystwan-0.30.0.dev2}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "catalystwan"
-version = "0.30.0dev1"
-description = "Cisco Catalyst SD-WAN SDK for Python"
+version = "0.30.0dev2"
+description = "Cisco Catalyst WAN SDK for Python"
 authors = ["kagorski <kagorski@cisco.com>"]
 readme = "README.md"
 repository = "https://github.com/CiscoDevNet/catalystwan"

{catalystwan-0.30.0.dev1 → catalystwan-0.30.0.dev2}/setup.py

@@ -62,8 +62,8 @@ install_requires = \
 
 setup_kwargs = {
     'name': 'catalystwan',
-    'version': '0.30.0.dev1',
-    'description': 'Cisco Catalyst SD-WAN SDK for Python',
+    'version': '0.30.0.dev2',
+    '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 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 Manager.\n\n## Installation\n```console\npip install catalystwan\n```\n\n## Session usage example\nOur session is an extension to `requests.Session` designed to make it easier to communicate via API calls with SDWAN Manager. We provide ready to use authentication, you have to simply provide the Manager url, username and password as as if you were doing it through a GUI. \n```python\nfrom catalystwan.session import create_manager_session\n\nurl = "example.com"\nusername = "admin"\npassword = "password123"\nwith create_manager_session(url=url, username=username, password=password) as session:\n    session.get("/dataservice/device")\n\n# When interacting with the SDWAN Manager API without using a context manager, it\'s important \n# to manually execute the `close()` method to release the user session resource.\n\nsession = create_manager_session(url=url, username=username, password=password)\nsession.get("/dataservice/device")\nsession.close()\n```\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## API usage examples\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\nvsmarts = session.api.devices.get().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", resGroupName="global")\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        orgName="CiscoDevNet",\n        subDomain="alpha.bravo.net",\n        desc="This is tenant for unit tests",\n        edgeConnectorEnable=True,\n        edgeConnectorSystemIp="172.16.255.81",\n        edgeConnectorTunnelInterfaceName="GigabitEthernet1",\n        wanEdgeForecast=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\tsession.api.users.delete_user("XYZ")\nexcept vManageBadRequestError as error:\n\t# Process an error.\n\tlogger.error(error.info.details)\n\n# message = \'Delete users request failed\' \n# details = \'No user with name XYZ was found\' \n# code = \'USER0006\'\n```\n\n## [Supported API endpoints](https://github.com/CiscoDevNet/catalystwan/blob/main/ENDPOINTS.md)\n\n\n## [Contributing, bug reporting and feature requests](https://github.com/CiscoDevNet/catalystwan/blob/main/CONTRIBUTING.md)\n\n## Seeking support\n\nYou can contact us by submitting [issues](https://github.com/CiscoDevNet/catalystwan/issues), or directly via mail on vmngclient@cisco.com.\n',
     'author': 'kagorski',
     'author_email': 'kagorski@cisco.com',