catalystwan 0.41.2__py3-none-any.whl → 0.41.2.dev1__py3-none-any.whl

catalystwan/api/templates/models/cisco_logging_model.py

@@ -1,85 +1,122 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
-from enum import Enum
 from pathlib import Path
-from typing import ClassVar, List, Optional
+from typing import ClassVar, List, Literal, Optional
 
 from pydantic import ConfigDict, Field
 
 from catalystwan.api.templates.bool_str import BoolStr
 from catalystwan.api.templates.feature_template import FeatureTemplate, FeatureTemplateValidator
 
+Version = Literal["TLSv1.1", "TLSv1.2"]
 
-class Version(str, Enum):
-    TLSV11 = "TLSv1.1"
-    TLSV12 = "TLSv1.2"
 
-
-class AuthType(str, Enum):
-    SERVER = "Server"
-    MUTUAL = "Mutual"
+AuthType = Literal["Server", "Mutual"]
 
 
 class TlsProfile(FeatureTemplateValidator):
-    profile: str
-    version: Optional[Version] = Field(Version.TLSV11, json_schema_extra={"data_path": ["tls-version"]})
-    auth_type: AuthType = Field(json_schema_extra={"vmanage_key": "auth-type"})
-    ciphersuite_list: Optional[List] = Field(
-        default=None, json_schema_extra={"data_path": ["ciphersuite"], "vmanage_key": "ciphersuite-list"}
+    profile: str = Field(description="The name of the TLS profile")
+    version: Optional[Version] = Field(
+        default="TLSv1.1", json_schema_extra={"data_path": ["tls-version"]}, description="The TLS version"
+    )
+    auth_type: AuthType = Field(
+        json_schema_extra={"vmanage_key": "auth-type"}, description="The authentication type for the TLS connection"
+    )
+    ciphersuite_list: Optional[List[str]] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["ciphersuite"], "vmanage_key": "ciphersuite-list"},
+        description="The list of ciphersuites for the TLS connection",
     )
     model_config = ConfigDict(populate_by_name=True)
 
 
-class Priority(str, Enum):
-    INFORMATION = "information"
-    DEBUGGING = "debugging"
-    NOTICE = "notice"
-    WARN = "warn"
-    ERROR = "error"
-    CRITICAL = "critical"
-    ALERT = "alert"
-    EMERGENCY = "emergency"
+Priority = Literal["information", "debugging", "notice", "warn", "error", "critical", "alert", "emergency"]
 
 
 class Server(FeatureTemplateValidator):
-    name: str
-    vpn: Optional[int] = None
-    source_interface: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "source-interface"})
-    priority: Optional[Priority] = Priority.INFORMATION
+    name: str = Field(description="The hostname/IPv4 address of the server")
+    vpn: Optional[int] = Field(description="The VPN ID for the server")
+    source_interface: Optional[str] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "source-interface"},
+        description="The source interface for the server",
+    )
+    priority: Optional[Priority] = Field(default="information", description="The priority level for logging messages")
     enable_tls: Optional[BoolStr] = Field(
-        default=False, json_schema_extra={"data_path": ["tls"], "vmanage_key": "enable-tls"}
+        default=False,
+        json_schema_extra={"data_path": ["tls"], "vmanage_key": "enable-tls"},
+        description="Whether to enable TLS encryption",
     )
     custom_profile: Optional[BoolStr] = Field(
-        default=False, json_schema_extra={"data_path": ["tls", "tls-properties"], "vmanage_key": "custom-profile"}
+        default=False,
+        json_schema_extra={"data_path": ["tls", "tls-properties"], "vmanage_key": "custom-profile"},
+        description="Whether to use a custom TLS profile",
+    )
+    profile: Optional[str] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tls", "tls-properties"]},
+        description="The custom TLS profile to use",
     )
-    profile: Optional[str] = Field(default=None, json_schema_extra={"data_path": ["tls", "tls-properties"]})
     model_config = ConfigDict(populate_by_name=True)
 
 
 class Ipv6Server(FeatureTemplateValidator):
