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

catalystwan/api/templates/models/cisco_ntp_model.py

@@ -1,60 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-from pathlib import Path
-from typing import ClassVar, List, Optional
-
-from pydantic import ConfigDict, Field
-
-from catalystwan.api.templates.bool_str import BoolStr
-from catalystwan.api.templates.feature_template import FeatureTemplate, FeatureTemplateValidator
-
-
-class Server(FeatureTemplateValidator):
-    model_config = ConfigDict(populate_by_name=True)
-
-    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 = 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)
-    _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,121 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-from pathlib import Path
-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
-
-DEFAULT_OMP_HOLDTIME = 60
-DEFAULT_OMP_EOR_TIMER = 300
-DEFAULT_OMP_GRACEFUL_RESTART_TIMER = 43200
-DEFAULT_OMP_ADVERTISEMENT_INTERVAL = 1
-DEFAULT_OMP_SENDPATH_LIMIT = 4
-DEFAULT_OMP_ECMP_LIMIT = 4
-
-
-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 = 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 = 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,
-        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=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"},
-    )
-    shutdown: Optional[BoolStr] = Field(default=None, description="Enable or disable the shutdown of OMP.")
-    omp_admin_distance_ipv4: Optional[int] = Field(
-        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,
-        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=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=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=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=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, description="A list of IPv6 advertise rules.", json_schema_extra={"vmanage_key": "ipv6-advertise"}
-    )
-    ignore_region_path_length: Optional[BoolStr] = Field(
-        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,
-        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"},
-    )
-
-    payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
-    type: ClassVar[str] = "cisco_omp"

catalystwan/api/templates/models/cisco_ospf.py

