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

catalystwan/api/templates/models/cli_template.py

@@ -3,15 +3,16 @@
 from pathlib import Path
 from typing import ClassVar
 
-from pydantic import ConfigDict
+from pydantic import ConfigDict, Field
 
 from catalystwan.api.templates.feature_template import FeatureTemplate
 
 
 class CliTemplateModel(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    _docs_description: str = "CLI Template Feature configuration for applying command-line settings."
 
-    config: str
+    config: str = Field(description="The CLI configuration commands to be applied as a template.")
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "cli-template"

catalystwan/api/templates/models/omp_vsmart_model.py

@@ -11,26 +11,62 @@ from catalystwan.api.templates.feature_template import FeatureTemplate
 
 class OMPvSmart(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    _docs_description: str = "Overlay Management Protocol (OMP) settings for vSmart controller"
 
-    graceful_restart: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "graceful-restart"})
-    send_path_limit: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "send-path-limit"})
-    send_backup_paths: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "send-backup-paths"})
-    discard_rejected: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "discard-rejected"})
-    shutdown: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "shutdown"})
+    graceful_restart: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "graceful-restart"},
+        description="Enable or disable graceful restart for the OMP session",
+    )
+    send_path_limit: Optional[int] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "send-path-limit"},
+        description="The maximum number of paths that can be sent to a TLOC",
+    )
+    send_backup_paths: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "send-backup-paths"},
+        description="Enable or disable sending additional backup paths",
+    )
+    discard_rejected: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "discard-rejected"},
+        description="Discard routes that are rejected by policy instead of marking them as rejected",
+    )
+    shutdown: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "shutdown"},
+        description="Enable or disable the shutdown of the OMP session",
+    )
     graceful_restart_timer: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "graceful-restart-timer", "data_path": ["timers"]}
+        default=None,
+        json_schema_extra={"vmanage_key": "graceful-restart-timer", "data_path": ["timers"]},
+        description="The time interval for graceful restart of OMP sessions",
     )
     eor_timer: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "eor-timer", "data_path": ["timers"]}
+        default=None,
+        json_schema_extra={"vmanage_key": "eor-timer", "data_path": ["timers"]},
+        description="The End of Routes (EOR) timer value",
     )
     holdtime: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "holdtime", "data_path": ["timers"]}
+        default=None,
+        json_schema_extra={"vmanage_key": "holdtime", "data_path": ["timers"]},
+        description="The hold time interval for OMP sessions",
     )
     affinity_group_preference: Optional[BoolStr] = Field(
-        default=None, json_schema_extra={"vmanage_key": "affinity-group-preference"}
+        default=False,
+        json_schema_extra={"vmanage_key": "affinity-group-preference", "data_path": ["filter-route", "outbound"]},
+        description="Filter routes based on affinity preference list",
     )
     advertisement_interval: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "advertisement-interval", "data_path": ["timers"]}
+        default=None,
+        json_schema_extra={"vmanage_key": "advertisement-interval", "data_path": ["timers"]},
+        description="Interval between sending OMP route advertisements",
+    )
+    tloc_color: Optional[BoolStr] = Field(
+        default=False,
+        json_schema_extra={"vmanage_key": "tloc-color", "data_path": ["filter-route", "outbound"]},
+        description="Filter routes based on TLOC color",
     )
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"

catalystwan/api/templates/models/security_vsmart_model.py

@@ -1,25 +1,28 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
-from enum import Enum
 from pathlib import Path
-from typing import ClassVar, Optional
+from typing import ClassVar, Literal, Optional
 
 from pydantic import ConfigDict, Field
 
 from catalystwan.api.templates.feature_template import FeatureTemplate
 
