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

catalystwan/tests/templates/models/cisco_omp.py

@@ -0,0 +1,37 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
+from catalystwan.api.templates.models.cisco_omp_model import CiscoOMPModel, IPv4Advertise, IPv6Advertise
+
+cisco_omp_complex = CiscoOMPModel(
+    template_name="cisco_omp_complex",
+    template_description="cisco_omp_complex",
+    graceful_restart=True,
+    overlay_as=65000,
+    send_path_limit=10,
+    ecmp_limit=8,
+    shutdown=False,
+    omp_admin_distance_ipv4=110,
+    omp_admin_distance_ipv6=115,
+    advertisement_interval=30,
+    graceful_restart_timer=120,
+    eor_timer=300,
+    holdtime=180,
+    advertise=[
+        IPv4Advertise(protocol="bgp", route="external"),
+        IPv4Advertise(protocol="ospf", route=None),
+        IPv4Advertise(protocol="connected", route=None),
+        IPv4Advertise(protocol="static", route=None),
+        IPv4Advertise(protocol="eigrp", route=None),
+        IPv4Advertise(protocol="lisp", route=None),
+    ],
+    ipv6_advertise=[
+        IPv6Advertise(protocol="bgp"),
+        IPv6Advertise(protocol="ospf"),
+        IPv6Advertise(protocol="connected"),
+        IPv6Advertise(protocol="static"),
+    ],
+    ignore_region_path_length=True,
+    transport_gateway="prefer",
+    site_types=["type-1", "type-2", "cloud", "branch", "spoke"],
+    auto_translate=True,
+)

catalystwan/tests/templates/models/cisco_ospf.py

@@ -0,0 +1,60 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from ipaddress import IPv4Interface
+
+from catalystwan.api.templates.models.cisco_ospf import (
+    Area,
+    CiscoOSPFModel,
+    Interface,
+    Range,
+    Redistribute,
+    RoutePolicy,
+    RouterLsa,
+)
+
+cisco_ospf_complex = CiscoOSPFModel(
+    template_name="cisco_ospf_complex",
+    template_description="cisco_ospf_complex",
+    device_models=["vedge-C8000V"],
+    router_id="1.1.1.1",
+    reference_bandwidth=10000,
+    rfc1583=False,
+    originate=True,
+    always=True,
+    metric=10,
+    metric_type="type1",
+    external=20,
+    inter_area=30,
+    intra_area=40,
+    delay=5,
+    initial_hold=10,
+    max_hold=40,
+    redistribute=[
+        Redistribute(protocol="static", route_policy="static_policy", dia=True),
+        Redistribute(protocol="bgp", route_policy="bgp_to_ospf_policy", dia=False),
+    ],
+    router_lsa=[RouterLsa(ad_type="administrative", time=10)],
+    route_policy=[RoutePolicy(direction="in", pol_name="ospf_in_policy")],
+    area=[
+        Area(
+            a_num=0,
+            stub=False,
+            nssa=True,
+            interface=[
+                Interface(
+                    name="GigabitEthernet0/0",
+                    hello_interval=10,
+                    dead_interval=40,
+                    retransmit_interval=5,
+                    cost=1,
+                    priority=1,
+                    network="broadcast",
+                    passive_interface=False,
+                    type="simple",
+                    message_digest_key=1,
+                    md5="md5keystring",
+                )
+            ],
+            range=[Range(address=IPv4Interface("192.168.1.0/24"), cost=100, no_advertise=True)],
+        )
+    ],
+)

catalystwan/tests/templates/models/cisco_secure_internet_gateway.py