-    name: str
-    vpn: Optional[int] = None
-    source_interface: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "source-interface"})
-    priority: Optional[Priority] = Priority.INFORMATION
+    name: str = Field(description="The name of the IPv6 server")
+    vpn: Optional[int] = Field(description="The VPN ID for the IPv6 server")
+    source_interface: Optional[str] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "source-interface"},
+        description="The source interface for the IPv6 server",
+    )
+    priority: Optional[Priority] = Field(
+        default="information", description="The priority level for logging messages to the IPv6 server"
+    )
     enable_tls: Optional[BoolStr] = Field(
-        default=False, json_schema_extra={"data_path": ["tls"], "vmanage_key": "enable-tls"}
+        default=False,
+        json_schema_extra={"data_path": ["tls"], "vmanage_key": "enable-tls"},
+        description="Whether to enable TLS encryption for the IPv6 server",
     )
     custom_profile: Optional[BoolStr] = Field(
-        default=False, json_schema_extra={"data_path": ["tls", "tls-properties"], "vmanage_key": "custom-profile"}
+        default=False,
+        json_schema_extra={"data_path": ["tls", "tls-properties"], "vmanage_key": "custom-profile"},
+        description="Whether to use a custom TLS profile for the IPv6 server",
+    )
+    profile: Optional[str] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tls", "tls-properties"]},
+        description="The custom TLS profile to use for the IPv6 server",
     )
-    profile: Optional[str] = Field(default=None, json_schema_extra={"data_path": ["tls", "tls-properties"]})
     model_config = ConfigDict(populate_by_name=True)
 
 
 class CiscoLoggingModel(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    _docs_description: str = "Cisco Logging Feature Template configuration"
 
-    enable: Optional[BoolStr] = Field(default=None, json_schema_extra={"data_path": ["disk"]})
-    size: Optional[int] = Field(default=None, json_schema_extra={"data_path": ["disk", "file"]})
-    rotate: Optional[int] = Field(default=None, json_schema_extra={"data_path": ["disk", "file"]})
-    tls_profile: Optional[List[TlsProfile]] = Field(default=None, json_schema_extra={"vmanage_key": "tls-profile"})
-    server: Optional[List[Server]] = None
-    ipv6_server: Optional[List[Ipv6Server]] = Field(default=None, json_schema_extra={"vmanage_key": "ipv6-server"})
+    enable: Optional[BoolStr] = Field(
+        default=None, json_schema_extra={"data_path": ["disk"]}, description="Whether logging to disk is enabled"
+    )
+    size: Optional[int] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["disk", "file"]},
+        description="The maximum file size for the log file",
+    )
+    rotate: Optional[int] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["disk", "file"]},
+        description="The number of log files to maintain before rotating",
+    )
+    tls_profile: Optional[List[TlsProfile]] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "tls-profile"},
+        description="List of TLS profiles configurations",
+    )
+    server: Optional[List[Server]] = Field(default=None, description="List of server configurations for logging")
+    ipv6_server: Optional[List[Ipv6Server]] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "ipv6-server"},
+        description="List of IPv6 server configurations for logging",
+    )
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "cisco_logging"

catalystwan/api/templates/models/cisco_ntp_model.py

@@ -12,30 +12,49 @@ from catalystwan.api.templates.feature_template import FeatureTemplate, FeatureT
 class Server(FeatureTemplateValidator):
     model_config = ConfigDict(populate_by_name=True)
 
-    name: str
-    key: Optional[int] = None
-    vpn: Optional[int] = None
-    version: Optional[int] = None
-    source_interface: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "source-interface"})
-    prefer: Optional[BoolStr] = None
+    name: str = Field(description="The hostname or IP address of the NTP server")
+    key: Optional[int] = Field(default=None, description="The identifier for the authentication key")
+    vpn: Optional[int] = Field(default=None, description="The VPN ID associated with the NTP server")
+    version: Optional[int] = Field(default=None, description="The NTP version used")
+    source_interface: Optional[str] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "source-interface"},
+        description="The source interface for NTP messages",
+    )
+    prefer: Optional[BoolStr] = Field(default=None, description="Whether this server is preferred over others")
 
 
 class Authentication(FeatureTemplateValidator):
     model_config = ConfigDict(populate_by_name=True)
 
-    number: int
-    md5: str
+    number: int = Field(description="The authentication key number")
+    md5: str = Field(description="The MD5 hash used for authentication")
 
 
 class CiscoNTPModel(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-
-    server: List[Server] = Field(default=[])
-    authentication: Optional[List[Authentication]] = Field(default=None, json_schema_extra={"data_path": ["keys"]})
-    trusted: Optional[List[int]] = Field(default=None, json_schema_extra={"data_path": ["keys"]})
-    enable: Optional[BoolStr] = Field(default=None, json_schema_extra={"data_path": ["master"]})
-    stratum: Optional[int] = Field(default=None, json_schema_extra={"data_path": ["master"]})
-    source: Optional[str] = Field(default=None, json_schema_extra={"data_path": ["master"]})
+    _docs_description: str = "Cisco NTP Feature Template configuration"
+
+    server: List[Server] = Field(default=[], description="List of NTP servers")
+    authentication: Optional[List[Authentication]] = Field(
+        default=None, json_schema_extra={"data_path": ["keys"]}, description="List of authentication keys"
+    )
+    trusted: Optional[List[int]] = Field(
+        default=None, json_schema_extra={"data_path": ["keys"]}, description="List of trusted key numbers"
+    )
+    enable: Optional[BoolStr] = Field(
+        default=None, json_schema_extra={"data_path": ["master"]}, description="Whether the device is an NTP master"
+    )
+    stratum: Optional[int] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["master"]},
+        description="The stratum level if the device is an NTP master",
+    )
+    source: Optional[str] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["master"]},
+        description="The source interface for NTP messages if the device is an NTP master",
+    )
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "cisco_ntp"