-
-class Protocol(str, Enum):
-    DTLS = "dtls"
-    TLS = "tls"
+Protocol = Literal["dtls", "tls"]
 
 
 class SecurityvSmart(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    _docs_description: str = "Security settings for vSmart controller"
 
-    protocol: Optional[Protocol] = Field(default=None, json_schema_extra={"data_path": ["control"]})
+    protocol: Optional[Protocol] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["control"]},
+        description="The security protocol used for control plane communication",
+    )
     tls_port: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "tls-port", "data_path": ["control"]}
+        default=None,
+        json_schema_extra={"vmanage_key": "tls-port", "data_path": ["control"]},
+        description="The port used for TLS communications",
     )
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "security-vsmart"

catalystwan/api/templates/models/supported.py

@@ -1,5 +1,6 @@
 # Copyright 2024 Cisco Systems, Inc. and its affiliates
 
+from catalystwan.api.templates.models.aaa_model import AAAModel
 from catalystwan.api.templates.models.cisco_aaa_model import CiscoAAAModel
 from catalystwan.api.templates.models.cisco_banner_model import CiscoBannerModel
 from catalystwan.api.templates.models.cisco_bfd_model import CiscoBFDModel
@@ -15,17 +16,17 @@ from catalystwan.api.templates.models.cisco_vpn_model import CiscoVPNModel
 from catalystwan.api.templates.models.omp_vsmart_model import OMPvSmart
 from catalystwan.api.templates.models.security_vsmart_model import SecurityvSmart
 from catalystwan.api.templates.models.system_vsmart_model import SystemVsmart
