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

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

@@ -0,0 +1,389 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from ipaddress import IPv4Address, IPv6Interface
+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
+from catalystwan.models.common import (
+    CarrierType,
+    EncapType,
+    EthernetDuplexMode,
+    MediaType,
+    Speed,
+    TLOCColor,
+    TunnelMode,
+)
+from catalystwan.models.configuration.feature_profile.common import (
+    AclQos,
+    AllowService,
+    Arp,
+    Encapsulation,
+    EthernetNatAttributesIpv4,
+    InterfaceDynamicIPv4Address,
+    InterfaceDynamicIPv6Address,
+    InterfaceStaticIPv4Address,
+    MultiRegionFabric,
+    RefIdItem,
+    StaticIPv6Address,
+)
+
+LoadBalance = Literal[
+    "flow",
+    "vlan",
+]
+
+LacpMode = Literal[
+    "active",
+    "passive",
+]
+
+
+LacpRate = Literal[
+    "fast",
+    "normal",
+]
+
+
+class PortChannelMemberLinksLacp(BaseModel):
+    lacp_mode: Union[Global[LacpMode], Default[Literal["active"]], Variable] = Field(
+        validation_alias="lacpMode", serialization_alias="lacpMode"
+    )
+    interface: Optional[RefIdItem] = Field(default=None)
+    lacp_port_priority: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None, validation_alias="lacpPortPriority", serialization_alias="lacpPortPriority"
+    )
+    lacp_rate: Optional[Union[Variable, Global[LacpRate], Default[None]]] = Field(
+        default=None, validation_alias="lacpRate", serialization_alias="lacpRate"
+    )
+
+
+class LacpModeMainInterface(BaseModel):
+    port_channel_member_links: List[PortChannelMemberLinksLacp] = Field(
+        validation_alias="portChannelMemberLinks",
+        serialization_alias="portChannelMemberLinks",
+        description="Configure Port-Channel member links",
+    )
+    lacp_fast_switchover: Optional[Union[Global[bool], Default[bool], Variable]] = Field(
+        default=None, validation_alias="lacpFastSwitchover", serialization_alias="lacpFastSwitchover"
+    )
+    lacp_max_bundle: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None, validation_alias="lacpMaxBundle", serialization_alias="lacpMaxBundle"
+    )
+    lacp_min_bundle: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None, validation_alias="lacpMinBundle", serialization_alias="lacpMinBundle"
+    )
+    load_balance: Optional[Union[Variable, Global[LoadBalance], Default[None]]] = Field(
+        default=None, validation_alias="loadBalance", serialization_alias="loadBalance"
+    )
+    port_channel_qos_aggregate: Optional[Union[Global[bool], Default[bool], Variable]] = Field(
+        default=None, validation_alias="portChannelQosAggregate", serialization_alias="portChannelQosAggregate"
+    )
+
+
+class MainInterfaceLacp(BaseModel):
+    lacp_mode_main_interface: LacpModeMainInterface = Field(
+        validation_alias="lacpModeMainInterface", serialization_alias="lacpModeMainInterface"
+    )
+
+
+class PortChannelMemberLinks(BaseModel):
+    interface: Optional[RefIdItem] = Field(default=None)
+
+
+class StaticModeMainInterface(BaseModel):
+    port_channel_member_links: List[PortChannelMemberLinks] = Field(
+        validation_alias="portChannelMemberLinks",
+        serialization_alias="portChannelMemberLinks",
+        description="Configure Port-Channel member links",
+    )
+    load_balance: Optional[Union[Variable, Global[LoadBalance], Default[None]]] = Field(
+        default=None, validation_alias="loadBalance", serialization_alias="loadBalance"
+    )
+    port_channel_qos_aggregate: Optional[Union[Global[bool], Default[bool], Variable]] = Field(
+        default=None, validation_alias="portChannelQosAggregate", serialization_alias="portChannelQosAggregate"
+    )
+
+
+class MainInterfaceStatic(BaseModel):
+    static_mode_main_interface: StaticModeMainInterface = Field(
+        validation_alias="staticModeMainInterface", serialization_alias="staticModeMainInterface"
+    )
+
+
+MainInterface = Union[MainInterfaceLacp, MainInterfaceStatic]
+
+
+class PortChannelMain(BaseModel):
+    main_interface: MainInterface = Field(validation_alias="mainInterface", serialization_alias="mainInterface")
+
+
+class SubInterface(BaseModel):
+    wan: Optional[Default[bool]] = Field(default=None)
+
+
+class PortChannelSub(BaseModel):
+    sub_interface: SubInterface = Field(validation_alias="subInterface", serialization_alias="subInterface")
+
+
+PortChannel = Union[PortChannelMain, PortChannelSub]
+
+
+class Static(BaseModel):
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+    primary_ip_v6_address: Optional[StaticIPv6Address] = Field(
+        default=None,
+        validation_alias="primaryIpV6Address",
+        serialization_alias="primaryIpV6Address",
+        description="Static IpV6Address Primary",
+    )
+    secondary_ip_v6_address: Optional[List[StaticIPv6Address]] = Field(
+        default=None,
+        validation_alias="secondaryIpV6Address",
+        serialization_alias="secondaryIpV6Address",
+        description="Static secondary IPv6 addresses",
+    )
+
+
+class InterfaceStaticIPv6Address(BaseModel):
+    static: Static = Field()
+
+
+class Tunnel(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    bandwidth_percent: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None, validation_alias="bandwidthPercent", serialization_alias="bandwidthPercent"
+    )
+    bind: Optional[Union[Variable, Global[str], Default[None]]] = Field(default=None)
+    border: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(default=None)
+    carrier: Optional[Union[Variable, Default[Literal["default"]], Global[CarrierType]]] = Field(default=None)
+    clear_dont_fragment: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="clearDontFragment", serialization_alias="clearDontFragment"
+    )
+    color: Optional[Union[Global[TLOCColor], Default[Literal["mpls"]], Variable]] = Field(default=None)
+    cts_sgt_propagation: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="ctsSgtPropagation", serialization_alias="ctsSgtPropagation"
+    )
+    exclude_controller_group_list: Optional[Union[Variable, Default[None], Global[List[int]]]] = Field(
+        default=None, validation_alias="excludeControllerGroupList", serialization_alias="excludeControllerGroupList"
+    )
+    group: Optional[Union[Variable, Global[int], Default[None]]] = Field(default=None)
+    hello_interval: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None, validation_alias="helloInterval", serialization_alias="helloInterval"
+    )
+    hello_tolerance: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None, validation_alias="helloTolerance", serialization_alias="helloTolerance"
+    )
+    last_resort_circuit: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="lastResortCircuit", serialization_alias="lastResortCircuit"
+    )
+    low_bandwidth_link: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="lowBandwidthLink", serialization_alias="lowBandwidthLink"
+    )
+    max_control_connections: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None, validation_alias="maxControlConnections", serialization_alias="maxControlConnections"
+    )
+    mode: Optional[Union[Variable, Global[TunnelMode]]] = Field(default=None)
+    nat_refresh_interval: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None, validation_alias="natRefreshInterval", serialization_alias="natRefreshInterval"
+    )
+    network_broadcast: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="networkBroadcast", serialization_alias="networkBroadcast"
+    )
+    per_tunnel_qos: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="perTunnelQos", serialization_alias="perTunnelQos"
+    )
+    port_hop: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="portHop", serialization_alias="portHop"
+    )
+    restrict: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(default=None)
+    tloc_extension_gre_to: Optional[Union[Variable, Global[str], Global[IPv4Address], Default[None]]] = Field(
+        default=None, validation_alias="tlocExtensionGreTo", serialization_alias="tlocExtensionGreTo"
+    )
+    tunnel_tcp_mss: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None, validation_alias="tunnelTcpMss", serialization_alias="tunnelTcpMss"
+    )
+    v_bond_as_stun_server: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="vBondAsStunServer", serialization_alias="vBondAsStunServer"
+    )
+    v_manage_connection_preference: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None, validation_alias="vManageConnectionPreference", serialization_alias="vManageConnectionPreference"
+    )
+
+
+NatType = Literal[
+    "interface",
+    "loopback",
+    "pool",
+]
+
+
+StaticNatDirection = Literal[
+    "inside",
+    "outside",
+]
+
+
+class StaticNat66(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    source_prefix: Union[Variable, Global[str], Global[IPv6Interface]] = Field(
+        validation_alias="sourcePrefix", serialization_alias="sourcePrefix"
+    )
+    source_vpn_id: Union[Variable, Global[int], Default[None]] = Field(
+        validation_alias="sourceVpnId", serialization_alias="sourceVpnId"
+    )
+    egress_interface: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="egressInterface", serialization_alias="egressInterface"
+    )
+    translated_source_prefix: Optional[Union[Variable, Global[str], Default[None], Global[IPv6Interface]]] = Field(
+        default=None, validation_alias="translatedSourcePrefix", serialization_alias="translatedSourcePrefix"
+    )
+
+
+class NatAttributesIpv6(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    nat64: Optional[Union[Global[bool], Default[bool]]] = Field(default=None)
+    nat66: Optional[Union[Global[bool], Default[bool]]] = Field(default=None)
+    static_nat66: Optional[List[StaticNat66]] = Field(
+        default=None, validation_alias="staticNat66", serialization_alias="staticNat66", description="static NAT66"
+    )
+
+
+class TlocExtensionGreFrom(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    source_ip: Optional[Union[Variable, Global[str], Global[IPv4Address], Default[None]]] = Field(
+        default=None, validation_alias="sourceIp", serialization_alias="sourceIp"
+    )
+    xconnect: Optional[Union[Variable, Global[str], Global[IPv4Address], Default[None]]] = Field(default=None)
+
+
+class Advanced(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    arp_timeout: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None, validation_alias="arpTimeout", serialization_alias="arpTimeout"
+    )
+    autonegotiate: Optional[Union[Variable, Global[bool], Default[None]]] = Field(default=None)
+    duplex: Optional[Union[Variable, Default[None], Global[EthernetDuplexMode]]] = Field(default=None)
+    icmp_redirect_disable: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="icmpRedirectDisable", serialization_alias="icmpRedirectDisable"
+    )
+    intrf_mtu: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None, validation_alias="intrfMtu", serialization_alias="intrfMtu"
+    )
+    ip_directed_broadcast: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="ipDirectedBroadcast", serialization_alias="ipDirectedBroadcast"
+    )
+    ip_mtu: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None, validation_alias="ipMtu", serialization_alias="ipMtu"
+    )
+    load_interval: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None, validation_alias="loadInterval", serialization_alias="loadInterval"
+    )
+    mac_address: Optional[Union[Variable, Global[str], Default[None]]] = Field(
+        default=None, validation_alias="macAddress", serialization_alias="macAddress"
+    )
+    media_type: Optional[Union[Variable, Global[MediaType], Default[None]]] = Field(
+        default=None, validation_alias="mediaType", serialization_alias="mediaType"
+    )
+    speed: Optional[Union[Variable, Global[Speed], Default[None]]] = Field(default=None)
+    tcp_mss: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None, validation_alias="tcpMss", serialization_alias="tcpMss"
+    )
+    tloc_extension: Optional[Union[Variable, Global[str], Default[None]]] = Field(
+        default=None, validation_alias="tlocExtension", serialization_alias="tlocExtension"
+    )
+    tloc_extension_gre_from: Optional[TlocExtensionGreFrom] = Field(
+        default=None,
+        validation_alias="tlocExtensionGreFrom",
+        serialization_alias="tlocExtensionGreFrom",
+        description="Extend remote TLOC over a GRE tunnel to a local WAN interface",
+    )
+    tracker: Optional[Union[Variable, Global[str], Default[None]]] = Field(default=None)
+
+
+class InterfaceEthernetParcel(_ParcelBase):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True, extra="forbid")
+    type_: Literal["wan/vpn/interface/ethernet"] = Field(default="wan/vpn/interface/ethernet", exclude=True)
+    encapsulation: List[Encapsulation] = Field(
+        default_factory=list, validation_alias=AliasPath("data", "encapsulation"), description="Encapsulation for TLOC"
+    )
+    interface_name: Union[Variable, Global[str]] = Field(validation_alias=AliasPath("data", "interfaceName"))
+    interface_ip_address: Union[InterfaceDynamicIPv4Address, InterfaceStaticIPv4Address] = Field(
+        validation_alias=AliasPath("data", "intfIpAddress"), default_factory=InterfaceStaticIPv4Address
+    )
+    interface_description: Optional[Union[Variable, Global[str], Default[None]]] = Field(
+        default=None, validation_alias=AliasPath("data", "description")
+    )
+    nat: Union[Variable, Global[bool], Default[bool]] = Field(
+        default=Global[bool](value=False), validation_alias=AliasPath("data", "nat")
+    )
+    shutdown: Union[Variable, Global[bool], Default[bool]] = Field(
+        default=Global[bool](value=True), validation_alias=AliasPath("data", "shutdown")
+    )
+    tunnel_interface: Union[Global[bool], Default[bool]] = Field(
+        default=Global[bool](value=False), 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"
+    )
+    auto_detect_bandwidth: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias=AliasPath("data", "autoDetectBandwidth")
+    )
+    bandwidth_downstream: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None, validation_alias=AliasPath("data", "bandwidthDownstream")
+    )
+    bandwidth_upstream: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None, validation_alias=AliasPath("data", "bandwidthUpstream")
+    )
+    block_non_source_ip: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias=AliasPath("data", "blockNonSourceIp")
+    )
+    dhcp_helper: Optional[Union[Variable, Default[None], Global[List[str]]]] = Field(
+        default=None, validation_alias=AliasPath("data", "dhcpHelper")
+    )
+    intf_ip_v6_address: Optional[Union[InterfaceDynamicIPv6Address, InterfaceStaticIPv6Address]] = Field(
+        default=None, validation_alias=AliasPath("data", "intfIpV6Address")
+    )
+    iperf_server: Optional[Union[Variable, Global[str], Default[None]]] = Field(
+        default=None, validation_alias=AliasPath("data", "iperfServer")
+    )
+    multi_region_fabric: Optional[MultiRegionFabric] = Field(
+        default=None, validation_alias=AliasPath("data", "multiRegionFabric"), description="Multi-Region Fabric"
+    )
+    nat_attributes_ipv4: Optional[EthernetNatAttributesIpv4] = Field(
+        default=None, validation_alias=AliasPath("data", "natAttributesIpv4"), description="NAT Attributes IpV4"
+    )
+    nat_attributes_ipv6: Optional[NatAttributesIpv6] = Field(
+        default=None, validation_alias=AliasPath("data", "natAttributesIpv6"), description="NAT Attributes Ipv6"
+    )
+    nat_ipv6: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias=AliasPath("data", "natIpv6")
+    )
+    service_provider: Optional[Union[Variable, Global[str], Default[None]]] = Field(
+        default=None, validation_alias=AliasPath("data", "serviceProvider")
+    )
+    tunnel: Optional[Tunnel] = Field(
+        default=None, validation_alias=AliasPath("data", "tunnel"), description="Tunnel Interface Attributes"
+    )
+    port_channel: Optional[PortChannel] = Field(default=None, validation_alias=AliasPath("data", "portChannel"))
+    port_channel_interface: Optional[Union[Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias=AliasPath("data", "portChannelInterface")
+    )
+    port_channel_member_interface: Optional[Union[Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias=AliasPath("data", "portChannelMemberInterface")
+    )
+
+    def add_encapsulation(
+        self,
+        encap: Optional[EncapType] = None,
+        preference: Union[None, int, str] = None,
+        weight: Union[None, int, str] = None,
+    ) -> None:
+        self.encapsulation.append(Encapsulation.from_params(encap, preference, weight))

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

@@ -0,0 +1,46 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from __future__ import annotations
+
+from ipaddress import IPv4Address
+from typing import Literal, Optional, Union
+
+from pydantic import AliasPath, BaseModel, ConfigDict, Field
+
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase
+from catalystwan.models.configuration.feature_profile.common import AddressWithMask, AdvancedGre, TunnelSourceType
+
+
+class Basic(BaseModel):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    address: AddressWithMask = Field()
+    if_name: Union[Variable, Global[str]] = Field(validation_alias="ifName", serialization_alias="ifName")
+    tunnel_destination: Union[Variable, Global[IPv4Address]] = Field(
+        validation_alias="tunnelDestination", serialization_alias="tunnelDestination"
+    )
+    clear_dont_fragment: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None, validation_alias="clearDontFragment", serialization_alias="clearDontFragment"
+    )
+    description: Optional[Union[Variable, Global[str], Default[None]]] = Field(default=None)
+    mtu: Optional[Union[Variable, Default[int], Global[int]]] = Field(default=None)
+    shutdown: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(default=None)
+    tcp_mss_adjust: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None, validation_alias="tcpMssAdjust", serialization_alias="tcpMssAdjust"
+    )
+    tunnel_source_type: Optional[TunnelSourceType] = Field(
+        default=None, validation_alias="tunnelSourceType", serialization_alias="tunnelSourceType"
+    )
+
+
+class InterfaceGreParcel(_ParcelBase):
+    model_config = ConfigDict(
+        extra="forbid",
+        populate_by_name=True,
+    )
+    type_: Literal["wan/vpn/interface/gre"] = Field(default="wan/vpn/interface/gre", frozen=True, exclude=True)
+    basic: Basic = Field(validation_alias=AliasPath("data", "basic"), description="basic configuration")
+    advanced: Optional[AdvancedGre] = Field(
+        default=None, validation_alias=AliasPath("data", "advanced"), description="advanced"
+    )

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

