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

catalystwan/api/templates/models/cli_template.py

@@ -3,16 +3,15 @@
 from pathlib import Path
 from typing import ClassVar
 
-from pydantic import ConfigDict, Field
+from pydantic import ConfigDict
 
 from catalystwan.api.templates.feature_template import FeatureTemplate
 
 
 class CliTemplateModel(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-    _docs_description: str = "CLI Template Feature configuration for applying command-line settings."
 
-    config: str = Field(description="The CLI configuration commands to be applied as a template.")
+    config: str
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "cli-template"

catalystwan/api/templates/models/omp_vsmart_model.py

@@ -11,62 +11,26 @@ from catalystwan.api.templates.feature_template import FeatureTemplate
 
 class OMPvSmart(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-    _docs_description: str = "Overlay Management Protocol (OMP) settings for vSmart controller"
 
-    graceful_restart: Optional[BoolStr] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "graceful-restart"},
-        description="Enable or disable graceful restart for the OMP session",
-    )
-    send_path_limit: Optional[int] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "send-path-limit"},
-        description="The maximum number of paths that can be sent to a TLOC",
-    )
-    send_backup_paths: Optional[BoolStr] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "send-backup-paths"},
-        description="Enable or disable sending additional backup paths",
-    )
-    discard_rejected: Optional[BoolStr] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "discard-rejected"},
-        description="Discard routes that are rejected by policy instead of marking them as rejected",
-    )
-    shutdown: Optional[BoolStr] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "shutdown"},
-        description="Enable or disable the shutdown of the OMP session",
-    )
+    graceful_restart: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "graceful-restart"})
+    send_path_limit: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "send-path-limit"})
+    send_backup_paths: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "send-backup-paths"})
+    discard_rejected: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "discard-rejected"})
+    shutdown: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "shutdown"})
     graceful_restart_timer: Optional[int] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "graceful-restart-timer", "data_path": ["timers"]},
-        description="The time interval for graceful restart of OMP sessions",
+        default=None, json_schema_extra={"vmanage_key": "graceful-restart-timer", "data_path": ["timers"]}
     )
     eor_timer: Optional[int] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "eor-timer", "data_path": ["timers"]},
-        description="The End of Routes (EOR) timer value",
+        default=None, json_schema_extra={"vmanage_key": "eor-timer", "data_path": ["timers"]}
     )
     holdtime: Optional[int] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "holdtime", "data_path": ["timers"]},
-        description="The hold time interval for OMP sessions",
+        default=None, json_schema_extra={"vmanage_key": "holdtime", "data_path": ["timers"]}
     )
     affinity_group_preference: Optional[BoolStr] = Field(
-        default=False,
-        json_schema_extra={"vmanage_key": "affinity-group-preference", "data_path": ["filter-route", "outbound"]},
-        description="Filter routes based on affinity preference list",
+        default=None, json_schema_extra={"vmanage_key": "affinity-group-preference"}
     )
     advertisement_interval: Optional[int] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "advertisement-interval", "data_path": ["timers"]},
-        description="Interval between sending OMP route advertisements",
-    )
-    tloc_color: Optional[BoolStr] = Field(
-        default=False,
-        json_schema_extra={"vmanage_key": "tloc-color", "data_path": ["filter-route", "outbound"]},
-        description="Filter routes based on TLOC color",
+        default=None, json_schema_extra={"vmanage_key": "advertisement-interval", "data_path": ["timers"]}
     )
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"

catalystwan/api/templates/models/security_vsmart_model.py

@@ -1,28 +1,25 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
+from enum import Enum
 from pathlib import Path
-from typing import ClassVar, Literal, Optional
+from typing import ClassVar, Optional
 
 from pydantic import ConfigDict, Field
 
 from catalystwan.api.templates.feature_template import FeatureTemplate
 
-Protocol = Literal["dtls", "tls"]
+
+class Protocol(str, Enum):
+    DTLS = "dtls"
+    TLS = "tls"
 
 
 class SecurityvSmart(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-    _docs_description: str = "Security settings for vSmart controller"
 
-    protocol: Optional[Protocol] = Field(
-        default=None,
-        json_schema_extra={"data_path": ["control"]},
-        description="The security protocol used for control plane communication",
-    )
+    protocol: Optional[Protocol] = Field(default=None, json_schema_extra={"data_path": ["control"]})
     tls_port: Optional[int] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "tls-port", "data_path": ["control"]},
-        description="The port used for TLS communications",
+        default=None, json_schema_extra={"vmanage_key": "tls-port", "data_path": ["control"]}
     )
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "security-vsmart"