catalystwan/api/templates/models/cisco_omp_model.py

@@ -1,8 +1,7 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
-from enum import Enum
 from pathlib import Path
-from typing import ClassVar, List, Optional
+from typing import ClassVar, List, Literal, Optional
 
 from pydantic import ConfigDict, Field
 
@@ -17,95 +16,106 @@ DEFAULT_OMP_SENDPATH_LIMIT = 4
 DEFAULT_OMP_ECMP_LIMIT = 4
 
 
-class IPv4AdvertiseProtocol(str, Enum):
-    BGP = "bgp"
-    OSPF = "ospf"
-    OSPFV3 = "ospfv3"
-    CONNECTED = "connected"
-    STATIC = "static"
-    EIGRP = "eigrp"
-    LISP = "lisp"
-    ISIS = "isis"
-
-
-class Route(str, Enum):
-    EXTERNAL = "external"
+IPv4AdvertiseProtocol = Literal["bgp", "ospf", "ospfv3", "connected", "static", "eigrp", "lisp", "isis"]
+IPv6AdvertiseProtocol = Literal["bgp", "ospf", "connected", "static", "eigrp", "lisp", "isis"]
+TransportGateway = Literal["prefer", "ecmp-with-direct-path"]
+SiteTypes = Literal["type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke"]
+Route = Literal["external"]
 
 
 class IPv4Advertise(FeatureTemplateValidator):
-    protocol: IPv4AdvertiseProtocol
-    route: Optional[Route] = None
-
-
-class IPv6AdvertiseProtocol(str, Enum):
-    BGP = "bgp"
-    OSPF = "ospf"
-    CONNECTED = "connected"
-    STATIC = "static"
-    EIGRP = "eigrp"
-    LISP = "lisp"
-    ISIS = "isis"
+    protocol: IPv4AdvertiseProtocol = Field(description="The IPv4 routing protocol whose routes are to be advertised.")
+    route: Optional[Route] = Field(
+        default=None,
+        description="The type of IPv4 routes to be advertised. For example, 'external' for external routes.",
+    )
 
 
 class IPv6Advertise(FeatureTemplateValidator):
-    protocol: IPv6AdvertiseProtocol
-
-
-class TransportGateway(str, Enum):
-    PREFER = "prefer"
-    ECMP_WITH_DIRECT_PATH = "ecmp-with-direct-path"
-
-
-class SiteTypes(str, Enum):
-    TYPE_1 = "type-1"
-    TYPE_2 = "type-2"
-    TYPE_3 = "type-3"
-    CLOUD = "cloud"
-    BRANCH = "branch"
-    BR = "br"
-    SPOKE = "spoke"
+    protocol: IPv6AdvertiseProtocol = Field(description="The IPv6 routing protocol whose routes are to be advertised.")
 
 
 class CiscoOMPModel(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    _docs_description: str = "Configuration settings for the Cisco Overlay Management Protocol (OMP) feature template."
 
-    graceful_restart: Optional[BoolStr] = Field(default=True, json_schema_extra={"vmanage_key": "graceful-restart"})
-    overlay_as: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "overlay-as"})
+    graceful_restart: Optional[BoolStr] = Field(
+        default=True,
+        description="Enable or disable graceful restart for OMP.",
+        json_schema_extra={"vmanage_key": "graceful-restart"},
+    )
+    overlay_as: Optional[int] = Field(
+        default=None,
+        description="The autonomous system number used for the overlay.",
+        json_schema_extra={"vmanage_key": "overlay-as"},
+    )
     send_path_limit: Optional[int] = Field(
-        DEFAULT_OMP_SENDPATH_LIMIT, json_schema_extra={"vmanage_key": "send-path-limit"}
+        default=DEFAULT_OMP_SENDPATH_LIMIT,
+        ge=1,
+        le=32,
+        description="The maximum number of paths that can be sent for each prefix.",
+        json_schema_extra={"vmanage_key": "send-path-limit"},
+    )
+    ecmp_limit: Optional[int] = Field(
+        default=DEFAULT_OMP_ECMP_LIMIT,
+        description="The maximum number of equal-cost multi-path routes.",
+        json_schema_extra={"vmanage_key": "ecmp-limit"},
     )
