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

catalystwan/api/templates/models/cisco_snmp_model.py

@@ -1,88 +1,102 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
-from enum import Enum
 from pathlib import Path
-from typing import ClassVar, List, Optional
+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
 
+Authorization = Literal["read-only"]
+SecurityLevel = Literal["no-auth-no-priv", "auth-no-priv", "auth-priv"]
+Auth = Literal["md5", "sha"]
+Priv = Literal["aes-cfb-128", "aes-256-cfb-128"]
+
 
 class Oid(FeatureTemplateValidator):
-    id: str
-    exclude: Optional[BoolStr] = None
+    id: str = Field(description="The OID (Object Identifier) to include or exclude in the view")
+    exclude: Optional[BoolStr] = Field(
+        default=None, description="Indicates whether the OID should be excluded from the view"
+    )
 
 
 class View(FeatureTemplateValidator):
-    name: str
-    oid: Optional[List[Oid]] = None
-
-
-class Authorization(str, Enum):
-    READ_ONLY = "read-only"
+    name: str = Field(description="The name of the SNMP view")
+    oid: Optional[List[Oid]] = Field(default=None, description="List of OIDs to include or exclude in the view")
 
 
 class Community(FeatureTemplateValidator):
-    name: str
-    view: str
-    authorization: Authorization
-
-
-class SecurityLevel(str, Enum):
-    NOAUTHNOPRIV = "no-auth-no-priv"
-    AUTHNOPRIV = "auth-no-priv"
-    AUTHPRIV = "auth-priv"
+    name: str = Field(description="The name of the SNMP community")
+    view: str = Field(description="The SNMP view associated with the community")
+    authorization: Authorization = Field(description="The authorization level of the community")
 
 
 class Group(FeatureTemplateValidator):
-    name: str
-    security_level: SecurityLevel = Field(json_schema_extra={"vmanage_key": "security-level"})
-    view: str
+    name: str = Field(description="The name of the SNMP group")
+    security_level: SecurityLevel = Field(
+        description="The security level associated with the group", json_schema_extra={"vmanage_key": "security-level"}
+    )
+    view: str = Field(description="The SNMP view associated with the group")
     model_config = ConfigDict(populate_by_name=True)
 
 
-class Auth(str, Enum):
-    MD5 = "md5"
-    SHA = "sha"
-
-
-class Priv(str, Enum):
-    AES_CFB_128 = "aes-cfb-128"
-
-
 class User(FeatureTemplateValidator):
-    name: str
-    auth: Optional[Auth] = None
-    auth_password: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "auth-password"})
-    priv: Optional[Priv] = None
-    priv_password: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "priv-password"})
-    group: str
+    name: str = Field(description="The name of the SNMP user")
+    auth: Optional[Auth] = Field(default=None, description="The authentication protocol used")
+    auth_password: Optional[str] = Field(
+        default=None, description="The password for authentication", json_schema_extra={"vmanage_key": "auth-password"}
+    )
+    priv: Optional[Priv] = Field(default=None, description="The privacy (encryption) protocol used")
+    priv_password: Optional[str] = Field(
+        default=None, description="The password for privacy", json_schema_extra={"vmanage_key": "priv-password"}
+    )
+    group: str = Field(description="The group to which the user belongs")
     model_config = ConfigDict(populate_by_name=True)
 
 
 class Target(FeatureTemplateValidator):