+from catalystwan.api.templates.models.vpn_vsmart_interface_model import VpnVsmartInterfaceModel
+from catalystwan.api.templates.models.vpn_vsmart_model import VpnVsmartModel
 
 available_models = {
+    "aaa": AAAModel,
     "cisco_aaa": CiscoAAAModel,
-    "cisco_bfd": CiscoBFDModel,
     "cisco_banner": CiscoBannerModel,
+    "cisco_bfd": CiscoBFDModel,
     "cisco_ntp": CiscoNTPModel,
     "cisco_ospf": CiscoOSPFModel,
     "cisco_logging": CiscoLoggingModel,
-    "omp_vsmart": OMPvSmart,
-    "security_vsmart": SecurityvSmart,
-    "system_vsmart": SystemVsmart,
     "cisco_vpn_interface": CiscoVpnInterfaceModel,
     "cisco_system": CiscoSystemModel,
     "cisco_vpn": CiscoVPNModel,
@@ -33,4 +34,9 @@ available_models = {
     "cisco_system": CiscoSystemModel,
     "cisco_secure_internet_gateway": CiscoSecureInternetGatewayModel,
     "cisco_omp": CiscoOMPModel,
+    "omp_vsmart": OMPvSmart,
+    "security_vsmart": SecurityvSmart,
+    "system_vsmart": SystemVsmart,
+    "vpn_vsmart": VpnVsmartModel,
+    "vpn_vsmart_interface": VpnVsmartInterfaceModel,
 }

catalystwan/api/templates/models/system_vsmart_model.py

@@ -1,45 +1,182 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
 from pathlib import Path
-from typing import ClassVar, Optional
+from typing import ClassVar, List, Literal, Optional, Union
 
 from pydantic import ConfigDict, Field
 
-from catalystwan.api.templates.feature_template import FeatureTemplate
-from catalystwan.utils.timezone import Timezone
+from catalystwan.api.templates.bool_str import BoolStr
+from catalystwan.api.templates.device_variable import DeviceVariable
+from catalystwan.api.templates.feature_template import FeatureTemplate, FeatureTemplateValidator
+from catalystwan.models.common import Timezone, TLOCColor
+
+Toology = Literal["hub-and-spoke"]
+
+
+class TlocColorComparison(FeatureTemplateValidator):
+    color_1: Optional[TLOCColor] = Field(
+        default=None,
+        description="First TLOC color in comparsion",
+        json_schema_extra={"vmanage_key": "color-1"},
+    )
+    color_2: Optional[TLOCColor] = Field(
+        default=None,
+        description="Second TLOC color in comparsion",
+        json_schema_extra={"vmanage_key": "color-2"},
+    )
+    model_config = ConfigDict(populate_by_name=True)
 
 
 class SystemVsmart(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    _docs_description: str = "Security settings for vSmart controller"
 
-    timezone: Optional[Timezone] = Field(default=None)
-    idle_timeout: Optional[int] = Field(default=None, ge=0, le=300, json_schema_extra={"vmanage_key": "idle-timeout"})
-    admin_tech_on_failure: Optional[bool] = Field(
-        default=True, json_schema_extra={"vmanage_key": "admin-tech-on-failure"}
+    timezone: Optional[Timezone] = Field(
+        default="UTC",
+        description="The timezone setting for the vSmart controller",
+        json_schema_extra={"data_path": ["clock"]},
     )
-    iptables_enable: Optional[bool] = Field(default=True, json_schema_extra={"vmanage_key": "iptables-enable"})
-    track_default_gateway: Optional[bool] = Field(
-        default=True, json_schema_extra={"vmanage_key": "track-default-gateway"}
+    host_name: DeviceVariable = Field(
+        default=DeviceVariable(name="system_host_name"),
+        json_schema_extra={"vmanage_key": "host-name"},
+        description="The hostname for the vSmart controller",
     )
-    dns_cache_timeout: Optional[int] = Field(
-        default=2, ge=1, le=30, json_schema_extra={"vmanage_key": "dns-cache-timeout"}
+    dual_stack_ipv6: Union[DeviceVariable, BoolStr] = Field(
+        default=DeviceVariable(name="system_ipv6-strict-control"),
+        json_schema_extra={"vmanage_key": "ipv6-strict-control"},
+        description="Enable Dual Stack IPv6 Default",
+    )
+    description: Optional[str] = Field(default=None, description="Set a text description of the device")
+    location: Optional[str] = Field(
+        default=None, description="A description of the physical location of the vSmart controller"
+    )
+    system_tunnel_mtu: Optional[int] = Field(
+        default=1024, json_schema_extra={"vmanage_key": "system-tunnel-mtu"}, description="MTU size for system tunnels"
+    )
+    latitude: Optional[int] = Field(
+        default=None,
+        ge=-90,
+        le=90,
+        json_schema_extra={"data_path": ["gps-location"]},
+        description="Geographical latitude of the vSmart controller",
+    )
+    longitude: Optional[int] = Field(
+        default=None,
+        ge=-180,
+        le=180,
+        json_schema_extra={"data_path": ["gps-location"]},
+        description="Geographical longitude of the vSmart controller",
+    )
+    device_groups: List[str] = Field(
+        default_factory=list,
+        json_schema_extra={"vmanage_key": "device-groups"},
+        description="Device group names for the vSmart controller",
+    )
+    system_ip: DeviceVariable = Field(
+        default=DeviceVariable(name="system_system_ip"),
+        json_schema_extra={"vmanage_key": "system-ip"},
+        description="System IP address for the vSmart controller",
+    )
+    site_id: DeviceVariable = Field(
+        default=DeviceVariable(name="system_site_id"),
+        json_schema_extra={"vmanage_key": "site-id"},
+        description="Site ID for the vSmart controller",
+    )
+    overlay_id: Optional[int] = Field(
+        default=1,
+        ge=1,
+        le=4294967295,
+        json_schema_extra={"vmanage_key": "overlay-id"},
+        description="Overlay ID for the vSmart controller",
+    )
+    topology: Optional[List[Toology]] = Field(
+        default=None,
+        description="Set the topology",
+    )
+    port_offset: Optional[int] = Field(
+        default=0,
+        ge=0,
+        le=20,
+        json_schema_extra={"vmanage_key": "port-offset"},
+        description="Port offset for port hopping",
+    )
+    port_hop: Optional[bool] = Field(
+        default=True, json_schema_extra={"vmanage_key": "port-hop"}, description="Enable or disable port hopping"
+    )
+    control_session_pps: Optional[int] = Field(
+        default=300,
+        json_schema_extra={"vmanage_key": "control-session-pps"},
+        description="Control session packets per second limit",
     )
-    track_transport: Optional[bool] = Field(default=True, json_schema_extra={"vmanage_key": "track-transport"})
     controller_group_id: Optional[int] = Field(
-        default=0, ge=0, le=100, json_schema_extra={"vmanage_key": "controller-group-id"}
-    )
-    control_session_pps: Optional[int] = Field(default=300, json_schema_extra={"vmanage_key": "control-session-pps"})
-    port_hop: Optional[bool] = Field(default=True, json_schema_extra={"vmanage_key": "port-hop"})
-    port_offset: Optional[int] = Field(default=0, ge=0, le=20, json_schema_extra={"vmanage_key": "port-offset"})
-    overlay_id: Optional[int] = Field(default=1, ge=1, le=4294967295, json_schema_extra={"vmanage_key": "overlay-id"})
-    site_id: Optional[int] = Field(default=1, ge=1, le=4294967295, json_schema_extra={"vmanage_key": "site-id"})
-    system_ip: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "system-ip"})
-    device_groups: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "device-groups"})
-    longitude: Optional[int] = Field(default=None, ge=-180, le=180)
-    latitude: Optional[int] = Field(default=None, ge=-90, le=90)
-    system_tunnel_mtu: Optional[int] = Field(default=1024, json_schema_extra={"vmanage_key": "system-tunnel-mtu"})
-    location: Optional[str] = None
-    host_name: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "host-name"})
+        default=0,
+        ge=0,
+        le=100,
+        json_schema_extra={"vmanage_key": "controller-group-id"},
+        description="Group ID for the vSmart controller",
+    )
+    track_transport: Optional[BoolStr] = Field(
+        default=True,
+        json_schema_extra={"vmanage_key": "track-transport"},
+        description="Enable or disable tracking of transport connections",
+    )
+    track_default_gateway: Optional[BoolStr] = Field(
+        default=True,
+        json_schema_extra={"vmanage_key": "track-default-gateway"},
+        description="Enable or disable tracking of the default gateway",
+    )
+    iptables_enable: Optional[BoolStr] = Field(
+        default=True,
+        json_schema_extra={"vmanage_key": "iptables-enable"},
+        description="Enable or disable iptables for security",
+    )
+    admin_tech_on_failure: Optional[BoolStr] = Field(
+        default=True,
+        json_schema_extra={"vmanage_key": "admin-tech-on-failure"},
+        description="Enable automatic generation of tech-support file on failure",
+    )
+    idle_timeout: Optional[int] = Field(
+        default=None,
+        ge=0,
+        le=300,
+        json_schema_extra={"vmanage_key": "idle-timeout"},
+        description="Idle timeout in minutes for user sessions",
+    )
+    dns_cache_timeout: Optional[int] = Field(
+        default=2,
+        ge=1,
+        le=30,
+        json_schema_extra={"vmanage_key": "dns-cache-timeout"},
+        description="DNS cache timeout in minutes",
+    )
+    region_list_id: Optional[int] = Field(
+        default=None,
+        ge=1,
+        le=64,
+        json_schema_extra={"vmanage_key": "region-id-list"},
+        description="Configure a list of region ID",
+    )
+    management_region: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "management-region"},
+        description="Management Region",
+    )
+    compatible: Optional[List[TlocColorComparison]] = Field(
+        default=None,
+        json_schema_extra={
+            "data_path": ["tloc-color-compatibility"],
+            "priority_order": ["color-1", "color-2"],
+        },
+        description="Configure compatible TLOC color",
+    )
+    incompatible: Optional[List[TlocColorComparison]] = Field(
+        default=None,
+        json_schema_extra={
+            "data_path": ["tloc-color-compatibility"],
+            "priority_order": ["color-1", "color-2"],
+        },
+        description="Configure incompatible TLOC color",
+    )
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "system-vsmart"