catalystwan/api/templates/models/supported.py

@@ -1,6 +1,5 @@
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
 
-from catalystwan.api.templates.models.aaa_model import AAAModel
 from catalystwan.api.templates.models.cisco_aaa_model import CiscoAAAModel
 from catalystwan.api.templates.models.cisco_banner_model import CiscoBannerModel
 from catalystwan.api.templates.models.cisco_bfd_model import CiscoBFDModel
@@ -16,17 +15,17 @@ from catalystwan.api.templates.models.cisco_vpn_model import CiscoVPNModel
 from catalystwan.api.templates.models.omp_vsmart_model import OMPvSmart
 from catalystwan.api.templates.models.security_vsmart_model import SecurityvSmart
 from catalystwan.api.templates.models.system_vsmart_model import SystemVsmart
-from catalystwan.api.templates.models.vpn_vsmart_interface_model import VpnVsmartInterfaceModel
-from catalystwan.api.templates.models.vpn_vsmart_model import VpnVsmartModel
 
 available_models = {
-    "aaa": AAAModel,
     "cisco_aaa": CiscoAAAModel,
-    "cisco_banner": CiscoBannerModel,
     "cisco_bfd": CiscoBFDModel,
+    "cisco_banner": CiscoBannerModel,
     "cisco_ntp": CiscoNTPModel,
     "cisco_ospf": CiscoOSPFModel,
     "cisco_logging": CiscoLoggingModel,
+    "omp_vsmart": OMPvSmart,
+    "security_vsmart": SecurityvSmart,
+    "system_vsmart": SystemVsmart,
     "cisco_vpn_interface": CiscoVpnInterfaceModel,
     "cisco_system": CiscoSystemModel,
     "cisco_vpn": CiscoVPNModel,
@@ -34,9 +33,4 @@ available_models = {
     "cisco_system": CiscoSystemModel,
     "cisco_secure_internet_gateway": CiscoSecureInternetGatewayModel,
     "cisco_omp": CiscoOMPModel,
-    "omp_vsmart": OMPvSmart,
-    "security_vsmart": SecurityvSmart,
-    "system_vsmart": SystemVsmart,
-    "vpn_vsmart": VpnVsmartModel,
-    "vpn_vsmart_interface": VpnVsmartInterfaceModel,
 }

catalystwan/api/templates/models/system_vsmart_model.py

@@ -1,182 +1,45 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
 from pathlib import Path
-from typing import ClassVar, List, Literal, Optional, Union
+from typing import ClassVar, Optional
 
 from pydantic import ConfigDict, Field
 
-from catalystwan.api.templates.bool_str import BoolStr
-from catalystwan.api.templates.device_variable import DeviceVariable
-from catalystwan.api.templates.feature_template import FeatureTemplate, FeatureTemplateValidator
-from catalystwan.models.common import Timezone, TLOCColor
-
-Toology = Literal["hub-and-spoke"]
-
-
-class TlocColorComparison(FeatureTemplateValidator):
-    color_1: Optional[TLOCColor] = Field(
-        default=None,
-        description="First TLOC color in comparsion",
-        json_schema_extra={"vmanage_key": "color-1"},
-    )
-    color_2: Optional[TLOCColor] = Field(
-        default=None,
-        description="Second TLOC color in comparsion",
-        json_schema_extra={"vmanage_key": "color-2"},
-    )
-    model_config = ConfigDict(populate_by_name=True)
+from catalystwan.api.templates.feature_template import FeatureTemplate
+from catalystwan.utils.timezone import Timezone
 
 
 class SystemVsmart(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-    _docs_description: str = "Security settings for vSmart controller"
 
-    timezone: Optional[Timezone] = Field(
-        default="UTC",
-        description="The timezone setting for the vSmart controller",
-        json_schema_extra={"data_path": ["clock"]},
-    )
-    host_name: DeviceVariable = Field(
-        default=DeviceVariable(name="system_host_name"),
-        json_schema_extra={"vmanage_key": "host-name"},
-        description="The hostname for the vSmart controller",
-    )
-    dual_stack_ipv6: Union[DeviceVariable, BoolStr] = Field(
-        default=DeviceVariable(name="system_ipv6-strict-control"),
-        json_schema_extra={"vmanage_key": "ipv6-strict-control"},
-        description="Enable Dual Stack IPv6 Default",
-    )
-    description: Optional[str] = Field(default=None, description="Set a text description of the device")
-    location: Optional[str] = Field(
-        default=None, description="A description of the physical location of the vSmart controller"
-    )
-    system_tunnel_mtu: Optional[int] = Field(
-        default=1024, json_schema_extra={"vmanage_key": "system-tunnel-mtu"}, description="MTU size for system tunnels"
-    )
-    latitude: Optional[int] = Field(
-        default=None,
-        ge=-90,
-        le=90,
-        json_schema_extra={"data_path": ["gps-location"]},
-        description="Geographical latitude of the vSmart controller",
-    )
-    longitude: Optional[int] = Field(
-        default=None,
-        ge=-180,
-        le=180,
-        json_schema_extra={"data_path": ["gps-location"]},
-        description="Geographical longitude of the vSmart controller",
-    )
-    device_groups: List[str] = Field(
-        default_factory=list,
-        json_schema_extra={"vmanage_key": "device-groups"},
-        description="Device group names for the vSmart controller",
-    )
-    system_ip: DeviceVariable = Field(
-        default=DeviceVariable(name="system_system_ip"),
-        json_schema_extra={"vmanage_key": "system-ip"},
-        description="System IP address for the vSmart controller",
-    )
-    site_id: DeviceVariable = Field(
-        default=DeviceVariable(name="system_site_id"),
-        json_schema_extra={"vmanage_key": "site-id"},
-        description="Site ID for the vSmart controller",
-    )
-    overlay_id: Optional[int] = Field(
-        default=1,
-        ge=1,
-        le=4294967295,
-        json_schema_extra={"vmanage_key": "overlay-id"},
-        description="Overlay ID for the vSmart controller",
+    timezone: Optional[Timezone] = Field(default=None)
+    idle_timeout: Optional[int] = Field(default=None, ge=0, le=300, json_schema_extra={"vmanage_key": "idle-timeout"})
+    admin_tech_on_failure: Optional[bool] = Field(
+        default=True, json_schema_extra={"vmanage_key": "admin-tech-on-failure"}
     )
-    topology: Optional[List[Toology]] = Field(
-        default=None,
-        description="Set the topology",
-    )
-    port_offset: Optional[int] = Field(
-        default=0,
-        ge=0,
-        le=20,
-        json_schema_extra={"vmanage_key": "port-offset"},
-        description="Port offset for port hopping",
-    )
-    port_hop: Optional[bool] = Field(
-        default=True, json_schema_extra={"vmanage_key": "port-hop"}, description="Enable or disable port hopping"
-    )
-    control_session_pps: Optional[int] = Field(
-        default=300,
-        json_schema_extra={"vmanage_key": "control-session-pps"},
-        description="Control session packets per second limit",
-    )
-    controller_group_id: Optional[int] = Field(
-        default=0,
-        ge=0,
-        le=100,
-        json_schema_extra={"vmanage_key": "controller-group-id"},
-        description="Group ID for the vSmart controller",
-    )
-    track_transport: Optional[BoolStr] = Field(
-        default=True,
-        json_schema_extra={"vmanage_key": "track-transport"},
-        description="Enable or disable tracking of transport connections",
-    )
-    track_default_gateway: Optional[BoolStr] = Field(
-        default=True,
-        json_schema_extra={"vmanage_key": "track-default-gateway"},
-        description="Enable or disable tracking of the default gateway",
-    )
-    iptables_enable: Optional[BoolStr] = Field(
-        default=True,
-        json_schema_extra={"vmanage_key": "iptables-enable"},
-        description="Enable or disable iptables for security",
-    )
-    admin_tech_on_failure: Optional[BoolStr] = Field(
-        default=True,
-        json_schema_extra={"vmanage_key": "admin-tech-on-failure"},
-        description="Enable automatic generation of tech-support file on failure",
-    )
-    idle_timeout: Optional[int] = Field(
-        default=None,
-        ge=0,
-        le=300,
-        json_schema_extra={"vmanage_key": "idle-timeout"},
-        description="Idle timeout in minutes for user sessions",
+    iptables_enable: Optional[bool] = Field(default=True, json_schema_extra={"vmanage_key": "iptables-enable"})
+    track_default_gateway: Optional[bool] = Field(
+        default=True, json_schema_extra={"vmanage_key": "track-default-gateway"}
     )
     dns_cache_timeout: Optional[int] = Field(
-        default=2,
-        ge=1,
-        le=30,
-        json_schema_extra={"vmanage_key": "dns-cache-timeout"},
-        description="DNS cache timeout in minutes",
-    )
-    region_list_id: Optional[int] = Field(
-        default=None,
-        ge=1,
-        le=64,
-        json_schema_extra={"vmanage_key": "region-id-list"},
-        description="Configure a list of region ID",
-    )
-    management_region: Optional[BoolStr] = Field(
-        default=None,
-        json_schema_extra={"vmanage_key": "management-region"},
-        description="Management Region",
-    )
-    compatible: Optional[List[TlocColorComparison]] = Field(
-        default=None,
-        json_schema_extra={
-            "data_path": ["tloc-color-compatibility"],
-            "priority_order": ["color-1", "color-2"],
-        },
-        description="Configure compatible TLOC color",
-    )
-    incompatible: Optional[List[TlocColorComparison]] = Field(
-        default=None,
-        json_schema_extra={
-            "data_path": ["tloc-color-compatibility"],
-            "priority_order": ["color-1", "color-2"],
-        },
-        description="Configure incompatible TLOC color",
+        default=2, ge=1, le=30, json_schema_extra={"vmanage_key": "dns-cache-timeout"}
     )
+    track_transport: Optional[bool] = Field(default=True, json_schema_extra={"vmanage_key": "track-transport"})
+    controller_group_id: Optional[int] = Field(
+        default=0, ge=0, le=100, json_schema_extra={"vmanage_key": "controller-group-id"}
+    )
+    control_session_pps: Optional[int] = Field(default=300, json_schema_extra={"vmanage_key": "control-session-pps"})
+    port_hop: Optional[bool] = Field(default=True, json_schema_extra={"vmanage_key": "port-hop"})
+    port_offset: Optional[int] = Field(default=0, ge=0, le=20, json_schema_extra={"vmanage_key": "port-offset"})
+    overlay_id: Optional[int] = Field(default=1, ge=1, le=4294967295, json_schema_extra={"vmanage_key": "overlay-id"})
+    site_id: Optional[int] = Field(default=1, ge=1, le=4294967295, json_schema_extra={"vmanage_key": "site-id"})
+    system_ip: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "system-ip"})
+    device_groups: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "device-groups"})
+    longitude: Optional[int] = Field(default=None, ge=-180, le=180)
+    latitude: Optional[int] = Field(default=None, ge=-90, le=90)
+    system_tunnel_mtu: Optional[int] = Field(default=1024, json_schema_extra={"vmanage_key": "system-tunnel-mtu"})
+    location: Optional[str] = None
+    host_name: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "host-name"})
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "system-vsmart"