-    vpn_id: int = Field(json_schema_extra={"vmanage_key": "vpn-id"})
-    ip: str
-    port: int
-    community_name: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "community-name"})
-    user: Optional[str] = None
-    source_interface: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "source-interface"})
+    vpn_id: int = Field(
+        description="The VPN ID where the SNMP target resides", json_schema_extra={"vmanage_key": "vpn-id"}
+    )
+    ip: str = Field(description="The IP address of the SNMP target")
+    port: int = Field(description="The port number for the SNMP target")
+    community_name: Optional[str] = Field(
+        default=None,
+        description="The community name for the SNMP target",
+        json_schema_extra={"vmanage_key": "community-name"},
+    )
+    user: Optional[str] = Field(default=None, description="The user name for the SNMP target")
+    source_interface: Optional[str] = Field(
+        default=None,
+        description="The source interface for sending SNMP traps",
+        json_schema_extra={"vmanage_key": "source-interface"},
+    )
     model_config = ConfigDict(populate_by_name=True)
 
 
 class CiscoSNMPModel(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
-
-    shutdown: Optional[BoolStr] = True
-    contact: Optional[str] = None
-    location: Optional[str] = None
-    view: Optional[List[View]] = None
-    community: Optional[List[Community]] = None
-    group: Optional[List[Group]] = None
-    user: Optional[List[User]] = None
-    target: Optional[List[Target]] = Field(default=None, json_schema_extra={"data_path": ["trap"]})
+    _docs_description: str = "Cisco SNMP Feature Template configuration"
+
+    shutdown: Optional[BoolStr] = Field(
+        default=True, description="Indicates whether SNMP is administratively shut down"
+    )
+    contact: Optional[str] = Field(default=None, description="The contact information for the SNMP administrator")
+    location: Optional[str] = Field(default=None, description="The physical location information for the SNMP agent")
+    view: Optional[List[View]] = Field(default=None, description="List of SNMP views for controlling access to OIDs")
+    community: Optional[List[Community]] = Field(
+        default=None, description="List of SNMP communities for different access rights"
+    )
+    group: Optional[List[Group]] = Field(
+        default=None, description="List of SNMP groups defining security models and access rights"
+    )
+    user: Optional[List[User]] = Field(
+        default=None, description="List of SNMP users with authentication and privacy configurations"
+    )
+    target: Optional[List[Target]] = Field(
+        default=None, json_schema_extra={"data_path": ["trap"]}, description="List of SNMP targets for sending traps"
+    )
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "cisco_snmp"

catalystwan/api/templates/models/cisco_system.py

@@ -1,209 +1,318 @@
 # Copyright 2023 Cisco Systems, Inc. and its affiliates
 
-from enum import Enum
 from pathlib import Path
-from typing import ClassVar, List, Optional
+from typing import ClassVar, List, Literal, Optional, Union
 
 from pydantic import ConfigDict, Field
 
 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.utils.timezone import Timezone
+from catalystwan.models.common import Protocol, Timezone
 
-
-class MobileNumber(FeatureTemplateValidator):
-    number: str
-
-
-class SiteType(str, Enum):
-    TYPE_1 = "type-1"
-    TYPE_2 = "type-2"
-    TYPE_3 = "type-3"
-    CLOUD = "cloud"
-    BRANCH = "branch"
-    BR = "br"
-    SPOKE = "spoke"
-
-
-class ConsoleBaudRate(str, Enum):
-    _1200 = "1200"
-    _2400 = "2400"
-    _4800 = "4800"
-    _9600 = "9600"
-    _19200 = "19200"
-    _38400 = "38400"
-    _57600 = "57600"
-    _115200 = "115200"
+SiteType = Literal["type-1", "type-2", "type-3", "cloud", "branch", "br", "spoke"]
+ConsoleBaudRate = Literal["1200", "2400", "4800", "9600", "19200", "38400", "57600", "115200"]
+Boolean = Literal["or", "and"]
+Type = Literal["interface", "static-route"]
+Role = Literal["edge-router", "border-router"]
+EnableMrfMigration = Literal["enabled", "enabled-from-bgp-core"]
+Epfr = Literal["disabled", "aggressive", "moderate", "conservative"]
 
 
-class Protocol(str, Enum):
-    TCP = "tcp"
-    UDP = "udp"
-
-
-class Boolean(str, Enum):
-    OR = "or"
-    AND = "and"
-
-
-class Type(str, Enum):
-    INTERFACE = "interface"
-    STATIC_ROUTE = "static-route"
+class MobileNumber(FeatureTemplateValidator):
+    number: str = Field(description="The mobile phone number used for notification or security purposes.")
 
 
 class Tracker(FeatureTemplateValidator):
-    name: str
-    endpoint_ip: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "endpoint-ip"})
+    name: str = Field(description="Name for the Tracker")
+    endpoint_ip: Optional[str] = Field(
+        default=None,
+        description="The IP address of the endpoint to track.",
+        json_schema_extra={"vmanage_key": "endpoint-ip"},
+    )
     endpoint_ip_transport_port: Optional[str] = Field(
-        default=None, json_schema_extra={"vmanage_key": "endpoint-ip", "data_path": ["endpoint-ip-transport-port"]}
-    )
-    protocol: Optional[Protocol] = Field(default=None, json_schema_extra={"data_path": ["endpoint-ip-transport-port"]})
-    port: Optional[int] = Field(default=None, json_schema_extra={"data_path": ["endpoint-ip-transport-port"]})
-    endpoint_dns_name: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "endpoint-dns-name"})
-    endpoint_api_url: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "endpoint-api-url"})
-    elements: Optional[List[str]] = None
-    boolean: Optional[Boolean] = Boolean.OR
-    threshold: Optional[int] = 300
-    interval: Optional[int] = 60
-    multiplier: Optional[int] = 3
-    type: Optional[Type] = Type.INTERFACE
+        default=None,
+        description="The transport port of the endpoint IP address.",
+        json_schema_extra={"vmanage_key": "endpoint-ip", "data_path": ["endpoint-ip-transport-port"]},
+    )
+    protocol: Optional[Protocol] = Field(
+        default=None,
+        description="The protocol used for the tracker (TCP or UDP).",
+        json_schema_extra={"data_path": ["endpoint-ip-transport-port"]},
+    )
+    port: Optional[int] = Field(
+        default=None,
+        description="The port number used for the tracker.",
+        json_schema_extra={"data_path": ["endpoint-ip-transport-port"]},
+    )
+    endpoint_dns_name: Optional[str] = Field(
+        default=None,
+        description="The DNS name of the endpoint to track.",
+        json_schema_extra={"vmanage_key": "endpoint-dns-name"},
+    )
+    endpoint_api_url: Optional[str] = Field(
+        default=None,
+        description="The API URL of the endpoint to track.",
+        json_schema_extra={"vmanage_key": "endpoint-api-url"},
+    )
+    elements: Optional[List[str]] = Field(default=None, description="A list of elements to track.")
+    boolean: Optional[Boolean] = Field(
+        default="or", description="The boolean condition to use when evaluating multiple elements."
+    )
+    threshold: Optional[int] = Field(default=300, description="The threshold for triggering the tracker.")
+    interval: Optional[int] = Field(default=60, description="The interval at which the tracker checks the elements.")
+    multiplier: Optional[int] = Field(default=3, description="The multiplier used for determining the loss threshold.")
+    type: Optional[Type] = Field(default="interface", description="The type of tracker (interface or static route).")
+
     model_config = ConfigDict(populate_by_name=True)
 
 
 class Object(FeatureTemplateValidator):