catalystwan/api/templates/models/vpn_vsmart_interface_model.py

@@ -0,0 +1,198 @@
+# 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
+from catalystwan.models.common import TLOCColor
+
+VpnId = Literal["0", "512"]
+Role = Literal["primary", "secondary"]
+
+Speed = Literal["10", "100", "1000"]
+Duplex = Literal["full", "half"]
+Carrier = Literal[
+    "default", "carrier1", "carrier2", "carrier3", "carrier4", "carrier5", "carrier6", "carrier7", "carrier8"
+]
+FlowControl = Literal["ingress", "egress", "autoneg", "both", "none"]
+
+
+class Ip(FeatureTemplateValidator):
+    addr: ipaddress.IPv4Address = Field(..., description="IPv4 address for the interface.")
+    mac: str = Field(..., description="MAC address associated with the IPv4 address.")
+
+
+class VpnVsmartInterfaceModel(FeatureTemplate):
+    model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    _docs_description: str = "vSmart VPN Interface Feature Template configuration"
+
+    if_name: Optional[str] = Field(
+        default=None, description="The name of the interface.", json_schema_extra={"vmanage_key": "if-name"}
+    )
+    interface_description: Optional[str] = Field(
+        default=None, description="A description for the interface.", json_schema_extra={"vmanage_key": "description"}
+    )
+    ipv4_address: Optional[str] = Field(
+        default=None,
+        description="The primary IPv4 address assigned to the interface.",
+        json_schema_extra={"data_path": ["ip"], "vmanage_key": "address"},
+    )
+    dhcp_ipv4_client: Optional[BoolStr] = Field(
+        default=None,
+        description=(
+            "Whether DHCP client is enabled on the interface for IPv4 addressing. True if enabled, False otherwise."
+        ),
+        json_schema_extra={"data_path": ["ip"], "vmanage_key": "dhcp-client"},
+    )
+    dhcp_distance: Optional[int] = Field(
+        default=None,
+        description="Administrative distance for DHCP routes on the interface.",
+        json_schema_extra={"data_path": ["ip"], "vmanage_key": "dhcp-distance"},
+    )
+    ipv6_address: Optional[ipaddress.IPv6Interface] = Field(
+        default=None,
+        description="The primary IPv6 address assigned to the interface.",
+        json_schema_extra={"data_path": ["ipv6"], "vmanage_key": "address"},
+    )
+    dhcp_ipv6_client: Optional[BoolStr] = Field(
+        default=None,
+        description=(
+            "Whether DHCP client is enabled on the interface for IPv6 addressing. True if enabled, False otherwise."
+        ),
+        json_schema_extra={"data_path": ["ipv6"], "vmanage_key": "dhcp-client"},
+    )
+    dhcp_ipv6_distance: Optional[int] = Field(
+        default=None,
+        description="Administrative distance for DHCP routes on the interface.",
+        json_schema_extra={"data_path": ["ipv6"], "vmanage_key": "dhcp-distance"},
+    )
+    dhcp_rapid_commit: Optional[BoolStr] = Field(
+        default=None,
+        description=("Enable DHCPv6 rapid commit"),
+        json_schema_extra={"data_path": ["ipv6"], "vmanage_key": "dhcp-rapid-commit"},
+    )
+    group: Optional[List[int]] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface"]},
+        description="Identifies the group or groups the interface belongs to.",
+    )
+    value: Optional[TLOCColor] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface", "color"]},
+        description=(
+            "The value field often corresponds to a specific attribute or setting, such as color in this context."
+        ),
+    )
+    carrier: Optional[Carrier] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface"]},
+        description="Specifies the carrier information for the tunnel interface.",
+    )
+    nat_refresh_interval: Optional[int] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "nat-refresh-interval", "data_path": ["tunnel-interface"]},
+        description="Interval in seconds to refresh NAT (Network Address Translation) mappings.",
+    )
+    hello_interval: Optional[int] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "hello-interval", "data_path": ["tunnel-interface"]},
+        description="Time interval in seconds between successive hello packets sent over the tunnel interface.",
+    )
+    hello_tolerance: Optional[int] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "hello-tolerance", "data_path": ["tunnel-interface"]},
+        description="Time in seconds to wait before declaring a neighbor down due to missing hello packets.",
+    )
+    all: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface", "allow-service"]},
+        description="Permits or denies all services through the tunnel interface.",
+    )
+    dhcp: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface", "allow-service"]},
+        description="Enables or disables Dynamic Host Configuration Protocol (DHCP) on the tunnel interface.",
+    )
+    dns: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface", "allow-service"]},
+        description="Allows or disallows Domain Name System (DNS) queries through the tunnel interface.",
+    )
+    icmp: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface", "allow-service"]},
+        description=(
+            "Enables or disables Internet Control Message Protocol (ICMP) "
+            "for ping and traceroute through the tunnel interface."
+        ),
+    )
+    sshd: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface", "allow-service"]},
+        description="Allows or disallows Secure Shell (SSH) daemon access through the tunnel interface.",
+    )
+    netconf: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface", "allow-service"]},
+        description="Enables or disables NETCONF protocol support on the tunnel interface.",
+    )
+    ntp: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface", "allow-service"]},
+        description="Allows or disallows Network Time Protocol (NTP) synchronization through the tunnel interface.",
+    )
+    stun: Optional[BoolStr] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["tunnel-interface", "allow-service"]},
+        description="Enables or disables Session Traversal Utilities for NAT (STUN) on the tunnel interface.",
+    )
+    flow_control: Optional[FlowControl] = Field(default=None, description="Enable flow control.")
+    clear_dont_fragment: Optional[BoolStr] = Field(
+        default=False,
+        json_schema_extra={"vmanage_key": "clear-dont-fragment"},
+        description="Enables Clear don't fragment bit",
+    )
+    autonegotiate: Optional[BoolStr] = Field(
+        default=True,
+        json_schema_extra={"vmanage_key": "autonegotiate"},
+        description="Link autonegotiation",
+    )
+    pmtu: Optional[BoolStr] = Field(
+        default=False,
+        json_schema_extra={"vmanage_key": "pmtu"},
+        description="Enables Path MTU Discovery",
+    )
+    mtu: Optional[int] = Field(
+        default=1500,
+        json_schema_extra={"vmanage_key": "mtu"},
+        description="Interface MTU <576..2000>",
+    )
+    tcp_mss_adjust: Optional[int] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "tcp-mss-adjust"},
+        description="TCP MSS on SYN packets, in bytes",
+    )
+    mac_address: Optional[str] = Field(
+        default=None,
+        json_schema_extra={"vmanage_key": "mac-address"},
+        description="Specifies the MAC address for the interface.",
+    )
+    speed: Optional[Speed] = Field(
+        default=None, description="Defines the speed of the interface, such as 10Mbps, 100Mbps, or 1Gbps."
+    )
+    duplex: Optional[Duplex] = Field(
+        default=None, description="Sets the duplex mode for the interface, such as full or half duplex."
+    )
+    shutdown: Optional[BoolStr] = Field(default=False, description="Enables or disables (shuts down) the interface.")
+    ip: Optional[List[Ip]] = Field(
+        default=None,
+        json_schema_extra={"data_path": ["arp"]},
+        description="A list of IP configurations for Address Resolution Protocol (ARP) settings.",
+    )
+
+    payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
+    type: ClassVar[str] = "vpn-vsmart-interface"