catalystwan/apigw_auth.py

@@ -7,10 +7,10 @@ from urllib.parse import urlparse
 from pydantic import BaseModel, Field, PositiveInt
 from requests import HTTPError, PreparedRequest, post
 from requests.auth import AuthBase
-from requests.exceptions import JSONDecodeError, Timeout
+from requests.exceptions import JSONDecodeError
 
 from catalystwan.abstractions import APIEndpointClient, AuthProtocol
-from catalystwan.exceptions import ApiGwAuthTimeout, CatalystwanException
+from catalystwan.exceptions import CatalystwanException
 from catalystwan.response import auth_response_debug
 
 LoginMode = Literal["machine", "user", "session"]
@@ -106,8 +106,6 @@ class ApiGwAuth(AuthBase, AuthProtocol):
             raise CatalystwanException(
                 f"Problem with connection to ApiGateway login endpoint, ({ex}). Response: ({response.text})"
             )
-        except Timeout as ex:
-            raise ApiGwAuthTimeout(f"The request to the API GW login timeout, ({ex}).")
         except KeyError as ex:
             raise CatalystwanException(f"Not found token in login response from ApiGateway, ({ex})")
         else:
@@ -141,8 +139,6 @@ class ApiGwAuth(AuthBase, AuthProtocol):
                 f"Problem with connecting to API GW organization registration endpoint, ({ex}).\
                   Response: ({response.text})"
             )