@@ -0,0 +1,137 @@
+# Copyright 2024 Cisco Systems, Inc. and its affiliates
+from __future__ import annotations
+
+from ipaddress import IPv4Address, IPv4Interface, IPv6Address, IPv6Interface
+from typing import Literal, Optional, Union
+
+from pydantic import AliasPath, ConfigDict, Field
+
+from catalystwan.api.configuration_groups.parcel import Default, Global, Variable, _ParcelBase
+from catalystwan.models.common import IkeCiphersuite, IkeGroup, IkeMode, IpsecCiphersuite, IpsecTunnelMode, PfsGroup
+from catalystwan.models.configuration.feature_profile.common import (
+    AddressAndMaskWithDefault,
+    AddressWithMask,
+    TunnelApplication,
+)
+
+
+class InterfaceIpsecParcel(_ParcelBase):
+    model_config = ConfigDict(populate_by_name=True, extra="forbid")
+    type_: Literal["wan/vpn/interface/ipsec"] = Field(default="wan/vpn/interface/ipsec", exclude=True, frozen=True)
+    address: Optional[AddressAndMaskWithDefault] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "address"),
+        description="""
+            This filed is required in version < 20.14 (default: 1500).
+            In version >=20.14 it is optional, as it can be replaced by ipv6_address.
+        """,
+    )
+    ipv6_address: Optional[Union[Global[str], Global[IPv6Interface], Variable]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "ipv6Address"),
+        description="This field is supported from version 20.14",
+    )
+    application: Union[Variable, Global[TunnelApplication]] = Field(validation_alias=AliasPath("data", "application"))
+    clear_dont_fragment: Union[Variable, Global[bool], Default[bool]] = Field(
+        default=Default[bool](value=False),
+        validation_alias=AliasPath("data", "clearDontFragment"),
+        description="Required if address is provided (default: False). None otherwise.",
+    )
+    if_description: Union[Variable, Global[str], Default[None]] = Field(
+        default=Default[None](value=None), validation_alias=AliasPath("data", "description")
+    )
+    dpd_interval: Union[Variable, Default[int], Global[int]] = Field(
+        default=Default[int](value=10), validation_alias=AliasPath("data", "dpdInterval")
+    )
+    dpd_retries: Union[Variable, Default[int], Global[int]] = Field(
+        default=Default[int](value=3), validation_alias=AliasPath("data", "dpdRetries")
+    )
+    if_name: Union[Variable, Global[str]] = Field(validation_alias=AliasPath("data", "ifName"))
+    ike_ciphersuite: Union[Variable, Global[IkeCiphersuite], Default[IkeCiphersuite]] = Field(
+        default=Default[IkeCiphersuite](value="aes256-cbc-sha1"), validation_alias=AliasPath("data", "ikeCiphersuite")
+    )
+    ike_group: Union[Global[IkeGroup], Default[IkeGroup], Variable] = Field(
+        default=Default[IkeGroup](value="16"), validation_alias=AliasPath("data", "ikeGroup")
+    )
+    ike_local_id: Union[Variable, Global[str], Default[None]] = Field(
+        validation_alias=AliasPath("data", "ikeLocalId"), default=Default[None](value=None)
+    )
+    ike_rekey_interval: Union[Variable, Default[int], Global[int]] = Field(
+        default=Default[int](value=14400), validation_alias=AliasPath("data", "ikeRekeyInterval")
+    )
+    ike_remote_id: Union[Variable, Global[str], Default[None], Global[IPv4Address]] = Field(
+        default=Default[None](value=None), validation_alias=AliasPath("data", "ikeRemoteId")
+    )
+    ike_version: Union[Global[int], Default[int]] = Field(
+        default=Default[int](value=1), validation_alias=AliasPath("data", "ikeVersion")
+    )
+    ipsec_ciphersuite: Union[Variable, Global[IpsecCiphersuite], Default[IpsecCiphersuite]] = Field(
+        default=Default[IpsecCiphersuite](value="aes256-gcm"), validation_alias=AliasPath("data", "ipsecCiphersuite")
+    )
+    ipsec_rekey_interval: Union[Variable, Default[int], Global[int]] = Field(
+        default=Default[int](value=3600), validation_alias=AliasPath("data", "ipsecRekeyInterval")
+    )
+    ipsec_replay_window: Union[Variable, Default[int], Global[int]] = Field(
+        default=Default[int](value=512), validation_alias=AliasPath("data", "ipsecReplayWindow")
+    )
+    mtu: Optional[Union[Variable, Default[int], Global[int]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "mtu"),
+        description="Required if address is provided (default: 1500). None otherwise.",
+    )
+    mtu_v6: Optional[Union[Global[int], Variable, Default[None]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "mtuV6"),
+        description="Required if ipv6_address is provided (default: Default[None]). None otherwise.",
+    )
+    multiplexing: Optional[Union[Variable, Global[bool], Default[bool]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "multiplexing"),
+        description="This field is supported from version 20.14 (default False)",
+    )
+    perfect_forward_secrecy: Union[Variable, Default[PfsGroup], Global[PfsGroup]] = Field(
+        default=Default[PfsGroup](value="group-16"),
+        validation_alias=AliasPath("data", "perfectForwardSecrecy"),
+    )
+    pre_shared_secret: Union[Variable, Global[str]] = Field(validation_alias=AliasPath("data", "preSharedSecret"))
+    shutdown: Union[Variable, Global[bool], Default[bool]] = Field(
+        default=Default[bool](value=True), validation_alias=AliasPath("data", "shutdown")
+    )
+    tcp_mss_adjust: Optional[Union[Variable, Global[int], Default[None]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "tcpMssAdjust"),
+        description="Required if address is provided (default: Default[None]). None otherwise.",
+    )
+    tcp_mss_adjust_v6: Optional[Union[Global[int], Variable, Default[None]]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "tcpMssAdjustV6"),
+        description="Required if ipv6_address is provided (default: Default[None]). None otherwise.",
+    )
+    tunnel_mode: Optional[Union[Global[IpsecTunnelMode], Default[IpsecTunnelMode]]] = Field(
+        validation_alias=AliasPath("data", "tunnelMode"),
+        default=None,
+    )
+    tunnel_destination: Optional[AddressWithMask] = Field(
+        validation_alias=AliasPath("data", "tunnelDestination"), default=None
+    )
+    tunnel_destination_v6: Optional[Union[Global[str], Global[IPv6Address], Variable]] = Field(
+        default=None,
+        validation_alias=AliasPath("data", "tunnelDestinationV6"),
+        description="Required if ipv6_address is provided. None otherwise.",
+    )
+    tunnel_source: Optional[AddressWithMask] = Field(default=None, validation_alias=AliasPath("data", "tunnelSource"))
+    tunnel_source_v6: Optional[Union[Global[str], Variable]] = Field(
+        validation_alias=AliasPath("data", "tunnelSourceV6"), default=None
+    )
+    ike_mode: Optional[Union[Variable, Global[IkeMode], Default[IkeMode]]] = Field(
+        default=Default[IkeMode](value="main"), validation_alias=AliasPath("data", "ikeMode")
+    )
+    tracker: Optional[Union[Variable, Global[str], Default[None]]] = Field(
+        default=None, validation_alias=AliasPath("data", "tracker")
+    )
+    tunnel_route_via: Optional[Union[Variable, Global[str], Default[None]]] = Field(
+        default=None, validation_alias=AliasPath("data", "tunnelRouteVia")
+    )
+    tunnel_source_interface: Optional[Union[Variable, Global[str], Global[IPv4Interface]]] = Field(
+        default=None, validation_alias=AliasPath("data", "tunnelSourceInterface")
+    )