-    number: int
+    number: int = Field(description="The unique identifier for the object.")
 
 
 class ObjectTrack(FeatureTemplateValidator):
-    object_number: int = Field(json_schema_extra={"vmanage_key": "object-number"})
-    interface: str
-    sig: str
-    ip: str
-    mask: Optional[str] = "0.0.0.0"
-    vpn: int
-    object: List[Object]
-    boolean: Boolean
+    object_number: int = Field(
+        description="The tracking object number.", json_schema_extra={"vmanage_key": "object-number"}
+    )
+    interface: str = Field(description="The name of the interface to track.")
+    sig: str = Field(description="The signature associated with the tracking object.")
+    ip: str = Field(description="The IP address used for tracking.")
+    mask: Optional[str] = Field(
+        default="0.0.0.0", description="The subnet mask associated with the IP address for tracking."
+    )
+    vpn: int = Field(description="The VPN instance associated with the tracking object.")
+    object: List[Object] = Field(description="A list of objects related to the tracking.")
+    boolean: Boolean = Field(description="The boolean condition to use when evaluating multiple objects.")
     model_config = ConfigDict(populate_by_name=True)
 
 
-class Role(str, Enum):
-    EDGE_ROUTER = "edge-router"
-    BORDER_ROUTER = "border-router"
-
-
 class AffinityPerVrf(FeatureTemplateValidator):
     affinity_group_number: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "affinity-group-number"}
+        default=None,
+        description="The affinity group number for VRF binding.",
+        json_schema_extra={"vmanage_key": "affinity-group-number"},
+    )
+    vrf_range: Optional[str] = Field(
+        default=None,
+        description="The range of VRFs associated with the affinity group.",
+        json_schema_extra={"vmanage_key": "vrf-range"},
     )
-    vrf_range: Optional[str] = Field(default=None, json_schema_extra={"vmanage_key": "vrf-range"})
     model_config = ConfigDict(populate_by_name=True)
 
 
-class EnableMrfMigration(str, Enum):
-    ENABLE = "enabled"
-    ENABLE_FROM_BGP_CORE = "enabled-from-bgp-core"
-
-
 class Vrf(FeatureTemplateValidator):