@@ -0,0 +1,95 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from ipaddress import IPv4Address, IPv4Interface
+
+from catalystwan.api.templates.models.cisco_secure_internet_gateway import (
+    CiscoSecureInternetGatewayModel,
+    Interface,
+    InterfacePair,
+    Service,
+    Tracker,
+)
+
+cisco_sig = CiscoSecureInternetGatewayModel(
+    template_name="cisco_sig",
+    template_description="Comprehensive CiscoSecureInternetGateway Configuration",
+    vpn_id=10,
+    child_org_id="example_org",
+    interface=[
+        Interface(
+            if_name="ipsec255",
+            auto=True,
+            shutdown=False,
+            description="Main interface for SIG",
+            unnumbered=False,
+            address=IPv4Interface("192.168.1.1/24"),
+            tunnel_source=IPv4Address("192.168.1.1"),
+            tunnel_source_interface="Loopback0",
+            tunnel_route_via="192.168.2.1",
+            tunnel_destination="203.0.113.1",
+            application="sig",
+            tunnel_set="secure-internet-gateway-umbrella",
+            tunnel_dc_preference="primary-dc",
+            tcp_mss_adjust=1400,
+            mtu=1400,
+            dpd_interval=30,
+            dpd_retries=3,
+            ike_version=2,
+            pre_shared_secret="MyPreSharedSecret",  # pragma: allowlist secret
+            ike_rekey_interval=3600,
+            ike_ciphersuite="aes256-cbc-sha1",
+            ike_group="14",
+            pre_shared_key_dynamic=False,
+            ike_local_id="local-id",
+            ike_remote_id="remote-id",
+            ipsec_rekey_interval=3600,
+            ipsec_replay_window=32,
+            ipsec_ciphersuite="aes256-gcm",
+            perfect_forward_secrecy="group-14",
+            tracker=True,
+            track_enable=True,
+        )
+    ],
+    service=[
+        Service(
+            svc_type="sig",
+            interface_pair=[
+                InterfacePair(
+                    active_interface="GigabitEthernet0/0",
+                    active_interface_weight=10,
+                    backup_interface="GigabitEthernet0/1",
+                    backup_interface_weight=5,
+                )
+            ],
+            auth_required=True,
+            xff_forward_enabled=True,
+            ofw_enabled=False,
+            ips_control=True,
+            caution_enabled=False,
+            primary_data_center="Auto",
+            secondary_data_center="Auto",
+            ip=True,
+            idle_time=30,
+            display_time_unit="MINUTE",
+            ip_enforced_for_known_browsers=True,
+            refresh_time=5,
+            refresh_time_unit="MINUTE",
+            enabled=True,
+            block_internet_until_accepted=False,
+            force_ssl_inspection=True,
+            timeout=60,
+            data_center_primary="Auto",
+            data_center_secondary="Auto",
+        )
+    ],
+    tracker_src_ip=IPv4Interface("192.0.2.1/32"),
+    tracker=[
+        Tracker(
+            name="health-check-tracker",
+            endpoint_api_url="http://api.example.com/health",
+            threshold=100,
+            interval=60,
+            multiplier=2,
+            tracker_type="SIG",
+        )
+    ],
+)

catalystwan/tests/templates/models/cisco_snmp.py

@@ -0,0 +1,40 @@
+# Copyright 2023 Cisco Systems, Inc. and its affiliates
+
+from catalystwan.api.templates.models.cisco_snmp_model import CiscoSNMPModel, Community, Group, Oid, Target, User, View
+
+cisco_snmp_complex = CiscoSNMPModel(
+    template_name="cisco_snmp_complex",
+    template_description="Comprehensive Cisco SNMP Configuration",
+    shutdown=False,
+    contact="SNMP Admin",
+    location="Data Center A",
+    view=[
+        View(name="SystemView", oid=[Oid(id="1.3.6.1.2.1.1", exclude=False), Oid(id="1.3.6.1.2.1.2", exclude=True)]),
+        View(name="AllView", oid=[Oid(id="1.3.6.1", exclude=False)]),
+    ],
+    community=[
+        Community(name="public", view="SystemView", authorization="read-only"),
+        Community(name="private", view="AllView", authorization="read-only"),
+    ],
+    group=[Group(name="v3group", security_level="auth-priv", view="AllView")],
+    user=[
+        User(
+            name="snmpuser",
+            auth="md5",
+            auth_password="authpass",  # pragma: allowlist secret
+            priv="aes-cfb-128",
+            priv_password="privpass",  # pragma: allowlist secret
+            group="v3group",
+        )
+    ],
+    target=[
+        Target(
+            vpn_id=10,
+            ip="192.0.2.50",
+            port=162,
+            community_name="public",
+            user="snmpuser",
+            source_interface="GigabitEthernet0/0",
+        )
+    ],
+)

catalystwan/tests/templates/models/cisco_system.py

@@ -1,8 +1,113 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
-from catalystwan.api.templates.models.cisco_system import CiscoSystemModel
-from catalystwan.utils.device_model import DeviceModel
+from catalystwan.api.templates.models.cisco_system import (
+    AffinityPerVrf,
+    CiscoSystemModel,
+    DeviceVariable,
+    MobileNumber,
+    Object,
+    ObjectTrack,
+    Tracker,
+    Vrf,
+)
 
 default_cisco_system = CiscoSystemModel(
-    name="default_cisco_system", description="default", device_models=[DeviceModel.VEDGE_C8000V]
+    template_name="default_cisco_system", template_description="default", device_models=["vedge-C8000V"]
 )  # type: ignore
