catalystwan 0.40.1.dev6__py3-none-any.whl → 2.0.0a0__py3-none-any.whl

catalystwan/endpoints/monitoring/status.py

@@ -1,76 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from enum import Enum
-from typing import List
-
-from pydantic import BaseModel, Field, RootModel
-
-from catalystwan.endpoints import APIEndpoints, get, put
-from catalystwan.typed_list import DataSequence
-
-
-class StatusEnum(str, Enum):
-    enable = "enable"
-    disable = "disable"
-    bypass = "bypass"
-    custom = "custom"
-
-
-index_name_field = Field(..., alias="indexName", pattern="^[a-z]+$")
-
-
-class Status(BaseModel):
-    index_name: str = index_name_field
-    status: StatusEnum
-    display_name: str = Field(alias="displayName")
-
-
-class UpdateStatus(BaseModel):
-    index_name: str = index_name_field
-    status: StatusEnum
-
-
-class EnabledIndex(BaseModel):
-    index_name: str = index_name_field
-
-
-SingleList = RootModel[List[str]]  # trick to make endpoint return list of strings
-
-
-class DisabledDeviceList(SingleList):
-    pass
-
-
-class DisabledDeviceListResponse(SingleList):
-    pass
-
-
-class UpdateIndexResponse(BaseModel):
-    response: bool
-
-
-class EnabledIndexDeviceListResponse(SingleList):
-    pass
-
-
-class MonitoringStatus(APIEndpoints):
-    @get("/statistics/settings/disable/devicelist/{indexName}")
-    def get_disabled_device_list(self, indexName: str) -> DisabledDeviceListResponse:
-        ...
-
-    @put("/statistics/settings/disable/devicelist/{indexName}", "response")
-    def update_statistics_device_list(self, indexName: str, payload: DisabledDeviceList) -> UpdateIndexResponse:
-        ...
-
-    @get("/statistics/settings/status")
-    def get_statistics_settings(self) -> DataSequence[Status]:
-        ...
-
-    @put("/statistics/settings/status")
-    def update_statistics_settings(self, payload: List[UpdateStatus]) -> DataSequence[Status]:
-        ...
-
-    @get("/statistics/settings/status/device")
-    def get_enabled_index_for_device(self, params: dict) -> EnabledIndexDeviceListResponse:
-        ...

catalystwan/endpoints/real_time_monitoring/reboot_history.py

@@ -1,35 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from datetime import datetime
-from typing import Optional
-
-from pydantic import AliasChoices, BaseModel, ConfigDict, Field
-
-from catalystwan.endpoints import APIEndpoints, get
-from catalystwan.typed_list import DataSequence
-
-
-class RebootEntry(BaseModel):
-    model_config = ConfigDict(extra="allow")
-    reason: Optional[str] = Field(default=None, validation_alias=AliasChoices("reboot_reason", "reload-desc"))
-    severity: Optional[str] = Field(default=None, validation_alias="reload-severity", description=">=17.13 only")
-    category: Optional[str] = Field(default=None, validation_alias="reload-category", description=">=17.13 only")
-    date_time: datetime = Field(validation_alias=AliasChoices("reboot_date_time-date", "reload-time-date"))
-    last_updated: datetime = Field(validation_alias="lastupdated")
-    vdevice_name: str = Field(validation_alias="vdevice-name")
-    vdevice_host_name: str = Field(validation_alias="vdevice-host-name")
-
-
-class RealTimeMonitoringRebootHistory(APIEndpoints):
-    @get("/device/reboothistory", "data")
-    def create_reboot_history_list(self, params: dict) -> DataSequence[RebootEntry]:
-        ...
-
-    def create_synced_reboot_history_list(self):
-        # GET /device/reboothistory/synced
-        ...
-
-    def get_reboot_history_details(self):
-        # GET /device/reboothistory/details
-        ...

catalystwan/endpoints/sdavc_cloud_connector.py