-    ecmp_limit: Optional[int] = Field(DEFAULT_OMP_ECMP_LIMIT, json_schema_extra={"vmanage_key": "ecmp-limit"})
-    shutdown: Optional[BoolStr] = None
+    shutdown: Optional[BoolStr] = Field(default=None, description="Enable or disable the shutdown of OMP.")
     omp_admin_distance_ipv4: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "omp-admin-distance-ipv4"}
+        default=None,
+        description="The administrative distance for IPv4 routes learned via OMP.",
+        json_schema_extra={"vmanage_key": "omp-admin-distance-ipv4"},
     )
     omp_admin_distance_ipv6: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "omp-admin-distance-ipv6"}
+        default=None,
+        description="The administrative distance for IPv6 routes learned via OMP.",
+        json_schema_extra={"vmanage_key": "omp-admin-distance-ipv6"},
     )
     advertisement_interval: Optional[int] = Field(
-        DEFAULT_OMP_ADVERTISEMENT_INTERVAL,
+        default=DEFAULT_OMP_ADVERTISEMENT_INTERVAL,
+        description="The interval between sending unsolicited OMP route advertisements.",
         json_schema_extra={"vmanage_key": "advertisement-interval", "data_path": ["timers"]},
     )
     graceful_restart_timer: Optional[int] = Field(
-        DEFAULT_OMP_GRACEFUL_RESTART_TIMER,
+        default=DEFAULT_OMP_GRACEFUL_RESTART_TIMER,
+        description="The timer for graceful restart, specifying the period during which peerings are preserved.",
         json_schema_extra={"vmanage_key": "graceful-restart-timer", "data_path": ["timers"]},
     )
     eor_timer: Optional[int] = Field(
-        DEFAULT_OMP_EOR_TIMER, json_schema_extra={"vmanage_key": "eor-timer", "data_path": ["timers"]}
+        default=DEFAULT_OMP_EOR_TIMER,
+        description="End-of-RIB (EOR) timer which indicates stability of the route table.",
+        json_schema_extra={"vmanage_key": "eor-timer", "data_path": ["timers"]},
     )
-    holdtime: Optional[int] = Field(DEFAULT_OMP_HOLDTIME, json_schema_extra={"data_path": ["timers"]})
-    advertise: Optional[List[IPv4Advertise]] = None
+    holdtime: Optional[int] = Field(
+        default=DEFAULT_OMP_HOLDTIME,
+        description="The amount of time that the routes are preserved while the peer is unreachable.",
+        json_schema_extra={"data_path": ["timers"]},
+    )
+    advertise: Optional[List[IPv4Advertise]] = Field(default=None, description="A list of IPv4 advertise rules.")
     ipv6_advertise: Optional[List[IPv6Advertise]] = Field(
-        default=None, json_schema_extra={"vmanage_key": "ipv6-advertise"}
+        default=None, description="A list of IPv6 advertise rules.", json_schema_extra={"vmanage_key": "ipv6-advertise"}
     )
     ignore_region_path_length: Optional[BoolStr] = Field(
-        default=False, json_schema_extra={"vmanage_key": "ignore-region-path-length"}
+        default=False,
+        description="Whether to ignore the region part of the path length for OMP routes.",
+        json_schema_extra={"vmanage_key": "ignore-region-path-length"},
     )
     transport_gateway: Optional[TransportGateway] = Field(
-        default=None, json_schema_extra={"vmanage_key": "transport-gateway"}
+        default=None,
+        description="Specifies the preferred transport gateway selection strategy.",
+        json_schema_extra={"vmanage_key": "transport-gateway"},
+    )
+    site_types: Optional[List[SiteTypes]] = Field(
+        default=None,
+        description="A list of site types that are allowed to participate in the overlay network.",
+        json_schema_extra={"vmanage_key": "site-types"},
+    )
+    auto_translate: Optional[BoolStr] = Field(
+        default=False,
+        description="Enable or disable automatic translation of network settings.",
+        json_schema_extra={"vmanage_key": "auto-translate"},
     )
-    site_types: Optional[List[SiteTypes]] = Field(default=None, json_schema_extra={"vmanage_key": "site-types"})
-    auto_translate: Optional[BoolStr] = Field(default=False, json_schema_extra={"vmanage_key": "auto-translate"})
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "cisco_omp"