+
+cisco_system_complex = CiscoSystemModel(
+    template_name="cisco_system_complex",
+    template_description="cisco_system_complex",
+    timezone="UTC",
+    description="Example desc",
+    hostname=DeviceVariable(name="sdwan-hostname"),
+    location="Data Center A",
+    latitude=37.7749,
+    longitude=-122.4194,
+    range=10,
+    enable_fencing=True,
+    mobile_number=[MobileNumber(number="+12345678901"), MobileNumber(number="+10987654321")],
+    enable_sms=True,
+    device_groups=["group1", "group2"],
+    controller_group_list=[1, 3],
+    system_ip=DeviceVariable(name="192.0.2.1"),
+    overlay_id=1,
+    site_id=1001,
+    site_type=["branch", "spoke"],
+    port_offset=1000,
+    port_hop=True,
+    control_session_pps=500,
+    track_transport=True,
+    track_interface_tag=1,
+    console_baud_rate="9600",
+    max_omp_sessions=50,
+    multi_tenant=False,
+    track_default_gateway=False,
+    admin_tech_on_failure=True,
+    enable_tunnel=True,
+    idle_timeout=300,
+    on_demand_idle_timeout_min=60,
+    tracker=[
+        Tracker(
+            name="tracker1",
+            endpoint_ip="203.0.113.1",
+            endpoint_ip_transport_port="8080",
+            protocol="tcp",
+            port=443,
+            endpoint_dns_name=None,
+            endpoint_api_url=None,
+            elements=["element1, element2"],
+            boolean="and",
+            threshold=10,
+            interval=30,
+            multiplier=3,
+            type="static-route",
+        )
+    ],
+    object_track=[
+        ObjectTrack(
+            object_number=10,
+            interface="GigabitEthernet0/0/0",
+            sig="100",
+            ip="192.0.2.1",
+            mask="255.255.255.0",
+            vpn=1,
+            object=[Object(number=101)],
+            boolean="and",
+        ),
+        ObjectTrack(
+            object_number=20,
+            interface="GigabitEthernet0/0/0",
+            sig="100",
+            ip="192.0.2.1",
+            mask="255.255.255.0",
+            vpn=1,
+            object=[Object(number=101)],
+            boolean="and",
+        ),
+        ObjectTrack(
+            object_number=30,
+            interface="GigabitEthernet0/0/1",
+            sig="200",
+            ip="198.51.100.1",
+            mask="255.255.255.0",
+            vpn=2,
+            object=[Object(number=201)],
+            boolean="or",
+        ),
+    ],
+    region_id=None,
+    secondary_region=None,
+    role="edge-router",
+    affinity_group_number=1,
+    preference=[1],
+    preference_auto=True,
+    affinity_per_vrf=[AffinityPerVrf(affinity_group_number=1, vrf_range="22")],
+    transport_gateway=True,
+    enable_mrf_migration="enabled",
+    migration_bgp_community=65535,
+    enable_management_region=True,
+    vrf=[Vrf(vrf_id=1, gateway_preference=[4, 5]), Vrf(vrf_id=2, gateway_preference=[12, 13])],
+    management_gateway=None,
+    epfr="conservative",
+)

catalystwan/tests/templates/models/cisco_vpn.py

@@ -4,88 +4,65 @@
 
 from catalystwan.api.templates.models.cisco_vpn_model import (
     Advertise,
-    AdvertiseProtocol,
-    AdvertiseProtocolSubType,
     CiscoVPNModel,
-    Direction,
     Dns,
     DnsIpv6,
     GreRoute,
     Host,
     IpsecRoute,
     Ipv6Advertise,
-    Ipv6AdvertiseProtocol,
-    Ipv6AdvertiseProtocolSubType,
-    LeakFromGlobalProtocol,
-    Nat,
     Natpool,
     NextHop,
     NextHopv6,
-    Overload,
     Pool,
     PortForward,
     PrefixList,
-    Proto,
-    Region,
-    Role,
     RouteExport,
-    RouteExportProtocol,
-    RouteExportProtocolSubType,
     RouteExportRedistribute,
-    RouteExportRedistributeProtocol,
     RouteImport,
     RouteImportFrom,
-    RouteImportFromProtocol,
-    RouteImportFromProtocolSubType,
     RouteImportFromRedistribute,
-    RouteImportFromRedistributeProtocol,
-    RouteImportProtocol,
-    RouteImportProtocolSubType,
     RouteImportRedistribute,
-    RouteImportRedistributeProtocol,
     Routev4,
     Routev6,
     Service,
     ServiceRoute,
     Static,
-    StaticNatDirection,
     SubnetStatic,
-    SvcType,
 )