-        except Timeout as ex:
-            raise ApiGwAuthTimeout(f"The request to the API GW organization registration timeout, ({ex}).")
         except Exception as ex:
             raise CatalystwanException(f"Org registration to API-GW failed: {ex}")
 

catalystwan/dataclasses.py

@@ -11,9 +11,9 @@ from catalystwan.utils.alarm_status import Severity
 from catalystwan.utils.certificate_status import ValidityPeriod
 from catalystwan.utils.colors import PrintColors
 from catalystwan.utils.creation_tools import FIELD_NAME, asdict, convert_attributes
-from catalystwan.utils.persona import Persona
 from catalystwan.utils.personality import Personality
 from catalystwan.utils.reachability import Reachability
+from catalystwan.utils.template_type import TemplateType
 
 
 class DataclassBase:
@@ -252,6 +252,36 @@ class User(DataclassBase):
     resource_group: Optional[str] = field(default=None, metadata={FIELD_NAME: "resGroupName"})
 
 
+@define(kw_only=True)
+class TemplateInfo(DataclassBase):
+    last_updated_by: str = field(metadata={FIELD_NAME: "lastUpdatedBy"})
+    id: str = field(metadata={FIELD_NAME: "templateId"})
+    factory_default: bool = field(metadata={FIELD_NAME: "factoryDefault"})
+    name: str = field(metadata={FIELD_NAME: "templateName"})
+    devices_attached: int = field(metadata={FIELD_NAME: "devicesAttached"})
+    description: str = field(metadata={FIELD_NAME: "templateDescription"})
+    last_updated_on: dt.datetime = field(metadata={FIELD_NAME: "lastUpdatedOn"})
+    resource_group: Optional[str] = field(default=None, metadata={FIELD_NAME: "resourceGroup"})
+
+
+@define(kw_only=True)
+class FeatureTemplateInfo(TemplateInfo):
+    template_type: str = field(metadata={FIELD_NAME: "templateType"})
+    device_type: List[str] = field(metadata={FIELD_NAME: "deviceType"})
+    version: str = field(metadata={FIELD_NAME: "templateMinVersion"})
+    template_definiton: Optional[str] = field(default=None, metadata={FIELD_NAME: "templateDefinition"})
+
+
+@define(kw_only=True)
+class DeviceTemplateInfo(TemplateInfo):
+    device_type: str = field(metadata={FIELD_NAME: "deviceType"})
+    template_class: str = field(metadata={FIELD_NAME: "templateClass"})
+    config_type: TemplateType = field(converter=TemplateType, metadata={FIELD_NAME: "configType"})
+    template_attached: int = field(metadata={FIELD_NAME: "templateAttached"})
+    draft_mode: Optional[str] = field(default=None, metadata={FIELD_NAME: "draftMode"})
+    device_role: Optional[str] = field(default=None, metadata={FIELD_NAME: "deviceRole"})
+
+
 @define
 class Speedtest(DataclassBase):
     device_ip: str