-    vrf_id: int = Field(json_schema_extra={"vmanage_key": "vrf-id"})
+    vrf_id: int = Field(
+        description="The VRF (VPN Routing and Forwarding) instance ID.", json_schema_extra={"vmanage_key": "vrf-id"}
+    )
     gateway_preference: Optional[List[int]] = Field(
-        default=None, json_schema_extra={"vmanage_key": "gateway-preference"}
+        default=None,
+        description="List of affinity group preferences for VRF",
+        json_schema_extra={"vmanage_key": "gateway-preference"},
     )
     model_config = ConfigDict(populate_by_name=True)
 
 
-class Epfr(str, Enum):
-    DISABLED = "disabled"
-    AGGRESSIVE = "aggressive"
-    MODERATE = "moderate"
-    CONSERVATIVE = "conservative"
-
-
 class CiscoSystemModel(FeatureTemplate):
     model_config = ConfigDict(arbitrary_types_allowed=True, populate_by_name=True)
+    _docs_description: str = "Cisco System configuration settings for SD-WAN devices."
 
-    timezone: Optional[Timezone] = Field(default=None, json_schema_extra={"data_path": ["clock"]})
+    timezone: Optional[Timezone] = Field(
+        default=None, description="The timezone setting for the system.", json_schema_extra={"data_path": ["clock"]}
+    )
+    description: Optional[str] = Field(default=None, description="Set a text description of the device")
     hostname: DeviceVariable = Field(
         default=DeviceVariable(name="system_host_name"),
         validate_default=True,
+        description="The hostname for the device.",
         json_schema_extra={"vmanage_key": "host-name"},
     )
-    location: Optional[str] = None
-    latitude: Optional[float] = Field(default=None, json_schema_extra={"data_path": ["gps-location"]})
-    longitude: Optional[float] = Field(default=None, json_schema_extra={"data_path": ["gps-location"]})
-    range: Optional[int] = Field(100, json_schema_extra={"data_path": ["gps-location", "geo-fencing"]})
+    location: Optional[str] = Field(default=None, description="The physical location of the device.")
+    latitude: Optional[float] = Field(
+        default=None,
+        description="The latitude coordinate for the device's location.",
+        json_schema_extra={"data_path": ["gps-location"]},
+    )
+    longitude: Optional[float] = Field(
+        default=None,
+        description="The longitude coordinate for the device's location.",
+        json_schema_extra={"data_path": ["gps-location"]},
+    )
+    range: Optional[int] = Field(
+        default=100,
+        description="The range for geo-fencing feature.",
+        json_schema_extra={"data_path": ["gps-location", "geo-fencing"]},
+    )
     enable_fencing: Optional[BoolStr] = Field(
-        default=None, json_schema_extra={"data_path": ["gps-location", "geo-fencing"], "vmanage_key": "enable"}
+        default=None,
+        description="Enable or disable geo-fencing.",
+        json_schema_extra={"data_path": ["gps-location", "geo-fencing"], "vmanage_key": "enable"},
     )
     mobile_number: Optional[List[MobileNumber]] = Field(
         default=None,
+        description="List of mobile numbers for SMS notifications.",
         json_schema_extra={"vmanage_key": "mobile-number", "data_path": ["gps-location", "geo-fencing", "sms"]},
     )
     enable_sms: Optional[BoolStr] = Field(
-        default=False, json_schema_extra={"data_path": ["gps-location", "geo-fencing", "sms"], "vmanage_key": "enable"}
+        default=False,
+        description="Enable or disable SMS notifications.",
+        json_schema_extra={"data_path": ["gps-location", "geo-fencing", "sms"], "vmanage_key": "enable"},
+    )
+    device_groups: Optional[List[str]] = Field(
+        default=None,
+        description="List of device groups the device belongs to.",
+        json_schema_extra={"vmanage_key": "device-groups"},
     )
