catalystwan 0.40.2.dev1__py3-none-any.whl → 2.0.0a1__py3-none-any.whl

catalystwan/endpoints/cluster_management.py

@@ -1,130 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from typing import Dict, Literal, Optional
-
-from pydantic import BaseModel, ConfigDict, Field
-
-from catalystwan.endpoints import JSON, APIEndpoints, get, post, put
-from catalystwan.typed_list import DataSequence
-from catalystwan.utils.persona import Persona
-
-TenancyModes = Literal["SingleTenant", "MultiTenant"]
-
-
-class TenancyMode(BaseModel):
-    mode: TenancyModes
-    deploymentmode: str
-    domain: Optional[str] = None
-    clusterid: Optional[str] = None
-
-
-class VManageDetails(BaseModel):
-    service: str
-    enabled: bool
-    status: str
-
-
-class ConnectedDevice(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    uuid: str
-    device_id: str = Field(serialization_alias="deviceId", validation_alias="deviceId")
-
-
-class VManageSetup(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-    vmanage_id: Optional[str] = Field(default=None, serialization_alias="vmanageID", validation_alias="vmanageID")
-    device_ip: str = Field(serialization_alias="deviceIP", validation_alias="deviceIP")
-    username: str
-    password: str
-    gen_csr: Optional[bool] = Field(default=None, serialization_alias="genCSR", validation_alias="genCSR")
-    persona: Persona
-    services: Optional[Dict[str, Dict[str, bool]]] = Field(default=None)
-
-
-class ClusterManagement(APIEndpoints):
-    def add_or_update_user_credentials(self):
-        # POST /clusterManagement/userCreds
-        ...
-
-    @post("/clusterManagement/setup")
-    def add_vmanage(self, payload: VManageSetup) -> JSON:
-        # POST /clusterManagement/setup
-        ...
-
-    def check_if_cluster_locked(self):
-        # GET /clusterManagement/clusterLocked
-        ...
-
-    def configure_vmanage(self):
-        # POST /clusterManagement/configure
-        ...
-
-    @put("/clusterManagement/setup")
-    def edit_vmanage(self, payload: VManageSetup) -> JSON:
-        # PUT /clusterManagement/setup
-        ...
-
-    def get_cluster_workflow_version(self):
-        # GET /clusterManagement/clusterworkflow/version
-        ...
-
-    def get_configured_ip_list(self):
-        # GET /clusterManagement/iplist/{vmanageID}
-        ...
-
-    @get("/clusterManagement/connectedDevices/{vmanageIP}", "data")
-    def get_connected_devices(self, vmanageIP: str) -> DataSequence[ConnectedDevice]:
-        ...
-
-    def get_connected_devices_per_tenant(self):
-        # GET /clusterManagement/{tenantId}/connectedDevices/{vmanageIP}
-        ...
-
-    @get("/clusterManagement/tenancy/mode", "data")
-    def get_tenancy_mode(self) -> TenancyMode:
-        ...
-
-    def get_tenants_list(self):
-        # GET /clusterManagement/tenantList
-        ...
-
-    @get("/clusterManagement/vManage/details/{vmanageIP}", "data")
-    def get_vmanage_details(self, vmanageIP: str) -> DataSequence[VManageDetails]:
-        ...
-
-    def health_details(self):
-        # GET /clusterManagement/health/details
-        ...
-
-    def health_status_info(self):
-        # GET /clusterManagement/health/status
-        ...
-
-    def health_summary(self):
-        # GET /clusterManagement/health/summary
-        ...
-
-    def is_cluster_ready(self):
-        # GET /clusterManagement/isready
-        ...
-
-    def list_vmanages(self):
-        # GET /clusterManagement/list
-        ...
-
-    def node_properties(self):
-        # GET /clusterManagement/nodeProperties
-        ...
-
-    def perform_replication_and_rebalance_of_kafka_partitions(self):
-        # PUT /clusterManagement/replicateAndRebalance
-        ...
-
-    def remove_vmanage(self):
-        # POST /clusterManagement/remove
-        ...
-
-    def set_tenancy_mode(self):
-        # POST /clusterManagement/tenancy/mode
-        ...

catalystwan/endpoints/configuration/device/software_update.py

@@ -1,31 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from catalystwan.endpoints import APIEndpoints, post
-from catalystwan.utils.upgrades_helper import SoftwarePackageUploadPayload
-
-
-class ConfigurationDeviceSoftwareUpdate(APIEndpoints):
-    def download_package_file(self):
-        # GET /device/action/software/package/{fileName}
-        ...
-
-    def edit_image_metadata(self):
-        # PUT /device/action/software/package/{versionId}/metadata
-        ...
-
-    def get_image_metadata(self):
-        # GET /device/action/software/package/{versionId}/metadata
-        ...
-
-    def get_upload_images_count(self):
-        # GET /device/action/software/package/imageCount
-        ...
-
-    @post("/device/action/software/package")
-    def upload_software_to_manager(self, payload: SoftwarePackageUploadPayload) -> None:
-        ...
-
-    def process_software_image(self):
-        # POST /device/action/software/package/{imageType}
-        ...

catalystwan/endpoints/configuration/disaster_recovery.py

@@ -1,305 +0,0 @@
-# Copyright 2024 Cisco Systems, Inc. and its affiliates
-
-# mypy: disable-error-code="empty-body"
-from ipaddress import IPv4Address
-from typing import List, Union
-from uuid import UUID
-
-from pydantic import BaseModel, ConfigDict, Field, RootModel
-
-from catalystwan.endpoints import APIEndpoints, get, post
-from catalystwan.typed_list import DataSequence
-
-
-class DisasterRecoveryTaskId(BaseModel):
-    id: UUID
-
-
-class RegisterDisasterRecoveryTaskId(DisasterRecoveryTaskId):
-    ...
-
-
-class DeregisterDisasterRecoveryTaskId(DisasterRecoveryTaskId):
-    ...
-
-
-class ActivateDisasterRecoveryTaskId(DisasterRecoveryTaskId):
-    ...
-
-
-class UnpauseDisasterRecoveryTaskId(DisasterRecoveryTaskId):
-    ...
-
-
-class ReplicationDetailsEntry(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    last_replicated: str = Field(serialization_alias="lastReplicated", validation_alias="lastReplicated")
-    export_duration: str = Field(serialization_alias="exportDuration", validation_alias="exportDuration")
-    export_size: str = Field(serialization_alias="exportSize", validation_alias="exportSize")
-    replication_status: str = Field(serialization_alias="replicationStatus", validation_alias="replicationStatus")
-    export_id: str = Field(serialization_alias="exportID", validation_alias="exportID")
-
-
-class DisasterRecoveryDetailsResponse(BaseModel):
-    replication_details: List[ReplicationDetailsEntry]
-
-
-class ValidateNodePayload(BaseModel):
-    ip: IPv4Address
-    username: str
-    password: str
-
-
-class ValidatedNodeEntry(BaseModel):
-    ip: IPv4Address
-    is_reachable: bool
-
-
-class DisasterRecoveryPauseResponse(BaseModel):
-    status: str
-
-
-class DataCenter(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    name: str
-    nms_personality: str = Field(serialization_alias="nmsPersonality", validation_alias="nmsPersonality")
-    dc_personality: str = Field(serialization_alias="dcPersonality", validation_alias="dcPersonality")
-    management_ip: IPv4Address = Field(serialization_alias="mgmtIPAddress", validation_alias="mgmtIPAddress")
-    username: str
-    password: str
-
-
-class DisasterRecoverySettings(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    delay_threshold: int = Field(serialization_alias="delayThreshold", validation_alias="delayThreshold")
-    start_time: str = Field(serialization_alias="startTime", validation_alias="startTime")
-    interval: int
-
-
-class VbondPayload(BaseModel):
-    name: str = Field(default="")
-    ip: IPv4Address
-    username: str
-    password: str
-
-
-class DisasterRecoveryRegisterPayload(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    data_centers: List[DataCenter] = Field(serialization_alias="dataCenters", validation_alias="dataCenters")
-    disaster_recovery_settings: List[DisasterRecoverySettings] = Field(
-        serialization_alias="disasterRecoverySettings", validation_alias="disasterRecoverySettings"
-    )
-    vbonds: List[VbondPayload]
-
-
-class DisasterRecoveryStatusInformation(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    pause_replication: bool = Field(serialization_alias="pauseReplication", validation_alias="pauseReplication")
-    pause_dr: bool = Field(serialization_alias="pauseDR", validation_alias="pauseDR")
-    dr_enabled: bool = Field(serialization_alias="drenabled", validation_alias="drenabled")
-
-
-class DisasterRecoveryStatusResponse(BaseModel):
-    dr_status: Union[DisasterRecoveryStatusInformation, None] = Field(
-        serialization_alias="drStatus", validation_alias="drStatus"
-    )
-
-
-class DisasterRecoveryScheduleResponse(BaseModel):
-    schedule: DisasterRecoverySettings
-
-
-class RemoteDataCentervManageVersionResponse(RootModel):
-    root: list
-
-
-class RemoteDataCenterDetails(BaseModel):
-    name: str
-    ip: IPv4Address
-    uuid: UUID
-    serialno: str
-    state: str
-
-
-class DisasterRecoveryDataCenterStatus(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    dc_personality: str = Field(serialization_alias="dcPersonality", validation_alias="dcPersonality")
-    management_ip: IPv4Address = Field(serialization_alias="mgmtIPAddress", validation_alias="mgmtIPAddress")
-
-
-class LastestLocalHistory(BaseModel):
-    model_config = ConfigDict(populate_by_name=True)
-
-    last_switch: int = Field(serialization_alias="lastSwitch", validation_alias="lastSwitch")
-    reason_for_switch: Union[str, None] = Field(
-        serialization_alias="reasonForSwitch", validation_alias="reasonForSwitch"
-    )
-    updated_primary: Union[str, None] = Field(serialization_alias="updatedPrimary", validation_alias="updatedPrimary")
-
-
-class ConfigurationDisasterRecovery(APIEndpoints):
-    @post("/disasterrecovery/activate")
-    def activate(self) -> ActivateDisasterRecoveryTaskId:
-        ...
-
-    @post("/disasterrecovery/deregister")
-    def delete(self) -> DeregisterDisasterRecoveryTaskId:
-        ...
-
-    # def delete_dc(self) -> None:
-    #     # POST /disasterrecovery/deleteRemoteDataCenter
-    #     ...
-
-    # def delete_local_dc(self) -> None:
-    #     # POST /disasterrecovery/deleteLocalDataCenter
-    #     ...
-
-    # def disaster_recovery_pause_replication(self) -> None:
-    #     # POST /disasterrecovery/pausereplication
-    #     ...
-
-    # def disaster_recovery_replication_request(self) -> None:
-    #     # POST /disasterrecovery/requestimport
-    #     ...
-
-    # def disaster_recovery_un_pause_replication(self) -> None:
-    #     # POST /disasterrecovery/unpausereplication
-    #     ...
-
-    # def download(self) -> None:
-    #     # GET /disasterrecovery/download/backup/{token}/db_bkp.tar.gz
-    #     ...
-
-    # def download_replication_data(self) -> None:
-    #     # GET /disasterrecovery/download/{token}/{fileName}
-    #     ...
-
-    # def get_usernames(self) -> None:
-    #     # GET /disasterrecovery/usernames
-    #     ...
-
-    # @get("/disasterrecovery/clusterInfo")
-    # def get_cluster_info(self) -> None:
-    #     ...
-
-    # def get_config_db_restore_status(self) -> None:
-    #     # GET /disasterrecovery/dbrestorestatus
-    #     ...
-
-    @get("/disasterrecovery/details")
-    def get_details(self) -> DisasterRecoveryDetailsResponse:
-        ...
-
-    @get("/disasterrecovery/schedule")
-    def get_disaster_recovery_local_replication_schedule(self) -> DisasterRecoveryScheduleResponse:
-        ...
-
-    @get("/disasterrecovery/drstatus")
-    def get_disaster_recovery_status(self) -> DataSequence[DisasterRecoveryDataCenterStatus]:
-        ...
-
-    # def get_history(self) -> None:
-    #     # GET /disasterrecovery/history
-    #     ...
-
-    # def get_local_data_center_state(self) -> None:
-    #     # GET /disasterrecovery/localdc
-    #     ...
-
-    @get("/disasterrecovery/localLatestHistory")
-    def get_local_history(self) -> LastestLocalHistory:
-        ...
-
-    @post("/disasterrecovery/validateNodes")
-    def get_reachability_info(self, payload: List[ValidateNodePayload]) -> DataSequence[ValidatedNodeEntry]:
-        ...
-
-    @get("/disasterrecovery/remotedc")
-    def get_remote_data_center_details(self) -> DataSequence[RemoteDataCenterDetails]:
-        ...
-
-    @get("/disasterrecovery/remotedc/swversion")
-    def get_remote_data_center_version(self) -> RemoteDataCentervManageVersionResponse:
-        ...
-
-    # def get_remote_dc_members_state(self) -> None:
-    #     # GET /disasterrecovery/remoteDcState
-    #     ...
-
-    @get("/disasterrecovery/status")
-    def get_dr_status(self) -> DisasterRecoveryStatusResponse:
-        ...
-
-    @post("/disasterrecovery/pause")
-    def pause_dr(self) -> DisasterRecoveryPauseResponse:
-        ...
-
-    # def pause_local_arbitrator(self) -> None:
-    #     # POST /disasterrecovery/pauseLocalArbitrator
-    #     ...
-
-    # def pause_local_dc_for_dr(self) -> None:
-    #     # POST /disasterrecovery/pauseLocalDC
-    #     ...
-
-    # def pause_local_dc_replication(self) -> None:
-    #     # POST /disasterrecovery/pauseLocalReplication
-    #     ...
-
-    @post("/disasterrecovery/register")
-    def register(self, payload: DisasterRecoveryRegisterPayload) -> RegisterDisasterRecoveryTaskId:
-        ...
-
-    # def restart_data_center(self) -> None:
-    #     # POST /disasterrecovery/restartDataCenter
-    #     ...
-
-    # def restore_config_db(self) -> None:
-    #     # POST /disasterrecovery/dbrestore
-    #     ...
-
-    @post("/disasterrecovery/unpause")
-    def unpause_dr(self) -> UnpauseDisasterRecoveryTaskId:
-        ...
-
-    # def unpause_local_arbitrator(self) -> None:
-    #     # POST /disasterrecovery/unpauseLocalArbitrator
-    #     ...
-
-    # def unpause_local_dc_for_dr(self) -> None:
-    #     # POST /disasterrecovery/unpauseLocalDC
-    #     ...
-
-    # def unpause_local_dc_replication(self) -> None:
-    #     # POST /disasterrecovery/unpauseLocalReplication
-    #     ...
-
-    # def update(self) -> None:
-    #     # POST /disasterrecovery/password
-    #     ...
-
-    # def update1(self) -> None:
-    #     # PUT /disasterrecovery/register
-    #     ...
-
-    # def update_disaster_recovery_state(self) -> None:
-    #     # POST /disasterrecovery/remotePassword
-    #     ...
-
-    # def update_disaster_recovery_state1(self) -> None:
-    #     # POST /disasterrecovery/remotedc
-    #     ...
-
-    # def update_dr_state(self) -> None:
-    #     # POST /disasterrecovery/updateDRConfigOnArbitrator
-    #     ...
-
-    # def update_replication(self) -> None:
-    #     # POST /disasterrecovery/updateReplication
-    #     ...

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:
-        ...