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

catalystwan/models/configuration/feature_profile/sdwan/transport/vpn.py

@@ -0,0 +1,285 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+from ipaddress import IPv4Address, IPv6Address, IPv6Interface
+from typing import Iterator, List, Literal, Optional, Tuple, Union
+
+from pydantic import AliasPath, BaseModel, ConfigDict, Field
+
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase, as_default
+from catalystwan.models.common import SubnetMask
+from catalystwan.models.configuration.feature_profile.common import DNSIPv4, DNSIPv6, HostMapping
+
+Gateway = Literal["nextHop", "dhcp", "null0"]
+Nat = Literal["NAT64", "NAT66"]
+ServiceType = Literal["TE"]
+
+UnitIPv4Address = Union[Variable, Global[IPv4Address]]
+UnitDistance = Union[Variable, Global[int]]
+
+RouteHop = Union[Tuple[UnitIPv4Address, UnitDistance], UnitIPv4Address]
+
+
+class Prefix(BaseModel):
+    """
+    Prefix
+    """
+
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    ip_address: Union[Variable, Global[IPv4Address]] = Field(
+        ..., serialization_alias="ipAddress", validation_alias="ipAddress", description="IP Address"
+    )
+    subnet_mask: Union[Variable, Global[SubnetMask]] = Field(
+        ..., serialization_alias="subnetMask", validation_alias="subnetMask", description="Subnet Mask"
+    )
+
+
+class NextHopItem(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    address: Union[Variable, Global[IPv4Address]] = Field(..., description="Variable")
+    distance: Union[Variable, Global[int], Default[int]] = Field(as_default(1), description="Administrative distance")
+
+
+class Ipv4RouteItem(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    prefix: Prefix = Field(..., description="Prefix")
+    gateway: Union[Global[Gateway], Default[Gateway]] = Field(
+        default=as_default("nextHop", Gateway), description="Gateway"
+    )
+    next_hop: Optional[List[NextHopItem]] = Field(
+        default=None,
+        serialization_alias="nextHop",
+        validation_alias="nextHop",
+        description="IPv4 Route Gateway Next Hop",
+    )
+    distance: Optional[Union[Variable, Global[int], Default[int]]] = Field(
+        default=None, description="Administrative distance"
+    )
+
+
+class NextHopItemIpv6(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    address: Union[Variable, Global[IPv6Address]] = Field(..., description="Variable")
+    distance: Union[Variable, Global[int], Default[int]] = Field(..., description="Administrative distance")
+
+
+class NextHopContainer(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    next_hop: Optional[List[NextHopItemIpv6]] = Field(
+        default=None,
+        serialization_alias="nextHop",
+        validation_alias="nextHop",
+        description="IPv6 Route Gateway Next Hop",
+    )
+
+
+class OneOfIpRouteNextHopContainer(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    next_hop_container: NextHopContainer = Field(
+        ..., serialization_alias="nextHopContainer", validation_alias="nextHopContainer"
+    )
+
+
+class OneOfIpRouteNull0(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    null0: Union[Global[bool], Default[bool]] = Field(
+        default=as_default(True), description="IPv6 Route Gateway Next Hop"
+    )
+
+
+class OneOfIpRouteNat(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    nat: Union[Variable, Global[Nat]] = Field(..., description="IPv6 Variable")
+
+
+class Ipv6RouteItem(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    prefix: Union[Variable, Global[IPv6Interface]] = Field(..., description="Prefix")
+    one_of_ip_route: Union[OneOfIpRouteNextHopContainer, OneOfIpRouteNull0, OneOfIpRouteNat] = Field(
+        ..., serialization_alias="oneOfIpRoute", validation_alias="oneOfIpRoute"
+    )
+
+
+class ServiceItem(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    service_type: Global[ServiceType] = Field(
+        ..., serialization_alias="serviceType", validation_alias="serviceType", description="Service Type"
+    )
+
+
+class Address64V4PoolItem(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    name: Union[Variable, Global[str]] = Field(
+        ..., serialization_alias="nat64V4PoolName", validation_alias="nat64V4PoolName", description="NAT64 v4 Pool Name"
+    )
+    range_start: Union[Variable, Global[IPv4Address]] = Field(
+        ...,
+        serialization_alias="nat64V4PoolRangeStart",
+        validation_alias="nat64V4PoolRangeStart",
+        description="NAT64 Pool Range Start",
+    )
+    range_end: Union[Variable, Global[IPv4Address]] = Field(
+        ...,
+        serialization_alias="nat64V4PoolRangeEnd",
+        validation_alias="nat64V4PoolRangeEnd",
+        description="NAT64 Pool Range End",
+    )
+    overload: Union[Variable, Global[bool], Default[bool]] = Field(
+        default=as_default(False),
+        serialization_alias="nat64V4PoolOverload",
+        validation_alias="nat64V4PoolOverload",
+        description="NAT64 Overload",
+    )
+
+
+class ManagementVpnParcel(_ParcelBase):
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+    type_: Literal["management/vpn"] = Field(default="management/vpn", exclude=True)
+    vpn_id: Default[int] = Field(
+        default=as_default(512),
+        validation_alias=AliasPath("data", "vpnId"),
+        frozen=True,
+        description="Management VPN, which will always be 512",
+    )
+    dns_ipv4: Optional[DNSIPv4] = Field(default=None, validation_alias=AliasPath("data", "dnsIpv4"))
+    dns_ipv6: Optional[DNSIPv6] = Field(default=None, validation_alias=AliasPath("data", "dnsIpv6"))
+    new_host_mapping: Optional[List[HostMapping]] = Field(
+        default=None, validation_alias=AliasPath("data", "newHostMapping")
+    )
+    ipv4_route: List[Ipv4RouteItem] = Field(
+        default_factory=list, validation_alias=AliasPath("data", "ipv4Route"), description="IPv4 Static Route"
+    )
+    ipv6_route: List[Ipv6RouteItem] = Field(
+        default_factory=list, validation_alias=AliasPath("data", "ipv6Route"), description="IPv6 Static Route"
+    )
+
+
+class TransportVpnParcel(_ParcelBase):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    type_: Literal["wan/vpn"] = Field(default="wan/vpn", exclude=True)
+    vpn_id: Default[int] = Field(
+        default=as_default(0),
+        validation_alias=AliasPath("data", "vpnId"),
+        frozen=True,
+        description="Transport VPN, which will always be 0",
+    )
+    dns_ipv4: Optional[DNSIPv4] = Field(default=None, validation_alias=AliasPath("data", "dnsIpv4"))
+    dns_ipv6: Optional[DNSIPv6] = Field(default=None, validation_alias=AliasPath("data", "dnsIpv6"))
+    new_host_mapping: Optional[List[HostMapping]] = Field(
+        default=None, validation_alias=AliasPath("data", "newHostMapping")
+    )
+    ipv4_route: List[Ipv4RouteItem] = Field(
+        default_factory=list, validation_alias=AliasPath("data", "ipv4Route"), description="IPv4 Static Route"
+    )
+    ipv6_route: List[Ipv6RouteItem] = Field(
+        default_factory=list, validation_alias=AliasPath("data", "ipv6Route"), description="IPv6 Static Route"
+    )
+    enhance_ecmp_keying: Union[Variable, Global[bool], Default[bool]] = Field(
+        default=as_default(False),
+        validation_alias=AliasPath("data", "enhanceEcmpKeying"),
+        description="Enhance ECMP Keying",
+    )
+    service: Optional[List[ServiceItem]] = Field(
+        default=None, validation_alias=AliasPath("data", "service"), description="Service"
+    )
+    nat64_v4_pool: Optional[List[Address64V4PoolItem]] = Field(
+        default=None, validation_alias=AliasPath("data", "nat64V4Pool"), description="NAT64 V4 Pool"
+    )
+
+    def set_dns_ipv4(
+        self,
+        primary_ipv4: Union[Variable, Global[IPv4Address]],
+        secondary_ipv4: Union[Variable, Global[IPv4Address], Default[None]] = as_default(None),
+    ) -> None:
+        """
+        Set the DNS server IP addresses for IPv4.
+
+        Sets the primary and, optionally, the secondary DNS server IP addresses for the system.
+        The addresses can be specified as either string representations or as IPv4Address objects.
+
+        Args:
+            primary (Union[Variable, Global[IPv4Address]]): The IP address of the primary DNS server.
+            secondary (Union[Variable, Global[IPv4Address], Default[None]]): The IP address of the
+                secondary DNS server.
+                Defaults to None, which means no secondary DNS server is set.
+        """
+        self.dns_ipv4 = DNSIPv4(primary_dns_address_ipv4=primary_ipv4, secondary_dns_address_ipv4=secondary_ipv4)
+
+    def add_ipv4_route(
+        self,
+        prefix_ip_address: Global[IPv4Address],
+        prefix_mask_address: Global[SubnetMask],
+        next_hops: List[RouteHop],
+        gateway: Optional[Global[Gateway]] = None,
+        distance: Optional[UnitDistance] = None,
+    ):
+        """
+        Add an IPv4 route to the instance's routing table.
+
+        Constructs an IPv4 route using the provided network prefix, subnet mask, and next hops.
+        Optionally, a default gateway and administrative distance can be set for the route.
+
+        Args:
+            prefix_ip_address (IPv4Address): The IP address of the network prefix.
+            prefix_mask_address (SubnetMask): The subnet mask associated with the network prefix.
+            next_hops (List[RouteHop]): A list of next hop addresses for the route.
+            gateway (Gateway, optional): The default gateway for the route. Defaults to "nextHop".
+            distance (Optional[int], optional): The administrative distance of the route. Defaults to None.
+
+        """
+        prefix = Prefix(ip_address=prefix_ip_address, subnet_mask=prefix_mask_address)
+        gateway_route = gateway if gateway is not None else as_default("nextHop", Gateway)
+        route = Ipv4RouteItem(prefix=prefix, gateway=gateway_route, distance=distance)
+        for next_hop in _create_next_hops(next_hops):
+            if route.next_hop is None:
+                route.next_hop = []
+            route.next_hop.append(next_hop)
+        self.ipv4_route.append(route)
+
+
+def _normalize_route_hops(hop: RouteHop) -> Tuple[UnitIPv4Address, Union[Default[int], UnitDistance]]:
+    if isinstance(hop, (list, tuple)):
+        return hop
+    else:
+        return hop, as_default(1)
+
+
+def _create_next_hops(hops: Optional[List[RouteHop]]) -> Iterator[NextHopItem]:
+    if hops:
+        for hop in hops:
+            address, distance = _normalize_route_hops(hop)
+            yield NextHopItem(address=address, distance=distance)

catalystwan/models/configuration/feature_profile/sdwan/transport/wan/interface/cellular.py

@@ -0,0 +1,173 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from __future__ import annotations
+
+from typing import List, Literal, Optional, Union
+
+from pydantic import AliasPath, BaseModel, ConfigDict, Field
+
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase, as_default
+from catalystwan.models.common import CarrierType, TLOCColor
+from catalystwan.models.configuration.feature_profile.common import (
+    AclQos,
+    AllowService,
+    Arp,
+    Encapsulation,
+    MultiRegionFabric,
+)
+
+CellularTLOCColor = Literal[
+    TLOCColor,
+    "metro ethernet",  # workaround for mistyped schema <20.14
+    "biz internet",  # workaround for mistyped schema <20.14
+    "public internet",  # workaround for mistyped schema <20.14
+]
+
+
+class Tunnel(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    bind: Optional[Union[Global[str], Default[None], Variable]] = Field(default=None)
+    border: Optional[Union[Default[bool], Global[bool], Variable]] = Field(default=None)
+    carrier: Optional[Union[Default[CarrierType], Global[CarrierType], Variable]] = Field(default=None)
+    clear_dont_fragment: Optional[Union[Default[bool], Global[bool], Variable]] = Field(
+        default=None, validation_alias="clearDontFragment", serialization_alias="clearDontFragment"
+    )
+    color: Optional[Union[Default[CellularTLOCColor], Global[CellularTLOCColor], Variable]] = Field(default=None)
+    exclude_controller_group_list: Optional[Union[Global[List[int]], Default[None], Variable]] = Field(
+        default=None, validation_alias="excludeControllerGroupList", serialization_alias="excludeControllerGroupList"
+    )
+    group: Optional[Union[Global[int], Default[None], Variable]] = Field(default=None)
+    hello_interval: Optional[Union[Global[int], Default[int], Variable]] = Field(
+        default=None, validation_alias="helloInterval", serialization_alias="helloInterval"
+    )
+    hello_tolerance: Optional[Union[Global[int], Default[int], Variable]] = Field(
+        default=None, validation_alias="helloTolerance", serialization_alias="helloTolerance"
+    )
+    last_resort_circuit: Optional[Union[Default[bool], Global[bool], Variable]] = Field(
+        default=None, validation_alias="lastResortCircuit", serialization_alias="lastResortCircuit"
+    )
+    low_bandwidth_link: Optional[Union[Default[bool], Global[bool], Variable]] = Field(
+        default=None, validation_alias="lowBandwidthLink", serialization_alias="lowBandwidthLink"
+    )
+    max_control_connections: Optional[Union[Global[int], Default[None], Variable]] = Field(
+        default=None, validation_alias="maxControlConnections", serialization_alias="maxControlConnections"
+    )
+    mode: Optional[Union[Global[Literal["spoke"]], Variable]] = Field(default=None)
+    nat_refresh_interval: Optional[Union[Global[int], Default[int], Variable]] = Field(
+        default=None, validation_alias="natRefreshInterval", serialization_alias="natRefreshInterval"
+    )
+    network_broadcast: Optional[Union[Default[bool], Global[bool], Variable]] = Field(
+        default=None, validation_alias="networkBroadcast", serialization_alias="networkBroadcast"
+    )
+    per_tunnel_qos: Optional[Union[Default[bool], Global[bool], Variable]] = Field(
+        default=None, validation_alias="perTunnelQos", serialization_alias="perTunnelQos"
+    )
+    port_hop: Optional[Union[Default[bool], Global[bool], Variable]] = Field(
+        default=None, validation_alias="portHop", serialization_alias="portHop"
+    )
+    restrict: Optional[Union[Default[bool], Global[bool], Variable]] = Field(default=None)
+    tunnel_tcp_mss: Optional[Union[Global[int], Default[None], Variable]] = Field(
+        default=None, validation_alias="tunnelTcpMss", serialization_alias="tunnelTcpMss"
+    )
+    vbond_as_stun_server: Optional[Union[Default[bool], Global[bool], Variable]] = Field(
+        default=None, validation_alias="vBondAsStunServer", serialization_alias="vBondAsStunServer"
+    )
+    vmanage_connection_preference: Optional[Union[Global[int], Default[int], Variable]] = Field(
+        default=None, validation_alias="vManageConnectionPreference", serialization_alias="vManageConnectionPreference"
+    )
+
+
+class NatAttributesIpv4(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    tcp_timeout: Union[Global[int], Default[int], Variable] = Field(
+        default=as_default(60), validation_alias="tcpTimeout", serialization_alias="tcpTimeout"
+    )
+    udp_timeout: Union[Global[int], Default[int], Variable] = Field(
+        default=as_default(1), validation_alias="udpTimeout", serialization_alias="udpTimeout"
+    )
+
+
+class Advanced(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    intrf_mtu: Optional[Union[Global[int], Default[int], Variable]] = Field(
+        default=None, validation_alias="intrfMtu", serialization_alias="intrfMtu"
+    )
+    ip_directed_broadcast: Optional[Union[Default[bool], Global[bool], Variable]] = Field(
+        default=None, validation_alias="ipDirectedBroadcast", serialization_alias="ipDirectedBroadcast"
+    )
+    ip_mtu: Optional[Union[Global[int], Default[int], Variable]] = Field(
+        default=None, validation_alias="ipMtu", serialization_alias="ipMtu"
+    )
+    tcp_mss: Optional[Union[Global[int], Default[None], Variable]] = Field(
+        default=None, validation_alias="tcpMss", serialization_alias="tcpMss"
+    )
+    tloc_extension: Optional[Union[Global[str], Default[None], Variable]] = Field(
+        default=None, validation_alias="tlocExtension", serialization_alias="tlocExtension"
+    )
+    tracker: Optional[Union[Global[str], Default[None], Variable]] = Field(default=None)
+
+
+class InterfaceCellularParcel(_ParcelBase):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    type_: Literal["wan/vpn/interface/cellular"] = Field(
+        default="wan/vpn/interface/cellular", frozen=True, exclude=True
+    )
+    encapsulation: List[Encapsulation] = Field(
+        validation_alias=AliasPath("data", "encapsulation"), description="Encapsulation for TLOC"
+    )
+    interface_description: Optional[Union[Global[str], Default[None], Variable]] = Field(
+        validation_alias=AliasPath("data", "description")
+    )
+    interface_name: Union[Global[str], Variable] = Field(validation_alias=AliasPath("data", "interfaceName"))
+    nat: Union[Default[bool], Global[bool], Variable] = Field(
+        default=as_default(False), validation_alias=AliasPath("data", "nat")
+    )
+    shutdown: Union[Default[bool], Global[bool], Variable] = Field(
+        default=as_default(True), validation_alias=AliasPath("data", "shutdown")
+    )
+    tunnel_interface: Union[Global[bool], Default[bool]] = Field(validation_alias=AliasPath("data", "tunnelInterface"))
+    acl_qos: Optional[AclQos] = Field(default=None, validation_alias=AliasPath("data", "aclQos"), description="ACL/QOS")
+    advanced: Optional[Advanced] = Field(
+        default=None, validation_alias=AliasPath("data", "advanced"), description="Advanced Attributes"
+    )
+    allow_service: Optional[AllowService] = Field(
+        default=None, validation_alias=AliasPath("data", "allowService"), description="Tunnel Interface Attributes"
+    )
+    arp: Optional[List[Arp]] = Field(
+        default=None, validation_alias=AliasPath("data", "arp"), description="Configure ARP entries"
+    )
+    bandwidth_downstream: Optional[Union[Global[int], Default[None], Variable]] = Field(
+        default=None, validation_alias=AliasPath("data", "bandwidthDownstream")
+    )
+    bandwidth_upstream: Optional[Union[Global[int], Default[None], Variable]] = Field(
+        default=None, validation_alias=AliasPath("data", "bandwidthUpstream")
+    )
+    dhcp_helper: Optional[Union[Global[List[str]], Default[None], Variable]] = Field(
+        default=None, validation_alias=AliasPath("data", "dhcpHelper")
+    )
+    enable_ipv6: Optional[Union[Default[bool], Global[bool], Variable]] = Field(
+        default=None, validation_alias=AliasPath("data", "enableIpv6")
+    )
+    multi_region_fabric: Optional[MultiRegionFabric] = Field(
+        default=None, validation_alias=AliasPath("data", "multiRegionFabric"), description="Multi-Region Fabric"
+    )
+    nat_attributes_ipv4: Optional[NatAttributesIpv4] = Field(
+        default=None, validation_alias=AliasPath("data", "natAttributesIpv4"), description="NAT Attributes"
+    )
+    service_provider: Optional[Union[Global[str], Default[None], Variable]] = Field(
+        default=None, validation_alias=AliasPath("data", "serviceProvider")
+    )
+    tunnel: Optional[Tunnel] = Field(
+        default=None, validation_alias=AliasPath("data", "tunnel"), description="Tunnel Interface Attributes"
+    )