-    device_groups: Optional[List[str]] = Field(default=None, json_schema_extra={"vmanage_key": "device-groups"})
     controller_group_list: Optional[List[int]] = Field(
-        default=None, json_schema_extra={"vmanage_key": "controller-group-list"}
+        default=None,
+        description="List of controller groups the device is associated with.",
+        json_schema_extra={"vmanage_key": "controller-group-list"},
     )
     system_ip: DeviceVariable = Field(
-        default=DeviceVariable(name="system_system_ip"), json_schema_extra={"vmanage_key": "system-ip"}
-    )
-    overlay_id: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "overlay-id"})
-    site_id: DeviceVariable = Field(
-        default=DeviceVariable(name="system_site_id"), json_schema_extra={"vmanage_key": "site-id"}
-    )
-    site_type: Optional[List[SiteType]] = Field(default=None, json_schema_extra={"vmanage_key": "site-type"})
-    port_offset: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "port-offset"})
-    port_hop: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "port-hop"})
-    control_session_pps: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "control-session-pps"})
-    track_transport: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "track-transport"})
-    track_interface_tag: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "track-interface-tag"})
+        default=DeviceVariable(name="system_system_ip"),
+        description="The system IP address of the device.",
+        json_schema_extra={"vmanage_key": "system-ip"},
+    )
+    overlay_id: Optional[int] = Field(
+        default=None, description="The overlay ID of the device.", json_schema_extra={"vmanage_key": "overlay-id"}
+    )
+    site_id: Union[int, DeviceVariable] = Field(
+        default=DeviceVariable(name="system_site_id"),
+        description="The site ID of the device.",
+        json_schema_extra={"vmanage_key": "site-id"},
+    )
+    site_type: Optional[List[SiteType]] = Field(
+        default=None,
+        description="The site type classification for the device.",
+        json_schema_extra={"vmanage_key": "site-type"},
+    )
+    port_offset: Optional[int] = Field(
+        default=None, description="The port offset for the device.", json_schema_extra={"vmanage_key": "port-offset"}
+    )
+    port_hop: Optional[BoolStr] = Field(
+        default=None, description="Enable or disable port hopping.", json_schema_extra={"vmanage_key": "port-hop"}
+    )
+    control_session_pps: Optional[int] = Field(
+        default=None,
+        description="Control session packets per second setting.",
+        json_schema_extra={"vmanage_key": "control-session-pps"},
+    )
+    track_transport: Optional[BoolStr] = Field(
+        default=None,
+        description="Enable or disable transport tracking.",
+        json_schema_extra={"vmanage_key": "track-transport"},
+    )
+    track_interface_tag: Optional[int] = Field(
+        default=None,
+        description="The tag of the interface to be tracked.",
+        json_schema_extra={"vmanage_key": "track-interface-tag"},
+    )
+
     console_baud_rate: Optional[ConsoleBaudRate] = Field(
-        default=None, json_schema_extra={"vmanage_key": "console-baud-rate"}
+        default=None,
+        description="The console baud rate setting for the device.",
+        json_schema_extra={"vmanage_key": "console-baud-rate"},
+    )
+    max_omp_sessions: Optional[int] = Field(
+        default=None,
+        description="The maximum number of OMP (Overlay Management Protocol) sessions.",
+        json_schema_extra={"vmanage_key": "max-omp-sessions"},
+    )
+    multi_tenant: Optional[BoolStr] = Field(
+        default=None,
+        description="Enable or disable multi-tenant support.",
+        json_schema_extra={"vmanage_key": "multi-tenant"},
     )
-    max_omp_sessions: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "max-omp-sessions"})
-    multi_tenant: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "multi-tenant"})
     track_default_gateway: Optional[BoolStr] = Field(
-        default=None, json_schema_extra={"vmanage_key": "track-default-gateway"}
+        default=None,
+        description="Enable or disable default gateway tracking.",
+        json_schema_extra={"vmanage_key": "track-default-gateway"},
     )
     admin_tech_on_failure: Optional[BoolStr] = Field(
-        default=None, json_schema_extra={"vmanage_key": "admin-tech-on-failure"}
+        default=None,
+        description="Enable or disable automatic generation of admin technical details on failure.",
+        json_schema_extra={"vmanage_key": "admin-tech-on-failure"},
     )
     enable_tunnel: Optional[BoolStr] = Field(
-        default=None, json_schema_extra={"vmanage_key": "enable", "data_path": ["on-demand"]}
+        default=None,
+        description="Enable or disable tunnel functionality.",
+        json_schema_extra={"vmanage_key": "enable", "data_path": ["on-demand"]},
+    )
+    idle_timeout: Optional[int] = Field(
+        default=None,
+        description="The idle timeout setting for tunnels.",
+        json_schema_extra={"vmanage_key": "idle-timeout"},
     )
-    idle_timeout: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "idle-timeout"})
     on_demand_idle_timeout_min: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "idle-timeout", "data_path": ["on-demand"]}