@@ -282,7 +312,7 @@ class ServiceConfigurationData(DataclassBase):
     vmanage_id: str = field(metadata={FIELD_NAME: "vmanageID"})
     device_ip: str = field(metadata={FIELD_NAME: "deviceIP"})  # consider using ip4 module to verify
     services: dict = field(metadata={FIELD_NAME: "services"})  # consider using nested dataclasses
-    persona: Persona = field(default="COMPUTE_AND_DATA")
+    persona: str = field(default="COMPUTE_AND_DATA")  # TODO Enum
     username: Optional[str] = field(default=None)
     password: Optional[str] = field(default=None)
 
@@ -344,6 +374,27 @@ class TierInfo(DataclassBase):
     nat_session_limit: Optional[int] = field(default=None, metadata={FIELD_NAME: "natSessionLimit"})
 
 
+@define(frozen=True)
+class FeatureTemplateInformation(DataclassBase):
+    """Endpoint: /dataservice/template/feature"""
+
+    id: str = field(metadata={FIELD_NAME: "templateId"})
+    name: str = field(metadata={FIELD_NAME: "templateName"})
+    description: str = field(metadata={FIELD_NAME: "templateDescription"})
+    type: str = field(metadata={FIELD_NAME: "templateType"})  # TODO Enum
+    device_types: List[str] = field(metadata={FIELD_NAME: "deviceType"})  # TODO Enum
+    last_updated_by: str = field(metadata={FIELD_NAME: "lastUpdatedBy"})
+    last_updated_on: dt.datetime = field(metadata={FIELD_NAME: "lastUpdatedOn"})
+    factory_default: bool = field(metadata={FIELD_NAME: "factoryDefault"})
+    devices_attached: int = field(metadata={FIELD_NAME: "devicesAttached"})
+    attached_masters: int = field(metadata={FIELD_NAME: "attachedMastersCount"})
+    version: str = field(metadata={FIELD_NAME: "templateMinVersion"})
+    config_type: str = field(metadata={FIELD_NAME: "configType"})
+    created_by: str = field(metadata={FIELD_NAME: "createdBy"})
+    created_on: dt.datetime = field(metadata={FIELD_NAME: "createdOn"})
+    resource_group: str = field(metadata={FIELD_NAME: "resourceGroup"})
+
+
 @define
 class Organization(DataclassBase):
     name: str = field(metadata={FIELD_NAME: "org"})