@@ -1,241 +0,0 @@
-# Copyright 2023 Cisco Systems, Inc. and its affiliates
-
-import ipaddress
-from pathlib import Path
-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
-
-DEFAULT_OSPF_HELLO_INTERVAL = 10
-DEFAULT_OSPF_DEAD_INTERVAL = 40
-DEFAULT_OSPF_RETRANSMIT_INTERVAL = 5
-DEFAULT_OSPF_INTERFACE_PRIORITY = 1
-DEFAULT_OSPF_REFERENCE_BANDWIDTH = 100
-DEFAULT_OSPF_EXTERNAL = 110
-DEFAULT_OSPF_INTER_AREA = 110
-DEFAULT_OSPF_INTRA_AREA = 110
-DEFAULT_OSPF_DELAY = 200
-DEFAULT_OSPF_INITIAL_HOLD = 1000
-DEFAULT_OSPF_MAX_HOLD = 10000
-
-
-Protocol = Literal["static", "connected", "bgp", "omp", "nat", "eigrp"]
-
-AdType = Literal["administrative", "on-startup"]
-
-Direction = Literal["in"]
-
-Network = Literal["broadcast", "point-to-point", "non-broadcast", "point-to-multipoint"]
-
-Type = Literal["simple", "message-digest", "null"]
-
-MetricType = Literal["type1", "type2"]
-
-
-class Redistribute(FeatureTemplateValidator):
-    protocol: Protocol = Field(description="The routing protocol from which routes are to be redistributed into OSPF.")
-    route_policy: Optional[str] = Field(
-        default=None,
-        description="Name of the route policy to control the redistribution.",
-        json_schema_extra={"vmanage_key": "route-policy"},
-    )
-    dia: Optional[BoolStr] = Field(
-        default=True, description="Default information originate, which controls the advertisement of default route."
-    )
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class RouterLsa(FeatureTemplateValidator):
-    ad_type: AdType = Field(
-        description="Type of advertisement for the router LSA.", json_schema_extra={"vmanage_key": "ad-type"}
-    )
-    time: int = Field(description="Time in seconds for advertisement.")
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class RoutePolicy(FeatureTemplateValidator):
-    direction: Direction = Field(description="Direction of the route policy (e.g., 'in' for incoming).")
-    pol_name: str = Field(description="Name of the route policy.", json_schema_extra={"vmanage_key": "pol-name"})
-
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class Interface(FeatureTemplateValidator):
-    name: str = Field(description="The name of the OSPF interface.")
-    hello_interval: Optional[int] = Field(
-        DEFAULT_OSPF_HELLO_INTERVAL,
-        description="The interval between the OSPF Hello packets that the router sends on the interface.",
-        json_schema_extra={"vmanage_key": "hello-interval"},
-    )
-    dead_interval: Optional[int] = Field(
-        DEFAULT_OSPF_DEAD_INTERVAL,
-        description=(
-            "The time interval an OSPF router waits for a Hello packet before declaring the sending router down."
-        ),
-        json_schema_extra={"vmanage_key": "dead-interval"},
-    )
-    retransmit_interval: Optional[int] = Field(
-        DEFAULT_OSPF_RETRANSMIT_INTERVAL,
-        description="The interval between LSA retransmissions for adjacencies belonging to the interface.",
-        json_schema_extra={"vmanage_key": "retransmit-interval"},
-    )
-    cost: Optional[int] = Field(default=None, description="The OSPF cost (metric) for this interface.")
-    priority: Optional[int] = Field(
-        default=DEFAULT_OSPF_INTERFACE_PRIORITY, description="The OSPF priority of the interface."
-    )
-    network: Optional[Network] = Field(default="broadcast", description="The OSPF network type for the interface.")
-    passive_interface: Optional[BoolStr] = Field(
-        default=False,
-        description="Whether the interface is a passive OSPF interface.",
-        json_schema_extra={"vmanage_key": "passive-interface"},
-    )
-    type: Optional[Type] = Field(
-        default=None,
-        description="The OSPF authentication type for the interface.",
-        json_schema_extra={"data_path": ["authentication"]},
-    )
-    message_digest_key: Optional[int] = Field(
-        default=None,
-        description="The message-digest key ID for OSPF authentication.",
-        json_schema_extra={"vmanage_key": "message-digest-key", "data_path": ["authentication", "message-digest"]},
-    )
-    md5: Optional[str] = Field(
-        default=None,
-        description="The MD5 string for OSPF message-digest authentication.",
-        json_schema_extra={"data_path": ["authentication", "message-digest"]},
-    )
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class Range(FeatureTemplateValidator):
-    address: ipaddress.IPv4Interface = Field(description="The IPv4 network address to be advertised as an OSPF range.")
-    cost: Optional[int] = Field(default=None, description="The OSPF cost (metric) for this range.")
-    no_advertise: Optional[BoolStr] = Field(
-        default=False,
-        description="Whether to suppress advertising this range.",
-        json_schema_extra={"vmanage_key": "no-advertise"},
-    )
-
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class Area(FeatureTemplateValidator):
-    a_num: int = Field(description="The OSPF area number.", json_schema_extra={"vmanage_key": "a-num"})
-    stub: Optional[BoolStr] = Field(
-        default=None,
-        description="Configuration for the OSPF area to be a stub area. If set, no-summary can be applied.",
-        json_schema_extra={"vmanage_key": "no-summary", "data_path": ["stub"]},
-    )
-    nssa: Optional[BoolStr] = Field(
-        default=None,
-        description=(
-            "Configuration for the OSPF area to be a Not-So-Stubby Area (NSSA). If set, no-summary can be applied."
-        ),
-        json_schema_extra={"vmanage_key": "no-summary", "data_path": ["nssa"]},
-    )
-    interface: Optional[List[Interface]] = Field(
-        default=None, description="A list of OSPF interface configurations associated with this area."
-    )
-    range: Optional[List[Range]] = Field(
-        default=None, description="A list of OSPF range entries to be associated with this area."
-    )
-    model_config = ConfigDict(populate_by_name=True)
-
-
-class CiscoOSPFModel(FeatureTemplate):
-    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-    _docs_description: str = "Cisco OSPF (Open Shortest Path First) configuration"
-
-    router_id: Optional[str] = Field(
-        default=None,
-        description="The router ID of the OSPF process.",
-        json_schema_extra={"vmanage_key": "router-id", "data_path": ["ospf"]},
-    )
-    reference_bandwidth: Optional[int] = Field(
-        DEFAULT_OSPF_REFERENCE_BANDWIDTH,
-        description="The reference bandwidth used by OSPF for cost calculation.",
-        json_schema_extra={"data_path": ["ospf", "auto-cost"], "vmanage_key": "reference-bandwidth"},
-    )
-    rfc1583: Optional[BoolStr] = Field(
-        default=True,
-        description="Compatibility switch for RFC 1583.",
-        json_schema_extra={"data_path": ["ospf", "compatible"]},
-    )
-    originate: Optional[BoolStr] = Field(
-        default=None,
-        description="Controls the origination of default information into the OSPF domain.",
-        json_schema_extra={"data_path": ["ospf", "default-information"]},
-    )
-    always: Optional[BoolStr] = Field(
-        default=None,
-        description=(
-            "Ensures that the default route is always advertised,"
-            " regardless of the existence of a default route in the routing table."
-        ),
-        json_schema_extra={"data_path": ["ospf", "default-information", "originate"]},
-    )
-    metric: Optional[int] = Field(
-        default=None,
-        description="The metric value to be set for the default route advertised by OSPF.",
-        json_schema_extra={"data_path": ["ospf", "default-information", "originate"]},
-    )
-    metric_type: Optional[MetricType] = Field(
-        default=None,
-        description="The metric type (Type 1 or Type 2) for OSPF external routes.",
-        json_schema_extra={"vmanage_key": "metric-type", "data_path": ["ospf", "default-information", "originate"]},
-    )
-    external: Optional[int] = Field(
-        DEFAULT_OSPF_EXTERNAL,
-        description="The OSPF external route metric.",
-        json_schema_extra={"data_path": ["ospf", "distance"]},
-    )
-    inter_area: Optional[int] = Field(
-        DEFAULT_OSPF_INTER_AREA,
-        description="The OSPF inter-area route metric.",
-        json_schema_extra={"data_path": ["ospf", "distance"], "vmanage_key": "inter-area"},
-    )
-    intra_area: Optional[int] = Field(
-        DEFAULT_OSPF_INTRA_AREA,
-        description="The OSPF intra-area route metric.",
-        json_schema_extra={"data_path": ["ospf", "distance"], "vmanage_key": "intra-area"},
-    )
-    delay: Optional[int] = Field(
-        DEFAULT_OSPF_DELAY,
-        description="The OSPF Shortest Path First (SPF) delay time.",
-        json_schema_extra={"data_path": ["ospf", "timers", "spf"]},
-    )
-    initial_hold: Optional[int] = Field(
-        DEFAULT_OSPF_INITIAL_HOLD,
-        description="The initial hold time between consecutive SPF calculations.",
-        json_schema_extra={"vmanage_key": "initial-hold", "data_path": ["ospf", "timers", "spf"]},
-    )
-    max_hold: Optional[int] = Field(
-        DEFAULT_OSPF_MAX_HOLD,
-        description="The maximum hold time between consecutive SPF calculations.",
-        json_schema_extra={"vmanage_key": "max-hold", "data_path": ["ospf", "timers", "spf"]},
-    )
-    redistribute: Optional[List[Redistribute]] = Field(
-        default=None,
-        description="A list of OSPF redistribution configurations.",
-        json_schema_extra={"vmanage_key": "redistribute", "data_path": ["ospf"]},
-    )
-    router_lsa: Optional[List[RouterLsa]] = Field(
-        default=None,
-        description="Configuration options for the Router LSA in OSPF.",
-        json_schema_extra={"vmanage_key": "router-lsa", "data_path": ["ospf", "max-metric"]},
-    )
-    route_policy: Optional[List[RoutePolicy]] = Field(
-        default=None,
-        description="A list of OSPF route policies.",
-        json_schema_extra={"vmanage_key": "route-policy", "data_path": ["ospf"]},
-    )
-    area: Optional[List[Area]] = Field(
-        default=None,
-        description="A list of OSPF areas and their configurations.",
-        json_schema_extra={"vmanage_key": "area", "data_path": ["ospf"]},
-    )
-    payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
-    type: ClassVar[str] = "cisco_ospf"