+        default=None,
+        description="The minimum idle timeout for on-demand tunnels.",
+        json_schema_extra={"vmanage_key": "idle-timeout", "data_path": ["on-demand"]},
+    )
+    tracker: Optional[List[Tracker]] = Field(default=None, description="List of tracker configurations.")
+    object_track: Optional[List[ObjectTrack]] = Field(
+        default=None,
+        description="List of object tracking configurations.",
+        json_schema_extra={"vmanage_key": "object-track"},
+    )
+    region_id: Optional[int] = Field(
+        default=None, description="The region ID of the device.", json_schema_extra={"vmanage_key": "region-id"}
+    )
+    secondary_region: Optional[int] = Field(
+        default=None,
+        description="The secondary region ID of the device.",
+        json_schema_extra={"vmanage_key": "secondary-region"},
+    )
+    role: Optional[Role] = Field(
+        default=None,
+        description="The role of the device in the network.",
     )
-    tracker: Optional[List[Tracker]] = None
-    object_track: Optional[List[ObjectTrack]] = Field(default=None, json_schema_extra={"vmanage_key": "object-track"})
-    region_id: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "region-id"})
-    secondary_region: Optional[int] = Field(default=None, json_schema_extra={"vmanage_key": "secondary-region"})
-    role: Optional[Role] = None
     affinity_group_number: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "affinity-group-number", "data_path": ["affinity-group"]}
+        default=None,
+        description="The affinity group number for VRF binding.",
+        json_schema_extra={"vmanage_key": "affinity-group-number", "data_path": ["affinity-group"]},
+    )
+    preference: Optional[List[int]] = Field(
+        default=None,
+        description="List of affinity group preferences.",
+        json_schema_extra={"data_path": ["affinity-group"]},
+    )
+    preference_auto: Optional[BoolStr] = Field(
+        default=None,
+        description="Enable or disable automatic preference setting for affinity groups.",
+        json_schema_extra={"vmanage_key": "preference-auto", "data_path": ["affinity-group"]},
     )
-    preference: Optional[List[int]] = Field(default=None, json_schema_extra={"data_path": ["affinity-group"]})
-    preference_auto: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "preference-auto"})
     affinity_per_vrf: Optional[List[AffinityPerVrf]] = Field(
-        default=None, json_schema_extra={"vmanage_key": "affinity-per-vrf"}
+        default=None,
+        description="List of affinity configurations per VRF.",
+        json_schema_extra={"vmanage_key": "affinity-per-vrf", "data_path": ["affinity-group"]},
+    )
+    transport_gateway: Optional[BoolStr] = Field(
+        default=None,
+        description="Enable or disable the transport gateway feature.",
+        json_schema_extra={"vmanage_key": "transport-gateway"},
     )
-    transport_gateway: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "transport-gateway"})
     enable_mrf_migration: Optional[EnableMrfMigration] = Field(
-        default=None, json_schema_extra={"vmanage_key": "enable-mrf-migration"}
+        default=None,
+        description="Enable Multicast Routing Framework (MRF) migration settings.",
+        json_schema_extra={"vmanage_key": "enable-mrf-migration"},
     )
     migration_bgp_community: Optional[int] = Field(
-        default=None, json_schema_extra={"vmanage_key": "migration-bgp-community"}
+        default=None,
+        description="BGP community value for MRF migration.",
+        json_schema_extra={"vmanage_key": "migration-bgp-community"},
     )
     enable_management_region: Optional[BoolStr] = Field(
-        default=None, json_schema_extra={"vmanage_key": "enable-management-region"}
+        default=None,
+        description="Enable or disable management region configuration.",
+        json_schema_extra={"vmanage_key": "enable-management-region"},
+    )
+    vrf: Optional[List[Vrf]] = Field(default=None, description="List of VRF configurations.")
+    management_gateway: Optional[BoolStr] = Field(
+        default=None,
+        description="Enable or disable the management gateway feature.",
+        json_schema_extra={"vmanage_key": "management-gateway"},
     )
-    vrf: Optional[List[Vrf]] = None
-    management_gateway: Optional[BoolStr] = Field(default=None, json_schema_extra={"vmanage_key": "management-gateway"})
-    epfr: Optional[Epfr] = None
+    epfr: Optional[Epfr] = Field(default=None, description="Edge Policy-based Framework Routing (EPFR) setting.")
 
     payload_path: ClassVar[Path] = Path(__file__).parent / "DEPRECATED"
     type: ClassVar[str] = "cisco_system"