-from catalystwan.utils.device_model import DeviceModel
 
-basic_cisco_vpn = CiscoVPNModel(
-    template_name="Basic_Cisco_VPN_Model", template_description="Primitive", device_models=[DeviceModel.VEDGE_C8000V]
+cisco_vpn_basic = CiscoVPNModel(
+    template_name="cisco_vpn_basic", template_description="Primitive", device_models=["vedge-C8000V"]
 )  # type: ignore
 
 
-complex_vpn_model = CiscoVPNModel(
-    template_name="complex_cisco_vpn",
-    template_description="NA",
-    device_models=[DeviceModel.VEDGE],
+cisco_vpn_complex = CiscoVPNModel(
+    template_name="cisco_vpn_complex",
+    template_description="cisco_vpn_complex",
+    device_models=["vedge-cloud"],
     vpn_name="test_vpn_name",
     omp_admin_distance_ipv4=10,
     omp_admin_distance_ipv6=100,
     route_v4=[Routev4(prefix="prefixv4", next_hop=[NextHop(address="1.1.1.1")])],
-    route_v6=[Routev6(prefix="prefixv6", next_hop=[NextHopv6(address="2.2.2.2")], nat=Nat.NAT64)],
-    dns=[Dns(dns_addr="1.1.1.1"), Dns(dns_addr="2.2.2.2", role=Role.SECONDARY)],
+    route_v6=[Routev6(prefix="prefixv6", next_hop=[NextHopv6(address="2.2.2.2")], nat="NAT64")],
+    dns=[Dns(dns_addr="1.1.1.1"), Dns(dns_addr="2.2.2.2", role="secondary")],
     dns_ipv6=[DnsIpv6(dns_addr="30a8:b25e:3db5:fe9f:231f:7478:4181:9234")],
     host=[Host(hostname="test_hostname", ip=["1.1.1.1"])],
     service=[
         Service(
-            svc_type=SvcType.APPQOE,
+            svc_type="appqoe",
             address=["1.1.1.1"],
             interface="Gig0/0/1",
             track_enable=False,
         ),
         Service(
-            svc_type=SvcType.FW,
+            svc_type="FW",
             address=["1.1.122.1", "2.2.2.2"],
             interface="Gig0/0/2",
             track_enable=True,
         ),
         Service(
-            svc_type=SvcType.IDP,
+            svc_type="IDP",
             address=["1.1.122.2", "3.2.2.2"],
             interface="Gig0/0/3",
             track_enable=False,
@@ -105,40 +82,40 @@ complex_vpn_model = CiscoVPNModel(
     ],
     advertise=[
         Advertise(
-            protocol=AdvertiseProtocol.AGGREGATE,
+            protocol="aggregate",
             route_policy="route-policy",
-            protocol_sub_type=[AdvertiseProtocolSubType.EXTERNAL],
+            protocol_sub_type=["external"],
             prefix_list=[
                 PrefixList(
                     prefix_entry="prefix_entry",
                     aggregate_only=True,
-                    region=Region.ACCESS,
+                    region="access",
                 )
             ],
         )
     ],
     ipv6_advertise=[
         Ipv6Advertise(
-            protocol=Ipv6AdvertiseProtocol.AGGREGATE,
+            protocol="aggregate",
             route_policy="route-policyv6",
-            protocol_sub_type=[Ipv6AdvertiseProtocolSubType.EXTERNAL],
+            protocol_sub_type=["external"],
             prefix_list=[
                 PrefixList(
                     prefix_entry="prefix_entryv6",
                     aggregate_only=False,
-                    region=Region.CORE,
+                    region="core",
                 )
             ],
         ),
         Ipv6Advertise(
-            protocol=Ipv6AdvertiseProtocol.CONNECTED,
+            protocol="connected",
             route_policy="route-policyv6-connected",
-            protocol_sub_type=[Ipv6AdvertiseProtocolSubType.EXTERNAL],
+            protocol_sub_type=["external"],
             prefix_list=[
                 PrefixList(
                     prefix_entry="prefix_entryv6-connected",
                     aggregate_only=True,
-                    region=Region.ACCESS,
+                    region="access",
                 )
             ],
         ),
@@ -150,7 +127,7 @@ complex_vpn_model = CiscoVPNModel(
             end_address="10.10.10.10",
             overload=False,
             leak_from_global=True,
-            leak_from_global_protocol=LeakFromGlobalProtocol.CONNECTED,
+            leak_from_global_protocol="connected",
             leak_to_global=False,
         )
     ],
@@ -160,32 +137,25 @@ complex_vpn_model = CiscoVPNModel(
             prefix_length=24,
             range_start="10",
             range_end="100",
-            overload=Overload.FALSE,
-            direction=Direction.INSIDE,
+            overload="false",
+            direction="inside",
             tracker_id=10,
         ),
-        Natpool(
-            name=2,
-            prefix_length=24,
-            range_start="10",
-            range_end="100",
-            overload=Overload.TRUE,
-            direction=Direction.OUTSIDE,
-        ),
+        Natpool(name=2, prefix_length=24, range_start="10", range_end="100", overload="true", direction="outside"),
     ],
     static=[
         Static(
             pool_name=1,
             source_ip="1.1.1.1",
             translate_ip="1.1.1.2",
-            static_nat_direction=StaticNatDirection.INSIDE,
+            static_nat_direction="inside",
             tracker_id=1,
         ),
         Static(
             pool_name=2,
             source_ip="2.1.1.1",
             translate_ip="2.1.1.2",
-            static_nat_direction=StaticNatDirection.OUTSIDE,
+            static_nat_direction="inside",
         ),
     ],
     subnet_static=[
@@ -193,13 +163,13 @@ complex_vpn_model = CiscoVPNModel(
             source_ip_subnet="1.1.1.1",
             translate_ip_subnet="2.2.2.2",
             prefix_length=24,
-            static_nat_direction=StaticNatDirection.OUTSIDE,
+            static_nat_direction="outside",
         ),
         SubnetStatic(
             source_ip_subnet="1.1.2.1",
             translate_ip_subnet="2.3.2.2",
             prefix_length=24,
-            static_nat_direction=StaticNatDirection.INSIDE,
+            static_nat_direction="inside",
             tracker_id=10,
         ),
     ],
@@ -210,7 +180,7 @@ complex_vpn_model = CiscoVPNModel(
             translate_port=2000,
             source_ip="1.1.1.1",
             translate_ip="2.2.2.2",
-            proto=Proto.TCP,
+            proto="tcp",
         ),
         PortForward(
             pool_name=2,
@@ -218,17 +188,17 @@ complex_vpn_model = CiscoVPNModel(
             translate_port=2000,
             source_ip="1.1.4.1",
             translate_ip="2.2.3.2",
-            proto=Proto.UDP,
+            proto="udp",
         ),
     ],
     route_import=[
         RouteImport(
-            protocol=RouteImportProtocol.BGP,
-            protocol_sub_type=[RouteImportProtocolSubType.EXTERNAL],
+            protocol="bgp",
+            protocol_sub_type=["external"],
             route_policy="test_route_policy",
             redistribute=[
                 RouteImportRedistribute(
-                    protocol=RouteImportRedistributeProtocol.EIGRP,
+                    protocol="eigrp",
                     route_policy="test_route_policy",
                 )
             ],
@@ -237,19 +207,19 @@ complex_vpn_model = CiscoVPNModel(
     route_import_from=[
         RouteImportFrom(
             source_vpn=1,
-            protocol=RouteImportFromProtocol.CONNECTED,
-            protocol_sub_type=[RouteImportFromProtocolSubType.EXTERNAL],
+            protocol="connected",
+            protocol_sub_type=["external"],
             route_policy="test_route_policy",
-            redistribute=[RouteImportFromRedistribute(protocol=RouteImportFromRedistributeProtocol.BGP)],
+            redistribute=[RouteImportFromRedistribute(protocol="bgp")],
         ),
         RouteImportFrom(
             source_vpn=100,
-            protocol=RouteImportFromProtocol.BGP,
-            protocol_sub_type=[RouteImportFromProtocolSubType.EXTERNAL],
+            protocol="bgp",
+            protocol_sub_type=["external"],
             route_policy="test_route_policy",
             redistribute=[
                 RouteImportFromRedistribute(
-                    protocol=RouteImportFromRedistributeProtocol.EIGRP,
+                    protocol="eigrp",
                     route_policy="test_route_policy",
                 )
             ],
@@ -257,11 +227,11 @@ complex_vpn_model = CiscoVPNModel(
     ],
     route_export=[
         RouteExport(
-            protocol=RouteExportProtocol.STATIC,
-            protocol_sub_type=[RouteExportProtocolSubType.EXTERNAL],
+            protocol="static",
+            protocol_sub_type=["external"],
             redistribute=[
                 RouteExportRedistribute(
-                    protocol=RouteExportRedistributeProtocol.OSPF,
+                    protocol="ospf",
                     route_policy="test_route_policy",
                 )
             ],