@@ -1,43 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-
-from typing import Optional
-
-from pydantic import BaseModel, ConfigDict, Field
-
-from catalystwan.endpoints import APIEndpoints, get
-
-
-class CloudConnector(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    cloud_enabled: Optional[bool] = Field(
-        default=False, serialization_alias="cloudEnabled", validation_alias="cloudEnabled"
-    )
-    client_id: Optional[str] = Field(default=None, serialization_alias="clientId", validation_alias="clientId")
-    client_secret: Optional[str] = Field(
-        default=None, serialization_alias="clientSecret", validation_alias="clientSecret"
-    )
-    org_name: Optional[str] = Field(default=None, serialization_alias="orgName", validation_alias="orgName")
-    affinity: Optional[str] = None
-    telemetry_enabled: Optional[bool] = Field(
-        default=None, serialization_alias="telemetryEnabled", validation_alias="telemetryEnabled"
-    )
-
-
-class SDAVCCloudConnector(APIEndpoints):
-    def disable_cloud_connector(self):
-        # PUT /sdavc/cloudconnector
-        ...
-
-    def enable_cloud_connector(self):
-        # POST /sdavc/cloudconnector
-        ...
-
-    @get("/sdavc/cloudconnector")
-    def get_cloud_connector(self) -> CloudConnector:
-        ...
-
-    def get_cloud_connector_status(self):
-        # GET /sdavc/cloudconnector/status
-        ...

catalystwan/endpoints/tenant_backup_restore.py

@@ -1,40 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from typing import List
-
-from pydantic import BaseModel
-
-from catalystwan.endpoints import APIEndpoints, get, view
-from catalystwan.utils.session_type import ProviderAsTenantView, TenantView
-
-
-class BackupFiles(BaseModel):
-    backup_files: List[str]
-
-
-class TenantBackupRestore(APIEndpoints):
-    @view({ProviderAsTenantView})
-    def delete_tenant_backup(self):
-        # DELETE /tenantbackup/delete
-        ...
-
-    @view({ProviderAsTenantView, TenantView})
-    def download_existing_backup_file(self):
-        # GET /tenantbackup/download/{path}
-        ...
-
-    @view({ProviderAsTenantView, TenantView})
-    def export_tenant_backup(self):
-        # GET /tenantbackup/export
-        ...
-
-    @view({ProviderAsTenantView})
-    def import_tenant_backup(self):
-        # POST /tenantbackup/import
-        ...
-
-    @view({ProviderAsTenantView, TenantView})
-    @get("/tenantbackup/list")
-    def list_tenant_backup(self) -> BackupFiles:
-        ...

catalystwan/endpoints/tenant_management.py

@@ -1,215 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from typing import Dict, List, Optional
-
-from pydantic import BaseModel, ConfigDict, Field
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put, versions, view
-from catalystwan.models.tenant import Tenant
-from catalystwan.typed_list import DataSequence
-from catalystwan.utils.session_type import ProviderAsTenantView, ProviderView
-
-
-class TenantDeleteRequest(BaseModel):
-    password: str
-
-
-class TenantBulkDeleteRequest(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    password: str
-    tenant_id_list: List[str] = Field(serialization_alias="tenantIdList", validation_alias="tenantIdList")
-
-
-class TenantTaskId(BaseModel):
-    id: str
-
-
-class CertificatesStatus(BaseModel):
-    invalid: int
-    warning: int
-    revoked: int
-
-
-class ControlStatus(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    control_up: int = Field(serialization_alias="controlUp", validation_alias="controlUp")
-    partial: int
-    control_down: int = Field(serialization_alias="controlDown", validation_alias="controlDown")
-
-
-class SiteHealth(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    full_connectivity: int = Field(serialization_alias="fullConnectivity", validation_alias="fullConnectivity")
-    partial_connectivity: int = Field(serialization_alias="partialConnectivity", validation_alias="partialConnectivity")
-    no_connectivity: int = Field(serialization_alias="noConnectivity", validation_alias="noConnectivity")
-
-
-class vEdgeHealth(BaseModel):
-    normal: int
-    warning: int
-    error: int
-
-
-class vSmartStatus(BaseModel):
-    up: int
-    down: int
-
-
-class TenantStatus(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    tenant_id: str = Field(serialization_alias="tenantId", validation_alias="tenantId")
-    tenant_name: str = Field(serialization_alias="tenantName", validation_alias="tenantName")
-    control_status: ControlStatus = Field(serialization_alias="controlStatus", validation_alias="controlStatus")
-    site_health: SiteHealth = Field(serialization_alias="siteHealth", validation_alias="siteHealth")
-    vedge_health: vEdgeHealth = Field(serialization_alias="vEdgeHealth", validation_alias="vEdgeHealth")
-    vsmart_status: vSmartStatus = Field(serialization_alias="vSmartStatus", validation_alias="vSmartStatus")
-
-
-class TenantUpdateRequest(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    tenant_id: str = Field(serialization_alias="tenantId", validation_alias="tenantId")
-    subdomain: str = Field(serialization_alias="subDomain", validation_alias="subDomain")
-    desc: str
-    wan_edge_forecast: Optional[int] = Field(serialization_alias="wanEdgeForecast", validation_alias="wanEdgeForecast")
-    edge_connector_enable: Optional[bool] = Field(
-        serialization_alias="edgeConnectorEnable", validation_alias="edgeConnectorEnable"
-    )
-    edge_connector_system_ip: Optional[str] = Field(
-        default=None, serialization_alias="edgeConnectorSystemIp", validation_alias="edgeConnectorSystemIp"
-    )
-    edge_connector_tunnel_interface_name: Optional[str] = Field(
-        default=None,
-        serialization_alias="edgeConnectorTunnelInterfaceName",
-        validation_alias="edgeConnectorTunnelInterfaceName",
-    )
-
-    @classmethod
-    def from_tenant(cls, tenant: Tenant) -> "TenantUpdateRequest":
-        """Creates payload for tenant update from existing tenant data obtained by GET
-
-        Args:
-            tenant (Tenant): Tenant to be updated
-
-        Raises:
-            TypeError: When provided tenant is missing ID
-
-        Returns:
-            TenantUpdateRequest: Tenant attributes suitable for PUT request
-        """
-        if not tenant.tenant_id:
-            raise TypeError("tenantId required for update request")
-        return TenantUpdateRequest(
-            tenant_id=tenant.tenant_id,
-            desc=tenant.desc,
-            subdomain=tenant.subdomain,
-            wan_edge_forecast=tenant.wan_edge_forecast,
-            edge_connector_enable=tenant.edge_connector_enable,
-            edge_connector_system_ip=tenant.edge_connector_system_ip,
-            edge_connector_tunnel_interface_name=tenant.edge_connector_tunnel_interface_name,
-        )
-
-
-class vSmartPlacementUpdateRequest(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    src_vsmart_uuid: str = Field(serialization_alias="srcvSmartUuid", validation_alias="srcvSmartUuid")
-    dest_vsmart_uuid: str = Field(serialization_alias="destvSmartUuid", validation_alias="destvSmartUuid")
-
-
-class vSmartTenantCapacity(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    vsmart_uuid: str = Field(serialization_alias="vSmartUuid", validation_alias="vSmartUuid")
-    total_tenant_capacity: int = Field(
-        serialization_alias="totalTenantCapacity", validation_alias="totalTenantCapacity"
-    )
-    current_tenant_count: int = Field(serialization_alias="currentTenantCount", validation_alias="currentTenantCount")
-
-
-class vSmartTenantMap(BaseModel):
-    data: Dict[str, List[Tenant]]
-
-
-class vSessionId(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    vsessionid: str = Field(serialization_alias="VSessionId", validation_alias="VSessionId")
-
-
-class TenantManagement(APIEndpoints):
-    @view({ProviderView})
-    @post("/tenant")
-    def create_tenant(self, payload: Tenant) -> Tenant:
-        ...
-
-    @view({ProviderView})
-    @post("/tenant/async")
-    def create_tenant_async(self, payload: Tenant) -> TenantTaskId:
-        ...
-
-    @versions(">=20.4")
-    @view({ProviderView})
-    @post("/tenant/bulk/async")
-    def create_tenant_async_bulk(self, payload: List[Tenant]) -> TenantTaskId:
-        ...
-
-    @view({ProviderView})
-    @delete("/tenant/{tenant_id}/delete")
-    def delete_tenant(self, tenant_id: str, payload: TenantDeleteRequest) -> None:
-        ...
-
-    @versions(">=20.4")
-    @view({ProviderView})
-    @delete("/tenant/bulk/async")
-    def delete_tenant_async_bulk(self, payload: TenantBulkDeleteRequest) -> TenantTaskId:
-        ...
-
-    def force_status_collection(self):
-        # POST /tenantstatus/force
-        ...
-
-    @view({ProviderView, ProviderAsTenantView})
-    @get("/tenantstatus", "data")
-    def get_all_tenant_statuses(self) -> DataSequence[TenantStatus]:
-        ...
-
-    @view({ProviderView, ProviderAsTenantView})
-    @get("/tenant", "data")
-    def get_all_tenants(self) -> DataSequence[Tenant]:
-        ...
-
-    @view({ProviderView, ProviderAsTenantView})
-    @get("/tenant/{tenant_id}")
-    def get_tenant(self, tenant_id: str) -> Tenant:
-        ...
-
-    @view({ProviderView})
-    @get("/tenant/vsmart/capacity", "data")
-    def get_tenant_hosting_capacity_on_vsmarts(self) -> DataSequence[vSmartTenantCapacity]:
-        ...
-
-    @view({ProviderView, ProviderAsTenantView})
-    @get("/tenant/vsmart")
-    def get_tenant_vsmart_mapping(self) -> vSmartTenantMap:
-        ...
-
-    def switch_tenant(self):
-        # POST /tenant/{tenantId}/switch
-        ...
-
-    def tenant_vsmart_mt_migrate(self):
-        # POST /tenant/vsmart-mt/migrate
-        ...
-
-    @view({ProviderView})
-    @put("/tenant/{tenant_id}")
-    def update_tenant(self, tenant_id: str, payload: TenantUpdateRequest) -> Tenant:
-        ...
-
-    @view({ProviderView})
-    @put("/tenant/{tenant_id}/vsmart")
-    def update_tenant_vsmart_placement(self, tenant_id: str, payload: vSmartPlacementUpdateRequest) -> None:
-        ...
-
-    @view({ProviderView})
-    @post("/tenant/{tenant_id}/vsessionid")
-    def vsession_id(self, tenant_id: str) -> vSessionId:
-        ...

catalystwan/endpoints/tenant_migration.py

@@ -1,102 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from pathlib import Path
-from typing import Any
-from urllib.parse import parse_qs, urlsplit
-
-from pydantic import BaseModel, ConfigDict, Field, model_validator
-
-from catalystwan.endpoints import APIEndpoints, CustomPayloadType, PreparedPayload, get, post, versions, view
-from catalystwan.models.tenant import TenantExport
-from catalystwan.utils.session_type import ProviderView, SingleTenantView
-
-
-class MigrationTokenQueryParams(BaseModel):
-    model_config = ConfigDict(populate_by_name=True, extra="allow")
-    migration_id: str = Field(serialization_alias="migrationId", validation_alias="migrationId")
-
-    @model_validator(mode="before")
-    @classmethod
-    def single_migration_id_required(cls, values: Any):
-        if not isinstance(values, dict):
-            return values
-        migration_id = values.get("migrationId")
-        if isinstance(migration_id, list) and len(migration_id) == 1:
-            values["migrationId"] = migration_id[0]
-        return values
-
-
-class ExportInfo(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    process_id: str = Field(serialization_alias="processId", validation_alias="processId")
-
-
-class ImportInfo(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    process_id: str = Field(serialization_alias="processId", validation_alias="processId")
-    migration_token_url: str = Field(serialization_alias="migrationTokenURL", validation_alias="migrationTokenURL")
-
-    @property
-    def migration_token_query(self) -> str:
-        return urlsplit(self.migration_token_url).query
-
-    @property
-    def migration_token_query_params(self) -> MigrationTokenQueryParams:
-        return MigrationTokenQueryParams.model_validate(parse_qs(self.migration_token_query))
-
-
-class MigrationInfo(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    process_id: str = Field(serialization_alias="processId", validation_alias="processId")
-
-
-class MigrationFile(CustomPayloadType):
-    def __init__(self, filename: Path):
-        self.filename = filename
-
-    def prepared(self) -> PreparedPayload:
-        data = open(self.filename, "rb")
-        return PreparedPayload(files={"file": (Path(data.name).name, data)})
-
-
-class TenantMigration(APIEndpoints):
-    @view({SingleTenantView, ProviderView})
-    @versions(">=20.6")
-    @get("/tenantmigration/download/{path}")
-    def download_tenant_data(self, path: str = "default.tar.gz") -> bytes:
-        ...
-
-    @view({SingleTenantView, ProviderView})
-    @versions(">=20.6")
-    @post("/tenantmigration/export")
-    def export_tenant_data(self, payload: TenantExport) -> ExportInfo:
-        ...
-
-    @view({SingleTenantView, ProviderView})
-    @versions(">=20.6")
-    @get("/tenantmigration/migrationToken")
-    def get_migration_token(self, params: MigrationTokenQueryParams) -> str:
-        ...
-
-    @view({SingleTenantView, ProviderView})
-    @versions(">=20.6,<20.13")
-    @post("/tenantmigration/import")
-    def import_tenant_data(self, payload: MigrationFile) -> ImportInfo:
-        ...
-
-    @view({SingleTenantView, ProviderView})
-    @versions(">=20.13")
-    @post("/tenantmigration/import/{migration_key}")
-    def import_tenant_data_with_key(self, payload: MigrationFile, migration_key: str) -> ImportInfo:
-        ...
-
-    @view({SingleTenantView, ProviderView})
-    @versions(">=20.6")
-    @post("/tenantmigration/networkMigration")
-    def migrate_network(self, payload: str) -> MigrationInfo:
-        ...
-
-    def retrigger_network_migration(self):
-        # GET /tenantmigration/networkMigration
-        ...

catalystwan/endpoints/troubleshooting_tools/device_connectivity.py

@@ -1,128 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from enum import Enum
-from typing import List, Optional
-
-from pydantic import BaseModel, ConfigDict, Field
-
-from catalystwan.endpoints import APIEndpoints, post
-
-
-class PingProbeType(str, Enum):
-    ICMP = "icmp"
-    TCP = "tcp"
-    UDP = "udp"
-
-
-class NPingRequest(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    host: str
-    vpn: str
-    probe_type: PingProbeType = Field(default=PingProbeType.ICMP, serialization_alias="probeType")
-    count: Optional[str] = None
-    dest_port: Optional[str] = Field(default=None, serialization_alias="destPort")
-    df: Optional[str] = None
-    interface_ip: Optional[str] = Field(default=None, serialization_alias="interfaceIP")
-    mtu: Optional[str] = None
-    rapid: Optional[str] = None
-    size: Optional[str] = None
-    source: Optional[str] = None
-    source_port: Optional[str] = Field(default=None, serialization_alias="sourcePort")
-    tos: Optional[str] = None
-    ttl: Optional[str] = None
-
-
-class NPingResult(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    raw_output: List[str] = Field(validation_alias="rawOutput")
-    packets_transmitted: int = Field(validation_alias="packetsTransmitted")
-    packets_received: int = Field(validation_alias="packetsReceived")
-    loss_percentage: float = Field(validation_alias="lossPercentage")
-    min_round_trip: float = Field(validation_alias="minRoundTrip")
-    max_round_trip: float = Field(validation_alias="maxRoundTrip")
-    avg_round_trip: float = Field(validation_alias="avgRoundTrip")
-
-
-class TroubleshootingToolsDeviceConnectivity(APIEndpoints):
-    def copy_admin_tech_on_device(self):
-        # POST /device/tools/admintech/copy
-        ...
-
-    def create_admin_tech(self):
-        # POST /device/tools/admintech
-        ...
-
-    def delete_admin_tech_file(self):
-        # DELETE /device/tools/admintech/{requestID}
-        ...
-
-    def delete_admin_tech_on_device(self):
-        # DELETE /device/tools/admintech/delete
-        ...
-
-    def download_admin_tech_file(self):
-        # GET /device/tools/admintech/download/{filename}
-        ...
-
-    def factory_reset(self):
-        # POST /device/tools/factoryreset
-        ...
-
-    def get_control_connections(self):
-        # GET /troubleshooting/control/{uuid}
-        ...
-
-    def get_device_configuration(self):
-        # GET /troubleshooting/devicebringup
-        ...
-
-    def get_in_progress_count(self):
-        # GET /device/tools/admintechs/inprogress
-        ...
-
-    def list_admin_techs(self):
-        # GET /device/tools/admintechs
-        ...
-
-    def list_admin_techs_on_device(self):
-        # POST /device/tools/admintechlist
-        ...
-
-    @post("/device/tools/nping/{device_ip}")
-    def nping_device(self, device_ip: str, payload: NPingRequest) -> NPingResult:
-        ...
-
-    def ping_device(self):
-        # POST /device/tools/ping/{deviceIP}
-        ...
-
-    def process_interface_reset(self):
-        # POST /device/tools/reset/interface/{deviceIP}
-        ...
-
-    def process_port_hop_color(self):
-        # POST /device/tools/porthopcolor/{deviceIP}
-        ...
-
-    def process_reset_user(self):
-        # POST /device/tools/resetuser/{deviceIP}
-        ...
-
-    def service_path(self):
-        # POST /device/tools/servicepath/{deviceIP}
-        ...
-
-    def traceroute_device(self):
-        # POST /device/tools/traceroute/{deviceIP}
-        ...
-
-    def tunnel_path(self):
-        # POST /device/tools/tunnelpath/{deviceIP}
-        ...
-
-    def upload_admin_tech(self):
-        # POST /device/tools/admintechs/upload
-        ...

catalystwan/endpoints/url_monitoring.py

@@ -1,26 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-
-
-from catalystwan.endpoints import APIEndpoints, delete, get, post, put
-from catalystwan.models.url_monitoring import DeleteUrlMonitorRequest, UrlMonitoringConfig, UrlMonitoringInfo
-from catalystwan.typed_list import DataSequence
-
-
-class UrlMonitoring(APIEndpoints):
-    @get("/url/monitor")
-    def get_url_monitor(self) -> DataSequence[UrlMonitoringInfo]:
-        ...
-
-    @post("/url/monitor")
-    def add_url_monitor(self, payload: UrlMonitoringConfig) -> None:
-        ...
-
-    @put("/url/monitor")
-    def update_url_monitor(self, payload: UrlMonitoringConfig) -> None:
-        ...
-
-    @delete("/url/monitor")
-    def delete_url_monitor(self, params: DeleteUrlMonitorRequest) -> None:
-        ...